@ogcio/o11y-sdk-react 0.2.0 → 0.4.0

package/test/lib/pii-detection.test.ts

@@ -0,0 +1,79 @@
+import { TransportItemType } from "@grafana/faro-web-sdk";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { _cleanStringPII } from "../../lib/internals/redaction/pii-detection";
+
+// Mock faro.api.pushMeasurement
+vi.mock("@grafana/faro-web-sdk", async () => {
+  const actual = await vi.importActual<any>("@grafana/faro-web-sdk");
+  return {
+    ...actual,
+    faro: {
+      api: {
+        pushMeasurement: vi.fn(),
+      },
+    },
+  };
+});
+
+import { faro } from "@grafana/faro-web-sdk";
+import { redactors } from "../../lib/internals/redaction/redactors";
+
+describe("_cleanStringPII", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("should redact email and call pushMeasurement", () => {
+    const input = "Contact me at alice@example.com.";
+    const result = _cleanStringPII(input, TransportItemType.LOG, [
+      redactors.email,
+    ]);
+
+    expect(result).toBe("Contact me at [REDACTED EMAIL].");
+    expect(faro.api.pushMeasurement).toHaveBeenCalledOnce();
+    expect(faro.api.pushMeasurement).toHaveBeenCalledWith(
+      {
+        type: "faro_o11y_pii_redaction",
+        values: { redacted: 1 },
+      },
+      {
+        context: {
+          pii_type: "email",
+          redaction_source: TransportItemType.LOG,
+          pii_email_domain: "example.com",
+          pii_format: "string",
+        },
+      },
+    );
+  });
+
+  it("should decode and redact URI-encoded emails", () => {
+    const encoded = "mailto%3Ajohn.doe%40gmail.com";
+    const result = _cleanStringPII(encoded, TransportItemType.EXCEPTION, [
+      redactors.email,
+    ]);
+
+    expect(result).toBe("mailto:[REDACTED EMAIL]");
+    expect(faro.api.pushMeasurement).toHaveBeenCalledOnce();
+  });
+
+  it("should return same string when no email present", () => {
+    const input = "Just a normal message.";
+    const result = _cleanStringPII(input, TransportItemType.LOG, [
+      redactors.email,
+    ]);
+
+    expect(result).toBe(input);
+    expect(faro.api.pushMeasurement).not.toHaveBeenCalled();
+  });
+
+  it("should return same string when decodeURIComponent fail", () => {
+    const input = "mailto%john.doe%4gmail.com";
+    const result = _cleanStringPII(input, TransportItemType.LOG, [
+      redactors.email,
+    ]);
+
+    expect(result).toBe(input);
+    expect(faro.api.pushMeasurement).not.toHaveBeenCalled();
+  });
+});

package/vitest.config.ts

@@ -4,7 +4,7 @@ export default defineConfig({
   test: {
     globals: true,
     watch: false,
-    include: ["**/test/*.test.ts"],
+    include: ["**/*.test.ts"],
     exclude: ["**/fixtures/**", "**/dist/**"],
     poolOptions: {
       threads: {

package/test/index.test.ts

@@ -1,28 +0,0 @@
-import { describe, test, expect, vi } from "vitest";
-import { FaroSDKConfig } from "../lib";
-import { instrumentFaro } from "../index";
-
-vi.mock("../lib/instrumentation.faro", () => ({
-  default: vi.fn(),
-}));
-
-describe("instrumentFaro", () => {
-  test("should call buildFaroInstrumentation with the provided config", async () => {
-    const config: FaroSDKConfig = {
-      serviceName: "custom-service",
-      collectorUrl: "http://custom-collector.com",
-    };
-
-    const buildFaroInstrumentation = await import(
-      "../lib/instrumentation.faro"
-    );
-
-    instrumentFaro(config);
-
-    expect(buildFaroInstrumentation.default).toHaveBeenCalledWith(config);
-  });
-
-  test("should not throw when called without arguments", () => {
-    expect(() => instrumentFaro()).not.toThrow();
-  });
-});