@netlify/build 29.4.3-rc → 29.4.3

package/lib/core/bin.js

@@ -3,10 +3,10 @@ import process from 'process';
 import filterObj from 'filter-obj';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { normalizeCliFeatureFlags } from '../../lib/core/feature_flags.js';
-import { FLAGS } from '../../lib/core/flags.js';
-import build from '../../lib/core/main.js';
-import { FALLBACK_SEVERITY_ENTRY } from '../../lib/core/severity.js';
+import { normalizeCliFeatureFlags } from './feature_flags.js';
+import { FLAGS } from './flags.js';
+import build from './main.js';
+import { FALLBACK_SEVERITY_ENTRY } from './severity.js';
 // CLI entry point.
 // Before adding logic to this file, please consider adding it to the main
 // programmatic command instead, so that the new logic is available when run

package/lib/core/build.js

@@ -30,7 +30,7 @@ export const startBuild = function (flags) {
     const errorMonitor = startErrorMonitor({ flags: flagsA, logs, bugsnagKey });
     return { ...flagsA, errorMonitor, logs, timers };
 };
-const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cachedConfigPath, outputConfigPath, cwd, 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, }) {
+const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cachedConfigPath, outputConfigPath, cwd, 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, }) {
     const configOpts = getConfigOpts({
         config,
         defaultConfig,
@@ -61,14 +61,6 @@ const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cached
         timers,
         quiet,
     });
-    if (framework) {
-        const runtime = supportedRuntimes[framework];
-        const skip = childEnv[runtime.skipFlag];
-        const installedPlugins = netlifyConfig.plugins.map((plugin) => plugin.package);
-        if (runtime !== undefined && skip !== 'true' && installedPlugins.contains(runtime.package)) {
-            netlifyConfig.plugins.push({ package: runtime.package });
-        }
-    }
     const constants = await getConstants({
         configPath,
         buildDir,
@@ -374,7 +366,3 @@ const runBuild = async function ({ childProcesses, pluginsOptions, netlifyConfig
     });
     return { stepsCount, netlifyConfig: netlifyConfigA, statuses, failedPlugins, timers: timersB, configMutations };
 };
-const supportedRuntimes = {
-    next: { package: '@netlify/plugin-nextjs', skipFlag: 'NETLIFY_NEXT_PLUGIN_SKIP' },
-    gatsby: { package: '@netlify/plugin-gatsby', skipFlag: 'NETLIFY_GATSBY_PLUGIN_SKIP' },
-};

package/lib/core/main.js

@@ -31,7 +31,6 @@ export default async function buildSite(flags = {}) {
             debug,
             testOpts,
             errorParams,
-            framework,
         });
         await handleBuildSuccess({
             framework,
@@ -75,7 +74,7 @@ export default async function buildSite(flags = {}) {
             testOpts,
             errorParams,
         });
-        await reportError({ error, framework, statsdOpts });
+        await reportError(error, statsdOpts, framework);
         return { success, severityCode, logs };
     }
 }
@@ -86,7 +85,7 @@ const handleBuildSuccess = async function ({ framework, dry, logs, timers, durat
     }
     logBuildSuccess(logs);
     logTimer(logs, durationNs, 'Netlify Build', systemLog);
-    await reportTimers({ timers, statsdOpts, framework });
+    await reportTimers(timers, statsdOpts, framework);
 };
 // Handles the calls and errors of telemetry reports
 const telemetryReport = async function ({ deployId, buildId, status, stepsCount, pluginsOptions, durationNs, siteInfo, telemetry, userNodeVersion, framework, testOpts, errorParams, }) {

package/lib/error/report.js

@@ -1,11 +1,13 @@
 import { isNetlifyMaintainedPlugin } from '../plugins/internal.js';
-import { closeClient, normalizeTagName, startClient } from '../report/statsd.js';
+import { closeClient, formatTags, normalizeTagName, startClient, validateStatsDOptions, } 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) {
+/**
+ * Record error rates of the build phase for monitoring.
+ * Sends to statsd daemon.
+ */
+export const reportError = async function (error, statsdOpts, framework) {
+    if (!validateStatsDOptions(statsdOpts)) {
         return;
     }
     const [errorInfo] = getErrorInfo(error);
@@ -16,12 +18,12 @@ export const reportError = async function ({ error, statsdOpts: { host, port },
     }
     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,
-    });
+    const statsDTags = { stage: stage ?? 'system', parent };
+    // Do not add a framework tag if empty string or null/undefined
+    if (framework) {
+        statsDTags.framework = framework;
+    }
+    const client = await startClient(statsdOpts);
+    client.increment('buildbot.build.stage.error', 1, formatTags(statsDTags));
     await closeClient(client);
 };

package/lib/report/statsd.js

@@ -1,31 +1,56 @@
 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;
+import { StatsD } from 'hot-shots';
+export const validateStatsDOptions = function (statsdOpts) {
+    return !!(statsdOpts && statsdOpts.host && statsdOpts.port);
 };
-// UDP packets are buffered and flushed at regular intervals by statsd-client.
-// Closing force flushing all of them.
+/**
+ * Start a new StatsD Client and a new UDP socket
+ */
+export const startClient = async function (statsdOpts) {
+    const { host, port } = statsdOpts;
+    return new StatsD({
+        host,
+        port,
+        // This caches the dns resolution for subsequent sends of metrics for this instance
+        // Because we only try to send the metrics on close, this comes only into effect if `bufferFlushInterval` time is exceeded
+        cacheDns: true,
+        // set the maxBufferSize to infinite and the bufferFlushInterval very high, so that we only
+        // send the metrics on close or if more than 10 seconds past by
+        maxBufferSize: Infinity,
+        bufferFlushInterval: 10_000,
+    });
+};
+/**
+ * Close the StatsD Client
+ *
+ * UDP packets are buffered and flushed every 10 seconds and
+ * closing the client forces all buffered metrics to be flushed.
+ */
 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);
