@ogcio/o11y-sdk-react 0.4.0 → 0.6.0

package/test/lib/internals/redactors/email.test.ts

@@ -1,81 +0,0 @@
-import { describe, expect, it, vi, beforeEach, afterAll } from "vitest";
-
-import { emailRedactor } from "../../../../lib/internals/redaction/redactors/email";
-import { ipRedactor } from "../../../../lib/internals/redaction/redactors/ip";
-import { faro, TransportItemType } from "@grafana/faro-web-sdk";
-
-// 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(),
-      },
-    },
-  };
-});
-
-describe("Email Redaction utils", () => {
-  afterAll(() => {
-    vi.restoreAllMocks();
-  });
-
-  describe("tracks metrics", () => {
-    beforeEach(() => {
-      vi.clearAllMocks();
-    });
-
-    it("redacts plain PII and tracks redaction with metric", () => {
-      const input = "admin@example.com";
-      const output = emailRedactor(input, "log", "string");
-
-      expect(output).toBe("[REDACTED EMAIL]");
-      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("handles strings without PII unchanged", () => {
-      const input = "hello world";
-      const output = ipRedactor(input, "log", "string");
-
-      expect(output).toBe("hello world");
-      expect(faro.api.pushMeasurement).not.toHaveBeenCalled();
-    });
-  });
-
-  describe("Redacts email addresses", () => {
-    it.each`
-      value                                  | expectedRedactedValue
-      ${"user+tag@example.com"}              | ${"[REDACTED EMAIL]"}
-      ${"user.name+tag+sorting@example.com"} | ${"[REDACTED EMAIL]"}
-      ${"x@example.museum"}                  | ${"[REDACTED EMAIL]"}
-      ${"a.b-c_d@example.co.uk"}             | ${"[REDACTED EMAIL]"}
-      ${"üser@example.de"}                   | ${"[REDACTED EMAIL]"}
-      ${"john.doe@xn--exmple-cua.com"}       | ${"[REDACTED EMAIL]"}
-      ${"üser@example.de"}                   | ${"[REDACTED EMAIL]"}
-      ${"plainaddress"}                      | ${"plainaddress"}
-      ${"@missinglocal.org"}                 | ${"@missinglocal.org"}
-      ${"user@invalid_domain.com"}           | ${"user@invalid_domain.com"}
-    `(
-      "returns $expectedRedactedValue for value '$value'",
-      async ({ value, expectedRedactedValue }: Record<string, string>) => {
-        const result = emailRedactor(value, "log", "string");
-        expect(result).toBe(expectedRedactedValue);
-      },
-    );
-  });
-});

package/test/lib/internals/redactors/ip.test.ts

@@ -1,86 +0,0 @@
-import { describe, expect, it, vi, afterAll } from "vitest";
-
-import { faro } from "@grafana/faro-web-sdk";
-import { ipRedactor } from "../../../../lib/internals/redaction/redactors/ip";
-
-// 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(),
-      },
-    },
-  };
-});
-
-describe("IP Redaction utils", () => {
-  afterAll(() => {
-    vi.restoreAllMocks();
-  });
-
-  describe("tracks metrics", () => {
-    it("redacts plain PII and tracks redaction with metric", () => {
-      const input = "255.255.255.255";
-      const output = ipRedactor(input, "log", "string");
-
-      expect(output).toBe("[REDACTED IPV4]");
-      expect(faro.api.pushMeasurement).toHaveBeenCalledWith(
-        {
-          type: "faro_o11y_pii_redaction",
-          values: {
-            redacted: 1,
-          },
-        },
-        {
-          context: {
-            pii_format: "string",
-            pii_type: "IPv4",
-            redaction_source: "log",
-          },
-        },
-      );
-    });
-
-    it("handles strings without PII unchanged", () => {
-      const input = "hello world";
-      const output = ipRedactor(input, "log", "string");
-
-      expect(output).toBe("hello world");
-      expect(faro.api.pushMeasurement).not.toHaveBeenCalled();
-    });
-  });
-
-  describe("Redacts IPv4 and IPv6", () => {
-    it.each`
-      value                                           | expectedRedactedValue
-      ${"hello world"}                                | ${"hello world"}
-      ${"hello 127.0.0.1"}                            | ${"hello [REDACTED IPV4]"}
-      ${"127.0.0.1, hello!"}                          | ${"[REDACTED IPV4], hello!"}
-      ${"127.0.0.1,127.0.0.1"}                        | ${"[REDACTED IPV4],[REDACTED IPV4]"}
-      ${"127.0.0.1127.0.0.1"}                         | ${"127.0.0.1127.0.0.1"}
-      ${"256.1.1.1"}                                  | ${"256.1.1.1"}
-      ${"0.0.0.0!"}                                   | ${"[REDACTED IPV4]!"}
-      ${"text0.0.0.0"}                                | ${"text[REDACTED IPV4]"}
-      ${"0.0.text0.0"}                                | ${"0.0.text0.0"}
-      ${"2001:0db8::1"}                               | ${"[REDACTED IPV6]"}
-      ${"::1"}                                        | ${"[REDACTED IPV6]"}
-      ${"text::1"}                                    | ${"text[REDACTED IPV6]"}
-      ${"::1text"}                                    | ${"[REDACTED IPV6]text"}
-      ${"sentence ending with f::1"}                  | ${"sentence ending with [REDACTED IPV6]"}
-      ${"sentence ending with :::1"}                  | ${"sentence ending with :::1"}
-      ${"2001:0DB8:85A3:0000:0000:8A2E:0370:7334::1"} | ${"2001:0DB8:85A3:0000:0000:8A2E:0370:7334::1"}
-      ${"2001:0DB8:85A3:0000:text:8A2E:0370:7334"}    | ${"2001:0DB8:85A3:0000:text:8A2E:0370:7334"}
-      ${"2001:0db8::12001:0db8::1"}                   | ${"2001:0db8::12001:0db8::1"}
-      ${"2001:0db8::1,2001:0db8::1"}                  | ${"[REDACTED IPV6],[REDACTED IPV6]"}
-    `(
-      "returns $expectedRedactedValue for value '$value'",
-      async ({ value, expectedRedactedValue }: Record<string, string>) => {
-        const result = ipRedactor(value, "log", "string");
-        expect(result).toBe(expectedRedactedValue);
-      },
-    );
-  });
-});

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

