@netlify/build 19.0.5 → 20.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "19.0.5",
+  "version": "20.0.0",
   "description": "Netlify build module",
   "main": "src/core/main.js",
   "types": "types/index.d.ts",
@@ -36,8 +36,8 @@
     "ci",
     "plugins",
     "continuous-integration",
-    "continuous-delivery",
     "continuous-deployment",
+    "continuous-delivery",
     "continuous-testing",
     "netlify-plugin",
     "netlify"
@@ -61,7 +61,7 @@
     "@netlify/plugin-edge-handlers": "^2.0.0",
     "@netlify/plugins-list": "^5.0.0",
     "@netlify/run-utils": "^3.0.0",
-    "@netlify/zip-it-and-ship-it": "^5.0.0",
+    "@netlify/zip-it-and-ship-it": "^5.1.0",
     "@sindresorhus/slugify": "^1.1.0",
     "ansi-escapes": "^4.3.2",
     "chalk": "^4.1.2",

package/src/error/build.js

@@ -5,7 +5,8 @@ const safeJsonStringify = require('safe-json-stringify')
 const { CUSTOM_ERROR_KEY } = require('./info')
 
 // Retrieve error information from child process and re-build it in current
-// process. We need this since errors are not JSON-serializable.
+// process. We need this since errors static properties are not kept by
+// `v8.serialize()`.
 const jsonToError = function ({ name, message, stack, ...errorProps }) {
   // eslint-disable-next-line unicorn/error-message
   const error = new Error('')
@@ -35,8 +36,6 @@ const assignErrorProp = function (error, name, value) {
 }
 
 // Inverse of `jsonToError()`.
-// IPC uses JSON for the payload. We ensure there are not circular references
-// as those would make the message sending fail.
 const errorToJson = function ({ name, message, stack, [CUSTOM_ERROR_KEY]: customError, ...errorProps }) {
   return {
     ...safeJsonStringify.ensureProperties(errorProps),

package/src/plugins/child/load.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const filterObj = require('filter-obj')
+
 const { getLogic } = require('./logic')
 const { registerTypeScript } = require('./typescript')
 const { validatePlugin } = require('./validate')
@@ -9,27 +11,22 @@ const { validatePlugin } = require('./validate')
 // This also validates the plugin.
 // Do it when parent requests it using the `load` event.
 // Also figure out the list of plugin steps. This is also passed to the parent.
-const load = function ({ pluginPath, inputs, packageJson }) {
+const load = async function ({ pluginPath, inputs, packageJson }) {
   const tsNodeService = registerTypeScript(pluginPath)
-  const logic = getLogic({ pluginPath, inputs, tsNodeService })
+  const logic = await getLogic({ pluginPath, inputs, tsNodeService })
 
   validatePlugin(logic)
 
-  const pluginSteps = getPluginSteps(logic)
+  const methods = filterObj(logic, isEventHandler)
+  const events = Object.keys(methods)
 
   // Context passed to every event handler
-  const context = { pluginSteps, inputs, packageJson }
-
-  return { pluginSteps, context }
-}
+  const context = { methods, inputs, packageJson }
 
-const getPluginSteps = function (logic) {
-  return Object.entries(logic)
-    .filter(isEventHandler)
-    .map(([event, method]) => ({ event, method }))
+  return { events, context }
 }
 
-const isEventHandler = function ([, value]) {
+const isEventHandler = function (event, value) {
   return typeof value === 'function'
 }
 

package/src/plugins/child/logic.js

@@ -1,22 +1,43 @@
 'use strict'
 
+const { pathToFileURL } = require('url')
+
 const { addTsErrorInfo } = require('./typescript')
 
 // Require the plugin file and fire its top-level function.
 // The returned object is the `logic` which includes all event handlers.
-const getLogic = function ({ pluginPath, inputs, tsNodeService }) {
-  const logic = requireLogic(pluginPath, tsNodeService)
+const getLogic = async function ({ pluginPath, inputs, tsNodeService }) {
+  const logic = await importLogic(pluginPath, tsNodeService)
   const logicA = loadLogic({ logic, inputs })
   return logicA
 }
 
-const requireLogic = function (pluginPath, tsNodeService) {
+const importLogic = async function (pluginPath, tsNodeService) {
   try {
-    // eslint-disable-next-line node/global-require, import/no-dynamic-require
-    return require(pluginPath)
+    // `ts-node` is not available programmatically for pure ES modules yet,
+    // which is currently making it impossible for local plugins to use both
+    // pure ES modules and TypeScript.
+    if (tsNodeService !== undefined) {
+      // eslint-disable-next-line node/global-require, import/no-dynamic-require
+      return require(pluginPath)
+    }
+
+    // `pluginPath` is an absolute file path but `import()` needs URLs.
+    // Converting those with `pathToFileURL()` is needed especially on Windows
+    // where the drive letter would not work with `import()`.
+    const returnValue = await import(pathToFileURL(pluginPath))
+    // Plugins should use named exports, but we still support default exports
+    // for backward compatibility with CommonJS
+    return returnValue.default === undefined ? returnValue : returnValue.default
   } catch (error) {
     addTsErrorInfo(error, tsNodeService)
-    error.message = `Could not import plugin:\n${error.message}`
+    // We must change `error.stack` instead of `error.message` because some
+    // errors thrown from `import()` access `error.stack` before throwing.
+    // `error.stack` is lazily instantiated by Node.js, so changing
+    // `error.message` afterwards would not modify `error.stack`. Therefore, the
+    // resulting stack trace, which is printed in the build logs, would not
+    // include the additional message prefix.
+    error.stack = `Could not import plugin:\n${error.stack}`
     throw error
   }
 }

package/src/plugins/child/run.js

@@ -6,11 +6,8 @@ const { cloneNetlifyConfig, getConfigMutations } = require('./diff')
 const { getUtils } = require('./utils')
 
 // Run a specific plugin event handler
-const run = async function (
-  { event, error, constants, envChanges, netlifyConfig },
-  { pluginSteps, inputs, packageJson },
-) {
-  const { method } = pluginSteps.find((pluginStep) => pluginStep.event === event)
+const run = async function ({ event, error, constants, envChanges, netlifyConfig }, { methods, inputs, packageJson }) {
+  const method = methods[event]
   const runState = {}
   const utils = getUtils({ event, constants, runState })
   const netlifyConfigCopy = cloneNetlifyConfig(netlifyConfig)

package/src/plugins/child/validate.js

@@ -1,7 +1,5 @@
 'use strict'
 
-const isPlainObj = require('is-plain-obj')
-
 const { addErrorInfo } = require('../../error/info')
 const { serializeArray } = require('../../log/serialize')
 const { EVENTS } = require('../events')
@@ -9,7 +7,9 @@ const { EVENTS } = require('../events')
 // Validate the shape of a plugin return value
 const validatePlugin = function (logic) {
   try {
-    if (!isPlainObj(logic)) {
+    // This validation must work with the return value of `import()` which has
+    // a `Module` prototype, not `Object`
+    if (typeof logic !== 'object' || logic === null) {
       throw new Error('Plugin must be an object or a function')
     }
 

package/src/plugins/ipc.js

@@ -113,10 +113,9 @@ const sendEventToParent = async function (callId, payload) {
   await promisify(process.send.bind(process))([callId, payload])
 }
 
-// Errors are not serializable through `child_process` `ipc` so we need to
-// convert from/to plain objects.
-// TODO: use `child_process.spawn()` `serialization: 'advanced'` option after
-// dropping support for Node.js <=12.6.0
+// Error static properties are not serializable through `child_process`
+// (which uses `v8.serialize()` under the hood) so we need to convert from/to
+// plain objects.
 const serializePayload = function ({ error = {}, error: { name } = {}, ...payload }) {
   if (name === undefined) {
     return payload

package/src/plugins/load.js

@@ -37,8 +37,8 @@ const loadPlugin = async function (
   const loadEvent = 'load'
 
   try {
-    const { pluginSteps } = await callChild(childProcess, 'load', { pluginPath, inputs, packageJson })
-    const pluginStepsA = pluginSteps.map(({ event }) => ({
+    const { events } = await callChild(childProcess, 'load', { pluginPath, inputs, packageJson })
+    const pluginSteps = events.map((event) => ({
       event,
       packageName,
       loadedFrom,
@@ -46,7 +46,7 @@ const loadPlugin = async function (
       pluginPackageJson,
       childProcess,
     }))
-    return pluginStepsA
+    return pluginSteps
   } catch (error) {
     addErrorInfo(error, {
       plugin: { packageName, pluginPackageJson },

package/src/plugins/spawn.js

@@ -39,6 +39,7 @@ const startPlugin = async function ({ pluginDir, nodePath, buildDir, childEnv })
     execPath: nodePath,
     env: childEnv,
     extendEnv: false,
+    serialization: 'advanced',
   })
 
   try {

package/types/config/netlify_config.d.ts

@@ -14,7 +14,7 @@ interface Redirect {
   signed?: string
   query?: Partial<Record<string, string>>
   headers?: Partial<Record<string, string>>
-  conditions?: Record<'language' | 'role' | 'country', readonly string[]>
+  conditions?: Partial<Record<'Language' | 'Role' | 'Country' | 'Cookie', readonly string[]>>
 }
 
 interface Header {