@lsctech/polaris 0.1.0

package/dist/smartdocs-engine/canon-check.test.js

@@ -0,0 +1,234 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const node_os_1 = require("node:os");
+const canon_check_js_1 = require("./canon-check.js");
+function makeTestDir() {
+    const dir = (0, node_path_1.join)((0, node_os_1.tmpdir)(), `canon-check-test-${Date.now()}`);
+    (0, node_fs_1.mkdirSync)(dir, { recursive: true });
+    return dir;
+}
+function makeTelemetryFile(dir) {
+    const telDir = (0, node_path_1.join)(dir, "telemetry");
+    (0, node_fs_1.mkdirSync)(telDir, { recursive: true });
+    return (0, node_path_1.join)(telDir, "telemetry.jsonl");
+}
+(0, vitest_1.describe)("runCanonCheck", () => {
+    let testDir;
+    let telemetryFile;
+    (0, vitest_1.beforeEach)(() => {
+        testDir = makeTestDir();
+        telemetryFile = makeTelemetryFile(testDir);
+    });
+    (0, vitest_1.afterEach)(() => {
+        (0, node_fs_1.rmSync)(testDir, { recursive: true, force: true });
+    });
+    (0, vitest_1.describe)("aligned outcome", () => {
+        (0, vitest_1.it)("returns aligned when no changed files are provided", () => {
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: [],
+                runId: "test-run-1",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(result.outcome).toBe("aligned");
+            (0, vitest_1.expect)(result.conflicts).toEqual([]);
+        });
+        (0, vitest_1.it)("returns aligned when no POLARIS.md or canon dirs exist", () => {
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/loop/continue.ts"],
+                runId: "test-run-1",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(result.outcome).toBe("aligned");
+            (0, vitest_1.expect)(result.conflicts).toEqual([]);
+        });
+        (0, vitest_1.it)("returns aligned when POLARIS.md has no rules mentioning changed files as deleted", () => {
+            (0, node_fs_1.mkdirSync)((0, node_path_1.join)(testDir, "src", "loop"), { recursive: true });
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "src", "loop", "continue.ts"), "// placeholder");
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "POLARIS.md"), [
+                "# POLARIS.md",
+                "",
+                "## Editing rules",
+                "- State writes must use checkpoint.ts",
+                "- Keep loop files small",
+                "",
+                "## Architecture assumptions",
+                "- Bootstrap packets are immutable once written",
+            ].join("\n"));
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/loop/continue.ts"],
+                runId: "test-run-1",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(result.outcome).toBe("aligned");
+            (0, vitest_1.expect)(result.conflicts).toEqual([]);
+        });
+        (0, vitest_1.it)("sets canonFilesInspected based on found canon files", () => {
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "POLARIS.md"), "# POLARIS.md\n## Editing rules\n- No special rules\n");
+            (0, node_fs_1.mkdirSync)((0, node_path_1.join)(testDir, "src"), { recursive: true });
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "src", "foo.ts"), "// code");
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/foo.ts"],
+                runId: "test-run-1",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(result.canonFilesInspected).toBeGreaterThan(0);
+        });
+    });
+    (0, vitest_1.describe)("SUMMARY.md exclusion", () => {
+        (0, vitest_1.it)("excludes SUMMARY.md from triggering canon lookup", () => {
+            // Create a POLARIS.md that would normally be found
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "POLARIS.md"), "# POLARIS.md\n");
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["SUMMARY.md"],
+                runId: "test-summary-exclude",
+                telemetryFile,
+            });
+            // Should not find any canon files because SUMMARY.md was ignored
+            (0, vitest_1.expect)(result.canonFilesInspected).toBe(0);
+            (0, vitest_1.expect)(result.outcome).toBe("aligned");
+        });
+        (0, vitest_1.it)("does not report conflicts for SUMMARY.md even if it contains 'must' and 'deleted'", () => {
+            // Create a SUMMARY.md with modal verbs that would normally trigger checkDocFile
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "SUMMARY.md"), "Agents must not use old-file.ts as it is deleted.");
+            (0, node_fs_1.mkdirSync)((0, node_path_1.join)(testDir, "docs", "doctrine", "active"), { recursive: true });
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/some-file.ts"],
+                runId: "test-summary-no-conflict",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(result.conflicts).toHaveLength(0);
+        });
+    });
+    (0, vitest_1.describe)("stale-implementation outcome", () => {
+        (0, vitest_1.it)("returns stale-implementation when POLARIS.md says a file is deleted but it still exists", () => {
+            (0, node_fs_1.mkdirSync)((0, node_path_1.join)(testDir, "src", "loop"), { recursive: true });
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "src", "loop", "old-module.ts"), "// still here");
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "POLARIS.md"), [
+                "# POLARIS.md",
+                "",
+                "## Architecture assumptions",
+                "- old-module.ts has been deleted and must not be used",
+            ].join("\n"));
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/loop/old-module.ts"],
+                runId: "test-run-1",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(result.outcome).toBe("stale-implementation");
+            (0, vitest_1.expect)(result.conflicts.length).toBeGreaterThan(0);
+            (0, vitest_1.expect)(result.conflicts[0].type).toBe("stale-implementation");
+        });
+        (0, vitest_1.it)("emits canon-conflict-halt telemetry event on stale-implementation", () => {
+            (0, node_fs_1.mkdirSync)((0, node_path_1.join)(testDir, "src"), { recursive: true });
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "src", "legacy.ts"), "// still exists");
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "POLARIS.md"), [
+                "# POLARIS.md",
+                "",
+                "## Architecture assumptions",
+                "- legacy.ts has been removed and should not be referenced",
+            ].join("\n"));
+            (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/legacy.ts"],
+                runId: "test-run-halt",
+                telemetryFile,
+                childId: "POL-99",
+            });
+            const lines = (0, node_fs_1.readFileSync)(telemetryFile, "utf-8")
+                .trim()
+                .split("\n")
+                .map((l) => JSON.parse(l));
+            const halt = lines.find((e) => e.event === "canon-conflict-halt");
+            (0, vitest_1.expect)(halt).toBeTruthy();
+            (0, vitest_1.expect)(halt.run_id).toBe("test-run-halt");
+            (0, vitest_1.expect)(halt.child_id).toBe("POL-99");
+        });
+    });
+    (0, vitest_1.describe)("telemetry events", () => {
+        (0, vitest_1.it)("emits canon-check-start event", () => {
+            (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/foo.ts"],
+                runId: "test-run-tel",
+                telemetryFile,
+                childId: "POL-51",
+            });
+            const lines = (0, node_fs_1.readFileSync)(telemetryFile, "utf-8")
+                .trim()
+                .split("\n")
+                .map((l) => JSON.parse(l));
+            const start = lines.find((e) => e.event === "canon-check-start");
+            (0, vitest_1.expect)(start).toBeTruthy();
+            (0, vitest_1.expect)(start.run_id).toBe("test-run-tel");
+            (0, vitest_1.expect)(start.child_id).toBe("POL-51");
+            (0, vitest_1.expect)(typeof start.changed_files_count).toBe("number");
+        });
+        (0, vitest_1.it)("emits canon-check-result event for aligned outcome", () => {
+            (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: [],
+                runId: "test-run-aligned",
+                telemetryFile,
+            });
+            const lines = (0, node_fs_1.readFileSync)(telemetryFile, "utf-8")
+                .trim()
+                .split("\n")
+                .map((l) => JSON.parse(l));
+            const result = lines.find((e) => e.event === "canon-check-result");
+            (0, vitest_1.expect)(result).toBeTruthy();
+            (0, vitest_1.expect)(result.outcome).toBe("aligned");
+            (0, vitest_1.expect)(result.conflicts).toEqual([]);
+        });
+        (0, vitest_1.it)("sets child_id to null when not provided", () => {
+            (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: [],
+                runId: "test-run-no-child",
+                telemetryFile,
+            });
+            const lines = (0, node_fs_1.readFileSync)(telemetryFile, "utf-8")
+                .trim()
+                .split("\n")
+                .map((l) => JSON.parse(l));
+            const start = lines.find((e) => e.event === "canon-check-start");
+            (0, vitest_1.expect)(start.child_id).toBeNull();
+        });
+    });
+    (0, vitest_1.describe)("config flags", () => {
+        (0, vitest_1.it)("does not alter return value — callers control skip logic", () => {
+            // canon-check itself has no checkOnContinue/checkOnFinalize logic;
+            // skipping is the caller's responsibility. Just verify function is callable.
+            const checkResult = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: [],
+                runId: "test-flag",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(checkResult).toBeDefined();
+        });
+    });
+    (0, vitest_1.describe)("POLARIS.md nearest ancestor lookup", () => {
+        (0, vitest_1.it)("finds POLARIS.md in a parent directory", () => {
+            (0, node_fs_1.mkdirSync)((0, node_path_1.join)(testDir, "src", "loop", "deep"), { recursive: true });
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "src", "loop", "deep", "file.ts"), "// code");
+            (0, node_fs_1.writeFileSync)((0, node_path_1.join)(testDir, "src", "POLARIS.md"), "# POLARIS.md\n## Editing rules\n- no rules\n");
+            const result = (0, canon_check_js_1.runCanonCheck)({
+                repoRoot: testDir,
+                changedFiles: ["src/loop/deep/file.ts"],
+                runId: "test-ancestor",
+                telemetryFile,
+            });
+            (0, vitest_1.expect)(result.canonFilesInspected).toBeGreaterThan(0);
+        });
+    });
+});