@vercel/build-utils 9.2.0 → 9.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @vercel/build-utils
 
+## 9.3.0
+
+### Minor Changes
+
+- Support process tracing ([#12894](https://github.com/vercel/vercel/pull/12894))
+
+## 9.2.1
+
+### Patch Changes
+
+- Add tracer utility to @vercel/build-utils ([#13013](https://github.com/vercel/vercel/pull/13013))
+
 ## 9.2.0
 
 ### Minor Changes

package/dist/fs/run-user-scripts.d.ts

@@ -198,7 +198,7 @@ export declare function runCustomInstallCommand({ destPath, installCommand, node
 export declare function runPackageJsonScript(destPath: string, scriptNames: string | Iterable<string>, spawnOpts?: SpawnOptions): Promise<boolean>;
 export declare function runBundleInstall(destPath: string, args?: string[], spawnOpts?: SpawnOptions, meta?: Meta): Promise<void>;
 export declare function runPipInstall(destPath: string, args?: string[], spawnOpts?: SpawnOptions, meta?: Meta): Promise<void>;
-export declare function getScriptName(pkg: Pick<PackageJson, 'scripts'> | null | undefined, possibleNames: Iterable<string>): string | null;
+export declare function getScriptName(pkg: Pick<PackageJson, 'scripts'> | null | undefined, possibleNames: Iterable<string>): string | undefined;
 /**
  * @deprecate installDependencies() is deprecated.
  * Please use runNpmInstall() instead.

package/dist/fs/run-user-scripts.js

@@ -909,7 +909,7 @@ function getScriptName(pkg, possibleNames) {
       }
     }
   }
-  return null;
+  return void 0;
 }
 const installDependencies = (0, import_util.deprecate)(
   runNpmInstall,

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import download, { downloadFile, DownloadedFiles, isSymbolicLink, isDirectory }
 import getWriteableDirectory from './fs/get-writable-directory';
 import glob, { GlobOptions } from './fs/glob';
 import rename from './fs/rename';
-import { spawnAsync, execCommand, spawnCommand, walkParentDirs, getScriptName, installDependencies, runPackageJsonScript, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getPathForPackageManager, getSpawnOptions, getNodeBinPath, getNodeBinPaths, scanParentDirs, traverseUpDirectories } from './fs/run-user-scripts';
+import { spawnAsync, execCommand, spawnCommand, walkParentDirs, getScriptName, installDependencies, runPackageJsonScript, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getPathForPackageManager, detectPackageManager, getSpawnOptions, getNodeBinPath, getNodeBinPaths, scanParentDirs, traverseUpDirectories } from './fs/run-user-scripts';
 import { getLatestNodeVersion, getDiscontinuedNodeVersions, getSupportedNodeVersion } from './fs/node-version';
 import streamToBuffer, { streamToBufferChunks } from './fs/stream-to-buffer';
 import debug from './debug';
@@ -18,7 +18,7 @@ import { getPrefixedEnvVars } from './get-prefixed-env-vars';
 import { cloneEnv } from './clone-env';
 import { hardLinkDir } from './hard-link-dir';
 import { validateNpmrc } from './validate-npmrc';
-export { FileBlob, FileFsRef, FileRef, Lambda, NodejsLambda, createLambda, Prerender, download, downloadFile, DownloadedFiles, getWriteableDirectory, glob, GlobOptions, rename, spawnAsync, getScriptName, installDependencies, runPackageJsonScript, execCommand, spawnCommand, walkParentDirs, getNodeBinPath, getNodeBinPaths, getSupportedNodeVersion, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getPathForPackageManager, getLatestNodeVersion, getDiscontinuedNodeVersions, getSpawnOptions, getPlatformEnv, getPrefixedEnvVars, streamToBuffer, streamToBufferChunks, debug, isSymbolicLink, isDirectory, getLambdaOptionsFromFunction, scanParentDirs, getIgnoreFilter, cloneEnv, hardLinkDir, traverseUpDirectories, validateNpmrc, };
+export { FileBlob, FileFsRef, FileRef, Lambda, NodejsLambda, createLambda, Prerender, download, downloadFile, DownloadedFiles, getWriteableDirectory, glob, GlobOptions, rename, spawnAsync, getScriptName, installDependencies, runPackageJsonScript, execCommand, spawnCommand, walkParentDirs, getNodeBinPath, getNodeBinPaths, getSupportedNodeVersion, detectPackageManager, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getPathForPackageManager, getLatestNodeVersion, getDiscontinuedNodeVersions, getSpawnOptions, getPlatformEnv, getPrefixedEnvVars, streamToBuffer, streamToBufferChunks, debug, isSymbolicLink, isDirectory, getLambdaOptionsFromFunction, scanParentDirs, getIgnoreFilter, cloneEnv, hardLinkDir, traverseUpDirectories, validateNpmrc, };
 export { EdgeFunction } from './edge-function';
 export { readConfigFile } from './fs/read-config-file';
 export { normalizePath } from './fs/normalize-path';
@@ -27,6 +27,7 @@ export * from './should-serve';
 export * from './schemas';
 export * from './types';
 export * from './errors';
+export * from './trace';
 export { NODE_VERSIONS } from './fs/node-version';
 export { getInstalledPackageVersion } from './get-installed-package-version';
 export { defaultCachePathGlob } from './default-cache-path-glob';

package/dist/index.js

@@ -21845,6 +21845,8 @@ var require_ignore = __commonJS({
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  BUILDER_COMPILE_STEP: () => BUILDER_COMPILE_STEP,
+  BUILDER_INSTALLER_STEP: () => BUILDER_INSTALLER_STEP,
   EdgeFunction: () => EdgeFunction,
   FileBlob: () => FileBlob,
   FileFsRef: () => file_fs_ref_default,
@@ -21855,12 +21857,14 @@ __export(src_exports, {
   NodejsLambda: () => NodejsLambda,
   NowBuildError: () => NowBuildError,
   Prerender: () => Prerender,
+  Span: () => Span,
   Version: () => Version,
   buildsSchema: () => buildsSchema,
   cloneEnv: () => cloneEnv,
   createLambda: () => createLambda,
   debug: () => debug,
   defaultCachePathGlob: () => defaultCachePathGlob,
+  detectPackageManager: () => detectPackageManager,
   download: () => download,
   downloadFile: () => downloadFile,
   execCommand: () => execCommand,
@@ -23918,7 +23922,7 @@ function getScriptName(pkg, possibleNames) {
       }
     }
   }
-  return null;
+  return void 0;
 }
 var installDependencies = (0, import_util2.deprecate)(
   runNpmInstall,
@@ -24225,6 +24229,77 @@ var buildsSchema = {
   }
 };
 
+// src/trace/trace.ts
+var import_node_crypto = require("crypto");
+var NUM_OF_MICROSEC_IN_NANOSEC = BigInt("1000");
+function mapUndefinedAttributes(attrs) {
+  return Object.fromEntries(
+    Object.entries(attrs ?? {}).filter(
+      (attr) => !!attr[1]
+    )
+  );
+}
+var Span = class _Span {
+  constructor({
+    name,
+    parentId,
+    attrs,
+    reporter
+  }) {
+    this.name = name;
+    this.parentId = parentId;
+    this.attrs = mapUndefinedAttributes(attrs);
+    this.status = "started";
+    this.id = (0, import_node_crypto.randomUUID)();
+    this._reporter = reporter;
+    this.now = Date.now();
+    this._start = process.hrtime.bigint();
+  }
+  stop() {
+    if (this.status === "stopped") {
+      throw new Error(`Cannot stop a span which is already stopped`);
+    }
+    this.status = "stopped";
+    const end = process.hrtime.bigint();
+    const duration = Number((end - this._start) / NUM_OF_MICROSEC_IN_NANOSEC);
+    const timestamp = Number(this._start / NUM_OF_MICROSEC_IN_NANOSEC);
+    const traceEvent = {
+      name: this.name,
+      duration,
+      timestamp,
+      id: this.id,
+      parentId: this.parentId,
+      tags: this.attrs,
+      startTime: this.now
+    };
+    if (this._reporter) {
+      this._reporter.report(traceEvent);
+    }
+  }
+  setAttributes(attrs) {
+    Object.assign(this.attrs, mapUndefinedAttributes(attrs));
+  }
+  child(name, attrs) {
+    return new _Span({
+      name,
+      parentId: this.id,
+      attrs,
+      reporter: this._reporter
+    });
+  }
+  async trace(fn) {
+    try {
+      return await fn(this);
+    } finally {
+      this.stop();
+    }
+  }
+};
+
+// src/trace/constants.ts
+var BUILDER_INSTALLER_STEP = "vc.builder.install";
+var BUILDER_COMPILE_STEP = "vc.builder.build";
+
 // src/get-installed-package-version.ts
 async function getInstalledPackageVersion(packageName, path7) {
   try {
@@ -24246,6 +24321,8 @@ async function getInstalledPackageVersion(packageName, path7) {
 var defaultCachePathGlob = "**/{node_modules,.yarn/cache}/**";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  BUILDER_COMPILE_STEP,
+  BUILDER_INSTALLER_STEP,
   EdgeFunction,
   FileBlob,
   FileFsRef,
@@ -24256,12 +24333,14 @@ var defaultCachePathGlob = "**/{node_modules,.yarn/cache}/**";
   NodejsLambda,
   NowBuildError,
   Prerender,
+  Span,
   Version,
   buildsSchema,
   cloneEnv,
   createLambda,
   debug,
   defaultCachePathGlob,
+  detectPackageManager,
   download,
   downloadFile,
   execCommand,

package/dist/trace/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const BUILDER_INSTALLER_STEP = "vc.builder.install";
+export declare const BUILDER_COMPILE_STEP = "vc.builder.build";

package/dist/trace/constants.js

@@ -0,0 +1,31 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var constants_exports = {};
+__export(constants_exports, {
+  BUILDER_COMPILE_STEP: () => BUILDER_COMPILE_STEP,
+  BUILDER_INSTALLER_STEP: () => BUILDER_INSTALLER_STEP
+});
+module.exports = __toCommonJS(constants_exports);
+const BUILDER_INSTALLER_STEP = "vc.builder.install";
+const BUILDER_COMPILE_STEP = "vc.builder.build";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BUILDER_COMPILE_STEP,
+  BUILDER_INSTALLER_STEP
+});

package/dist/trace/index.d.ts

@@ -0,0 +1,3 @@
+export { Span } from './trace';
+export { BUILDER_COMPILE_STEP, BUILDER_INSTALLER_STEP } from './constants';
+export type { SpanId, TraceEvent, Reporter } from './trace';

package/dist/trace/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var trace_exports = {};
+__export(trace_exports, {
+  BUILDER_COMPILE_STEP: () => import_constants.BUILDER_COMPILE_STEP,
+  BUILDER_INSTALLER_STEP: () => import_constants.BUILDER_INSTALLER_STEP,
+  Span: () => import_trace.Span
+});
+module.exports = __toCommonJS(trace_exports);
+var import_trace = require("./trace");
+var import_constants = require("./constants");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BUILDER_COMPILE_STEP,
+  BUILDER_INSTALLER_STEP,
+  Span
+});

package/dist/trace/trace.d.ts

@@ -0,0 +1,37 @@
+export type SpanId = string;
+export type TraceEvent = {
+    parentId?: SpanId;
+    name: string;
+    id: SpanId;
+    timestamp: number;
+    duration: number;
+    tags: Record<string, string>;
+    startTime: number;
+};
+export type Reporter = {
+    report: (event: TraceEvent) => void;
+};
+interface Attributes {
+    [key: string]: string | undefined;
+}
+export declare class Span {
+    private name;
+    private id;
+    private parentId?;
+    private attrs;
+    private status;
+    private _start;
+    private now;
+    private _reporter;
+    constructor({ name, parentId, attrs, reporter, }: {
+        name: string;
+        parentId?: SpanId;
+        attrs?: Attributes;
+        reporter?: Reporter;
+    });
+    stop(): void;
+    setAttributes(attrs: Attributes): void;
+    child(name: string, attrs?: Attributes): Span;
+    trace<T>(fn: (span: Span) => T | Promise<T>): Promise<T>;
+}
+export {};

package/dist/trace/trace.js

@@ -0,0 +1,92 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var trace_exports = {};
+__export(trace_exports, {
+  Span: () => Span
+});
+module.exports = __toCommonJS(trace_exports);
+var import_node_crypto = require("node:crypto");
+const NUM_OF_MICROSEC_IN_NANOSEC = BigInt("1000");
+function mapUndefinedAttributes(attrs) {
+  return Object.fromEntries(
+    Object.entries(attrs ?? {}).filter(
+      (attr) => !!attr[1]
+    )
+  );
+}
+class Span {
+  constructor({
+    name,
+    parentId,
+    attrs,
+    reporter
+  }) {
+    this.name = name;
+    this.parentId = parentId;
+    this.attrs = mapUndefinedAttributes(attrs);
+    this.status = "started";
+    this.id = (0, import_node_crypto.randomUUID)();
+    this._reporter = reporter;
+    this.now = Date.now();
+    this._start = process.hrtime.bigint();
+  }
+  stop() {
+    if (this.status === "stopped") {
+      throw new Error(`Cannot stop a span which is already stopped`);
+    }
+    this.status = "stopped";
+    const end = process.hrtime.bigint();
+    const duration = Number((end - this._start) / NUM_OF_MICROSEC_IN_NANOSEC);
+    const timestamp = Number(this._start / NUM_OF_MICROSEC_IN_NANOSEC);
+    const traceEvent = {
+      name: this.name,
+      duration,
+      timestamp,
+      id: this.id,
+      parentId: this.parentId,
+      tags: this.attrs,
+      startTime: this.now
+    };
+    if (this._reporter) {
+      this._reporter.report(traceEvent);
+    }
+  }
+  setAttributes(attrs) {
+    Object.assign(this.attrs, mapUndefinedAttributes(attrs));
+  }
+  child(name, attrs) {
+    return new Span({
+      name,
+      parentId: this.id,
+      attrs,
+      reporter: this._reporter
+    });
+  }
+  async trace(fn) {
+    try {
+      return await fn(this);
+    } finally {
+      this.stop();
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Span
+});

package/dist/types.d.ts

@@ -5,6 +5,7 @@ import type FileBlob from './file-blob';
 import type { Lambda } from './lambda';
 import type { Prerender } from './prerender';
 import type { EdgeFunction } from './edge-function';
+import type { Span } from './trace';
 export interface Env {
     [name: string]: string | undefined;
 }
@@ -102,6 +103,10 @@ export interface BuildOptions {
      * fully processed
      */
     buildCallback?: (opts: Omit<BuildOptions, 'buildCallback'>) => Promise<void>;
+    /**
+     * The current trace state from the internal vc tracing
+     */
+    span?: Span;
 }
 export interface PrepareCacheOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/build-utils",
-  "version": "9.2.0",
+  "version": "9.3.0",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",