roarr - npm Package Compare versions

Comparing version 7.20.0 to 7.21.0

dist/utilities/stringify.js

@@ -7,2 +7,11 @@ "use strict";
     deterministic: false,
+    // The reason for the following values is because it is fairly easy
+    // to accidentally pass astronomically large objects to the logger.
+    // For context, we were debugging a UI slowdown that was caused by
+    // unknowingly trying to pass 5MB worth of data to the logger context.
+    //
+    // I am starting with hard limits for now to assess the impact of the changes,
+    // but we may want to make these configurable in the future.
+    maximumBreadth: 10,
+    maximumDepth: 10,
     strict: false,
@@ -16,2 +25,3 @@ });
     catch (error) {
+        // The only time I've seen this happen is when the value was excessively large.
         // eslint-disable-next-line no-console
@@ -18,0 +28,0 @@ console.error('[roarr] could not serialize value', value);

package.json

@@ -71,3 +71,3 @@ {
   "types": "./dist/Roarr.d.ts",
-  "version": "7.20.0"
+  "version": "7.21.0"
 }

src/utilities/stringify.ts

@@ -5,2 +5,11 @@ import { configure } from 'safe-stable-stringify';
   deterministic: false,
+  // The reason for the following values is because it is fairly easy
+  // to accidentally pass astronomically large objects to the logger.
+  // For context, we were debugging a UI slowdown that was caused by
+  // unknowingly trying to pass 5MB worth of data to the logger context.
+  //
+  // I am starting with hard limits for now to assess the impact of the changes,
+  // but we may want to make these configurable in the future.
+  maximumBreadth: 10,
+  maximumDepth: 10,
   strict: false,
@@ -13,2 +22,3 @@ });
   } catch (error) {
+    // The only time I've seen this happen is when the value was excessively large.
     // eslint-disable-next-line no-console
@@ -15,0 +25,0 @@ console.error('[roarr] could not serialize value', value);

No alert changes

Improved metrics

Total package byte prevSize

98422

increased by1.32%

Lines of code

1332

increased by1.52%

No dependency changes