@netlify/build 27.18.4 → 27.18.6-rc

package/src/plugins/expected_version.js

@@ -1,119 +0,0 @@
-import semver from 'semver'
-
-import { addErrorInfo } from '../error/info.js'
-import { importJsonFile } from '../utils/json.js'
-import { resolvePath } from '../utils/resolve.js'
-
-import { getExpectedVersion } from './compatibility.js'
-import { getPluginsList } from './list.js'
-
-// When using plugins in our official list, those are installed in .netlify/plugins/
-// We ensure that the last version that's been approved is always the one being used.
-// We also ensure that the plugin is our official list.
-export const addExpectedVersions = async function ({
-  pluginsOptions,
-  autoPluginsDir,
-  packageJson,
-  debug,
-  logs,
-  buildDir,
-  testOpts,
-  featureFlags,
-}) {
-  if (!pluginsOptions.some(needsExpectedVersion)) {
-    return pluginsOptions
-  }
-
-  const pluginsList = await getPluginsList({ debug, logs, testOpts })
-  return await Promise.all(
-    pluginsOptions.map((pluginOptions) =>
-      addExpectedVersion({ pluginsList, autoPluginsDir, packageJson, pluginOptions, buildDir, featureFlags }),
-    ),
-  )
-}
-
-// Any `pluginOptions` with `expectedVersion` set will be automatically installed
-const addExpectedVersion = async function ({
-  pluginsList,
-  autoPluginsDir,
-  packageJson,
-  pluginOptions,
-  pluginOptions: { packageName, pluginPath, loadedFrom, nodeVersion, pinnedVersion },
-  buildDir,
-  featureFlags,
-}) {
-  if (!needsExpectedVersion(pluginOptions)) {
-    return pluginOptions
-  }
-
-  if (pluginsList[packageName] === undefined) {
-    validateUnlistedPlugin(packageName, loadedFrom)
-    return pluginOptions
-  }
-
-  const unfilteredVersions = pluginsList[packageName]
-  const versions = filterVersions(unfilteredVersions, featureFlags)
-  const [{ version: latestVersion, migrationGuide }] = versions
-  const [{ version: expectedVersion }, { version: compatibleVersion, compatWarning }] = await Promise.all([
-    getExpectedVersion({ versions, nodeVersion, packageJson, buildDir, pinnedVersion }),
-    getExpectedVersion({ versions, nodeVersion, packageJson, buildDir }),
-  ])
-
-  const isMissing = await isMissingVersion({ autoPluginsDir, packageName, pluginPath, loadedFrom, expectedVersion })
-  return {
-    ...pluginOptions,
-    latestVersion,
-    expectedVersion,
-    compatibleVersion,
-    migrationGuide,
-    compatWarning,
-    isMissing,
-  }
-}
-
-// Feature flagged versions are removed unless the feature flag is present.
-//  - This is done before conditions are applied since, unlike conditions,
-//    users cannot always choose to enable a feature flag.
-const filterVersions = function (unfilteredVersions, featureFlags) {
-  return unfilteredVersions.filter(({ featureFlag }) => featureFlag === undefined || featureFlags[featureFlag])
-}
-
-// Checks whether plugin should be installed due to the wrong version being used
-// (either outdated, or mismatching compatibility requirements)
-const isMissingVersion = async function ({ autoPluginsDir, packageName, pluginPath, loadedFrom, expectedVersion }) {
-  return (
-    // We always respect the versions specified in `package.json`, as opposed
-    // to auto-installed plugins
-    loadedFrom !== 'package.json' &&
-    // Plugin was not previously installed
-    (pluginPath === undefined ||
-      // Plugin was previously installed but a different version should be used
-      !semver.satisfies(await getAutoPluginVersion(packageName, autoPluginsDir), expectedVersion))
-  )
-}
-
-const getAutoPluginVersion = async function (packageName, autoPluginsDir) {
-  const packageJsonPath = await resolvePath(`${packageName}/package.json`, autoPluginsDir)
-  const { version } = await importJsonFile(packageJsonPath)
-  return version
-}
-
-const needsExpectedVersion = function ({ loadedFrom }) {
-  return loadedFrom === 'auto_install' || loadedFrom === 'package.json'
-}
-
-// Plugins that are not in our official list can only be specified in
-// `netlify.toml` providing they are also installed in the site's package.json.
-// Otherwise, the build should fail.
-const validateUnlistedPlugin = function (packageName, loadedFrom) {
-  if (loadedFrom === 'package.json') {
-    return
-  }
-
-  const error = new Error(
-    `Plugins must be installed either in the Netlify App or in "package.json".
-Please run "npm install -D ${packageName}" or "yarn add -D ${packageName}".`,
-  )
-  addErrorInfo(error, { type: 'resolveConfig' })
-  throw error
-}

