refactor(sourcemaps): consolidate debug ID handling into debugId module

- addDebugIdToPayloads sets each payload's debugId and gates the abort
- fold missing-debug-ID skip into validatePayload as an InvalidPayload
- move debug-ID messages into renderer; keep extractDebugId pure
- add debugId.test.ts coverage and partial-debug-id fixture

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: amortemousque

packages/base/src/commands/sourcemaps/__tests__/debugId.test.ts

@@ -1,24 +1,26 @@
 import fs from 'fs'
 
-import type {CommandContext} from '@datadog/datadog-ci-base'
-
-import {createMockContext} from '@datadog/datadog-ci-base/helpers/__tests__/testing-tools'
-
-import {extractDebugId} from '../debugId'
+import {addDebugIdToPayloads, extractDebugId} from '../debugId'
+import {Sourcemap} from '../interfaces'
 
 const DEBUG_ID = '2f1d7f52-4e1b-4f7c-8c0d-2f4a5f6d8e91'
 
-const mockFileContent = (content: string) => {
-  jest.spyOn(fs, 'readFileSync').mockReturnValueOnce(content)
-}
+const makeSourcemap = (minifiedFilePath: string) =>
+  new Sourcemap(minifiedFilePath, `https://static.com/${minifiedFilePath}`, `${minifiedFilePath}.map`, minifiedFilePath)
 
