inline _handleFeedbackSubmit and handleFeedbackSubmit and simplify return types

Author: ryan953

packages/feedback-async/src/sendFeedback.ts

@@ -1,8 +1,9 @@
+import { createEventEnvelope, getClient, withScope } from '@sentry/core';
+import type { FeedbackEvent, TransportMakeRequestResponse } from '@sentry/types';
 import { getLocationHref } from '@sentry/utils';
-
-import { FEEDBACK_API_SOURCE } from './constants';
+import { FEEDBACK_API_SOURCE, FEEDBACK_WIDGET_SOURCE } from './constants';
 import type { SendFeedbackOptions } from './types';
-import { sendFeedbackRequest } from './util/sendFeedbackRequest';
+import { prepareFeedbackEvent } from './util/prepareFeedbackEvent';
 
 interface SendFeedbackParams {
   message: string;
@@ -15,24 +16,124 @@ interface SendFeedbackParams {
 /**
  * Public API to send a Feedback item to Sentry
  */
-export function sendFeedback(
+export async function sendFeedback(
   { name, email, message, source = FEEDBACK_API_SOURCE, url = getLocationHref() }: SendFeedbackParams,
-  options: SendFeedbackOptions = {},
-): ReturnType<typeof sendFeedbackRequest> {
+  { includeReplay = true }: SendFeedbackOptions = {},
+): Promise<TransportMakeRequestResponse> {
   if (!message) {
     throw new Error('Unable to submit feedback with empty message');
   }
 
-  return sendFeedbackRequest(
-    {
+  const client = getClient();
+  const transport = client && client.getTransport();
+  const dsn = client && client.getDsn();
+
+  if (!client || !transport || !dsn) {
+    throw new Error('Invalid Sentry client');
+  }
+
+  const baseEvent: FeedbackEvent = {
+    contexts: {
       feedback: {
+        contact_email: email,
         name,
-        email,
         message,
         url,
         source,
       },
     },
-    options,
-  );
+    type: 'feedback',
+  };
+
+  return withScope(async scope => {
+    // No use for breadcrumbs in feedback
+    scope.clearBreadcrumbs();
+
+    if ([FEEDBACK_API_SOURCE, FEEDBACK_WIDGET_SOURCE].includes(String(source))) {
+      scope.setLevel('info');
+    }
+
+    const feedbackEvent = await prepareFeedbackEvent({
+      scope,
+      client,
+      event: baseEvent,
+    });
+
+    if (client.emit) {
+      client.emit('beforeSendFeedback', feedbackEvent, { includeReplay: Boolean(includeReplay) });
+    }
+
+    const envelope = createEventEnvelope(feedbackEvent, dsn, client.getOptions()._metadata, client.getOptions().tunnel);
+
+    let response: void | TransportMakeRequestResponse;
+
+    try {
+      response = await transport.send(envelope);
+    } catch (err) {
+      const error = new Error('Unable to send Feedback');
+
+      try {
+        // In case browsers don't allow this property to be writable
+        // @ts-expect-error This needs lib es2022 and newer
+        error.cause = err;
+      } catch {
+        // nothing to do
+      }
+      throw error;
+    }
+
+    // TODO (v8): we can remove this guard once transport.send's type signature doesn't include void anymore
+    if (!response) {
+      throw new Error('Unable to send Feedback');
+    }
+
+    // Require valid status codes, otherwise can assume feedback was not sent successfully
+    if (typeof response.statusCode === 'number' && (response.statusCode < 200 || response.statusCode >= 300)) {
+      throw new Error('Unable to send Feedback. Invalid response from server.');
+    }
+
+    return response;
+  });
 }
+
+/*
+ * For reference, the fully built event looks something like this:
+ * {
+ *     "type": "feedback",
+ *     "event_id": "d2132d31b39445f1938d7e21b6bf0ec4",
+ *     "timestamp": 1597977777.6189718,
+ *     "dist": "1.12",
+ *     "platform": "javascript",
+ *     "environment": "production",
+ *     "release": 42,
+ *     "tags": {"transaction": "/organizations/:orgId/performance/:eventSlug/"},
+ *     "sdk": {"name": "name", "version": "version"},
+ *     "user": {
+ *         "id": "123",
+ *         "username": "user",
+ *         "email": "user@site.com",
+ *         "ip_address": "192.168.11.12",
+ *     },
+ *     "request": {
+ *         "url": None,
+ *         "headers": {
+ *             "user-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15"
+ *         },
+ *     },
+ *     "contexts": {
+ *         "feedback": {
+ *             "message": "test message",
+ *             "contact_email": "test@example.com",
+ *             "type": "feedback",
+ *         },
+ *         "trace": {
+ *             "trace_id": "4C79F60C11214EB38604F4AE0781BFB2",
+ *             "span_id": "FA90FDEAD5F74052",
+ *             "type": "trace",
+ *         },
+ *         "replay": {
+ *             "replay_id": "e2d42047b1c5431c8cba85ee2a8ab25d",
+ *         },
+ *     },
+ *   }
+ */

packages/feedback-async/src/util/handleFeedbackSubmit.ts

@@ -15,7 +15,7 @@ export async function prepareFeedbackEvent({
   client,
   scope,
   event,
-}: PrepareFeedbackEventParams): Promise<FeedbackEvent | null> {
+}: PrepareFeedbackEventParams): Promise<FeedbackEvent> {
   const eventHint = {};
   if (client.emit) {
     client.emit('preprocessEvent', event, eventHint);
@@ -33,7 +33,7 @@ export async function prepareFeedbackEvent({
   if (preparedEvent === null) {
     // Taken from baseclient's `_processEvent` method, where this is handled for errors/transactions
     client.recordDroppedEvent('event_processor', 'feedback', event);
-    return null;
+    throw new Error('Unable to prepare event');
   }
 
   // This normally happens in browser client "_prepareEvent"

packages/feedback-async/src/util/prepareFeedbackEvent.ts

@@ -0,0 +1,19 @@
+import type { FeedbackFormData, FeedbackInternalOptions } from '../types';
+
+/**
+ * Validate that a given feedback submission has the required fields
+ */
+export function getMissingFields(feedback: FeedbackFormData, options: FeedbackInternalOptions): string[] {
+  const emptyFields = [];
+  if (options.isNameRequired && !feedback.name) {
+    emptyFields.push(options.nameLabel);
+  }
+  if (options.isEmailRequired && !feedback.email) {
+    emptyFields.push(options.emailLabel);
+  }
+  if (!feedback.message) {
+    emptyFields.push(options.messageLabel);
+  }
+
+  return emptyFields;
+}