@netlify/build 29.28.0 → 29.28.1

package/lib/core/flags.d.ts

@@ -169,6 +169,11 @@ export const FLAGS: {
         describe: string;
         hidden: boolean;
     };
+    'tracing.preloadingEnabled': {
+        boolean: boolean;
+        describe: string;
+        hidden: boolean;
+    };
     'tracing.apiKey': {
         string: boolean;
         describe: string;

package/lib/core/flags.js

@@ -202,6 +202,11 @@ Default: false`,
         describe: 'Enable distributed tracing for build',
         hidden: true,
     },
+    'tracing.preloadingEnabled': {
+        boolean: true,
+        describe: 'Enable distributed tracing for build via module preloading, to be removed once fully rolled out',
+        hidden: true,
+    },
     'tracing.apiKey': {
         string: true,
         describe: 'API Key for the tracing backend provider',

package/lib/core/normalize_flags.js

@@ -58,6 +58,7 @@ const getDefaultFlags = function ({ env: envOpt = {} }, combinedEnv) {
         // honeycomb directly - https://github.com/honeycombio/honeycomb-opentelemetry-node/issues/201
         tracing: {
             enabled: false,
+            preloadingEnabled: false,
             apiKey: '-',
             // defaults to always sample
             sampleRate: 1,

package/lib/core/types.d.ts

@@ -76,6 +76,7 @@ export type ErrorParam = {
 };
 export type TracingOptions = {
     enabled: boolean;
+    preloadingEnabled: boolean;
     httpProtocol: string;
     host: string;
     port: number;

package/lib/plugins/spawn.js

@@ -31,6 +31,8 @@ const startPlugin = async function ({ pluginDir, nodePath, buildDir, childEnv, s
         preferLocal: true,
         localDir: pluginDir,
         nodePath,
+        // make sure we don't pass build's node cli properties for now (e.g. --import)
+        nodeOptions: [],
         execPath: nodePath,
         env: childEnv,
         extendEnv: false,

package/lib/tracing/main.d.ts

@@ -1,18 +1,29 @@
+import { Context } from '@opentelemetry/api';
 import type { TracingOptions } from '../core/types.js';
+/**
+ * Gets the global context to be used when initialising our root span
+ * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
+ */
+export declare const getGlobalContext: () => Context;
+/**
+ * Sets global context to be used when initialising our root span
+ * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
+ */
+export declare const setGlobalContext: (ctx: Context) => void;
 /** Starts the tracing SDK, if there's already a tracing service this will be a no-op */
-export declare const startTracing: (options: TracingOptions, logger: (...args: any[]) => void) => import("@opentelemetry/api").Context | undefined;
+export declare const startTracing: (options: TracingOptions, logger: (...args: any[]) => void) => 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 active context */
 export declare const setMultiSpanAttributes: (attributes: {
     [key: string]: string;
-}) => import("@opentelemetry/api").Context;
+}) => Context;
 /** Add error information to the current active span (if any) */
 export declare const addErrorToActiveSpan: (error: Error) => void;
 export declare const addEventToActiveSpan: (eventName: string, attributes?: {
     [key: string]: string;
 } | undefined) => void;
-export declare const loadBaggageFromFile: (baggageFilePath: string) => import("@opentelemetry/api").Context;
+export declare const loadBaggageFromFile: (baggageFilePath: string) => Context;
 /** Attributes used for the root span of our execution */
 export type RootExecutionAttributes = {
     'build.id': string;

package/lib/tracing/main.js

@@ -1,6 +1,6 @@
 import { readFileSync } from 'node:fs';
 import { HoneycombSDK } from '@honeycombio/opentelemetry-node';
-import { context, trace, propagation, SpanStatusCode, diag, DiagLogLevel } from '@opentelemetry/api';
+import { context, trace, propagation, SpanStatusCode, diag, DiagLogLevel, } from '@opentelemetry/api';
 import { parseKeyPairsIntoRecord } from '@opentelemetry/core/build/src/baggage/utils.js';
 import { isBuildError } from '../error/info.js';
 import { parseErrorInfo } from '../error/parse/parse.js';
@@ -22,8 +22,30 @@ const getOtelLogger = function (logger) {
         warn: otelLogger,
     };
 };
+/**
+ * Gets the global context to be used when initialising our root span
+ * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
+ */
+export const getGlobalContext = function () {
+    if (global['NETLIFY_GLOBAL_CONTEXT'] === undefined) {
+        return context.active();
+    }
+    return global['NETLIFY_GLOBAL_CONTEXT'];
+};
+/**
+ * Sets global context to be used when initialising our root span
+ * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
+ */
+export const setGlobalContext = function (ctx) {
+    global['NETLIFY_GLOBAL_CONTEXT'] = ctx;
+};
 /** Starts the tracing SDK, if there's already a tracing service this will be a no-op */
 export const startTracing = function (options, logger) {
+    // As we roll out the new way to initialise the SDK, if we detect preloading is enabled,
+    // it means we're using `@netlify/opentelemetry-sdk-setup` so we must get the initial context from the global store
+    if (options.preloadingEnabled) {
+        return getGlobalContext();
+    }
     if (!options.enabled)
         return;
     if (sdk)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.28.0",
+  "version": "29.28.1",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/index.js",
@@ -70,11 +70,11 @@
     "@netlify/config": "^20.10.0",
     "@netlify/edge-bundler": "10.1.3",
     "@netlify/framework-info": "^9.8.10",
-    "@netlify/functions-utils": "^5.2.41",
+    "@netlify/functions-utils": "^5.2.42",
     "@netlify/git-utils": "^5.1.1",
     "@netlify/plugins-list": "^6.72.0",
     "@netlify/run-utils": "^5.1.1",
-    "@netlify/zip-it-and-ship-it": "9.26.2",
+    "@netlify/zip-it-and-ship-it": "9.26.4",
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/core": "^1.17.1",
     "@sindresorhus/slugify": "^2.0.0",
@@ -140,11 +140,19 @@
     "process-exists": "^5.0.0",
     "sinon": "^13.0.0",
     "tmp-promise": "^3.0.2",
-    "tsd": "^0.28.0",
+    "tsd": "^0.29.0",
     "yarn": "^1.22.4"
   },
+  "peerDependencies": {
+    "@netlify/opentelemetry-sdk-setup": "^1.0.1"
+  },
+  "peerDependenciesMeta": {
+    "@netlify/opentelemetry-sdk-setup": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "4731f03bc8ba9cc1a8e42f95777ed24497c727b5"
+  "gitHead": "5aef135bf29606313b5e2547c4c7d77c8ff64d56"
 }