Addresses QA findings on PR #119 (issues #235/#236). SYNC-WEDGE (HIGH): one same-line conflict on one page froze sync for the WHOLE space in both directions forever. The pull's docmost->main merge left the vault mid-merge, so every later cycle's isMergeInProgress() check returned skipped:"merge-in-progress" and skipped the entire space with no recovery. - pull.ts now COMMITS a conflicting merge with markers in place (commitMerge): cleanly-merged pages land, the conflicted page carries its markers on main and is isolated by the existing push-side conflict-marker skip (markers never reach Docmost), and the next cycle is no longer wedged. conflictedPaths is surfaced. - cycle.ts now RECOVERS a vault left mid-merge by a prior/pre-fix cycle: it aborts the stale merge (merge --abort, hard-reset fallback) and continues, instead of skipping the space forever. - git.ts: listUnmergedPaths / commitMerge / abortMerge / resetHardToHead. CALLOUT TYPE FIDELITY: git-sync's CALLOUT_TYPES was missing "note" and "default" (editor-canonical types), so [!note]/[!default] callouts flattened to [!info] on every round-trip. Aligned the list with @docmost/editor-ext getValidCalloutType. LOSS-ON-FAST-CLOSE: editing a page then closing the tab inside the collab debounce window (~3-18s) lost the edit, because with unloadImmediately:false Hocuspocus does not flush the debounced onStoreDocument on the last-client disconnect. PersistenceExtension.onDisconnect now flushes the pending store (debouncer.executeNow) on the last disconnect only, with no redundant write. DUPLICATION re-verify (#1): the schema-default merge-key normalization is intact; faithful toYdoc-based reproduction shows callout + rich content resync with 0 ops and no growth/strip across cycles -> the re-report was leftover vault data, not a live regression. Locked with a callout regression spec. Tests: git-sync 688 pass (incl. real-VaultGit wedge-recovery integration); server git-sync+collaboration 285 pass; new callout merge/fidelity + onDisconnect-flush specs. tsc --noEmit clean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
180 lines
6.7 KiB
TypeScript
180 lines
6.7 KiB
TypeScript
import { describe, it, expect, vi } from "vitest";
|
|
import { runCycle, type RunCycleDeps } from "../src/engine/cycle";
|
|
|
|
// A fake VaultGit recording the staging calls. An EMPTY vault/tree lets the real
|
|
// readExisting/computePullActions/applyPullActions/runPush run trivially (no
|
|
// files, no pages) so we can assert runCycle's choreography without real git.
|
|
function fakeVault(overrides: Record<string, any> = {}) {
|
|
const order: string[] = [];
|
|
const rec =
|
|
(name: string, ret?: any) =>
|
|
async (...args: any[]) => {
|
|
order.push(args.length ? `${name}:${args.join(",")}` : name);
|
|
return ret;
|
|
};
|
|
const vault: any = {
|
|
order,
|
|
assertGitAvailable: rec("assertGitAvailable"),
|
|
ensureRepo: rec("ensureRepo"),
|
|
isMergeInProgress: vi.fn(async () => false),
|
|
ensureBranch: rec("ensureBranch"),
|
|
checkout: rec("checkout"),
|
|
listTrackedFiles: vi.fn(async () => [] as string[]),
|
|
// push-side git surface (empty diff -> a clean no-op push)
|
|
stageAll: rec("stageAll"),
|
|
commit: rec("commit", { committed: false }),
|
|
merge: rec("merge", { ok: true, conflict: false, output: "" }),
|
|
listUnmergedPaths: vi.fn(async () => [] as string[]),
|
|
commitMerge: rec("commitMerge"),
|
|
abortMerge: rec("abortMerge"),
|
|
resetHardToHead: rec("resetHardToHead"),
|
|
readRef: vi.fn(async () => null),
|
|
revParse: vi.fn(async () => "0000000000000000000000000000000000000000"),
|
|
diffNameStatus: vi.fn(async () => [] as any[]),
|
|
showFileAtRef: vi.fn(async () => ""),
|
|
updateRef: rec("updateRef"),
|
|
fastForwardBranch: rec("fastForwardBranch", { ok: true }),
|
|
...overrides,
|
|
};
|
|
return vault;
|
|
}
|
|
|
|
function baseDeps(vault: any, over: Partial<RunCycleDeps> = {}): RunCycleDeps {
|
|
return {
|
|
spaceId: "space-1",
|
|
client: {
|
|
listSpaceTree: vi.fn(async () => ({ pages: [], complete: true })),
|
|
getPageJson: vi.fn(),
|
|
importPageMarkdown: vi.fn(),
|
|
createPage: vi.fn(),
|
|
deletePage: vi.fn(),
|
|
movePage: vi.fn(),
|
|
renamePage: vi.fn(),
|
|
listRecentSince: vi.fn(),
|
|
listTrash: vi.fn(),
|
|
restorePage: vi.fn(),
|
|
} as any,
|
|
vault,
|
|
settings: { vaultPath: "/vault" } as any,
|
|
fs: {
|
|
readFile: vi.fn(async () => ""),
|
|
writeFile: vi.fn(async () => undefined),
|
|
mkdir: vi.fn(async () => undefined),
|
|
rm: vi.fn(async () => undefined),
|
|
},
|
|
log: vi.fn(),
|
|
...over,
|
|
};
|
|
}
|
|
|
|
describe("runCycle (composition)", () => {
|
|
it("RECOVERS from a vault left mid-merge: aborts the stale merge and continues (no wedge)", async () => {
|
|
// Regression for the WEDGE bug (QA #119): a vault left mid-merge by a prior
|
|
// cycle used to skip the WHOLE space forever. Now the cycle aborts the stale
|
|
// merge and proceeds so the space self-heals.
|
|
let midMerge = true;
|
|
const vault = fakeVault({
|
|
// mid-merge until `abortMerge` clears it (then the cycle continues).
|
|
isMergeInProgress: vi.fn(async () => midMerge),
|
|
abortMerge: vi.fn(async () => {
|
|
midMerge = false;
|
|
}),
|
|
});
|
|
const deps = baseDeps(vault);
|
|
|
|
const res = await runCycle(deps);
|
|
|
|
// The stale merge was aborted and the cycle RAN (no permanent wedge).
|
|
expect(vault.abortMerge).toHaveBeenCalledTimes(1);
|
|
expect(res.ran).toBe(true);
|
|
expect(deps.client.listSpaceTree).toHaveBeenCalledTimes(1);
|
|
expect(vault.order).toContain("checkout:docmost");
|
|
});
|
|
|
|
it("hard-resets when 'merge --abort' cannot clear a stray unmerged index", async () => {
|
|
// abortMerge does NOT clear it (no MERGE_HEAD but stray unmerged entries);
|
|
// the cycle falls back to a hard reset, then proceeds.
|
|
let midMerge = true;
|
|
const vault = fakeVault({
|
|
isMergeInProgress: vi.fn(async () => midMerge),
|
|
abortMerge: vi.fn(async () => undefined), // leaves it mid-merge
|
|
resetHardToHead: vi.fn(async () => {
|
|
midMerge = false;
|
|
}),
|
|
});
|
|
const deps = baseDeps(vault);
|
|
|
|
const res = await runCycle(deps);
|
|
|
|
expect(vault.abortMerge).toHaveBeenCalledTimes(1);
|
|
expect(vault.resetHardToHead).toHaveBeenCalledTimes(1);
|
|
expect(res.ran).toBe(true);
|
|
});
|
|
|
|
it("stages ensureRepo -> ensureBranch(docmost,main) -> checkout(docmost) BEFORE pulling", async () => {
|
|
const vault = fakeVault();
|
|
const deps = baseDeps(vault);
|
|
|
|
const res = await runCycle(deps);
|
|
|
|
expect(res.ran).toBe(true);
|
|
const ensureRepoIdx = vault.order.indexOf("ensureRepo");
|
|
const ensureBranchIdx = vault.order.indexOf("ensureBranch:docmost,main");
|
|
const checkoutIdx = vault.order.indexOf("checkout:docmost");
|
|
expect(ensureRepoIdx).toBeGreaterThanOrEqual(0);
|
|
expect(ensureBranchIdx).toBeGreaterThan(ensureRepoIdx);
|
|
expect(checkoutIdx).toBeGreaterThan(ensureBranchIdx);
|
|
expect(deps.client.listSpaceTree).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it("runs a SINGLE push planning pass (no dry-run; the delete-cap hook is gone)", async () => {
|
|
const vault = fakeVault();
|
|
const deps = baseDeps(vault);
|
|
|
|
const res = await runCycle(deps);
|
|
expect(res.ran).toBe(true);
|
|
// There is exactly one runPush (the apply) — no separate dry-run pass.
|
|
// diffNameStatus is read once per runPush; assert a single planning pass.
|
|
expect(vault.diffNameStatus).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it("throws on a PRE-aborted signal BEFORE applying the pull (first destructive phase)", async () => {
|
|
const vault = fakeVault();
|
|
const controller = new AbortController();
|
|
controller.abort();
|
|
const deps = baseDeps(vault, { signal: controller.signal });
|
|
|
|
await expect(runCycle(deps)).rejects.toThrow();
|
|
|
|
// The signal is checked AFTER planning but BEFORE the first write phase:
|
|
// the tree was listed (planning) but neither destructive phase advanced —
|
|
// no pull merge and no push diff.
|
|
expect(deps.client.listSpaceTree).toHaveBeenCalledTimes(1);
|
|
expect(vault.order).not.toContain("merge:main");
|
|
expect(vault.diffNameStatus).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("throws BEFORE the push apply when the signal aborts during the pull phase", async () => {
|
|
// Abort mid-cycle: the signal fires while listSpaceTree (the pull read)
|
|
// runs, so the SECOND checkpoint (before runPush) trips and the push apply
|
|
// never starts.
|
|
const controller = new AbortController();
|
|
const vault = fakeVault();
|
|
const deps = baseDeps(vault, {
|
|
signal: controller.signal,
|
|
client: {
|
|
...baseDeps(vault).client,
|
|
listSpaceTree: vi.fn(async () => {
|
|
controller.abort();
|
|
return { pages: [], complete: true };
|
|
}),
|
|
} as any,
|
|
});
|
|
|
|
await expect(runCycle(deps)).rejects.toThrow();
|
|
// Pull planning ran but the push never did (aborted at a checkpoint).
|
|
expect(deps.client.listSpaceTree).toHaveBeenCalledTimes(1);
|
|
expect(vault.diffNameStatus).not.toHaveBeenCalled();
|
|
});
|
|
});
|