Few more minor fixes and additions

Author: timfish

packages/core/src/baseclient.ts

@@ -620,7 +620,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
           this._updateSessionFromEvent(session, processedEvent);
         }
 
-        this._sendEvent(processedEvent, this._getAttachments(scope));
+        this._sendEvent(processedEvent, this._attachmentsFromScope(scope));
         return processedEvent;
       })
       .then(null, reason => {
@@ -657,8 +657,10 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
     );
   }
 
-  /** */
-  protected _getAttachments(scope: Scope | undefined): AttachmentItem[] | undefined {
+  /**
+   * Loads attachment items from scope
+   */
+  protected _attachmentsFromScope(scope: Scope | undefined): AttachmentItem[] | undefined {
     return scope?.getAttachments()?.map(a => createAttachmentEnvelopeItem(a));
   }
 

packages/node/src/client.ts

@@ -155,7 +155,7 @@ export class NodeClient extends BaseClient<NodeClientOptions> {
   /**
    * @inheritDoc
    */
-  protected _getAttachments(scope: Scope | undefined): AttachmentItem[] | undefined {
+  protected _attachmentsFromScope(scope: Scope | undefined): AttachmentItem[] | undefined {
     return scope?.getAttachments()?.map(attachment => {
       let [pathOrData, options] = attachment;
 

packages/node/src/transports/http.ts

@@ -30,7 +30,7 @@ const GZIP_THRESHOLD = 1024 * 32;
 
 /**
  * Gets a stream from a Uint8Array or string
- * We don't have Readable.from in earlier versions of node
+ * Readable.from was added in node.sj v12.3.0, v10.17.0
  */
 function streamFromBody(body: Uint8Array | string): Readable {
   return new Readable({

packages/types/src/scope.ts

@@ -160,9 +160,20 @@ export interface Scope {
    */
   clearBreadcrumbs(): this;
 
+  /**
+   * Adds an attachment to the scope
+   * @param pathOrData A Uint8Array containing the attachment bytes
+   * @param options Attachment options
+   */
   addAttachment(pathOrData: string | Uint8Array, options?: AttachmentOptions): this;
 
+  /**
+   * Returns an array of attachments on the scope
+   */
   getAttachments(): Attachment[];
 
+  /**
+   * Clears attachments from the scope
+   */
   clearAttachments(): this;
 }

packages/utils/src/attachment.ts

@@ -1,4 +1,4 @@
-import { Envelope } from '@sentry/types';
+import { Attachment, AttachmentItem, Envelope } from '@sentry/types';
 
 import { isPrimitive } from './is';
 
@@ -98,3 +98,23 @@ function concatBuffers(buffers: Uint8Array[]): Uint8Array {
 
   return merged;
 }
+
+/**
+ * Creates attachment envelope items
+ */
+export function createAttachmentEnvelopeItem(attachment: Attachment): AttachmentItem {
+  const [pathOrData, options] = attachment;
+
+  const buffer = typeof pathOrData === 'string' ? new TextEncoder().encode(pathOrData) : pathOrData;
+
+  return [
+    {
+      type: 'attachment',
+      length: buffer.length,
+      filename: options?.filename || 'No filename',
+      content_type: options?.contentType,
+      attachment_type: options?.attachmentType,
+    },
+    buffer,
+  ];
+}

packages/utils/src/envelope.ts

@@ -23,4 +23,3 @@ export * from './env';
 export * from './envelope';
 export * from './clientreport';
 export * from './ratelimit';
-export * from './attachment';