@netlify/build 29.23.5 → 29.24.0

package/lib/core/flags.d.ts

@@ -209,6 +209,11 @@ export const FLAGS: {
         describe: string;
         hidden: boolean;
     };
+    'tracing.baggageFilePath': {
+        string: boolean;
+        describe: string;
+        hidden: boolean;
+    };
     offline: {
         boolean: boolean;
         describe: string;

package/lib/core/flags.js

@@ -242,6 +242,11 @@ Default: false`,
         describe: 'Trace flags containing the trace settings for the given trace ID',
         hidden: true,
     },
+    'tracing.baggageFilePath': {
+        string: true,
+        describe: '',
+        hidden: true,
+    },
     offline: {
         boolean: true,
         describe: `Do not send requests to the Netlify API to retrieve site settings.

package/lib/core/normalize_flags.js

@@ -63,6 +63,7 @@ const getDefaultFlags = function ({ env: envOpt = {} }, combinedEnv) {
             sampleRate: 1,
             httpProtocol: DEFAULT_OTEL_ENDPOINT_PROTOCOL,
             port: DEFAULT_OTEL_TRACING_PORT,
+            baggageFilePath: '',
         },
         timeline: 'build',
         quiet: false,

package/lib/core/types.d.ts

@@ -80,4 +80,5 @@ export type TracingOptions = {
     traceId: string;
     traceFlags: number;
     parentSpanId: string;
+    baggageFilePath: string;
 };

package/lib/plugins_core/functions/index.js

@@ -1,6 +1,7 @@
 import { resolve } from 'path';
 import { RUNTIME, zipFunctions } from '@netlify/zip-it-and-ship-it';
 import { pathExists } from 'path-exists';
+import { addErrorInfo } from '../../error/info.js';
 import { log } from '../../log/logger.js';
 import { logBundleResults, logFunctionsNonExistingDir, logFunctionsToBundle } from '../../log/messages/core_steps.js';
 import { getZipError } from './error.js';
@@ -12,6 +13,38 @@ const getBundlers = (results = []) =>
 new Set(results
     .map((bundle) => (bundle.runtime === RUNTIME.JAVASCRIPT ? bundle.bundler : null))
     .filter(Boolean));
+// see https://docs.netlify.com/functions/trigger-on-events/#available-triggers
+const eventTriggeredFunctions = new Set([
+    'deploy-building',
+    'deploy-succeeded',
+    'deploy-failed',
+    'deploy-deleted',
+    'deploy-locked',
+    'deploy-unlocked',
+    'submission-created',
+    'split-test-activated',
+    'split-test-deactivated',
+    'split-test-modified',
+    'identity-validate',
+    'identity-signup',
+    'identity-login',
+]);
+const validateCustomRoutes = function (functions) {
+    for (const { routes, name, schedule } of functions) {
+        if (!routes || routes.length === 0)
+            continue;
+        if (schedule) {
+            const error = new Error(`Scheduled functions must not specify a custom path. Please remove the "path" configuration. Learn more about scheduled functions at https://ntl.fyi/custom-path-scheduled-functions.`);
+            addErrorInfo(error, { type: 'resolveConfig' });
+            throw error;
+        }
+        if (eventTriggeredFunctions.has(name.toLowerCase().replace('-background', ''))) {
+            const error = new Error(`Event-triggered functions must not specify a custom path. Please remove the "path" configuration or pick a different name for the function. Learn more about event-triggered functions at https://ntl.fyi/custom-path-event-triggered-functions.`);
+            addErrorInfo(error, { type: 'resolveConfig' });
+            throw error;
+        }
+    }
+};
 const zipFunctionsAndLogResults = async ({ buildDir, childEnv, featureFlags, functionsConfig, functionsDist, functionsSrc, internalFunctionsSrc, isRunningLocally, logs, repositoryRoot, userNodeVersion, systemLog, }) => {
     const zisiParameters = getZisiParameters({
         buildDir,
@@ -30,6 +63,7 @@ const zipFunctionsAndLogResults = async ({ buildDir, childEnv, featureFlags, fun
         log(logs, '');
         const sourceDirectories = [internalFunctionsSrc, functionsSrc].filter(Boolean);
         const results = await zipItAndShipIt.zipFunctions(sourceDirectories, functionsDist, zisiParameters);
+        validateCustomRoutes(results);
         const bundlers = Array.from(getBundlers(results));
         logBundleResults({ logs, results });
         return { bundlers };

package/lib/tracing/main.d.ts

@@ -3,12 +3,13 @@ import type { TracingOptions } from '../core/types.js';
 export declare const startTracing: (options: TracingOptions, logger: (...args: any[]) => void) => import("@opentelemetry/api").Context | undefined;
 /** Stops the tracing service if there's one running. This will flush any ongoing events */
 export declare const stopTracing: () => Promise<void>;
-/** Sets attributes to be propagated across child spans under the current context */
+/** Sets attributes to be propagated across child spans under the current active context */
 export declare const setMultiSpanAttributes: (attributes: {
     [key: string]: string;
 }) => import("@opentelemetry/api").Context;
 /** Add error information to the current active span (if any) */
 export declare const addErrorToActiveSpan: (error: Error) => void;
+export declare const loadBaggageFromFile: (baggageFilePath: string) => import("@opentelemetry/api").Context;
 /** Attributes used for the root span of our execution */
 export type RootExecutionAttributes = {
     'build.id': string;

package/lib/tracing/main.js

@@ -1,5 +1,7 @@
+import { readFileSync } from 'node:fs';
 import { HoneycombSDK } from '@honeycombio/opentelemetry-node';
 import { context, trace, propagation, SpanStatusCode, diag, DiagLogLevel } from '@opentelemetry/api';
+import { parseKeyPairsIntoRecord } from '@opentelemetry/core/build/src/baggage/utils.js';
 import { ROOT_PACKAGE_JSON } from '../utils/json.js';
 let sdk;
 /** Given a simple logging function return a `DiagLogger`. Used to setup our system logger as the diag logger.*/
@@ -36,14 +38,17 @@ export const startTracing = function (options, logger) {
     // in case there's a default console logger already registered (it would log a msg to it)
     diag.setLogger(getOtelLogger(logger), { logLevel: DiagLogLevel.INFO, suppressOverrideMessage: true });
     sdk.start();
+    // Loads the contents of the passed baggageFilePath into the baggage
+    const baggageCtx = loadBaggageFromFile(options.baggageFilePath);
     // Sets the current trace ID and span ID based on the options received
     // this is used as a way to propagate trace context from Buildbot
-    return trace.setSpanContext(context.active(), {
+    const ctx = trace.setSpanContext(baggageCtx, {
         traceId: options.traceId,
         spanId: options.parentSpanId,
         traceFlags: options.traceFlags,
         isRemote: true,
     });
+    return ctx;
 };
 /** Stops the tracing service if there's one running. This will flush any ongoing events */
 export const stopTracing = async function () {
@@ -59,12 +64,13 @@ export const stopTracing = async function () {
         diag.error(e);
     }
 };
-/** Sets attributes to be propagated across child spans under the current context */
+/** Sets attributes to be propagated across child spans under the current active context */
 export const setMultiSpanAttributes = function (attributes) {
     const currentBaggage = propagation.getBaggage(context.active());
+    // Create a baggage if there's none
     let baggage = currentBaggage === undefined ? propagation.createBaggage() : currentBaggage;
-    Object.entries(attributes).forEach((entry) => {
-        baggage = baggage.setEntry(entry[0], { value: entry[1] });
+    Object.entries(attributes).forEach(([key, value]) => {
+        baggage = baggage.setEntry(key, { value });
     });
     return propagation.setBaggage(context.active(), baggage);
 };
@@ -79,3 +85,20 @@ export const addErrorToActiveSpan = function (error) {
         message: error.message,
     });
 };
+//** Loads the baggage attributes from a baggabe file which follows W3C Baggage specification */
+export const loadBaggageFromFile = function (baggageFilePath) {
+    if (baggageFilePath.length === 0) {
+        diag.warn('Empty baggage file path provided, no context loaded');
+        return context.active();
+    }
+    let baggageString;
+    try {
+        baggageString = readFileSync(baggageFilePath, 'utf-8');
+    }
+    catch (error) {
+        diag.error(error);
+        return context.active();
+    }
+    const parsedBaggage = parseKeyPairsIntoRecord(baggageString);
+    return setMultiSpanAttributes(parsedBaggage);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.23.5",
+  "version": "29.24.0",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/index.js",
@@ -76,6 +76,7 @@
     "@netlify/run-utils": "^5.1.1",
     "@netlify/zip-it-and-ship-it": "9.25.4",
     "@opentelemetry/api": "^1.4.1",
+    "@opentelemetry/core": "^1.17.1",
     "@sindresorhus/slugify": "^2.0.0",
     "ansi-escapes": "^6.0.0",
     "chalk": "^5.0.0",
@@ -145,5 +146,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "db107b34adafddf6972b671687f584ee795befe9"
+  "gitHead": "d2322081693fa4fea32710d5551d5cf33b92ee33"
 }