-describe('extractDebugId', () => {
-  let context: CommandContext
+// Mocks fs.readFileSync to return the given content keyed by minified file path.
+const mockFilesByPath = (contentByPath: Record<string, string>) => {
+  jest.spyOn(fs, 'readFileSync').mockImplementation((path: unknown) => {
+    const content = contentByPath[path as string]
+    if (content === undefined) {
+      throw new Error(`ENOENT: ${String(path)}`)
+    }
 
-  beforeEach(() => {
-    context = createMockContext() as CommandContext
+    return content
   })
+}
 
+describe('extractDebugId', () => {
   afterEach(() => {
     jest.restoreAllMocks()
   })
@@ -34,25 +36,49 @@ describe('extractDebugId', () => {
       [`var x=1;({"ddDebugId":"${DEBUG_ID}"});var y=2;`],
       [`var x=1;\n{"ddDebugId": "${DEBUG_ID}"}\nvar y=2;`],
     ])('%s', (content: string) => {
-      mockFileContent(content)
-      expect(extractDebugId('bundle.js', context)).toBe(DEBUG_ID)
-      expect(context.stderr.toString()).toBe('')
+      jest.spyOn(fs, 'readFileSync').mockReturnValueOnce(content)
+      expect(extractDebugId('bundle.js')).toBe(DEBUG_ID)
     })
   })
 
   describe('missing or unreadable', () => {
-    test('returns undefined and writes to stderr when snippet is absent', () => {
-      mockFileContent('var x = 1; console.log("hello");')
-      expect(extractDebugId('bundle.js', context)).toBeUndefined()
-      expect(context.stderr.toString()).toContain('Debug ID not found')
+    test('returns undefined when snippet is absent', () => {
+      jest.spyOn(fs, 'readFileSync').mockReturnValueOnce('var x = 1; console.log("hello");')
+      expect(extractDebugId('bundle.js')).toBeUndefined()
     })
 
-    test('returns undefined and writes to stderr when file cannot be read', () => {
+    test('returns undefined when file cannot be read', () => {
       jest.spyOn(fs, 'readFileSync').mockImplementationOnce(() => {
         throw new Error('ENOENT: no such file or directory')
       })
-      expect(extractDebugId('nonexistent.js', context)).toBeUndefined()
-      expect(context.stderr.toString()).toContain('Cannot extract Debug ID')
+      expect(extractDebugId('nonexistent.js')).toBeUndefined()
+    })
+  })
+})
+
+describe('addDebugIdToPayloads', () => {
+  afterEach(() => {
+    jest.restoreAllMocks()
+  })
+
+  test('stores each debug ID on its payload and returns true when any is found', () => {
+    mockFilesByPath({
+      'a.min.js': `{"ddDebugId":"${DEBUG_ID}"}`,
+      'b.min.js': 'var x = 1;',
     })
+    const withId = makeSourcemap('a.min.js')
+    const withoutId = makeSourcemap('b.min.js')
+
+    expect(addDebugIdToPayloads([withId, withoutId])).toBe(true)
+    expect(withId.debugId).toBe(DEBUG_ID)
+    expect(withoutId.debugId).toBeUndefined()
+  })
+
+  test('returns false when no payload has a debug ID', () => {
+    mockFilesByPath({'a.min.js': 'var x = 1;', 'b.min.js': 'var y = 2;'})
+    const payloads = [makeSourcemap('a.min.js'), makeSourcemap('b.min.js')]
+
+    expect(addDebugIdToPayloads(payloads)).toBe(false)
+    expect(payloads.every((p) => p.debugId === undefined)).toBe(true)
   })
 })

packages/base/src/commands/sourcemaps/__tests__/fixtures/bundle-with-partial-debug-id/a.min.js

@@ -301,6 +301,25 @@ describe('execute', () => {
     )
   })
 
+  test('debug id missing in all files aborts with exit 1', async () => {
+    const {context, code} = await runCLIWithDebugId(['./src/commands/sourcemaps/__tests__/fixtures/basic'])
+    expect(code).toBe(1)
+    expect(context.stderr.toString()).toContain('No debug ID found in any minified file')
+    expect(context.stdout.toString()).not.toContain('[DRYRUN] Uploading sourcemap')
+  })
+
+  test('debug id missing in some files skips only those files', async () => {
+    const {context, code} = await runCLIWithDebugId([
+      './src/commands/sourcemaps/__tests__/fixtures/bundle-with-partial-debug-id',
+    ])
+    expect(code).toBe(0)
+    const stdout = context.stdout.toString()
+    expect(stdout).toContain('[DRYRUN] Uploading sourcemap')
+    expect(stdout).toContain('a.min.js.map')
+    expect(stdout).toContain('because no debug ID was found')
+    expect(stdout).toContain('b.min.js.map')
+  })
+
   test('relative path with double dots', async () => {
     const {context, code} = await runCLI(['./src/commands/sourcemaps/__tests__/doesnotexist/../fixtures/basic'])
     const output = context.stdout.toString().split('\n')

packages/base/src/commands/sourcemaps/__tests__/fixtures/bundle-with-partial-debug-id/a.min.js.map

@@ -1,21 +1,32 @@
 import fs from 'fs'
 
-import type {CommandContext} from '@datadog/datadog-ci-base'
+import type {Sourcemap} from './interfaces'
 
 const DD_DEBUG_ID_REGEX = /["']ddDebugId["']\s*:\s*["']([^"']+)["']/
 
-export const extractDebugId = (filePath: string, context: CommandContext): string | undefined => {
+export const extractDebugId = (filePath: string): string | undefined => {
   try {
     const source = fs.readFileSync(filePath, 'utf-8')
-    const match = source.match(DD_DEBUG_ID_REGEX)
-    if (match) {
-      return match[1]
+
+    return source.match(DD_DEBUG_ID_REGEX)?.[1]
+  } catch {
+    // Unreadable file: treated as having no debug ID.
+    return undefined
+  }
+}
+
+/**
+ * Adds the debug ID extracted from each payload's minified file onto the
+ * payload. Returns true if at least one payload has a debug ID.
+ */
+export const addDebugIdToPayloads = (payloads: Sourcemap[]): boolean => {
+  let hasAnyDebugId = false
+  for (const payload of payloads) {
+    payload.debugId = extractDebugId(payload.minifiedFilePath)
+    if (payload.debugId !== undefined) {
+      hasAnyDebugId = true
     }
-    context.stderr.write(`Debug ID not found in ${filePath}\n`)
-  } catch (err) {
-    const errorMsg = err instanceof Error ? err.message : String(err)
-    context.stderr.write(`Cannot extract Debug ID from ${filePath}: ${errorMsg}\n`)
   }
 
-  return undefined
+  return hasAnyDebugId
 }

packages/base/src/commands/sourcemaps/__tests__/fixtures/bundle-with-partial-debug-id/b.min.js

@@ -2,6 +2,7 @@ import type {CommandContext} from '@datadog/datadog-ci-base'
 import type {MultipartPayload, MultipartValue} from '@datadog/datadog-ci-base/helpers/upload'
 
 export class Sourcemap {
+  public debugId?: string
   public gitData?: GitData
   public minifiedFilePath: string
   public minifiedPathPrefix?: string
@@ -49,21 +50,15 @@ export class Sourcemap {
     }
   }
 
-  private getMetadataPayload({
-    cliVersion,
-    service,
-    version,
-    projectPath,
-    debugId,
-  }: SourcemapUploadOptions): MultipartValue {
+  private getMetadataPayload({cliVersion, service, version, projectPath}: SourcemapUploadOptions): MultipartValue {
     const metadata: {[k: string]: any} = {
       cli_version: cliVersion,
       project_path: projectPath,
       type: 'js_sourcemap',
       service,
       version,
       minified_url: this.minifiedUrl,
-      debug_id: debugId,
+      debug_id: this.debugId,
     }
 
     if (this.gitData !== undefined) {
@@ -85,7 +80,6 @@ export class Sourcemap {
 export interface SourcemapUploadOptions {
   cliVersion: string
   context: CommandContext
-  debugId?: string
   projectPath?: string
   service?: string
   version?: string

packages/base/src/commands/sourcemaps/__tests__/fixtures/bundle-with-partial-debug-id/b.min.js.map

@@ -38,6 +38,8 @@ export const renderFailedUpload = (sourcemap: Sourcemap, errorMessage: string) =
   return chalk.red(`${ICONS.FAILED} Failed upload sourcemap for ${sourcemapPathBold}: ${errorMessage}\n`)
 }
 
+export const renderNoDebugIdFound = () => 'No debug ID found in any minified file. Aborting upload.\n'
+
 export const renderRetriedUpload = (payload: Sourcemap, errorMessage: string, attempt: number) => {
   const sourcemapPathBold = `[${chalk.bold.dim(payload.sourcemapPath)}]`
 
@@ -140,8 +142,8 @@ export const renderCommandInfo = (
   return fullStr
 }
 
-export const renderUpload = (sourcemap: Sourcemap, debugId?: string): string => {
-  const debugIdSuffix = debugId ? ` (debug ID: ${debugId})` : ''
+export const renderUpload = (sourcemap: Sourcemap): string => {
+  const debugIdSuffix = sourcemap.debugId ? ` (debug ID: ${sourcemap.debugId})` : ''
 
   return `Uploading sourcemap ${sourcemap.sourcemapPath} for JS file available at ${sourcemap.minifiedUrl}${debugIdSuffix}\n`
 }

packages/base/src/commands/sourcemaps/__tests__/upload.test.ts

@@ -32,7 +32,7 @@ import {getRequestBuilder, buildPath} from '@datadog/datadog-ci-base/helpers/uti
 import * as validation from '@datadog/datadog-ci-base/helpers/validation'
 import {cliVersion} from '@datadog/datadog-ci-base/version'
 
-import {extractDebugId} from './debugId'
+import {addDebugIdToPayloads} from './debugId'
 import {Sourcemap} from './interfaces'
 import {
   renderCommandInfo,
@@ -42,6 +42,7 @@ import {
   renderGitDataNotAttachedWarning,
   renderGitWarning,
   renderInvalidPrefix,
+  renderNoDebugIdFound,
   renderRetriedUpload,
   renderSourcesNotFoundWarning,
   renderSuccessfulCommand,
@@ -138,6 +139,13 @@ export class SourcemapsUploadCommand extends BaseCommand {
     const useGit = this.disableGit === undefined || !this.disableGit
     const initialTime = Date.now()
     const payloads = await this.getPayloadsToUpload(useGit)
+
+    if (this.debugId && !addDebugIdToPayloads(payloads)) {
+      this.context.stderr.write(renderNoDebugIdFound())
+
+      return 1
+    }
+
     const requestBuilder = this.getRequestBuilder()
     const uploadMultipart = this.upload(requestBuilder, metricsLogger, apiKeyValidator)
     try {
@@ -423,7 +431,7 @@ export class SourcemapsUploadCommand extends BaseCommand {
   ): (sourcemap: Sourcemap) => Promise<UploadStatus> {
     return async (sourcemap: Sourcemap) => {
       try {
-        validatePayload(sourcemap, this.context.stdout)
+        validatePayload(sourcemap, this.context.stdout, this.debugId)
       } catch (error) {
         if (error instanceof InvalidPayload) {
           this.context.stdout.write(renderFailedUpload(sourcemap, error.message))
@@ -441,17 +449,15 @@ export class SourcemapsUploadCommand extends BaseCommand {
         return UploadStatus.Skipped
       }
 
-      const debugId = this.debugId ? extractDebugId(sourcemap.minifiedFilePath, this.context) : undefined
       const payload = sourcemap.asMultipartPayload({
         cliVersion: this.cliVersion,
         service: this.service,
         version: this.releaseVersion,
         projectPath: this.projectPath,
-        debugId,
         context: this.context,
       })
       if (this.dryRun) {
-        this.context.stdout.write(`[DRYRUN] ${renderUpload(sourcemap, debugId)}`)
+        this.context.stdout.write(`[DRYRUN] ${renderUpload(sourcemap)}`)
 
         return UploadStatus.Success
       }
@@ -470,7 +476,7 @@ export class SourcemapsUploadCommand extends BaseCommand {
           if (this.quiet) {
             return
           }
-          this.context.stdout.write(renderUpload(sourcemap, debugId))
+          this.context.stdout.write(renderUpload(sourcemap))
         },
         retries: 5,
         useGzip: true,