♻️ Use registerCleanupTask for visibilityState cleanup

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

@@ -1,5 +1,5 @@
 import type { Configuration } from '../domain/configuration'
-import { createNewEvent, restorePageVisibility, setPageVisibility, registerCleanupTask } from '../../test'
+import { createNewEvent, setPageVisibility, registerCleanupTask } from '../../test'
 import type { PageExitEvent } from './pageExitObservable'
 import { PageExitReason, createPageExitObservable } from './pageExitObservable'
 
@@ -13,10 +13,6 @@ describe('createPageExitObservable', () => {
     registerCleanupTask(createPageExitObservable(configuration).subscribe(onExitSpy).unsubscribe)
   })
 
-  afterEach(() => {
-    restorePageVisibility()
-  })
-
   it('notifies when the page fires beforeunload', () => {
     window.dispatchEvent(createNewEvent('beforeunload'))
 

packages/core/src/domain/session/sessionManager.spec.ts

@@ -1,11 +1,4 @@
-import {
-  createNewEvent,
-  expireCookie,
-  mockClock,
-  registerCleanupTask,
-  restorePageVisibility,
-  setPageVisibility,
-} from '../../../test'
+import { createNewEvent, expireCookie, mockClock, registerCleanupTask, setPageVisibility } from '../../../test'
 import type { Clock } from '../../../test'
 import { getCookie, setCookie } from '../../browser/cookie'
 import { isIE } from '../../tools/utils/browserDetection'
@@ -365,10 +358,6 @@ describe('startSessionManager', () => {
       setPageVisibility('hidden')
     })
 
-    afterEach(() => {
-      restorePageVisibility()
-    })
-
     it('should expire the session after expiration delay', () => {
       const sessionManager = startSessionManagerWithDefaults()
       const expireSessionSpy = jasmine.createSpy()

packages/core/test/emulate/mockVisibilityState.ts

@@ -1,12 +1,14 @@
+import { registerCleanupTask } from '../registerCleanupTask'
+
 export function setPageVisibility(visibility: 'visible' | 'hidden') {
+  registerCleanupTask(() => {
+    delete (document as any).visibilityState
+  })
+
   Object.defineProperty(document, 'visibilityState', {
     get() {
       return visibility
     },
     configurable: true,
   })
 }
-
-export function restorePageVisibility() {
-  delete (document as any).visibilityState
-}

packages/rum-core/src/domain/view/viewMetrics/trackFirstContentfulPaint.spec.ts

@@ -1,5 +1,5 @@
 import type { RelativeTime } from '@datadog/browser-core'
-import { registerCleanupTask, restorePageVisibility, setPageVisibility } from '@datadog/browser-core/test'
+import { registerCleanupTask, setPageVisibility } from '@datadog/browser-core/test'
 import type { RumPerformanceEntry } from '../../../browser/performanceObservable'
 import { RumPerformanceEntryType } from '../../../browser/performanceObservable'
 import { createPerformanceEntry, mockPerformanceObserver, mockRumConfiguration } from '../../../../test'
@@ -20,7 +20,6 @@ describe('trackFirstContentfulPaint', () => {
     registerCleanupTask(() => {
       firstHidden.stop()
       firstContentfulPaint.stop()
-      restorePageVisibility()
     })
   }
 

packages/rum-core/src/domain/view/viewMetrics/trackFirstHidden.spec.ts

@@ -1,6 +1,6 @@
 import type { RelativeTime } from '@datadog/browser-core'
 import { DOM_EVENT } from '@datadog/browser-core'
-import { createNewEvent, restorePageVisibility, setPageVisibility } from '@datadog/browser-core/test'
+import { createNewEvent, setPageVisibility } from '@datadog/browser-core/test'
 import { mockRumConfiguration } from '../../../../test'
 import { trackFirstHidden } from './trackFirstHidden'
 
@@ -9,7 +9,6 @@ describe('trackFirstHidden', () => {
   let firstHidden: { timeStamp: RelativeTime; stop: () => void }
 
   afterEach(() => {
-    restorePageVisibility()
     firstHidden.stop()
   })
 

packages/rum-core/src/domain/view/viewMetrics/trackFirstInput.spec.ts

@@ -1,5 +1,5 @@
 import { type Duration, type RelativeTime } from '@datadog/browser-core'
-import { registerCleanupTask, restorePageVisibility, setPageVisibility } from '@datadog/browser-core/test'
+import { registerCleanupTask, setPageVisibility } from '@datadog/browser-core/test'
 import {
   appendElement,
   appendText,
@@ -29,7 +29,6 @@ describe('firstInputTimings', () => {
     registerCleanupTask(() => {
       firstHidden.stop()
       firstInputTimings.stop()
-      restorePageVisibility()
     })
   }
 

packages/rum-core/src/domain/view/viewMetrics/trackLargestContentfulPaint.spec.ts

@@ -1,11 +1,6 @@
 import type { RelativeTime } from '@datadog/browser-core'
 import { DOM_EVENT } from '@datadog/browser-core'
-import {
-  setPageVisibility,
-  createNewEvent,
-  restorePageVisibility,
-  registerCleanupTask,
-} from '@datadog/browser-core/test'
+import { setPageVisibility, createNewEvent, registerCleanupTask } from '@datadog/browser-core/test'
 import type { RumPerformanceEntry } from '../../../browser/performanceObservable'
 import { RumPerformanceEntryType } from '../../../browser/performanceObservable'
 import { appendElement, createPerformanceEntry, mockPerformanceObserver, mockRumConfiguration } from '../../../../test'
@@ -32,7 +27,6 @@ describe('trackLargestContentfulPaint', () => {
     registerCleanupTask(() => {
       firstHidden.stop()
       largestContentfulPaint.stop()
-      restorePageVisibility()
     })
   }
 

packages/rum-core/src/domain/view/viewMetrics/trackLoadingTime.spec.ts

@@ -1,7 +1,7 @@
 import type { RelativeTime, Duration } from '@datadog/browser-core'
 import { clocksOrigin, Observable } from '@datadog/browser-core'
 import type { Clock } from '@datadog/browser-core/test'
-import { mockClock, setPageVisibility, restorePageVisibility } from '@datadog/browser-core/test'
+import { mockClock, setPageVisibility } from '@datadog/browser-core/test'
 import { ViewLoadingType } from '../../../rawRumEvent.types'
 import { createPerformanceEntry, mockRumConfiguration } from '../../../../test'
 import { PAGE_ACTIVITY_END_DELAY, PAGE_ACTIVITY_VALIDATION_DELAY } from '../../waitPageActivityEnd'
@@ -46,7 +46,6 @@ describe('trackLoadingTime', () => {
 
   afterEach(() => {
     stopLoadingTimeTracking()
-    restorePageVisibility()
     clock.cleanup()
   })
 

packages/rum/src/domain/segmentCollection/segmentCollection.spec.ts

@@ -3,7 +3,7 @@ import { DeflateEncoderStreamId, PageExitReason, isIE } from '@datadog/browser-c
 import type { ViewHistory, ViewHistoryEntry, RumConfiguration } from '@datadog/browser-rum-core'
 import { LifeCycle, LifeCycleEventType } from '@datadog/browser-rum-core'
 import type { Clock } from '@datadog/browser-core/test'
-import { mockClock, registerCleanupTask, restorePageVisibility } from '@datadog/browser-core/test'
+import { mockClock, registerCleanupTask } from '@datadog/browser-core/test'
 import { createRumSessionManagerMock } from '../../../../rum-core/test'
 import type { BrowserRecord, SegmentContext } from '../../types'
 import { RecordType } from '../../types'
@@ -114,10 +114,6 @@ describe('startSegmentCollection', () => {
   })
 
   describe('segment flush strategy', () => {
-    afterEach(() => {
-      restorePageVisibility()
-    })
-
     it('does not flush empty segments', () => {
       emulatePageUnload()
       worker.processAllMessages()