@netlify/build 27.20.4 → 27.20.6

package/lib/plugins/child/main.js

@@ -1,51 +1,37 @@
-import { setInspectColors } from '../../log/colors.js'
-import { sendEventToParent, getEventsFromParent } from '../ipc.js'
-
-import { handleProcessErrors, handleError } from './error.js'
-import { load } from './load.js'
-import { run } from './run.js'
-
+import { setInspectColors } from '../../log/colors.js';
+import { sendEventToParent, getEventsFromParent } from '../ipc.js';
+import { handleProcessErrors, handleError } from './error.js';
+import { load } from './load.js';
+import { run } from './run.js';
 // Boot plugin child process.
 const bootPlugin = async function () {
-  const state = { context: { verbose: false } }
-
-  try {
-    handleProcessErrors()
-    setInspectColors()
-
-    // We need to fire them in parallel because `process.send()` can be slow
-    // to await, i.e. parent might send `load` event before child `ready` event
-    // returns.
-    await Promise.all([handleEvents(state), sendEventToParent('ready', {}, false)])
-  } catch (error) {
-    await handleError(error, state.context.verbose)
-  }
-}
-
+    const state = { context: { verbose: false } };
+    try {
+        handleProcessErrors();
+        setInspectColors();
+        // We need to fire them in parallel because `process.send()` can be slow
+        // to await, i.e. parent might send `load` event before child `ready` event
+        // returns.
+        await Promise.all([handleEvents(state), sendEventToParent('ready', {}, false)]);
+    }
+    catch (error) {
+        await handleError(error, state.context.verbose);
+    }
+};
 // Wait for events from parent to perform plugin methods
 const handleEvents = async function (state) {
-  await getEventsFromParent((callId, eventName, payload) => handleEvent({ callId, eventName, payload, state }))
-}
-
+    await getEventsFromParent((callId, eventName, payload) => handleEvent({ callId, eventName, payload, state }));
+};
 // Each event can pass `context` information to the next event
-const handleEvent = async function ({
-  callId,
-  eventName,
-  payload,
-  state,
-  state: {
-    context: { verbose },
-  },
-}) {
-  try {
-    const { context, ...response } = await EVENTS[eventName](payload, state.context)
-    state.context = { ...state.context, ...context }
-    await sendEventToParent(callId, response, verbose)
-  } catch (error) {
-    await handleError(error, verbose)
-  }
-}
-
-const EVENTS = { load, run }
-
-bootPlugin()
+const handleEvent = async function ({ callId, eventName, payload, state, state: { context: { verbose }, }, }) {
+    try {
+        const { context, ...response } = await EVENTS[eventName](payload, state.context);
+        state.context = { ...state.context, ...context };
+        await sendEventToParent(callId, response, verbose);
+    }
+    catch (error) {
+        await handleError(error, verbose);
+    }
+};
+const EVENTS = { load, run };
+bootPlugin();

package/lib/plugins/child/run.js

@@ -1,28 +1,19 @@
-import { getNewEnvChanges, setEnvChanges } from '../../env/changes.js'
-import { logPluginMethodStart, logPluginMethodEnd } from '../../log/messages/ipc.js'
-
-import { cloneNetlifyConfig, getConfigMutations } from './diff.js'
-import { getUtils } from './utils.js'
-
+import { getNewEnvChanges, setEnvChanges } from '../../env/changes.js';
+import { logPluginMethodStart, logPluginMethodEnd } from '../../log/messages/ipc.js';
+import { cloneNetlifyConfig, getConfigMutations } from './diff.js';
+import { getUtils } from './utils.js';
 // Run a specific plugin event handler
-export const run = async function (
-  { event, error, constants, envChanges, netlifyConfig },
-  { methods, inputs, packageJson, verbose },
-) {
-  const method = methods[event]
-  const runState = {}
-  const utils = getUtils({ event, constants, runState })
-  const netlifyConfigCopy = cloneNetlifyConfig(netlifyConfig)
-  const runOptions = { utils, constants, inputs, netlifyConfig: netlifyConfigCopy, packageJson, error }
-
-  const envBefore = setEnvChanges(envChanges)
-
-  logPluginMethodStart(verbose)
-  await method(runOptions)
-  logPluginMethodEnd(verbose)
-
-  const newEnvChanges = getNewEnvChanges(envBefore, netlifyConfig, netlifyConfigCopy)
-
-  const configMutations = getConfigMutations(netlifyConfig, netlifyConfigCopy, event)
-  return { ...runState, newEnvChanges, configMutations }
-}
+export const run = async function ({ event, error, constants, envChanges, netlifyConfig }, { methods, inputs, packageJson, verbose }) {
+    const method = methods[event];
+    const runState = {};
+    const utils = getUtils({ event, constants, runState });
+    const netlifyConfigCopy = cloneNetlifyConfig(netlifyConfig);
+    const runOptions = { utils, constants, inputs, netlifyConfig: netlifyConfigCopy, packageJson, error };
+    const envBefore = setEnvChanges(envChanges);
+    logPluginMethodStart(verbose);
+    await method(runOptions);
+    logPluginMethodEnd(verbose);
+    const newEnvChanges = getNewEnvChanges(envBefore, netlifyConfig, netlifyConfigCopy);
+    const configMutations = getConfigMutations(netlifyConfig, netlifyConfigCopy, event);
+    return { ...runState, newEnvChanges, configMutations };
+};

