@netlify/build 28.0.1 → 28.1.1

package/lib/core/main.js

@@ -1,4 +1,5 @@
 import { handleBuildError } from '../error/handle.js';
+import { reportError } from '../error/report.js';
 import { logTimer, logBuildSuccess } from '../log/messages/core.js';
 import { trackBuildComplete } from '../telemetry/main.js';
 import { reportTimers } from '../time/report.js';
@@ -70,6 +71,7 @@ export default async function buildSite(flags = {}) {
             testOpts,
             errorParams,
         });
+        await reportError({ error, framework, statsdOpts });
         return { success, severityCode, logs };
     }
 }

package/lib/error/report.js

@@ -0,0 +1,27 @@
+import { isNetlifyMaintainedPlugin } from '../plugins/internal.js';
+import { closeClient, normalizeTagName, startClient } from '../report/statsd.js';
+import { getErrorInfo } from './info.js';
+const TOP_PARENT_TAG = 'run_netlify_build';
+// Record error rates of the build phase for monitoring.
+// Sends to statsd daemon.
+export const reportError = async function ({ error, statsdOpts: { host, port }, framework, }) {
+    if (host === undefined) {
+        return;
+    }
+    const [errorInfo] = getErrorInfo(error);
+    const pluginName = errorInfo.plugin ? normalizeTagName(errorInfo.plugin.packageName) : null;
+    // only send tracking if it is a known plugin
+    if (pluginName && !isNetlifyMaintainedPlugin(pluginName)) {
+        return;
+    }
+    const parent = pluginName ? pluginName : TOP_PARENT_TAG;
+    const stage = pluginName ? errorInfo.location?.event : errorInfo.stage;
+    const client = await startClient(host, port);
+    const frameworkTag = framework === undefined ? {} : { framework };
+    client.increment('buildbot.build.stage.error', 1, {
+        stage: stage ?? 'system',
+        parent,
+        ...frameworkTag,
+    });
+    await closeClient(client);
+};

package/lib/plugins/internal.js

@@ -0,0 +1,10 @@
+const NETLIFY_MAINTAINED_PLUGINS = new Set([
+    'netlify_plugin_gatsby_cache',
+    'netlify_plugin_sitemap',
+    'netlify_plugin_debug_cache',
+    'netlify_plugin_is_website_vulnerable',
+    'netlify_plugin_lighthouse',
+    'netlify_plugin_nextjs',
+    'netlify_plugin_gatsby',
+]);
+export const isNetlifyMaintainedPlugin = (pluginPackage) => NETLIFY_MAINTAINED_PLUGINS.has(pluginPackage);

package/lib/report/statsd.js

@@ -0,0 +1,31 @@
+import { promisify } from 'util';
+import slugify from '@sindresorhus/slugify';
+import StatsdClient from 'statsd-client';
+// TODO: replace with `timers/promises` after dropping Node < 15.0.0
+const pSetTimeout = promisify(setTimeout);
+// See https://github.com/msiebuhr/node-statsd-client/blob/45a93ee4c94ca72f244a40b06cb542d4bd7c3766/lib/EphemeralSocket.js#L81
+const CLOSE_TIMEOUT = 11;
+// The socket creation is delayed until the first packet is sent. In our
+// case, this happens just before `client.close()` is called, which is too
+// late and make it not send anything. We need to manually create it using
+// the internal API.
+export const startClient = async function (host, port) {
+    const client = new StatsdClient({ host, port, socketTimeout: 0 });
+    // @ts-expect-error using internals :D
+    await promisify(client._socket._createSocket.bind(client._socket))();
+    return client;
+};
+// UDP packets are buffered and flushed at regular intervals by statsd-client.
+// Closing force flushing all of them.
+export const closeClient = async function (client) {
+    client.close();
+    // statsd-client does not provide a way of knowing when the socket is done
+    // closing, so we need to use the following hack.
+    await pSetTimeout(CLOSE_TIMEOUT);
+    await pSetTimeout(CLOSE_TIMEOUT);
+};
+// Make sure the timer name does not include special characters.
+// For example, the `packageName` of local plugins includes dots.
+export const normalizeTagName = function (name) {
+    return slugify(name, { separator: '_' });
+};

package/lib/steps/core_step.js

@@ -2,7 +2,7 @@ import { setEnvChanges } from '../env/changes.js';
 import { addErrorInfo, isBuildError } from '../error/info.js';
 import { updateNetlifyConfig, listConfigSideFiles } from './update_config.js';
 // Fire a core step