package/src/plugins/ipc.js

@@ -1,145 +0,0 @@
-import process from 'process'
-import { promisify } from 'util'
-
-import { pEvent } from 'p-event'
-import { v4 as uuidv4 } from 'uuid'
-
-import { jsonToError, errorToJson } from '../error/build.js'
-import { addErrorInfo } from '../error/info.js'
-import {
-  logSendingEventToChild,
-  logSentEventToChild,
-  logReceivedEventFromChild,
-  logSendingEventToParent,
-} from '../log/messages/ipc.js'
-
-// Send event from child to parent process then wait for response
-// We need to fire them in parallel because `process.send()` can be slow
-// to await, i.e. child might send response before parent start listening for it
-export const callChild = async function ({ childProcess, eventName, payload, logs, verbose }) {
-  const callId = uuidv4()
-  const [response] = await Promise.all([
-    getEventFromChild(childProcess, callId),
-    sendEventToChild({ childProcess, callId, eventName, payload, logs, verbose }),
-  ])
-  logReceivedEventFromChild(logs, verbose)
-  return response
-}
-
-// Receive event from child to parent process
-// Wait for either:
-//  - `message` event with a specific `callId`
-//  - `message` event with an `error` `callId` indicating an exception in the
-//    child process
-//  - child process `exit`
-// In the later two cases, we propagate the error.
-// We need to make `p-event` listeners are properly cleaned up too.
-export const getEventFromChild = async function (childProcess, callId) {
-  if (childProcessHasExited(childProcess)) {
-    throw getChildExitError('Could not receive event from child process because it already exited.')
-  }
-
-  const messagePromise = pEvent(childProcess, 'message', { filter: ([actualCallId]) => actualCallId === callId })
-  const errorPromise = pEvent(childProcess, 'message', { filter: ([actualCallId]) => actualCallId === 'error' })
-  const exitPromise = pEvent(childProcess, 'exit', { multiArgs: true })
-  try {
-    return await Promise.race([getMessage(messagePromise), getError(errorPromise), getExit(exitPromise)])
-  } finally {
-    messagePromise.cancel()
-    errorPromise.cancel()
-    exitPromise.cancel()
-  }
-}
-
-const childProcessHasExited = function (childProcess) {
-  return !childProcess.connected || childProcess.signalCode !== null || childProcess.exitCode !== null
-}
-
-const getMessage = async function (messagePromise) {
-  const [, response] = await messagePromise
-  return response
-}
-
-const getError = async function (errorPromise) {
-  const [, error] = await errorPromise
-  throw jsonToError(error)
-}
-
-const getExit = async function (exitPromise) {
-  const [exitCode, signal] = await exitPromise
-  throw getChildExitError(`Plugin exited with exit code ${exitCode} and signal ${signal}.`)
-}
-
-// Plugins should not terminate processes explicitly:
-//  - It prevents specifying error messages to the end users
-//  - It makes it impossible to distinguish between bugs (such as infinite loops) and user errors
-//  - It complicates child process orchestration. For example if an async operation
-//    of a previous event handler is still running, it would be aborted if another
-//    is terminating the process.
-const getChildExitError = function (message) {
-  const error = new Error(`${message}\n${EXIT_WARNING}`)
-  addErrorInfo(error, { type: 'ipc' })
-  return error
-}
-
-const EXIT_WARNING = `The plugin might have exited due to a bug terminating the process, such as an infinite loop.
-The plugin might also have explicitly terminated the process, for example with process.exit().
-Plugin methods should instead:
-  - on success: return
-  - on failure: call utils.build.failPlugin() or utils.build.failBuild()`
-
-// Send event from parent to child process
-const sendEventToChild = async function ({ childProcess, callId, eventName, payload, logs, verbose }) {
-  logSendingEventToChild(logs, verbose)
-
-  const payloadA = serializePayload(payload)
-  await promisify(childProcess.send.bind(childProcess))([callId, eventName, payloadA])
-
-  logSentEventToChild(logs, verbose)
-}
-
-// Respond to events from parent to child process.
-// This runs forever until `childProcess.kill()` is called.
-// We need to use `new Promise()` and callbacks because this runs forever.
-// eslint-disable-next-line promise/prefer-await-to-callbacks
-export const getEventsFromParent = function (callback) {
-  return new Promise((resolve, reject) => {
-    process.on('message', async (message) => {
-      try {
-        const [callId, eventName, payload] = message
-        const payloadA = parsePayload(payload)
-        // eslint-disable-next-line promise/prefer-await-to-callbacks
-        return await callback(callId, eventName, payloadA)
-      } catch (error) {
-        reject(error)
-      }
-    })
-  })
-}
-
-// Send event from child to parent process
-export const sendEventToParent = async function (callId, payload, verbose, error) {
-  logSendingEventToParent(verbose, error)
-  await promisify(process.send.bind(process))([callId, payload])
-}
-
-// Error static properties are not serializable through `child_process`
-// (which uses `v8.serialize()` under the hood) so we need to convert from/to
-// plain objects.
-const serializePayload = function ({ error = {}, error: { name } = {}, ...payload }) {
-  if (name === undefined) {
-    return payload
-  }
-
-  const errorA = errorToJson(error)
-  return { ...payload, error: errorA }
-}
-
-const parsePayload = function ({ error = {}, error: { name } = {}, ...payload }) {
-  if (name === undefined) {
-    return payload
-  }
-
-  const errorA = jsonToError(error)
-  return { ...payload, error: errorA }
-}

