fix: handle next imports

Author: ascorbic

Diff for: helpers/getNextConfig.js

@@ -4,13 +4,15 @@ const { cwd: getCwd } = require('process')
 
 const moize = require('moize')
 
+const requireNextModule = require('./requireNextModule')
+
 // 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 } = require('next/constants')
-  const loadConfig = require('next/dist/next-server/server/config').default
+  const { PHASE_PRODUCTION_BUILD } = requireNextModule('next/constants', cwd)
+  const loadConfig = requireNextModule('next/dist/next-server/server/config', cwd).default
 
   try {
     return await loadConfig(PHASE_PRODUCTION_BUILD, cwd)

Diff for: 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 requireNextModule = (module, nextRoot) => {
+  const resolved = require.resolve(module, { paths: [nextRoot, process.cwd()] })
+  if (resolved) {
+    // eslint-disable-next-line import/no-dynamic-require
+    return require(resolved)
+  }
+  throw new Error(`Could not load module ${module}`)
+}
+
+module.exports = requireNextModule

Diff for: helpers/validateNextUsage.js

@@ -1,12 +1,17 @@
 const { yellowBright } = require('chalk')
 const { lt: ltVersion, gte: gteVersion } = require('semver')
 
+const getNextRoot = require('./getNextRoot')
+
 // Ensure Next.js is available.
 // We use `peerDependencies` instead of `dependencies` so that users can choose
 // the Next.js version. However, this requires them to install "next" in their
 // site.
-const validateNextUsage = function (failBuild) {
-  if (!hasPackage('next')) {
+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)) {
     return failBuild(
       'This site does not seem to be using Next.js. Please run "npm install next" or "yarn next" in the repository.',
     )
@@ -15,9 +20,12 @@ const validateNextUsage = function (failBuild) {
   // 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
-  const { version } = require('next/package.json')
+  // 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)
   if (ltVersion(version, MIN_VERSION)) {
-    return failBuild(`Please upgrade to Next.js ${MIN_VERSION} or later`)
+    return failBuild(`Please upgrade to Next.js ${MIN_VERSION} or later. Found ${version}.`)
   }
 
   // Recent Next.js versions are sometimes unstable and we might not officially
@@ -31,9 +39,9 @@ const validateNextUsage = function (failBuild) {
 const MIN_VERSION = '10.0.6'
 const MIN_EXPERIMENTAL_VERSION = '11.0.0'
 
-const hasPackage = function (packageName) {
+const hasPackage = function (packageName, paths) {
   try {
-    require(`${packageName}/package.json`)
+    require.resolve(`${packageName}/package.json`, { paths })
     return true
   } catch (error) {
     return false

Diff for: helpers/verifyBuildTarget.js

@@ -33,8 +33,10 @@ const verifyBuildTarget = async ({ failBuild, netlifyConfig }) => {
   // https://github.com/vercel/next.js/blob/canary/packages/next/telemetry/ci-info.ts
   /* eslint-disable node/no-unpublished-require */
 
-  delete require.cache[require.resolve('next/dist/telemetry/ci-info')]
-  delete require.cache[require.resolve('next/dist/next-server/server/config')]
+  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 */
 
@@ -45,7 +47,7 @@ const verifyBuildTarget = async ({ failBuild, netlifyConfig }) => {
 
   if (!configFile) {
     await writeFile(
-      path.resolve('next.config.js'),
+      path.resolve(nextRoot, 'next.config.js'),
       `
 module.exports = {
   // Supported targets are "serverless" and "experimental-serverless-trace"

Diff for: index.js

@@ -19,7 +19,7 @@ module.exports = {
   async onPreBuild({ netlifyConfig, packageJson, utils, constants }) {
     const { failBuild } = utils.build
 
-    validateNextUsage(failBuild)
+    validateNextUsage({ failBuild, netlifyConfig })
 
     const hasNoPackageJson = Object.keys(packageJson).length === 0
     if (hasNoPackageJson) {

Diff for: src/lib/helpers/getI18n.js

@@ -1,4 +1,4 @@
-// Get the i1i8n details specified in next.config.js, if any
+// Get the ii8n details specified in next.config.js, if any
 const getNextConfig = require('../../../helpers/getNextConfig')
 
 const getI18n = async () => {

Diff for: src/lib/helpers/getSortedRedirects.js

@@ -1,3 +1,5 @@
+const requireNextModule = require('../../../helpers/requireNextModule')
+
 const removeFileExtension = require('./removeFileExtension')
 
 // Return an array of redirects sorted in order of specificity, i.e., more generic
@@ -8,11 +10,8 @@ const getSortedRedirects = (redirects) => {
   // after sorting
   const routesWithoutExtensions = redirects.map(({ route }) => removeFileExtension(route))
 
-  // We cannot load `next` at the top-level because we validate whether the
-  // site is using `next` inside `onPreBuild`.
   // Sort the "naked" routes
-  // eslint-disable-next-line node/no-unpublished-require
-  const { getSortedRoutes } = require('next/dist/next-server/lib/router/utils/sorted-routes')
+  const { getSortedRoutes } = requireNextModule('next/dist/next-server/lib/router/utils/sorted-routes', process.cwd())
   const sortedRoutes = getSortedRoutes(routesWithoutExtensions)
 
   // Return original routes in the sorted order

Diff for: src/tests/fixtures/next.config.js-with-function.js

@@ -1,9 +1,8 @@
-const { PHASE_PRODUCTION_BUILD } = require('next/constants')
 
 module.exports = (phase, { defaultConfig }) => {
   // next-on-netlify uses settings from PHASE_PRODUCTION_BUILD
   // This is the same phase that is used when running `next build`
-  if (phase === PHASE_PRODUCTION_BUILD) {
+  if (phase === "phase-production-build") {
     return {
       target: 'serverless',
       distDir: '.myCustomDir',