Merge branch 'antonis/3859-newCaptureFeedbackAPI' into antonis/3859-newCaptureFeedbackAPI-hint

Author: antonis

CHANGELOG.md

@@ -12,7 +12,6 @@
 
 - Adds new `captureFeedback` and deprecates the `captureUserFeedback` API ([#4320](https://github.com/getsentry/sentry-react-native/pull/4320))
 
-
   ```jsx
   import * as Sentry from "@sentry/react-native";
 

packages/core/src/js/client.ts

@@ -9,6 +9,7 @@ import type {
   Outcome,
   SeverityLevel,
   TransportMakeRequestResponse,
+  UserFeedback,
 } from '@sentry/types';
 import { dateTimestampInSeconds, logger, SentryError } from '@sentry/utils';
 import { Alert } from 'react-native';
@@ -19,7 +20,7 @@ import { getDefaultSidecarUrl } from './integrations/spotlight';
 import type { ReactNativeClientOptions } from './options';
 import type { mobileReplayIntegration } from './replay/mobilereplay';
 import { MOBILE_REPLAY_INTEGRATION_NAME } from './replay/mobilereplay';
-import { items } from './utils/envelope';
+import { createUserFeedbackEnvelope, items } from './utils/envelope';
 import { ignoreRequireCycleLogs } from './utils/ignorerequirecyclelogs';
 import { mergeOutcomes } from './utils/outcome';
 import { ReactNativeLibraries } from './utils/rnlibraries';
@@ -82,6 +83,20 @@ export class ReactNativeClient extends BaseClient<ReactNativeClientOptions> {
     });
   }
 
+  /**
+   * Sends user feedback to Sentry.
+   * @deprecated Use `Sentry.captureFeedback` instead.
+   */
+  public captureUserFeedback(feedback: UserFeedback): void {
+    const envelope = createUserFeedbackEnvelope(feedback, {
+      metadata: this._options._metadata,
+      dsn: this.getDsn(),
+      tunnel: undefined,
+    });
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this.sendEnvelope(envelope);
+  }
+
   /**
    * @inheritdoc
    */

packages/core/test/client.test.ts

@@ -19,6 +19,7 @@ import {
   envelopeItems,
   firstArg,
   getMockSession,
+  getMockUserFeedback,
   getSyncPromiseRejectOnFirstCall,
 } from './testutils';
 
@@ -186,6 +187,15 @@ describe('Tests ReactNativeClient', () => {
       expect(mockTransport.send).not.toBeCalled();
     });
 
+    test('captureUserFeedback does not call transport when enabled false', () => {
+      const mockTransport = createMockTransport();
+      const client = createDisabledClientWith(mockTransport);
+
+      client.captureUserFeedback(getMockUserFeedback());
+
+      expect(mockTransport.send).not.toBeCalled();
+    });
+
     function createDisabledClientWith(transport: Transport) {
       return new ReactNativeClient({
         ...DEFAULT_OPTIONS,
@@ -279,6 +289,38 @@ describe('Tests ReactNativeClient', () => {
     });
   });
 
+  describe('UserFeedback', () => {
+    test('sends UserFeedback to native Layer', () => {
+      const mockTransportSend: jest.Mock = jest.fn(() => Promise.resolve());
+      const client = new ReactNativeClient({
+        ...DEFAULT_OPTIONS,
+        dsn: EXAMPLE_DSN,
+        transport: () => ({
+          send: mockTransportSend,
+          flush: jest.fn(),
+        }),
+      });
+
+      client.captureUserFeedback({
+        comments: 'Test Comments',
+        email: '[email protected]',
+        name: 'Test User',
+        event_id: 'testEvent123',
+      });
+
+      expect(mockTransportSend.mock.calls[0][firstArg][envelopeHeader].event_id).toEqual('testEvent123');
+      expect(mockTransportSend.mock.calls[0][firstArg][envelopeItems][0][envelopeItemHeader].type).toEqual(
+        'user_report',
+      );
+      expect(mockTransportSend.mock.calls[0][firstArg][envelopeItems][0][envelopeItemPayload]).toEqual({
+        comments: 'Test Comments',
+        email: '[email protected]',
+        name: 'Test User',
+        event_id: 'testEvent123',
+      });
+    });
+  });
+
   describe('attachStacktrace', () => {
     let mockTransportSend: jest.Mock;
     let client: ReactNativeClient;
@@ -375,6 +417,11 @@ describe('Tests ReactNativeClient', () => {
       client.captureSession(getMockSession());
       expect(getSdkInfoFrom(mockTransportSend)).toStrictEqual(expectedSdkInfo);
     });
+
+    test('send SdkInfo in the user feedback envelope header', () => {
+      client.captureUserFeedback(getMockUserFeedback());
+      expect(getSdkInfoFrom(mockTransportSend)).toStrictEqual(expectedSdkInfo);
+    });
   });
 
   describe('event data enhancement', () => {

packages/core/test/testutils.ts

@@ -1,4 +1,4 @@
-import type { Session, Transport } from '@sentry/types';
+import type { Session, Transport, UserFeedback } from '@sentry/types';
 import { rejectedSyncPromise } from '@sentry/utils';
 
 export type MockInterface<T> = {
@@ -36,6 +36,13 @@ export const getMockSession = (): Session => ({
   }),
 });
 
+export const getMockUserFeedback = (): UserFeedback => ({
+  comments: 'comments_test_value',
+  email: 'email_test_value',
+  name: 'name_test_value',
+  event_id: 'event_id_test_value',
+});
+
 export const getSyncPromiseRejectOnFirstCall = <Y extends any[]>(reason: unknown): jest.Mock => {
   let shouldSyncReject = true;
   return jest.fn((..._args: Y) => {