@netlify/build 29.44.0 → 29.45.0

package/lib/core/build.js

@@ -296,6 +296,7 @@ const initAndRunBuild = async function ({ pluginsOptions, netlifyConfig, configO
         timers: timersA,
         featureFlags,
         quiet,
+        systemLog,
         systemLogFile,
     });
     try {

package/lib/plugins/load.js

@@ -3,6 +3,7 @@ import { addErrorInfo } from '../error/info.js';
 import { addPluginLoadErrorStatus } from '../status/load_error.js';
 import { measureDuration } from '../time/main.js';
 import { callChild } from './ipc.js';
+import { captureStandardError } from './system_log.js';
 const pSetTimeout = promisify(setTimeout);
 // Retrieve all plugins steps
 // Can use either a module name or a file path to the plugin.
@@ -44,16 +45,7 @@ const loadAllPlugins = measureDuration(tLoadAllPlugins, 'load_plugins');
 const loadPlugin = async function ({ packageName, pluginPackageJson, pluginPackageJson: { version } = {}, pluginPath, inputs, loadedFrom, origin }, { childProcesses, index, packageJson, logs, debug, verbose, netlifyConfig, featureFlags, systemLog }) {
     const { childProcess } = childProcesses[index];
     const loadEvent = 'load';
-    // A buffer for any data piped into the child process' stderr. We'll pipe
-    // this to system logs if we fail to load the plugin.
-    const bufferedStdErr = [];
-    let bufferedStdListener;
-    if (featureFlags.netlify_build_plugin_system_log && childProcess.stderr) {
-        bufferedStdListener = (data) => {
-            bufferedStdErr.push(data.toString().trimEnd());
-        };
-        childProcess.stderr.on('data', bufferedStdListener);
-    }
+    const cleanup = captureStandardError(childProcess, systemLog, loadEvent, featureFlags);
     try {
         const { events } = await callChild({
             childProcess,
@@ -76,9 +68,6 @@ const loadPlugin = async function ({ packageName, pluginPackageJson, pluginPacka
         if (featureFlags.netlify_build_plugin_system_log) {
             // Wait for stderr to be flushed.
             await pSetTimeout(0);
-            bufferedStdErr.forEach((line) => {
-                systemLog(line);
-            });
         }
         addErrorInfo(error, {
             plugin: { packageName, pluginPackageJson },
@@ -88,8 +77,6 @@ const loadPlugin = async function ({ packageName, pluginPackageJson, pluginPacka
         throw error;
     }
     finally {
-        if (bufferedStdListener) {
-            childProcess.stderr.removeListener('data', bufferedStdListener);
-        }
+        cleanup();
     }
 };

package/lib/plugins/spawn.js

@@ -1,5 +1,6 @@
 import { createRequire } from 'module';
 import { fileURLToPath, pathToFileURL } from 'url';
+import { promisify } from 'util';
 import { trace } from '@opentelemetry/api';
 import { execaNode } from 'execa';
 import { gte } from 'semver';
@@ -9,7 +10,9 @@ import { isTrustedPlugin } from '../steps/plugin.js';
 import { measureDuration } from '../time/main.js';
 import { callChild, getEventFromChild } from './ipc.js';
 import { getSpawnInfo } from './options.js';
+import { captureStandardError } from './system_log.js';
 const CHILD_MAIN_FILE = fileURLToPath(new URL('child/main.js', import.meta.url));
+const pSetTimeout = promisify(setTimeout);
 const require = createRequire(import.meta.url);
 // Start child processes used by all plugins
 // We fire plugins through child processes so that:
@@ -17,7 +20,7 @@ const require = createRequire(import.meta.url);
 //    (for both security and safety reasons)
 //  - logs can be buffered which allows manipulating them for log shipping,
 //    transforming and parallel plugins
-const tStartPlugins = async function ({ pluginsOptions, buildDir, childEnv, logs, debug, quiet, systemLogFile }) {
+const tStartPlugins = async function ({ pluginsOptions, buildDir, childEnv, logs, debug, quiet, systemLog, systemLogFile, featureFlags, }) {
     if (!quiet) {
         logRuntime(logs, pluginsOptions);
         logLoadingPlugins(logs, pluginsOptions, debug);
@@ -25,11 +28,21 @@ const tStartPlugins = async function ({ pluginsOptions, buildDir, childEnv, logs
     }
     logOutdatedPlugins(logs, pluginsOptions);
     logIncompatiblePlugins(logs, pluginsOptions);
-    const childProcesses = await Promise.all(pluginsOptions.map(({ pluginDir, nodePath, nodeVersion, pluginPackageJson }) => startPlugin({ pluginDir, nodePath, nodeVersion, buildDir, childEnv, systemLogFile, pluginPackageJson })));
+    const childProcesses = await Promise.all(pluginsOptions.map(({ pluginDir, nodePath, nodeVersion, pluginPackageJson }) => startPlugin({
+        pluginDir,
+        nodePath,
+        nodeVersion,
+        buildDir,
+        childEnv,
+        systemLog,
+        systemLogFile,
+        pluginPackageJson,
+        featureFlags,
+    })));
     return { childProcesses };
 };
 export const startPlugins = measureDuration(tStartPlugins, 'start_plugins');
-const startPlugin = async function ({ pluginDir, nodeVersion, nodePath, buildDir, childEnv, systemLogFile, pluginPackageJson, }) {
+const startPlugin = async function ({ pluginDir, nodeVersion, nodePath, buildDir, childEnv, systemLog, systemLogFile, pluginPackageJson, featureFlags, }) {
     const ctx = trace.getActiveSpan()?.spanContext();
     // the baggage will be passed to the child process when sending the run event
     const args = [
@@ -71,15 +84,24 @@ const startPlugin = async function ({ pluginDir, nodeVersion, nodePath, buildDir
             ? ['pipe', 'pipe', 'pipe', 'ipc', systemLogFile]
             : undefined,
     });
+    const readyEvent = 'ready';
+    const cleanup = captureStandardError(childProcess, systemLog, readyEvent, featureFlags);
     try {
-        await getEventFromChild(childProcess, 'ready');
+        await getEventFromChild(childProcess, readyEvent);
         return { childProcess };
     }
     catch (error) {
+        if (featureFlags.netlify_build_plugin_system_log) {
+            // Wait for stderr to be flushed.
+            await pSetTimeout(0);
+        }
         const spawnInfo = getSpawnInfo();
         addErrorInfo(error, spawnInfo);
         throw error;
     }
+    finally {
+        cleanup();
+    }
 };
 // Stop all plugins child processes
 export const stopPlugins = async function ({ childProcesses, logs, verbose, pluginOptions, netlifyConfig, }) {

package/lib/plugins/system_log.d.ts

@@ -0,0 +1,4 @@
+import type { FeatureFlags } from '../core/feature_flags.js';
+import type { SystemLogger } from '../plugins_core/types.js';
+import type { ChildProcess } from './spawn.js';
+export declare const captureStandardError: (childProcess: ChildProcess, systemLog: SystemLogger, eventName: string, featureFlags: FeatureFlags) => () => void;

package/lib/plugins/system_log.js

@@ -0,0 +1,20 @@
+export const captureStandardError = (childProcess, systemLog, eventName, featureFlags) => {
+    if (!featureFlags.netlify_build_plugin_system_log) {
+        return () => {
+            // no-op
+        };
+    }
+    let receivedChunks = false;
+    const listener = (chunk) => {
+        if (!receivedChunks) {
+            receivedChunks = true;
+            systemLog(`Plugin failed to initialize during the "${eventName}" phase`);
+        }
+        systemLog(chunk.toString().trimEnd());
+    };
+    childProcess.stderr?.on('data', listener);
+    const cleanup = () => {
+        childProcess.stderr?.removeListener('data', listener);
+    };
+    return cleanup;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.44.0",
+  "version": "29.45.0",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/index.js",
@@ -165,5 +165,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "bd868b81a1ead42e337bea8bebfee0d51307e078"
+  "gitHead": "492b2e3de82bc00b0427eac5a12f847bb72404fa"
 }