✅ improve unit test setup (#4149)

Author: BenoitZugmeyer

AGENTS.md

@@ -24,6 +24,9 @@ yarn test:unit
 # Run specific test file
 yarn test:unit --spec packages/core/src/path/to/feature.spec.ts
 
+# Run tests on a specific seed
+yarn test:unit --seed 123
+
 # setup E2E tests (installs Playwright and builds test apps)
 yarn test:e2e:init
 

packages/core/src/browser/cookie.spec.ts

@@ -1,12 +1,8 @@
 import { mockCookies } from '../../test'
-import { getCurrentSite, resetGetCurrentSite } from './cookie'
+import { getCurrentSite } from './cookie'
 
 describe('cookie', () => {
   describe('getCurrentSite', () => {
-    beforeEach(() => {
-      resetGetCurrentSite()
-    })
-
     it('returns the eTLD+1 for example.com', () => {
       mockCookies()
       expect(getCurrentSite('example.com')).toBe('example.com')

packages/core/src/browser/xhrObservable.ts

@@ -132,3 +132,12 @@ function abortXhr({ target: xhr }: InstrumentedMethodCall<XMLHttpRequest, 'abort
     context.isAborted = true
   }
 }
+
+/**
+ * Reset the XHR observable global state. This is useful for testing to ensure clean state between tests.
+ *
+ * @internal
+ */
+export function resetXhrObservable() {
+  xhrObservable = undefined
+}

packages/core/src/domain/session/storeStrategies/sessionInCookie.spec.ts

@@ -1,5 +1,5 @@
 import { mockClock, getSessionState, registerCleanupTask } from '../../../../test'
-import { setCookie, deleteCookie, getCookie, getCurrentSite } from '../../../browser/cookie'
+import { setCookie, deleteCookie, getCookie } from '../../../browser/cookie'
 import type { SessionState } from '../sessionState'
 import { validateAndBuildConfiguration } from '../../configuration'
 import type { InitConfiguration } from '../../configuration'
@@ -93,28 +93,29 @@ describe('session in cookie strategy', () => {
       {
         initConfiguration: { clientToken: 'abc' },
         cookieOptions: {},
-        cookieString: /^dd_cookie_test_[\w-]+=[^;]*;expires=[^;]+;path=\/;samesite=strict$/,
+        cookieString: /^dd_[\w_-]+=[^;]*;expires=[^;]+;path=\/;samesite=strict$/,
         description: 'should set samesite to strict by default',
       },
       {
         initConfiguration: { clientToken: 'abc', useSecureSessionCookie: true },
         cookieOptions: { secure: true },
-        cookieString: /^dd_cookie_test_[\w-]+=[^;]*;expires=[^;]+;path=\/;samesite=strict;secure$/,
+        cookieString: /^dd_[\w_-]+=[^;]*;expires=[^;]+;path=\/;samesite=strict;secure$/,
         description: 'should add secure attribute when defined',
       },
       {
         initConfiguration: { clientToken: 'abc', trackSessionAcrossSubdomains: true },
         cookieOptions: { domain: 'foo.bar' },
-        cookieString: new RegExp(
-          `^dd_cookie_test_[\\w-]+=[^;]*;expires=[^;]+;path=\\/;samesite=strict;domain=${getCurrentSite()}$`
-        ),
+        cookieString: new RegExp('^dd_[\\w_-]+=[^;]*;expires=[^;]+;path=\\/;samesite=strict;domain='),
         description: 'should set cookie domain when tracking accross subdomains',
       },
     ].forEach(({ description, initConfiguration, cookieString }) => {
       it(description, () => {
         const cookieSetSpy = spyOnProperty(document, 'cookie', 'set')
         selectCookieStrategy(initConfiguration)
-        expect(cookieSetSpy.calls.argsFor(0)[0]).toMatch(cookieString)
+        expect(cookieSetSpy).toHaveBeenCalled()
+        for (const call of cookieSetSpy.calls.all()) {
+          expect(call.args[0]).toMatch(cookieString)
+        }
       })
     })
   })

packages/core/src/domain/telemetry/telemetry.spec.ts

@@ -20,7 +20,6 @@ import type { StackTrace } from '../../tools/stackTrace/computeStackTrace'
 import { HookNames } from '../../tools/abstractHooks'
 import {
   addTelemetryError,
-  resetTelemetry,
   scrubCustomerFrames,
   formatError,
   addTelemetryConfiguration,
@@ -71,10 +70,6 @@ function startAndSpyTelemetry(
 }
 
 describe('telemetry', () => {
-  afterEach(() => {
-    resetTelemetry()
-  })
-
   it('collects "monitor" errors', async () => {
     const { getTelemetryEvents } = startAndSpyTelemetry()
     callMonitored(() => {

packages/core/src/domain/telemetry/telemetry.ts

@@ -8,7 +8,7 @@ import { buildTags } from '../tags'
 import { INTAKE_SITE_STAGING, INTAKE_SITE_US1_FED } from '../intakeSites'
 import { BufferedObservable, Observable } from '../../tools/observable'
 import { clocksNow } from '../../tools/utils/timeUtils'
-import { displayIfDebugEnabled, startMonitorErrorCollection, resetMonitor } from '../../tools/monitor'
+import { displayIfDebugEnabled, startMonitorErrorCollection } from '../../tools/monitor'
 import { sendToExtension } from '../../tools/sendToExtension'
 import { performDraw } from '../../tools/utils/numberUtils'
 import { jsonStringify } from '../../tools/serialisation/jsonStringify'
@@ -247,7 +247,6 @@ function getRuntimeEnvInfo(): RuntimeEnvInfo {
 
 export function resetTelemetry() {
   telemetryObservable = undefined
-  resetMonitor()
 }
 
 /**

packages/core/src/index.ts

@@ -42,7 +42,6 @@ export {
   startTelemetry,
   addTelemetryDebug,
   addTelemetryError,
-  resetTelemetry,
   TelemetryService,
   TelemetryMetrics,
   addTelemetryConfiguration,
@@ -106,7 +105,7 @@ export type { CookieStore, WeakRef, WeakRefConstructor } from './browser/browser
 export type { XhrCompleteContext, XhrStartContext } from './browser/xhrObservable'
 export { initXhrObservable } from './browser/xhrObservable'
 export type { FetchResolveContext, FetchStartContext, FetchContext } from './browser/fetchObservable'
-export { initFetchObservable, resetFetchObservable, ResponseBodyAction } from './browser/fetchObservable'
+export { initFetchObservable, ResponseBodyAction } from './browser/fetchObservable'
 export { fetch } from './browser/fetch'
 export type { PageMayExitEvent } from './browser/pageMayExitObservable'
 export { createPageMayExitObservable, PageExitReason, isPageExitReason } from './browser/pageMayExitObservable'
@@ -115,7 +114,7 @@ export { requestIdleCallback } from './tools/requestIdleCallback'
 export * from './tools/taskQueue'
 export * from './tools/timer'
 export type { ConsoleLog } from './domain/console/consoleObservable'
-export { initConsoleObservable, resetConsoleObservable } from './domain/console/consoleObservable'
+export { initConsoleObservable } from './domain/console/consoleObservable'
 export type { BoundedBuffer } from './tools/boundedBuffer'
 export { createBoundedBuffer } from './tools/boundedBuffer'
 export { catchUserErrors } from './tools/catchUserErrors'

packages/core/src/tools/monitor.spec.ts

@@ -1,15 +1,12 @@
 import { display } from './display'
-import { callMonitored, monitor, monitored, startMonitorErrorCollection, resetMonitor, setDebugMode } from './monitor'
+import { callMonitored, monitor, monitored, startMonitorErrorCollection, setDebugMode } from './monitor'
 
 describe('monitor', () => {
   let onMonitorErrorCollectedSpy: jasmine.Spy<(error: unknown) => void>
 
   beforeEach(() => {
     onMonitorErrorCollectedSpy = jasmine.createSpy()
   })
-  afterEach(() => {
-    resetMonitor()
-  })
 
   describe('decorator', () => {
     class Candidate {

packages/core/src/tools/timer.spec.ts

@@ -1,6 +1,6 @@
-import { mockClock, mockZoneJs, registerCleanupTask } from '../../test'
+import { mockClock, mockZoneJs } from '../../test'
 import type { Clock, MockZoneJs } from '../../test'
-import { resetMonitor, startMonitorErrorCollection } from './monitor'
+import { startMonitorErrorCollection } from './monitor'
 import { setTimeout, clearTimeout, setInterval, clearInterval } from './timer'
 import { noop } from './utils/functionUtils'
 ;[
@@ -21,9 +21,6 @@ import { noop } from './utils/functionUtils'
 
     beforeEach(() => {
       clock = mockClock()
-      registerCleanupTask(() => {
-        resetMonitor()
-      })
       zoneJs = mockZoneJs()
     })
 

packages/core/src/tools/valueHistory.ts

@@ -30,7 +30,7 @@ export interface ValueHistory<Value> {
   stop: () => void
 }
 
-let cleanupHistoriesInterval: TimeoutId | null = null
+let cleanupHistoriesInterval: TimeoutId | undefined
 
 const cleanupTasks: Set<() => void> = new Set()
 
@@ -143,9 +143,20 @@ export function createValueHistory<Value>({
     cleanupTasks.delete(clearExpiredValues)
     if (cleanupTasks.size === 0 && cleanupHistoriesInterval) {
       clearInterval(cleanupHistoriesInterval)
-      cleanupHistoriesInterval = null
+      cleanupHistoriesInterval = undefined
     }
   }
 
   return { add, find, closeActive, findAll, reset, stop }
 }
+
+/**
+ * Reset all global state. This is useful for testing to ensure clean state between tests.
+ *
+ * @internal
+ */
+export function resetValueHistoryGlobals() {
+  cleanupTasks.clear()
+  clearInterval(cleanupHistoriesInterval)
+  cleanupHistoriesInterval = undefined
+}