Merge pull request #7 from netlify/test-workflow

feat: transfer core tests + accompanying logic

Author: lindsaylevine

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Plugin Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+        node-version: [12, '*']
+        exclude:
+          - os: macOS-latest
+            node-version: 12
+          - os: windows-latest
+            node-version: 12
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          check-latest: true
+      - name: NPM Install
+        run: npm ci
+      - name: Linting
+        run: npm run format:ci
+        if: "${{ matrix.node-version == '*' }}"
+      - name: Run tests against next@latest
+        run: npm test
+      - name: Install Next.js Canary
+        run: npm install -D next@canary --legacy-peer-deps
+      - name: Run tests against next@canary
+        run: npm test

package-lock.json

@@ -23,7 +23,8 @@
     "prepublishOnly:checkout": "git checkout main",
     "prepublishOnly:pull": "git pull",
     "prepublishOnly:install": "npm ci",
-    "prepublishOnly:test": "npm test"
+    "prepublishOnly:test": "npm test",
+    "test": "next build test/sample && jest"
   },
   "config": {
     "eslint": "--cache --format=codeframe --max-warnings=0 \"{src,scripts,tests,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
@@ -65,12 +66,15 @@
   },
   "devDependencies": {
     "@netlify/eslint-config-node": "^3.2.6",
+    "cpy": "^8.1.2",
     "eslint-config-next": "^11.0.0",
     "husky": "^4.3.0",
     "jest": "^27.0.0",
+    "path-exists": "^4.0.0",
     "prettier": "^2.1.2",
     "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "react-dom": "^17.0.1",
+    "tmp-promise": "^3.0.2"
   },
   "husky": {
     "hooks": {

package.json

@@ -0,0 +1,7 @@
+const HANDLER_FUNCTION_NAME = '___netlify-handler'
+const ODB_FUNCTION_NAME = '___netlify-odb-handler'
+
+module.exports = {
+  HANDLER_FUNCTION_NAME,
+  ODB_FUNCTION_NAME,
+}

src/constants.js

@@ -0,0 +1,26 @@
+const path = require('path')
+
+const { copyFile, ensureDir, writeFile } = require('fs-extra')
+
+const { HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME } = require('../constants')
+
+const getHandler = require('./getHandler')
+
+const DEFAULT_FUNCTIONS_SRC = 'netlify/functions'
+
+const generateFunctions = async ({ FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC }) => {
+  const FUNCTION_DIR = INTERNAL_FUNCTIONS_SRC || FUNCTIONS_SRC
+  const bridgeFile = require.resolve('@vercel/node/dist/bridge')
+
+  const writeHandler = async (func, isODB) => {
+    const handlerSource = await getHandler(isODB)
+    await ensureDir(path.join(FUNCTION_DIR, func))
+    await writeFile(path.join(FUNCTION_DIR, func, `${func}.js`), handlerSource)
+    await copyFile(bridgeFile, path.join(FUNCTION_DIR, func, 'bridge.js'))
+  }
+
+  await writeHandler(HANDLER_FUNCTION_NAME, false)
+  await writeHandler(ODB_FUNCTION_NAME, true)
+}
+
+module.exports = generateFunctions

src/helpers/generateFunctions.js

@@ -0,0 +1,20 @@
+const usesBuildCommand = require('./usesBuildCommand')
+
+// Takes 1. Netlify config's build details and
+// 2. the project's package.json scripts to determine if
+// the Next.js app uses static HTML export
+const isStaticExportProject = ({ build, scripts }) => {
+  const NEXT_EXPORT_COMMAND = 'next export'
+
+  const isStaticExport = usesBuildCommand({ build, scripts, command: NEXT_EXPORT_COMMAND })
+
+  if (isStaticExport) {
+    console.log(
+      'NOTE: Static HTML export Next.js projects (projects that use `next export`) do not require most of this plugin. For these sites, this plugin *only* caches builds.',
+    )
+  }
+
+  return isStaticExport
+}
+
+module.exports = isStaticExportProject

src/helpers/isStaticExportProject.js

@@ -0,0 +1,20 @@
+const { HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME } = require('../constants')
+
+const setIncludedFiles = ({ netlifyConfig, distDir }) => {
+  // Serverless functions need parts of build dist in runtime env
+  ;[HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME].forEach((functionName) => {
+    if (!netlifyConfig.functions[functionName]) {
+      netlifyConfig.functions[functionName] = {}
+    }
+    if (!netlifyConfig.functions[functionName].included_files) {
+      netlifyConfig.functions[functionName].included_files = []
+    }
+    netlifyConfig.functions[functionName].included_files.push(
+      `${distDir}/server/**`,
+      `${distDir}/*.json`,
+      `${distDir}/BUILD_ID`,
+    )
+  })
+}
+
+module.exports = setIncludedFiles

src/helpers/setIncludedFiles.js

@@ -0,0 +1,53 @@
+// Checks all the cases for which the plugin should do nothing
+const { redBright, yellowBright } = require('chalk')
+
+const isStaticExportProject = require('./isStaticExportProject')
+const usesBuildCommand = require('./usesBuildCommand')
+
+const shouldSkipPlugin = ({ netlifyConfig, packageJson, failBuild }) => {
+  const hasNoPackageJson = Object.keys(packageJson).length === 0
+  if (hasNoPackageJson) {
+    return failBuild('Could not find a package.json for this project')
+  }
+
+  // The env var skips the auto-detection
+  const envVar = process.env.NEXT_PLUGIN_FORCE_RUN
+  if (envVar === 'false' || envVar === '0' || envVar === false) {
+    console.log(
+      yellowBright`The env var NEXT_PLUGIN_FORCE_RUN was set to ${JSON.stringify(
+        envVar,
+      )}, so auto-detection is disabled and the plugin will not run`,
+    )
+    return true
+  }
+  if (envVar === 'true' || envVar === '1' || envVar === true) {
+    console.log(
+      yellowBright`The env var NEXT_PLUGIN_FORCE_RUN was set to ${JSON.stringify(
+        envVar,
+      )}, so auto-detection is disabled and the plugin will run regardless`,
+    )
+    return false
+  }
+  // Otherwise use auto-detection
+
+  const { build } = netlifyConfig
+  const { scripts = {} } = packageJson
+
+  if (!build.command) {
+    console.log(
+      redBright`⚠️  Warning: No build command specified in the site's Netlify config, so plugin will not run. This deploy will fail unless you have already exported the site.  ⚠️`,
+    )
+    return true
+  }
+
+  if (usesBuildCommand({ build, scripts, command: 'build-storybook' })) {
+    console.log(
+      yellowBright`Site seems to be building a Storybook rather than the Next.js site, so the Essential Next.js plugin will not run. If this is incorrect, set NEXT_PLUGIN_FORCE_RUN to true`,
+    )
+    return true
+  }
+
+  return isStaticExportProject({ build, scripts })
+}
+
+module.exports = shouldSkipPlugin

src/helpers/shouldSkipPlugin.js

@@ -0,0 +1,36 @@
+const parseNpmScript = require('@netlify/parse-npm-script')
+
+const COMMAND_PLACEHOLDER = '___netlifybuildcommand'
+
+// Does the build command include this value, either directly or via an npm script?
+const usesBuildCommand = ({ build, scripts, command }) => {
+  if (!build.command) return false
+
+  if (build.command.includes(command)) {
+    return true
+  }
+
+  if (!build.command.includes('npm run') && !build.command.includes('yarn')) {
+    return false
+  }
+
+  // Insert a fake script to represent the build command
+
+  const commands = { ...scripts, [COMMAND_PLACEHOLDER]: build.command }
+
+  // This resolves the npm script that is actually being run
+  try {
+    const { raw } = parseNpmScript({ scripts: commands }, COMMAND_PLACEHOLDER)
+    return raw.some((script) => script.includes(command))
+  } catch (error) {
+    console.error(
+      `Static export detection disabled because we could not parse your build command: ${error.message}
+The build command is "${build.command}" and the available npm scripts are: ${Object.keys(scripts)
+        .map((script) => `"${script}"`)
+        .join(', ')}
+If the site does use static export then you can set the env var NEXT_PLUGIN_FORCE_RUN to "false" or uninstall the plugin. See https://ntl.fyi/remove-plugin for instructions.`,
+    )
+  }
+}
+
+module.exports = usesBuildCommand

src/helpers/usesBuildCommand.js

@@ -0,0 +1,53 @@
+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
+// the Next.js version. However, this requires them to install "next" in their
+// site.
+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
+  if (!hasPackage('next', nextRoot)) {
+    return failBuild(
+      `This site does not seem to be using Next.js. Please run "npm install next" in the repository.
+If you are using a monorepo, please see the docs on configuring your site: https://ntl.fyi/next-monorepos`,
+    )
+  }
+
+  // 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 import/no-dynamic-require
+  const { version } = require(resolveNextModule(`next/package.json`, nextRoot))
+
+  console.log(`Using Next.js ${yellowBright(version)}`)
+
+  if (ltVersion(version, MIN_VERSION)) {
+    return failBuild(`Please upgrade to Next.js ${MIN_VERSION} or later.`)
+  }
+
+  // Recent Next.js versions are sometimes unstable and we might not officially
+  // support them yet. However, they might still work for some users, so we
+  // only print a warning
+  if (gteVersion(version, MIN_EXPERIMENTAL_VERSION)) {
+    console.log(yellowBright(`Warning: support for Next.js >=${MIN_EXPERIMENTAL_VERSION} is experimental`))
+  }
+}
+
+const MIN_VERSION = '11.1.2'
+const MIN_EXPERIMENTAL_VERSION = '11.2.0'
+
+const hasPackage = function (packageName, nextRoot) {
+  try {
+    resolveNextModule(`${packageName}/package.json`, nextRoot)
+    return true
+  } catch (error) {
+    return false
+  }
+}
+
+module.exports = validateNextUsage

src/helpers/validateNextUsage.js

@@ -2,7 +2,7 @@ const { yellowBright } = require('chalk')
 
 const verifyBuildTarget = (target) => {
   if (target !== 'server') {
-    // TO-DO: This will only work for Next > 11.1.2
+    // NOTE: This will only work for Next > 11.1.2
     console.log(yellowBright`Forcing site to build with target: server`)
     process.env.NEXT_PRIVATE_TARGET = 'server'
   }

src/helpers/verifyBuildTarget.js

@@ -0,0 +1,16 @@
+const { satisfies } = require('semver')
+
+// This is when the esbuild dynamic import support was added
+const REQUIRED_BUILD_VERSION = '>=15.11.5'
+
+const verifyNetlifyBuildVersion = ({ IS_LOCAL, NETLIFY_BUILD_VERSION, failBuild }) => {
+  // We check for build version because that's what's available to us, but prompt about the cli because that's what they can upgrade
+  if (IS_LOCAL && !satisfies(NETLIFY_BUILD_VERSION, REQUIRED_BUILD_VERSION, { includePrerelease: true })) {
+    return failBuild(
+      `This version of the Essential Next.js plugin requires netlify-cli@4.4.2 or higher. Please upgrade and try again.
+You can do this by running: "npm install -g netlify-cli@latest" or "yarn global add netlify-cli@latest"`,
+    )
+  }
+}
+
+module.exports = verifyNetlifyBuildVersion

src/helpers/verifyNetlifyBuildVersion.js

@@ -0,0 +1,19 @@
+const path = require('path')
+
+const verifyPublishDir = ({ netlifyConfig, siteRoot, distDir, failBuild }) => {
+  const { publish } = netlifyConfig.build
+  const nextSiteNotInProjectRoot = siteRoot !== process.cwd()
+
+  // Publish dir needs to match distDir
+  if (
+    !publish ||
+    (nextSiteNotInProjectRoot && publish !== path.join(siteRoot, distDir)) ||
+    (!nextSiteNotInProjectRoot && publish !== path.join(process.cwd(), distDir))
+  ) {
+    return failBuild(
+      `You set your publish directory to "${publish}". Your publish directory should be set to your distDir (defaults to .next or is configured in your next.config.js). If your site is rooted in a subdirectory, your publish directory should be {yourSiteRoot}/{distDir}.`,
+    )
+  }
+}
+
+module.exports = verifyPublishDir

src/helpers/verifyPublishDir.js

@@ -45,8 +45,8 @@ const getNetlifyRoutes = (nextRoute) => {
   return netlifyRoutes
 }
 
-const writeRedirects = async ({ publishDir = 'out', nextRoot = process.cwd(), netlifyConfig }) => {
-  const { dynamicRoutes } = await readJSON(path.join(nextRoot, '.next', 'prerender-manifest.json'))
+const writeRedirects = async ({ siteRoot = process.cwd(), netlifyConfig }) => {
+  const { dynamicRoutes } = await readJSON(path.join(siteRoot, '.next', 'prerender-manifest.json'))
 
   const redirects = []
   Object.entries(dynamicRoutes).forEach(([route, { dataRoute, fallback }]) => {
@@ -76,7 +76,7 @@ const writeRedirects = async ({ publishDir = 'out', nextRoot = process.cwd(), ne
   // /_next/static/* /static/:splat 200
   // /* ${HANDLER_FUNCTION_PATH} 200
   //     `;
-  // await writeFile(path.join(nextRoot, publishDir, "_redirects"), odbRedirects);
+  // await writeFile(path.join(siteRoot, publishDir, "_redirects"), odbRedirects);
 }
 
 module.exports = writeRedirects