More type improve

Author: timfish

packages/browser/src/client.ts

@@ -1,5 +1,5 @@
 import { BaseClient, getCurrentHub, getEnvelopeEndpointWithUrlEncodedAuth, Scope, SDK_VERSION } from '@sentry/core';
-import { AttachmentWithData,ClientOptions, Event, EventHint, Options, Severity, SeverityLevel } from '@sentry/types';
+import { Attachment, ClientOptions, Event, EventHint, Options, Severity, SeverityLevel } from '@sentry/types';
 import {
   createClientReportEnvelope,
   dsnToString,
@@ -103,7 +103,7 @@ export class BrowserClient extends BaseClient<BrowserClientOptions> {
   /**
    * @inheritDoc
    */
-  public sendEvent(event: Event, attachments?: AttachmentWithData[]): void {
+  public sendEvent(event: Event, attachments?: Attachment[]): void {
     // We only want to add the sentry event breadcrumb when the user has the breadcrumb integration installed and
     // activated its `sentry` option.
     // We also do not want to use the `Breadcrumbs` class here directly, because we do not want it to be included in

packages/core/src/baseclient.ts

@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */
 import { Scope, Session } from '@sentry/hub';
 import {
-  AttachmentWithData,
+  Attachment,
   Client,
   ClientOptions,
   DataCategory,
@@ -285,7 +285,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   /**
    * @inheritDoc
    */
-  public sendEvent(event: Event, attachments?: AttachmentWithData[]): void {
+  public sendEvent(event: Event, attachments?: Attachment[]): void {
     if (this._dsn) {
       const env = createEventEnvelope(event, this._dsn, this._options._metadata, this._options.tunnel);
 
@@ -670,17 +670,15 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   /**
    * Loads attachments from scope
    */
-  protected _attachmentsFromScope(scope: Scope | undefined): AttachmentWithData[] {
+  protected _attachmentsFromScope(scope: Scope | undefined): Attachment[] {
     return (
       scope?.getAttachments()?.reduce((acc, attachment) => {
-        if ('path' in attachment || !('data' in attachment)) {
-          logger.error('This SDK does not support loading attachments from file paths and no data was supplied');
-        } else {
+        if ('data' in attachment) {
           acc.push(attachment);
         }
 
         return acc;
-      }, [] as AttachmentWithData[]) || []
+      }, [] as Attachment[]) || []
     );
   }
 

packages/hub/src/scope.ts

@@ -1,6 +1,6 @@
 /* eslint-disable max-lines */
 import {
-  Attachment,
+  AttachmentOptions,
   Breadcrumb,
   CaptureContext,
   Context,
@@ -87,7 +87,7 @@ export class Scope implements ScopeInterface {
   protected _requestSession?: RequestSession;
 
   /** Attachments */
-  protected _attachments: Attachment[] = [];
+  protected _attachments: AttachmentOptions[] = [];
 
   /**
    * A place to stash data which is needed at some point in the SDK's event processing pipeline but which shouldn't get
@@ -407,15 +407,15 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public addAttachment(attachment: Attachment): this {
+  public addAttachment(attachment: AttachmentOptions): this {
     this._attachments.push(attachment);
     return this;
   }
 
   /**
    * @inheritDoc
    */
-  public getAttachments(): Attachment[] {
+  public getAttachments(): AttachmentOptions[] {
     return this._attachments;
   }
 

packages/node/src/client.ts

@@ -1,6 +1,6 @@
 import { BaseClient, Scope, SDK_VERSION } from '@sentry/core';
 import { SessionFlusher } from '@sentry/hub';
-import { AttachmentWithData, Event, EventHint, Severity, SeverityLevel } from '@sentry/types';
+import { Attachment, Event, EventHint, Severity, SeverityLevel } from '@sentry/types';
 import { basename, logger, resolvedSyncPromise } from '@sentry/utils';
 import { existsSync, readFileSync } from 'fs';
 import { TextEncoder } from 'util';
@@ -162,7 +162,7 @@ export class NodeClient extends BaseClient<NodeClientOptions> {
   /**
    * @inheritDoc
    */
-  protected _attachmentsFromScope(scope: Scope | undefined): AttachmentWithData[] {
+  protected _attachmentsFromScope(scope: Scope | undefined): Attachment[] {
     return (
       scope?.getAttachments()?.map(attachment => {
         if ('path' in attachment && !('data' in attachment)) {
@@ -174,9 +174,12 @@ export class NodeClient extends BaseClient<NodeClientOptions> {
               attachmentType: attachment.attachmentType,
             };
           } else {
+            const msg = `Missing attachment - file not found: ${attachment.path}`;
+            logger.warn(msg);
+
             return {
               filename: attachment.filename || basename(attachment.path),
-              data: 'Missing attachment - file not found',
+              data: msg,
               contentType: 'text/plain',
             };
           }

packages/node/test/index.test.ts

@@ -1,6 +1,6 @@
 import { initAndBind, SDK_VERSION } from '@sentry/core';
 import { getMainCarrier } from '@sentry/hub';
-import { AttachmentWithData,Integration } from '@sentry/types';
+import { Attachment, Integration } from '@sentry/types';
 import * as domain from 'domain';
 
 import {
@@ -76,7 +76,7 @@ describe('SentryNode', () => {
   });
 
   describe('breadcrumbs', () => {
-    let s: jest.SpyInstance<void, [Event, AttachmentWithData[]?]>;
+    let s: jest.SpyInstance<void, [Event, Attachment[]?]>;
 
     beforeEach(() => {
       s = jest.spyOn(NodeClient.prototype, 'sendEvent').mockImplementation(async () => Promise.resolve({ code: 200 }));
@@ -107,7 +107,7 @@ describe('SentryNode', () => {
   });
 
   describe('capture', () => {
-    let s: jest.SpyInstance<void, [Event, AttachmentWithData[]?]>;
+    let s: jest.SpyInstance<void, [Event, Attachment[]?]>;
 
     beforeEach(() => {
       s = jest.spyOn(NodeClient.prototype, 'sendEvent').mockImplementation(async () => Promise.resolve({ code: 200 }));

packages/types/src/attachment.ts

@@ -1,13 +1,13 @@
-export type Attachment = AttachmentWithPath | AttachmentWithData;
+export type AttachmentOptions = Attachment | AttachmentFromPath;
 
-export interface AttachmentWithData {
+export interface Attachment {
   data: string | Uint8Array;
   filename: string;
   contentType?: string;
   attachmentType?: string;
 }
 
-interface AttachmentWithPath {
+interface AttachmentFromPath {
   path: string;
   filename?: string;
   contentType?: string;

packages/types/src/index.ts

@@ -1,4 +1,4 @@
-export type { Attachment, AttachmentWithData } from './attachment';
+export type { Attachment, AttachmentOptions } from './attachment';
 export type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 export type { Client } from './client';
 export type { ClientReport, Outcome, EventDropReason } from './clientreport';

packages/types/src/scope.ts

@@ -1,4 +1,4 @@
-import { Attachment } from './attachment';
+import { AttachmentOptions } from './attachment';
 import { Breadcrumb } from './breadcrumb';
 import { Context, Contexts } from './context';
 import { EventProcessor } from './eventprocessor';
@@ -164,12 +164,12 @@ export interface Scope {
    * Adds an attachment to the scope
    * @param attachment Attachment options
    */
-  addAttachment(attachment: Attachment): this;
+  addAttachment(attachment: AttachmentOptions): this;
 
   /**
    * Returns an array of attachments on the scope
    */
-  getAttachments(): Attachment[];
+  getAttachments(): AttachmentOptions[];
 
   /**
    * Clears attachments from the scope

packages/utils/src/envelope.ts

@@ -1,11 +1,4 @@
-import {
-  AttachmentItem,
-  AttachmentWithData,
-  DataCategory,
-  Envelope,
-  EnvelopeItem,
-  EnvelopeItemType,
-} from '@sentry/types';
+import { Attachment, AttachmentItem, DataCategory, Envelope, EnvelopeItem, EnvelopeItemType } from '@sentry/types';
 
 import { dropUndefinedKeys } from './object';
 
@@ -93,7 +86,7 @@ function concatBuffers(buffers: Uint8Array[]): Uint8Array {
  * Creates attachment envelope items
  */
 export function createAttachmentEnvelopeItem(
-  attachment: AttachmentWithData,
+  attachment: Attachment,
   textEncoder?: TextEncoderInternal,
 ): AttachmentItem {
   const utf8 = textEncoder || new TextEncoder();