@netlify/build 28.0.1-beta → 29.0.0-rc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "28.0.1-beta",
+  "version": "29.0.0-rc",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./src/core/main.js",
@@ -56,16 +56,18 @@
   "license": "MIT",
   "dependencies": {
     "@bugsnag/js": "^7.0.0",
-    "@netlify/edge-bundler": "^1.4.2",
+    "@netlify/edge-bundler": "^1.12.1",
     "@netlify/cache-utils": "^4.0.0",
-    "@netlify/config": "^18.1.1",
-    "@netlify/functions-utils": "^4.2.0",
+    "@netlify/config": "^18.1.4",
+    "@netlify/functions-utils": "^4.2.3",
     "@netlify/git-utils": "^4.0.0",
-    "@netlify/plugins-list": "^6.29.0",
+    "@netlify/plugins-list": "^6.36.0",
     "@netlify/run-utils": "^4.0.0",
-    "@netlify/zip-it-and-ship-it": "6.0.1-beta",
+    "@netlify/zip-it-and-ship-it": "5.13.4",
     "@sindresorhus/slugify": "^2.0.0",
     "@types/node": "^16.0.0",
+    "ajv": "^8.11.0",
+    "ajv-errors": "^3.0.0",
     "ansi-escapes": "^5.0.0",
     "chalk": "^5.0.0",
     "clean-stack": "^4.0.0",

package/src/core/build.js

@@ -0,0 +1,554 @@
+import { getErrorInfo } from '../error/info.js'
+import { startErrorMonitor } from '../error/monitor/start.js'
+import { getBufferLogs, getSystemLogger } from '../log/logger.js'
+import { logBuildStart } from '../log/messages/core.js'
+import { loadPlugins } from '../plugins/load.js'
+import { getPluginsOptions } from '../plugins/options.js'
+import { pinPlugins } from '../plugins/pinned_version.js'
+import { startPlugins, stopPlugins } from '../plugins/spawn.js'
+import { addCorePlugins } from '../plugins_core/add.js'
+import { reportStatuses } from '../status/report.js'
+import { getDevSteps, getSteps } from '../steps/get.js'
+import { runSteps } from '../steps/run_steps.js'
+import { initTimers, measureDuration } from '../time/main.js'
+
+import { getConfigOpts, loadConfig } from './config.js'
+import { getConstants } from './constants.js'
+import { doDryRun } from './dry.js'
+import { warnOnLingeringProcesses } from './lingering.js'
+import { warnOnMissingSideFiles } from './missing_side_file.js'
+import { normalizeFlags } from './normalize_flags.js'
+
+// Performed on build start. Must be kept small and unlikely to fail since it
+// does not have proper error handling. Error handling relies on `errorMonitor`
+// being built, which relies itself on flags being normalized.
+export const startBuild = function (flags) {
+  const timers = initTimers()
+
+  const logs = getBufferLogs(flags)
+  logBuildStart(logs)
+
+  const { bugsnagKey, ...flagsA } = normalizeFlags(flags, logs)
+  const errorMonitor = startErrorMonitor({ flags: flagsA, logs, bugsnagKey })
+
+  return { ...flagsA, errorMonitor, logs, timers }
+}
+
+const tExecBuild = async function ({
+  config,
+  defaultConfig,
+  cachedConfig,
+  cachedConfigPath,
+  cwd,
+  repositoryRoot,
+  apiHost,
+  token,
+  siteId,
+  context,
+  branch,
+  baseRelDir,
+  env: envOpt,
+  debug,
+  systemLogFile,
+  verbose,
+  nodePath,
+  functionsDistDir,
+  edgeFunctionsDistDir,
+  cacheDir,
+  dry,
+  mode,
+  offline,
+  deployId,
+  buildId,
+  testOpts,
+  errorMonitor,
+  errorParams,
+  logs,
+  timers,
+  buildbotServerSocket,
+  sendStatus,
+  saveConfig,
+  featureFlags,
+  timeline,
+  devCommand,
+}) {
+  const configOpts = getConfigOpts({
+    config,
+    defaultConfig,
+    cwd,
+    repositoryRoot,
+    apiHost,
+    token,
+    siteId,
+    context,
+    branch,
+    baseRelDir,
+    envOpt,
+    mode,
+    offline,
+    deployId,
+    buildId,
+    testOpts,
+    featureFlags,
+  })
+  const {
+    netlifyConfig,
+    configPath,
+    headersPath,
+    redirectsPath,
+    buildDir,
+    repositoryRoot: repositoryRootA,
+    packageJson,
+    userNodeVersion,
+    childEnv,
+    context: contextA,
+    branch: branchA,
+    token: tokenA,
+    api,
+    siteInfo,
+    timers: timersA,
+  } = await loadConfig({
+    configOpts,
+    cachedConfig,
+    cachedConfigPath,
+    envOpt,
+    debug,
+    logs,
+    nodePath,
+    timers,
+  })
+  const constants = await getConstants({
+    configPath,
+    buildDir,
+    functionsDistDir,
+    edgeFunctionsDistDir,
+    cacheDir,
+    netlifyConfig,
+    siteInfo,
+    apiHost,
+    token: tokenA,
+    mode,
+    testOpts,
+  })
+  const systemLog = getSystemLogger(logs, debug, systemLogFile)
+  const pluginsOptions = addCorePlugins({ netlifyConfig, constants })
+  // `errorParams` is purposely stateful
+  // eslint-disable-next-line fp/no-mutating-assign
+  Object.assign(errorParams, { netlifyConfig, pluginsOptions, siteInfo, childEnv, userNodeVersion })
+
+  const {
+    pluginsOptions: pluginsOptionsA,
+    netlifyConfig: netlifyConfigA,
+    stepsCount,
+    timers: timersB,
+    configMutations,
+  } = await runAndReportBuild({
+    pluginsOptions,
+    netlifyConfig,
+    configOpts,
+    siteInfo,
+    configPath,
+    headersPath,
+    redirectsPath,
+    buildDir,
+    repositoryRoot: repositoryRootA,
+    nodePath,
+    packageJson,
+    userNodeVersion,
+    childEnv,
+    context: contextA,
+    branch: branchA,
+    dry,
+    mode,
+    api,
+    errorMonitor,
+    deployId,
+    errorParams,
+    logs,
+    debug,
+    systemLog,
+    verbose,
+    timers: timersA,
+    sendStatus,
+    saveConfig,
+    testOpts,
+    buildbotServerSocket,
+    constants,
+    featureFlags,
+    timeline,
+    devCommand,
+  })
+  return {
+    pluginsOptions: pluginsOptionsA,
+    netlifyConfig: netlifyConfigA,
+    siteInfo,
+    userNodeVersion,
+    stepsCount,
+    timers: timersB,
+    configMutations,
+  }
+}
+
+export const execBuild = measureDuration(tExecBuild, 'total', { parentTag: 'build_site' })
+
+// Runs a build then report any plugin statuses
+export const runAndReportBuild = async function ({
+  pluginsOptions,
+  netlifyConfig,
+  configOpts,
+  siteInfo,
+  configPath,
+  headersPath,
+  redirectsPath,
+  buildDir,
+  repositoryRoot,
+  nodePath,
+  packageJson,
+  userNodeVersion,
+  childEnv,
+  context,
+  branch,
+  buildbotServerSocket,
+  constants,
+  dry,
+  mode,
+  api,
+  errorMonitor,
+  deployId,
+  errorParams,
+  logs,
+  debug,
+  systemLog,
+  verbose,
+  timers,
+  sendStatus,
+  saveConfig,
+  testOpts,
+  featureFlags,
+  timeline,
+  devCommand,
+}) {
+  try {
+    const {
+      stepsCount,
+      netlifyConfig: netlifyConfigA,
+      statuses,
+      pluginsOptions: pluginsOptionsA,
+      failedPlugins,
+      timers: timersA,
+      configMutations,
+    } = await initAndRunBuild({
+      pluginsOptions,
+      netlifyConfig,
+      configOpts,
+      siteInfo,
+      configPath,
+      headersPath,
+      redirectsPath,
+      buildDir,
+      repositoryRoot,
+      nodePath,
+      packageJson,
+      userNodeVersion,
+      childEnv,
+      context,
+      branch,
+      dry,
+      mode,
+      api,
+      errorMonitor,
+      deployId,
+      errorParams,
+      logs,
+      debug,
+      systemLog,
+      verbose,
+      timers,
+      sendStatus,
+      saveConfig,
+      testOpts,
+      buildbotServerSocket,
+      constants,
+      featureFlags,
+      timeline,
+      devCommand,
+    })
+    await Promise.all([
+      reportStatuses({
+        statuses,
+        childEnv,
+        api,
+        mode,
+        pluginsOptions: pluginsOptionsA,
+        netlifyConfig: netlifyConfigA,
+        errorMonitor,
+        deployId,
+        logs,
+        debug,
+        sendStatus,
+        testOpts,
+      }),
+      pinPlugins({
+        pluginsOptions: pluginsOptionsA,
+        failedPlugins,
+        api,
+        siteInfo,
+        childEnv,
+        mode,
+        netlifyConfig: netlifyConfigA,
+        errorMonitor,
+        logs,
+        debug,
+        testOpts,
+        sendStatus,
+      }),
+    ])
+
+    return {
+      pluginsOptions: pluginsOptionsA,
+      netlifyConfig: netlifyConfigA,
+      stepsCount,
+      timers: timersA,
+      configMutations,
+    }
+  } catch (error) {
+    const [{ statuses }] = getErrorInfo(error)
+    await reportStatuses({
+      statuses,
+      childEnv,
+      api,
+      mode,
+      pluginsOptions,
+      netlifyConfig,
+      errorMonitor,
+      deployId,
+      logs,
+      debug,
+      sendStatus,
+      testOpts,
+    })
+    throw error
+  }
+}
+
+// Initialize plugin processes then runs a build
+const initAndRunBuild = async function ({
+  pluginsOptions,
+  netlifyConfig,
+  configOpts,
+  siteInfo,
+  configPath,
+  headersPath,
+  redirectsPath,
+  buildDir,
+  repositoryRoot,
+  nodePath,
+  packageJson,
+  userNodeVersion,
+  childEnv,
+  context,
+  branch,
+  dry,
+  mode,
+  api,
+  errorMonitor,
+  deployId,
+  errorParams,
+  logs,
+  debug,
+  systemLog,
+  verbose,
+  sendStatus,
+  saveConfig,
+  timers,
+  testOpts,
+  buildbotServerSocket,
+  constants,
+  featureFlags,
+  timeline,
+  devCommand,
+}) {
+  const { pluginsOptions: pluginsOptionsA, timers: timersA } = await getPluginsOptions({
+    pluginsOptions,
+    netlifyConfig,
+    siteInfo,
+    buildDir,
+    nodePath,
+    packageJson,
+    userNodeVersion,
+    mode,
+    api,
+    logs,
+    debug,
+    sendStatus,
+    timers,
+    testOpts,
+    featureFlags,
+  })
+  // eslint-disable-next-line fp/no-mutation, no-param-reassign
+  errorParams.pluginsOptions = pluginsOptionsA
+
+  const { childProcesses, timers: timersB } = await startPlugins({
+    pluginsOptions: pluginsOptionsA,
+    buildDir,
+    childEnv,
+    logs,
+    debug,
+    timers: timersA,
+  })
+
+  try {
+    const {
+      stepsCount,
+      netlifyConfig: netlifyConfigA,
+      statuses,
+      failedPlugins,
+      timers: timersC,
+      configMutations,
+    } = await runBuild({
+      childProcesses,
+      pluginsOptions: pluginsOptionsA,
+      netlifyConfig,
+      configOpts,
+      packageJson,
+      configPath,
+      headersPath,
+      redirectsPath,
+      buildDir,
+      repositoryRoot,
+      nodePath,
+      childEnv,
+      context,
+      branch,
+      dry,
+      buildbotServerSocket,
+      constants,
+      mode,
+      api,
+      errorMonitor,
+      deployId,
+      errorParams,
+      logs,
+      debug,
+      systemLog,
+      verbose,
+      saveConfig,
+      timers: timersB,
+      testOpts,
+      featureFlags,
+      timeline,
+      devCommand,
+    })
+
+    await Promise.all([
+      warnOnMissingSideFiles({ buildDir, netlifyConfig: netlifyConfigA, logs }),
+      warnOnLingeringProcesses({ mode, logs, testOpts }),
+    ])
+
+    return {
+      stepsCount,
+      netlifyConfig: netlifyConfigA,
+      statuses,
+      pluginsOptions: pluginsOptionsA,
+      failedPlugins,
+      timers: timersC,
+      configMutations,
+    }
+  } finally {
+    stopPlugins(childProcesses)
+  }
+}
+
+// Load plugin main files, retrieve their event handlers then runs them,
+// together with the build command
+const runBuild = async function ({
+  childProcesses,
+  pluginsOptions,
+  netlifyConfig,
+  configOpts,
+  packageJson,
+  configPath,
+  headersPath,
+  redirectsPath,
+  buildDir,
+  repositoryRoot,
+  nodePath,
+  childEnv,
+  context,
+  branch,
+  dry,
+  buildbotServerSocket,
+  constants,
+  mode,
+  api,
+  errorMonitor,
+  deployId,
+  errorParams,
+  logs,
+  debug,
+  systemLog,
+  verbose,
+  saveConfig,
+  timers,
+  testOpts,
+  featureFlags,
+  timeline,
+  devCommand,
+}) {
+  const { pluginsSteps, timers: timersA } = await loadPlugins({
+    pluginsOptions,
+    childProcesses,
+    packageJson,
+    timers,
+    logs,
+    debug,
+    verbose,
+  })
+
+  const { steps, events } = timeline === 'dev' ? getDevSteps(devCommand, pluginsSteps) : getSteps(pluginsSteps)
+
+  if (dry) {
+    await doDryRun({ buildDir, steps, netlifyConfig, constants, buildbotServerSocket, logs })
+    return { netlifyConfig }
+  }
+
+  const {
+    stepsCount,
+    netlifyConfig: netlifyConfigA,
+    statuses,
+    failedPlugins,
+    timers: timersB,
+    configMutations,
+  } = await runSteps({
+    steps,
+    buildbotServerSocket,
+    events,
+    configPath,
+    headersPath,
+    redirectsPath,
+    buildDir,
+    repositoryRoot,
+    nodePath,
+    childEnv,
+    context,
+    branch,
+    constants,
+    mode,
+    api,
+    errorMonitor,
+    deployId,
+    errorParams,
+    netlifyConfig,
+    configOpts,
+    logs,
+    debug,
+    systemLog,
+    verbose,
+    saveConfig,
+    timers: timersA,
+    testOpts,
+    featureFlags,
+  })
+
+  return { stepsCount, netlifyConfig: netlifyConfigA, statuses, failedPlugins, timers: timersB, configMutations }
+}

package/src/core/dev.js

@@ -0,0 +1,31 @@
+import { handleBuildError } from '../error/handle.js'
+
+import { execBuild, startBuild } from './build.js'
+import { getSeverity } from './severity.js'
+
+export const startDev = async (devCommand, flags = {}) => {
+  const { errorMonitor, mode, logs, debug, testOpts, ...normalizedFlags } = startBuild(flags)
+  const errorParams = { errorMonitor, mode, logs, debug, testOpts }
+
+  try {
+    const { netlifyConfig: netlifyConfigA, configMutations } = await execBuild({
+      ...normalizedFlags,
+      errorMonitor,
+      errorParams,
+      mode,
+      logs,
+      debug,
+      testOpts,
+      timeline: 'dev',
+      devCommand,
+    })
+    const { success, severityCode } = getSeverity('success')
+
+    return { success, severityCode, netlifyConfig: netlifyConfigA, logs, configMutations }
+  } catch (error) {
+    const { severity, message, stack } = await handleBuildError(error, errorParams)
+    const { success, severityCode } = getSeverity(severity)
+
+    return { success, severityCode, logs, error: { message, stack } }
+  }
+}

package/src/core/feature_flags.js

@@ -18,4 +18,5 @@ export const DEFAULT_FEATURE_FLAGS = {
   buildbot_zisi_esbuild_parser: false,
   edge_functions_cache_cli: false,
   edge_functions_produce_eszip: false,
+  edge_functions_system_logger: false,
 }

package/src/core/flags.js

@@ -145,6 +145,11 @@ Default: false`,
     describe: 'Print user-facing debugging information',
     hidden: true,
   },
+  systemLogFile: {
+    type: 'number',
+    describe: 'File descriptor to where system logs should be piped',
+    hidden: true,
+  },
   verbose: {
     boolean: true,
     describe: 'Print internal debugging information',
@@ -191,4 +196,9 @@ Default: false`,
     boolean: true,
     describe: 'Buffer output instead of printing it',
   },
+  timeline: {
+    string: true,
+    describe: 'The sequence of lifecycle events to run',
+    hidden: true,
+  },
 }