@ogcio/o11y-sdk-node 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.3.1](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.3.0...@ogcio/o11y-sdk-node@v0.3.1) (2025-07-31)
+
+
+### Bug Fixes
+
+* **sdk-node:** replace Object.assign with spread operator on log redaction ([#186](https://github.com/ogcio/o11y/issues/186)) ([432f8d6](https://github.com/ogcio/o11y/commit/432f8d6aa493fd01d093f7ecdd0a9faccd0726e9))
+
 ## [0.3.0](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.2.0...@ogcio/o11y-sdk-node@v0.3.0) (2025-07-28)
 
 

package/dist/lib/exporter/pii-exporter-decorator.d.ts

@@ -1,9 +1,9 @@
 import { ExportResult } from "@opentelemetry/core";
 import { OTLPExporterBase } from "@opentelemetry/otlp-exporter-base";
 import { ReadableLogRecord } from "@opentelemetry/sdk-logs";
+import { PushMetricExporter, ResourceMetrics } from "@opentelemetry/sdk-metrics";
 import { ReadableSpan, SpanExporter } from "@opentelemetry/sdk-trace-base";
 import { NodeSDKConfig } from "../index.js";
-import { PushMetricExporter, ResourceMetrics } from "@opentelemetry/sdk-metrics";
 export declare class PIIExporterDecorator extends OTLPExporterBase<(ReadableSpan | ReadableLogRecord)[] | ResourceMetrics> implements SpanExporter, PushMetricExporter {
     private readonly _exporter;
     private readonly _config;

package/dist/lib/exporter/pii-exporter-decorator.js

@@ -25,7 +25,7 @@ export class PIIExporterDecorator extends OTLPExporterBase {
                     this._redactSpan(item);
                 }
                 else if (this._isReadableLogRecord(item)) {
-                    this._redactLogRecord(item);
+                    item = this._redactLogRecord(item);
                 }
                 return item;
             });
@@ -83,14 +83,15 @@ export class PIIExporterDecorator extends OTLPExporterBase {
         });
     }
     _redactLogRecord(log) {
-        Object.assign(log, {
+        return {
+            ...log,
             body: _cleanLogBodyPII(log.body),
             attributes: log.attributes && _cleanObjectPII(log.attributes, "log"),
-            resource: {
-                attributes: log?.resource?.attributes &&
-                    _cleanObjectPII(log.resource.attributes, "log"),
+            resource: log.resource && {
+                ...log.resource,
+                attributes: _cleanObjectPII(log.resource.attributes, "log"),
             },
-        });
+        };
     }
     _redactResourceMetrics(metric) {
         Object.assign(metric, {

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ogcio/o11y-sdk-node",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
     "main": "dist/index.js",
     "type": "module",

package/lib/exporter/pii-exporter-decorator.ts

@@ -1,6 +1,10 @@
 import { ExportResult } from "@opentelemetry/core";
 import { OTLPExporterBase } from "@opentelemetry/otlp-exporter-base";
 import { ReadableLogRecord } from "@opentelemetry/sdk-logs";
+import {
+  PushMetricExporter,
+  ResourceMetrics,
+} from "@opentelemetry/sdk-metrics";
 import { ReadableSpan, SpanExporter } from "@opentelemetry/sdk-trace-base";
 import { NodeSDKConfig } from "../index.js";
 import {
@@ -8,10 +12,6 @@ import {
   _cleanObjectPII,
   _cleanStringPII,
 } from "../internals/pii-detection.js";
-import {
-  PushMetricExporter,
-  ResourceMetrics,
-} from "@opentelemetry/sdk-metrics";
 
 export class PIIExporterDecorator
   extends OTLPExporterBase<
@@ -55,7 +55,7 @@ export class PIIExporterDecorator
         if (this._isReadableSpan(item)) {
           this._redactSpan(item);
         } else if (this._isReadableLogRecord(item)) {
-          this._redactLogRecord(item);
+          item = this._redactLogRecord(item) as ReadableLogRecord;
         }
         return item;
       });
@@ -129,15 +129,15 @@ export class PIIExporterDecorator
   }
 
   private _redactLogRecord(log: ReadableLogRecord) {
-    Object.assign(log, {
+    return {
+      ...log,
       body: _cleanLogBodyPII(log.body),
       attributes: log.attributes && _cleanObjectPII(log.attributes, "log"),
-      resource: {
-        attributes:
-          log?.resource?.attributes &&
-          _cleanObjectPII(log.resource.attributes, "log"),
+      resource: log.resource && {
+        ...log.resource,
+        attributes: _cleanObjectPII(log.resource.attributes, "log"),
       },
-    });
+    };
   }
 
   private _redactResourceMetrics(metric: ResourceMetrics) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ogcio/o11y-sdk-node",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
   "main": "dist/index.js",
   "type": "module",

package/test/exporter/pii-exporter-decorator.test.ts

@@ -1,139 +1,88 @@
-import type { ReadableLogRecord } from "@opentelemetry/sdk-logs";
-import type { ReadableSpan } from "@opentelemetry/sdk-trace-base";
+import { ReadableLogRecord } from "@opentelemetry/sdk-logs";
+import { ResourceMetrics } from "@opentelemetry/sdk-metrics";
+import { ReadableSpan } from "@opentelemetry/sdk-trace-base";
 import { beforeEach, describe, expect, it, vi } from "vitest";
-import type { NodeSDKConfig } from "../../index.js";
-import { PIIExporterDecorator } from "../../lib/exporter/pii-exporter-decorator.js";
-import * as pii from "../../lib/internals/pii-detection.js";
-
-const mockExporter = {
-  export: vi.fn(),
-  forceFlush: vi.fn().mockResolvedValue(undefined),
-  shutdown: vi.fn().mockResolvedValue(undefined),
-  _delegate: {}, // required by OTLPExporterBase
-};
-
-const mockCallback = vi.fn();
-
-const baseSpan = (): ReadableSpan =>
-  ({
-    name: "john.doe@example.com",
-    kind: 1,
-    spanContext: () => ({ traceId: "abc", spanId: "def" }),
-    attributes: { email: "john.doe@example.com" },
-    resource: {
-      attributes: { team: "dev@example.com" },
-      otherProp: "shouldBeLost",
-    },
-    links: [{ attributes: { collaborator: "co@example.com" } }],
-    events: [{ name: "event@email.com", attributes: { code: "123" } }],
-  }) as any;
-
-const baseLog = (): ReadableLogRecord =>
-  ({
-    body: "user: john.doe@example.com",
-    attributes: { email: "john.doe@example.com" },
-    resource: {
-      attributes: { service: "log@example.com" },
-      otherProp: "shouldBeLost",
-    },
-    severityText: "INFO",
-    severityNumber: 1,
-  }) as any;
-
-vi.mock("../../lib/internals/pii-detection.js", async () => {
-  return {
-    _cleanStringPII: vi.fn((v: string) => `[REDACTED(${v})]`),
-    _cleanObjectPII: vi.fn((obj: any) =>
-      Object.fromEntries(
-        Object.entries(obj || {}).map(([k, v]) => [k, `[REDACTED(${v})]`]),
-      ),
-    ),
-    _cleanLogBodyPII: vi.fn((v: any) => `[REDACTED_BODY(${v})]`),
-  };
-});
+import { PIIExporterDecorator } from "../../lib/exporter/pii-exporter-decorator";
 
 describe("PIIExporterDecorator", () => {
-  let decorator: PIIExporterDecorator;
+  let exporterMock: any;
+  let config: any;
+  let piiExporter: PIIExporterDecorator;
 
   beforeEach(() => {
-    vi.clearAllMocks();
+    exporterMock = {
+      export: vi.fn(),
+      shutdown: vi.fn(() => Promise.resolve()),
+      forceFlush: vi.fn(() => Promise.resolve()),
+      _delegate: {},
+    };
+
+    config = { detection: { email: true } };
+    piiExporter = new PIIExporterDecorator(exporterMock, config);
   });
 
-  it("delegates forceFlush and shutdown", async () => {
-    const config: NodeSDKConfig = {};
-    decorator = new PIIExporterDecorator(mockExporter as any, config);
-
-    await decorator.forceFlush();
-    await decorator.shutdown();
-
-    expect(mockExporter.forceFlush).toHaveBeenCalled();
-    expect(mockExporter.shutdown).toHaveBeenCalled();
+  it("should redact emails in span name and attributes", () => {
+    const items: ReadableSpan[] = [
+      {
+        name: "user@example.com",
+        kind: 0,
+        spanContext: () => ({}),
+        attributes: { email: "user@example.com" },
+        resource: { attributes: { owner: "user@example.com" } },
+        events: [
+          {
+            name: "Login from user@example.com",
+            attributes: { email: "user@example.com" },
+          },
+        ],
+      } as any,
+    ];
+
+    const callback = vi.fn();
+    piiExporter.export(items, callback);
+
+    const exportedSpan = exporterMock.export.mock.calls[0][0][0];
+    expect(exportedSpan.name).toBe("[REDACTED EMAIL]");
+    expect(exportedSpan.attributes.email).toBe("[REDACTED EMAIL]");
+    expect(exportedSpan.resource.attributes.owner).toBe("[REDACTED EMAIL]");
+    expect(exportedSpan.events[0].name).toBe("Login from [REDACTED EMAIL]");
+    expect(exportedSpan.events[0].attributes.email).toBe("[REDACTED EMAIL]");
   });
 
-  it("skips redaction if detection.email is false", () => {
-    const config: NodeSDKConfig = { detection: { email: false } };
-    decorator = new PIIExporterDecorator(mockExporter as any, config);
-
-    const spans = [baseSpan()];
-    decorator.export(spans, mockCallback);
-
-    expect(mockExporter.export).toHaveBeenCalledWith(spans, mockCallback);
-    expect(pii._cleanStringPII).not.toHaveBeenCalled();
-    expect(pii._cleanObjectPII).not.toHaveBeenCalled();
+  it("should redact emails in log records", () => {
+    const items: ReadableLogRecord[] = [
+      {
+        body: "Error from user@example.com",
+        attributes: { email: "user@example.com" },
+        severityText: "INFO",
+        severityNumber: 1,
+        resource: { attributes: { owner: "user@example.com" } },
+      } as any,
+    ];
+
+    const callback = vi.fn();
+    piiExporter.export(items, callback);
+
+    const exportedLog = exporterMock.export.mock.calls[0][0][0];
+    expect(exportedLog.body).toBe("Error from [REDACTED EMAIL]");
+    expect(exportedLog.attributes.email).toBe("[REDACTED EMAIL]");
+    expect(exportedLog.resource.attributes.owner).toBe("[REDACTED EMAIL]");
   });
 
-  it("redacts span data if detection.email is true", () => {
-    const config: NodeSDKConfig = { detection: { email: true } };
-    decorator = new PIIExporterDecorator(mockExporter as any, config);
-
-    const span = baseSpan();
-    decorator.export([span], mockCallback);
-
-    expect(pii._cleanStringPII).toHaveBeenCalled();
-    expect(pii._cleanObjectPII).toHaveBeenCalled();
-    expect(mockExporter.export).toHaveBeenCalledWith([span], mockCallback);
-
-    // verify name and nested structure were touched
-    expect(span.name).toMatch(/^\[REDACTED\(/);
-    expect(span.attributes.email).toMatch(/^\[REDACTED\(/);
-
-    // Resource is replaced with only attributes, old props lost
-    expect(span.resource).toEqual({
-      attributes: { team: "[REDACTED(dev@example.com)]" },
-    });
-
-    expect(span.events[0].name).toMatch(/^\[REDACTED\(/);
-  });
-
-  it("redacts log record data if detection.email is true", () => {
-    const config: NodeSDKConfig = { detection: { email: true } };
-    decorator = new PIIExporterDecorator(mockExporter as any, config);
-
-    const log = baseLog();
-    decorator.export([log], mockCallback);
-
-    expect(pii._cleanLogBodyPII).toHaveBeenCalled();
-    expect(pii._cleanObjectPII).toHaveBeenCalled();
-
-    expect(log.body).toMatch(/^\[REDACTED_BODY\(/);
-    expect(log.attributes.email).toMatch(/^\[REDACTED\(/);
-
-    // Resource replaced with only attributes, other props lost
-    expect(log.resource).toEqual({
-      attributes: { service: "[REDACTED(log@example.com)]" },
-    });
-  });
-
-  it("handles a mix of spans and logs", () => {
-    const config: NodeSDKConfig = { detection: { email: true } };
-    decorator = new PIIExporterDecorator(mockExporter as any, config);
-
-    const items = [baseSpan(), baseLog()];
-    decorator.export(items, mockCallback);
-
-    expect(mockExporter.export).toHaveBeenCalledWith(items, mockCallback);
-    expect(pii._cleanLogBodyPII).toHaveBeenCalled();
-    expect(pii._cleanStringPII).toHaveBeenCalled();
-    expect(pii._cleanObjectPII).toHaveBeenCalled();
+  it("should redact emails in resource metrics", () => {
+    const metrics: ResourceMetrics = {
+      resource: {
+        attributes: { maintainer: "user@example.com" },
+      },
+      scopeMetrics: [],
+    } as any;
+
+    const callback = vi.fn();
+    piiExporter.export(metrics, callback);
+
+    const exportedMetric = exporterMock.export.mock.calls[0][0];
+    expect(exportedMetric.resource.attributes.maintainer).toBe(
+      "[REDACTED EMAIL]",
+    );
   });
 });