+    await promisify(client.close.bind(client))();
 };
-// Make sure the timer name does not include special characters.
-// For example, the `packageName` of local plugins includes dots.
+/**
+ * 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: '_' });
 };
+/**
+ * Formats and flattens the tags as array
+ * We do this because we might send the same tag with different values `{ tag: ['a', 'b'] }`
+ * which cannot be represented in an flattened object and `hot-shots` also supports tags as array in the format `['tag:a', 'tag:b']`
+ */
+export const formatTags = function (tags) {
+    return Object.entries(tags)
+        .map(([key, value]) => {
+        if (Array.isArray(value)) {
+            return value.map((subValue) => `${key}:${subValue}`);
+        }
+        else {
+            return `${key}:${value}`;
+        }
+    })
+        .flat();
+};

package/lib/time/report.js

@@ -1,24 +1,30 @@
-import { closeClient, startClient } from '../report/statsd.js';
+import { closeClient, formatTags, startClient, validateStatsDOptions, } from '../report/statsd.js';
 import { addAggregatedTimers } from './aggregate.js';
 import { roundTimerToMillisecs } from './measure.js';
-// Record the duration of a build phase, for monitoring.
-// Sends to statsd daemon.
-export const reportTimers = async function ({ timers, statsdOpts: { host, port }, framework }) {
-    if (host === undefined) {
+/**
+ * Record the duration of a build phase, for monitoring.
+ * Sends to statsd daemon.
+ */
+export const reportTimers = async function (timers, statsdOpts, framework) {
+    if (!validateStatsDOptions(statsdOpts)) {
         return;
     }
-    const timersA = addAggregatedTimers(timers);
-    await sendTimers({ timers: timersA, host, port, framework });
+    await sendTimers(addAggregatedTimers(timers), statsdOpts, framework);
 };
-const sendTimers = async function ({ timers, host, port, framework }) {
-    const client = await startClient(host, port);
+const sendTimers = async function (timers, statsdOpts, framework) {
+    const client = await startClient(statsdOpts);
     timers.forEach((timer) => {
-        sendTimer({ timer, client, framework });
+        sendTimer(timer, client, framework);
     });
     await closeClient(client);
 };
-const sendTimer = function ({ timer: { metricName, stageTag, parentTag, durationNs, tags }, client, framework }) {
+const sendTimer = function (timer, client, framework) {
+    const { metricName, stageTag, parentTag, durationNs, tags } = timer;
     const durationMs = roundTimerToMillisecs(durationNs);
-    const frameworkTag = framework === undefined ? {} : { framework };
-    client.distribution(metricName, durationMs, { stage: stageTag, parent: parentTag, ...tags, ...frameworkTag });
+    const statsDTags = { stage: stageTag, parent: parentTag, ...tags };
+    // Do not add a framework tag if empty string or null/undefined
+    if (framework) {
+        statsDTags.framework = framework;
+    }
+    client.distribution(metricName, durationMs, formatTags(statsDTags));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.4.3-rc",
+  "version": "29.4.3",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/core/main.js",
@@ -66,12 +66,12 @@
     "@bugsnag/js": "^7.0.0",
     "@netlify/cache-utils": "^5.1.0",
     "@netlify/config": "^20.3.0",
-    "@netlify/edge-bundler": "8.0.0",
-    "@netlify/functions-utils": "^5.1.1",
+    "@netlify/edge-bundler": "8.1.2",
+    "@netlify/functions-utils": "^5.1.2",
     "@netlify/git-utils": "^5.1.0",
-    "@netlify/plugins-list": "^6.59.0",
+    "@netlify/plugins-list": "^6.61.0",
     "@netlify/run-utils": "^5.1.0",
-    "@netlify/zip-it-and-ship-it": "^8.2.0",
+    "@netlify/zip-it-and-ship-it": "^8.3.0",
     "@sindresorhus/slugify": "^2.0.0",
     "ansi-escapes": "^5.0.0",
     "chalk": "^5.0.0",
@@ -80,6 +80,7 @@
     "figures": "^4.0.0",
     "filter-obj": "^3.0.0",
     "got": "^10.0.0",
+    "hot-shots": "9.3.0",
     "indent-string": "^5.0.0",
     "is-plain-obj": "^4.0.0",
     "js-yaml": "^4.0.0",
@@ -105,7 +106,6 @@
     "rfdc": "^1.3.0",
     "safe-json-stringify": "^1.2.0",
     "semver": "^7.0.0",
-    "statsd-client": "0.4.7",
     "string-width": "^5.0.0",
     "strip-ansi": "^7.0.0",
     "supports-color": "^9.0.0",
@@ -120,7 +120,6 @@
   "devDependencies": {
     "@netlify/nock-udp": "^3.1.0",
     "@types/node": "^14.18.31",
-    "@types/statsd-client": "^0.4.3",
     "atob": "^2.1.2",
     "ava": "^4.0.0",
     "c8": "^7.12.0",
@@ -148,5 +147,6 @@
     "compilerOptions": {
       "module": "commonjs"
     }
-  }
+  },
+  "gitHead": "c534df8433e85724d77a38c288a2a5cb55eb59b8"
 }