@ogcio/o11y-sdk-react 0.4.2 → 0.6.1

package/test/lib/hooks.test.ts

@@ -1,150 +0,0 @@
-import {
-  LogEvent,
-  LogLevel,
-  TransportItem,
-  TransportItemType,
-} from "@grafana/faro-web-sdk";
-import { beforeEach, describe, expect, it, vi } from "vitest";
-import { _beforeSend } from "../../lib/internals/hooks";
-
-// 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("_beforeSend", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it("should deeply redact PII in object", () => {
-    const item = {
-      type: TransportItemType.LOG,
-      payload: {
-        level: LogLevel.INFO,
-        context: {},
-        timestamp: Date.now().toString(),
-        message: "my email is bob@abc.com",
-      },
-      meta: {
-        user: {
-          email: "carol@abc.com",
-          attributes: {
-            alternative_email: "foo@xyz.org",
-          },
-        },
-      },
-    } satisfies TransportItem<LogEvent>;
-
-    const redacted: TransportItem<LogEvent> = _beforeSend([redactors.email])(
-      item,
-    ) as TransportItem<LogEvent>;
-
-    expect(redacted.payload.message).toBe("my email is [REDACTED EMAIL]");
-    expect(redacted.meta.user).not.toBeNull();
-    expect(redacted.meta.user!.email).toBe("[REDACTED EMAIL]");
-    expect(redacted.meta.user!.attributes).toBeDefined();
-    expect(redacted.meta.user!.attributes!["alternative_email"]).toBe(
-      "[REDACTED EMAIL]",
-    );
-    expect(faro.api.pushMeasurement).toHaveBeenCalledTimes(3);
-  });
-
-  it("should redact email inside arrays of primitives", () => {
-    const item: TransportItem<LogEvent> = {
-      type: TransportItemType.LOG,
-      payload: {
-        message: "start",
-        context: {
-          messages: ["hello", "email: test@abc.com", "ok"],
-        },
-        timestamp: "123",
-        level: LogLevel.INFO,
-      },
-    };
-
-    const redacted = _beforeSend([redactors.email])(item)!;
-
-    expect(redacted.payload.context.messages[1]).toBe(
-      "email: [REDACTED EMAIL]",
-    );
-    expect(faro.api.pushMeasurement).toHaveBeenCalledOnce();
-  });
-
-  it("should redact emails in arrays of objects", () => {
-    const item: TransportItem<LogEvent> = {
-      type: TransportItemType.LOG,
-      payload: {
-        message: "checking",
-        context: {
-          events: [
-            { message: "contact a@b.com" },
-            { message: "nothing here" },
-            { note: "try c@d.net" },
-          ],
-        },
-        timestamp: "123",
-        level: LogLevel.INFO,
-      },
-    };
-
-    const redacted = _beforeSend([redactors.email])(item)!;
-
-    expect(redacted.payload.context.events[0].message).toBe(
-      "contact [REDACTED EMAIL]",
-    );
-    expect(redacted.payload.context.events[2].note).toBe(
-      "try [REDACTED EMAIL]",
-    );
-    expect(faro.api.pushMeasurement).toHaveBeenCalledTimes(2);
-  });
-
-  it("should not break on nulls, undefined, numbers, booleans", () => {
-    const item: TransportItem<LogEvent> = {
-      type: TransportItemType.LOG,
-      payload: {
-        message: null as any,
-        count: 123,
-        active: true,
-        description: undefined,
-      } as any,
-      meta: null,
-    };
-
-    const redacted = _beforeSend([redactors.email])(item)!;
-
-    expect(redacted.payload.message).toBeNull();
-    expect(redacted.payload.count).toBe(123);
-    expect(redacted.payload.active).toBe(true);
-    expect("description" in redacted.payload).toBe(true); // still defined as undefined
-    expect(faro.api.pushMeasurement).not.toHaveBeenCalled();
-  });
-
-  it("should decode and redact encoded emails", () => {
-    const item: TransportItem<LogEvent> = {
-      type: TransportItemType.LOG,
-      payload: {
-        message: "contact%20user%40domain.com",
-        level: LogLevel.INFO,
-        context: {},
-        timestamp: "now",
-      },
-    };
-
-    const redacted = _beforeSend([redactors.email])(item)!;
-
-    expect(redacted.payload.message).toBe("contact [REDACTED EMAIL]");
-    expect(faro.api.pushMeasurement).toHaveBeenCalledOnce();
-  });
-});

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,179 +0,0 @@
-import { TransportItemType } from "@grafana/faro-web-sdk";
-import { beforeEach, describe, expect, it, vi } from "vitest";
-import {
-  _cleanStringPII,
-  _containsEncodedComponents,
-} from "../../lib/internals/redaction/pii-detection";
-import { faro } from "@grafana/faro-web-sdk";
-import { redactors } from "../../lib/internals/redaction/redactors";
-
-// 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("_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();
-  });
-});
-
-describe("_containsEncodedComponents", () => {
-  describe("should return true for properly URL encoded strings", () => {
-    it.each([
-      ["hello%20world", "Space encoded as %20"],
-      ["test%2Bvalue", "Plus sign encoded as %2B"],
-      ["path%2Fto%2Ffile", "Forward slashes encoded"],
-      ["user%40domain.com", "@ symbol encoded"],
-      ["100%25%20off", "Percent and space encoded"],
-      ["a%3Db%26c%3Dd", "Query parameters (a=b&c=d)"],
-      ["caf%C3%A9", "UTF-8 encoded (café)"],
-      ["price%3A%20%2410", "Colon, space, dollar ($10)"],
-      ["%22quoted%22", "Double quotes encoded"],
-      ["https%3A%2F%2Fexample.com", "Full URL encoded"],
-      ["file%20name.txt", "filename encoded"],
-      ["search%3Fq%3Dhello%20world", "Query string encoded"],
-      ["%3C%3E%26%22%27", "HTML special chars encoded (<>&\"')"],
-      ["%E2%9C%93", "UTF-8 checkmark (✓) encoded"],
-      ["test%2b", "Lowercase hex"],
-      ["%E4%B8%AD%E6%96%87", "Chinese characters encoded"],
-    ])('should detect "%s" as URL encoded (%s)', (input, description) => {
-      expect(_containsEncodedComponents(input)).toBe(true);
-    });
-  });
-
-  describe("should return false for non-URL encoded strings", () => {
-    it.each([
-      ["test", "Simple ASCII string"],
-      ["hello world", "Unencoded space"],
-      ["user@domain.com", "Unencoded email"],
-      ["simple123", "Alphanumeric only"],
-      ["", "Empty string"],
-      ["25%%", "Literal percent signs"],
-      ["100% off", "Percent without hex digits"],
-      ["test%2", "Incomplete percent encoding"],
-      ["hello%ZZ", "Invalid hex digits"],
-      ["test%2G", "Invalid hex digit G"],
-      ["bad%encoding%here", "Percent without hex pairs"],
-      ["hello%20world and more", "Partially encoded string"],
-      ["hello%20world%21%20how%20are%20you", "Overly encoded string"],
-      ["café", "Unicode characters (unencoded)"],
-      ["hello+world", "Plus sign (form encoding style)"],
-      ["test%", "Trailing percent"],
-      ["hello%20world%", "Encoded content with trailing percent"],
-      ["%", "Single percent"],
-      ["%%", "Double percent"],
-      ["normal text with % symbols", "Text with percent but no encoding"],
-      ["price: $100%", "Currency with percent"],
-      ["file.txt", "Simple filename"],
-      ["path/to/file", "Unencoded path"],
-      ["query?param=value", "Unencoded query string"],
-      ["hello%world", "Percent without following hex"],
-      ["test%1", "Single hex digit after percent"],
-      ["hello%zz", "Non-hex characters after percent"],
-    ])('should not detect "%s" as URL encoded (%s)', (input, description) => {
-      expect(_containsEncodedComponents(input)).toBe(false);
-    });
-  });
-
-  describe("Error handling", () => {
-    it.each([
-      ["%C0%80", "Overlong UTF-8 encoding (security concern)"],
-      ["%ED%A0%80", "UTF-8 surrogate (invalid)"],
-      ["%FF%FE", "Invalid UTF-8 sequence"],
-      ["test%20%ZZ", "Mix of valid and invalid encoding"],
-    ])('should handle "%s" (%s)', (input, description) => {
-      // These should not throw errors
-      expect(() => _containsEncodedComponents(input)).not.toThrow();
-
-      // Most of these should return false due to invalid sequences
-      // or security-related encoding issues
-      const result = _containsEncodedComponents(input);
-      expect(typeof result).toBe("boolean");
-    });
-  });
-
-  describe("real-world url examples", () => {
-    it.each([
-      [
-        "https%3A%2F%2Fgoogle.com%2Fsearch%3Fq%3Djavascript",
-        "Encoded Google search URL",
-      ],
-      ["The%20quick%20brown%20fox", "Sentence with spaces encoded"],
-      [
-        "/api/user?body=here%20are%20all%20my%20secrets",
-        "contextually encoded API path",
-      ],
-      ["redirect_uri=https%3A%2F%2Fapp.com%2Fcallback", "OAuth redirect URI"],
-      ["data%3Atext%2Fplain%3Bbase64%2CSGVsbG8%3D", "Data URL encoded"],
-    ])('real-world case: "%s" (%s)', (input, description) => {
-      const result = _containsEncodedComponents(input);
-
-      // Verify the function doesn't crash
-      expect(typeof result).toBe("boolean");
-      expect(result).toBe(true);
-    });
-  });
-});

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",
-  },
-});