Move sendFeedback implementation in the SDK

getsentry · Dec 20, 2024 · eeaa319 · eeaa319
1 parent 50dd619
commit eeaa319
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 21 deletions.
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -65,7 +65,6 @@
     "react-native": ">=0.65.0"
   },
   "dependencies": {
-    "@sentry-internal/feedback": "8.45.1",
     "@sentry/babel-plugin-component-annotate": "2.20.1",
     "@sentry/browser": "8.47.0",
     "@sentry/cli": "2.39.1",

diff --git a/packages/core/src/js/feedback/FeedbackForm.tsx b/packages/core/src/js/feedback/FeedbackForm.tsx
@@ -1,4 +1,3 @@
-import { sendFeedback } from '@sentry-internal/feedback';
 import type { EventHint, SendFeedbackParams } from '@sentry/core';
 import { getCurrentScope, lastEventId, logger } from '@sentry/core';
 import * as React from 'react';
@@ -21,6 +20,7 @@ import { sentryLogo } from './branding';
 import { defaultConfiguration } from './defaults';
 import defaultStyles from './FeedbackForm.styles';
 import type { FeedbackFormProps, FeedbackFormState, FeedbackFormStyles,FeedbackGeneralConfiguration, FeedbackTextConfiguration } from './FeedbackForm.types';
+import { sendFeedback } from './sendFeedback';
 import { checkInternetConnection, isValidEmail } from './utils';
 
 const submitFeedback = async (feedbackParams: SendFeedbackParams, hint: EventHint, success: () => void, error: (e: string) => void): Promise<void> => {

diff --git a/packages/core/src/js/feedback/sendFeedback.ts b/packages/core/src/js/feedback/sendFeedback.ts
@@ -0,0 +1,52 @@
+import type { Event, EventHint, SendFeedback, SendFeedbackParams, TransportMakeRequestResponse } from '@sentry/core';
+import { captureFeedback, getClient, logger } from '@sentry/core';
+
+const FEEDBACK_WIDGET_SOURCE = 'widget';
+const FEEDBACK_RESPONSE_TIMEOUT = 5_000;
+
+/**
+ * Sends feedback to Sentry using Sentry.captureFeedback and waits for the response.
+ */
+export const sendFeedback: SendFeedback = (
+  params: SendFeedbackParams,
+  hint: EventHint & { includeReplay?: boolean } = { includeReplay: true },
+): Promise<string> => {
+  const client = getClient();
+  if (!client) {
+    throw new Error('No client setup, cannot send feedback.');
+  }
+
+  const eventId = captureFeedback(
+    {
+      source: FEEDBACK_WIDGET_SOURCE,
+      ...params,
+    },
+    hint,
+  );
+
+  logger.debug('Feedback captured with Event ID:', eventId);
+
+  return new Promise<string>((resolve, reject) => {
+    const timeout = setTimeout(() => {
+      logger.error('Feedback submission timed out.');
+      reject('Unable to determine if Feedback was correctly sent.');
+    }, FEEDBACK_RESPONSE_TIMEOUT);
+
+    const cleanup = client.on('afterSendEvent', (event: Event, response: TransportMakeRequestResponse) => {
+      if (event.event_id !== eventId) {
+        return;
+      }
+
+      clearTimeout(timeout);
+      cleanup();
+
+      if (event.type === 'feedback') {
+        logger.debug('Feedback detected as sent with eventId:', eventId);
+        resolve(eventId);
+      } else {
+        logger.error('Unexpected response status:', response?.statusCode);
+        reject('Unable to send Feedback due to unexpected issues.');
+      }
+    });
+  });
+};
diff --git a/packages/core/test/feedback/FeedbackForm.test.tsx b/packages/core/test/feedback/FeedbackForm.test.tsx
@@ -1,10 +1,10 @@
-import { sendFeedback } from '@sentry-internal/feedback';
 import { fireEvent, render, waitFor } from '@testing-library/react-native';
 import * as React from 'react';
 import { Alert } from 'react-native';
 
 import { FeedbackForm } from '../../src/js/feedback/FeedbackForm';
 import type { FeedbackFormProps } from '../../src/js/feedback/FeedbackForm.types';
+import { sendFeedback } from '../../src/js/feedback/sendFeedback';
 import { checkInternetConnection } from '../../src/js/feedback/utils';
 
 const mockOnFormClose = jest.fn();
@@ -29,7 +29,7 @@ jest.mock('../../src/js/feedback/utils', () => ({
   ...jest.requireActual('../../src/js/feedback/utils'),
   checkInternetConnection: jest.fn(),
 }));
-jest.mock('@sentry-internal/feedback', () => ({
+jest.mock('../../src/js/feedback/sendFeedback', () => ({
   sendFeedback: jest.fn(),
 }));
 

diff --git a/yarn.lock b/yarn.lock
@@ -7591,15 +7591,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@sentry-internal/feedback@npm:8.45.1":
-  version: 8.45.1
-  resolution: "@sentry-internal/feedback@npm:8.45.1"
-  dependencies:
-    "@sentry/core": 8.45.1
-  checksum: aa0d50078350dbfd3ebdfed448a0d4279324d624fb464bc411d3ec286d6895e52753bc9217bcdfe75a35e184d479588227d1e503bf766ea39bd5392103431b25
-  languageName: node
-  linkType: hard
-
 "@sentry-internal/feedback@npm:8.47.0":
   version: 8.47.0
   resolution: "@sentry-internal/feedback@npm:8.47.0"
@@ -7788,13 +7779,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@sentry/core@npm:8.45.1":
-  version: 8.45.1
-  resolution: "@sentry/core@npm:8.45.1"
-  checksum: 81ed72485685d7baf246ed35c01428664a97eece445ab7b801b908e93dcb58652eaca588c2f9f80baa95419590eb78251305f9e5258ba8a1efee839cb40b15c8
-  languageName: node
-  linkType: hard
-
 "@sentry/core@npm:8.47.0":
   version: 8.47.0
   resolution: "@sentry/core@npm:8.47.0"
@@ -7837,7 +7821,6 @@ __metadata:
     "@react-native/babel-preset": 0.76.3
     "@sentry-internal/eslint-config-sdk": 8.47.0
     "@sentry-internal/eslint-plugin-sdk": 8.47.0
-    "@sentry-internal/feedback": 8.45.1
     "@sentry-internal/typescript": 8.47.0
     "@sentry/babel-plugin-component-annotate": 2.20.1
     "@sentry/browser": 8.47.0