feat: ignore extension exceptions (#2089)

Author: daibhin

.changeset/tame-doors-design.md

@@ -0,0 +1,5 @@
+---
+'posthog-js': minor
+---
+
+feat: exclude exceptions autocaptured by extensions

packages/browser/src/__tests__/__snapshots__/config-snapshot.test.ts.snap

@@ -324,6 +324,11 @@ exports[`config snapshot for PostHogConfig 1`] = `
     ]
   },
   \\"error_tracking\\": {
+    \\"captureExtensionExceptions\\": [
+      \\"undefined\\",
+      \\"false\\",
+      \\"true\\"
+    ],
     \\"__exceptionRateLimiterRefillRate\\": [
       \\"undefined\\",
       \\"number\\"

packages/browser/src/__tests__/posthog-exceptions.test.ts

@@ -1,13 +1,13 @@
 import { ERROR_TRACKING_SUPPRESSION_RULES } from '../constants'
-import { PostHog } from '../posthog-core'
+import { defaultConfig, PostHog } from '../posthog-core'
 import { PostHogExceptions } from '../posthog-exceptions'
 import { PostHogPersistence } from '../posthog-persistence'
 import {
-    FlagsResponse,
     ErrorTrackingSuppressionRule,
     ErrorTrackingSuppressionRuleValue,
     PostHogConfig,
     Property,
+    RemoteConfig,
 } from '../types'
 
 function createSuppressionRule(
@@ -37,7 +37,7 @@ describe('PostHogExceptions', () => {
     let config: PostHogConfig
 
     beforeEach(() => {
-        config = { persistence: 'memory' } as unknown as PostHogConfig
+        config = { ...defaultConfig(), persistence: 'memory' }
 
         const postHogPersistence = new PostHogPersistence(config)
         postHogPersistence.clear()
@@ -67,8 +67,8 @@ describe('PostHogExceptions', () => {
     describe('onRemoteConfig', () => {
         it('persists the suppression rules', () => {
             const suppressionRule = createSuppressionRule()
-            const flagsResponse: Partial<FlagsResponse> = { errorTracking: { suppressionRules: [suppressionRule] } }
-            exceptions.onRemoteConfig(flagsResponse as FlagsResponse)
+            const remoteResponse: Partial<RemoteConfig> = { errorTracking: { suppressionRules: [suppressionRule] } }
+            exceptions.onRemoteConfig(remoteResponse as RemoteConfig)
             expect(exceptions['_suppressionRules']).toEqual([suppressionRule])
         })
     })
@@ -84,21 +84,21 @@ describe('PostHogExceptions', () => {
             ['GenericError', 'This is a message that contains a ReactMinified error'],
         ])('drops the event if a suppression rule matches', (type, value) => {
             const suppressionRule = createSuppressionRule('OR')
-            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as FlagsResponse)
+            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as RemoteConfig)
             exceptions.sendExceptionEvent({ $exception_list: [{ type, value }] })
             expect(captureMock).not.toBeCalled()
         })
 
         it('captures an exception if no $exception_list property exists', () => {
             const suppressionRule = createSuppressionRule('AND')
-            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as FlagsResponse)
+            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as RemoteConfig)
             exceptions.sendExceptionEvent({ custom_property: true })
             expect(captureMock).toBeCalled()
         })
 
         it('captures an exception if all rule conditions do not match', () => {
             const suppressionRule = createSuppressionRule('AND')
-            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as FlagsResponse)
+            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as RemoteConfig)
             exceptions.sendExceptionEvent({ $exception_list: [{ type: 'TypeError', value: 'This is a type error' }] })
             expect(captureMock).toBeCalled()
         })
@@ -112,9 +112,24 @@ describe('PostHogExceptions', () => {
                     type: 'error_tracking_issue_property',
                 },
             ])
-            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as FlagsResponse)
+            exceptions.onRemoteConfig({ errorTracking: { suppressionRules: [suppressionRule] } } as RemoteConfig)
             exceptions.sendExceptionEvent({ $exception_list: [{ type: 'TypeError', value: 'This is a type error' }] })
             expect(captureMock).toBeCalled()
         })
+
+        it('does not capture exceptions with frames from extensions by default', () => {
+            const frame = { filename: 'chrome-extension://', platform: 'javascript:web' }
+            const exception = { stacktrace: { frames: [frame], type: 'raw' } }
+            exceptions.sendExceptionEvent({ $exception_list: [exception] })
+            expect(captureMock).not.toBeCalledWith('$exception', { $exception_list: [exception] }, expect.anything())
+        })
+
+        it('captures extension exceptions when enabled', () => {
+            exceptions.onRemoteConfig({ errorTracking: { captureExtensionExceptions: true } } as RemoteConfig)
+            const frame = { filename: 'chrome-extension://', platform: 'javascript:web' }
+            const exception = { stacktrace: { frames: [frame], type: 'raw' } }
+            exceptions.sendExceptionEvent({ $exception_list: [exception] })
+            expect(captureMock).toBeCalledWith('$exception', { $exception_list: [exception] }, expect.anything())
+        })
     })
 })

packages/browser/src/constants.ts

@@ -14,6 +14,7 @@ export const AUTOCAPTURE_DISABLED_SERVER_SIDE = '$autocapture_disabled_server_si
 export const HEATMAPS_ENABLED_SERVER_SIDE = '$heatmaps_enabled_server_side'
 export const EXCEPTION_CAPTURE_ENABLED_SERVER_SIDE = '$exception_capture_enabled_server_side'
 export const ERROR_TRACKING_SUPPRESSION_RULES = '$error_tracking_suppression_rules'
+export const ERROR_TRACKING_CAPTURE_EXTENSION_EXCEPTIONS = '$error_tracking_capture_extension_exceptions'
 export const WEB_VITALS_ENABLED_SERVER_SIDE = '$web_vitals_enabled_server_side'
 export const DEAD_CLICKS_ENABLED_SERVER_SIDE = '$dead_clicks_enabled_server_side'
 export const WEB_VITALS_ALLOWED_METRICS = '$web_vitals_allowed_metrics'

packages/browser/src/posthog-exceptions.ts

@@ -1,4 +1,5 @@
-import { ERROR_TRACKING_SUPPRESSION_RULES } from './constants'
+import { ERROR_TRACKING_CAPTURE_EXTENSION_EXCEPTIONS, ERROR_TRACKING_SUPPRESSION_RULES } from './constants'
+import { Exception } from './extensions/exception-autocapture/error-conversion'
 import { PostHog } from './posthog-core'
 import { CaptureResult, ErrorTrackingSuppressionRule, Properties, RemoteConfig } from './types'
 import { createLogger } from './utils/logger'
@@ -18,23 +19,36 @@ export class PostHogExceptions {
 
     onRemoteConfig(response: RemoteConfig) {
         const suppressionRules = response.errorTracking?.suppressionRules ?? []
+        const captureExtensionExceptions = response.errorTracking?.captureExtensionExceptions
 
         // store this in-memory in case persistence is disabled
         this._suppressionRules = suppressionRules
 
         if (this._instance.persistence) {
             this._instance.persistence.register({
                 [ERROR_TRACKING_SUPPRESSION_RULES]: this._suppressionRules,
+                [ERROR_TRACKING_CAPTURE_EXTENSION_EXCEPTIONS]: captureExtensionExceptions,
             })
         }
     }
 
+    private get _captureExtensionExceptions() {
+        const enabled_server_side = !!this._instance.get_property(ERROR_TRACKING_CAPTURE_EXTENSION_EXCEPTIONS)
+        const enabled_client_side = this._instance.config.error_tracking.captureExtensionExceptions
+        return enabled_client_side ?? enabled_server_side ?? false
+    }
+
     sendExceptionEvent(properties: Properties): CaptureResult | undefined {
         if (this._matchesSuppressionRule(properties)) {
             logger.info('Skipping exception capture because a suppression rule matched')
             return
         }
 
+        if (!this._captureExtensionExceptions && this._isExtensionException(properties)) {
+            logger.info('Skipping exception capture because it was thrown by an extension')
+            return
+        }
+
         return this._instance.capture('$exception', properties, {
             _noTruncate: true,
             _batchKey: 'exceptionEvent',
@@ -74,4 +88,15 @@ export class PostHogExceptions {
             return rule.type === 'OR' ? results.some(Boolean) : results.every(Boolean)
         })
     }
+
+    private _isExtensionException(properties: Properties): boolean {
+        const exceptionList = properties.$exception_list
+
+        if (!exceptionList || !isArray(exceptionList)) {
+            return false
+        }
+
+        const frames = (exceptionList as Exception[]).flatMap((e) => e.stacktrace?.frames ?? [])
+        return frames.some((f) => f.filename && f.filename.startsWith('chrome-extension://'))
+    }
 }

packages/browser/src/types.ts

@@ -1010,6 +1010,12 @@ export interface PostHogConfig {
 }
 
 export interface ErrorTrackingOptions {
+    /**
+     * Decide whether exceptions thrown by browser extensions should be captured
+     *
+     * @default false
+     */
+    captureExtensionExceptions?: boolean
     /**
      * ADVANCED: alters the refill rate for the token bucket mutation throttling
      * Normally only altered alongside posthog support guidance.
@@ -1385,6 +1391,7 @@ export interface RemoteConfig {
      */
     errorTracking?: {
         autocaptureExceptions?: boolean
+        captureExtensionExceptions?: boolean
         suppressionRules?: ErrorTrackingSuppressionRule[]
     }
 

packages/browser/terser-mangled-names.json

@@ -31,6 +31,7 @@
         "_capture",
         "_captureDeadClick",
         "_captureEvent",
+        "_captureExtensionExceptions",
         "_captureInitialPageview",
         "_capturePageview",
         "_captureSnapshot",
@@ -124,6 +125,7 @@
         "_internalFlagCheckSatisfied",
         "_isConsoleLogCaptureEnabled",
         "_isDisabledServerSide",
+        "_isExtensionException",
         "_isFetchingSurveys",
         "_isIdle",
         "_isInitializingSurveys",