@netlify/zip-it-and-ship-it 12.0.0 → 12.0.1

package/dist/feature_flags.d.ts

@@ -7,6 +7,7 @@ export declare const defaultFlags: {
     readonly zisi_output_cjs_extension: false;
     readonly zisi_unique_entry_file: false;
     readonly zisi_esbuild_fail_double_glob: false;
+    readonly zisi_add_instrumentation_loader: true;
     readonly zisi_dynamic_import_function_handler: false;
 };
 export type FeatureFlags = Partial<Record<keyof typeof defaultFlags, boolean>>;
@@ -19,5 +20,6 @@ export declare const getFlags: (input?: Record<string, boolean>, flags?: {
     readonly zisi_output_cjs_extension: false;
     readonly zisi_unique_entry_file: false;
     readonly zisi_esbuild_fail_double_glob: false;
+    readonly zisi_add_instrumentation_loader: true;
     readonly zisi_dynamic_import_function_handler: false;
 }) => FeatureFlags;

package/dist/feature_flags.js

@@ -18,6 +18,8 @@ export const defaultFlags = {
     zisi_unique_entry_file: false,
     // If multiple glob stars are in includedFiles, fail the build instead of warning.
     zisi_esbuild_fail_double_glob: false,
+    // Adds the `___netlify-telemetry.mjs` file to the function bundle.
+    zisi_add_instrumentation_loader: true,
     // Dynamically import the function handler.
     zisi_dynamic_import_function_handler: false,
 };

package/dist/runtimes/go/index.js

@@ -1,5 +1,5 @@
 import { basename, dirname, extname, join } from 'path';
-import { copyFile } from 'cp-file';
+import { copyFile } from 'copy-file';
 import { cachedLstat, cachedReaddir } from '../../utils/fs.js';
 import getInternalValue from '../../utils/get_internal_value.js';
 import { nonNullable } from '../../utils/non_nullable.js';

package/dist/runtimes/node/index.js

@@ -1,5 +1,5 @@
 import { extname, join } from 'path';
-import { copyFile } from 'cp-file';
+import { copyFile } from 'copy-file';
 import { INVOCATION_MODE } from '../../function.js';
 import { Priority } from '../../priority.js';
 import { getTrafficRulesConfig } from '../../rate_limit.js';

package/dist/runtimes/node/utils/entry_file.d.ts

@@ -4,10 +4,17 @@ export declare const ENTRY_FILE_NAME = "___netlify-entry-point";
 export declare const BOOTSTRAP_FILE_NAME = "___netlify-bootstrap.mjs";
 export declare const BOOTSTRAP_VERSION_FILE_NAME = "___netlify-bootstrap-version";
 export declare const METADATA_FILE_NAME = "___netlify-metadata.json";
+export declare const TELEMETRY_FILE_NAME = "___netlify-telemetry.mjs";
 export interface EntryFile {
     contents: string;
     filename: string;
 }
