ref: Improve how we get the replay container in tests

Author: mydea

packages/integration-tests/suites/replay/errorResponse/test.ts

@@ -39,6 +39,5 @@ sentryTest('should stop recording after receiving an error response', async ({ g
 
   const replay = await getReplaySnapshot(page);
 
-  // @ts-ignore private API
   expect(replay._isEnabled).toBe(false);
 });

packages/integration-tests/suites/replay/sessionInactive/test.ts

@@ -52,9 +52,7 @@ sentryTest('handles an inactive session', async ({ getLocalTestPath, page }) =>
 
   // nothing happened because no activity/inactivity was detected
   const replay = await getReplaySnapshot(page);
-  // @ts-ignore private api
   expect(replay._isEnabled).toEqual(true);
-  // @ts-ignore private api
   expect(replay._isPaused).toEqual(false);
 
   // Now we trigger a blur event, which should move the session to paused mode
@@ -63,19 +61,15 @@ sentryTest('handles an inactive session', async ({ getLocalTestPath, page }) =>
   });
 
   const replay2 = await getReplaySnapshot(page);
-  // @ts-ignore private api
   expect(replay2._isEnabled).toEqual(true);
-  // @ts-ignore private api
   expect(replay2._isPaused).toEqual(true);
 
   // Trigger an action, should re-start the recording
   await page.click('#button2');
   const req1 = await reqPromise1;
 
   const replay3 = await getReplaySnapshot(page);
-  // @ts-ignore private api
   expect(replay3._isEnabled).toEqual(true);
-  // @ts-ignore private api
   expect(replay3._isPaused).toEqual(false);
 
   const replayEvent1 = getReplayEvent(req1);

packages/integration-tests/suites/replay/sessionMaxAge/test.ts

@@ -41,7 +41,6 @@ for (let i = 0; i < 100; i++) {
 
     const replay0 = await getReplaySnapshot(page);
     // We use the `initialTimestamp` of the replay to do any time based calculations
-    // @ts-ignore this is fine
     const startTimestamp = replay0._context.initialTimestamp;
 
     const req0 = await reqPromise0;

packages/integration-tests/utils/replayHelpers.ts

@@ -1,4 +1,9 @@
-import type { RecordingEvent, ReplayContainer } from '@sentry/replay/build/npm/types/types';
+import type {
+  RecordingEvent,
+  ReplayContainer,
+  InternalEventContext,
+  Session,
+} from '@sentry/replay/build/npm/types/types';
 import type { Breadcrumb, Event, ReplayEvent } from '@sentry/types';
 import pako from 'pako';
 import type { Page, Request, Response } from 'playwright';
@@ -73,9 +78,22 @@ export function isReplayEvent(event: Event): event is ReplayEvent {
  * Note that due to how this works with playwright, this is a POJO copy of replay.
  * This means that we cannot access any methods on it, and also not mutate it in any way.
  */
-export async function getReplaySnapshot(page: Page): Promise<ReplayContainer> {
-  const replayIntegration = await page.evaluate<{ _replay: ReplayContainer }>('window.Replay');
-  return replayIntegration._replay;
+export async function getReplaySnapshot(
+  page: Page,
+): Promise<{ _isPaused: boolean; _isEnabled: boolean; _context: InternalEventContext; session: Session | undefined }> {
+  return await page.evaluate(() => {
+    const replayIntegration = (window as unknown as Window & { Replay: { _replay: ReplayContainer } }).Replay;
+    const replay = replayIntegration._replay;
+
+    const replaySnapshot = {
+      _isPaused: replay.isPaused(),
+      _isEnabled: replay.isEnabled(),
+      _context: replay.getContext(),
+      session: replay.session,
+    };
+
+    return replaySnapshot;
+  });
 }
 
 export const REPLAY_DEFAULT_FLUSH_MAX_DELAY = 5_000;

rollup/plugins/bundlePlugins.js

@@ -118,8 +118,6 @@ export function makeTerserPlugin() {
           '_support',
           // We want to keep some replay fields unmangled to enable integration tests to access them
           '_replay',
-          '_isEnabled',
-          '_isPaused',
           // We also can't mangle rrweb private fields when bundling rrweb in the replay CDN bundles
           '_cssText',
           // We want to keep the _integrations variable unmangled to send all installed integrations from replay