@@ -1,79 +0,0 @@
-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/test/validation.test.ts

@@ -1,65 +0,0 @@
-import { test, describe, assert, vi, expect } from "vitest";
-import buildFaroInstrumentation from "../lib/instrumentation.faro.js";
-import { Faro } from "@grafana/faro-react";
-import { instrumentFaro } from "../index.js";
-
-describe("validation config: should return without breaking the execution", () => {
-  test("should call buildFaroInstrumentation without config and skip instrumentation", async () => {
-    const consoleWarnSpy = vi
-      .spyOn(console, "warn")
-      .mockImplementation(vi.fn());
-
-    instrumentFaro();
-
-    expect(consoleWarnSpy).toHaveBeenCalled();
-    expect(consoleWarnSpy).toHaveBeenCalledWith(
-      "observability config not set. Skipping Faro OpenTelemetry instrumentation.",
-    );
-  });
-
-  test("faro instrumentation: url undefined", () => {
-    let sdk: Faro | undefined = undefined;
-
-    const consoleWarnSpy = vi
-      .spyOn(console, "warn")
-      .mockImplementation(vi.fn());
-    const consoleLogSpy = vi.spyOn(console, "log").mockImplementation(vi.fn());
-
-    assert.doesNotThrow(() => {
-      sdk = buildFaroInstrumentation({
-        collectorUrl: undefined!,
-      });
-    });
-
-    assert.equal(sdk, undefined);
-
-    expect(consoleWarnSpy).toHaveBeenCalled();
-    expect(consoleWarnSpy).toHaveBeenCalledWith(
-      "collectorUrl not set. Skipping Faro OpenTelemetry instrumentation.",
-    );
-    expect(consoleLogSpy).not.toHaveBeenCalled();
-  });
-
-  test("faro instrumentation: invalid url", () => {
-    let sdk: Faro | undefined = undefined;
-
-    const consoleErrorSpy = vi
-      .spyOn(console, "error")
-      .mockImplementation(vi.fn());
-    const consoleLogSpy = vi.spyOn(console, "log").mockImplementation(vi.fn());
-
-    assert.doesNotThrow(() => {
-      sdk = buildFaroInstrumentation({
-        collectorUrl: "notavalidURL",
-      });
-    });
-
-    assert.equal(sdk, undefined);
-
-    expect(consoleErrorSpy).toHaveBeenCalled();
-    expect(consoleErrorSpy).toHaveBeenCalledWith(
-      "collectorUrl does not use a valid format. Skipping Faro OpenTelemetry instrumentation.",
-    );
-    expect(consoleLogSpy).not.toHaveBeenCalled();
-  });
-});

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-    "module": "NodeNext" /* Specify what module code is generated. */,
-    "outDir": "./dist" /* Specify an output folder for all emitted files. */,
-    "moduleResolution": "NodeNext",
-    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
-    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-    "strict": true /* Enable all strict type-checking options. */,
-    "skipLibCheck": true /* Skip type checking all .d.ts files. */,
-    "declaration": true
-  },
-  "exclude": ["**/test/**"]
-}

package/vitest.config.ts

@@ -1,26 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    globals: true,
-    watch: false,
-    include: ["**/*.test.ts"],
-    exclude: ["**/fixtures/**", "**/dist/**"],
-    poolOptions: {
-      threads: {
-        maxThreads: 8,
-      },
-    },
-    clearMocks: true,
-    testTimeout: 30_000,
-    coverage: {
-      enabled: true,
-      provider: "v8",
-      reportsDirectory: "coverage",
-      reporter: ["lcov", "cobertura"],
-      clean: true,
-    },
-    reporters: ["default", ["junit", { outputFile: "test-report.xml" }]],
-    environment: "node",
-  },
-});