added prepareFeedbackEvent test case

Author: c298lee

packages/feedback/test/unit/util/prepareFeedbackEvent.test.ts

@@ -0,0 +1,87 @@
+import type { Hub, Scope } from '@sentry/core';
+import { getCurrentHub } from '@sentry/core';
+import type { Client } from '@sentry/types';
+
+import type { FeedbackEvent } from '../../../src/types';
+import { prepareFeedbackEvent } from '../../../src/util/prepareFeedbackEvent';
+import { getDefaultClientOptions, TestClient } from '../../utils/TestClient';
+
+describe('Unit | util | prepareFeedbackEvent', () => {
+  let hub: Hub;
+  let client: Client;
+  let scope: Scope;
+
+  beforeEach(() => {
+    hub = getCurrentHub();
+    client = new TestClient(getDefaultClientOptions());
+    hub.bindClient(client);
+
+    client = hub.getClient()!;
+    scope = hub.getScope()!;
+
+    jest.spyOn(client, 'getSdkMetadata').mockImplementation(() => {
+      return {
+        sdk: {
+          name: 'sentry.javascript.testSdk',
+          version: '1.0.0',
+        },
+      };
+    });
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('works', async () => {
+    expect(client).toBeDefined();
+    expect(scope).toBeDefined();
+
+    const replayId = 'replay-ID';
+    const event: FeedbackEvent = {
+      timestamp: 1670837008.634,
+      event_id: 'feedback-ID',
+      feedback: {
+        contact_email: '[email protected]',
+        message: 'looks great!',
+        replay_id: replayId,
+        url: 'https://sentry.io/',
+      },
+      contexts: {
+        replay: {
+          error_sample_rate: 1.0,
+          session_sample_rate: 0.1,
+        },
+      },
+    };
+
+    const feedbackEvent = await prepareFeedbackEvent({ scope, client, event });
+
+    expect(client.getSdkMetadata).toHaveBeenCalledTimes(1);
+
+    expect(feedbackEvent).toEqual({
+      timestamp: 1670837008.634,
+      event_id: 'feedback-ID',
+      feedback: {
+        contact_email: '[email protected]',
+        message: 'looks great!',
+        replay_id: replayId,
+        url: 'https://sentry.io/',
+      },
+      platform: 'javascript',
+      environment: 'production',
+      contexts: {
+        replay: {
+          error_sample_rate: 1.0,
+          session_sample_rate: 0.1,
+        },
+      },
+      sdk: {
+        name: 'sentry.javascript.testSdk',
+        version: '1.0.0',
+      },
+      sdkProcessingMetadata: expect.any(Object),
+      breadcrumbs: undefined,
+    });
+  });
+});

packages/feedback/test/utils/TestClient.ts

@@ -0,0 +1,44 @@
+import { BaseClient, createTransport, initAndBind } from '@sentry/core';
+import type { BrowserClientReplayOptions, ClientOptions, Event, SeverityLevel } from '@sentry/types';
+import { resolvedSyncPromise } from '@sentry/utils';
+
+export interface TestClientOptions extends ClientOptions, BrowserClientReplayOptions {}
+
+export class TestClient extends BaseClient<TestClientOptions> {
+  public constructor(options: TestClientOptions) {
+    super(options);
+  }
+
+  public eventFromException(exception: any): PromiseLike<Event> {
+    return resolvedSyncPromise({
+      exception: {
+        values: [
+          {
+            /* eslint-disable @typescript-eslint/no-unsafe-member-access */
+            type: exception.name,
+            value: exception.message,
+            /* eslint-enable @typescript-eslint/no-unsafe-member-access */
+          },
+        ],
+      },
+    });
+  }
+
+  public eventFromMessage(message: string, level: SeverityLevel = 'info'): PromiseLike<Event> {
+    return resolvedSyncPromise({ message, level });
+  }
+}
+
+export function init(options: TestClientOptions): void {
+  initAndBind(TestClient, options);
+}
+
+export function getDefaultClientOptions(options: Partial<ClientOptions> = {}): ClientOptions {
+  return {
+    integrations: [],
+    dsn: 'https://username@domain/123',
+    transport: () => createTransport({ recordDroppedEvent: () => undefined }, _ => resolvedSyncPromise({})),
+    stackParser: () => [],
+    ...options,
+  };
+}