sdk-core: PR suggestion changes

Author: perf2711

packages/sdk-core/src/common/jsonSize.ts

@@ -15,7 +15,7 @@ const booleanSize = (value: boolean) => (value ? 4 : 5);
 const undefinedSize = 0;
 const nullSize = 'null'.length;
 
-const arraySize = (array: unknown[], replacer?: (this: unknown, key: string, value: unknown) => unknown): number => {
+function arraySize(array: unknown[], replacer?: (this: unknown, key: string, value: unknown) => unknown): number {
     const bracketLength = 2;
     const commaLength = array.length - 1;
     let elementsLength = 0;
@@ -33,7 +33,7 @@ const arraySize = (array: unknown[], replacer?: (this: unknown, key: string, val
     }
 
     return bracketLength + commaLength + elementsLength;
-};
+}
 
 const objectSize = (obj: object, replacer?: (this: unknown, key: string, value: unknown) => unknown): number => {
     let jsonObject: object;
@@ -126,6 +126,15 @@ function _jsonSize(
     return 0;
 }
 
-export function jsonSize(value: unknown, replacer?: (this: unknown, key: string, value: unknown) => unknown) {
+/**
+ * Calculates size of the object as it would be serialized into JSON.
+ *
+ * _Should_ return the same value as `JSON.stringify(value, replacer).length`.
+ * This may not be 100% accurate, but should work for our requirements.
+ * @param value Value to compute length for.
+ * @param replacer A function that transforms the results as in `JSON.stringify`.
+ * @returns Final string length.
+ */
+export function jsonSize(value: unknown, replacer?: (this: unknown, key: string, value: unknown) => unknown): number {
     return _jsonSize(undefined, '', value, replacer);
 }

packages/sdk-core/src/model/configuration/BacktraceConfiguration.ts

@@ -86,7 +86,7 @@ export interface BacktraceBreadcrumbsSettings {
      * Use `false` to disable the limit.
      * @default 1048576 // 1MB
      */
-    maximumBreadcrumbsSize?: number | false;
+    maximumTotalBreadcrumbsSize?: number | false;
 
     /**
      * Inspects breadcrumb and allows to modify it. If the undefined value is being

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

@@ -56,7 +56,7 @@ export class BreadcrumbsManager implements BacktraceBreadcrumbs, BacktraceModule
             maximumAttributesDepth: defaultIfNotFalse(configuration?.maximumAttributesDepth, 2),
             maximumBreadcrumbMessageLength: defaultIfNotFalse(configuration?.maximumBreadcrumbMessageLength, 255),
             maximumBreadcrumbSize: defaultIfNotFalse(configuration?.maximumBreadcrumbSize, 64 * 1024),
-            maximumBreadcrumbsSize: defaultIfNotFalse(configuration?.maximumBreadcrumbsSize, 1024 * 1024),
+            maximumTotalBreadcrumbsSize: defaultIfNotFalse(configuration?.maximumTotalBreadcrumbsSize, 1024 * 1024),
         };
 
         this.breadcrumbsType = configuration?.eventType ?? defaultBreadcurmbType;

packages/sdk-core/src/modules/breadcrumbs/model/BreadcrumbLimits.ts

@@ -1,30 +1,39 @@
 export interface BreadcrumbLimits {
     /**
-     * Specifies maximum number of breadcrumbs stored by the library. By default, only 100 breadcrumbs
-     * will be stored.
+     * Specifies maximum number of breadcrumbs stored by the library.
+     *
+     * @default 100
      */
     readonly maximumBreadcrumbs?: number;
 
     /**
      * Specifies maximum object depth that are included in breadcrumb attributes.
+     *
+     * @default 2
      */
     readonly maximumAttributesDepth?: number;
 
     /**
      * Specifies maximum breadcrumb message length.
      * If the size is exceeded, message will be truncated.
+     *
+     * @default 255
      */
     readonly maximumBreadcrumbMessageLength?: number;
 
     /**
      * Specifies maximum single breadcrumb size in bytes.
      * If the size is exceeded, the breadcrumb will be skipped.
+     *
+     * @default 65536 // 64kB
      */
     readonly maximumBreadcrumbSize?: number;
 
     /**
      * Specifies maximum breadcrumbs size in bytes.
      * If the size is exceeded, oldest breadcrumbs will be skipped.
+     *
+     * @default 1048576 // 1MB
      */
-    readonly maximumBreadcrumbsSize?: number;
+    readonly maximumTotalBreadcrumbsSize?: number;
 }

packages/sdk-core/src/modules/breadcrumbs/storage/InMemoryBreadcrumbsStorage.ts

@@ -21,7 +21,7 @@ export class InMemoryBreadcrumbsStorage implements BreadcrumbsStorage, Backtrace
     private _breadcrumbs: OverwritingArray<Breadcrumb>;
 
     constructor(private readonly _limits: BreadcrumbsStorageLimits) {
-        this._breadcrumbs = new OverwritingArray<Breadcrumb>(_limits.maximumBreadcrumbs ?? Infinity);
+        this._breadcrumbs = new OverwritingArray<Breadcrumb>(_limits.maximumBreadcrumbs ?? 100);
     }
 
     public getAttachments(): BacktraceAttachment<unknown>[] {