sdk-core: reduce breadcrumb size PR changes

Author: perf2711

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

@@ -1,3 +1,5 @@
+type JsonReplacer = (this: unknown, key: string, value: unknown) => unknown;
+
 function stringifiedSize<T>(value: T): number {
     return JSON.stringify(value).length;
 }
@@ -15,7 +17,7 @@ const booleanSize = (value: boolean) => (value ? 4 : 5);
 const undefinedSize = 0;
 const nullSize = 'null'.length;
 
-function arraySize(array: unknown[], replacer?: (this: unknown, key: string, value: unknown) => unknown): number {
+function arraySize(array: unknown[], replacer?: JsonReplacer): number {
     const bracketLength = 2;
     const commaLength = array.length - 1;
     let elementsLength = 0;
@@ -35,7 +37,7 @@ function 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 => {
+const objectSize = (obj: object, replacer?: JsonReplacer): number => {
     const entries = Object.entries(obj);
     const bracketLength = 2;
 
@@ -49,9 +51,12 @@ const objectSize = (obj: object, replacer?: (this: unknown, key: string, value:
         }
 
         entryCount++;
+
+        // +1 adds the comma size
         entriesLength += keySize(k) + valueSize + 1;
     }
 
+    // -1 removes previously added last comma size (there is no trailing comma)
     const commaLength = Math.max(0, entryCount - 1);
 
     return bracketLength + commaLength + entriesLength;
@@ -74,18 +79,13 @@ function keySize(key: unknown): number {
         case 'boolean':
             return booleanSize(key) + QUOTE_SIZE;
         case 'symbol':
-            return 0; // key not used in JSON
+            return symbolSize; // key not used in JSON
         default:
             return stringSize(key.toString());
     }
 }
 
-function _jsonSize(
-    parent: unknown,
-    key: string,
-    value: unknown,
-    replacer?: (this: unknown, key: string, value: unknown) => unknown,
-): number {
+function _jsonSize(parent: unknown, key: string, value: unknown, replacer?: JsonReplacer): number {
     if (value && typeof value === 'object' && 'toJSON' in value && typeof value.toJSON === 'function') {
         value = value.toJSON() as object;
     }
@@ -132,6 +132,6 @@ function _jsonSize(
  * @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 {
+export function jsonSize(value: unknown, replacer?: JsonReplacer): number {
     return _jsonSize(undefined, '', value, replacer);
 }

packages/sdk-core/src/dataStructures/OverwritingArray.ts

@@ -34,7 +34,14 @@ export class OverwritingArray<T> {
         items?: T[],
     ) {
         this._array = new Array(capacity);
+
+        // Head must be always between 0 and capacity.
+        // If lower than 0, it needs to go from the end
+        // If larger than capacity, it needs to go from the start
+        // Wrapping solves this
         this._headConstraint = wrapped(0, capacity);
+
+        // Length must be always no less than 0 and no larger than capacity
         this._lengthConstraint = clamped(0, capacity);
 
         if (items) {

packages/sdk-core/src/dataStructures/numbers.ts

@@ -1,5 +1,17 @@
 export type ConstrainedNumber = (value: number) => number;
 
+/**
+ * Constrains `value` to `min` and `max` values, wrapping not matching values around.
+ * @param min minimum value to allow
+ * @param max maximum value to allow
+ * @returns function accepting `value`
+ *
+ * @example
+ * const wrap = wrapped(10, 20);
+ * console.log(wrap(15)); // 15
+ * console.log(wrap(21)); // 10, wrapped around
+ * console.log(wrap(8)); // 18, wrapped around
+ */
 export function wrapped(min: number, max: number): ConstrainedNumber {
     function wrapped(value: number) {
         const range = max - min;
@@ -23,6 +35,18 @@ export function wrapped(min: number, max: number): ConstrainedNumber {
     return wrapped;
 }
 
+/**
+ * Constrains `value` to `min` and `max` values.
+ * @param min minimum value to allow
+ * @param max maximum value to allow
+ * @returns function accepting `value`
+ *
+ * @example
+ * const clamp = clamped(10, 20);
+ * console.log(wrap(15)); // 15
+ * console.log(wrap(21)); // 20
+ * console.log(wrap(8)); // 10
+ */
 export function clamped(min: number, max: number): ConstrainedNumber {
     function clamped(value: number) {
         return Math.max(min, Math.min(value, max));

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

@@ -182,10 +182,7 @@ export class BreadcrumbsManager implements BacktraceBreadcrumbs, BacktraceModule
         }
 
         if (this._limits.maximumBreadcrumbMessageLength !== undefined) {
-            rawBreadcrumb = {
-                ...rawBreadcrumb,
-                message: rawBreadcrumb.message.substring(0, this._limits.maximumBreadcrumbMessageLength),
-            };
+            rawBreadcrumb.message = rawBreadcrumb.message.substring(0, this._limits.maximumBreadcrumbMessageLength);
         }
 
         let limitedBreadcrumb: RawBreadcrumb | LimitedRawBreadcrumb;

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

@@ -17,7 +17,7 @@ export interface BreadcrumbsStorageLimits {
      * Specifies maximum breadcrumbs size in bytes.
      * If the size is exceeded, oldest breadcrumbs will be skipped.
      */
-    readonly maximumBreadcrumbsSize?: number;
+    readonly maximumTotalBreadcrumbsSize?: number;
 }
 
 export type BreadcrumbsStorageFactory = (options: BreadcrumbsStorageOptions) => BreadcrumbsStorage;

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

@@ -70,12 +70,12 @@ export class InMemoryBreadcrumbsStorage implements BreadcrumbsStorage, Backtrace
 
         this._breadcrumbs.add(breadcrumb);
 
-        if (this._limits.maximumBreadcrumbsSize) {
+        if (this._limits.maximumTotalBreadcrumbsSize) {
             const size = jsonSize(breadcrumb, jsonEscaper());
             this._breadcrumbSizes.add(size);
 
             let totalSize = this.totalSize();
-            while (totalSize > this._limits.maximumBreadcrumbsSize) {
+            while (totalSize > this._limits.maximumTotalBreadcrumbsSize) {
                 this._breadcrumbs.shift();
                 const removedSize = this._breadcrumbSizes.shift() ?? 0;
 

packages/sdk-core/tests/breadcrumbs/InMemoryBreadcrumbsStorage.spec.ts

@@ -162,7 +162,7 @@ describe('InMemoryBreadcrumbsStorage', () => {
         const size = JSON.stringify(expected).length;
         const storage = new InMemoryBreadcrumbsStorage({
             maximumBreadcrumbs: 100,
-            maximumBreadcrumbsSize: size,
+            maximumTotalBreadcrumbsSize: size,
         });
 
         for (const breadcrumb of breadcrumbs) {