@zudojs/observability 1.0.0 → 1.0.1

package/README.md

@@ -98,9 +98,11 @@ obs.logger.info("login", {
 ```
 
 Traversal handles the shapes secrets actually arrive in: arrays, nested
-objects, and cyclic graphs (a request object in a log context becomes
-`[CIRCULAR]` rather than a stack overflow). Class instances — `Error`, `Date`,
-`Map` — are left intact instead of being flattened to `{}`.
+objects, instances of your own classes (a DTO carrying a `password` field is
+redacted and keeps its prototype), and cyclic graphs (a request object in a log
+context becomes `[CIRCULAR]` rather than a stack overflow). Built-ins —
+`Error`, `Date`, `Map`, `Set`, typed arrays, `URL` — are left intact instead of
+being flattened to `{}`.
 
 `redactObject`, `redactValue` and `createStructureRedactor` are exported for
 use outside the logger.

package/dist/redaction/redaction.core.d.ts

@@ -8,8 +8,11 @@
  *     (`headers: [{ authorization: "Bearer …" }]`);
  *   - traversal is cycle-aware and depth-capped, because a request object in
  *     a log context is a graph, not a tree;
- *   - class instances are not walked as plain objects, so an `Error` or a
- *     `Date` survives instead of collapsing to `{}`;
+ *   - built-ins such as `Error`, `Date`, `Map` and `Set` are left intact
+ *     instead of collapsing to `{}`, while an instance of a user-defined
+ *     class is walked like a plain object — its own fields are what an
+ *     exporter serializes, so a DTO carrying a `password` must not slip
+ *     past the field list;
  *   - matching is substring-based by default, so `userPassword` and
  *     `x-api-key` are caught, not just the exact names in the list.
  */

package/dist/redaction/redaction.core.js

@@ -8,8 +8,11 @@
  *     (`headers: [{ authorization: "Bearer …" }]`);
  *   - traversal is cycle-aware and depth-capped, because a request object in
  *     a log context is a graph, not a tree;
- *   - class instances are not walked as plain objects, so an `Error` or a
- *     `Date` survives instead of collapsing to `{}`;
+ *   - built-ins such as `Error`, `Date`, `Map` and `Set` are left intact
+ *     instead of collapsing to `{}`, while an instance of a user-defined
+ *     class is walked like a plain object — its own fields are what an
+ *     exporter serializes, so a DTO carrying a `password` must not slip
+ *     past the field list;
  *   - matching is substring-based by default, so `userPassword` and
  *     `x-api-key` are caught, not just the exact names in the list.
  */
@@ -145,10 +148,48 @@ function isPlainContainer(value) {
     if (Array.isArray(value))
         return false;
     const prototype = Object.getPrototypeOf(value);
-    // Walk plain objects and null-prototype bags; leave Error, Date, Map, Set,
-    // Buffer and every other class instance intact.
     return prototype === Object.prototype || prototype === null;
 }
+/**
+ * Built-ins whose contents are not key/value fields: they are left intact
+ * rather than walked, because rebuilding them field by field would collapse
+ * a `Date` or a `Map` to `{}`.
+ */
+function isOpaqueBuiltin(value) {
+    return (value instanceof Date ||
+        value instanceof RegExp ||
+        value instanceof Error ||
+        value instanceof Map ||
+        value instanceof Set ||
+        value instanceof WeakMap ||
+        value instanceof WeakSet ||
+        value instanceof Promise ||
+        value instanceof ArrayBuffer ||
+        ArrayBuffer.isView(value) ||
+        value instanceof Number ||
+        value instanceof String ||
+        value instanceof Boolean ||
+        (typeof URL !== "undefined" && value instanceof URL) ||
+        (typeof URLSearchParams !== "undefined" && value instanceof URLSearchParams));
+}
+/**
+ * True for an instance of a user-defined class (a DTO, a request model).
+ *
+ * Its own enumerable fields are exactly what `JSON.stringify` — and so every
+ * exporter — writes out, so a `password` field on a class instance leaked
+ * through a redactor that only walked plain objects. Such an instance is
+ * walked like a plain object and rebuilt on the same prototype, so
+ * `instanceof` and any `toJSON` it defines survive.
+ */
+function isWalkableInstance(value) {
+    if (value === null || typeof value !== "object")
+        return false;
+    if (Array.isArray(value) || isPlainContainer(value))
+        return false;
+    if (isOpaqueBuiltin(value))
+        return false;
+    return Object.keys(value).length > 0;
+}
 function walk(value, compiled, depth, seen) {
     if (depth > compiled.maxDepth)
         return MAX_DEPTH_MARKER;
@@ -160,11 +201,11 @@ function walk(value, compiled, depth, seen) {
         seen.delete(value);
         return result;
     }
-    if (isPlainContainer(value)) {
+    if (isPlainContainer(value) || isWalkableInstance(value)) {
         if (seen.has(value))
             return CIRCULAR_MARKER;
         seen.add(value);
-        const result = {};
+        const result = Object.create(Object.getPrototypeOf(value));
         for (const [key, entry] of Object.entries(value)) {
             const redacted = redactField(key, entry, compiled);
             // A field the matcher replaced is done — never walk into it, or a

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@zudojs/observability",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Structured logging, metrics, tracing, context propagation, and exporters for Zudojs applications.",
   "license": "MIT",
+  "author": {
+    "name": "Oluwayemi Oyinlola",
+    "url": "https://github.com/oyinlola-tech"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -22,7 +26,7 @@
     "!dist/.tsbuildinfo"
   ],
   "dependencies": {
-    "@zudojs/errors": "1.0.0"
+    "@zudojs/errors": "1.0.1"
   },
   "devDependencies": {
     "typescript": "7.0.2",