package/lib/plugins/child/status.js

@@ -1,74 +1,63 @@
-import isPlainObj from 'is-plain-obj'
-import mapObj from 'map-obj'
-
-import { addErrorInfo } from '../../error/info.js'
-
+import isPlainObj from 'is-plain-obj';
+import mapObj from 'map-obj';
+import { addErrorInfo } from '../../error/info.js';
 // Report status information to the UI
 export const show = function (runState, showArgs) {
-  validateShowArgs(showArgs)
-  const { title, summary, text, extraData } = removeEmptyStrings(showArgs)
-  runState.status = { state: 'success', title, summary, text, extraData }
-}
-
+    validateShowArgs(showArgs);
+    const { title, summary, text, extraData } = removeEmptyStrings(showArgs);
+    runState.status = { state: 'success', title, summary, text, extraData };
+};
 // Validate arguments of `utils.status.show()`
 const validateShowArgs = function (showArgs) {
-  try {
-    validateShowArgsObject(showArgs)
-    const { title, summary, text, extraData, ...otherArgs } = showArgs
-    validateShowArgsKeys(otherArgs)
-    Object.entries({ title, summary, text }).forEach(validateStringArg)
-    validateShowArgsSummary(summary)
-    validateShowArgsExtraData(extraData)
-  } catch (error) {
-    error.message = `utils.status.show() ${error.message}`
-    addErrorInfo(error, { type: 'pluginValidation' })
-    throw error
-  }
-}
-
+    try {
+        validateShowArgsObject(showArgs);
+        const { title, summary, text, extraData, ...otherArgs } = showArgs;
+        validateShowArgsKeys(otherArgs);
+        Object.entries({ title, summary, text }).forEach(validateStringArg);
+        validateShowArgsSummary(summary);
+        validateShowArgsExtraData(extraData);
+    }
+    catch (error) {
+        error.message = `utils.status.show() ${error.message}`;
+        addErrorInfo(error, { type: 'pluginValidation' });
+        throw error;
+    }
+};
 const validateShowArgsObject = function (showArgs) {
-  if (showArgs === undefined) {
-    throw new Error('requires an argument')
-  }
-
-  if (!isPlainObj(showArgs)) {
-    throw new Error('argument must be a plain object')
-  }
-}
-
+    if (showArgs === undefined) {
+        throw new Error('requires an argument');
+    }
+    if (!isPlainObj(showArgs)) {
+        throw new Error('argument must be a plain object');
+    }
+};
 const validateShowArgsKeys = function (otherArgs) {
-  const otherKeys = Object.keys(otherArgs).map((arg) => `"${arg}"`)
-  if (otherKeys.length !== 0) {
-    throw new Error(`must only contain "title", "summary" or "text" properties, not ${otherKeys.join(', ')}`)
-  }
-}
-
+    const otherKeys = Object.keys(otherArgs).map((arg) => `"${arg}"`);
+    if (otherKeys.length !== 0) {
+        throw new Error(`must only contain "title", "summary" or "text" properties, not ${otherKeys.join(', ')}`);
+    }
+};
 const validateStringArg = function ([key, value]) {
-  if (value !== undefined && typeof value !== 'string') {
-    throw new Error(`"${key}" property must be a string`)
-  }
-}
-
+    if (value !== undefined && typeof value !== 'string') {
+        throw new Error(`"${key}" property must be a string`);
+    }
+};
 const validateShowArgsSummary = function (summary) {
-  if (summary === undefined || summary.trim() === '') {
-    throw new Error('requires specifying a "summary" property')
-  }
-}
-
+    if (summary === undefined || summary.trim() === '') {
+        throw new Error('requires specifying a "summary" property');
+    }
+};
 const validateShowArgsExtraData = function (extraData) {
-  if (extraData !== undefined && Array.isArray(extraData) === false) {
-    throw new TypeError('provided extra data must be an array')
-  }
-}
-
+    if (extraData !== undefined && Array.isArray(extraData) === false) {
+        throw new TypeError('provided extra data must be an array');
+    }
+};
 const removeEmptyStrings = function (showArgs) {
-  return mapObj(showArgs, removeEmptyString)
-}
-
+    return mapObj(showArgs, removeEmptyString);
+};
 const removeEmptyString = function (key, value) {
-  if (typeof value === 'string' && value.trim() === '') {
-    return [key]
-  }
-
-  return [key, value]
-}
+    if (typeof value === 'string' && value.trim() === '') {
+        return [key];
+    }
+    return [key, value];
+};