package/src/plugins/list.js

@@ -1,86 +0,0 @@
-import { pluginsUrl, pluginsList as oldPluginsList } from '@netlify/plugins-list'
-import got from 'got'
-import isPlainObj from 'is-plain-obj'
-
-import { logPluginsList, logPluginsFetchError } from '../log/messages/plugins.js'
-
-import { CONDITIONS } from './compatibility.js'
-
-// Retrieve the list of plugins officially vetted by us and displayed in our
-// plugins directory UI.
-// We fetch this list during each build (no caching) because we want new
-// versions of plugins to be available instantly to all users. The time to
-// make this request is somewhat ok (in the 100ms range).
-// We only fetch this plugins list when needed, i.e. we defer it as much as
-// possible.
-export const getPluginsList = async function ({ debug, logs, testOpts: { pluginsListUrl } }) {
-  // We try not to mock in integration tests. However, sending a request for
-  // each test would be too slow and make tests unreliable.
-  if (pluginsListUrl === 'test') {
-    return []
-  }
-
-  const pluginsListUrlA = pluginsListUrl === undefined ? pluginsUrl : pluginsListUrl
-  const pluginsList = await fetchPluginsList({ logs, pluginsListUrl: pluginsListUrlA })
-  const pluginsListA = normalizePluginsList(pluginsList)
-  logPluginsList({ pluginsList: pluginsListA, debug, logs })
-  return pluginsListA
-}
-
-const fetchPluginsList = async function ({ logs, pluginsListUrl }) {
-  try {
-    const { body } = await got(pluginsListUrl, { responseType: 'json', timeout: PLUGINS_LIST_TIMEOUT })
-
-    if (!isValidPluginsList(body)) {
-      throw new Error(`Request succeeded but with an invalid response:\n${JSON.stringify(body, null, 2)}`)
-    }
-
-    return body
-    // The Netlify Site should be up. This is a fallback.
-    // `oldPluginsList` might not contain the latest plugins versions:
-    //  - We should do `npm publish` as soon as a PR is merged in
-    //    `netlify/plugins` but it is possible we don't.
-    //  - Releasing it requires a @netlify/buld release, which requires itself a
-    //    buildbot release.
-  } catch (error) {
-    logPluginsFetchError(logs, error.message)
-    return oldPluginsList
-  }
-}
-
-// 1 minute HTTP request timeout
-const PLUGINS_LIST_TIMEOUT = 6e4
-
-const isValidPluginsList = function (pluginsList) {
-  return Array.isArray(pluginsList) && pluginsList.every(isPlainObj)
-}
-
-const normalizePluginsList = function (pluginsList) {
-  return Object.fromEntries(pluginsList.map(normalizePluginItem))
-}
-
-// `version` in `plugins.json` is the latest version.
-// A `compatibility` array of objects can be added to specify conditions to
-// apply different versions.
-// `netlify/plugins` ensures that `compatibility`:
-//  - Has the proper shape.
-//  - Is sorted from the highest to lowest version.
-//  - Does not include the latest `version`.
-const normalizePluginItem = function ({ package: packageName, version, compatibility = [] }) {
-  const versions = compatibility.length === 0 ? [{ version }] : compatibility
-  const versionsA = versions.map(normalizeCompatVersion)
-  return [packageName, versionsA]
-}
-
-const normalizeCompatVersion = function ({ version, migrationGuide, featureFlag, ...otherProperties }) {
-  const conditions = Object.entries(otherProperties).filter(isCondition).map(normalizeCondition)
-  return { version, migrationGuide, featureFlag, conditions }
-}
-
-const isCondition = function ([type]) {
-  return type in CONDITIONS
-}
-
-const normalizeCondition = function ([type, condition]) {
-  return { type, condition }
-}

