Fix require('next') in production

Author: ehmicky

helpers/requirePeerDependency.js

@@ -0,0 +1,13 @@
+// In production, Build plugins cannot currently require peer dependencies
+// without this hack.
+// See https://github.com/netlify/netlify-plugin-nextjs/issues/55
+// TODO: remove once https://github.com/netlify/pod-the-builder/issues/102 is solved
+const requirePeerDependency = function (IS_LOCAL, modulePath) {
+  if (!IS_LOCAL) {
+    return require(require.resolve(modulePath, { paths: ['.'] }))
+  }
+
+  return require(modulePath)
+}
+
+module.exports = requirePeerDependency

index.js

@@ -7,6 +7,7 @@ const makeDir = require('make-dir')
 
 const isStaticExportProject = require('./helpers/isStaticExportProject')
 const validateNextUsage = require('./helpers/validateNextUsage')
+const requirePeerDependency = require('./helpers/requirePeerDependency')
 
 const pWriteFile = util.promisify(fs.writeFile)
 
@@ -15,7 +16,7 @@ const pWriteFile = util.promisify(fs.writeFile)
 // - Between the build and postbuild steps, any functions are bundled
 
 module.exports = {
-  async onPreBuild({ netlifyConfig, packageJson, utils }) {
+  async onPreBuild({ netlifyConfig, packageJson, utils, constants: { IS_LOCAL } }) {
     const { failBuild } = utils.build
 
     validateNextUsage(failBuild)
@@ -45,8 +46,8 @@ module.exports = {
     if (nextConfigPath !== undefined) {
       // We cannot load `next` at the top-level because we validate whether the
       // site is using `next` inside `onPreBuild`.
-      const { PHASE_PRODUCTION_BUILD } = require('next/constants')
-      const { default: loadConfig } = require('next/dist/next-server/server/config')
+      const { PHASE_PRODUCTION_BUILD } = requirePeerDependency(IS_LOCAL, 'next/constants')
+      const { default: loadConfig } = requirePeerDependency(IS_LOCAL, 'next/dist/next-server/server/config')
 
       // If the next config exists, fail build if target isnt in acceptableTargets
       const acceptableTargets = ['serverless', 'experimental-serverless-trace']
@@ -66,7 +67,7 @@ module.exports = {
       console.log(`** Adding next.config.js with target set to 'serverless' **`)
     }
   },
-  async onBuild({ constants: { PUBLISH_DIR, FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC } }) {
+  async onBuild({ constants: { PUBLISH_DIR, FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC, IS_LOCAL } }) {
     console.log(`** Running Next on Netlify package **`)
 
     await makeDir(PUBLISH_DIR)
@@ -75,7 +76,11 @@ module.exports = {
     // top-level because we validate whether the site is using `next`
     // inside `onPreBuild`.
     const nextOnNetlify = require('next-on-netlify')
-    nextOnNetlify({ functionsDir: FUNCTIONS_SRC, publishDir: PUBLISH_DIR })
+    nextOnNetlify({
+      functionsDir: FUNCTIONS_SRC,
+      publishDir: PUBLISH_DIR,
+      requirePeerDependency: requirePeerDependency.bind(undefined, IS_LOCAL),
+    })
   },
 }
 

test/index.js

@@ -92,6 +92,7 @@ describe('preBuild()', () => {
         netlifyConfig: {},
         packageJson,
         utils,
+        constants: {},
       }),
     ).rejects.toThrow(
       `This plugin does not support sites that manually use next-on-netlify. Uninstall next-on-netlify as a dependency to resolve.`,
@@ -107,6 +108,7 @@ describe('preBuild()', () => {
         netlifyConfig: {},
         packageJson,
         utils,
+        constants: {},
       }),
     ).rejects.toThrow(
       `This plugin does not support sites that manually use next-on-netlify. Uninstall next-on-netlify as a dependency to resolve.`,