@netlify/build 28.0.0-rc → 28.0.0

package/src/core/main.js

@@ -1,703 +0,0 @@
-/* eslint-disable max-lines, import/max-dependencies */
-import { handleBuildError } from '../error/handle.js'
-import { getErrorInfo } from '../error/info.js'
-import { startErrorMonitor } from '../error/monitor/start.js'
-import { getBufferLogs, getSystemLogger } from '../log/logger.js'
-import { logBuildStart, logTimer, logBuildSuccess } 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 { getSteps } from '../steps/get.js'
-import { runSteps } from '../steps/run_steps.js'
-import { trackBuildComplete } from '../telemetry/main.js'
-import { initTimers, measureDuration } from '../time/main.js'
-import { reportTimers } from '../time/report.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'
-import { getSeverity } from './severity.js'
-
-export { runCoreSteps } from '../steps/run_core_steps.js'
-
-/**
- * Main entry point of Netlify Build.
- * Runs a builds and returns whether it succeeded or not.
- *
- * @param  {object} [flags] - build configuration CLI flags
- * @param  {string} [flags.config] - Path to the configuration file
- * @param  {string} [flags.cwd] - Current directory. Used to retrieve the configuration file
- * @param  {string} [flags.repositoryRoot] - Git repository root directory. Used to retrieve the configuration file.
- * @param  {string} [flags.apiHost] - Netlify API endpoint
- * @param  {string} [flags.token] - Netlify API token for authentication
- * @param  {string} [flags.siteId] - Netlify Site ID
- * @param  {string} [flags.deployId] - Netlify Deploy ID
- * @param  {string} [flags.context] - Build context
- * @param  {string} [flags.branch] - Repository branch
- * @param  {boolean} [flags.dry=false] - Run in dry mode, i.e. printing steps without executing them
- * @param  {string} [flags.nodePath] - Path to the Node.js binary to use in the build command and plugins
- * @param  {boolean} [flags.buffer=false] - Buffer output instead of printing it
- *
- * @returns {object} buildResult
- * @returns {boolean} buildResult.success - Whether build succeeded or failed
- * @returns {number} buildResult.severityCode - Build success/failure status among:
- * 0 (success), 1 (build cancelled), 2 (user error), 3 (plugin error), 4 (system error). Can be used as exit code.
- * @returns {string[]} buildResult.logs - When using the `buffer` option, all log messages
- */
-export default async function buildSite(flags = {}) {
-  const {
-    errorMonitor,
-    framework,
-    mode,
-    logs,
-    debug,
-    systemLogFile,
-    testOpts,
-    statsdOpts,
-    dry,
-    telemetry,
-    buildId,
-    deployId,
-    ...flagsA
-  } = startBuild(flags)
-  const errorParams = { errorMonitor, mode, logs, debug, testOpts }
-
-  try {
-    const {
-      pluginsOptions,
-      netlifyConfig: netlifyConfigA,
-      siteInfo,
-      userNodeVersion,
-      stepsCount,
-      timers,
-      durationNs,
-      configMutations,
-    } = await execBuild({
-      ...flagsA,
-      buildId,
-      systemLogFile,
-      deployId,
-      dry,
-      errorMonitor,
-      mode,
-      logs,
-      debug,
-      testOpts,
-      errorParams,
-    })
-    await handleBuildSuccess({
-      framework,
-      dry,
-      logs,
-      timers,
-      durationNs,
-      statsdOpts,
-    })
-    const { success, severityCode, status } = getSeverity('success')
-    await telemetryReport({
-      buildId,
-      deployId,
-      status,
-      stepsCount,
-      pluginsOptions,
-      durationNs,
-      siteInfo,
-      telemetry,
-      userNodeVersion,
-      framework,
-      testOpts,
-      errorParams,
-    })
-    return { success, severityCode, netlifyConfig: netlifyConfigA, logs, configMutations }
-  } catch (error) {
-    const { severity } = await handleBuildError(error, errorParams)
-    const { pluginsOptions, siteInfo, userNodeVersion } = errorParams
-    const { success, severityCode, status } = getSeverity(severity)
-    await telemetryReport({
-      buildId,
-      deployId,
-      status,
-      pluginsOptions,
-      siteInfo,
-      telemetry,
-      userNodeVersion,
-      framework,
-      testOpts,
-      errorParams,
-    })
-    return { success, severityCode, logs }
-  }
-}
-
-// 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.
-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,
-}) {
-  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,
-  })
-  return {
-    pluginsOptions: pluginsOptionsA,
-    netlifyConfig: netlifyConfigA,
-    siteInfo,
-    userNodeVersion,
-    stepsCount,
-    timers: timersB,
-    configMutations,
-  }
-}
-
-const execBuild = measureDuration(tExecBuild, 'total', { parentTag: 'build_site' })
-
-// Runs a build then report any plugin statuses
-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,
-}) {
-  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,
-    })
-    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,
-}) {
-  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,
-    })
-
-    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,
-}) {
-  const { pluginsSteps, timers: timersA } = await loadPlugins({
-    pluginsOptions,
-    childProcesses,
-    packageJson,
-    timers,
-    logs,
-    debug,
-    verbose,
-  })
-
-  const { steps, events } = 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 }
-}
-
-// Logs and reports that a build successfully ended
-const handleBuildSuccess = async function ({ framework, dry, logs, timers, durationNs, statsdOpts }) {
-  if (dry) {
-    return
-  }
-
-  logBuildSuccess(logs)
-
-  logTimer(logs, durationNs, 'Netlify Build')
-  await reportTimers({ timers, statsdOpts, framework })
-}
-
-// Handles the calls and errors of telemetry reports
-const telemetryReport = async function ({
-  deployId,
-  buildId,
-  status,
-  stepsCount,
-  pluginsOptions,
-  durationNs,
-  siteInfo,
-  telemetry,
-  userNodeVersion,
-  framework,
-  testOpts,
-  errorParams,
-}) {
-  try {
-    await trackBuildComplete({
-      deployId,
-      buildId,
-      status,
-      stepsCount,
-      pluginsOptions,
-      durationNs,
-      siteInfo,
-      telemetry,
-      userNodeVersion,
-      framework,
-      testOpts,
-    })
-  } catch (error) {
-    await handleBuildError(error, errorParams)
-  }
-}
-/* eslint-enable max-lines, import/max-dependencies */

package/src/core/missing_side_file.js

@@ -1,29 +0,0 @@
-import { relative } from 'path'
-
-import { pathExists } from 'path-exists'
-
-import { logMissingSideFile } from '../log/messages/core.js'
-
-// Some files like `_headers` and `_redirects` must be copied to the publish
-// directory to be used in production. When those are present in the repository
-// but not in the publish directory, this most likely indicates that the build
-// command accidentally forgot to copy those. We then print a warning message.
-export const warnOnMissingSideFiles = async function ({
-  buildDir,
-  netlifyConfig: {
-    build: { publish },
-  },
-  logs,
-}) {
-  await Promise.all(SIDE_FILES.map((sideFile) => warnOnMissingSideFile({ logs, sideFile, buildDir, publish })))
-}
-
-const SIDE_FILES = ['_headers', '_redirects']
-
-const warnOnMissingSideFile = async function ({ logs, sideFile, buildDir, publish }) {
-  if (!(await pathExists(`${buildDir}/${sideFile}`)) || (await pathExists(`${publish}/${sideFile}`))) {
-    return
-  }
-
-  logMissingSideFile(logs, sideFile, relative(buildDir, publish))
-}