package/src/plugins/load.js

@@ -1,70 +0,0 @@
-import { addErrorInfo } from '../error/info.js'
-import { addPluginLoadErrorStatus } from '../status/load_error.js'
-import { measureDuration } from '../time/main.js'
-
-import { callChild } from './ipc.js'
-
-// Retrieve all plugins steps
-// Can use either a module name or a file path to the plugin.
-export const loadPlugins = async function ({
-  pluginsOptions,
-  childProcesses,
-  packageJson,
-  timers,
-  logs,
-  debug,
-  verbose,
-}) {
-  return pluginsOptions.length === 0
-    ? { pluginsSteps: [], timers }
-    : await loadAllPlugins({ pluginsOptions, childProcesses, packageJson, timers, logs, debug, verbose })
-}
-
-const tLoadAllPlugins = async function ({ pluginsOptions, childProcesses, packageJson, logs, debug, verbose }) {
-  const pluginsSteps = await Promise.all(
-    pluginsOptions.map((pluginOptions, index) =>
-      loadPlugin(pluginOptions, { childProcesses, index, packageJson, logs, debug, verbose }),
-    ),
-  )
-  const pluginsStepsA = pluginsSteps.flat()
-  return { pluginsSteps: pluginsStepsA }
-}
-
-// Only performed if there are some plugins
-const loadAllPlugins = measureDuration(tLoadAllPlugins, 'load_plugins')
-
-// Retrieve plugin steps for one plugin.
-// Do it by executing the plugin `load` event handler.
-const loadPlugin = async function (
-  { packageName, pluginPackageJson, pluginPackageJson: { version } = {}, pluginPath, inputs, loadedFrom, origin },
-  { childProcesses, index, packageJson, logs, debug, verbose },
-) {
-  const { childProcess } = childProcesses[index]
-  const loadEvent = 'load'
-
-  try {
-    const { events } = await callChild({
-      childProcess,
-      eventName: 'load',
-      payload: { pluginPath, inputs, packageJson, verbose },
-      logs,
-      verbose: false,
-    })
-    const pluginSteps = events.map((event) => ({
-      event,
-      packageName,
-      loadedFrom,
-      origin,
-      pluginPackageJson,
-      childProcess,
-    }))
-    return pluginSteps
-  } catch (error) {
-    addErrorInfo(error, {
-      plugin: { packageName, pluginPackageJson },
-      location: { event: loadEvent, packageName, loadedFrom, origin },
-    })
-    addPluginLoadErrorStatus({ error, packageName, version, debug })
-    throw error
-  }
-}