+/**
+ * A minimal implementation of kebab-case.
+ * It is used to transform the generator name into a service name for the telemetry file.
+ * As DataDog has a special handling for the service name, we need to make sure it is kebab-case.
+ */
+export declare const kebabCase: (input: string) => string;
 export declare const isNamedLikeEntryFile: (file: string, { basePath, featureFlags, filename, runtimeAPIVersion, }: {
     basePath: string;
     featureFlags: FeatureFlags;
@@ -22,6 +29,7 @@ export declare const conflictsWithEntryFile: (srcFiles: string[], { basePath, ex
     mainFile: string;
     runtimeAPIVersion: number;
 }) => boolean;
+export declare const getTelemetryFile: (generator?: string) => EntryFile;
 export declare const getEntryFile: ({ commonPrefix, featureFlags, filename, mainFile, moduleFormat, userNamespace, runtimeAPIVersion, }: {
     commonPrefix: string;
     featureFlags: FeatureFlags;

package/dist/runtimes/node/utils/entry_file.js

@@ -1,3 +1,5 @@
+import { readFileSync } from 'fs';
+import { createRequire } from 'module';
 import { basename, extname, resolve } from 'path';
 import { FunctionBundlingUserError } from '../../../utils/error.js';
 import { RUNTIME } from '../../runtime.js';
@@ -7,6 +9,20 @@ export const ENTRY_FILE_NAME = '___netlify-entry-point';
 export const BOOTSTRAP_FILE_NAME = '___netlify-bootstrap.mjs';
 export const BOOTSTRAP_VERSION_FILE_NAME = '___netlify-bootstrap-version';
 export const METADATA_FILE_NAME = '___netlify-metadata.json';
+export const TELEMETRY_FILE_NAME = '___netlify-telemetry.mjs';
+const require = createRequire(import.meta.url);
+/**
+ * A minimal implementation of kebab-case.
+ * It is used to transform the generator name into a service name for the telemetry file.
+ * As DataDog has a special handling for the service name, we need to make sure it is kebab-case.
+ */
+export const kebabCase = (input) => input
+    .replace(/([a-z])([A-Z])/g, '$1 $2')
+    .replace(/[@#//$\s_\\.-]+/g, ' ')
+    .trim()
+    .toLowerCase()
+    .split(' ')
+    .join('-');
 const getEntryFileContents = (mainPath, moduleFormat, featureFlags, runtimeAPIVersion) => {
     const importPath = `.${mainPath.startsWith('/') ? mainPath : `/${mainPath}`}`;
     if (runtimeAPIVersion === 2) {
@@ -77,6 +93,37 @@ const getEntryFileName = ({ extension, featureFlags, filename, runtimeAPIVersion
     }
     return `${basename(filename, extname(filename))}${extension}`;
 };
+export const getTelemetryFile = (generator) => {
+    // TODO: switch with import.meta.resolve once we drop support for Node 16.x
+    const filePath = require.resolve('@netlify/serverless-functions-api/instrumentation.js');
+    let serviceName;
+    let serviceVersion;
+    if (generator) {
+        // the generator can be something like: `@netlify/plugin-nextjs@14.13.2`
+        // following the convention of name@version but it must not have a version.
+        // split the generator by the @ sign to separate name and version.
+        // pop the last part (the version) and join the rest with a @ again.
+        const versionSepPos = generator.lastIndexOf('@');
+        if (versionSepPos > 1) {
+            const name = generator.substring(0, versionSepPos);
+            const version = generator.substring(versionSepPos + 1);
+            serviceVersion = version;
+            serviceName = kebabCase(name);
+        }
+        else {
+            serviceName = kebabCase(generator);
+        }
+    }
+    const contents = `
+var SERVICE_NAME = ${JSON.stringify(serviceName)};
+var SERVICE_VERSION = ${JSON.stringify(serviceVersion)};
+${readFileSync(filePath, 'utf8')}
+`;
+    return {
+        contents,
+        filename: TELEMETRY_FILE_NAME,
+    };
+};
 export const getEntryFile = ({ commonPrefix, featureFlags, filename, mainFile, moduleFormat, userNamespace, runtimeAPIVersion, }) => {
     const mainPath = normalizeFilePath({ commonPrefix, path: mainFile, userNamespace });
     const extension = getFileExtensionForFormat(moduleFormat, featureFlags, runtimeAPIVersion);

package/dist/runtimes/node/utils/entry_file.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/runtimes/node/utils/entry_file.test.js

@@ -0,0 +1,35 @@
+import { test, expect } from 'vitest';
+import { getTelemetryFile, kebabCase } from './entry_file.js';
+test('kebab-case', () => {
+    expect(kebabCase('hello-world')).toBe('hello-world');
+    expect(kebabCase('hello World')).toBe('hello-world');
+    expect(kebabCase('--Hello--World--')).toBe('hello-world');
+    expect(kebabCase('Next.js Runtime')).toBe('next-js-runtime');
+    expect(kebabCase('@netlify/plugin-nextjs@14')).toBe('netlify-plugin-nextjs-14');
+    expect(kebabCase('CamelCaseShould_Be_transformed')).toBe('camel-case-should-be-transformed');
+    expect(kebabCase('multiple   spaces')).toBe('multiple-spaces');
+});
+test('getTelemetryFile should handle no defined generator', () => {
+    const telemetryFile = getTelemetryFile();
+    expect(telemetryFile.filename).toBe('___netlify-telemetry.mjs');
+    expect(telemetryFile.contents).toContain('var SERVICE_NAME = undefined;');
+    expect(telemetryFile.contents).toContain('var SERVICE_VERSION = undefined;');
+});
+test('getTelemetryFile should handle internalFunc generator', () => {
+    const telemetryFile = getTelemetryFile('internalFunc');
+    expect(telemetryFile.filename).toBe('___netlify-telemetry.mjs');
+    expect(telemetryFile.contents).toContain('var SERVICE_NAME = "internal-func";');
+    expect(telemetryFile.contents).toContain('var SERVICE_VERSION = undefined;');
+});
+test('getTelemetryFile should handle generator with version', () => {
+    const telemetryFile = getTelemetryFile('@netlify/plugin-nextjs@14.13.2');
+    expect(telemetryFile.filename).toBe('___netlify-telemetry.mjs');
+    expect(telemetryFile.contents).toContain('var SERVICE_NAME = "netlify-plugin-nextjs";');
+    expect(telemetryFile.contents).toContain('var SERVICE_VERSION = "14.13.2";');
+});
+test('getTelemetryFile should handle generator without version', () => {
+    const telemetryFile = getTelemetryFile('@netlify/plugin-nextjs');
+    expect(telemetryFile.filename).toBe('___netlify-telemetry.mjs');
+    expect(telemetryFile.contents).toContain('var SERVICE_NAME = "netlify-plugin-nextjs";');
+    expect(telemetryFile.contents).toContain('var SERVICE_VERSION = undefined;');
+});

package/dist/runtimes/node/utils/zip.js

@@ -7,7 +7,7 @@ import { copyFile } from 'cp-file';
 import pMap from 'p-map';
 import { addZipContent, addZipFile, ARCHIVE_FORMAT, endZip, startZip, } from '../../../archive.js';
 import { cachedLstat, mkdirAndWriteFile } from '../../../utils/fs.js';
-import { BOOTSTRAP_FILE_NAME, METADATA_FILE_NAME, conflictsWithEntryFile, getEntryFile, isNamedLikeEntryFile, } from './entry_file.js';
+import { BOOTSTRAP_FILE_NAME, METADATA_FILE_NAME, conflictsWithEntryFile, getEntryFile, getTelemetryFile, isNamedLikeEntryFile, } from './entry_file.js';
 import { getMetadataFile } from './metadata_file.js';
 import { normalizeFilePath } from './normalize_path.js';
 import { getPackageJsonIfAvailable } from './package_json.js';
@@ -49,12 +49,18 @@ const createDirectory = async function ({ aliases = new Map(), basePath, cache,
         userNamespace,
         runtimeAPIVersion,
     });
+    const { contents: telemetryContents, filename: telemetryFilename } = getTelemetryFile();
     const functionFolder = join(destFolder, basename(filename, extension));
     // Deleting the functions directory in case it exists before creating it.
     await rm(functionFolder, { recursive: true, force: true, maxRetries: 3 });
     await mkdir(functionFolder, { recursive: true });
     // Writing entry files.
-    await writeFile(join(functionFolder, entryFilename), entryContents);
+    await Promise.all([
+        writeFile(join(functionFolder, entryFilename), entryContents),
+        featureFlags.zisi_add_instrumentation_loader
+            ? writeFile(join(functionFolder, telemetryFilename), telemetryContents)
+            : Promise.resolve(),
+    ]);
     if (runtimeAPIVersion === 2) {
         addBootstrapFile(srcFiles, aliases);
     }
@@ -94,7 +100,7 @@ const createDirectory = async function ({ aliases = new Map(), basePath, cache,
     });
     return { path: functionFolder, entryFilename };
 };
-const createZipArchive = async function ({ aliases = new Map(), basePath, branch, cache, destFolder, extension, featureFlags, filename, mainFile, moduleFormat, rewrites, runtimeAPIVersion, srcFiles, }) {
+const createZipArchive = async function ({ aliases = new Map(), basePath, branch, cache, destFolder, extension, featureFlags, filename, mainFile, moduleFormat, rewrites, runtimeAPIVersion, srcFiles, generator, }) {
     const destPath = join(destFolder, `${basename(filename, extension)}.zip`);
     const { archive, output } = startZip(destPath);
     // There is a naming conflict with the entry file if one of the supporting
@@ -132,6 +138,10 @@ const createZipArchive = async function ({ aliases = new Map(), basePath, branch
         entryFilename = entryFile.filename;
         addEntryFileToZip(archive, entryFile);
     }
+    const telemetryFile = getTelemetryFile(generator);
+    if (featureFlags.zisi_add_instrumentation_loader === true) {
+        addEntryFileToZip(archive, telemetryFile);
+    }
     if (runtimeAPIVersion === 2) {
         const bootstrapPath = addBootstrapFile(srcFiles, aliases);
         const { version } = await getPackageJsonIfAvailable(bootstrapPath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/zip-it-and-ship-it",
-  "version": "12.0.0",
+  "version": "12.0.1",
   "description": "Zip it and ship it",
   "main": "./dist/main.js",
   "type": "module",
@@ -44,11 +44,11 @@
     "@babel/parser": "^7.22.5",
     "@babel/types": "7.27.1",
     "@netlify/binary-info": "^1.0.0",
-    "@netlify/serverless-functions-api": "2.0.2",
+    "@netlify/serverless-functions-api": "^1.41.2",
     "@vercel/nft": "0.27.7",
     "archiver": "^7.0.0",
     "common-path-prefix": "^3.0.0",
-    "cp-file": "^10.0.0",
+    "copy-file": "^11.0.0",
     "es-module-lexer": "^1.0.0",
     "esbuild": "0.25.4",
     "execa": "^7.0.0",
@@ -89,7 +89,7 @@
     "@vitest/coverage-v8": "0.34.6",
     "browserslist": "4.24.5",
     "cardinal": "2.1.1",
-    "cpy": "9.0.1",
+    "cpy": "11.1.0",
     "decompress": "4.2.1",
     "deepmerge": "^4.3.1",
     "get-stream": "6.0.1",
@@ -102,5 +102,5 @@
   "engines": {
     "node": ">=18.14.0"
   },
-  "gitHead": "11241b50b724a2f229614e74dd22c86c4ca8757d"
+  "gitHead": "20ebc60880b209b976d33578734b64007103cd5f"
 }