-export const fireCoreStep = async function ({ coreStep, coreStepName, configPath, buildDir, repositoryRoot, constants, buildbotServerSocket, events, logs, nodePath, childEnv, context, branch, envChanges, errorParams, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, featureFlags, debug, systemLog, saveConfig, }) {
+export const fireCoreStep = async function ({ coreStep, coreStepId, coreStepName, configPath, buildDir, repositoryRoot, constants, buildbotServerSocket, events, logs, nodePath, childEnv, context, branch, envChanges, errorParams, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, featureFlags, debug, systemLog, saveConfig, }) {
     try {
         const configSideFiles = await listConfigSideFiles([headersPath, redirectsPath]);
         const childEnvA = setEnvChanges(envChanges, { ...childEnv });
@@ -52,6 +52,8 @@ export const fireCoreStep = async function ({ coreStep, coreStepName, configPath
         if (!isBuildError(newError)) {
             addErrorInfo(newError, { type: 'coreStep', location: { coreStepName } });
         }
+        // always add the current stage
+        addErrorInfo(newError, { stage: coreStepId });
         return { newError };
     }
 };

package/lib/steps/run_step.js

@@ -1,7 +1,8 @@
 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';
+import { normalizeTagName } from '../report/statsd.js';
+import { measureDuration } from '../time/main.js';
 import { fireCoreStep } from './core_step.js';
 import { firePluginStep } from './plugin.js';
 import { getStepReturn } from './return.js';
@@ -31,6 +32,7 @@ export const runStep = async function ({ event, childProcess, packageName, coreS
         loadedFrom,
         origin,
         coreStep,
+        coreStepId,
         coreStepName,
         configPath,
         buildDir,
@@ -78,7 +80,6 @@ export const runStep = async function ({ event, childProcess, packageName, coreS
         redirectsPath: redirectsPathA,
         logs,
         debug,
-        systemLog,
         timers: timersA,
         durationNs,
         testOpts,
@@ -131,13 +132,14 @@ const getFireStep = function (packageName, coreStepId, event) {
     if (coreStepId !== undefined) {
         return measureDuration(tFireStep, coreStepId);
     }
-    const parentTag = normalizeTimerName(packageName);
+    const parentTag = normalizeTagName(packageName);
     return measureDuration(tFireStep, event, { parentTag, category: 'pluginEvent' });
 };
-const tFireStep = function ({ event, childProcess, packageName, pluginPackageJson, loadedFrom, origin, coreStep, coreStepName, configPath, buildDir, repositoryRoot, nodePath, childEnv, context, branch, envChanges, constants, steps, buildbotServerSocket, events, error, logs, debug, systemLog, verbose, saveConfig, errorParams, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, featureFlags, }) {
+const tFireStep = function ({ event, childProcess, packageName, pluginPackageJson, loadedFrom, origin, coreStep, coreStepId, coreStepName, configPath, buildDir, repositoryRoot, nodePath, childEnv, context, branch, envChanges, constants, steps, buildbotServerSocket, events, error, logs, debug, systemLog, verbose, saveConfig, errorParams, configOpts, netlifyConfig, configMutations, headersPath, redirectsPath, featureFlags, }) {
     if (coreStep !== undefined) {
         return fireCoreStep({
             coreStep,
+            coreStepId,
             coreStepName,
             configPath,
             buildDir,
@@ -182,7 +184,6 @@ const tFireStep = function ({ event, childProcess, packageName, pluginPackageJso
         error,
         logs,
         debug,
-        systemLog,
         verbose,
     });
 };

package/lib/time/aggregate.js

@@ -1,3 +1,4 @@
+import { isNetlifyMaintainedPlugin } from '../plugins/internal.js';
 import { createTimer, TOP_PARENT_TAG } from './main.js';
 // Some timers are computed based on others:
 //   - `others` is `total` minus the other timers
@@ -53,18 +54,6 @@ const addPluginTimers = function (timers) {
 const isCommunityPluginTimer = function (timer) {
     return isPluginTimer(timer) && !isNetlifyMaintainedPlugin(getPluginTimerPackage(timer));
 };
-const isNetlifyMaintainedPlugin = function (pluginPackage) {
-    return NETLIFY_MAINTAINED_PLUGINS.has(pluginPackage);
-};
-const NETLIFY_MAINTAINED_PLUGINS = new Set([
-    'netlify_plugin_gatsby_cache',
-    'netlify_plugin_sitemap',
-    'netlify_plugin_debug_cache',
-    'netlify_plugin_is_website_vulnerable',
-    'netlify_plugin_lighthouse',
-    'netlify_plugin_nextjs',
-    'netlify_plugin_gatsby',
-]);
 const getPluginPackages = function (pluginsTimers) {
     const pluginPackages = pluginsTimers.map(getPluginTimerPackage);
     return [...new Set(pluginPackages)];
@@ -90,7 +79,7 @@ const addTypeTimers = function (timers) {
 const TYPE_TIMERS = [
     { name: 'system', stages: ['resolve_config', 'get_plugins_options', 'start_plugins', 'others'] },
     { name: 'plugin', stages: ['load_plugins', 'run_plugins'] },
-    { name: 'user', stages: ['build_command', 'functions_bundling', 'deploy_site'] },
+    { name: 'user', stages: ['build_command', 'edge_functions_bundling', 'functions_bundling', 'deploy_site'] },
 ];
 const getTypeTimer = function (name, stages, topTimers) {
     const topTimersA = topTimers.filter(({ stageTag }) => stages.includes(stageTag));

package/lib/time/main.js

@@ -1,4 +1,3 @@
-import slugify from '@sindresorhus/slugify';
 import keepFuncProps from 'keep-func-props';
 import { startTimer, endTimer } from './measure.js';
 // Initialize the `timers` array
@@ -11,7 +10,7 @@ export const initTimers = function () {
 //   - return a plain object. This may or may not contain a modified `timers`.
 // The `durationNs` will be returned by the function. A new `timers` with the
 // additional duration timer will be returned as well.
-const kMeasureDuration = function (func, stageTag, { parentTag, category } = {}) {
+const kMeasureDuration = function (func, stageTag, { parentTag = undefined, category = undefined } = {}) {
     return async function measuredFunc({ timers, ...opts }, ...args) {
         const timerNs = startTimer();
         const { timers: timersA = timers, ...returnObject } = await func({ timers, ...opts }, ...args);
@@ -25,13 +24,8 @@ const kMeasureDuration = function (func, stageTag, { parentTag, category } = {})
 // Ensure the wrapped function `name` is not `anonymous` in stack traces
 export const measureDuration = keepFuncProps(kMeasureDuration);
 // Create a new object representing a completed timer
-export const createTimer = function (stageTag, durationNs, { metricName = DEFAULT_METRIC_NAME, parentTag = TOP_PARENT_TAG, category, tags } = {}) {
+export const createTimer = function (stageTag, durationNs, { metricName = DEFAULT_METRIC_NAME, parentTag = TOP_PARENT_TAG, category = undefined, tags = undefined } = {}) {
     return { metricName, stageTag, parentTag, durationNs, category, tags };
 };
 const DEFAULT_METRIC_NAME = 'buildbot.build.stage.duration';
 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.
-export const normalizeTimerName = function (name) {
-    return slugify(name, { separator: '_' });
-};

package/lib/time/report.js

@@ -1,9 +1,6 @@
-import { promisify } from 'util';
-import StatsdClient from 'statsd-client';
+import { closeClient, startClient } from '../report/statsd.js';
 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.
 export const reportTimers = async function ({ timers, statsdOpts: { host, port }, framework }) {
@@ -20,28 +17,8 @@ const sendTimers = async function ({ timers, host, port, framework }) {
     });
     await closeClient(client);
 };
-// The socket creation is delayed until the first packet is sent. In our
-// case, this happens just before `client.close()` is called, which is too
-// late and make it not send anything. We need to manually create it using
-// the internal API.
-const startClient = async function (host, port) {
-    const client = new StatsdClient({ host, port, socketTimeout: 0 });
-    await promisify(client._socket._createSocket.bind(client._socket))();
-    return client;
-};
 const sendTimer = function ({ timer: { metricName, stageTag, parentTag, durationNs, tags }, client, framework }) {
     const durationMs = roundTimerToMillisecs(durationNs);
     const frameworkTag = framework === undefined ? {} : { framework };
     client.distribution(metricName, durationMs, { stage: stageTag, parent: parentTag, ...tags, ...frameworkTag });
 };
-// UDP packets are buffered and flushed at regular intervals by statsd-client.
-// Closing force flushing all of them.
-const closeClient = async function (client) {
-    client.close();
-    // statsd-clent does not provide with a way of knowing when the socket is done
-    // closing, so we need to use the following hack.
-    await pSetTimeout(CLOSE_TIMEOUT);
-    await pSetTimeout(CLOSE_TIMEOUT);
-};
-// See https://github.com/msiebuhr/node-statsd-client/blob/45a93ee4c94ca72f244a40b06cb542d4bd7c3766/lib/EphemeralSocket.js#L81
-const CLOSE_TIMEOUT = 11;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "28.0.1",
+  "version": "28.1.1",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/core/main.js",
@@ -65,7 +65,7 @@
   "dependencies": {
     "@bugsnag/js": "^7.0.0",
     "@netlify/cache-utils": "^5.0.1",
-    "@netlify/config": "^19.0.1",
+    "@netlify/config": "^19.0.2",
     "@netlify/edge-bundler": "^2.8.0",
     "@netlify/functions-utils": "^5.0.1",
     "@netlify/git-utils": "^5.0.1",
@@ -116,11 +116,12 @@
     "typescript": "^4.5.4",
     "update-notifier": "^5.0.0",
     "uuid": "^8.0.0",
-    "yargs": "^17.3.1"
+    "yargs": "^17.6.0"
   },
   "devDependencies": {
     "@netlify/nock-udp": "^3.0.0",
     "@types/node": "^14.18.31",
+    "@types/statsd-client": "^0.4.3",
     "atob": "^2.1.2",
     "ava": "^4.0.0",
     "c8": "^7.12.0",
@@ -150,5 +151,5 @@
       "module": "commonjs"
     }
   },
-  "gitHead": "701e883d4e19c048e8de9801e49e21de5c891a18"
+  "gitHead": "20503830a8814af5d5f8bfabaac38be846e131f4"
 }