package/src/plugins/manifest/check.js

@@ -1,106 +0,0 @@
-import { addErrorInfo } from '../../error/info.js'
-import { serializeObject } from '../../log/serialize.js'
-import { THEME } from '../../log/theme.js'
-
-// Check that plugin inputs match the validation specified in "manifest.yml"
-// Also assign default values
-export const checkInputs = function ({
-  inputs,
-  manifest: { inputs: rules = [] },
-  packageName,
-  pluginPackageJson,
-  loadedFrom,
-  origin,
-}) {
-  try {
-    const inputsA = addDefaults(inputs, rules)
-    checkRequiredInputs({ inputs: inputsA, rules, packageName, pluginPackageJson, loadedFrom, origin })
-    checkUnknownInputs({ inputs: inputsA, rules, packageName, pluginPackageJson, loadedFrom, origin })
-    return inputsA
-  } catch (error) {
-    error.message = `${error.message}
-
-${THEME.errorSubHeader('Plugin inputs')}
-${serializeObject(inputs)}`
-    throw error
-  }
-}
-
-// Add "inputs[*].default"
-const addDefaults = function (inputs, rules) {
-  const defaults = rules.filter(hasDefault).map(getDefault)
-  return Object.assign({}, ...defaults, inputs)
-}
-
-const hasDefault = function (rule) {
-  return rule.default !== undefined
-}
-
-const getDefault = function ({ name, default: defaultValue }) {
-  return { [name]: defaultValue }
-}
-
-// Check "inputs[*].required"
-const checkRequiredInputs = function ({ inputs, rules, packageName, pluginPackageJson, loadedFrom, origin }) {
-  const missingInputs = rules.filter((rule) => isMissingRequired(inputs, rule))
-  if (missingInputs.length === 0) {
-    return
-  }
-
-  const names = missingInputs.map(getName)
-  const error = new Error(`Required inputs for plugin "${packageName}": ${names.join(', ')}`)
-  addInputError({ error, name: names[0], packageName, pluginPackageJson, loadedFrom, origin })
-  throw error
-}
-
-const isMissingRequired = function (inputs, { name, required }) {
-  return required && inputs[name] === undefined
-}
-
-const getName = function ({ name }) {
-  return name
-}
-
-// Check each "inputs[*].*" property for a specific input
-const checkUnknownInputs = function ({ inputs, rules, packageName, pluginPackageJson, loadedFrom, origin }) {
-  const knownInputs = rules.map(getName)
-  const unknownInputs = Object.keys(inputs).filter((name) => !knownInputs.includes(name))
-  if (unknownInputs.length === 0) {
-    return
-  }
-
-  const unknownInputsMessage = getUnknownInputsMessage({ packageName, knownInputs, unknownInputs })
-  const error = new Error(`${unknownInputsMessage}
-Check your plugin configuration to be sure that:
-  - the input name is spelled correctly
-  - the input is included in the plugin's available configuration options
-  - the plugin's input requirements have not changed`)
-  const [name] = unknownInputs
-  addInputError({ error, name, packageName, pluginPackageJson, loadedFrom, origin })
-  throw error
-}
-
-const getUnknownInputsMessage = function ({ packageName, knownInputs, unknownInputs }) {
-  const unknownInputsStr = unknownInputs.map(quoteWord).join(', ')
-
-  if (knownInputs.length === 0) {
-    return `Plugin "${packageName}" does not accept any inputs but you specified: ${unknownInputsStr}`
-  }
-
-  const knownInputsStr = knownInputs.map(quoteWord).join(', ')
-  return `Unknown inputs for plugin "${packageName}": ${unknownInputsStr}
-Plugin inputs should be one of: ${knownInputsStr}`
-}
-
-const quoteWord = function (word) {
-  return `"${word}"`
-}
-
-// Add error information
-const addInputError = function ({ error, name, packageName, pluginPackageJson, loadedFrom, origin }) {
-  addErrorInfo(error, {
-    type: 'pluginInput',
-    plugin: { packageName, pluginPackageJson },
-    location: { event: 'load', packageName, input: name, loadedFrom, origin },
-  })
-}

