SnapOtter/tests/unit/shared/telemetry-doc-drift.test.ts

// @vitest-environment node
import { existsSync, readFileSync } from "node:fs";
import { fileURLToPath } from "node:url";
import { ANALYTICS_EVENTS } from "@snapotter/shared";
import { describe, expect, it } from "vitest";

// Keep the contributor-facing event dictionary honest: every analytics event in
// ANALYTICS_EVENTS must be documented in TELEMETRY.md as a `code-span`. Adding an
// event without documenting it fails here.
describe("TELEMETRY.md event dictionary", () => {
  it("documents every ANALYTICS_EVENTS value", () => {
    // TELEMETRY.md is stripped from the shipped container image (.dockerignore),
    // so this doc-drift check runs in PR CI, not inside the Docker Container E2E.
    if (existsSync("/.dockerenv")) return;
    const doc = readFileSync(
      fileURLToPath(new URL("../../../TELEMETRY.md", import.meta.url)),
      "utf8",
    );
    const undocumented = Object.values(ANALYTICS_EVENTS).filter(
      (event) => !doc.includes(`\`${event}\``),
    );
    expect(undocumented).toEqual([]);
  });
});