node: use new AlternatingFileWriter with limits, add and use factory for FileBreadcrumbsStorage

Author: perf2711

packages/node/src/BacktraceClient.ts

@@ -43,13 +43,7 @@ export class BacktraceClient extends BacktraceCoreClient<BacktraceConfiguration>
 
         const breadcrumbsManager = this.modules.get(BreadcrumbsManager);
         if (breadcrumbsManager && this.sessionFiles) {
-            breadcrumbsManager.setStorage(
-                FileBreadcrumbsStorage.create(
-                    this.sessionFiles,
-                    fileSystem,
-                    clientSetup.options.breadcrumbs?.maximumBreadcrumbs ?? 100,
-                ),
-            );
+            breadcrumbsManager.setStorage(FileBreadcrumbsStorage.factory(this.sessionFiles, fileSystem));
         }
 
         if (this.sessionFiles && clientSetup.options.database?.captureNativeCrashes) {

packages/node/src/breadcrumbs/FileBreadcrumbsStorage.ts

@@ -3,13 +3,16 @@ import {
     Breadcrumb,
     BreadcrumbLogLevel,
     BreadcrumbsStorage,
+    BreadcrumbsStorageFactory,
+    BreadcrumbsStorageLimits,
     BreadcrumbType,
     jsonEscaper,
     RawBreadcrumb,
     SessionFiles,
     TimeHelper,
 } from '@backtrace/sdk-core';
 import path from 'path';
+import { Readable } from 'stream';
 import { BacktraceFileAttachment } from '../attachment';
 import { AlternatingFileWriter } from '../common/AlternatingFileWriter';
 import { NodeFileSystem } from '../storage/interfaces/NodeFileSystem';
@@ -28,14 +31,15 @@ export class FileBreadcrumbsStorage implements BreadcrumbsStorage {
     constructor(
         private readonly _mainFile: string,
         private readonly _fallbackFile: string,
-        fileSystem: NodeFileSystem,
-        maximumBreadcrumbs: number,
+        private readonly _fileSystem: NodeFileSystem,
+        private readonly _limits: BreadcrumbsStorageLimits,
     ) {
         this._writer = new AlternatingFileWriter(
+            _fileSystem,
             _mainFile,
             _fallbackFile,
-            Math.floor(maximumBreadcrumbs / 2),
-            fileSystem,
+            Math.floor((this._limits.maximumBreadcrumbs ?? 100) / 2),
+            this._limits.maximumBreadcrumbsSize,
         );
     }
 
@@ -52,19 +56,24 @@ export class FileBreadcrumbsStorage implements BreadcrumbsStorage {
             return undefined;
         }
 
-        return new FileBreadcrumbsStorage(files[0], files[1], fileSystem, 1);
+        return new FileBreadcrumbsStorage(files[0], files[1], fileSystem, {
+            maximumBreadcrumbs: 0,
+            maximumBreadcrumbsSize: 0,
+        });
     }
 
-    public static create(session: SessionFiles, fileSystem: NodeFileSystem, maximumBreadcrumbs: number) {
-        const file1 = session.getFileName(this.getFileName(0));
-        const file2 = session.getFileName(this.getFileName(1));
-        return new FileBreadcrumbsStorage(file1, file2, fileSystem, maximumBreadcrumbs);
+    public static factory(session: SessionFiles, fileSystem: NodeFileSystem): BreadcrumbsStorageFactory {
+        return ({ limits }) => {
+            const file1 = session.getFileName(this.getFileName(0));
+            const file2 = session.getFileName(this.getFileName(1));
+            return new FileBreadcrumbsStorage(file1, file2, fileSystem, limits);
+        };
     }
 
-    public getAttachments(): BacktraceAttachment<unknown>[] {
+    public getAttachments(): [BacktraceAttachment<Readable>, BacktraceAttachment<Readable>] {
         return [
-            new BacktraceFileAttachment(this._mainFile, 'bt-breadcrumbs-0'),
-            new BacktraceFileAttachment(this._fallbackFile, 'bt-breadcrumbs-1'),
+            new BacktraceFileAttachment(this._mainFile, 'bt-breadcrumbs-0', this._fileSystem),
+            new BacktraceFileAttachment(this._fallbackFile, 'bt-breadcrumbs-1', this._fileSystem),
         ];
     }
 
@@ -81,6 +90,14 @@ export class FileBreadcrumbsStorage implements BreadcrumbsStorage {
         };
 
         const breadcrumbJson = JSON.stringify(breadcrumb, jsonEscaper());
+        const jsonLength = breadcrumbJson.length + 1; // newline
+        const sizeLimit = this._limits.maximumBreadcrumbsSize;
+        if (sizeLimit !== undefined) {
+            if (jsonLength > sizeLimit) {
+                return id;
+            }
+        }
+
         this._writer.writeLine(breadcrumbJson);
 
         return id;