@netlify/build 29.24.3 → 29.25.0

package/lib/core/build.d.ts

@@ -33,7 +33,7 @@ export declare const startBuild: (flags: Partial<BuildFlags>) => {
     };
 };
 export declare const execBuild: any;
-export declare const runAndReportBuild: ({ pluginsOptions, netlifyConfig, configOpts, siteInfo, configPath, outputConfigPath, headersPath, redirectsPath, packagePath, 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, quiet, integrations, explicitSecretKeys, edgeFunctionsBootstrapURL, }: {
+export declare const runAndReportBuild: ({ pluginsOptions, netlifyConfig, configOpts, siteInfo, configPath, outputConfigPath, headersPath, redirectsPath, packagePath, 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, quiet, integrations, explicitSecretKeys, edgeFunctionsBootstrapURL, eventHandlers, }: {
     pluginsOptions: any;
     netlifyConfig: any;
     configOpts: any;
@@ -74,6 +74,7 @@ export declare const runAndReportBuild: ({ pluginsOptions, netlifyConfig, config
     integrations: any;
     explicitSecretKeys: any;
     edgeFunctionsBootstrapURL: any;
+    eventHandlers: any;
 }) => Promise<{
     pluginsOptions: any;
     netlifyConfig: any;

package/lib/core/build.js

@@ -33,7 +33,7 @@ export const startBuild = function (flags) {
     const rootTracingContext = startTracing(tracingOpts, getSystemLogger(logs, debug, systemLogFile));
     return { ...flagsA, rootTracingContext, debug, systemLogFile, errorMonitor, logs, timers };
 };
-const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cachedConfigPath, outputConfigPath, cwd, packagePath, 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, quiet, framework, explicitSecretKeys, edgeFunctionsBootstrapURL, }) {
+const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cachedConfigPath, outputConfigPath, cwd, packagePath, 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, quiet, framework, explicitSecretKeys, edgeFunctionsBootstrapURL, eventHandlers, }) {
     const configOpts = getConfigOpts({
         config,
         defaultConfig,
@@ -135,6 +135,7 @@ const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cached
         integrations,
         explicitSecretKeys,
         edgeFunctionsBootstrapURL,
+        eventHandlers,
     });
     return {
         pluginsOptions: pluginsOptionsA,
@@ -149,7 +150,7 @@ const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cached
 };
 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, outputConfigPath, headersPath, redirectsPath, packagePath, 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, quiet, integrations, explicitSecretKeys, edgeFunctionsBootstrapURL, }) {
+export const runAndReportBuild = async function ({ pluginsOptions, netlifyConfig, configOpts, siteInfo, configPath, outputConfigPath, headersPath, redirectsPath, packagePath, 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, quiet, integrations, explicitSecretKeys, edgeFunctionsBootstrapURL, eventHandlers, }) {
     try {
         const { stepsCount, netlifyConfig: netlifyConfigA, statuses, pluginsOptions: pluginsOptionsA, failedPlugins, timers: timersA, configMutations, metrics, } = await initAndRunBuild({
             pluginsOptions,
@@ -192,6 +193,7 @@ export const runAndReportBuild = async function ({ pluginsOptions, netlifyConfig
             integrations,
             explicitSecretKeys,
             edgeFunctionsBootstrapURL,
+            eventHandlers,
         });
         await Promise.all([
             reportStatuses({
@@ -252,7 +254,7 @@ export const runAndReportBuild = async function ({ pluginsOptions, netlifyConfig
     }
 };
 // Initialize plugin processes then runs a build
-const initAndRunBuild = async function ({ pluginsOptions, netlifyConfig, configOpts, siteInfo, configPath, outputConfigPath, headersPath, redirectsPath, buildDir, packagePath, 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, quiet, integrations, explicitSecretKeys, edgeFunctionsBootstrapURL, }) {
+const initAndRunBuild = async function ({ pluginsOptions, netlifyConfig, configOpts, siteInfo, configPath, outputConfigPath, headersPath, redirectsPath, buildDir, packagePath, 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, quiet, integrations, explicitSecretKeys, edgeFunctionsBootstrapURL, eventHandlers, }) {
     const { pluginsOptions: pluginsOptionsA, timers: timersA } = await getPluginsOptions({
         pluginsOptions,
         netlifyConfig,
@@ -324,6 +326,7 @@ const initAndRunBuild = async function ({ pluginsOptions, netlifyConfig, configO
             quiet,
             explicitSecretKeys,
             edgeFunctionsBootstrapURL,
+            eventHandlers,
         });
         await Promise.all([
             warnOnMissingSideFiles({ buildDir, netlifyConfig: netlifyConfigA, logs }),
@@ -351,7 +354,7 @@ const initAndRunBuild = async function ({ pluginsOptions, netlifyConfig, configO
 };
 // 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, outputConfigPath, userNodeVersion, headersPath, redirectsPath, buildDir, repositoryRoot, packagePath, nodePath, childEnv, context, branch, dry, buildbotServerSocket, constants, mode, api, errorMonitor, deployId, errorParams, logs, debug, systemLog, verbose, saveConfig, timers, testOpts, featureFlags, timeline, devCommand, quiet, explicitSecretKeys, edgeFunctionsBootstrapURL, }) {
+const runBuild = async function ({ childProcesses, pluginsOptions, netlifyConfig, configOpts, packageJson, configPath, outputConfigPath, userNodeVersion, headersPath, redirectsPath, buildDir, repositoryRoot, packagePath, nodePath, childEnv, context, branch, dry, buildbotServerSocket, constants, mode, api, errorMonitor, deployId, errorParams, logs, debug, systemLog, verbose, saveConfig, timers, testOpts, featureFlags, timeline, devCommand, quiet, explicitSecretKeys, edgeFunctionsBootstrapURL, eventHandlers, }) {
     const { pluginsSteps, timers: timersA } = await loadPlugins({
         pluginsOptions,
         childProcesses,
@@ -362,7 +365,7 @@ const runBuild = async function ({ childProcesses, pluginsOptions, netlifyConfig
         verbose,
         netlifyConfig,
     });
-    const { steps, events } = timeline === 'dev' ? getDevSteps(devCommand, pluginsSteps) : getSteps(pluginsSteps);
+    const { steps, events } = timeline === 'dev' ? getDevSteps(devCommand, pluginsSteps, eventHandlers) : getSteps(pluginsSteps, eventHandlers);
     if (dry) {
         await doDryRun({ buildDir, steps, netlifyConfig, constants, buildbotServerSocket, logs });
         return { netlifyConfig };

package/lib/core/main.js

@@ -17,7 +17,7 @@ const tracer = trace.getTracer('core');
  * @param flags - build configuration CLI flags
  */
 export async function buildSite(flags = {}) {
-    const { errorMonitor, framework, mode, logs, debug, systemLogFile, testOpts, statsdOpts, dry, telemetry, buildId, deployId, rootTracingContext, ...flagsA } = startBuild(flags);
+    const { errorMonitor, framework, mode, logs, debug, systemLogFile, testOpts, statsdOpts, dry, telemetry, buildId, deployId, rootTracingContext, eventHandlers, ...flagsA } = startBuild(flags);
     const errorParams = { errorMonitor, mode, logs, debug, testOpts };
     const systemLog = getSystemLogger(logs, debug, systemLogFile);
     const attributes = {
@@ -43,6 +43,7 @@ export async function buildSite(flags = {}) {
                 testOpts,
                 errorParams,
                 framework,
+                eventHandlers,
             });
             await handleBuildSuccess({
                 framework,

package/lib/core/types.d.ts

@@ -1,4 +1,4 @@
-import { NetlifyConfig } from '../../types/index.js';
+import { NetlifyConfig, NetlifyPlugin } from '../../types/index.js';
 export type Mode = 'buildbot' | 'cli' | 'require';
 export type BuildCLIFlags = {
     cachedConfig: Record<string, unknown>;
@@ -40,6 +40,13 @@ export type BuildCLIFlags = {
 };
 export type BuildFlags = BuildCLIFlags & {
     env?: Record<string, unknown>;
+    eventHandlers?: EventHandlers;
+};
+type EventHandlers = {
+    [K in keyof NetlifyPlugin]: NetlifyPlugin[K] | {
+        handler: NetlifyPlugin[K];
+        description: string;
+    };
 };
 export type BuildResult = {
     success: boolean;
@@ -82,3 +89,4 @@ export type TracingOptions = {
     parentSpanId: string;
     baggageFilePath: string;
 };
+export {};

package/lib/log/messages/config.js

@@ -52,9 +52,10 @@ const INTERNAL_FLAGS = [
     'timeline',
     'explicitSecretKeys',
     'edgeFunctionsBootstrapURL',
+    'eventHandlers',
 ];
 const HIDDEN_FLAGS = [...SECURE_FLAGS, ...TEST_FLAGS, ...INTERNAL_FLAGS];
-const HIDDEN_DEBUG_FLAGS = [...SECURE_FLAGS, ...TEST_FLAGS];
+const HIDDEN_DEBUG_FLAGS = [...SECURE_FLAGS, ...TEST_FLAGS, 'eventHandlers'];
 export const logBuildDir = function (logs, buildDir) {
     logSubHeader(logs, 'Current directory');
     logMessage(logs, buildDir);

package/lib/steps/get.d.ts

@@ -1,8 +1,8 @@
-export function getSteps(steps: any): {
+export function getSteps(steps: any, eventHandlers: any): {
     steps: any;
     events: any[];
 };
-export function getDevSteps(command: any, steps: any): {
+export function getDevSteps(command: any, steps: any, eventHandlers: any): {
     steps: any;
     events: any[];
 };

package/lib/steps/get.js

@@ -1,3 +1,4 @@
+import { getUtils } from '../plugins/child/utils.js';
 import { DEV_EVENTS, EVENTS } from '../plugins/events.js';
 import { buildCommandCore } from '../plugins_core/build_command.js';
 import { deploySite } from '../plugins_core/deploy/index.js';
@@ -6,14 +7,16 @@ import { bundleFunctions } from '../plugins_core/functions/index.js';
 import { saveArtifacts } from '../plugins_core/save_artifacts/index.js';
 import { scanForSecrets } from '../plugins_core/secrets_scanning/index.js';
 // Get all build steps
-export const getSteps = function (steps) {
+export const getSteps = function (steps, eventHandlers) {
     const stepsA = addCoreSteps(steps);
-    const stepsB = sortSteps(stepsA, EVENTS);
+    const eventSteps = getEventSteps(eventHandlers);
+    const stepsB = [...stepsA, ...eventSteps];
+    const stepsC = sortSteps(stepsB, EVENTS);
     const events = getEvents(stepsB);
-    return { steps: stepsB, events };
+    return { steps: stepsC, events };
 };
 // Get all dev steps
-export const getDevSteps = function (command, steps) {
+export const getDevSteps = function (command, steps, eventHandlers) {
     const devCommandStep = {
         event: 'onDev',
         coreStep: async () => {
@@ -24,10 +27,32 @@ export const getDevSteps = function (command, steps) {
         coreStepName: 'dev.command',
         coreStepDescription: () => 'Run command for local development',
     };
-    const sortedSteps = sortSteps([...steps, devCommandStep], DEV_EVENTS);
+    const eventSteps = getEventSteps(eventHandlers);
+    const sortedSteps = sortSteps([...steps, eventSteps, devCommandStep], DEV_EVENTS);
     const events = getEvents(sortedSteps);
     return { steps: sortedSteps, events };
 };
+const getEventSteps = function (eventHandlers) {
+    return Object.entries(eventHandlers ?? {}).map(([event, eventHandler]) => {
+        let description = `Event handler for ${event}`;
+        let handler = eventHandler;
+        if (typeof eventHandler !== 'function') {
+            description = eventHandler.description;
+            handler = eventHandler.handler;
+        }
+        return {
+            event,
+            coreStep: (args) => {
+                const { constants, event } = args;
+                const utils = getUtils({ event, constants, runState: {} });
+                return handler({ utils, ...args });
+            },
+            coreStepId: `options_${event}`,
+            coreStepName: `options.${event}`,
+            coreStepDescription: () => description,
+        };
+    });
+};
 const addCoreSteps = function (steps) {
     return [buildCommandCore, ...steps, bundleFunctions, bundleEdgeFunctions, scanForSecrets, deploySite, saveArtifacts];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.24.3",
+  "version": "29.25.0",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/index.js",
@@ -146,5 +146,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "5010beda1eafc633a34b03f21472ca7bae1a9b08"
+  "gitHead": "633f90410881f22105c6cb78003e92b92d0b02ef"
 }