package/src/plugins/manifest/load.js

@@ -1,41 +0,0 @@
-import { promises as fs } from 'fs'
-
-import { load as loadYaml, JSON_SCHEMA } from 'js-yaml'
-
-import { addErrorInfo } from '../../error/info.js'
-
-import { validateManifest } from './validate.js'
-
-// Load "manifest.yml" using its file path
-export const loadManifest = async function ({ manifestPath, packageName, pluginPackageJson, loadedFrom, origin }) {
-  try {
-    const rawManifest = await loadRawManifest(manifestPath)
-    const manifest = await parseManifest(rawManifest)
-    validateManifest(manifest, rawManifest)
-    return manifest
-  } catch (error) {
-    addErrorInfo(error, {
-      type: 'pluginValidation',
-      plugin: { packageName, pluginPackageJson },
-      location: { event: 'load', packageName, loadedFrom, origin },
-    })
-    throw error
-  }
-}
-
-const loadRawManifest = async function (manifestPath) {
-  try {
-    return await fs.readFile(manifestPath, 'utf8')
-  } catch (error) {
-    error.message = `Could not load plugin's "manifest.yml"\n${error.message}`
-    throw error
-  }
-}
-
-const parseManifest = async function (rawManifest) {
-  try {
-    return await loadYaml(rawManifest, { schema: JSON_SCHEMA, json: true })
-  } catch (error) {
-    throw new Error(`Could not parse plugin's "manifest.yml"\n${error.message}`)
-  }
-}

package/src/plugins/manifest/main.js

@@ -1,22 +0,0 @@
-import { addPluginLoadErrorStatus } from '../../status/load_error.js'
-
-import { checkInputs } from './check.js'
-import { loadManifest } from './load.js'
-import { getManifestPath } from './path.js'
-
-// Load plugin's `manifest.yml`
-export const useManifest = async function (
-  { packageName, loadedFrom, origin, inputs },
-  { pluginDir, packageDir, pluginPackageJson, pluginPackageJson: { version }, debug },
-) {
-  const manifestPath = await getManifestPath({ pluginDir, packageDir, packageName })
-
-  try {
-    const manifest = await loadManifest({ manifestPath, packageName, pluginPackageJson, loadedFrom, origin })
-    const inputsA = checkInputs({ inputs, manifest, packageName, pluginPackageJson, loadedFrom, origin })
-    return { manifest, inputs: inputsA }
-  } catch (error) {
-    addPluginLoadErrorStatus({ error, packageName, version, debug })
-    throw error
-  }
-}

package/src/plugins/manifest/path.js

@@ -1,31 +0,0 @@
-import { locatePath } from 'locate-path'
-
-import { addErrorInfo } from '../../error/info.js'
-
-// Retrieve "manifest.yml" path for a specific plugin
-export const getManifestPath = async function ({ pluginDir, packageDir, packageName }) {
-  const dirs = [pluginDir, packageDir]
-    .filter(Boolean)
-    .flatMap((dir) => MANIFEST_FILENAMES.map((filename) => `${dir}/${filename}`))
-  const manifestPath = await locatePath(dirs)
-  validateManifestExists(manifestPath, packageName)
-  return manifestPath
-}
-
-const validateManifestExists = function (manifestPath, packageName) {
-  if (manifestPath !== undefined) {
-    return
-  }
-
-  const error = new Error(
-    `The plugin "${packageName}" is missing a "manifest.yml".
-This might mean:
-  - The plugin "package" name is misspelled
-  - The plugin "package" points to a Node module that is not a Netlify Build plugin
-  - If you're developing a plugin, please see the documentation at https://docs.netlify.com/configure-builds/build-plugins/create-plugins/#anatomy-of-a-plugin`,
-  )
-  addErrorInfo(error, { type: 'resolveConfig' })
-  throw error
-}
-
-const MANIFEST_FILENAMES = ['manifest.yml', 'manifest.yaml']