don't report errors when running against non-production services

Author: craigmichaelmartin

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

@@ -3,6 +3,7 @@ import {ciPlatform, cloudEnvironment, isUnitTest, macAddress} from './context/lo
 import {mockAndCaptureOutput} from './testing/output.js'
 import * as error from './error.js'
 import {hashString} from '../../public/node/crypto.js'
+import {settings} from '@oclif/core'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
 
 const onNotify = vi.fn()
@@ -22,13 +23,22 @@ vi.mock('@bugsnag/js', () => {
 vi.mock('./cli.js')
 vi.mock('./context/local.js')
 vi.mock('../../public/node/crypto.js')
+vi.mock('@oclif/core', () => ({
+  settings: {
+    debug: false,
+  },
+  Interfaces: {},
+}))
 
 beforeEach(() => {
   vi.mocked(ciPlatform).mockReturnValue({isCI: true, name: 'vitest', metadata: {}})
   vi.mocked(macAddress).mockResolvedValue('macAddress')
   vi.mocked(cloudEnvironment).mockReturnValue({platform: 'localhost', editor: false})
   vi.mocked(hashString).mockReturnValue('hashed-macaddress')
   vi.mocked(isUnitTest).mockReturnValue(true)
+  onNotify.mockClear()
+  delete process.env.SHOPIFY_SERVICE_ENV
+  vi.mocked(settings).debug = false
 })
 
 describe('errorHandler', async () => {
@@ -108,7 +118,43 @@ describe('bugsnag metadata', () => {
   })
 })
 
-describe('send to Bugsnag', () => {
+describe('skips sending errors to Bugsnag', () => {
+  test('when SHOPIFY_SERVICE_ENV is local', async () => {
+    // Given
+    process.env.SHOPIFY_SERVICE_ENV = 'local'
+    const mockOutput = mockAndCaptureOutput()
+    const toThrow = new Error('In test')
+
+    // When
+    const res = await sendErrorToBugsnag(toThrow, 'unexpected_error')
+
+    // Then
+    expect(res.reported).toEqual(false)
+    expect(res.error).toEqual(toThrow)
+    expect(res.unhandled).toBeUndefined()
+    expect(onNotify).not.toHaveBeenCalled()
+    expect(mockOutput.debug()).toMatch('Skipping Bugsnag report')
+  })
+
+  test('when settings.debug is true', async () => {
+    // Given
+    vi.mocked(settings).debug = true
+    const mockOutput = mockAndCaptureOutput()
+    const toThrow = new Error('In test')
+
+    // When
+    const res = await sendErrorToBugsnag(toThrow, 'unexpected_error')
+
+    // Then
+    expect(res.reported).toEqual(false)
+    expect(res.error).toEqual(toThrow)
+    expect(res.unhandled).toBeUndefined()
+    expect(onNotify).not.toHaveBeenCalled()
+    expect(mockOutput.debug()).toMatch('Skipping Bugsnag report')
+  })
+})
+
+describe('sends errors to Bugsnag', () => {
   test('processes Error instances as unhandled', async () => {
     const toThrow = new Error('In test')
     const res = await sendErrorToBugsnag(toThrow, 'unexpected_error')

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

@@ -63,7 +63,7 @@ export async function sendErrorToBugsnag(
   exitMode: Omit<CommandExitMode, 'ok'>,
 ): Promise<{reported: false; error: unknown; unhandled: unknown} | {error: Error; reported: true; unhandled: boolean}> {
   try {
-    if (settings.debug) {
+    if (process.env.SHOPIFY_SERVICE_ENV === 'local' || settings.debug) {
       outputDebug(`Skipping Bugsnag report`)
       return {reported: false, error, unhandled: undefined}
     }