fix: revert b0e66dd (#6334)

Author: mrstork

package-lock.json

@@ -44,7 +44,7 @@
     "@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",

packages/zip-it-and-ship-it/package.json

@@ -27,6 +27,9 @@ export const defaultFlags = {
   // 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,
 } as const

packages/zip-it-and-ship-it/src/feature_flags.ts

@@ -0,0 +1,41 @@
+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/[email protected]')
+  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;')
+})

packages/zip-it-and-ship-it/src/runtimes/node/utils/entry_file.test.ts

@@ -1,3 +1,5 @@
+import { readFileSync } from 'fs'
+import { createRequire } from 'module'
 import { basename, extname, resolve } from 'path'
 
 import type { FeatureFlags } from '../../../feature_flags.js'
@@ -17,12 +19,29 @@ 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)
 
 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 const kebabCase = (input: string): string =>
+  input
+    .replace(/([a-z])([A-Z])/g, '$1 $2')
+    .replace(/[@#//$\s_\\.-]+/g, ' ')
+    .trim()
+    .toLowerCase()
+    .split(' ')
+    .join('-')
+
 const getEntryFileContents = (
   mainPath: string,
   moduleFormat: string,
@@ -161,6 +180,40 @@ const getEntryFileName = ({
   return `${basename(filename, extname(filename))}${extension}`
 }
 
+export const getTelemetryFile = (generator?: string): EntryFile => {
+  // 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: string | undefined
+  let serviceVersion: string | undefined
+
+  if (generator) {
+    // the generator can be something like: `@netlify/[email protected]`
+    // 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,

packages/zip-it-and-ship-it/src/runtimes/node/utils/entry_file.ts

@@ -5,7 +5,7 @@ import os from 'os'
 import { basename, dirname, extname, join } from 'path'
 
 import { getPath as getV2APIPath } from '@netlify/serverless-functions-api'
-import { copyFile } from 'copy-file'
+import { copyFile } from 'cp-file'
 import pMap from 'p-map'
 
 import {
@@ -27,6 +27,7 @@ import {
   conflictsWithEntryFile,
   EntryFile,
   getEntryFile,
+  getTelemetryFile,
   isNamedLikeEntryFile,
 } from './entry_file.js'
 import { getMetadataFile } from './metadata_file.js'
@@ -111,14 +112,20 @@ const createDirectory = async function ({
     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)
@@ -192,6 +199,7 @@ const createZipArchive = async function ({
   rewrites,
   runtimeAPIVersion,
   srcFiles,
+  generator,
 }: ZipNodeParameters) {
   const destPath = join(destFolder, `${basename(filename, extension)}.zip`)
   const { archive, output } = startZip(destPath)
@@ -238,6 +246,11 @@ const createZipArchive = async function ({
 
     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)

packages/zip-it-and-ship-it/src/runtimes/node/utils/zip.ts

@@ -59,6 +59,7 @@ test.skipIf(platform() === 'win32')('Symlinked directories from `includedFiles`
   expect(await readDirWithType(unzippedPath)).toEqual({
     '___netlify-bootstrap.mjs': false,
     '___netlify-entry-point.mjs': false,
+    '___netlify-telemetry.mjs': false,
     '___netlify-metadata.json': false,
     'function.mjs': false,
     [join('node_modules/.pnpm/crazy-dep/package.json')]: false,
@@ -108,6 +109,7 @@ test('preserves multiple symlinks that link to the same target', async () => {
   expect(await readDirWithType(join(tmpDir, 'function'))).toEqual({
     '___netlify-bootstrap.mjs': false,
     '___netlify-entry-point.mjs': false,
+    '___netlify-telemetry.mjs': false,
     'function.mjs': false,
     ['node_modules/.pnpm/[email protected]/node_modules/is-even'.replace(/\//g, sep)]: true,
     ['node_modules/.pnpm/[email protected]/node_modules/is-even-or-odd/index.js'.replace(/\//g, sep)]: false,
@@ -151,6 +153,7 @@ test('symlinks in subdir of `includedFiles` are copied over successfully', async
   expect(await readDirWithType(join(tmpDir, 'function'))).toEqual({
     '___netlify-bootstrap.mjs': false,
     '___netlify-entry-point.mjs': false,
+    '___netlify-telemetry.mjs': false,
     'function.cjs': false,
     [join('subproject/node_modules/.bin/cli.js')]: true,
     [join('subproject/node_modules/tool/cli.js')]: false,

packages/zip-it-and-ship-it/tests/symlinked_included_files.test.ts

@@ -0,0 +1,106 @@
+import { join } from 'path'
+
+import decompress from 'decompress'
+import glob from 'fast-glob'
+import { dir as getTmpDir } from 'tmp-promise'
+import { expect, test } from 'vitest'
+
+import { ARCHIVE_FORMAT, zipFunction } from '../src/main.js'
+
+import { FIXTURES_ESM_DIR } from './helpers/main.js'
+
+test('The telemetry file should be added by default to the function bundle', async () => {
+  const { path: tmpDir } = await getTmpDir({ prefix: 'zip-it-test' })
+  const basePath = join(FIXTURES_ESM_DIR, 'v2-api')
+  const mainFile = join(basePath, 'function.js')
+
+  const result = await zipFunction(mainFile, tmpDir, {
+    archiveFormat: ARCHIVE_FORMAT.ZIP,
+    basePath,
+    config: {
+      '*': {
+        includedFiles: ['**'],
+      },
+    },
+    repositoryRoot: basePath,
+    systemLog: console.log,
+    debug: true,
+    internalSrcFolder: undefined,
+  })
+
+  const unzippedPath = join(tmpDir, 'extracted')
+
+  await decompress(result!.path, unzippedPath)
+
+  const files = await glob('**/*', { cwd: unzippedPath })
+  expect(files.sort()).toEqual([
+    '___netlify-bootstrap.mjs',
+    '___netlify-entry-point.mjs',
+    '___netlify-metadata.json',
+    '___netlify-telemetry.mjs',
+    'function.mjs',
+    'package.json',
+  ])
+})
+
+test('The telemetry file should be added if bundler is none', async () => {
+  const { path: tmpDir } = await getTmpDir({ prefix: 'zip-it-test' })
+  const basePath = join(FIXTURES_ESM_DIR, 'v2-api')
+  const mainFile = join(basePath, 'function.js')
+
+  const result = await zipFunction(mainFile, tmpDir, {
+    archiveFormat: ARCHIVE_FORMAT.NONE,
+    basePath,
+    config: {
+      '*': {
+        includedFiles: ['**'],
+      },
+    },
+    repositoryRoot: basePath,
+    systemLog: console.log,
+    debug: true,
+    internalSrcFolder: undefined,
+  })
+
+  const files = await glob('**/*', { cwd: result!.path })
+  expect(files.sort()).toEqual([
+    '___netlify-bootstrap.mjs',
+    '___netlify-entry-point.mjs',
+    '___netlify-telemetry.mjs',
+    'function.mjs',
+    'package.json',
+  ])
+})
+
+test('The telemetry file should not be added to the bundle if the feature flag is explicitly turned off', async () => {
+  const { path: tmpDir } = await getTmpDir({ prefix: 'zip-it-test' })
+  const basePath = join(FIXTURES_ESM_DIR, 'v2-api')
+  const mainFile = join(basePath, 'function.js')
+
+  const result = await zipFunction(mainFile, tmpDir, {
+    archiveFormat: ARCHIVE_FORMAT.ZIP,
+    basePath,
+    config: {
+      '*': {
+        includedFiles: ['**'],
+      },
+    },
+    featureFlags: { zisi_add_instrumentation_loader: false },
+    repositoryRoot: basePath,
+    systemLog: console.log,
+    debug: true,
+    internalSrcFolder: undefined,
+  })
+
+  const unzippedPath = join(tmpDir, 'extracted')
+  await decompress(result!.path, unzippedPath)
+
+  const files = await glob('**/*', { cwd: unzippedPath })
+  expect(files.sort()).toEqual([
+    '___netlify-bootstrap.mjs',
+    '___netlify-entry-point.mjs',
+    '___netlify-metadata.json',
+    'function.mjs',
+    'package.json',
+  ])
+})