update usage example

Author: DavidWells

lib/index.js

@@ -19,7 +19,7 @@ const {
 
 const homeDir = os.homedir()
 
-async function cacheMagic(cacheFolder, contents) {
+async function cacheMeOutside(cacheFolder, contents) {
   const options = {}
   const currentWorkingDir = process.cwd()
   const defaultOptions = {
@@ -113,43 +113,45 @@ async function checkCache(d, opts, cacheDirectory) {
 
   let changeTriggered = false
   let shouldCacheUpdate = false
+  let shouldUpdateFunction = defaultShouldUpdate
+
   if (d.shouldCacheUpdate && typeof d.shouldCacheUpdate === 'function') {
-    shouldCacheUpdate = await d.shouldCacheUpdate(cacheData, {
-      diff: diffWrapper
-    })
-    console.log('shouldCacheUpdate', shouldCacheUpdate)
-    if (!cacheData || shouldCacheUpdate) {
-      console.log('TRIGGER UPDATE LOGIC')
-
-      changeTriggered = true
-
-      // Clear out cache directory
-      await removeDirectory(cachedContents)
-
-      // TODO use updateCacheFunction
-      if (d.handleCacheUpdate) {
-        console.log('handleCacheUpdate', d.handleCacheUpdate)
-
-        // Handle CLI commands
-        if (typeof d.handleCacheUpdate === 'string') {
-          console.log('Do command')
-          console.log(`cwd`, parentDirectory)
-          await execPromise(d.handleCacheUpdate, {
-            cwd: parentDirectory
-          })
-        }
-
-        // Handle custom functions
-        if (typeof d.handleCacheUpdate === 'function') {
-          console.log('Do function')
-          await d.handleCacheUpdate(cacheData)
-        }
+    shouldUpdateFunction = d.shouldCacheUpdate
+  }
+
+  // Run custom or default shouldCacheUpdate
+  shouldCacheUpdate = await shouldUpdateFunction(cacheData, {
+    diff: diffWrapper
+  })
+
+  if (!cacheData || shouldCacheUpdate) {
+    console.log('TRIGGER UPDATE LOGIC')
+
+    changeTriggered = true
+
+    // Clear out cache directory
+    await removeDirectory(cachedContents)
+
+    // Run handleCacheUpdate cmd/function
+    if (d.handleCacheUpdate) {
+      // Handle CLI commands
+      if (typeof d.handleCacheUpdate === 'string') {
+        console.log(`cwd`, parentDirectory)
+        await execPromise(d.handleCacheUpdate, {
+          cwd: parentDirectory
+        })
       }
 
-      console.log(`3. Copying over ${directory} to ${cachedContents}...`)
-      await copyDirectory(directory, cachedContents)
-      console.log(`✓  Dependencies copied to cache ${cachedContents}\n`)
+      // Handle custom functions
+      if (typeof d.handleCacheUpdate === 'function') {
+        console.log('Running handleCacheUpdate function...')
+        await d.handleCacheUpdate(cacheData)
+      }
     }
+
+    console.log(`3. Copying over ${directory} to ${cachedContents}...`)
+    await copyDirectory(directory, cachedContents)
+    console.log(`✓  Dependencies copied to cache ${cachedContents}\n`)
   }
 
   console.log(`4. Saving new dependencies hash...`)
@@ -175,6 +177,7 @@ async function checkCache(d, opts, cacheDirectory) {
   const defaultInfo = {
     ...info,
     cacheDir: path.dirname(cachedContents),
+    cacheDirContents: cachedContents,
     contents: {
       src: directory,
       hash: folderHash.hash,
@@ -192,9 +195,33 @@ async function checkCache(d, opts, cacheDirectory) {
 }
 
 // "build": "npm-install-cache && npm run build"
-module.exports = cacheMagic
+module.exports = cacheMeOutside
 module.exports.getHash = getHash
 
+/* Default should update checks for folder hash change */
+async function defaultShouldUpdate(cacheData) {
+  console.log('DEFUALT defaultShouldUpdate')
+  if (!cacheData || !cacheData.contents || !cacheData.contents.hash) {
+    // No cache, is first run
+    return true
+  }
+
+  const cacheHash = cacheData.contents.hash
+
+  const folderHash = await hashFolder(cacheData.contents.src)
+
+  if (folderHash.hash !== cacheHash) {
+    console.log('FOLDER HAS CHANGED PURGE CACHE')
+    return true
+  }
+
+  if (folderHash.hash === cacheData.contents.hash) {
+    console.log('NO changes to FOLDER')
+  }
+
+  return false
+}
+
 async function diff(filePath, cacheFile) {
   const cacheData = await getCacheData(cacheFile) || {}
   // No change file exists

lib/utils/fs.js

@@ -87,7 +87,7 @@ function fileExists(filePath) {
   return new Promise((resolve, reject) => {
     fs.access(filePath, fs.F_OK, (err) => {
       if (err) {
-        console.log(`${consolePrefix} No ${filePath} found. Proceeding`)
+        // console.log(`${consolePrefix} No ${filePath} found. Proceeding`)
         return resolve(false) // eslint-disable-line
       }
       return resolve(true)

usage-example.js

@@ -22,19 +22,18 @@ const contentsToCache = [
   },
   {
     contents: path.join(__dirname, 'other/node_modules'),
-    handleCacheUpdate: 'npm install',
-    shouldCacheUpdate: (data) => {
-      // console.log('data', data)
+    shouldCacheUpdate: function() {
       return false
     },
+    handleCacheUpdate: 'yarn install'
   },
   {
     contents: path.join(__dirname, 'serverless-test/.serverless'),
-    shouldCacheUpdate: function() {
-      return true
-    },
-    handleCacheUpdate: 'echo "hi"'
-  }
+    handleCacheUpdate: () => {
+      console.log('run my custom stuff here')
+    }
+    // shouldCacheUpdate if omitted will use contents folder hash
+  },
 ]
 
 cacheMeOutside(cacheDir, contentsToCache).then((cacheInfo) => {