Merge pull request #368 from backtrace-labs/bugfix/in-memory-attribute-support

sdk-core, node: In memory proper attribute filtering

Author: melekr

packages/node/src/breadcrumbs/FileBreadcrumbsStorage.ts

@@ -1,5 +1,4 @@
 import {
-    AttributeType,
     BacktraceAttachment,
     BacktraceAttachmentProvider,
     Breadcrumb,
@@ -108,7 +107,7 @@ export class FileBreadcrumbsStorage implements BreadcrumbsStorage {
             timestamp: TimeHelper.now(),
             type: BreadcrumbType[rawBreadcrumb.type].toLowerCase(),
             level: BreadcrumbLogLevel[rawBreadcrumb.level].toLowerCase(),
-            attributes: this.prepareAttributes(rawBreadcrumb.attributes),
+            attributes: rawBreadcrumb.attributes,
         };
         const breadcrumbJson = JSON.stringify(breadcrumb, jsonEscaper());
         const jsonLength = breadcrumbJson.length + 1; // newline
@@ -123,46 +122,6 @@ export class FileBreadcrumbsStorage implements BreadcrumbsStorage {
         return id;
     }
 
-    private prepareAttributes(attributes?: Record<string, AttributeType>): Record<string, AttributeType> | undefined {
-        const result: Record<string, AttributeType> = {};
-        if (!attributes) {
-            return undefined;
-        }
-        for (const key in attributes) {
-            const value = attributes[key];
-            switch (typeof value) {
-                case 'number':
-                case 'boolean':
-                case 'string':
-                case 'undefined':
-                    result[key] = value;
-                    break;
-                case 'bigint':
-                    result[key] = (value as bigint).toString();
-                    break;
-                case 'object': {
-                    if (!value) {
-                        result[key] = value;
-                        break;
-                    }
-                    const unknownValue = value as unknown;
-                    try {
-                        if (unknownValue instanceof Date) {
-                            result[key] = unknownValue.toISOString();
-                        } else if (unknownValue instanceof URL) {
-                            result[key] = unknownValue.toString();
-                        }
-                    } catch {
-                        // revoked proxy or broken object — drop it
-                    }
-                    // drop all other objects
-                    break;
-                }
-            }
-        }
-        return result;
-    }
-
     private static getFileName(index: number) {
         return `${FILE_PREFIX}-${index}`;
     }

packages/sdk-core/src/modules/breadcrumbs/BreadcrumbsManager.ts

@@ -185,6 +185,13 @@ export class BreadcrumbsManager implements BacktraceBreadcrumbs, BacktraceModule
             rawBreadcrumb.message = rawBreadcrumb.message.substring(0, this._limits.maximumBreadcrumbMessageLength);
         }
 
+        if (rawBreadcrumb.attributes) {
+            rawBreadcrumb = {
+                ...rawBreadcrumb,
+                attributes: this.prepareAttributes(rawBreadcrumb.attributes),
+            };
+        }
+
         let limitedBreadcrumb: RawBreadcrumb | LimitedRawBreadcrumb;
         if (this._limits.maximumAttributesDepth !== undefined && rawBreadcrumb.attributes) {
             limitedBreadcrumb = {
@@ -207,6 +214,43 @@ export class BreadcrumbsManager implements BacktraceBreadcrumbs, BacktraceModule
         return id !== undefined;
     }
 
+    private prepareAttributes(attributes: Record<string, AttributeType>): Record<string, AttributeType> {
+        const result: Record<string, AttributeType> = {};
+        for (const key in attributes) {
+            const value = attributes[key];
+            switch (typeof value) {
+                case 'number':
+                case 'boolean':
+                case 'string':
+                case 'undefined':
+                    result[key] = value;
+                    break;
+                case 'bigint':
+                    result[key] = (value as bigint).toString();
+                    break;
+                case 'object': {
+                    if (!value) {
+                        result[key] = value;
+                        break;
+                    }
+                    const unknownValue = value as unknown;
+                    try {
+                        if (unknownValue instanceof Date) {
+                            result[key] = unknownValue.toISOString();
+                        } else if (unknownValue instanceof URL) {
+                            result[key] = unknownValue.toString();
+                        }
+                    } catch {
+                        // revoked proxy or broken object — drop it
+                    }
+                    // drop all other objects
+                    break;
+                }
+            }
+        }
+        return result;
+    }
+
     /**
      * The expectation is, message should always be defined and passed as string.
      * However, logger can pass as a message an object or any other unknown type.