Merge pull request #6446 from Shopify/09-26-add_slice_name_to_error_handler

Add slice_name to error handler

Author: MitchDickinson

packages/cli-kit/src/public/node/error-handler.test.ts

@@ -1,4 +1,5 @@
 import {errorHandler, cleanStackFrameFilePath, addBugsnagMetadata, sendErrorToBugsnag} from './error-handler.js'
+import * as metadata from './metadata.js'
 import {ciPlatform, cloudEnvironment, isUnitTest, macAddress} from './context/local.js'
 import {mockAndCaptureOutput} from './testing/output.js'
 import * as error from './error.js'
@@ -8,16 +9,23 @@ import {settings} from '@oclif/core'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
 
 const onNotify = vi.fn()
+let lastBugsnagEvent: {addMetadata: ReturnType<typeof vi.fn>} | undefined
 
 vi.mock('process')
 vi.mock('@bugsnag/js', () => {
   return {
     default: {
       notify: (reportedError: any, args: any, callback: any) => {
         onNotify(reportedError)
+        if (typeof args === 'function') {
+          const event = {addMetadata: vi.fn()}
+          lastBugsnagEvent = event as any
+          args(event)
+        }
         callback(null)
       },
       isStarted: () => true,
+      addOnError: vi.fn(),
     },
   }
 })
@@ -39,6 +47,7 @@ beforeEach(() => {
   vi.mocked(hashString).mockReturnValue('hashed-macaddress')
   vi.mocked(isUnitTest).mockReturnValue(true)
   onNotify.mockClear()
+  lastBugsnagEvent = undefined
   vi.mocked(settings).debug = false
   vi.mocked(isLocalEnvironment).mockReturnValue(false)
 })
@@ -207,4 +216,39 @@ describe('sends errors to Bugsnag', () => {
     expect(res.error).toEqual(toThrow)
     expect(mockOutput.debug()).toMatch('Error reporting to Bugsnag: Error: Bugsnag is down')
   })
+
+  test('attaches custom metadata with allowed slice_name when startCommand is present', async () => {
+    await metadata.addSensitiveMetadata(() => ({
+      commandStartOptions: {startTime: Date.now(), startCommand: 'app dev', startArgs: []},
+    }))
+
+    await sendErrorToBugsnag(new Error('boom'), 'unexpected_error')
+
+    expect(lastBugsnagEvent).toBeDefined()
+    expect(lastBugsnagEvent!.addMetadata).toHaveBeenCalledWith('custom', {slice_name: 'app'})
+  })
+
+  test('does not attach custom slice_name when startCommand is missing', async () => {
+    await metadata.addSensitiveMetadata(() => ({
+      commandStartOptions: {startTime: Date.now(), startCommand: undefined as unknown as string, startArgs: []},
+    }))
+
+    await sendErrorToBugsnag(new Error('boom'), 'unexpected_error')
+
+    expect(lastBugsnagEvent).toBeDefined()
+    const calls = (lastBugsnagEvent!.addMetadata as any).mock.calls as any[]
+    const customCall = calls.find(([section]: [string]) => section === 'custom')
+    expect(customCall).toBeUndefined()
+  })
+
+  test('defaults slice_name to cli when first word not allowed', async () => {
+    await metadata.addSensitiveMetadata(() => ({
+      commandStartOptions: {startTime: Date.now(), startCommand: 'version', startArgs: []},
+    }))
+
+    await sendErrorToBugsnag(new Error('boom'), 'unexpected_error')
+
+    expect(lastBugsnagEvent).toBeDefined()
+    expect(lastBugsnagEvent!.addMetadata).toHaveBeenCalledWith('custom', {slice_name: 'cli'})
+  })
 })

packages/cli-kit/src/public/node/error-handler.ts

@@ -21,6 +21,10 @@ import StackTracey from 'stacktracey'
 import Bugsnag, {Event} from '@bugsnag/js'
 import {realpath} from 'fs/promises'
 
+// Allowed slice names for error analytics grouping.
+// Hardcoded list per product slices to keep analytics consistent.
+const ALLOWED_SLICE_NAMES = new Set<string>(['app', 'theme', 'hydrogen', 'store'])
+
 export async function errorHandler(
   error: Error & {exitCode?: number | undefined},
   config?: Interfaces.Config,
@@ -126,6 +130,14 @@ export async function sendErrorToBugsnag(
         const eventHandler = (event: Event) => {
           event.severity = 'error'
           event.unhandled = unhandled
+          // Attach command metadata so we know which CLI command triggered the error
+          const {commandStartOptions} = metadata.getAllSensitiveMetadata()
+          const {startCommand} = commandStartOptions ?? {}
+          if (startCommand) {
+            const firstWord = startCommand.trim().split(/\s+/)[0] ?? 'cli'
+            const sliceName = ALLOWED_SLICE_NAMES.has(firstWord) ? firstWord : 'cli'
+            event.addMetadata('custom', {slice_name: sliceName})
+          }
         }
         const errorHandler = (error: unknown) => {
           if (error) {