test(replay): Add test & comment for replay event creation

Author: mydea

packages/replay/src/replay.ts

@@ -954,6 +954,42 @@ export class ReplayContainer implements ReplayContainerInterface {
       replayType: this.session?.sampled,
     };
 
+    /*
+    For reference, the fully built event looks something like this:
+    {
+        "type": "replay_event",
+        "timestamp": 1670837008.634,
+        "error_ids": [
+            "errorId"
+        ],
+        "trace_ids": [
+            "traceId"
+        ],
+        "urls": [
+            "https://example.com"
+        ],
+        "replay_id": "eventId",
+        "segment_id": 3,
+        "platform": "javascript",
+        "event_id": "eventId",
+        "environment": "production",
+        "sdk": {
+            "integrations": [
+                "BrowserTracing",
+                "Replay"
+            ],
+            "name": "sentry.javascript.integration.replay",
+            "version": "7.24.2"
+        },
+        "sdkProcessingMetadata": {},
+        "tags": {
+            "sessionSampleRate": 1,
+            "errorSampleRate": 0,
+            "replayType": "error"
+        }
+    }
+    */
+
     const envelope = createReplayEnvelope(replayId, replayEvent, payloadWithSequence);
 
     try {

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

@@ -0,0 +1,60 @@
+import { BrowserClient } from '@sentry/browser';
+import { getCurrentHub, Hub, Scope } from '@sentry/core';
+import { Client, Event } from '@sentry/types';
+
+import { REPLAY_EVENT_NAME } from '../../../src/constants';
+import { getReplayEvent } from '../../../src/util/getReplayEvent';
+import { getDefaultBrowserClientOptions } from '../../utils/getDefaultBrowserClientOptions';
+
+describe('getReplayEvent', () => {
+  let hub: Hub;
+  let client: Client;
+  let scope: Scope;
+
+  beforeEach(() => {
+    hub = getCurrentHub();
+    client = new BrowserClient(getDefaultBrowserClientOptions());
+    hub.bindClient(client);
+
+    client = hub.getClient()!;
+    scope = hub.getScope()!;
+  });
+
+  it('works', async () => {
+    expect(client).toBeDefined();
+    expect(scope).toBeDefined();
+
+    const replayId = 'replay-ID';
+    const event: Event = {
+      // @ts-ignore private api
+      type: REPLAY_EVENT_NAME,
+      timestamp: 1670837008.634,
+      error_ids: ['error-ID'],
+      trace_ids: ['trace-ID'],
+      urls: ['https://sentry.io/'],
+      replay_id: replayId,
+      segment_id: 3,
+    };
+
+    const replayEvent = await getReplayEvent({ scope, client, replayId, event });
+
+    expect(replayEvent).toEqual({
+      type: 'replay_event',
+      timestamp: 1670837008.634,
+      error_ids: ['error-ID'],
+      trace_ids: ['trace-ID'],
+      urls: ['https://sentry.io/'],
+      replay_id: 'replay-ID',
+      segment_id: 3,
+      platform: 'javascript',
+      event_id: 'replay-ID',
+      environment: 'production',
+      sdk: {
+        name: 'sentry.javascript.integration.replay',
+        version: 'version:Test',
+      },
+      sdkProcessingMetadata: {},
+      breadcrumbs: undefined,
+    });
+  });
+});

packages/replay/test/utils/getDefaultBrowserClientOptions.ts

@@ -0,0 +1,12 @@
+import { createTransport } from '@sentry/core';
+import { ClientOptions } from '@sentry/types';
+import { resolvedSyncPromise } from '@sentry/utils';
+
+export function getDefaultBrowserClientOptions(options: Partial<ClientOptions> = {}): ClientOptions {
+  return {
+    integrations: [],
+    transport: () => createTransport({ recordDroppedEvent: () => undefined }, _ => resolvedSyncPromise({})),
+    stackParser: () => [],
+    ...options,
+  };
+}