@indigoai-us/hq-cli 5.77.14 → 5.78.0

package/src/commands/sync-narrow.test.ts

@@ -1,633 +0,0 @@
-/**
- * Unit tests for `hq sync narrow` (sync-narrow.ts).
- *
- * Stubs `SyncNarrowVaultClient`, `JournalIO`, and `FsIO` so we cover:
- *   - resolveNarrowTarget happy path + refuse-on-non-`all` (acceptance 5)
- *   - computeNarrowPlan: returns partitioned plan over a tmp tree
- *   - applyNarrow: deletes clean orphans + tombstones + flips sync-config
- *   - applyNarrow: dirty + force → deletes dirty too
- *   - formatDirtyConflictReport: includes paths + reasons + recovery hint
- *
- * The CLI Commander wiring is exercised by the existing
- * `cloud.push-all.test.ts`-style action-level integration tests in other
- * commands; we keep this file focused on the orchestrator units called by
- * that action.
- */
-
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import * as fs from "node:fs";
-import * as os from "node:os";
-import * as path from "node:path";
-import * as crypto from "node:crypto";
-
-import {
-  applyNarrow,
-  computeNarrowPlan,
-  formatDirtyConflictReport,
-  resolveNarrowTarget,
-  type FsIO,
-  type JournalIO,
-  type SyncNarrowVaultClient,
-} from "./sync-narrow.js";
-import type {
-  ExplicitGrant,
-  Membership,
-  MembershipSyncConfig,
-  SyncJournal,
-  SyncMode,
-} from "@indigoai-us/hq-cloud";
-
-// ── Tmp dir + journal fixture ──────────────────────────────────────────────
-
-let tmpRoot: string;
-
-beforeEach(() => {
-  tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), "hq-sync-narrow-"));
-});
-
-afterEach(() => {
-  fs.rmSync(tmpRoot, { recursive: true, force: true });
-});
-
-function writeFile(rel: string, contents: string): { abs: string; rel: string } {
-  const abs = path.join(tmpRoot, rel);
-  fs.mkdirSync(path.dirname(abs), { recursive: true });
-  fs.writeFileSync(abs, contents);
-  return { abs, rel };
-}
-
-function sha256(s: string): string {
-  return crypto.createHash("sha256").update(s).digest("hex");
-}
-
-function journalFromFiles(
-  files: Array<{ rel: string; contents: string }>,
-): SyncJournal {
-  const j: SyncJournal = {
-    version: "2",
-    lastSync: new Date().toISOString(),
-    files: {},
-    pulls: [],
-  };
-  for (const f of files) {
-    j.files[f.rel] = {
-      hash: sha256(f.contents),
-      size: Buffer.byteLength(f.contents),
-      syncedAt: new Date(Date.now() + 5000).toISOString(),
-      direction: "down",
-    };
-  }
-  return j;
-}
-
-// ── Stub builders ───────────────────────────────────────────────────────────
-
-function fakeMembership(overrides: Partial<Membership> = {}): Membership {
-  return {
-    membershipKey: "mbr_acme_123",
-    personUid: "prs_alice",
-    companyUid: "cmp_acme",
-    role: "member" as Membership["role"],
-    status: "active" as Membership["status"],
-    invitedBy: "prs_admin",
-    invitedAt: "2026-01-01T00:00:00Z",
-    ...overrides,
-  } as Membership;
-}
-
-function fakeGrant(p: string): ExplicitGrant {
-  return {
-    companyUid: "cmp_acme",
-    path: p,
-    permission: "read",
-    source: "person",
-  };
-}
-
-interface StubClientOpts {
-  memberships?: Membership[];
-  configs?: Record<string, MembershipSyncConfig>;
-  grants?: ExplicitGrant[];
-  setResult?: MembershipSyncConfig;
-  entities?: Record<string, { uid: string; slug: string; name?: string }>;
-}
-
-function makeStubClient(opts: StubClientOpts): {
-  client: SyncNarrowVaultClient;
-  spies: {
-    setMembershipSyncConfig: ReturnType<typeof vi.fn>;
-    listMyExplicitGrants: ReturnType<typeof vi.fn>;
-  };
-} {
-  const setMembershipSyncConfig = vi
-    .fn<
-      [string, { syncMode: SyncMode; customPaths?: string[] }],
-      Promise<MembershipSyncConfig>
-    >()
-    .mockImplementation(async (id, partial) => {
-      if (opts.setResult) return opts.setResult;
-      return {
-        membershipId: id,
-        syncMode: partial.syncMode,
-        isDefault: false,
-        updatedAt: "2026-05-20T12:00:00Z",
-        updatedBy: "prs_alice",
-      };
-    });
-  const listMyExplicitGrants = vi
-    .fn<[string], Promise<ExplicitGrant[]>>()
-    .mockResolvedValue(opts.grants ?? []);
-
-  const client: SyncNarrowVaultClient = {
-    listMyMemberships: vi
-      .fn<[], Promise<Membership[]>>()
-      .mockResolvedValue(opts.memberships ?? []),
-    getMembershipSyncConfig: vi
-      .fn<[string], Promise<MembershipSyncConfig>>()
-      .mockImplementation(async (id) => {
-        const cfg = opts.configs?.[id];
-        if (cfg) return cfg;
-        return { membershipId: id, syncMode: "shared", isDefault: true };
-      }),
-    setMembershipSyncConfig,
-    listMyExplicitGrants,
-    entity: {
-      get: vi
-        .fn<[string], Promise<{ uid: string; slug: string; name?: string }>>()
-        .mockImplementation(async (uid) => {
-          const e = opts.entities?.[uid];
-          if (!e) throw new Error(`unknown entity ${uid}`);
-          return e;
-        }),
-    },
-  };
-
-  return {
-    client,
-    spies: { setMembershipSyncConfig, listMyExplicitGrants },
-  };
-}
-
-function makeStubJournalIO(initial?: SyncJournal): {
-  io: JournalIO;
-  reads: string[];
-  writes: Array<{ slug: string; journal: SyncJournal }>;
-  current(): SyncJournal | undefined;
-} {
-  let state: SyncJournal | undefined = initial;
-  const reads: string[] = [];
-  const writes: Array<{ slug: string; journal: SyncJournal }> = [];
-  return {
-    io: {
-      read(slug) {
-        reads.push(slug);
-        if (!state) {
-          return { version: "2", lastSync: "", files: {}, pulls: [] };
-        }
-        // Return a deep clone so the caller mutating it doesn't change our seed.
-        return JSON.parse(JSON.stringify(state)) as SyncJournal;
-      },
-      write(slug, journal) {
-        writes.push({ slug, journal });
-        state = JSON.parse(JSON.stringify(journal)) as SyncJournal;
-      },
-    },
-    reads,
-    writes,
-    current: () => state,
-  };
-}
-
-function makeStubFs(): { io: FsIO; deletes: string[] } {
-  const deletes: string[] = [];
-  return {
-    io: {
-      unlinkSync(p) {
-        // Actually delete from tmpRoot so subsequent reads are honest.
-        deletes.push(p);
-        try {
-          fs.unlinkSync(p);
-        } catch (err) {
-          const code = (err as NodeJS.ErrnoException).code;
-          if (code !== "ENOENT") throw err;
-        }
-      },
-    },
-    deletes,
-  };
-}
-
-// ── resolveNarrowTarget ─────────────────────────────────────────────────────
-
-describe("resolveNarrowTarget", () => {
-  it("resolves membership + current sync-config for the slug", async () => {
-    const { client } = makeStubClient({
-      memberships: [fakeMembership()],
-      configs: {
-        mbr_acme_123: {
-          membershipId: "mbr_acme_123",
-          syncMode: "all",
-          isDefault: false,
-        },
-      },
-      entities: { cmp_acme: { uid: "cmp_acme", slug: "acme", name: "Acme" } },
-    });
-    const result = await resolveNarrowTarget({
-      companySlug: "acme",
-      vaultClient: client,
-    });
-    expect(result.membership.membershipKey).toBe("mbr_acme_123");
-    expect(result.companyUid).toBe("cmp_acme");
-    expect(result.syncConfig.syncMode).toBe("all");
-  });
-
-  it("refuses on already-shared memberships (acceptance 5)", async () => {
-    const { client } = makeStubClient({
-      memberships: [fakeMembership()],
-      configs: {
-        mbr_acme_123: {
-          membershipId: "mbr_acme_123",
-          syncMode: "shared",
-          isDefault: false,
-        },
-      },
-      entities: { cmp_acme: { uid: "cmp_acme", slug: "acme" } },
-    });
-    await expect(
-      resolveNarrowTarget({ companySlug: "acme", vaultClient: client }),
-    ).rejects.toThrow(/Refusing to narrow.*syncMode='shared'/);
-  });
-
-  it("refuses on custom memberships (acceptance 5)", async () => {
-    const { client } = makeStubClient({
-      memberships: [fakeMembership()],
-      configs: {
-        mbr_acme_123: {
-          membershipId: "mbr_acme_123",
-          syncMode: "custom",
-          customPaths: ["companies/acme/x/"],
-          isDefault: false,
-        },
-      },
-      entities: { cmp_acme: { uid: "cmp_acme", slug: "acme" } },
-    });
-    await expect(
-      resolveNarrowTarget({ companySlug: "acme", vaultClient: client }),
-    ).rejects.toThrow(/syncMode='custom'/);
-  });
-
-  it("errors out when the slug doesn't match any membership", async () => {
-    const { client } = makeStubClient({
-      memberships: [fakeMembership()],
-      entities: { cmp_acme: { uid: "cmp_acme", slug: "acme" } },
-    });
-    await expect(
-      resolveNarrowTarget({ companySlug: "ghost", vaultClient: client }),
-    ).rejects.toThrow(/No membership found for company 'ghost'.*acme/);
-  });
-});
-
-// ── computeNarrowPlan ───────────────────────────────────────────────────────
-
-describe("computeNarrowPlan", () => {
-  it("coalesces grants and returns a partitioned plan", async () => {
-    // Files live on disk at their hq-root-relative path…
-    writeFile("companies/acme/meetings/notes.md", "stays");
-    writeFile("companies/acme/scratch/old.md", "clean orphan");
-
-    // …but the journal keys + grant paths are COMPANY-RELATIVE — the
-    // namespace the real server + engine use. (The old fixtures used
-    // full `companies/acme/...` grant paths, which never matched the
-    // company-relative keys buildNarrowPlan emits — masking the namespace
-    // bug this test now guards against.)
-    const journal = journalFromFiles([
-      { rel: "meetings/notes.md", contents: "stays" },
-      { rel: "scratch/old.md", contents: "clean orphan" },
-    ]);
-
-    const { client } = makeStubClient({
-      grants: [
-        fakeGrant("meetings/"),
-        fakeGrant("meetings/2026/"), // collapsed by coalesce
-      ],
-    });
-
-    const journalIO = makeStubJournalIO(journal);
-
-    const result = await computeNarrowPlan({
-      hqRoot: tmpRoot,
-      companySlug: "acme",
-      companyUid: "cmp_acme",
-      vaultClient: client,
-      journalIO: journalIO.io,
-    });
-
-    expect(result.prospectivePrefixSet).toEqual(["meetings/"]);
-    expect(result.plan.totalStayingCount).toBe(1);
-    expect(result.plan.totalCleanCount).toBe(1);
-    expect(result.plan.totalDirtyCount).toBe(0);
-  });
-
-  it("normalizes real-world anchored + glob grant paths (grantPathToPrefix)", async () => {
-    writeFile("companies/acme/design-pack/logo.svg", "svg");
-    writeFile("companies/acme/scratch/old.md", "clean orphan");
-
-    const journal = journalFromFiles([
-      { rel: "design-pack/logo.svg", contents: "svg" },
-      { rel: "scratch/old.md", contents: "clean orphan" },
-    ]);
-
-    // The exact messy shapes the live vault returns: full-anchored + glob,
-    // and slug-anchored + glob — neither startsWith-matches the
-    // company-relative local keys until grantPathToPrefix de-anchors them.
-    const { client } = makeStubClient({
-      grants: [
-        fakeGrant("companies/acme/design-pack/*"),
-        fakeGrant("acme/design-pack/2026/*"), // subsumed after normalize+coalesce
-      ],
-    });
-
-    const result = await computeNarrowPlan({
-      hqRoot: tmpRoot,
-      companySlug: "acme",
-      companyUid: "cmp_acme",
-      vaultClient: client,
-      journalIO: makeStubJournalIO(journal).io,
-    });
-
-    expect(result.prospectivePrefixSet).toEqual(["design-pack/"]);
-    // design-pack/logo.svg stays (covered); scratch/old.md is a clean orphan.
-    expect(result.plan.totalStayingCount).toBe(1);
-    expect(result.plan.totalCleanCount).toBe(1);
-    expect(result.plan.totalDirtyCount).toBe(0);
-  });
-
-  it("a wildcard '*' grant keeps everything (no orphans)", async () => {
-    writeFile("companies/acme/a.md", "a");
-    writeFile("companies/acme/sub/b.md", "b");
-
-    const { client } = makeStubClient({ grants: [fakeGrant("*")] });
-
-    const result = await computeNarrowPlan({
-      hqRoot: tmpRoot,
-      companySlug: "acme",
-      companyUid: "cmp_acme",
-      vaultClient: client,
-      journalIO: makeStubJournalIO(journalFromFiles([])).io,
-    });
-
-    // "*" → "" → guarded to [""] (covers everything) so narrowing keeps the
-    // whole tree rather than collapsing to "nothing" and proposing deletes.
-    expect(result.prospectivePrefixSet).toEqual([""]);
-    expect(result.plan.totalCleanCount).toBe(0);
-    expect(result.plan.totalDirtyCount).toBe(0);
-    expect(result.plan.totalStayingCount).toBe(2);
-  });
-});
-
-// ── applyNarrow ─────────────────────────────────────────────────────────────
-
-describe("applyNarrow", () => {
-  it("deletes clean orphans, tombstones the journal, and flips sync-config", async () => {
-    const staying = writeFile("companies/acme/meetings/keep.md", "keep");
-    const orphan = writeFile("companies/acme/scratch/drop.md", "drop me");
-
-    const journal = journalFromFiles([
-      { rel: staying.rel, contents: "keep" },
-      { rel: orphan.rel, contents: "drop me" },
-    ]);
-
-    const { client, spies } = makeStubClient({});
-    const journalIO = makeStubJournalIO();
-    const fsIO = makeStubFs();
-
-    const result = await applyNarrow({
-      companySlug: "acme",
-      membershipId: "mbr_acme_123",
-      plan: {
-        staying: [{ relPath: staying.rel, absPath: staying.abs, bytes: 4 }],
-        clean: [{ relPath: orphan.rel, absPath: orphan.abs, bytes: 7 }],
-        dirty: [],
-        totalStayingCount: 1,
-        totalCleanCount: 1,
-        totalCleanBytes: 7,
-        totalDirtyCount: 0,
-        totalDirtyBytes: 0,
-      },
-      journal,
-      vaultClient: client,
-      force: false,
-      journalIO: journalIO.io,
-      fsIO: fsIO.io,
-    });
-
-    expect(result.cleanDeleted).toBe(1);
-    expect(result.dirtyDeleted).toBe(0);
-    expect(result.tombstoned).toBe(1);
-    expect(result.cleanBytes).toBe(7);
-    expect(fsIO.deletes).toEqual([orphan.abs]);
-    // file is actually gone on disk
-    expect(fs.existsSync(orphan.abs)).toBe(false);
-    // staying file untouched
-    expect(fs.existsSync(staying.abs)).toBe(true);
-
-    // Journal write contains tombstone marker on the orphan path.
-    expect(journalIO.writes).toHaveLength(1);
-    const written = journalIO.writes[0]!.journal;
-    expect(written.files[orphan.rel]?.removedAt).toBeTypeOf("string");
-    expect(written.files[orphan.rel]?.removedReason).toBe("narrow_apply");
-    // staying file's journal entry is left untouched (no tombstone).
-    expect(written.files[staying.rel]?.removedAt).toBeUndefined();
-
-    // sync-config PUT was called with shared.
-    expect(spies.setMembershipSyncConfig).toHaveBeenCalledWith("mbr_acme_123", {
-      syncMode: "shared",
-    });
-    expect(result.newConfig.syncMode).toBe("shared");
-  });
-
-  it("aborts when dirty files present and --force NOT set (caller-level — applyNarrow trusts plan)", async () => {
-    // applyNarrow itself doesn't gate on --force; the CLI does. This test
-    // pins the contract that applyNarrow ALSO doesn't accidentally delete
-    // dirty files when `force: false`.
-    const orphan = writeFile("companies/acme/scratch/dirty.md", "current");
-    const journal = journalFromFiles([
-      { rel: orphan.rel, contents: "different — journal version" },
-    ]);
-
-    const { client } = makeStubClient({});
-    const journalIO = makeStubJournalIO();
-    const fsIO = makeStubFs();
-
-    const result = await applyNarrow({
-      companySlug: "acme",
-      membershipId: "mbr_acme_123",
-      plan: {
-        staying: [],
-        clean: [],
-        dirty: [
-          {
-            relPath: orphan.rel,
-            absPath: orphan.abs,
-            bytes: 7,
-            reason: "hash-mismatch",
-          },
-        ],
-        totalStayingCount: 0,
-        totalCleanCount: 0,
-        totalCleanBytes: 0,
-        totalDirtyCount: 1,
-        totalDirtyBytes: 7,
-      },
-      journal,
-      vaultClient: client,
-      force: false,
-      journalIO: journalIO.io,
-      fsIO: fsIO.io,
-    });
-
-    expect(result.dirtyDeleted).toBe(0);
-    expect(result.cleanDeleted).toBe(0);
-    expect(fs.existsSync(orphan.abs)).toBe(true);
-    // sync-config still flipped — the CLI is the one that bails out before
-    // calling applyNarrow when dirty + !force. If the CLI invariant ever
-    // weakens, this test reminds us that applyNarrow is the wrong layer
-    // to enforce the gate.
-  });
-
-  it("with --force, deletes dirty files too and tombstones journal entries", async () => {
-    const orphan = writeFile("companies/acme/scratch/dirty.md", "current");
-    const journal = journalFromFiles([
-      { rel: orphan.rel, contents: "journal version" },
-    ]);
-
-    const { client } = makeStubClient({});
-    const journalIO = makeStubJournalIO();
-    const fsIO = makeStubFs();
-
-    const result = await applyNarrow({
-      companySlug: "acme",
-      membershipId: "mbr_acme_123",
-      plan: {
-        staying: [],
-        clean: [],
-        dirty: [
-          {
-            relPath: orphan.rel,
-            absPath: orphan.abs,
-            bytes: 7,
-            reason: "hash-mismatch",
-          },
-        ],
-        totalStayingCount: 0,
-        totalCleanCount: 0,
-        totalCleanBytes: 0,
-        totalDirtyCount: 1,
-        totalDirtyBytes: 7,
-      },
-      journal,
-      vaultClient: client,
-      force: true,
-      journalIO: journalIO.io,
-      fsIO: fsIO.io,
-    });
-
-    expect(result.dirtyDeleted).toBe(1);
-    expect(result.dirtyBytes).toBe(7);
-    expect(result.tombstoned).toBe(1);
-    expect(fs.existsSync(orphan.abs)).toBe(false);
-    expect(
-      journalIO.writes[0]!.journal.files[orphan.rel]?.removedAt,
-    ).toBeTypeOf("string");
-  });
-
-  it("with --force on a not-in-journal dirty file: deletes the file, no tombstone (nothing to tombstone)", async () => {
-    const orphan = writeFile(
-      "companies/acme/scratch/unjournaled.md",
-      "never tracked",
-    );
-    const journal: SyncJournal = {
-      version: "2",
-      lastSync: "",
-      files: {},
-      pulls: [],
-    };
-
-    const { client } = makeStubClient({});
-    const journalIO = makeStubJournalIO();
-    const fsIO = makeStubFs();
-
-    const result = await applyNarrow({
-      companySlug: "acme",
-      membershipId: "mbr_acme_123",
-      plan: {
-        staying: [],
-        clean: [],
-        dirty: [
-          {
-            relPath: orphan.rel,
-            absPath: orphan.abs,
-            bytes: 13,
-            reason: "not-in-journal",
-          },
-        ],
-        totalStayingCount: 0,
-        totalCleanCount: 0,
-        totalCleanBytes: 0,
-        totalDirtyCount: 1,
-        totalDirtyBytes: 13,
-      },
-      journal,
-      vaultClient: client,
-      force: true,
-      journalIO: journalIO.io,
-      fsIO: fsIO.io,
-    });
-
-    expect(result.dirtyDeleted).toBe(1);
-    // No journal entry existed, so tombstoned count stays at 0 for this orphan.
-    expect(result.tombstoned).toBe(0);
-    expect(fs.existsSync(orphan.abs)).toBe(false);
-  });
-});
-
-// ── formatDirtyConflictReport ───────────────────────────────────────────────
-
-describe("formatDirtyConflictReport", () => {
-  it("renders each dirty file with reason and a recovery hint", () => {
-    const out = formatDirtyConflictReport(
-      [
-        {
-          relPath: "companies/acme/scratch/x.md",
-          absPath: "/tmp/x.md",
-          bytes: 1024,
-          reason: "hash-mismatch",
-        },
-        {
-          relPath: "companies/acme/scratch/y.md",
-          absPath: "/tmp/y.md",
-          bytes: 2048,
-          reason: "modified-after-sync",
-        },
-      ],
-      "acme",
-    );
-    expect(out).toContain("Aborting narrow for 'acme'");
-    expect(out).toContain("companies/acme/scratch/x.md");
-    expect(out).toContain("hash-mismatch");
-    expect(out).toContain("companies/acme/scratch/y.md");
-    expect(out).toContain("modified-after-sync");
-    expect(out).toContain("--force");
-  });
-
-  it("caps the per-file listing at 25 with a 'more' suffix", () => {
-    const dirty = Array.from({ length: 30 }, (_, i) => ({
-      relPath: `companies/acme/scratch/${i}.md`,
-      absPath: `/tmp/${i}.md`,
-      bytes: 10,
-      reason: "hash-mismatch" as const,
-    }));
-    const out = formatDirtyConflictReport(dirty, "acme");
-    expect(out).toContain("... 5 more");
-  });
-});