package/lib/plugins/child/typescript.js

@@ -1,45 +1,28 @@
-import { extname } from 'path'
-
-import { register } from 'ts-node'
-
-import { addErrorInfo } from '../../error/info.js'
-
+import { extname } from 'path';
+import { register } from 'ts-node';
+import { addErrorInfo } from '../../error/info.js';
 // Allow local plugins to be written with TypeScript.
 // Local plugins cannot be transpiled by the build command since they can be run
 // before it. Therefore, we type-check and transpile them automatically using
 // `ts-node`.
 export const registerTypeScript = function (pluginPath) {
-  if (!isTypeScriptPlugin(pluginPath)) {
-    return
-  }
-
-  return register()
-}
-
+    if (!isTypeScriptPlugin(pluginPath)) {
+        return;
+    }
+    return register();
+};
 // On TypeScript errors, adds information about the `ts-node` configuration,
 // which includes the resolved `tsconfig.json`.
 export const addTsErrorInfo = function (error, tsNodeService) {
-  if (tsNodeService === undefined) {
-    return
-  }
-
-  const {
-    config: {
-      raw: { compilerOptions },
-    },
-    options: realTsNodeOptions,
-  } = tsNodeService
-
-  // filter out functions as they cannot be serialized
-  const tsNodeOptions = Object.fromEntries(
-    Object.entries(realTsNodeOptions).filter(([, val]) => typeof val !== 'function'),
-  )
-
-  addErrorInfo(error, { tsConfig: { compilerOptions, tsNodeOptions } })
-}
-
+    if (tsNodeService === undefined) {
+        return;
+    }
+    const { config: { raw: { compilerOptions }, }, options: realTsNodeOptions, } = tsNodeService;
+    // filter out functions as they cannot be serialized
+    const tsNodeOptions = Object.fromEntries(Object.entries(realTsNodeOptions).filter(([, val]) => typeof val !== 'function'));
+    addErrorInfo(error, { tsConfig: { compilerOptions, tsNodeOptions } });
+};
 const isTypeScriptPlugin = function (pluginPath) {
-  return TYPESCRIPT_EXTENSIONS.has(extname(pluginPath))
-}
-
-const TYPESCRIPT_EXTENSIONS = new Set(['.ts', '.tsx', '.mts', '.cts'])
+    return TYPESCRIPT_EXTENSIONS.has(extname(pluginPath));
+};
+const TYPESCRIPT_EXTENSIONS = new Set(['.ts', '.tsx', '.mts', '.cts']);

package/lib/plugins/child/utils.js

@@ -1,55 +1,42 @@
-import { bindOpts as cacheBindOpts } from '@netlify/cache-utils'
-import { add as functionsAdd, list as functionsList, listAll as functionsListAll } from '@netlify/functions-utils'
-import { getGitUtils } from '@netlify/git-utils'
-import { run, runCommand } from '@netlify/run-utils'
-
-import { failBuild, failPlugin, cancelBuild, failPluginWithWarning } from '../error.js'
-import { isSoftFailEvent } from '../events.js'
-
-import { addLazyProp } from './lazy.js'
-import { show } from './status.js'
-
+import { bindOpts as cacheBindOpts } from '@netlify/cache-utils';
+import { add as functionsAdd, list as functionsList, listAll as functionsListAll } from '@netlify/functions-utils';
+import { getGitUtils } from '@netlify/git-utils';
+import { run, runCommand } from '@netlify/run-utils';
+import { failBuild, failPlugin, cancelBuild, failPluginWithWarning } from '../error.js';
+import { isSoftFailEvent } from '../events.js';
+import { addLazyProp } from './lazy.js';
+import { show } from './status.js';
 // Retrieve the `utils` argument.
