fail build if plugin cant load next.config.js (#99)

* fail build if plugin cant load next.config.js

* pass config loading error to failBuild message

Co-authored-by: Erez Rokah <[email protected]>

Co-authored-by: Erez Rokah <[email protected]>

Author: lindsaylevine

.gitignore

@@ -7,7 +7,7 @@ test/sample/netlify/functions
 test/sample/my-publish-dir
 test/sample/.next
 test/sample/.netlify
-next.config.js
+/next.config.js
 
 # Logs
 logs

helpers/doesNotNeedPlugin.js

@@ -5,15 +5,15 @@ const isStaticExportProject = require('./isStaticExportProject')
 const doesSiteUseNextOnNetlify = require('./doesSiteUseNextOnNetlify')
 const hasCorrectNextConfig = require('./hasCorrectNextConfig')
 
-const doesNotNeedPlugin = async ({ netlifyConfig, packageJson }) => {
+const doesNotNeedPlugin = async ({ netlifyConfig, packageJson, utils }) => {
   const { build } = netlifyConfig
   const { name, scripts = {} } = packageJson
   const nextConfigPath = await findUp('next.config.js')
 
   return (
     isStaticExportProject({ build, scripts }) ||
     doesSiteUseNextOnNetlify({ packageJson }) ||
-    !hasCorrectNextConfig(nextConfigPath)
+    !hasCorrectNextConfig({ nextConfigPath, failBuild: utils.build.failBuild })
   )
 }
 

helpers/hasCorrectNextConfig.js

@@ -1,7 +1,7 @@
 const path = require('path')
 
 // Checks if site has the correct next.cofig.js
-const hasCorrectNextConfig = (nextConfigPath) => {
+const hasCorrectNextConfig = ({ nextConfigPath, failBuild }) => {
   // In the plugin's case, no config is valid because we'll make it ourselves
   if (nextConfigPath === undefined) return true
 
@@ -12,7 +12,12 @@ const hasCorrectNextConfig = (nextConfigPath) => {
 
   // If the next config exists, log warning if target isnt in acceptableTargets
   const acceptableTargets = ['serverless', 'experimental-serverless-trace']
-  const nextConfig = loadConfig(PHASE_PRODUCTION_BUILD, path.resolve('.'))
+  let nextConfig
+  try {
+    nextConfig = loadConfig(PHASE_PRODUCTION_BUILD, path.resolve('.'))
+  } catch (error) {
+    return failBuild('Error loading your next.config.js.', { error })
+  }
   const isValidTarget = acceptableTargets.includes(nextConfig.target)
   if (!isValidTarget) {
     console.log(

index.js

@@ -24,7 +24,7 @@ module.exports = {
       return failBuild('Could not find a package.json for this project')
     }
 
-    if (await doesNotNeedPlugin({ netlifyConfig, packageJson })) {
+    if (await doesNotNeedPlugin({ netlifyConfig, packageJson, utils })) {
       return
     }
 
@@ -39,8 +39,13 @@ module.exports = {
       await pWriteFile('next.config.js', nextConfig)
     }
   },
-  async onBuild({ netlifyConfig, packageJson, constants: { PUBLISH_DIR, FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC } }) {
-    if (await doesNotNeedPlugin({ netlifyConfig, packageJson })) {
+  async onBuild({
+    netlifyConfig,
+    packageJson,
+    constants: { PUBLISH_DIR, FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC },
+    utils,
+  }) {
+    if (await doesNotNeedPlugin({ netlifyConfig, packageJson, utils })) {
       return
     }
 

test/fixtures/broken_next_config/next.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  target: "serverless",
+  i18n: {
+    locales: ["en", "fr"
+  }
+};

test/index.js

@@ -141,6 +141,19 @@ describe('preBuild()', () => {
       }),
     ).rejects.toThrow(`Could not find a package.json for this project`)
   })
+
+  test('fail build if the app cant load the next.config.js', async () => {
+    await useFixture('broken_next_config')
+
+    await expect(
+      plugin.onPreBuild({
+        netlifyConfig,
+        packageJson: DUMMY_PACKAGE_JSON,
+        utils,
+        constants: { FUNCTIONS_SRC: 'out_functions' },
+      }),
+    ).rejects.toThrow(`Error loading your next.config.js.`)
+  })
 })
 
 describe('onBuild()', () => {
@@ -155,6 +168,7 @@ describe('onBuild()', () => {
       netlifyConfig,
       packageJson,
       constants: {},
+      utils,
     })
 
     expect(await pathExists(`${PUBLISH_DIR}/index.html`)).toBeFalsy()
@@ -170,6 +184,7 @@ describe('onBuild()', () => {
         packageJson: DUMMY_PACKAGE_JSON,
         utils,
         constants: { FUNCTIONS_SRC: 'out_functions' },
+        utils,
       })
 
       expect(await pathExists(`${PUBLISH_DIR}/index.html`)).toBeFalsy()
@@ -187,6 +202,7 @@ describe('onBuild()', () => {
         PUBLISH_DIR,
         FUNCTIONS_SRC: 'functions',
       },
+      utils,
     })
 
     expect(await pathExists(`${PUBLISH_DIR}/_redirects`)).toBeTruthy()
@@ -206,6 +222,7 @@ describe('onBuild()', () => {
         FUNCTIONS_SRC,
         PUBLISH_DIR: '.',
       },
+      utils,
     })
 
     expect(await pathExists(`${resolvedFunctions}/next_api_test/next_api_test.js`)).toBeTruthy()