@netlify/build 25.0.3 → 26.1.0

package/src/steps/error.js

@@ -1,10 +1,8 @@
-'use strict'
-
-const { cancelBuild } = require('../error/cancel')
-const { handleBuildError } = require('../error/handle')
-const { getFullErrorInfo, parseErrorInfo } = require('../error/parse/parse')
-const { serializeErrorStatus } = require('../error/parse/serialize_status')
-const { isSoftFailEvent } = require('../plugins/events')
+import { cancelBuild } from '../error/cancel.js'
+import { handleBuildError } from '../error/handle.js'
+import { getFullErrorInfo, parseErrorInfo } from '../error/parse/parse.js'
+import { serializeErrorStatus } from '../error/parse/serialize_status.js'
+import { isSoftFailEvent } from '../plugins/events.js'
 
 // Handle build command errors and plugin errors:
 //  - usually, propagate the error to make the build stop.
@@ -13,7 +11,7 @@ const { isSoftFailEvent } = require('../plugins/events')
 //    stop, but are still reported, and prevent future events from the same
 //    plugin.
 // This also computes error statuses that are sent to the API.
-const handleStepError = function ({
+export const handleStepError = function ({
   event,
   newError,
   childEnv,
@@ -90,7 +88,7 @@ const handleFailBuild = function ({ fullErrorInfo, newError }) {
 }
 
 // Unlike community plugins, core plugin bugs should be handled as system errors
-const getPluginErrorType = function (error, loadedFrom) {
+export const getPluginErrorType = function (error, loadedFrom) {
   if (!isCorePluginBug(error, loadedFrom)) {
     return {}
   }
@@ -102,5 +100,3 @@ const isCorePluginBug = function (error, loadedFrom) {
   const { severity } = parseErrorInfo(error)
   return severity === 'warning' && loadedFrom === 'core'
 }
-
-module.exports = { handleStepError, getPluginErrorType }

package/src/steps/get.js

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

package/src/steps/plugin.js

@@ -1,16 +1,14 @@
-'use strict'
+import { addErrorInfo } from '../error/info.js'
+import { logStepCompleted } from '../log/messages/ipc.js'
+import { pipePluginOutput, unpipePluginOutput } from '../log/stream.js'
+import { callChild } from '../plugins/ipc.js'
+import { getSuccessStatus } from '../status/success.js'
 
-const { addErrorInfo } = require('../error/info')
-const { logStepCompleted } = require('../log/messages/ipc')
-const { pipePluginOutput, unpipePluginOutput } = require('../log/stream')
-const { callChild } = require('../plugins/ipc')
-const { getSuccessStatus } = require('../status/success')
-
-const { getPluginErrorType } = require('./error')
-const { updateNetlifyConfig, listConfigSideFiles } = require('./update_config')
+import { getPluginErrorType } from './error.js'
+import { updateNetlifyConfig, listConfigSideFiles } from './update_config.js'
 
 // Fire a plugin step
-const firePluginStep = async function ({
+export const firePluginStep = async function ({
   event,
   childProcess,
   packageName,
@@ -85,5 +83,3 @@ const firePluginStep = async function ({
     logStepCompleted(logs, verbose)
   }
 }
-
-module.exports = { firePluginStep }

package/src/steps/return.js

@@ -1,12 +1,10 @@
-'use strict'
+import { logTimer } from '../log/messages/core.js'
+import { logStepSuccess } from '../log/messages/steps.js'
 
-const { logTimer } = require('../log/messages/core')
-const { logStepSuccess } = require('../log/messages/steps')
-
-const { handleStepError } = require('./error')
+import { handleStepError } from './error.js'
 
 // Retrieve the return value of a step
-const getStepReturn = function ({
+export const getStepReturn = function ({
   event,
   packageName,
   newError,
@@ -52,5 +50,3 @@ const getStepReturn = function ({
 
   return { newEnvChanges, netlifyConfig, configMutations, headersPath, redirectsPath, newStatus, timers }
 }
-
-module.exports = { getStepReturn }

package/src/steps/run_step.js

@@ -1,17 +1,15 @@
 /* eslint-disable max-lines */
-'use strict'
+import { addMutableConstants } from '../core/constants.js'
+import { logStepStart } from '../log/messages/steps.js'
+import { runsAlsoOnBuildFailure, runsOnlyOnBuildFailure } from '../plugins/events.js'
+import { measureDuration, normalizeTimerName } from '../time/main.js'
 
-const { addMutableConstants } = require('../core/constants')
-const { logStepStart } = require('../log/messages/steps')
-const { runsAlsoOnBuildFailure, runsOnlyOnBuildFailure } = require('../plugins/events')
-const { measureDuration, normalizeTimerName } = require('../time/main')
-
-const { fireCoreStep } = require('./core_step')
-const { firePluginStep } = require('./plugin')
-const { getStepReturn } = require('./return')
+import { fireCoreStep } from './core_step.js'
+import { firePluginStep } from './plugin.js'
+import { getStepReturn } from './return.js'
 
 // Run a step (core, build command or plugin)
-const runStep = async function ({
+export const runStep = async function ({
   event,
   childProcess,
   packageName,
@@ -299,6 +297,4 @@ const tFireStep = function ({
     verbose,
   })
 }
-
-module.exports = { runStep }
 /* eslint-enable max-lines */

package/src/steps/run_steps.js

@@ -1,19 +1,17 @@
 /* eslint-disable max-lines */
-'use strict'
+import pReduce from 'p-reduce'
 
-const pReduce = require('p-reduce')
+import { addErrorInfo } from '../error/info.js'
+import { addStatus } from '../status/add.js'
 
-const { addErrorInfo } = require('../error/info')
-const { addStatus } = require('../status/add')
-
-const { runStep } = require('./run_step')
+import { runStep } from './run_step.js'
 
 // Run all steps.
 // Each step can change some state: last `error`, environment variables changes,
 // list of `failedPlugins` (that ran `utils.build.failPlugin()`).
 // If an error arises, runs `onError` events.
 // Runs `onEnd` events at the end, whether an error was thrown or not.
-const runSteps = async function ({
+export const runSteps = async function ({
   steps,
   buildbotServerSocket,
   events,
@@ -178,6 +176,4 @@ const runSteps = async function ({
     configMutations: configMutationsB,
   }
 }
-
-module.exports = { runSteps }
 /* eslint-enable max-lines */

package/src/steps/update_config.js

@@ -1,18 +1,16 @@
-'use strict'
+import { isDeepStrictEqual } from 'util'
 
-const { isDeepStrictEqual } = require('util')
+import pFilter from 'p-filter'
+import pathExists from 'path-exists'
 
-const pFilter = require('p-filter')
-const pathExists = require('path-exists')
-
-const { resolveUpdatedConfig } = require('../core/config')
-const { addErrorInfo } = require('../error/info')
-const { logConfigOnUpdate } = require('../log/messages/config')
-const { logConfigMutations } = require('../log/messages/mutations')
+import { resolveUpdatedConfig } from '../core/config.js'
+import { addErrorInfo } from '../error/info.js'
+import { logConfigOnUpdate } from '../log/messages/config.js'
+import { logConfigMutations } from '../log/messages/mutations.js'
 
 // If `netlifyConfig` was updated or `_redirects` was created, the configuration
 // is updated by calling `@netlify/config` again.
-const updateNetlifyConfig = async function ({
+export const updateNetlifyConfig = async function ({
   configOpts,
   netlifyConfig,
   headersPath,
@@ -36,7 +34,7 @@ const updateNetlifyConfig = async function ({
     headersPath: headersPathA,
     redirectsPath: redirectsPathA,
   } = await resolveUpdatedConfig(configOpts, configMutationsA)
-  await logConfigOnUpdate({ logs, netlifyConfig: netlifyConfigA, debug })
+  logConfigOnUpdate({ logs, netlifyConfig: netlifyConfigA, debug })
   // eslint-disable-next-line fp/no-mutation,no-param-reassign
   errorParams.netlifyConfig = netlifyConfigA
   return {
@@ -67,7 +65,7 @@ const haveConfigSideFilesChanged = async function (configSideFiles, headersPath,
 // This is useful when applying configuration mutations since those files
 // sometimes have higher priority and should therefore be deleted in order to
 // apply any configuration update on `netlify.toml`.
-const listConfigSideFiles = async function (sideFiles) {
+export const listConfigSideFiles = async function (sideFiles) {
   const configSideFiles = await pFilter(sideFiles, pathExists)
   // eslint-disable-next-line fp/no-mutating-methods
   return configSideFiles.sort()
@@ -93,5 +91,3 @@ const validateConfigMutation = function ({ value, keysString }) {
 Please set this property to a specific value instead.`)
   }
 }
-
-module.exports = { updateNetlifyConfig, listConfigSideFiles }

package/src/telemetry/main.js

@@ -1,13 +1,11 @@
-'use strict'
+import { platform } from 'process'
 
-const { platform } = require('process')
+import got from 'got'
+import osName from 'os-name'
 
-const got = require('got')
-const osName = require('os-name')
-
-const { addErrorInfo } = require('../error/info')
-const { roundTimerToMillisecs } = require('../time/measure')
-const { ROOT_PACKAGE_JSON } = require('../utils/json')
+import { addErrorInfo } from '../error/info.js'
+import { roundTimerToMillisecs } from '../time/measure.js'
+import { ROOT_PACKAGE_JSON } from '../utils/json.js'
 
 const DEFAULT_TELEMETRY_TIMEOUT = 1200
 const DEFAULT_TELEMETRY_CONFIG = {
@@ -17,7 +15,7 @@ const DEFAULT_TELEMETRY_CONFIG = {
 }
 
 // Send telemetry request when build completes
-const trackBuildComplete = async function ({
+export const trackBuildComplete = async function ({
   deployId,
   buildId,
   status,
@@ -136,5 +134,3 @@ const getInstallType = function (origin, loadedFrom) {
 
   return loadedFrom
 }
-
-module.exports = { trackBuildComplete }

package/src/time/aggregate.js

@@ -1,13 +1,11 @@
-'use strict'
-
-const { createTimer, TOP_PARENT_TAG } = require('./main')
+import { createTimer, TOP_PARENT_TAG } from './main.js'
 
 // Some timers are computed based on others:
 //   - `others` is `total` minus the other timers
 //   - `run_plugins` is the sum of all plugins
 //   - `run_netlify_build_per_type` aggregates timers but per system/plugin/user
 //   - each plugin timer is the sum of its event handlers
-const addAggregatedTimers = function (timers) {
+export const addAggregatedTimers = function (timers) {
   const timersA = addRunPluginsTimer(timers)
   const timersB = addPluginTimers(timersA)
   const timersC = addOthersTimers(timersB)
@@ -146,5 +144,3 @@ const getTimerDuration = function ({ durationNs }) {
 const reduceSum = function (sum, number) {
   return sum + number
 }
-
-module.exports = { addAggregatedTimers }

package/src/time/main.js

@@ -1,12 +1,10 @@
-'use strict'
+import slugify from '@sindresorhus/slugify'
+import keepFuncProps from 'keep-func-props'
 
-const slugify = require('@sindresorhus/slugify')
-const keepFuncProps = require('keep-func-props')
-
-const { startTimer, endTimer } = require('./measure')
+import { startTimer, endTimer } from './measure.js'
 
 // Initialize the `timers` array
-const initTimers = function () {
+export const initTimers = function () {
   return []
 }
 
@@ -29,10 +27,10 @@ const kMeasureDuration = function (func, stageTag, { parentTag, category } = {})
 }
 
 // Ensure the wrapped function `name` is not `anonymous` in stack traces
-const measureDuration = keepFuncProps(kMeasureDuration)
+export const measureDuration = keepFuncProps(kMeasureDuration)
 
 // Create a new object representing a completed timer
-const createTimer = function (
+export const createTimer = function (
   stageTag,
   durationNs,
   { metricName = DEFAULT_METRIC_NAME, parentTag = TOP_PARENT_TAG, category, tags } = {},
@@ -41,12 +39,10 @@ const createTimer = function (
 }
 
 const DEFAULT_METRIC_NAME = 'buildbot.build.stage.duration'
-const TOP_PARENT_TAG = 'run_netlify_build'
+export const TOP_PARENT_TAG = 'run_netlify_build'
 
 // Make sure the timer name does not include special characters.
 // For example, the `packageName` of local plugins includes dots.
-const normalizeTimerName = function (name) {
+export const normalizeTimerName = function (name) {
   return slugify(name, { separator: '_' })
 }
-
-module.exports = { initTimers, measureDuration, normalizeTimerName, createTimer, TOP_PARENT_TAG }

package/src/time/measure.js

@@ -1,14 +1,12 @@
-'use strict'
-
-const { hrtime } = require('process')
+import { hrtime } from 'process'
 
 // Starts a timer
-const startTimer = function () {
+export const startTimer = function () {
   return hrtime()
 }
 
 // Stops a timer
-const endTimer = function ([startSecs, startNsecs]) {
+export const endTimer = function ([startSecs, startNsecs]) {
   const [endSecs, endNsecs] = hrtime()
   const durationNs = (endSecs - startSecs) * NANOSECS_TO_SECS + endNsecs - startNsecs
   return durationNs
@@ -16,11 +14,9 @@ const endTimer = function ([startSecs, startNsecs]) {
 
 // statsd expects milliseconds integers.
 // To prevent double rounding errors, rounding should only be applied once.
-const roundTimerToMillisecs = function (durationNs) {
+export const roundTimerToMillisecs = function (durationNs) {
   return Math.round(durationNs / NANOSECS_TO_MSECS)
 }
 
 const NANOSECS_TO_SECS = 1e9
 const NANOSECS_TO_MSECS = 1e6
-
-module.exports = { startTimer, endTimer, roundTimerToMillisecs }

package/src/time/report.js

@@ -1,18 +1,16 @@
-'use strict'
+import { promisify } from 'util'
 
-const { promisify } = require('util')
+import StatsdClient from 'statsd-client'
 
-const StatsdClient = require('statsd-client')
-
-const { addAggregatedTimers } = require('./aggregate')
-const { roundTimerToMillisecs } = require('./measure')
+import { addAggregatedTimers } from './aggregate.js'
+import { roundTimerToMillisecs } from './measure.js'
 
 // TODO: replace with `timers/promises` after dropping Node < 15.0.0
 const pSetTimeout = promisify(setTimeout)
 
 // Record the duration of a build phase, for monitoring.
 // Sends to statsd daemon.
-const reportTimers = async function ({ timers, statsdOpts: { host, port }, framework }) {
+export const reportTimers = async function ({ timers, statsdOpts: { host, port }, framework }) {
   if (host === undefined) {
     return
   }
@@ -59,5 +57,3 @@ const closeClient = async function (client) {
 
 // See https://github.com/msiebuhr/node-statsd-client/blob/45a93ee4c94ca72f244a40b06cb542d4bd7c3766/lib/EphemeralSocket.js#L81
 const CLOSE_TIMEOUT = 11
-
-module.exports = { reportTimers }

package/src/utils/errors.js

@@ -1,8 +1,6 @@
-'use strict'
-
 // Wrap an async function so it prepends an error message on exceptions.
 // This helps locate errors.
-const addAsyncErrorMessage = function (asyncFunc, message) {
+export const addAsyncErrorMessage = function (asyncFunc, message) {
   return async (...args) => {
     try {
       return await asyncFunc(...args)
@@ -12,5 +10,3 @@ const addAsyncErrorMessage = function (asyncFunc, message) {
     }
   }
 }
-
-module.exports = { addAsyncErrorMessage }

package/src/utils/json.js

@@ -1,12 +1,11 @@
-'use strict'
+import { promises as fs, readFileSync } from 'fs'
+import { fileURLToPath } from 'url'
 
-const { promises: fs, readFileSync } = require('fs')
-
-const ROOT_PACKAGE_JSON_PATH = `${__dirname}/../../package.json`
+const ROOT_PACKAGE_JSON_PATH = fileURLToPath(new URL('../../package.json', import.meta.url))
 
 // TODO: Replace with dynamic `import()` once it is supported without
 // experimental flags
-const importJsonFile = async function (filePath) {
+export const importJsonFile = async function (filePath) {
   const fileContents = await fs.readFile(filePath, 'utf8')
   return JSON.parse(fileContents)
 }
@@ -17,6 +16,4 @@ const importJsonFileSync = function (filePath) {
   return JSON.parse(fileContents)
 }
 
-const ROOT_PACKAGE_JSON = importJsonFileSync(ROOT_PACKAGE_JSON_PATH)
-
-module.exports = { importJsonFile, ROOT_PACKAGE_JSON }
+export const ROOT_PACKAGE_JSON = importJsonFileSync(ROOT_PACKAGE_JSON_PATH)

package/src/utils/omit.js

@@ -1,10 +1,6 @@
-'use strict'
-
-const filterObj = require('filter-obj')
+import filterObj from 'filter-obj'
 
 // lodash.omit is 1400 lines of codes. filter-obj is much smaller and simpler.
-const omit = function (obj, keys) {
+export const omit = function (obj, keys) {
   return filterObj(obj, (key) => !keys.includes(key))
 }
-
-module.exports = { omit }

package/src/utils/package.js

@@ -1,11 +1,9 @@
-'use strict'
+import { dirname } from 'path'
 
-const { dirname } = require('path')
-
-const readPkgUp = require('read-pkg-up')
+import readPkgUp from 'read-pkg-up'
 
 // Retrieve `package.json` from a specific directory
-const getPackageJson = async function (cwd, { normalize } = {}) {
+export const getPackageJson = async function (cwd, { normalize } = {}) {
   const packageObj = await getPackageObj({ cwd, normalize })
   if (packageObj === undefined) {
     return { packageJson: {} }
@@ -23,5 +21,3 @@ const getPackageObj = async function ({ cwd, normalize = true }) {
     // thrown. We return `undefined` then.
   } catch (error) {}
 }
-
-module.exports = { getPackageJson }

package/src/utils/remove_falsy.js

@@ -1,14 +1,10 @@
-'use strict'
-
-const filterObj = require('filter-obj')
+import filterObj from 'filter-obj'
 
 // Remove falsy values from object
-const removeFalsy = function (obj) {
+export const removeFalsy = function (obj) {
   return filterObj(obj, isDefined)
 }
 
 const isDefined = function (key, value) {
   return value !== undefined && value !== ''
 }
-
-module.exports = { removeFalsy }

package/src/utils/resolve.js

@@ -1,9 +1,13 @@
-'use strict'
+import { createRequire } from 'module'
 
-const resolveLib = require('resolve')
+import { async as resolveLib } from 'resolve'
+
+// TODO: use `import.resolve()` once it is available without any experimental
+// flags
+const require = createRequire(import.meta.url)
 
 // Like `resolvePath()` but does not throw
-const tryResolvePath = async function (path, basedir) {
+export const tryResolvePath = async function (path, basedir) {
   try {
     const resolvedPath = await resolvePath(path, basedir)
     return { path: resolvedPath }
@@ -13,7 +17,7 @@ const tryResolvePath = async function (path, basedir) {
 }
 
 // This throws if the package cannot be found
-const resolvePath = async function (path, basedir) {
+export const resolvePath = async function (path, basedir) {
   try {
     return await resolvePathWithBasedir(path, basedir)
     // Fallback.
@@ -40,5 +44,3 @@ const resolvePathWithBasedir = function (path, basedir) {
     })
   })
 }
-
-module.exports = { tryResolvePath, resolvePath }

package/src/utils/semver.js

@@ -1,38 +1,34 @@
-'use strict'
-
-const { major, minor, patch, clean: cleanVersion, lt: ltVersion, minVersion } = require('semver')
+import semver from 'semver'
 
 // Compare two versions by their major versions.
 // Takes into account the special rules for `0.*.*` and `0.0.*` versions.
-const isPreviousMajor = function (versionA, versionB) {
-  return ltVersion(getMajor(versionA), getMajor(versionB))
+export const isPreviousMajor = function (versionA, versionB) {
+  return semver.lt(getMajor(versionA), getMajor(versionB))
 }
 
 // Remove minor/patch numbers
 const getMajor = function (version) {
-  return minVersion(getMajorVersion(version)).version
+  return semver.minVersion(getMajorVersion(version)).version
 }
 
 // According to semver, the second number is the major release number for
 // `0.*.*` versions and the third for `0.0.*`. This is how `^` behaves with the
 // `semver` module which is used by `npm`.
-const getMajorVersion = function (version) {
-  if (!version || cleanVersion(version) === null) {
+export const getMajorVersion = function (version) {
+  if (!version || semver.clean(version) === null) {
     return
   }
 
-  const majorVersion = major(version)
+  const majorVersion = semver.major(version)
   if (majorVersion !== 0) {
     return `${majorVersion}`
   }
 
-  const minorVersion = minor(version)
+  const minorVersion = semver.minor(version)
   if (minorVersion !== 0) {
     return `${majorVersion}.${minorVersion}`
   }
 
-  const patchVersion = patch(version)
+  const patchVersion = semver.patch(version)
   return `${majorVersion}.${minorVersion}.${patchVersion}`
 }
-
-module.exports = { isPreviousMajor, getMajorVersion }

package/types/config/functions.d.ts

@@ -3,7 +3,7 @@ type GlobPattern = string
 /* eslint-disable camelcase -- some properties are named in snake case in this API */
 type FunctionsObject = {
   /**
-   * a list of additional paths to include in the function bundle. Although our build system includes statically referenced files (like `require("./some-file.js")`) by default, `included_files` lets you specify additional files or directories and reference them dynamically in function code. You can use `*` to match any character or prefix an entry with `!` to exclude files. Paths are relative to the [base directory](https://docs.netlify.com/configure-builds/get-started/#definitions-1).
+   * a list of additional paths to include in the function bundle. Although our build system includes statically referenced files (like `import * from "./some-file.js"`) by default, `included_files` lets you specify additional files or directories and reference them dynamically in function code. You can use `*` to match any character or prefix an entry with `!` to exclude files. Paths are relative to the [base directory](https://docs.netlify.com/configure-builds/get-started/#definitions-1).
    */
   included_files?: string[]
 } & (