@netlify/zip-it-and-ship-it 9.37.1 → 9.37.2

package/dist/runtimes/node/index.js

@@ -67,6 +67,7 @@ const zipFunction = async function ({ archiveFormat, basePath, cache, config = {
         stat,
     });
     createPluginsModulesPathAliases(srcFiles, pluginsModulesPath, aliases, finalBasePath);
+    const generator = mergedConfig?.generator || getInternalValue(isInternal);
     const zipPath = await zipNodeJs({
         aliases,
         archiveFormat,
@@ -83,6 +84,7 @@ const zipFunction = async function ({ archiveFormat, basePath, cache, config = {
         rewrites,
         runtimeAPIVersion,
         srcFiles,
+        generator,
     });
     await cleanupFunction?.();
     // Getting the invocation mode from ISC, in case the function is using the
@@ -105,7 +107,7 @@ const zipFunction = async function ({ archiveFormat, basePath, cache, config = {
         config: mergedConfig,
         displayName: mergedConfig?.name,
         entryFilename: zipPath.entryFilename,
-        generator: mergedConfig?.generator || getInternalValue(isInternal),
+        generator,
         timeout: mergedConfig?.timeout,
         inputs,
         includedFiles,

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

@@ -7,6 +7,12 @@ 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;
@@ -21,7 +27,7 @@ export declare const conflictsWithEntryFile: (srcFiles: string[], { basePath, ex
     mainFile: string;
     runtimeAPIVersion: number;
 }) => boolean;
-export declare const getTelemetryFile: () => EntryFile;
+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

@@ -9,6 +9,18 @@ export const ENTRY_FILE_NAME = '___netlify-entry-point';
 export const BOOTSTRAP_FILE_NAME = '___netlify-bootstrap.mjs';
 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) {
@@ -73,10 +85,32 @@ const getEntryFileName = ({ extension, featureFlags, filename, runtimeAPIVersion
     }
     return `${basename(filename, extname(filename))}${extension}`;
 };
-export const getTelemetryFile = () => {
+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');
-    const contents = readFileSync(filePath, 'utf8');
+    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,

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.d.ts

@@ -17,6 +17,7 @@ interface ZipNodeParameters {
     rewrites?: Map<string, string>;
     runtimeAPIVersion: number;
     srcFiles: string[];
+    generator?: string;
 }
 export declare const zipNodeJs: ({ archiveFormat, ...options }: ZipNodeParameters & {
     archiveFormat: ArchiveFormat;

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

@@ -94,7 +94,7 @@ const createDirectory = async function ({ aliases = new Map(), basePath, cache,
     });
     return { path: functionFolder, entryFilename };
 };
-const createZipArchive = async function ({ aliases = new Map(), basePath, cache, destFolder, extension, featureFlags, filename, mainFile, moduleFormat, rewrites, runtimeAPIVersion, srcFiles, }) {
+const createZipArchive = async function ({ aliases = new Map(), basePath, 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
@@ -131,7 +131,7 @@ const createZipArchive = async function ({ aliases = new Map(), basePath, cache,
         entryFilename = entryFile.filename;
         addEntryFileToZip(archive, entryFile);
     }
-    const telemetryFile = getTelemetryFile();
+    const telemetryFile = getTelemetryFile(generator);
     if (featureFlags.zisi_add_instrumentation_loader === true) {
         addEntryFileToZip(archive, telemetryFile);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/zip-it-and-ship-it",
-  "version": "9.37.1",
+  "version": "9.37.2",
   "description": "Zip it and ship it",
   "main": "./dist/main.js",
   "type": "module",
@@ -44,7 +44,7 @@
     "@babel/parser": "^7.22.5",
     "@babel/types": "7.24.6",
     "@netlify/binary-info": "^1.0.0",
-    "@netlify/serverless-functions-api": "^1.18.4",
+    "@netlify/serverless-functions-api": "^1.18.5",
     "@vercel/nft": "^0.27.1",
     "archiver": "^7.0.0",
     "common-path-prefix": "^3.0.0",
@@ -105,5 +105,5 @@
   "engines": {
     "node": "^14.18.0 || >=16.0.0"
   },
-  "gitHead": "bcf99673bb311e1e86fe44e8902875328e90cf88"
+  "gitHead": "73b6616a85923ed3c436747b5d69353400236a71"
 }