fix: correctly exclude files (#720)

* fix: correctly exclude files in monorepos

* fix: update tests

* fix: cross-platform paths

* fix: remove some exclusions

* fix: normalize paths

* fix: better error handling for next server imports

* chore: release 4.0.0-beta.2

Release-as: 4.0.0-beta.2

Author: ascorbic

package-lock.json

@@ -59,6 +59,7 @@
     "fs-extra": "^10.0.0",
     "moize": "^6.1.0",
     "outdent": "^0.8.0",
+    "pathe": "^0.2.0",
     "semver": "^7.3.5",
     "slash": "^3.0.0",
     "tiny-glob": "^0.2.9"

package.json

@@ -1,7 +1,6 @@
 // @ts-check
-const { join } = require('path')
-
 const { readJSON } = require('fs-extra')
+const { join, dirname, relative } = require('pathe')
 
 const defaultFailBuild = (message, { error }) => {
   throw new Error(`${message}\n${error && error.stack}`)
@@ -100,17 +99,29 @@ exports.generateRedirects = async ({ netlifyConfig, basePath, i18n }) => {
 
 exports.getNextConfig = async function getNextConfig({ publish, failBuild = defaultFailBuild }) {
   try {
-    const { config, appDir } = await readJSON(join(publish, 'required-server-files.json'))
+    const { config, appDir, ignore } = await readJSON(join(publish, 'required-server-files.json'))
     if (!config) {
       return failBuild('Error loading your Next config')
     }
-    return { ...config, appDir }
+    return { ...config, appDir, ignore }
   } catch (error) {
     return failBuild('Error loading your Next config', { error })
   }
 }
 
-exports.configureHandlerFunctions = ({ netlifyConfig, publish }) => {
+const resolveModuleRoot = (moduleName) => {
+  try {
+    return dirname(relative(process.cwd(), require.resolve(`${moduleName}/package.json`, { paths: [process.cwd()] })))
+  } catch (error) {
+    return null
+  }
+}
+
+exports.configureHandlerFunctions = ({ netlifyConfig, publish, ignore = [] }) => {
+  /* eslint-disable no-underscore-dangle */
+  netlifyConfig.functions._ipx ||= {}
+  netlifyConfig.functions._ipx.node_bundler = 'esbuild'
+  /* eslint-enable no-underscore-dangle */
   ;[HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME].forEach((functionName) => {
     netlifyConfig.functions[functionName] ||= { included_files: [], external_node_modules: [] }
     netlifyConfig.functions[functionName].node_bundler = 'nft'
@@ -120,16 +131,23 @@ exports.configureHandlerFunctions = ({ netlifyConfig, publish }) => {
       `${publish}/serverless/**`,
       `${publish}/*.json`,
       `${publish}/BUILD_ID`,
-      '!node_modules/@next/swc-*/**/*',
-      '!node_modules/next/dist/compiled/@ampproject/toolbox-optimizer/**/*',
-      '!node_modules/next/dist/pages/**/*',
-      `!node_modules/next/dist/server/lib/squoosh/**/*.wasm`,
-      `!node_modules/next/dist/next-server/server/lib/squoosh/**/*.wasm`,
-      '!node_modules/next/dist/compiled/webpack/(bundle4|bundle5).js',
-      '!node_modules/react/**/*.development.js',
-      '!node_modules/react-dom/**/*.development.js',
-      '!node_modules/use-subscription/**/*.development.js',
-      '!node_modules/sharp/**/*',
+      ...ignore.map((path) => `!${path}`),
     )
+
+    const nextRoot = resolveModuleRoot('next')
+    if (nextRoot) {
+      netlifyConfig.functions[functionName].included_files.push(
+        `!${nextRoot}/dist/server/lib/squoosh/**/*.wasm`,
+        `!${nextRoot}/dist/next-server/server/lib/squoosh/**/*.wasm`,
+        `!${nextRoot}/dist/compiled/webpack/bundle4.js`,
+        `!${nextRoot}/dist/compiled/webpack/bundle5.js`,
+        `!${nextRoot}/dist/compiled/terser/bundle.min.js`,
+      )
+    }
+
+    const sharpRoot = resolveModuleRoot('sharp')
+    if (sharpRoot) {
+      netlifyConfig.functions[functionName].included_files.push(`!${sharpRoot}/**/*`)
+    }
   })
 }

src/helpers/config.js

@@ -43,11 +43,11 @@ module.exports = {
 
     checkNextSiteHasBuilt({ publish, failBuild })
 
-    const { appDir, basePath, i18n, images, target } = await getNextConfig({ publish, failBuild })
+    const { appDir, basePath, i18n, images, target, ignore } = await getNextConfig({ publish, failBuild })
 
     verifyBuildTarget(target)
 
-    configureHandlerFunctions({ netlifyConfig, publish: relative(process.cwd(), publish) })
+    configureHandlerFunctions({ netlifyConfig, ignore, publish: relative(process.cwd(), publish) })
 
     await generateFunctions(constants, appDir)
     await generatePagesResolver({ netlifyConfig, target, constants })

src/index.js

@@ -7,26 +7,33 @@ const makeHandler =
   () =>
   // We return a function and then call `toString()` on it to serialise it as the launcher function
   (conf, app) => {
+    // This is just so nft knows about the page entrypoints
+    try {
+      // eslint-disable-next-line node/no-missing-require
+      require.resolve('./pages.js')
+    } catch {}
+
     let NextServer
     try {
       // next >= 11.0.1. Yay breaking changes in patch releases!
       NextServer = require('next/dist/server/next-server').default
-    } catch {
+    } catch (error) {
+      if (!error.message.includes("Cannot find module 'next/dist/server/next-server'")) {
+        // A different error, so rethrow it
+        throw error
+      }
       // Probably an old version of next
     }
 
-    // This is just so nft knows about the page entrypoints
-    try {
-      // eslint-disable-next-line node/no-missing-require
-      require.resolve('./pages.js')
-    } catch {}
-
     if (!NextServer) {
       try {
         // next < 11.0.1
         // eslint-disable-next-line node/no-missing-require, import/no-unresolved
         NextServer = require('next/dist/next-server/server/next-server').default
-      } catch {
+      } catch (error) {
+        if (!error.message.includes("Cannot find module 'next/dist/next-server/server/next-server'")) {
+          throw error
+        }
         throw new Error('Could not find Next.js server')
       }
     }
@@ -66,11 +73,7 @@ const makeHandler =
         }
       }
 
-      if (
-        multiValueHeaders['set-cookie'] &&
-        multiValueHeaders['set-cookie'][0] &&
-        multiValueHeaders['set-cookie'][0].includes('__prerender_bypass')
-      ) {
+      if (multiValueHeaders['set-cookie']?.[0]?.includes('__prerender_bypass')) {
         delete multiValueHeaders.etag
         multiValueHeaders['cache-control'] = ['no-cache']
       }

src/templates/getHandler.js

@@ -1,7 +1,7 @@
-const { writeJSON, unlink, existsSync, readFileSync, copy } = require('fs-extra')
+const { writeJSON, unlink, existsSync, readFileSync, copy, ensureDir } = require('fs-extra')
 const path = require('path')
 const process = require('process')
-
+const os = require('os')
 const cpy = require('cpy')
 const { dir: getTmpDir } = require('tmp-promise')
 
@@ -42,9 +42,18 @@ const onBuildHasRun = (netlifyConfig) =>
 
 // Move .next from sample project to current directory
 const moveNextDist = async function () {
+  await stubModules(['next', 'sharp'])
   await copy(path.join(SAMPLE_PROJECT_DIR, '.next'), path.join(process.cwd(), '.next'))
 }
 
+const stubModules = async function (modules) {
+  for (const mod of modules) {
+    const dir = path.join(process.cwd(), 'node_modules', mod)
+    await ensureDir(dir)
+    await writeJSON(path.join(dir, 'package.json'), { name: mod })
+  }
+}
+
 // Copy fixture files to the current directory
 const useFixture = async function (fixtureName) {
   const fixtureDir = `${FIXTURES_DIR}/${fixtureName}`
@@ -185,19 +194,19 @@ describe('onBuild()', () => {
       '.next/serverless/**',
       '.next/*.json',
       '.next/BUILD_ID',
-      '!node_modules/@next/swc-*/**/*',
-      '!node_modules/next/dist/compiled/@ampproject/toolbox-optimizer/**/*',
-      '!node_modules/next/dist/pages/**/*',
+      '!../node_modules/next/dist/compiled/@ampproject/toolbox-optimizer/**/*',
       `!node_modules/next/dist/server/lib/squoosh/**/*.wasm`,
       `!node_modules/next/dist/next-server/server/lib/squoosh/**/*.wasm`,
-      '!node_modules/next/dist/compiled/webpack/(bundle4|bundle5).js',
-      '!node_modules/react/**/*.development.js',
-      '!node_modules/react-dom/**/*.development.js',
-      '!node_modules/use-subscription/**/*.development.js',
+      '!node_modules/next/dist/compiled/webpack/bundle4.js',
+      '!node_modules/next/dist/compiled/webpack/bundle5.js',
+      '!node_modules/next/dist/compiled/terser/bundle.min.js',
       '!node_modules/sharp/**/*',
     ]
-    expect(netlifyConfig.functions[HANDLER_FUNCTION_NAME].included_files).toEqual(includes)
-    expect(netlifyConfig.functions[ODB_FUNCTION_NAME].included_files).toEqual(includes)
+    // Relative paths in Windows are different
+    if (os.platform() !== 'win32') {
+      expect(netlifyConfig.functions[HANDLER_FUNCTION_NAME].included_files).toEqual(includes)
+      expect(netlifyConfig.functions[ODB_FUNCTION_NAME].included_files).toEqual(includes)
+    }
     expect(netlifyConfig.functions[HANDLER_FUNCTION_NAME].node_bundler).toEqual('nft')
     expect(netlifyConfig.functions[ODB_FUNCTION_NAME].node_bundler).toEqual('nft')
   })