@netlify/build 24.0.1 → 25.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "24.0.1",
+  "version": "25.0.0",
   "description": "Netlify build module",
   "main": "src/core/main.js",
   "types": "types/index.d.ts",
@@ -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/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/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

@@ -20,14 +20,14 @@ const logBuildStart = function (logs) {
   logMessage(logs, `${name} ${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/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/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/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 {