fix: sort out require handling

Author: ascorbic

helpers/getNextConfig.js

@@ -4,15 +4,17 @@ const { cwd: getCwd } = require('process')
 
 const moize = require('moize')
 
-const requireNextModule = require('./requireNextModule')
+const resolveNextModule = require('./resolveNextModule')
 
 // We used to cache nextConfig for any cwd. Now we pass process.cwd() to cache
 // (or memoize) nextConfig per cwd.
 const getNextConfig = async function (failBuild = defaultFailBuild, cwd = getCwd()) {
   // We cannot load `next` at the top-level because we validate whether the
   // site is using `next` inside `onPreBuild`.
-  const { PHASE_PRODUCTION_BUILD } = requireNextModule('next/constants', cwd)
-  const loadConfig = requireNextModule('next/dist/next-server/server/config', cwd).default
+  /* eslint-disable import/no-dynamic-require */
+  const { PHASE_PRODUCTION_BUILD } = require(resolveNextModule('next/constants', cwd))
+  const loadConfig = require(resolveNextModule('next/dist/next-server/server/config', cwd)).default
+  /* eslint-enable import/no-dynamic-require */
 
   try {
     return await loadConfig(PHASE_PRODUCTION_BUILD, cwd)

helpers/requireNextModule.js

@@ -0,0 +1,13 @@
+/**
+ * We can't require() these normally, because the "next" package might not be resolvable from the root of a monorepo
+ */
+const resolveNextModule = (module, nextRoot) => {
+  // Get the default list of require paths...
+  const paths = require.resolve.paths(module)
+  // ...add the root of the Next site to the beginning of that list so we try it first...
+  paths.unshift(nextRoot)
+  // ...then resolve the module using that list of paths.
+  return require.resolve(module, { paths })
+}
+
+module.exports = resolveNextModule

helpers/resolveNextModule.js

@@ -2,6 +2,7 @@ const { yellowBright } = require('chalk')
 const { lt: ltVersion, gte: gteVersion } = require('semver')
 
 const getNextRoot = require('./getNextRoot')
+const resolveNextModule = require('./resolveNextModule')
 
 // Ensure Next.js is available.
 // We use `peerDependencies` instead of `dependencies` so that users can choose
@@ -10,20 +11,17 @@ const getNextRoot = require('./getNextRoot')
 const validateNextUsage = function ({ failBuild, netlifyConfig }) {
   const nextRoot = getNextRoot({ netlifyConfig })
   //  Because we don't know the monorepo structure, we try to resolve next both locally and in the next root
-  const paths = [nextRoot, process.cwd()]
-  if (!hasPackage('next', paths)) {
+  if (!hasPackage('next', nextRoot)) {
     return failBuild(
-      'This site does not seem to be using Next.js. Please run "npm install next" or "yarn next" in the repository.',
+      `This site does not seem to be using Next.js. Please run "npm install next" or "yarn next" in the repository. ${nextRoot} ${process.cwd()}`,
     )
   }
 
   // We cannot load `next` at the top-level because we validate whether the
   // site is using `next` inside `onPreBuild`.
   // Old Next.js versions are not supported
-  // eslint-disable-next-line node/no-unpublished-require
-  const pkg = require.resolve(`next/package.json`, { paths })
   // eslint-disable-next-line import/no-dynamic-require
-  const { version } = require(pkg)
+  const { version } = require(resolveNextModule(`next/package.json`, nextRoot))
   if (ltVersion(version, MIN_VERSION)) {
     return failBuild(`Please upgrade to Next.js ${MIN_VERSION} or later. Found ${version}.`)
   }
@@ -39,9 +37,9 @@ const validateNextUsage = function ({ failBuild, netlifyConfig }) {
 const MIN_VERSION = '10.0.6'
 const MIN_EXPERIMENTAL_VERSION = '11.0.0'
 
-const hasPackage = function (packageName, paths) {
+const hasPackage = function (packageName, nextRoot) {
   try {
-    require.resolve(`${packageName}/package.json`, { paths })
+    resolveNextModule(`${packageName}/package.json`, nextRoot)
     return true
   } catch (error) {
     return false

helpers/validateNextUsage.js

@@ -4,6 +4,7 @@ const { writeFile } = require('fs-extra')
 
 const getNextConfig = require('./getNextConfig')
 const getNextRoot = require('./getNextRoot')
+const resolveNextModule = require('./resolveNextModule')
 
 // Checks if site has the correct next.config.js
 const verifyBuildTarget = async ({ failBuild, netlifyConfig }) => {
@@ -31,14 +32,9 @@ const verifyBuildTarget = async ({ failBuild, netlifyConfig }) => {
   // 🐉 We need Next to recalculate "isZeitNow" var so we can set the target, but it's
   // set as an import side effect so we need to clear the require cache first. 🐲
   // https://github.com/vercel/next.js/blob/canary/packages/next/telemetry/ci-info.ts
-  /* eslint-disable node/no-unpublished-require */
 
-  const paths = [nextRoot, process.cwd()]
-
-  delete require.cache[require.resolve('next/dist/telemetry/ci-info', { paths })]
-  delete require.cache[require.resolve('next/dist/next-server/server/config', { paths })]
-
-  /* eslint-enable node/no-unpublished-require */
+  delete require.cache[resolveNextModule('next/dist/telemetry/ci-info', nextRoot)]
+  delete require.cache[resolveNextModule('next/dist/next-server/server/config', nextRoot)]
 
   // Clear memoized cache
   getNextConfig.clear()

helpers/verifyBuildTarget.js

@@ -1,4 +1,4 @@
-const requireNextModule = require('../../../helpers/requireNextModule')
+const resolveNextModule = require('../../../helpers/resolveNextModule')
 
 const removeFileExtension = require('./removeFileExtension')
 
@@ -11,7 +11,11 @@ const getSortedRedirects = (redirects) => {
   const routesWithoutExtensions = redirects.map(({ route }) => removeFileExtension(route))
 
   // Sort the "naked" routes
-  const { getSortedRoutes } = requireNextModule('next/dist/next-server/lib/router/utils/sorted-routes', process.cwd())
+  // eslint-disable-next-line import/no-dynamic-require
+  const { getSortedRoutes } = require(resolveNextModule(
+    'next/dist/next-server/lib/router/utils/sorted-routes',
+    process.cwd(),
+  ))
   const sortedRoutes = getSortedRoutes(routesWithoutExtensions)
 
   // Return original routes in the sorted order