@netlify/build 24.0.1 → 25.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "24.0.1",
+  "version": "25.0.3",
   "description": "Netlify build module",
   "main": "src/core/main.js",
   "types": "types/index.d.ts",
@@ -55,13 +55,13 @@
   "dependencies": {
     "@bugsnag/js": "^7.0.0",
     "@netlify/cache-utils": "^4.0.0",
-    "@netlify/config": "^16.0.0",
+    "@netlify/config": "^17.0.0",
     "@netlify/functions-utils": "^4.0.0",
     "@netlify/git-utils": "^4.0.0",
     "@netlify/plugin-edge-handlers": "^3.0.0",
     "@netlify/plugins-list": "^6.2.0",
     "@netlify/run-utils": "^4.0.0",
-    "@netlify/zip-it-and-ship-it": "^5.2.0",
+    "@netlify/zip-it-and-ship-it": "^5.3.0",
     "@sindresorhus/slugify": "^1.1.0",
     "ansi-escapes": "^4.3.2",
     "chalk": "^4.1.2",
@@ -112,6 +112,7 @@
     "ava": "^3.15.0",
     "cpy": "^8.1.0",
     "del": "^6.0.0",
+    "fast-safe-stringify": "^2.0.7",
     "get-bin-path": "^5.1.0",
     "get-node": "^11.0.2",
     "get-port": "^5.1.1",

package/src/core/config.js

@@ -1,8 +1,6 @@
 /* eslint-disable max-lines */
 'use strict'
 
-const resolveConfig = require('@netlify/config')
-const { updateConfig, restoreConfig } = require('@netlify/config')
 const mapObj = require('map-obj')
 
 const { getChildEnv } = require('../env/main')
@@ -15,6 +13,8 @@ const { getPackageJson } = require('../utils/package')
 
 const { getUserNodeVersion } = require('./user_node_version')
 
+const netlifyConfigPromise = import('@netlify/config')
+
 // Retrieve immutable options passed to `@netlify/config`.
 // This does not include options which might change during the course of the
 // build:
@@ -78,7 +78,7 @@ const tLoadConfig = async function ({ configOpts, cachedConfig, cachedConfigPath
     siteInfo,
     env,
   } = await resolveInitialConfig(configOpts, cachedConfig, cachedConfigPath)
-  logConfigInfo({ logs, configPath, buildDir, netlifyConfig, context: contextA, debug })
+  await logConfigInfo({ logs, configPath, buildDir, netlifyConfig, context: contextA, debug })
 
   const apiA = addApiErrorHandlers(api)
   const envValues = mapObj(env, (key, { value }) => [key, value])
@@ -108,13 +108,14 @@ const loadConfig = measureDuration(tLoadConfig, 'resolve_config')
 // In the buildbot and CLI, we re-use the already parsed `@netlify/config`
 // return value which is passed as `cachedConfig`/`cachedConfigPath`.
 const resolveInitialConfig = async function (configOpts, cachedConfig, cachedConfigPath) {
+  const { resolveConfig } = await netlifyConfigPromise
   return await resolveConfig({ ...configOpts, cachedConfig, cachedConfigPath })
 }
 
-const logConfigInfo = function ({ logs, configPath, buildDir, netlifyConfig, context, debug }) {
+const logConfigInfo = async function ({ logs, configPath, buildDir, netlifyConfig, context, debug }) {
   logBuildDir(logs, buildDir)
   logConfigPath(logs, configPath)
-  logConfig({ logs, netlifyConfig, debug })
+  await logConfig({ logs, netlifyConfig, debug })
   logContext(logs, context)
 }
 
@@ -126,6 +127,7 @@ const logConfigInfo = function ({ logs, configPath, buildDir, netlifyConfig, con
 // Errors are propagated and assigned to the specific plugin or core step
 // which changed the configuration.
 const resolveUpdatedConfig = async function (configOpts, configMutations) {
+  const { resolveConfig } = await netlifyConfigPromise
   try {
     return await resolveConfig({ ...configOpts, configMutations, debug: false })
   } catch (error) {
@@ -156,6 +158,7 @@ const saveUpdatedConfig = async function ({
     return
   }
 
+  const { updateConfig } = await netlifyConfigPromise
   await updateConfig(configMutations, {
     buildDir,
     configPath,
@@ -184,6 +187,7 @@ const restoreUpdatedConfig = async function ({
     return
   }
 
+  const { restoreConfig } = await netlifyConfigPromise
   await restoreConfig(configMutations, { buildDir, configPath, headersPath, redirectsPath })
 }
 

package/src/core/constants.js

@@ -5,7 +5,7 @@ const { relative, normalize } = require('path')
 const mapObj = require('map-obj')
 const pathExists = require('path-exists')
 
-const { version } = require('../../package.json')
+const { ROOT_PACKAGE_JSON } = require('../utils/json')
 
 const cacheUtilsPromise = import('@netlify/cache-utils')
 
@@ -35,7 +35,7 @@ const getConstants = async function ({
     // Boolean indicating whether the build was run locally (Netlify CLI) or in the production CI
     IS_LOCAL: isLocal,
     // The version of Netlify Build
-    NETLIFY_BUILD_VERSION: version,
+    NETLIFY_BUILD_VERSION: ROOT_PACKAGE_JSON.version,
     // The Netlify Site ID
     SITE_ID: siteId,
     // The Netlify API access token

package/src/core/main.js

@@ -595,7 +595,7 @@ const runBuild = async function ({
     verbose,
   })
 
-  const { steps, events } = getSteps(pluginsSteps)
+  const { steps, events } = await getSteps(pluginsSteps)
 
   if (dry) {
     await doDryRun({ buildDir, steps, netlifyConfig, constants, buildbotServerSocket, logs })

package/src/error/handle.js

@@ -26,7 +26,7 @@ const handleBuildError = async function (
   removeErrorColors(error)
   // Some errors, such as telemetry ones, should not be logged
   if (basicErrorInfo.showInBuildLog) {
-    logBuildError({ error, netlifyConfig, mode, logs, debug, testOpts })
+    await logBuildError({ error, netlifyConfig, mode, logs, debug, testOpts })
   }
   logOldCliVersionError({ mode, testOpts })
   await reportBuildError({ error, errorMonitor, childEnv, logs, testOpts })

package/src/error/monitor/start.js

@@ -3,8 +3,8 @@
 const Bugsnag = require('@bugsnag/js')
 const memoizeOne = require('memoize-one')
 
-const { name, version } = require('../../../package.json')
 const { log } = require('../../log/logger')
+const { ROOT_PACKAGE_JSON } = require('../../utils/json')
 
 const projectRoot = `${__dirname}/../../..`
 
@@ -20,8 +20,8 @@ const startErrorMonitor = function ({ flags: { mode }, logs, bugsnagKey }) {
   try {
     const errorMonitor = startBugsnag({
       apiKey: bugsnagKey,
-      appVersion: `${name} ${version}`,
-      appType: name,
+      appVersion: `${ROOT_PACKAGE_JSON.name} ${ROOT_PACKAGE_JSON.version}`,
+      appType: ROOT_PACKAGE_JSON.name,
       releaseStage,
       logger,
       projectRoot,

package/src/log/messages/config.js

@@ -1,12 +1,12 @@
 'use strict'
 
-const { cleanupConfig } = require('@netlify/config')
-
 const { DEFAULT_FEATURE_FLAGS } = require('../../core/feature_flags')
 const { omit } = require('../../utils/omit')
 const { logMessage, logObject, logSubHeader } = require('../logger')
 const { THEME } = require('../theme')
 
+const netlifyConfigPromise = import('@netlify/config')
+
 const logFlags = function (logs, flags, { debug }) {
   const flagsA = cleanFeatureFlags(flags)
   const hiddenFlags = debug ? HIDDEN_DEBUG_FLAGS : HIDDEN_FLAGS
@@ -69,29 +69,32 @@ const logConfigPath = function (logs, configPath = NO_CONFIG_MESSAGE) {
 
 const NO_CONFIG_MESSAGE = 'No config file was defined: using default values.'
 
-const logConfig = function ({ logs, netlifyConfig, debug }) {
+const logConfig = async function ({ logs, netlifyConfig, debug }) {
   if (!debug) {
     return
   }
 
+  const { cleanupConfig } = await netlifyConfigPromise
   logSubHeader(logs, 'Resolved config')
   logObject(logs, cleanupConfig(netlifyConfig))
 }
 
-const logConfigOnUpdate = function ({ logs, netlifyConfig, debug }) {
+const logConfigOnUpdate = async function ({ logs, netlifyConfig, debug }) {
   if (!debug) {
     return
   }
 
+  const { cleanupConfig } = await netlifyConfigPromise
   logSubHeader(logs, 'Updated config')
   logObject(logs, cleanupConfig(netlifyConfig))
 }
 
-const logConfigOnError = function ({ logs, netlifyConfig, severity }) {
+const logConfigOnError = async function ({ logs, netlifyConfig, severity }) {
   if (netlifyConfig === undefined || severity === 'none') {
     return
   }
 
+  const { cleanupConfig } = await netlifyConfigPromise
   logMessage(logs, THEME.errorSubHeader('Resolved config'))
   logObject(logs, cleanupConfig(netlifyConfig))
 }

package/src/log/messages/core.js

@@ -3,10 +3,10 @@
 const { link } = require('ansi-escapes')
 const prettyMs = require('pretty-ms')
 
-const { name, version } = require('../../../package.json')
 const { getFullErrorInfo } = require('../../error/parse/parse')
 const { serializeLogError } = require('../../error/parse/serialize_log')
 const { roundTimerToMillisecs } = require('../../time/measure')
+const { ROOT_PACKAGE_JSON } = require('../../utils/json')
 const { getLogHeaderFunc } = require('../header_func')
 const { log, logMessage, logWarning, logHeader, logSubHeader, logWarningArray } = require('../logger')
 const { logOldCliVersionError } = require('../old_version')
@@ -17,17 +17,17 @@ const { logConfigOnError } = require('./config')
 const logBuildStart = function (logs) {
   logHeader(logs, 'Netlify Build')
   logSubHeader(logs, 'Version')
-  logMessage(logs, `${name} ${version}`)
+  logMessage(logs, `${ROOT_PACKAGE_JSON.name} ${ROOT_PACKAGE_JSON.version}`)
 }
 
-const logBuildError = function ({ error, netlifyConfig, mode, logs, debug, testOpts }) {
+const logBuildError = async function ({ error, netlifyConfig, mode, logs, debug, testOpts }) {
   const fullErrorInfo = getFullErrorInfo({ error, colors: true, debug })
   const { severity } = fullErrorInfo
   const { title, body } = serializeLogError({ fullErrorInfo })
   const logHeaderFunc = getLogHeaderFunc(error)
   logHeaderFunc(logs, title)
   logMessage(logs, `\n${body}\n`)
-  logConfigOnError({ logs, netlifyConfig, severity })
+  await logConfigOnError({ logs, netlifyConfig, severity })
   logOldCliVersionError({ mode, testOpts })
 }
 

package/src/log/old_version.js

@@ -4,7 +4,7 @@ const { stdout } = require('process')
 
 const UpdateNotifier = require('update-notifier')
 
-const CORE_PACKAGE_JSON = require('../../package.json')
+const { ROOT_PACKAGE_JSON } = require('../utils/json')
 
 // Many build errors happen in local builds that do not use the latest version
 // of `@netlify/build`. We print a warning message on those.
@@ -32,10 +32,10 @@ const getCorePackageJson = function (testOpts) {
     // eslint-disable-next-line fp/no-mutation
     stdout.isTTY = true
 
-    return { ...CORE_PACKAGE_JSON, version: '0.0.1' }
+    return { ...ROOT_PACKAGE_JSON, version: '0.0.1' }
   }
 
-  return CORE_PACKAGE_JSON
+  return ROOT_PACKAGE_JSON
 }
 
 const OLD_VERSION_MESSAGE = `Please update netlify-cli to its latest version.

package/src/plugins/child/load.js

@@ -15,7 +15,7 @@ const load = async function ({ pluginPath, inputs, packageJson, verbose }) {
   const tsNodeService = registerTypeScript(pluginPath)
   const logic = await getLogic({ pluginPath, inputs, tsNodeService })
 
-  validatePlugin(logic)
+  await validatePlugin(logic)
 
   const methods = filterObj(logic, isEventHandler)
   const events = Object.keys(methods)

package/src/plugins/child/validate.js

@@ -2,10 +2,10 @@
 
 const { addErrorInfo } = require('../../error/info')
 const { serializeArray } = require('../../log/serialize')
-const { EVENTS } = require('../events')
+const { listEvents } = require('../events')
 
 // Validate the shape of a plugin return value
-const validatePlugin = function (logic) {
+const validatePlugin = async function (logic) {
   try {
     // This validation must work with the return value of `import()` which has
     // a `Module` prototype, not `Object`
@@ -13,8 +13,9 @@ const validatePlugin = function (logic) {
       throw new Error('Plugin must be an object or a function')
     }
 
+    const EVENTS = await listEvents()
     Object.entries(logic).forEach(([propName, value]) => {
-      validateEventHandler(value, propName)
+      validateEventHandler(value, propName, EVENTS)
     })
   } catch (error) {
     addErrorInfo(error, { type: 'pluginValidation' })
@@ -23,7 +24,7 @@ const validatePlugin = function (logic) {
 }
 
 // All other properties are event handlers
-const validateEventHandler = function (value, propName) {
+const validateEventHandler = function (value, propName, EVENTS) {
   if (!EVENTS.includes(propName)) {
     throw new Error(`Invalid event '${propName}'.
 Please use a valid event name. One of:

package/src/plugins/compatibility.js

@@ -3,6 +3,7 @@ const pEvery = require('p-every')
 const pLocate = require('p-locate')
 const { satisfies, clean: cleanVersion } = require('semver')
 
+const { importJsonFile } = require('../utils/json')
 const { resolvePath } = require('../utils/resolve')
 
 // Retrieve the `expectedVersion` of a plugin:
@@ -107,8 +108,7 @@ const siteDependencyTest = async function ({ dependencyName, allowedVersion, sit
   try {
     // if this is a range we need to get the exact version
     const packageJsonPath = await resolvePath(`${dependencyName}/package.json`, buildDir)
-    // eslint-disable-next-line node/global-require, import/no-dynamic-require
-    const { version } = require(packageJsonPath)
+    const { version } = await importJsonFile(packageJsonPath)
     return satisfies(version, allowedVersion)
   } catch (error) {
     return false

package/src/plugins/events.js

@@ -1,6 +1,11 @@
 'use strict'
 
-const { EVENTS } = require('@netlify/config')
+const netlifyConfigPromise = import('@netlify/config')
+
+const listEvents = async function () {
+  const { EVENTS } = await netlifyConfigPromise
+  return EVENTS
+}
 
 const isAmongEvents = function (events, event) {
   return events.includes(event)
@@ -19,7 +24,7 @@ const runsOnlyOnBuildFailure = isAmongEvents.bind(null, ['onError'])
 const runsAfterDeploy = isAmongEvents.bind(null, ['onSuccess', 'onEnd'])
 
 module.exports = {
-  EVENTS,
+  listEvents,
   isSoftFailEvent,
   runsAlsoOnBuildFailure,
   runsOnlyOnBuildFailure,

package/src/plugins/expected_version.js

@@ -3,6 +3,7 @@
 const { satisfies } = require('semver')
 
 const { addErrorInfo } = require('../error/info')
+const { importJsonFile } = require('../utils/json')
 const { resolvePath } = require('../utils/resolve')
 
 const { getExpectedVersion } = require('./compatibility')
@@ -95,8 +96,7 @@ const isMissingVersion = async function ({ autoPluginsDir, packageName, pluginPa
 
 const getAutoPluginVersion = async function (packageName, autoPluginsDir) {
   const packageJsonPath = await resolvePath(`${packageName}/package.json`, autoPluginsDir)
-  // eslint-disable-next-line node/global-require, import/no-dynamic-require
-  const { version } = require(packageJsonPath)
+  const { version } = await importJsonFile(packageJsonPath)
   return version
 }
 

package/src/plugins/node_version.js

@@ -4,10 +4,8 @@ const { version: currentVersion, execPath } = require('process')
 
 const { satisfies, clean: cleanVersion } = require('semver')
 
-const {
-  engines: { node: nodeVersionSupportedRange },
-} = require('../../package.json')
 const { addErrorInfo } = require('../error/info')
+const { ROOT_PACKAGE_JSON } = require('../utils/json')
 
 // Local plugins and `package.json`-installed plugins use user's preferred Node.js version if higher than our minimum
 // supported version. Else default to the system Node version.
@@ -29,7 +27,7 @@ const addPluginNodeVersion = function ({
   nodePath,
 }) {
   return (loadedFrom === 'local' || loadedFrom === 'package.json') &&
-    satisfies(userNodeVersion, nodeVersionSupportedRange)
+    satisfies(userNodeVersion, ROOT_PACKAGE_JSON.engines.node)
     ? { ...pluginOptions, nodePath, nodeVersion: userNodeVersion }
     : { ...pluginOptions, nodePath: execPath, nodeVersion: currentNodeVersion }
 }

package/src/plugins/options.js

@@ -2,9 +2,9 @@
 
 const { dirname } = require('path')
 
-const corePackageJson = require('../../package.json')
 const { installLocalPluginsDependencies } = require('../install/local')
 const { measureDuration } = require('../time/main')
+const { ROOT_PACKAGE_JSON } = require('../utils/json')
 const { getPackageJson } = require('../utils/package')
 
 const { useManifest } = require('./manifest/main')
@@ -83,10 +83,9 @@ const isNotRedundantCorePlugin = function (pluginOptionsA, index, pluginsOptions
 // Retrieve information about @netlify/build when an error happens there and not
 // in a plugin
 const getSpawnInfo = function () {
-  const { name } = corePackageJson
   return {
-    plugin: { packageName: name, pluginPackageJson: corePackageJson },
-    location: { event: 'load', packageName: name, loadedFrom: 'core', origin: 'core' },
+    plugin: { packageName: ROOT_PACKAGE_JSON.name, pluginPackageJson: ROOT_PACKAGE_JSON },
+    location: { event: 'load', packageName: ROOT_PACKAGE_JSON.name, loadedFrom: 'core', origin: 'core' },
   }
 }
 

package/src/steps/get.js

@@ -1,14 +1,14 @@
 'use strict'
 
-const { EVENTS } = require('../plugins/events')
+const { listEvents } = require('../plugins/events')
 const { buildCommandCore } = require('../plugins_core/build_command')
 const { deploySite } = require('../plugins_core/deploy')
 const { bundleFunctions } = require('../plugins_core/functions')
 
 // Get all build steps
-const getSteps = function (steps) {
+const getSteps = async function (steps) {
   const stepsA = addCoreSteps(steps)
-  const stepsB = sortSteps(stepsA)
+  const stepsB = await sortSteps(stepsA)
   const events = getEvents(stepsB)
   return { steps: stepsB, events }
 }
@@ -18,7 +18,8 @@ const addCoreSteps = function (steps) {
 }
 
 // Sort plugin steps by event order.
-const sortSteps = function (steps) {
+const sortSteps = async function (steps) {
+  const EVENTS = await listEvents()
   return EVENTS.flatMap((event) => steps.filter((step) => step.event === event))
 }
 

package/src/steps/update_config.js

@@ -36,7 +36,7 @@ const updateNetlifyConfig = async function ({
     headersPath: headersPathA,
     redirectsPath: redirectsPathA,
   } = await resolveUpdatedConfig(configOpts, configMutationsA)
-  logConfigOnUpdate({ logs, netlifyConfig: netlifyConfigA, debug })
+  await logConfigOnUpdate({ logs, netlifyConfig: netlifyConfigA, debug })
   // eslint-disable-next-line fp/no-mutation,no-param-reassign
   errorParams.netlifyConfig = netlifyConfigA
   return {

package/src/telemetry/main.js

@@ -5,9 +5,9 @@ const { platform } = require('process')
 const got = require('got')
 const osName = require('os-name')
 
-const { version: buildVersion } = require('../../package.json')
 const { addErrorInfo } = require('../error/info')
 const { roundTimerToMillisecs } = require('../time/measure')
+const { ROOT_PACKAGE_JSON } = require('../utils/json')
 
 const DEFAULT_TELEMETRY_TIMEOUT = 1200
 const DEFAULT_TELEMETRY_CONFIG = {
@@ -89,7 +89,7 @@ const getPayload = function ({
       buildId,
       status,
       steps: stepsCount,
-      buildVersion,
+      buildVersion: ROOT_PACKAGE_JSON.version,
       // We're passing the node version set by the buildbot/user which will run the `build.command` and
       // the `package.json`/locally defined plugins
       nodeVersion: userNodeVersion,

package/src/utils/json.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { promises: fs, readFileSync } = require('fs')
+
+const ROOT_PACKAGE_JSON_PATH = `${__dirname}/../../package.json`
+
+// TODO: Replace with dynamic `import()` once it is supported without
+// experimental flags
+const importJsonFile = async function (filePath) {
+  const fileContents = await fs.readFile(filePath, 'utf8')
+  return JSON.parse(fileContents)
+}
+
+const importJsonFileSync = function (filePath) {
+  // Use sync I/O so it is easier to migrate to `import()` later on
+  const fileContents = readFileSync(filePath, 'utf8')
+  return JSON.parse(fileContents)
+}
+
+const ROOT_PACKAGE_JSON = importJsonFileSync(ROOT_PACKAGE_JSON_PATH)
+
+module.exports = { importJsonFile, ROOT_PACKAGE_JSON }