feat(replay): Add getReplay utility function

Author: mydea

packages/browser/src/index.ts

@@ -27,6 +27,7 @@ export {
   // eslint-disable-next-line deprecation/deprecation
   Replay,
   replayIntegration,
+  getReplay,
 } from '@sentry/replay';
 export type {
   ReplayEventType,

packages/replay/src/index.ts

@@ -19,5 +19,7 @@ export type {
   CanvasManagerOptions,
 } from './types';
 
+export { getReplay } from './util/getReplay';
+
 // TODO (v8): Remove deprecated types
 export * from './types/deprecated';

packages/replay/src/util/getReplay.ts

@@ -0,0 +1,13 @@
+import { getClient } from '@sentry/core';
+import type { replayIntegration } from '../integration';
+
+/**
+ * This is a small utility to get a type-safe instance of the Replay integration.
+ */
+// eslint-disable-next-line deprecation/deprecation
+export function getReplay(): ReturnType<typeof replayIntegration> | undefined {
+  const client = getClient();
+  return (
+    client && client.getIntegrationByName && client.getIntegrationByName<ReturnType<typeof replayIntegration>>('Replay')
+  );
+}

packages/replay/test/unit/util/getReplay.test.ts

@@ -0,0 +1,40 @@
+import { getCurrentScope } from '@sentry/core';
+import { replayIntegration } from '../../../src/integration';
+import { getReplay } from '../../../src/util/getReplay';
+import { TestClient, getDefaultClientOptions } from '../../utils/TestClient';
+
+describe('getReplay', () => {
+  beforeEach(() => {
+    getCurrentScope().setClient(undefined);
+  });
+
+  it('works without a client', () => {
+    const actual = getReplay();
+    expect(actual).toBeUndefined();
+  });
+
+  it('works with a client without Replay', () => {
+    const client = new TestClient(getDefaultClientOptions());
+    getCurrentScope().setClient(client);
+
+    const actual = getReplay();
+    expect(actual).toBeUndefined();
+  });
+
+  it('works with a client with Replay', () => {
+    const replay = replayIntegration();
+    const client = new TestClient(
+      getDefaultClientOptions({
+        integrations: [replay],
+        replaysOnErrorSampleRate: 0,
+        replaysSessionSampleRate: 0,
+      }),
+    );
+    getCurrentScope().setClient(client);
+    client.init();
+
+    const actual = getReplay();
+    expect(actual).toBe(replay);
+    expect(replay.getReplayId()).toBe(undefined);
+  });
+});

packages/replay/test/utils/TestClient.ts

@@ -39,7 +39,7 @@ export function init(options: TestClientOptions): void {
   initAndBind(TestClient, options);
 }
 
-export function getDefaultClientOptions(options: Partial<ClientOptions> = {}): ClientOptions {
+export function getDefaultClientOptions(options: Partial<TestClientOptions> = {}): ClientOptions {
   return {
     integrations: [],
     dsn: 'https://username@domain/123',