[RUM-9181] ✨ Service Worker support for Logs (#3769)

mormubis · web-flow · commit e1d151a76885 · 2025-09-19T09:15:35.000Z
* ✨ avoid a ton of window * 🐛 last 2 windows in logs * ✨ create global object * 🐛 types of pristineWindow * 🐛 microtask types * 🐛 simplify condition * 🐛 remove ts-expect-error * ♻️ revert sandbox * ✨ e2e test for worker logs * 🐛 create global object type * 🐛 linter warnings * 🐛 improve e2e test * 🐛 fix built-in type in non-worker env * 🐛 missing exported symbol in test framework * 🐛 firefox skip service worker test * 🐛 type module is not compatible with importScripts in chromium * 🐛 apply local storage automatically on sw env * 🐛 types? * 🐛 remove test based on global * 🐛 wrong url in e2e * 🐛 test hacky wa * 🐛 test another hacky wa * 🐛 local url in bs * 🐛 typo in local url * ♻️ revert base url * 👷 test intake registry * 👷 a final test * 👷 ignore it * 👷 test with localhost * 👷 revert most of the server changes * 🐛 sw running on localhost * 🐛 pr-feedback: early return to ignore synthetics * ✨ pr-feedback: tools for testing service workers in e2e * 🐛 pr-feedback: undefined context for service worker * 🐛 pr-feedback: rename global object * 🐛 multiple imports * 🐛 optional chaining now in common context * 🐛 single sw in mocks * 🐛 forward console in worker * 🐛 typo in the options * 🐛 remove log name * 🐛 pr-feedback: improve the setup * 🐛 pr-feedback: remove unused condition * 🐛 pr-feedback: remove unused variable with fallback * 🐛 pr-feedback: check logs messages * 🐛 pr-feedback: remove localhost bridge * 👷 pr-feedback: add comments * ✨ mock session strategy * Revert "✨ mock session strategy" This reverts commit b8e5c11. * ♻️ pr-feedback: replace none storage with session manager stub * 🐛 pr-feedback: fix condition (thanks @BeltranBulbarellaDD) * 🐛 pr-feedback: ignore safari in second sw logs test * 🐛 pr-feedback: change name * 🐛 pr-feedback: fix types * 🐛 fix new event type * 🐛 fixes due to new event type * 🐛 pr-feedback: add comments * 🐛 pr-feedback: more docs * test putting back the address * 🐛 add extra var * 🐛 pr-feedback: remove listening port * 🐛 remove transition changes * 🐛 schema * 🐛 more removing transition * 🐛 pr-feedback: extract strategy condition * 🐛 pr-feedback * 🐛 pr-feedback: remove change in cookies authorized
diff --git a/packages/core/src/browser/fetchObservable.ts b/packages/core/src/browser/fetchObservable.ts
@@ -5,6 +5,8 @@ import { Observable } from '../tools/observable'
 import type { ClocksState } from '../tools/utils/timeUtils'
 import { clocksNow } from '../tools/utils/timeUtils'
 import { normalizeUrl } from '../tools/utils/urlPolyfill'
+import type { GlobalObject } from '../tools/globalObject'
+import { globalObject } from '../tools/globalObject'
 
 interface FetchContextBase {
   method: string
@@ -45,11 +47,11 @@ export function resetFetchObservable() {
 
 function createFetchObservable() {
   return new Observable<FetchContext>((observable) => {
-    if (!window.fetch) {
+    if (!globalObject.fetch) {
       return
     }
 
-    const { stop } = instrumentMethod(window, 'fetch', (call) => beforeSend(call, observable), {
+    const { stop } = instrumentMethod(globalObject, 'fetch', (call) => beforeSend(call, observable), {
       computeHandlingStack: true,
     })
 
@@ -58,7 +60,7 @@ function createFetchObservable() {
 }
 
 function beforeSend(
-  { parameters, onPostCall, handlingStack }: InstrumentedMethodCall<Window, 'fetch'>,
+  { parameters, onPostCall, handlingStack }: InstrumentedMethodCall<GlobalObject, 'fetch'>,
   observable: Observable<FetchContext>
 ) {
   const [input, init] = parameters
diff --git a/packages/core/src/domain/configuration/configuration.ts b/packages/core/src/domain/configuration/configuration.ts
@@ -13,6 +13,7 @@ import type { SessionPersistence } from '../session/sessionConstants'
 import type { MatchOption } from '../../tools/matchOption'
 import { isAllowedTrackingOrigins } from '../allowedTrackingOrigins'
 import type { Site } from '../intakeSites'
+import { isWorkerEnvironment } from '../../tools/globalObject'
 import type { TransportConfiguration } from './transportConfiguration'
 import { computeTransportConfiguration } from './transportConfiguration'
 
@@ -353,7 +354,7 @@ export function validateAndBuildConfiguration(initConfiguration: InitConfigurati
   return {
     beforeSend:
       initConfiguration.beforeSend && catchUserErrors(initConfiguration.beforeSend, 'beforeSend threw an error:'),
-    sessionStoreStrategyType: selectSessionStoreStrategyType(initConfiguration),
+    sessionStoreStrategyType: isWorkerEnvironment ? undefined : selectSessionStoreStrategyType(initConfiguration),
     sessionSampleRate: initConfiguration.sessionSampleRate ?? 100,
     telemetrySampleRate: initConfiguration.telemetrySampleRate ?? 20,
     telemetryConfigurationSampleRate: initConfiguration.telemetryConfigurationSampleRate ?? 5,
@@ -383,9 +384,10 @@ export function validateAndBuildConfiguration(initConfiguration: InitConfigurati
     flushTimeout: (30 * ONE_SECOND) as Duration,
 
     /**
-     * Logs intake limit
+     * Logs intake limit. When using the SDK in a Worker Environment, we
+     * limit the batch size to 1 to ensure it can be sent in a single event.
      */
-    batchMessagesLimit: 50,
+    batchMessagesLimit: isWorkerEnvironment ? 1 : 50,
     messageBytesLimit: 256 * ONE_KIBI_BYTE,
 
     /**
diff --git a/packages/core/src/domain/connectivity/connectivity.ts b/packages/core/src/domain/connectivity/connectivity.ts
@@ -1,3 +1,5 @@
+import { globalObject } from '../../tools/globalObject'
+
 export type NetworkInterface = 'bluetooth' | 'cellular' | 'ethernet' | 'none' | 'wifi' | 'wimax' | 'other' | 'unknown'
 export type EffectiveType = 'slow-2g' | '2g' | '3g' | '4g'
 
@@ -19,7 +21,8 @@ export interface Connectivity {
 }
 
 export function getConnectivity(): Connectivity {
-  const navigator = window.navigator as BrowserNavigator
+  const navigator = globalObject.navigator as BrowserNavigator
+
   return {
     status: navigator.onLine ? 'connected' : 'not_connected',
     interfaces: navigator.connection && navigator.connection.type ? [navigator.connection.type] : undefined,
diff --git a/packages/core/src/domain/error/trackRuntimeError.ts b/packages/core/src/domain/error/trackRuntimeError.ts
@@ -3,7 +3,7 @@ import { Observable } from '../../tools/observable'
 import { clocksNow } from '../../tools/utils/timeUtils'
 import type { StackTrace } from '../../tools/stackTrace/computeStackTrace'
 import { computeStackTraceFromOnErrorMessage } from '../../tools/stackTrace/computeStackTrace'
-import { getGlobalObject } from '../../tools/getGlobalObject'
+import { getGlobalObject } from '../../tools/globalObject'
 import { computeRawError, isError } from './error'
 import type { RawError } from './error.types'
 import { ErrorHandling, ErrorSource, NonErrorPrefix } from './error.types'
diff --git a/packages/core/src/domain/synthetics/syntheticsWorkerValues.ts b/packages/core/src/domain/synthetics/syntheticsWorkerValues.ts
@@ -1,4 +1,5 @@
 import { getInitCookie } from '../../browser/cookie'
+import { globalObject, isWorkerEnvironment } from '../../tools/globalObject'
 
 export const SYNTHETICS_TEST_ID_COOKIE_NAME = 'datadog-synthetics-public-id'
 export const SYNTHETICS_RESULT_ID_COOKIE_NAME = 'datadog-synthetics-result-id'
@@ -11,8 +12,13 @@ export interface BrowserWindow extends Window {
 }
 
 export function willSyntheticsInjectRum(): boolean {
+  if (isWorkerEnvironment) {
+    // We don't expect to run synthetics tests in a worker environment
+    return false
+  }
+
   return Boolean(
-    (window as BrowserWindow)._DATADOG_SYNTHETICS_INJECTS_RUM || getInitCookie(SYNTHETICS_INJECTS_RUM_COOKIE_NAME)
+    (globalObject as BrowserWindow)._DATADOG_SYNTHETICS_INJECTS_RUM || getInitCookie(SYNTHETICS_INJECTS_RUM_COOKIE_NAME)
   )
 }
 
diff --git a/packages/core/src/domain/telemetry/telemetry.ts b/packages/core/src/domain/telemetry/telemetry.ts
@@ -29,6 +29,7 @@ import type { PageMayExitEvent } from '../../browser/pageMayExitObservable'
 import { DeflateEncoderStreamId } from '../deflate'
 import type { AbstractHooks, RecursivePartial } from '../../tools/abstractHooks'
 import { HookNames, DISCARDED } from '../../tools/abstractHooks'
+import { globalObject, isWorkerEnvironment } from '../../tools/globalObject'
 import type { TelemetryEvent } from './telemetryEvent.types'
 import type {
   RawTelemetryConfiguration,
@@ -229,8 +230,8 @@ function startTelemetryTransport(
 
 function getRuntimeEnvInfo(): RuntimeEnvInfo {
   return {
-    is_local_file: window.location.protocol === 'file:',
-    is_worker: 'WorkerGlobalScope' in self,
+    is_local_file: globalObject.location?.protocol === 'file:',
+    is_worker: isWorkerEnvironment,
   }
 }
 
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -78,7 +78,7 @@ export * from './tools/utils/urlPolyfill'
 export * from './tools/utils/timeUtils'
 export * from './tools/utils/arrayUtils'
 export * from './tools/serialisation/sanitize'
-export * from './tools/getGlobalObject'
+export * from './tools/globalObject'
 export { AbstractLifeCycle } from './tools/abstractLifeCycle'
 export * from './domain/eventRateLimiter/createEventRateLimiter'
 export * from './tools/utils/browserDetection'
diff --git a/packages/core/src/tools/getZoneJsOriginalValue.ts b/packages/core/src/tools/getZoneJsOriginalValue.ts
@@ -1,4 +1,4 @@
-import { getGlobalObject } from './getGlobalObject'
+import { getGlobalObject } from './globalObject'
 
 export interface BrowserWindowWithZoneJs extends Window {
   Zone?: {
diff --git a/packages/core/src/tools/globalObject.ts b/packages/core/src/tools/globalObject.ts
@@ -2,6 +2,17 @@
  * inspired by https://mathiasbynens.be/notes/globalthis
  */
 
+// Extend/Create the WorkerGlobalScope interface to avoid issues when used in a non-browser tsconfig environment
+interface WorkerGlobalScope {
+  empty: never
+}
+
+// Utility type to enforce that exactly one of the two types is used
+type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never }
+type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U
+
+export type GlobalObject = XOR<Window, WorkerGlobalScope>
+
 export function getGlobalObject<T = typeof globalThis>(): T {
   if (typeof globalThis === 'object') {
     return globalThis as unknown as T
@@ -29,3 +40,12 @@ export function getGlobalObject<T = typeof globalThis>(): T {
   }
   return globalObject as T
 }
+
+/**
+ * Cached reference to the global object so it can be imported and re-used without
+ * re-evaluating the heavyweight fallback logic in `getGlobalObject()`.
+ */
+// eslint-disable-next-line local-rules/disallow-side-effects
+export const globalObject = getGlobalObject<GlobalObject>()
+
+export const isWorkerEnvironment = !('document' in globalObject)
diff --git a/packages/core/src/tools/queueMicrotask.ts b/packages/core/src/tools/queueMicrotask.ts
@@ -1,7 +1,9 @@
 import { monitor } from './monitor'
+import { globalObject } from './globalObject'
 
 export function queueMicrotask(callback: () => void) {
-  const nativeImplementation = window.queueMicrotask
+  const nativeImplementation = globalObject.queueMicrotask?.bind(globalObject)
+
   if (typeof nativeImplementation === 'function') {
     nativeImplementation(monitor(callback))
   } else {
diff --git a/packages/core/src/tools/sendToExtension.ts b/packages/core/src/tools/sendToExtension.ts
@@ -1,11 +1,13 @@
+import { globalObject } from './globalObject'
+
 interface BrowserWindow {
   __ddBrowserSdkExtensionCallback?: (message: unknown) => void
 }
 
 type ExtensionMessageType = 'logs' | 'record' | 'rum' | 'telemetry'
 
 export function sendToExtension(type: ExtensionMessageType, payload: unknown) {
-  const callback = (window as BrowserWindow).__ddBrowserSdkExtensionCallback
+  const callback = (globalObject as BrowserWindow).__ddBrowserSdkExtensionCallback
   if (callback) {
     callback({ type, payload })
   }
diff --git a/packages/core/src/tools/timer.ts b/packages/core/src/tools/timer.ts
@@ -1,6 +1,6 @@
 import { getZoneJsOriginalValue } from './getZoneJsOriginalValue'
 import { monitor } from './monitor'
-import { getGlobalObject } from './getGlobalObject'
+import { getGlobalObject } from './globalObject'
 
 export type TimeoutId = ReturnType<typeof globalThis.setTimeout>
 
diff --git a/packages/core/src/tools/utils/timeUtils.ts b/packages/core/src/tools/utils/timeUtils.ts
@@ -109,7 +109,9 @@ let navigationStart: TimeStamp | undefined
  */
 function getNavigationStart() {
   if (navigationStart === undefined) {
-    navigationStart = performance.timing.navigationStart as TimeStamp
+    // ServiceWorkers do not support navigationStart (it's deprecated), so we fallback to timeOrigin
+    navigationStart = (performance.timing?.navigationStart ?? performance.timeOrigin) as TimeStamp
   }
+
   return navigationStart
 }
diff --git a/packages/core/src/tools/utils/urlPolyfill.ts b/packages/core/src/tools/utils/urlPolyfill.ts
@@ -1,4 +1,5 @@
 import { jsonStringify } from '../serialisation/jsonStringify'
+import { globalObject } from '../globalObject'
 
 export function normalizeUrl(url: string) {
   return buildUrl(url, location.href).href
@@ -44,7 +45,7 @@ export function getPristineWindow() {
       document.body.appendChild(iframe)
       pristineWindow = iframe.contentWindow as Window & typeof globalThis
     } catch {
-      pristineWindow = window
+      pristineWindow = globalObject as unknown as Window & typeof globalThis
     }
     getPristineGlobalObjectCache = {
       URL: pristineWindow.URL,
diff --git a/packages/core/src/transport/eventBridge.ts b/packages/core/src/transport/eventBridge.ts
@@ -1,4 +1,4 @@
-import { getGlobalObject } from '../tools/getGlobalObject'
+import { getGlobalObject } from '../tools/globalObject'
 import type { DefaultPrivacyLevel } from '../domain/configuration'
 
 export interface BrowserWindowWithEventBridge extends Window {
@@ -47,6 +47,7 @@ export function bridgeSupports(capability: BridgeCapability): boolean {
 
 export function canUseEventBridge(currentHost = getGlobalObject<Window>().location?.hostname): boolean {
   const bridge = getEventBridge()
+
   return (
     !!bridge &&
     bridge
diff --git a/packages/logs/src/boot/preStartLogs.spec.ts b/packages/logs/src/boot/preStartLogs.spec.ts
@@ -161,7 +161,7 @@ describe('preStartLogs', () => {
       )
       strategy.init(DEFAULT_INIT_CONFIGURATION)
 
-      expect(getLoggedMessage(0).savedCommonContext!.view.url).toEqual('url')
+      expect(getLoggedMessage(0).savedCommonContext!.view?.url).toEqual('url')
     })
 
     it('saves the log context', () => {
diff --git a/packages/logs/src/boot/startLogs.ts b/packages/logs/src/boot/startLogs.ts
@@ -1,5 +1,6 @@
-import type { TrackingConsentState, BufferedObservable, BufferedData } from '@datadog/browser-core'
+import type { TrackingConsentState, BufferedObservable, BufferedData, PageMayExitEvent } from '@datadog/browser-core'
 import {
+  Observable,
   sendToExtension,
   createPageMayExitObservable,
   willSyntheticsInjectRum,
@@ -10,6 +11,7 @@ import {
   TelemetryService,
   createIdentityEncoder,
   startUserContext,
+  isWorkerEnvironment,
 } from '@datadog/browser-core'
 import { startLogsSessionManager, startLogsSessionManagerStub } from '../domain/logsSessionManager'
 import type { LogsConfiguration } from '../domain/configuration'
@@ -52,7 +54,10 @@ export function startLogs(
   lifeCycle.subscribe(LifeCycleEventType.LOG_COLLECTED, (log) => sendToExtension('logs', log))
 
   const reportError = startReportError(lifeCycle)
-  const pageMayExitObservable = createPageMayExitObservable(configuration)
+  // Page exit is not observable in worker environments (no window/document events)
+  const pageMayExitObservable = isWorkerEnvironment
+    ? new Observable<PageMayExitEvent>()
+    : createPageMayExitObservable(configuration)
 
   const telemetry = startTelemetry(
     TelemetryService.LOGS,
diff --git a/packages/logs/src/domain/contexts/commonContext.ts b/packages/logs/src/domain/contexts/commonContext.ts
@@ -1,6 +1,11 @@
+import { isWorkerEnvironment } from '@datadog/browser-core'
 import type { CommonContext } from '../../rawLogsEvent.types'
 
 export function buildCommonContext(): CommonContext {
+  if (isWorkerEnvironment) {
+    return {}
+  }
+
   return {
     view: {
       referrer: document.referrer,
diff --git a/packages/logs/src/domain/contexts/rumInternalContext.ts b/packages/logs/src/domain/contexts/rumInternalContext.ts
@@ -1,5 +1,6 @@
 import type { RelativeTime, RumInternalContext } from '@datadog/browser-core'
 import {
+  globalObject,
   willSyntheticsInjectRum,
   addTelemetryDebug,
   getSyntheticsTestId,
@@ -19,7 +20,7 @@ interface BrowserWindow {
 }
 
 export function startRUMInternalContext(hooks: Hooks) {
-  const browserWindow = window as BrowserWindow
+  const browserWindow = globalObject as BrowserWindow
   let logsSentBeforeRumInjectionTelemetryAdded = false
 
   hooks.register(HookNames.Assemble, ({ startTime }) => {
diff --git a/packages/logs/src/domain/networkError/networkErrorCollection.ts b/packages/logs/src/domain/networkError/networkErrorCollection.ts
@@ -1,5 +1,7 @@
 import type { FetchResolveContext, XhrCompleteContext } from '@datadog/browser-core'
 import {
+  isWorkerEnvironment,
+  Observable,
   ErrorSource,
   initXhrObservable,
   RequestType,
@@ -24,7 +26,10 @@ export function startNetworkErrorCollection(configuration: LogsConfiguration, li
     return { stop: noop }
   }
 
-  const xhrSubscription = initXhrObservable(configuration).subscribe((context) => {
+  // XHR is not available in web workers, so we use an empty observable that never emits
+  const xhrSubscription = (
+    isWorkerEnvironment ? new Observable<XhrCompleteContext>() : initXhrObservable(configuration)
+  ).subscribe((context) => {
     if (context.state === 'complete') {
       handleResponse(RequestType.XHR, context)
     }
diff --git a/packages/logs/src/rawLogsEvent.types.ts b/packages/logs/src/rawLogsEvent.types.ts
@@ -62,7 +62,7 @@ export interface RawAgentLogsEvent extends CommonRawLogsEvent {
 }
 
 export interface CommonContext {
-  view: {
+  view?: {
     referrer: string
     url: string
   }
diff --git a/test/e2e/lib/framework/createExtension.ts b/test/e2e/lib/framework/createExtension.ts
@@ -2,7 +2,7 @@ import type { RumInitConfiguration } from '@datadog/browser-rum-core'
 import type test from '@playwright/test'
 import type { LogsInitConfiguration } from '@datadog/browser-logs'
 import { createExtensionTest } from '../helpers/extensionFixture'
-import { DEFAULT_LOGS_CONFIGURATION, DEFAULT_RUM_CONFIGURATION } from './createTest'
+import { DEFAULT_LOGS_CONFIGURATION, DEFAULT_RUM_CONFIGURATION } from '../helpers/configuration'
 
 export function createExtension(path: string) {
   return new Extension(path)
diff --git a/test/e2e/lib/framework/createTest.ts b/test/e2e/lib/framework/createTest.ts
diff --git a/test/e2e/lib/framework/httpServers.ts b/test/e2e/lib/framework/httpServers.ts
diff --git a/test/e2e/lib/framework/index.ts b/test/e2e/lib/framework/index.ts
diff --git a/test/e2e/lib/framework/pageSetups.ts b/test/e2e/lib/framework/pageSetups.ts
diff --git a/test/e2e/lib/framework/serverApps/mock.ts b/test/e2e/lib/framework/serverApps/mock.ts
diff --git a/test/e2e/lib/helpers/configuration.ts b/test/e2e/lib/helpers/configuration.ts
diff --git a/test/e2e/scenario/logs.scenario.ts b/test/e2e/scenario/logs.scenario.ts
diff --git a/tsconfig.base.json b/tsconfig.base.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import { getInitCookie } from '../../browser/cookie'`
	`2`	`+import { globalObject, isWorkerEnvironment } from '../../tools/globalObject'`
`2`	`3`
`3`	`4`	`export const SYNTHETICS_TEST_ID_COOKIE_NAME = 'datadog-synthetics-public-id'`
`4`	`5`	`export const SYNTHETICS_RESULT_ID_COOKIE_NAME = 'datadog-synthetics-result-id'`
`@@ -11,8 +12,13 @@ export interface BrowserWindow extends Window {`
`11`	`12`	`}`
`12`	`13`
`13`	`14`	`export function willSyntheticsInjectRum(): boolean {`
	`15`	`+ if (isWorkerEnvironment) {`
	`16`	`+ // We don't expect to run synthetics tests in a worker environment`
	`17`	`+ return false`
	`18`	`+ }`
	`19`	`+`
`14`	`20`	`return Boolean(`
`15`		`- (window as BrowserWindow)._DATADOG_SYNTHETICS_INJECTS_RUM \|\| getInitCookie(SYNTHETICS_INJECTS_RUM_COOKIE_NAME)`
	`21`	`+ (globalObject as BrowserWindow)._DATADOG_SYNTHETICS_INJECTS_RUM \|\| getInitCookie(SYNTHETICS_INJECTS_RUM_COOKIE_NAME)`
`16`	`22`	`)`
`17`	`23`	`}`
`18`	`24`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { getGlobalObject } from './getGlobalObject'`
	`1`	`+import { getGlobalObject } from './globalObject'`
`2`	`2`
`3`	`3`	`export interface BrowserWindowWithZoneJs extends Window {`
`4`	`4`	`Zone?: {`