Merge pull request #11 from netlify/caching

feat: build caching

Author: lindsaylevine

src/helpers/cacheBuild.js

@@ -0,0 +1,28 @@
+const path = require('path')
+
+const getPath = (siteRoot, distDir, source) => path.join(siteRoot, distDir, source)
+
+const restoreCache = async ({ cache, distDir, siteRoot }) => {
+  const cacheDir = getPath(siteRoot, distDir, 'cache')
+  if (await cache.restore(cacheDir)) {
+    console.log('Next.js cache restored.')
+  } else {
+    console.log('No Next.js cache to restore.')
+  }
+}
+
+const saveCache = async ({ cache, distDir, siteRoot }) => {
+  const cacheDir = getPath(siteRoot, distDir, 'cache')
+
+  const buildManifest = getPath(siteRoot, distDir, 'build-manifest.json')
+  if (await cache.save(cacheDir, { digests: [buildManifest] })) {
+    console.log('Next.js cache saved.')
+  } else {
+    console.log('No Next.js cache to save.')
+  }
+}
+
+module.exports = {
+  restoreCache,
+  saveCache,
+}

src/index.js

@@ -1,6 +1,7 @@
 // @ts-check
 const path = require('path')
 
+const { restoreCache, saveCache } = require('./helpers/cacheBuild')
 const copyNextDist = require('./helpers/copyNextDist')
 const generateFunctions = require('./helpers/generateFunctions')
 const getNextConfig = require('./helpers/getNextConfig')
@@ -20,6 +21,7 @@ module.exports = {
     packageJson,
     utils: {
       build: { failBuild },
+      cache,
     },
   }) {
     if (shouldSkipPlugin({ netlifyConfig, packageJson, failBuild })) {
@@ -36,6 +38,8 @@ module.exports = {
     verifyBuildTarget(target)
 
     setIncludedFiles({ netlifyConfig, distDir })
+
+    await restoreCache({ cache, distDir, siteRoot })
   },
 
   async onBuild({
@@ -68,4 +72,16 @@ module.exports = {
       copyNextDist(siteRoot)
     }
   },
+
+  async onPostBuild({
+    netlifyConfig,
+    utils: {
+      build: { failBuild },
+      cache,
+    },
+  }) {
+    const siteRoot = getNextRoot({ netlifyConfig })
+    const { distDir } = await getNextConfig(failBuild, siteRoot)
+    await saveCache({ cache, distDir, siteRoot })
+  },
 }

test/index.js

@@ -245,7 +245,7 @@ describe('preBuild()', () => {
     ).rejects.toThrow(`You set your publish directory to "${wrongPublishDir}". Your publish directory should be set to your distDir (defaults to .next or is configured in your next.config.js). If your site is rooted in a subdirectory, your publish directory should be {yourSiteRoot}/{distDir}.`)
   })
 
-  test('fail build if no  publish dir', async () => {
+  test('fail build if no publish dir', async () => {
     expect(
       plugin.onPreBuild({
         netlifyConfig: { build: { command: 'npm run build', publish: null } },
@@ -256,20 +256,21 @@ describe('preBuild()', () => {
     ).rejects.toThrow('You set your publish directory to "null". Your publish directory should be set to your distDir (defaults to .next or is configured in your next.config.js). If your site is rooted in a subdirectory, your publish directory should be {yourSiteRoot}/{distDir}.')
   })
 
-  // test('restores cache with right paths', async () => {
-  //   await useFixture('dist_dir_next_config')
+  test('restores cache with right paths', async () => {
+    await useFixture('dist_dir_next_config')
+    netlifyConfig.build.publish = path.join(process.cwd(), 'build')
 
-  //   const restore = jest.fn()
+    const restore = jest.fn()
 
-  //   await plugin.onPreBuild({
-  //     netlifyConfig,
-  //     packageJson: DUMMY_PACKAGE_JSON,
-  //     utils: { ...utils, cache: { restore } },
-  //     constants: { FUNCTIONS_SRC: 'out_functions' },
-  //   })
+    await plugin.onPreBuild({
+      netlifyConfig,
+      packageJson,
+      utils: { ...utils, cache: { restore } },
+      constants: { FUNCTIONS_SRC: 'out_functions' },
+    })
 
-  //   expect(restore).toHaveBeenCalledWith(path.resolve('build/cache'))
-  // })
+    expect(restore).toHaveBeenCalledWith(path.resolve('build/cache'))
+  })
 })
 
 describe('onBuild()', () => {
@@ -322,22 +323,22 @@ describe('onBuild()', () => {
 })
 
 describe('onPostBuild', () => {
-  // test('saves cache with right paths', async () => {
-  //   await useFixture('dist_dir_next_config')
-
-  //   const save = jest.fn()
-
-  //   await plugin.onPostBuild({
-  //     netlifyConfig,
-  //     packageJson: DUMMY_PACKAGE_JSON,
-  //     utils: { ...utils, cache: { save } },
-  //     constants: { FUNCTIONS_SRC: 'out_functions' },
-  //   })
-
-  //   expect(save).toHaveBeenCalledWith(path.resolve('build/cache'), {
-  //     digests: [path.resolve('build/build-manifest.json')],
-  //   })
-  // })
+  test('saves cache with right paths', async () => {
+    await useFixture('dist_dir_next_config')
+
+    const save = jest.fn()
+
+    await plugin.onPostBuild({
+      netlifyConfig,
+      packageJson,
+      utils: { ...utils, cache: { save } },
+      constants: { FUNCTIONS_SRC: 'out_functions' },
+    })
+
+    expect(save).toHaveBeenCalledWith(path.resolve('build/cache'), {
+      digests: [path.resolve('build/build-manifest.json')],
+    })
+  })
 })
 
 describe('script parser', () => {