🔊 Add Url Extension Telemetry (#3768)

Co-authored-by: Thomas Lebeau <[email protected]>

Author: rgaignault

packages/core/src/domain/allowedTrackingOrigins.ts

@@ -1,7 +1,7 @@
 import { display } from '../tools/display'
 import { matchList } from '../tools/matchOption'
 import type { InitConfiguration } from './configuration'
-import { isUnsupportedExtensionEnvironment } from './extension/extensionUtils'
+import { extractExtensionUrlFromStack, isUnsupportedExtensionEnvironment } from './extension/extensionUtils'
 import { addTelemetryDebug } from './telemetry'
 
 export const WARN_DOES_NOT_HAVE_ALLOWED_TRACKING_ORIGIN =
@@ -11,13 +11,17 @@ export const ERROR_NOT_ALLOWED_TRACKING_ORIGIN = 'SDK initialized on a non-allow
 export function isAllowedTrackingOrigins(
   configuration: InitConfiguration,
   windowOrigin = typeof location !== 'undefined' ? location.origin : '',
-  errorStack?: string
+  errorStack = new Error().stack
 ): boolean {
   const allowedTrackingOrigins = configuration.allowedTrackingOrigins
   if (!allowedTrackingOrigins) {
     if (isUnsupportedExtensionEnvironment(windowOrigin, errorStack)) {
       display.warn(WARN_DOES_NOT_HAVE_ALLOWED_TRACKING_ORIGIN)
-      addTelemetryDebug(WARN_DOES_NOT_HAVE_ALLOWED_TRACKING_ORIGIN)
+
+      const extensionUrl = extractExtensionUrlFromStack(errorStack)
+      addTelemetryDebug(WARN_DOES_NOT_HAVE_ALLOWED_TRACKING_ORIGIN, {
+        extensionUrl: extensionUrl || 'unknown',
+      })
       // TODO(next major): make `allowedTrackingOrigins` required in unsupported extension environments
     }
     return true

packages/core/src/domain/extension/extensionUtils.spec.ts

@@ -1,4 +1,9 @@
-import { containsExtensionUrl, EXTENSION_PREFIXES, isUnsupportedExtensionEnvironment } from './extensionUtils'
+import {
+  containsExtensionUrl,
+  EXTENSION_PREFIXES,
+  extractExtensionUrlFromStack,
+  isUnsupportedExtensionEnvironment,
+} from './extensionUtils'
 
 describe('containsExtensionUrl', () => {
   it('should return true if string contains an extension URL', () => {
@@ -13,7 +18,7 @@ describe('containsExtensionUrl', () => {
   })
 })
 
-describe('testIsUnsupportedExtensionEnvironment', () => {
+describe('isUnsupportedExtensionEnvironment', () => {
   it('should return true when window location is a regular URL and error stack contains extension URL', () => {
     expect(
       isUnsupportedExtensionEnvironment('https://example.com', 'Error: at chrome-extension://abcdefg/content.js:10:15')
@@ -46,19 +51,28 @@ describe('testIsUnsupportedExtensionEnvironment', () => {
     })
   })
 
-  it('should handle case when Error.stack is undefined', () => {
-    const mockError = new Error()
-    mockError.stack = undefined
-    spyOn(window, 'Error').and.returnValue(mockError)
-
+  it('should handle case when stack trace is undefined', () => {
     expect(isUnsupportedExtensionEnvironment('https://example.com')).toBe(false)
   })
 
   it('should handle extension stack trace', () => {
-    const mockError = new Error()
-    mockError.stack = 'Error: at chrome-extension://abcdefg/content.js:10:15'
-    spyOn(window, 'Error').and.returnValue(mockError)
+    expect(
+      isUnsupportedExtensionEnvironment('https://example.com', 'Error: at chrome-extension://abcdefg/content.js:10:15')
+    ).toBe(true)
+  })
+})
+
+describe('extractExtensionUrlFromStack', () => {
+  it('should extract extension URL from stack trace', () => {
+    const stack = `Error
+    at foo (<anonymous>:549:44)
+    at bar (<anonymous>:701:91)
+    at e.init (chrome-extension://boceobohkgenpcpogecpjlnmnfbdigda/content-script-main.js:1:1009)`
+    expect(extractExtensionUrlFromStack(stack)).toBe('chrome-extension://boceobohkgenpcpogecpjlnmnfbdigda')
+  })
 
-    expect(isUnsupportedExtensionEnvironment('https://example.com')).toBe(true)
+  it('should return undefined when no extension URL found', () => {
+    const stack = 'Error at https://example.com/script.js:10:15'
+    expect(extractExtensionUrlFromStack(stack)).toBeUndefined()
   })
 })

packages/core/src/domain/extension/extensionUtils.ts

@@ -11,8 +11,17 @@ export function containsExtensionUrl(str: string): boolean {
  * @param stack - The error stack to check for extension URLs
  * @returns true if running in an unsupported browser extension environment
  */
-export function isUnsupportedExtensionEnvironment(windowLocation: string, stack = new Error().stack) {
+export function isUnsupportedExtensionEnvironment(windowLocation: string, stack: string = '') {
   // If we're on a regular web page but the error stack shows extension URLs,
   // then an extension is injecting RUM.
-  return !containsExtensionUrl(windowLocation) && containsExtensionUrl(stack || '')
+  return !containsExtensionUrl(windowLocation) && containsExtensionUrl(stack)
+}
+
+export function extractExtensionUrlFromStack(stack: string = ''): string | undefined {
+  for (const prefix of EXTENSION_PREFIXES) {
+    const match = stack.match(new RegExp(`${prefix}[^/]+`))
+    if (match) {
+      return match[0]
+    }
+  }
 }