-export const getUtils = function ({
-  event,
-  constants: { FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC, CACHE_DIR },
-  runState,
-}) {
-  run.command = runCommand
-
-  const build = getBuildUtils(event)
-  const cache = getCacheUtils(CACHE_DIR)
-  const functions = getFunctionsUtils(FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC)
-  const status = getStatusUtils(runState)
-  const utils = { build, cache, run, functions, status }
-  addLazyProp(utils, 'git', () => getGitUtils())
-  return utils
-}
-
+export const getUtils = function ({ event, constants: { FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC, CACHE_DIR }, runState, }) {
+    run.command = runCommand;
+    const build = getBuildUtils(event);
+    const cache = getCacheUtils(CACHE_DIR);
+    const functions = getFunctionsUtils(FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC);
+    const status = getStatusUtils(runState);
+    const utils = { build, cache, run, functions, status };
+    addLazyProp(utils, 'git', () => getGitUtils());
+    return utils;
+};
 const getBuildUtils = function (event) {
-  if (isSoftFailEvent(event)) {
-    return {
-      failPlugin,
-      failBuild: failPluginWithWarning.bind(null, 'failBuild', event),
-      cancelBuild: failPluginWithWarning.bind(null, 'cancelBuild', event),
+    if (isSoftFailEvent(event)) {
+        return {
+            failPlugin,
+            failBuild: failPluginWithWarning.bind(null, 'failBuild', event),
+            cancelBuild: failPluginWithWarning.bind(null, 'cancelBuild', event),
+        };
     }
-  }
-
-  return { failBuild, failPlugin, cancelBuild }
-}
-
+    return { failBuild, failPlugin, cancelBuild };
+};
 const getCacheUtils = function (CACHE_DIR) {
-  return cacheBindOpts({ cacheDir: CACHE_DIR })
-}
-
+    return cacheBindOpts({ cacheDir: CACHE_DIR });
+};
 const getFunctionsUtils = function (FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC) {
-  const functionsDirectories = [INTERNAL_FUNCTIONS_SRC, FUNCTIONS_SRC].filter(Boolean)
-  const add = (src) => functionsAdd(src, INTERNAL_FUNCTIONS_SRC, { fail: failBuild })
-  const list = functionsList.bind(null, functionsDirectories, { fail: failBuild })
-  const listAll = functionsListAll.bind(null, functionsDirectories, { fail: failBuild })
-  return { add, list, listAll }
-}
-
+    const functionsDirectories = [INTERNAL_FUNCTIONS_SRC, FUNCTIONS_SRC].filter(Boolean);
+    const add = (src) => functionsAdd(src, INTERNAL_FUNCTIONS_SRC, { fail: failBuild });
+    const list = functionsList.bind(null, functionsDirectories, { fail: failBuild });
+    const listAll = functionsListAll.bind(null, functionsDirectories, { fail: failBuild });
+    return { add, list, listAll };
+};
 const getStatusUtils = function (runState) {
-  return { show: show.bind(undefined, runState) }
-}
+    return { show: show.bind(undefined, runState) };
+};

package/lib/plugins/child/validate.js

@@ -1,34 +1,31 @@
-import { addErrorInfo } from '../../error/info.js'
-import { serializeArray } from '../../log/serialize.js'
-import { DEV_EVENTS, EVENTS } from '../events.js'
-
+import { addErrorInfo } from '../../error/info.js';
+import { serializeArray } from '../../log/serialize.js';
+import { DEV_EVENTS, EVENTS } from '../events.js';
 // Validate the shape of a plugin return value
 export const validatePlugin = function (logic) {
-  try {
-    // This validation must work with the return value of `import()` which has
-    // a `Module` prototype, not `Object`
-    if (typeof logic !== 'object' || logic === null) {
-      throw new Error('Plugin must be an object or a function')
+    try {
+        // This validation must work with the return value of `import()` which has
+        // a `Module` prototype, not `Object`
+        if (typeof logic !== 'object' || logic === null) {
+            throw new Error('Plugin must be an object or a function');
+        }
+        Object.entries(logic).forEach(([propName, value]) => {
+            validateEventHandler(value, propName);
+        });
     }
-
-    Object.entries(logic).forEach(([propName, value]) => {
-      validateEventHandler(value, propName)
-    })
-  } catch (error) {
-    addErrorInfo(error, { type: 'pluginValidation' })
-    throw error
-  }
-}
-
+    catch (error) {
+        addErrorInfo(error, { type: 'pluginValidation' });
+        throw error;
+    }
+};
 // All other properties are event handlers
 const validateEventHandler = function (value, propName) {
-  if (!EVENTS.includes(propName) && !DEV_EVENTS.includes(propName)) {
-    throw new Error(`Invalid event '${propName}'.
+    if (!EVENTS.includes(propName) && !DEV_EVENTS.includes(propName)) {
+        throw new Error(`Invalid event '${propName}'.
 Please use a valid event name. One of:
-${serializeArray(EVENTS)}`)
-  }
-
-  if (typeof value !== 'function') {
-    throw new TypeError(`Invalid event handler '${propName}': must be a function`)
-  }
-}
+${serializeArray(EVENTS)}`);
+    }
+    if (typeof value !== 'function') {
+        throw new TypeError(`Invalid event handler '${propName}': must be a function`);
+    }
+};