clean up attachment code

Author: c298lee

packages/core/src/envelope.ts

@@ -11,7 +11,6 @@ import type {
   SessionAggregates,
   SessionEnvelope,
   SessionItem,
-  TextEncoderInternal,
 } from '@sentry/types';
 import {
   createAttachmentEnvelopeItem,
@@ -96,11 +95,10 @@ export function createEventEnvelope(
  */
 export function createAttachmentEnvelope(
   event: Event,
-  attachment: Attachment,
+  attachments: Attachment[],
   dsn?: DsnComponents,
   metadata?: SdkMetadata,
   tunnel?: string,
-  textEncoder?: TextEncoderInternal,
 ): EventEnvelope {
   const sdkInfo = getSdkMetadataForEnvelopeHeader(metadata);
   enhanceEventWithSdkInfo(event, metadata && metadata.sdk);
@@ -113,6 +111,9 @@ export function createAttachmentEnvelope(
   // of this `delete`, lest we miss putting it back in the next time the property is in use.)
   delete event.sdkProcessingMetadata;
 
-  const attachmentItem: AttachmentItem = createAttachmentEnvelopeItem(attachment, textEncoder);
-  return createEnvelope<EventEnvelope>(envelopeHeaders, [attachmentItem]);
+  const attachmentItems: AttachmentItem[] = [];
+  for (const attachment of attachments || []) {
+    attachmentItems.push(createAttachmentEnvelopeItem(attachment));
+  }
+  return createEnvelope<EventEnvelope>(envelopeHeaders, attachmentItems);
 }

packages/feedback/src/sendFeedback.ts

@@ -1,8 +1,9 @@
 import { getLocationHref } from '@sentry/utils';
 
 import { FEEDBACK_API_SOURCE } from './constants';
-import type { Screenshot, SendFeedbackOptions } from './types';
+import type { SendFeedbackOptions } from './types';
 import { sendFeedbackRequest } from './util/sendFeedbackRequest';
+import type { Attachment } from '@sentry/types';
 
 interface SendFeedbackParams {
   message: string;
@@ -18,7 +19,7 @@ interface SendFeedbackParams {
 export function sendFeedback(
   { name, email, message, source = FEEDBACK_API_SOURCE, url = getLocationHref() }: SendFeedbackParams,
   options: SendFeedbackOptions = {},
-  screenshots: Screenshot[] = [],
+  screenshots: Attachment[] = [],
 ): ReturnType<typeof sendFeedbackRequest> {
   if (!message) {
     throw new Error('Unable to submit feedback with empty message');

packages/feedback/src/types/index.ts

@@ -1,4 +1,4 @@
-import type { Primitive } from '@sentry/types';
+import type { Attachment, Primitive } from '@sentry/types';
 
 import type { ActorComponent } from '../widget/Actor';
 import type { DialogComponent } from '../widget/Dialog';
@@ -21,7 +21,7 @@ export interface SendFeedbackOptions {
    * Should include replay with the feedback?
    */
   includeReplay?: boolean;
-  screenshots?: Screenshot[];
+  screenshots?: Attachment[];
 }
 
 /**
@@ -343,9 +343,3 @@ export interface FeedbackWidget {
   closeDialog: () => void;
   removeDialog: () => void;
 }
-
-export interface Screenshot {
-  filename: string;
-  data: Uint8Array;
-  contentType: string;
-}

packages/feedback/src/util/handleFeedbackSubmit.ts

@@ -1,10 +1,10 @@
-import type { TransportMakeRequestResponse } from '@sentry/types';
+import type { Attachment, TransportMakeRequestResponse } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
 import { FEEDBACK_WIDGET_SOURCE } from '../constants';
 import { DEBUG_BUILD } from '../debug-build';
 import { sendFeedback } from '../sendFeedback';
-import type { FeedbackFormData, Screenshot, SendFeedbackOptions } from '../types';
+import type { FeedbackFormData, SendFeedbackOptions } from '../types';
 import type { DialogComponent } from '../widget/Dialog';
 
 /**
@@ -14,7 +14,7 @@ import type { DialogComponent } from '../widget/Dialog';
 export async function handleFeedbackSubmit(
   dialog: DialogComponent | null,
   feedback: FeedbackFormData,
-  screenshots?: Screenshot[],
+  screenshots?: Attachment[],
   options?: SendFeedbackOptions,
 ): Promise<TransportMakeRequestResponse | void> {
   if (!dialog) {

packages/feedback/src/util/sendFeedbackRequest.ts

@@ -1,8 +1,8 @@
 import { createEventEnvelope, getClient, withScope, createAttachmentEnvelope } from '@sentry/core';
-import type { FeedbackEvent, TransportMakeRequestResponse } from '@sentry/types';
+import type { Attachment, FeedbackEvent, TransportMakeRequestResponse } from '@sentry/types';
 
 import { FEEDBACK_API_SOURCE, FEEDBACK_WIDGET_SOURCE } from '../constants';
-import type { Screenshot, SendFeedbackData, SendFeedbackOptions } from '../types';
+import type { SendFeedbackData, SendFeedbackOptions } from '../types';
 import { prepareFeedbackEvent } from './prepareFeedbackEvent';
 
 /**
@@ -11,7 +11,7 @@ import { prepareFeedbackEvent } from './prepareFeedbackEvent';
 export async function sendFeedbackRequest(
   { feedback: { message, email, name, source, url } }: SendFeedbackData,
   { includeReplay = true }: SendFeedbackOptions = {},
-  screenshots: Screenshot[],
+  screenshots: Attachment[],
 ): Promise<void | TransportMakeRequestResponse> {
   const client = getClient();
   const transport = client && client.getTransport();
@@ -56,19 +56,6 @@ export async function sendFeedbackRequest(
 
     const envelope = createEventEnvelope(feedbackEvent, dsn, client.getOptions()._metadata, client.getOptions().tunnel);
 
-    let attachment_envelope;
-    for (const attachment of screenshots || []) {
-      attachment_envelope = createAttachmentEnvelope(
-        feedbackEvent,
-        attachment,
-        dsn,
-        client.getOptions()._metadata,
-        client.getOptions().tunnel,
-        // eslint-disable-next-line @sentry-internal/sdk/no-optional-chaining
-        client.getOptions().transportOptions && client.getOptions().transportOptions?.textEncoder,
-      );
-    }
-
     let response: void | TransportMakeRequestResponse;
 
     try {
@@ -96,7 +83,15 @@ export async function sendFeedbackRequest(
       throw new Error('Unable to send Feedback');
     }
 
-    if (attachment_envelope) {
+    if (screenshots) {
+      const attachment_envelope = createAttachmentEnvelope(
+        feedbackEvent,
+        screenshots,
+        dsn,
+        client.getOptions()._metadata,
+        client.getOptions().tunnel,
+      );
+
       try {
         response = await transport.send(attachment_envelope);
       } catch (err) {

packages/feedback/src/widget/Form.ts

@@ -1,10 +1,5 @@
-import type {
-  FeedbackComponent,
-  FeedbackFormData,
-  FeedbackInternalOptions,
-  FeedbackTextConfiguration,
-  Screenshot,
-} from '../types';
+import type { Attachment } from '@sentry/types';
+import type { FeedbackComponent, FeedbackFormData, FeedbackInternalOptions, FeedbackTextConfiguration } from '../types';
 import { SubmitButton } from './SubmitButton';
 import { createElement } from './util/createElement';
 import * as ScreenshotIntegration from '@sentry-internal/feedback-screenshot';
@@ -27,7 +22,7 @@ export interface FormComponentProps
    */
   defaultEmail: string;
   onCancel?: (e: Event) => void;
-  onSubmit?: (feedback: FeedbackFormData, screenshots?: Screenshot[]) => void;
+  onSubmit?: (feedback: FeedbackFormData, screenshots?: Attachment[]) => void;
 }
 
 interface FormComponent extends FeedbackComponent<HTMLFormElement> {

packages/feedback/src/widget/createWidget.ts

@@ -1,7 +1,7 @@
 import { getCurrentScope } from '@sentry/core';
 import { logger } from '@sentry/utils';
-
-import type { FeedbackFormData, FeedbackInternalOptions, FeedbackWidget, Screenshot } from '../types';
+import type { Attachment } from '@sentry/types';
+import type { FeedbackFormData, FeedbackInternalOptions, FeedbackWidget } from '../types';
 import { handleFeedbackSubmit } from '../util/handleFeedbackSubmit';
 import type { ActorComponent } from './Actor';
 import { Actor } from './Actor';
@@ -83,7 +83,7 @@ export function createWidget({
    * Handler for when the feedback form is completed by the user. This will
    * create and send the feedback message as an event.
    */
-  async function _handleFeedbackSubmit(feedback: FeedbackFormData, screenshots?: Screenshot[]): Promise<void> {
+  async function _handleFeedbackSubmit(feedback: FeedbackFormData, screenshots?: Attachment[]): Promise<void> {
     if (!dialog) {
       return;
     }
@@ -210,8 +210,6 @@ export function createWidget({
       }
     } catch (err) {
       // TODO: Error handling?
-      logger.error(err);
-      console.log(err);
     }
   }