@ybotok/loam 0.1.0-beta.3 → 0.2.0-alpha.13

package/dist/core/staging/lock.js

@@ -0,0 +1,268 @@
+/**
+ * The docs repo's advisory lock: take it, describe its holder, and break it
+ * when that holder is a pid on this host that no longer exists.
+ *
+ * A module of its own because it is the only rule here that spans the whole
+ * fleet rather than one file, and because the two readers of a held lock have
+ * to agree on what "stale" means — `breakStaleLock` acts on the answer,
+ * `lockIsStale` only reports it to `doctor`. They were written as twins and
+ * stay together so they cannot drift into two definitions of a dead holder.
+ */
+import { link, readFile, rename, writeFile } from "node:fs/promises";
+import { hostname } from "node:os";
+import { join } from "node:path";
+// Every `isRecord` below guards a record loam itself wrote and is reading back
+// — the lock, the snapshot manifest — whose fields are asked for on the very
+// next line, inside a REFUSAL path. `JSON.parse` answers with any JSON value,
+// not with an object, and that is where a thrown `TypeError` costs the most: it
+// does not make the command fail safely, it replaces a designed refusal with
+// `internal`.
+import { isRecord } from "../kernel/records.js";
+import { quietRm, tempPath } from "./commit.js";
+/** The lock file, in the docs repo root — one writer at a time across the whole fleet. */
+export const DOCS_LOCK = ".loam-lock";
+/**
+ * How long a WAITING writer sits out a live holder before answering
+ * `docs-busy`. One spelling for every writer that waits — including gherkin,
+ * whose lock guards the SERVICE repo's emission root rather than the docs
+ * repo: long enough to cover another writer's sub-second commit window with a
+ * margin for a loaded host, bounded so a wedged lock cannot hang anyone.
+ */
+export const LOCK_WAIT_MS = 5_000;
+/** Another writer holds the docs repo. Commands map this to the `docs-busy` envelope code. */
+export class DocsBusyError extends Error {
+    lockPath;
+    name = "DocsBusyError";
+    constructor(lockPath, holder) {
+        super(`another loam command is writing this docs repo (${holder}) — nothing was read or written. ` +
+            `Wait for it to finish, or remove ${lockPath} if no such command is running.`);
+        this.lockPath = lockPath;
+    }
+}
+/**
+ * Take the docs repo's advisory lock for the whole plan+commit window, and
+ * return the release.
+ *
+ * Advisory, and deliberately coarse: the destructive commands write the SAME
+ * three shared files (a service spec, a service contract, the one landscape),
+ * so two of them overlapping is not a merge to be resolved but a merge one of
+ * them computed against a snapshot that no longer exists. Two archives used to
+ * plan against the same landscape bytes and the second's splice silently
+ * dropped the first's additions — exit 0 on both, and a `validate` that stayed
+ * green because the surviving document was perfectly coherent.
+ *
+ * link(2) over a fully-written sibling is the primitive: as atomic as the
+ * O_EXCL create it replaced, needs no daemon, and leaves a file a human can
+ * read and delete — but unlike open-then-write, the lock file can never be
+ * OBSERVED empty. `writeFile(path, …, "wx")` published existence first and
+ * payload a syscall later, and in that window (or after a crash inside it) the
+ * lock named no holder: `doctor` now grades exactly that shape as damage whose
+ * fix is deletion, so the healthy path must never wear it, even for a
+ * microsecond. A create that dies before its link leaves only a staging temp
+ * `doctor` already names as litter. A holder that died without releasing would
+ * otherwise wedge the repo forever, so a lock naming a pid on THIS host that
+ * no longer exists is broken once and retried. Breaking removes only the
+ * instance that was judged dead (see `breakStaleLock`), never a successor's
+ * live lock. This comment used to accept that two racers could both break the
+ * same stale lock, trusting the pre-image check in `swapStaged` as the second
+ * line of defence. That check is still kept, and is still not an
+ * optimisation. But it guards only the swap. A second holder's RECOVERY reads
+ * the first holder's in-flight journal as an interrupted commit and sweeps
+ * its staged temps, and no compare-and-set sits in front of that.
+ */
+/**
+ * Distinguishes concurrent acquires INSIDE one process. `tempPath` salts with
+ * pid and a millisecond timestamp, which is unique across processes and not
+ * within one: two in-process acquirers in the same millisecond shared a temp
+ * name, the first's cleanup deleted it under the second, and the second's
+ * link(2) surfaced ENOENT as `internal`. The private name a stale-lock break
+ * takes the lock to is salted from the same counter, for the same reason. A
+ * bare counter is module-level mutable state, tolerated here because it feeds
+ * nothing but name uniqueness — no behaviour ever branches on its value.
+ */
+let lockAcquireSeq = 0;
+export async function acquireDocsLock(docsDir) {
+    const path = join(docsDir, DOCS_LOCK);
+    const payload = `${JSON.stringify({ pid: process.pid, host: hostname(), at: new Date().toISOString() })}\n`;
+    lockAcquireSeq += 1;
+    const tmp = tempPath(path, lockAcquireSeq);
+    await writeFile(tmp, payload);
+    try {
+        for (let attempt = 0;; attempt += 1) {
+            try {
+                await link(tmp, path);
+            }
+            catch (err) {
+                if (err.code !== "EEXIST")
+                    throw err;
+                if (attempt === 0 && (await breakStaleLock(path)))
+                    continue;
+                throw new DocsBusyError(path, await describeLock(path));
+            }
+            let released = false;
+            return async () => {
+                if (released)
+                    return;
+                released = true;
+                await quietRm(path);
+            };
+        }
+    }
+    finally {
+        await quietRm(tmp);
+    }
+}
+/**
+ * Take the docs lock, waiting out a live holder instead of refusing on first
+ * contact. Same lock, different caller contract: `archive` refuses fast because
+ * its holder may be mid-merge for seconds and its caller can re-run, but two
+ * `verify --record` runs for different services of one feature are BOTH
+ * supposed to land — the second must wait for the first's sub-second window and
+ * then merge over the record it left, or one service's attestation is refused
+ * for no reason a user can see. The wait is bounded: a holder that outlives
+ * `waitMs` yields the same `DocsBusyError` the fast form throws, so the caller
+ * maps it to `docs-busy` either way and nothing hangs on a wedged lock.
+ */
+export async function acquireDocsLockWaiting(docsDir, waitMs) {
+    const deadline = Date.now() + waitMs;
+    for (;;) {
+        try {
+            return await acquireDocsLock(docsDir);
+        }
+        catch (err) {
+            if (!(err instanceof DocsBusyError) || Date.now() >= deadline)
+                throw err;
+        }
+        // Short enough that a released lock is picked up before a human notices;
+        // long enough that the poll does not busy-spin the directory.
+        await new Promise((resolve) => setTimeout(resolve, 25));
+    }
+}
+async function readLockHolder(path) {
+    let text;
+    try {
+        text = await readFile(path, "utf8");
+    }
+    catch (err) {
+        return err.code === "ENOENT" ? { kind: "absent" } : { kind: "unreadable" };
+    }
+    let holder;
+    try {
+        holder = JSON.parse(text);
+    }
+    catch {
+        return { kind: "unreadable" };
+    }
+    // A lock file holding `null` (or a bare string, or an array) is JSON this
+    // parses and nothing else understands. The dereference below used to run
+    // outside the guard in `acquireDocsLock`'s breaker and threw, replacing the
+    // `docs-busy` refusal — the designed answer — with an `internal` envelope.
+    if (!isRecord(holder) || typeof holder.host !== "string" || typeof holder.pid !== "number") {
+        return { kind: "unreadable" };
+    }
+    return { kind: "held", host: holder.host, pid: holder.pid, at: typeof holder.at === "string" ? holder.at : undefined };
+}
+/** Does this pid no longer exist on this host? Signal 0 asks without delivering; EPERM is alive-but-somebody-else's. */
+function pidGone(pid) {
+    try {
+        process.kill(pid, 0);
+        return false;
+    }
+    catch (err) {
+        return err.code === "ESRCH";
+    }
+}
+/**
+ * Remove a lock whose holder is a dead process on this same host, and only the
+ * lock INSTANCE that verdict was about. Returns whether it did.
+ *
+ * The verdict comes from a read, the removal acts on a path, and other writers
+ * move in between. The removal used to be a bare unlink(2) of the path. Under
+ * CPU load a waiter read the holder's payload, then the holder released
+ * NORMALLY and exited, then a third writer linked a fresh lock, and only then
+ * did kill(pid, 0) answer ESRCH. The unlink deleted that third writer's LIVE
+ * lock. Two `loam gherkin` runs then shared one commit window, and the
+ * second's recovery read the first's in-flight journal as "interrupted" and
+ * swept its staged temps. The first's rename failed ENOENT
+ * (test/stress-gherkin.test.ts found it; test/lock-break.test.ts opens each
+ * window on purpose).
+ *
+ * So the removal is bound to the judged instance, twice:
+ *  - the lock is re-read AFTER the verdict and must still name the judged
+ *    holder. A holder that released normally removed its file before it
+ *    exited, so a dead holder's lock still in place can only be a crashed
+ *    one's, which is the one lock a break is for;
+ *  - it is then TAKEN by rename(2) to a private name, which exactly one of
+ *    several concurrent breakers can win, and judged in hand. If what moved is
+ *    not the judged instance (another waiter broke the same crashed lock first
+ *    and linked its own in between), it goes back by link(2), which never
+ *    overwrites.
+ * One gap stays open, between that take and the put-back. A third writer can
+ * link in it, and then the displaced lock stays down. Or the displaced holder
+ * can release in it, and then the put-back restores a lock nobody holds, which
+ * stands until that process exits. Either needs a crashed holder AND two
+ * breakers racing for its lock. The gap is named here rather than closed,
+ * because closing it needs a kernel lock (flock) that Node does not expose and
+ * loam will not add a dependency for.
+ */
+async function breakStaleLock(path) {
+    const judged = await readLockHolder(path);
+    // Unreadable is deliberately NOT breakable: a lock we cannot understand is
+    // the one case where guessing is worst. `doctor` reports it as damage.
+    if (judged.kind !== "held" || judged.host !== hostname() || !pidGone(judged.pid))
+        return false;
+    if (!sameHolder(await readLockHolder(path), judged))
+        return false;
+    lockAcquireSeq += 1;
+    const taken = tempPath(path, lockAcquireSeq);
+    try {
+        await rename(path, taken);
+    }
+    catch {
+        // Another breaker took it first, or the platform refused the rename (a
+        // Windows handle still open on it). Either way the next link(2) attempt
+        // decides, not this one.
+        return false;
+    }
+    if (sameHolder(await readLockHolder(taken), judged)) {
+        await quietRm(taken);
+        return true;
+    }
+    try {
+        await link(taken, path);
+    }
+    catch {
+        // The gap named above: a third writer linked in between, and putting the
+        // displaced lock back would overwrite a live one. It stays down. Its holder
+        // is unprotected from here, and nothing this process can do fixes that.
+    }
+    await quietRm(taken);
+    return false;
+}
+/** Is `now` the very lock instance `judged` was read from? Pid, host and timestamp are its identity. */
+function sameHolder(now, judged) {
+    return now.kind === "held" && now.pid === judged.pid && now.host === judged.host && now.at === judged.at;
+}
+export async function describeLock(path) {
+    const holder = await readLockHolder(path);
+    return holder.kind === "held" ? `pid ${holder.pid} on ${holder.host} since ${String(holder.at)}` : `see ${path}`;
+}
+/**
+ * The lock's whole state for `doctor`, from ONE read. Null means no lock.
+ * Three sequential reads used to answer this — exists, describe, stale — and a
+ * lock released between them made `doctor` describe a file that was gone,
+ * escalating an ordinary sub-second commit window into a blocker.
+ */
+export async function lockResidue(path) {
+    const holder = await readLockHolder(path);
+    if (holder.kind === "absent")
+        return null;
+    if (holder.kind === "unreadable")
+        return { holder: `see ${path}`, stale: false, unreadable: true };
+    return {
+        holder: `pid ${holder.pid} on ${holder.host} since ${String(holder.at)}`,
+        stale: holder.host === hostname() && pidGone(holder.pid),
+        unreadable: false,
+    };
+}
+//# sourceMappingURL=lock.js.map

package/dist/core/staging/lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.js","sourceRoot":"","sources":["../../../src/core/staging/lock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,+EAA+E;AAC/E,6EAA6E;AAC7E,8EAA8E;AAC9E,gFAAgF;AAChF,6EAA6E;AAC7E,cAAc;AACd,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEhD,0FAA0F;AAC1F,MAAM,CAAC,MAAM,SAAS,GAAG,YAAY,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC;AAElC,8FAA8F;AAC9F,MAAM,OAAO,aAAc,SAAQ,KAAK;IAI3B,QAAQ;IAHD,IAAI,GAAG,eAAe,CAAC;IAEzC,YACW,QAAgB,EACzB,MAAc;QAEd,KAAK,CACH,mDAAmD,MAAM,mCAAmC;YAC1F,oCAAoC,QAAQ,iCAAiC,CAChF,CAAC;wBANO,QAAQ;IAOnB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH;;;;;;;;;GASG;AACH,IAAI,cAAc,GAAG,CAAC,CAAC;AAEvB,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAe;IACnD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC;IAC5G,cAAc,IAAI,CAAC,CAAC;IACpB,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC3C,MAAM,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,CAAC;QACH,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,IAAI,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACxB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ;oBAAE,MAAM,GAAG,CAAC;gBAChE,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;oBAAE,SAAS;gBAC5D,MAAM,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,OAAO,KAAK,IAAI,EAAE;gBAChB,IAAI,QAAQ;oBAAE,OAAO;gBACrB,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC,CAAC;QACJ,CAAC;IACH,CAAC;YAAS,CAAC;QACT,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,OAAe,EAAE,MAAc;IAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC;IACrC,SAAS,CAAC;QACR,IAAI,CAAC;YACH,OAAO,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,aAAa,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ;gBAAE,MAAM,GAAG,CAAC;QAC3E,CAAC;QACD,yEAAyE;QACzE,8DAA8D;QAC9D,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAsBD,KAAK,UAAU,cAAc,CAAC,IAAY;IACxC,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAQ,GAA6B,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IACxG,CAAC;IACD,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAChC,CAAC;IACD,0EAA0E;IAC1E,yEAAyE;IACzE,4EAA4E;IAC5E,2EAA2E;IAC3E,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC3F,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAChC,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,OAAO,MAAM,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;AACzH,CAAC;AAED,wHAAwH;AACxH,SAAS,OAAO,CAAC,GAAW;IAC1B,IAAI,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAQ,GAA6B,CAAC,IAAI,KAAK,OAAO,CAAC;IACzD,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,KAAK,UAAU,cAAc,CAAC,IAAY;IACxC,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAC1C,2EAA2E;IAC3E,uEAAuE;IACvE,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/F,IAAI,CAAC,UAAU,CAAC,MAAM,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IAClE,cAAc,IAAI,CAAC,CAAC;IACpB,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC7C,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,uEAAuE;QACvE,wEAAwE;QACxE,yBAAyB;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,MAAM,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC;QACpD,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,yEAAyE;QACzE,4EAA4E;QAC5E,wEAAwE;IAC1E,CAAC;IACD,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,wGAAwG;AACxG,SAAS,UAAU,CAAC,GAAe,EAAE,MAA6C;IAChF,OAAO,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC;AAC3G,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAY;IAC7C,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,GAAG,OAAO,MAAM,CAAC,IAAI,UAAU,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;AACnH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAY;IAC5C,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC1C,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY;QAAE,OAAO,EAAE,MAAM,EAAE,OAAO,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACnG,OAAO;QACL,MAAM,EAAE,OAAO,MAAM,CAAC,GAAG,OAAO,MAAM,CAAC,IAAI,UAAU,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;QACxE,KAAK,EAAE,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;QACxD,UAAU,EAAE,KAAK;KAClB,CAAC;AACJ,CAAC","sourcesContent":["/**\n * The docs repo's advisory lock: take it, describe its holder, and break it\n * when that holder is a pid on this host that no longer exists.\n *\n * A module of its own because it is the only rule here that spans the whole\n * fleet rather than one file, and because the two readers of a held lock have\n * to agree on what \"stale\" means — `breakStaleLock` acts on the answer,\n * `lockIsStale` only reports it to `doctor`. They were written as twins and\n * stay together so they cannot drift into two definitions of a dead holder.\n */\nimport { link, readFile, rename, writeFile } from \"node:fs/promises\";\nimport { hostname } from \"node:os\";\nimport { join } from \"node:path\";\n// Every `isRecord` below guards a record loam itself wrote and is reading back\n// — the lock, the snapshot manifest — whose fields are asked for on the very\n// next line, inside a REFUSAL path. `JSON.parse` answers with any JSON value,\n// not with an object, and that is where a thrown `TypeError` costs the most: it\n// does not make the command fail safely, it replaces a designed refusal with\n// `internal`.\nimport { isRecord } from \"../kernel/records.js\";\nimport { quietRm, tempPath } from \"./commit.js\";\n\n/** The lock file, in the docs repo root — one writer at a time across the whole fleet. */\nexport const DOCS_LOCK = \".loam-lock\";\n\n/**\n * How long a WAITING writer sits out a live holder before answering\n * `docs-busy`. One spelling for every writer that waits — including gherkin,\n * whose lock guards the SERVICE repo's emission root rather than the docs\n * repo: long enough to cover another writer's sub-second commit window with a\n * margin for a loaded host, bounded so a wedged lock cannot hang anyone.\n */\nexport const LOCK_WAIT_MS = 5_000;\n\n/** Another writer holds the docs repo. Commands map this to the `docs-busy` envelope code. */\nexport class DocsBusyError extends Error {\n  override readonly name = \"DocsBusyError\";\n\n  constructor(\n    readonly lockPath: string,\n    holder: string,\n  ) {\n    super(\n      `another loam command is writing this docs repo (${holder}) — nothing was read or written. ` +\n        `Wait for it to finish, or remove ${lockPath} if no such command is running.`,\n    );\n  }\n}\n\n/**\n * Take the docs repo's advisory lock for the whole plan+commit window, and\n * return the release.\n *\n * Advisory, and deliberately coarse: the destructive commands write the SAME\n * three shared files (a service spec, a service contract, the one landscape),\n * so two of them overlapping is not a merge to be resolved but a merge one of\n * them computed against a snapshot that no longer exists. Two archives used to\n * plan against the same landscape bytes and the second's splice silently\n * dropped the first's additions — exit 0 on both, and a `validate` that stayed\n * green because the surviving document was perfectly coherent.\n *\n * link(2) over a fully-written sibling is the primitive: as atomic as the\n * O_EXCL create it replaced, needs no daemon, and leaves a file a human can\n * read and delete — but unlike open-then-write, the lock file can never be\n * OBSERVED empty. `writeFile(path, …, \"wx\")` published existence first and\n * payload a syscall later, and in that window (or after a crash inside it) the\n * lock named no holder: `doctor` now grades exactly that shape as damage whose\n * fix is deletion, so the healthy path must never wear it, even for a\n * microsecond. A create that dies before its link leaves only a staging temp\n * `doctor` already names as litter. A holder that died without releasing would\n * otherwise wedge the repo forever, so a lock naming a pid on THIS host that\n * no longer exists is broken once and retried. Breaking removes only the\n * instance that was judged dead (see `breakStaleLock`), never a successor's\n * live lock. This comment used to accept that two racers could both break the\n * same stale lock, trusting the pre-image check in `swapStaged` as the second\n * line of defence. That check is still kept, and is still not an\n * optimisation. But it guards only the swap. A second holder's RECOVERY reads\n * the first holder's in-flight journal as an interrupted commit and sweeps\n * its staged temps, and no compare-and-set sits in front of that.\n */\n/**\n * Distinguishes concurrent acquires INSIDE one process. `tempPath` salts with\n * pid and a millisecond timestamp, which is unique across processes and not\n * within one: two in-process acquirers in the same millisecond shared a temp\n * name, the first's cleanup deleted it under the second, and the second's\n * link(2) surfaced ENOENT as `internal`. The private name a stale-lock break\n * takes the lock to is salted from the same counter, for the same reason. A\n * bare counter is module-level mutable state, tolerated here because it feeds\n * nothing but name uniqueness — no behaviour ever branches on its value.\n */\nlet lockAcquireSeq = 0;\n\nexport async function acquireDocsLock(docsDir: string): Promise<() => Promise<void>> {\n  const path = join(docsDir, DOCS_LOCK);\n  const payload = `${JSON.stringify({ pid: process.pid, host: hostname(), at: new Date().toISOString() })}\\n`;\n  lockAcquireSeq += 1;\n  const tmp = tempPath(path, lockAcquireSeq);\n  await writeFile(tmp, payload);\n  try {\n    for (let attempt = 0; ; attempt += 1) {\n      try {\n        await link(tmp, path);\n      } catch (err) {\n        if ((err as NodeJS.ErrnoException).code !== \"EEXIST\") throw err;\n        if (attempt === 0 && (await breakStaleLock(path))) continue;\n        throw new DocsBusyError(path, await describeLock(path));\n      }\n      let released = false;\n      return async () => {\n        if (released) return;\n        released = true;\n        await quietRm(path);\n      };\n    }\n  } finally {\n    await quietRm(tmp);\n  }\n}\n\n/**\n * Take the docs lock, waiting out a live holder instead of refusing on first\n * contact. Same lock, different caller contract: `archive` refuses fast because\n * its holder may be mid-merge for seconds and its caller can re-run, but two\n * `verify --record` runs for different services of one feature are BOTH\n * supposed to land — the second must wait for the first's sub-second window and\n * then merge over the record it left, or one service's attestation is refused\n * for no reason a user can see. The wait is bounded: a holder that outlives\n * `waitMs` yields the same `DocsBusyError` the fast form throws, so the caller\n * maps it to `docs-busy` either way and nothing hangs on a wedged lock.\n */\nexport async function acquireDocsLockWaiting(docsDir: string, waitMs: number): Promise<() => Promise<void>> {\n  const deadline = Date.now() + waitMs;\n  for (;;) {\n    try {\n      return await acquireDocsLock(docsDir);\n    } catch (err) {\n      if (!(err instanceof DocsBusyError) || Date.now() >= deadline) throw err;\n    }\n    // Short enough that a released lock is picked up before a human notices;\n    // long enough that the poll does not busy-spin the directory.\n    await new Promise((resolve) => setTimeout(resolve, 25));\n  }\n}\n\n/**\n * One read of the lock file, one interpretation, shared by every question\n * asked about it. These used to be four separate parse-and-guard copies\n * (`breakStaleLock`, `describeLock`, `lockIsStale`, `lockUnreadable`), each\n * catching to a different answer — which is how `doctor` came to read the file\n * three times in a row and report three different states of a lock that was\n * released between its reads.\n *\n * `absent` and `unreadable` are kept apart on purpose: a lock that is GONE is\n * the ordinary end of every command, while a lock that exists and cannot name\n * a holder — empty bytes from a crash between create and flush, JSON that is\n * not a record, a record with no string `host` or numeric `pid` — is damage:\n * `breakStaleLock` rightly refuses to guess about it, so nothing will ever\n * release it. A different host's lock is legible and simply not ours to judge.\n */\ntype LockHolder =\n  | { kind: \"absent\" }\n  | { kind: \"unreadable\" }\n  | { kind: \"held\"; host: string; pid: number; at: string | undefined };\n\nasync function readLockHolder(path: string): Promise<LockHolder> {\n  let text: string;\n  try {\n    text = await readFile(path, \"utf8\");\n  } catch (err) {\n    return (err as NodeJS.ErrnoException).code === \"ENOENT\" ? { kind: \"absent\" } : { kind: \"unreadable\" };\n  }\n  let holder: unknown;\n  try {\n    holder = JSON.parse(text);\n  } catch {\n    return { kind: \"unreadable\" };\n  }\n  // A lock file holding `null` (or a bare string, or an array) is JSON this\n  // parses and nothing else understands. The dereference below used to run\n  // outside the guard in `acquireDocsLock`'s breaker and threw, replacing the\n  // `docs-busy` refusal — the designed answer — with an `internal` envelope.\n  if (!isRecord(holder) || typeof holder.host !== \"string\" || typeof holder.pid !== \"number\") {\n    return { kind: \"unreadable\" };\n  }\n  return { kind: \"held\", host: holder.host, pid: holder.pid, at: typeof holder.at === \"string\" ? holder.at : undefined };\n}\n\n/** Does this pid no longer exist on this host? Signal 0 asks without delivering; EPERM is alive-but-somebody-else's. */\nfunction pidGone(pid: number): boolean {\n  try {\n    process.kill(pid, 0);\n    return false;\n  } catch (err) {\n    return (err as NodeJS.ErrnoException).code === \"ESRCH\";\n  }\n}\n\n/**\n * Remove a lock whose holder is a dead process on this same host, and only the\n * lock INSTANCE that verdict was about. Returns whether it did.\n *\n * The verdict comes from a read, the removal acts on a path, and other writers\n * move in between. The removal used to be a bare unlink(2) of the path. Under\n * CPU load a waiter read the holder's payload, then the holder released\n * NORMALLY and exited, then a third writer linked a fresh lock, and only then\n * did kill(pid, 0) answer ESRCH. The unlink deleted that third writer's LIVE\n * lock. Two `loam gherkin` runs then shared one commit window, and the\n * second's recovery read the first's in-flight journal as \"interrupted\" and\n * swept its staged temps. The first's rename failed ENOENT\n * (test/stress-gherkin.test.ts found it; test/lock-break.test.ts opens each\n * window on purpose).\n *\n * So the removal is bound to the judged instance, twice:\n *  - the lock is re-read AFTER the verdict and must still name the judged\n *    holder. A holder that released normally removed its file before it\n *    exited, so a dead holder's lock still in place can only be a crashed\n *    one's, which is the one lock a break is for;\n *  - it is then TAKEN by rename(2) to a private name, which exactly one of\n *    several concurrent breakers can win, and judged in hand. If what moved is\n *    not the judged instance (another waiter broke the same crashed lock first\n *    and linked its own in between), it goes back by link(2), which never\n *    overwrites.\n * One gap stays open, between that take and the put-back. A third writer can\n * link in it, and then the displaced lock stays down. Or the displaced holder\n * can release in it, and then the put-back restores a lock nobody holds, which\n * stands until that process exits. Either needs a crashed holder AND two\n * breakers racing for its lock. The gap is named here rather than closed,\n * because closing it needs a kernel lock (flock) that Node does not expose and\n * loam will not add a dependency for.\n */\nasync function breakStaleLock(path: string): Promise<boolean> {\n  const judged = await readLockHolder(path);\n  // Unreadable is deliberately NOT breakable: a lock we cannot understand is\n  // the one case where guessing is worst. `doctor` reports it as damage.\n  if (judged.kind !== \"held\" || judged.host !== hostname() || !pidGone(judged.pid)) return false;\n  if (!sameHolder(await readLockHolder(path), judged)) return false;\n  lockAcquireSeq += 1;\n  const taken = tempPath(path, lockAcquireSeq);\n  try {\n    await rename(path, taken);\n  } catch {\n    // Another breaker took it first, or the platform refused the rename (a\n    // Windows handle still open on it). Either way the next link(2) attempt\n    // decides, not this one.\n    return false;\n  }\n  if (sameHolder(await readLockHolder(taken), judged)) {\n    await quietRm(taken);\n    return true;\n  }\n  try {\n    await link(taken, path);\n  } catch {\n    // The gap named above: a third writer linked in between, and putting the\n    // displaced lock back would overwrite a live one. It stays down. Its holder\n    // is unprotected from here, and nothing this process can do fixes that.\n  }\n  await quietRm(taken);\n  return false;\n}\n\n/** Is `now` the very lock instance `judged` was read from? Pid, host and timestamp are its identity. */\nfunction sameHolder(now: LockHolder, judged: Extract<LockHolder, { kind: \"held\" }>): boolean {\n  return now.kind === \"held\" && now.pid === judged.pid && now.host === judged.host && now.at === judged.at;\n}\n\nexport async function describeLock(path: string): Promise<string> {\n  const holder = await readLockHolder(path);\n  return holder.kind === \"held\" ? `pid ${holder.pid} on ${holder.host} since ${String(holder.at)}` : `see ${path}`;\n}\n\n/**\n * The lock's whole state for `doctor`, from ONE read. Null means no lock.\n * Three sequential reads used to answer this — exists, describe, stale — and a\n * lock released between them made `doctor` describe a file that was gone,\n * escalating an ordinary sub-second commit window into a blocker.\n */\nexport async function lockResidue(path: string): Promise<{ holder: string; stale: boolean; unreadable: boolean } | null> {\n  const holder = await readLockHolder(path);\n  if (holder.kind === \"absent\") return null;\n  if (holder.kind === \"unreadable\") return { holder: `see ${path}`, stale: false, unreadable: true };\n  return {\n    holder: `pid ${holder.pid} on ${holder.host} since ${String(holder.at)}`,\n    stale: holder.host === hostname() && pidGone(holder.pid),\n    unreadable: false,\n  };\n}\n\n"]}

package/dist/core/staging/recovery/finding.js

@@ -0,0 +1,35 @@
+/**
+ * What an unfinished write means for `loam validate`.
+ *
+ * `core/doctor/residue.ts` grades the same fact for `doctor`; this module
+ * answers for `loam validate --all` — the fleet gate — and `loam gate`, the
+ * deploy-time query, reuses the same finding verbatim for its interrupted
+ * check. A `.loam-commit` in the repo means the last writer's commit never finished:
+ * some files hold the new bytes, some the old, and a validate that grades
+ * that tree green is certifying a state no run ever produced. In CI that
+ * green MERGES, which is why this is an error finding and not a warning.
+ */
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+import { COMMIT_INTENT } from "../interrupted.js";
+import {} from "../../vocabulary/report.js";
+import { readTxnIntent } from "../txn/journal.js";
+import { readCommitIntent } from "./intent.js";
+/** The error every validate mode leads with while a journal sits in the repo, or null. */
+export async function interruptedCommitFinding(docsDir) {
+    if (!existsSync(join(docsDir, COMMIT_INTENT)))
+        return null;
+    const intent = (await readCommitIntent(docsDir)) ?? (await readTxnIntent(docsDir));
+    const what = intent === null
+        ? `a commit this loam cannot read — check the living docs against version control, delete ${COMMIT_INTENT}, then re-run`
+        : "rerun" in intent
+            ? `an interrupted \`${intent.rerun}\` — re-running it recovers first, and \`loam doctor\` names the pending files and directory moves`
+            : `an interrupted \`loam ${intent.command} ${intent.feature}\` — re-running it recovers first, and \`loam doctor\` names the files`;
+    return {
+        severity: "error",
+        code: "docs.commit-interrupted",
+        message: `${COMMIT_INTENT} records ${what}. ` +
+            "Until it is gone the files under this journal's root may be half-committed, so nothing graded from them can be trusted to describe one state.",
+    };
+}
+//# sourceMappingURL=finding.js.map

package/dist/core/staging/recovery/finding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"finding.js","sourceRoot":"","sources":["../../../../src/core/staging/recovery/finding.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAgB,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,0FAA0F;AAC1F,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,OAAe;IAC5D,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC3D,MAAM,MAAM,GAAG,CAAC,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACnF,MAAM,IAAI,GACR,MAAM,KAAK,IAAI;QACb,CAAC,CAAC,0FAA0F,aAAa,eAAe;QACxH,CAAC,CAAC,OAAO,IAAI,MAAM;YACjB,CAAC,CAAC,oBAAoB,MAAM,CAAC,KAAK,oGAAoG;YACtI,CAAC,CAAC,yBAAyB,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,wEAAwE,CAAC;IAC1I,OAAO;QACL,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,yBAAyB;QAC/B,OAAO,EACL,GAAG,aAAa,YAAY,IAAI,IAAI;YACpC,+IAA+I;KAClJ,CAAC;AACJ,CAAC","sourcesContent":["/**\n * What an unfinished write means for `loam validate`.\n *\n * `core/doctor/residue.ts` grades the same fact for `doctor`; this module\n * answers for `loam validate --all` — the fleet gate — and `loam gate`, the\n * deploy-time query, reuses the same finding verbatim for its interrupted\n * check. A `.loam-commit` in the repo means the last writer's commit never finished:\n * some files hold the new bytes, some the old, and a validate that grades\n * that tree green is certifying a state no run ever produced. In CI that\n * green MERGES, which is why this is an error finding and not a warning.\n */\nimport { existsSync } from \"node:fs\";\nimport { join } from \"node:path\";\nimport { COMMIT_INTENT } from \"../interrupted.js\";\nimport { type Finding } from \"../../vocabulary/report.js\";\nimport { readTxnIntent } from \"../txn/journal.js\";\nimport { readCommitIntent } from \"./intent.js\";\n\n/** The error every validate mode leads with while a journal sits in the repo, or null. */\nexport async function interruptedCommitFinding(docsDir: string): Promise<Finding | null> {\n  if (!existsSync(join(docsDir, COMMIT_INTENT))) return null;\n  const intent = (await readCommitIntent(docsDir)) ?? (await readTxnIntent(docsDir));\n  const what =\n    intent === null\n      ? `a commit this loam cannot read — check the living docs against version control, delete ${COMMIT_INTENT}, then re-run`\n      : \"rerun\" in intent\n        ? `an interrupted \\`${intent.rerun}\\` — re-running it recovers first, and \\`loam doctor\\` names the pending files and directory moves`\n        : `an interrupted \\`loam ${intent.command} ${intent.feature}\\` — re-running it recovers first, and \\`loam doctor\\` names the files`;\n  return {\n    severity: \"error\",\n    code: \"docs.commit-interrupted\",\n    message:\n      `${COMMIT_INTENT} records ${what}. ` +\n      \"Until it is gone the files under this journal's root may be half-committed, so nothing graded from them can be trusted to describe one state.\",\n  };\n}\n"]}

package/dist/core/staging/recovery/intent.js

@@ -0,0 +1,95 @@
+/**
+ * The `.loam-commit` journal — written before the first swap, cleared after the
+ * last — and the record that makes an interrupted commit detectable at all.
+ *
+ * Reading and writing the record is kept apart from acting on it
+ * (`./recover.ts`) because a corrupt record has to stay describable: `doctor`
+ * reports a `.loam-commit` it cannot parse, and a module that parsed and
+ * repaired in one step would have no way to say that without also attempting
+ * the repair.
+ */
+import { existsSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import { hostname } from "node:os";
+import { join } from "node:path";
+import { repoPath } from "../../envelope/json.js";
+import { isPathInside } from "../../kernel/path-safety.js";
+import { COMMIT_INTENT, writeDurable } from "../interrupted.js";
+import { isDigest, sha256 } from "../writes.js";
+import { quietRm } from "../commit.js";
+/** The version-1 record: archive's and unarchive's snapshot-backed journal. */
+const COMMIT_INTENT_VERSION = 1;
+/**
+ * Write the intent record and get it onto the disk before the first swap.
+ *
+ * fsync, not just write — through `writeDurable`, whose doc says why: the
+ * point of the record is to survive the crash that interrupts the commit.
+ */
+export async function writeCommitIntent(docsDir, spec, staged) {
+    const intent = {
+        version: COMMIT_INTENT_VERSION,
+        command: spec.command,
+        restore: spec.restore,
+        pid: process.pid,
+        host: hostname(),
+        at: new Date().toISOString(),
+        feature: spec.feature,
+        moveFrom: repoPath(docsDir, spec.moveFrom),
+        moveTo: repoPath(docsDir, spec.moveTo),
+        files: staged.map((s) => ({
+            path: repoPath(docsDir, s.write.path),
+            before: s.before === null ? null : sha256(s.before),
+            after: s.content === null ? null : sha256(s.content),
+        })),
+    };
+    await writeDurable(join(docsDir, COMMIT_INTENT), JSON.stringify(intent, null, 2) + "\n");
+}
+/** The commit finished (or was rolled back): there is nothing left to recover from. */
+export async function clearCommitIntent(docsDir) {
+    await quietRm(join(docsDir, COMMIT_INTENT));
+}
+/** The intent record as written, or null when it is absent or unreadable. */
+export async function readCommitIntent(docsDir) {
+    const path = join(docsDir, COMMIT_INTENT);
+    if (!existsSync(path))
+        return null;
+    let parsed;
+    try {
+        parsed = JSON.parse(await readFile(path, "utf8"));
+    }
+    catch {
+        return null;
+    }
+    const i = parsed;
+    if (i === null || typeof i !== "object")
+        return null;
+    if (i.version !== COMMIT_INTENT_VERSION)
+        return null;
+    if (i.command !== "archive" && i.command !== "unarchive")
+        return null;
+    if (i.restore !== "before" && i.restore !== "after")
+        return null;
+    if (typeof i.feature !== "string" || typeof i.moveFrom !== "string" || typeof i.moveTo !== "string")
+        return null;
+    if (!Array.isArray(i.files))
+        return null;
+    // The journal is untrusted input, and recovery writes over what it names —
+    // the same containment the version-2 reader enforces, because an entry
+    // escaping the docs repo would turn repair into an arbitrary write.
+    const inside = (rel) => isPathInside(join(docsDir), join(docsDir, ...rel.split("/")));
+    if (!inside(i.moveFrom) || !inside(i.moveTo))
+        return null;
+    for (const f of i.files) {
+        if (typeof f?.path !== "string")
+            return null;
+        if (!isDigestOrNull(f.before) || !isDigestOrNull(f.after))
+            return null;
+        if (!inside(f.path))
+            return null;
+    }
+    return i;
+}
+function isDigestOrNull(value) {
+    return value === null || isDigest(value);
+}
+//# sourceMappingURL=intent.js.map

package/dist/core/staging/recovery/intent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"intent.js","sourceRoot":"","sources":["../../../../src/core/staging/recovery/intent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAoB,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,+EAA+E;AAC/E,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAiChC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAe,EACf,IAMC,EACD,MAAqB;IAErB,MAAM,MAAM,GAAiB;QAC3B,OAAO,EAAE,qBAAqB;QAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,IAAI,EAAE,QAAQ,EAAE;QAChB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,QAAQ,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC;QAC1C,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC;QACtC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACxB,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;YACrC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;YACnD,KAAK,EAAE,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;SACrD,CAAC,CAAC;KACJ,CAAC;IACF,MAAM,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AAC3F,CAAC;AAED,uFAAuF;AACvF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAe;IACrD,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,6EAA6E;AAC7E,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAe;IACpD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC1C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,CAAC,GAAG,MAA+B,CAAC;IAC1C,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACrD,IAAI,CAAC,CAAC,OAAO,KAAK,qBAAqB;QAAE,OAAO,IAAI,CAAC;IACrD,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,KAAK,WAAW;QAAE,OAAO,IAAI,CAAC;IACtE,IAAI,CAAC,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC;IACjE,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACjH,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,2EAA2E;IAC3E,uEAAuE;IACvE,oEAAoE;IACpE,MAAM,MAAM,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IAC1D,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,OAAO,CAAC,EAAE,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC7C,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACvE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;IACnC,CAAC;IACD,OAAO,CAAiB,CAAC;AAC3B,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,KAAK,KAAK,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["/**\n * The `.loam-commit` journal — written before the first swap, cleared after the\n * last — and the record that makes an interrupted commit detectable at all.\n *\n * Reading and writing the record is kept apart from acting on it\n * (`./recover.ts`) because a corrupt record has to stay describable: `doctor`\n * reports a `.loam-commit` it cannot parse, and a module that parsed and\n * repaired in one step would have no way to say that without also attempting\n * the repair.\n */\nimport { existsSync } from \"node:fs\";\nimport { readFile } from \"node:fs/promises\";\nimport { hostname } from \"node:os\";\nimport { join } from \"node:path\";\nimport { repoPath } from \"../../envelope/json.js\";\nimport { isPathInside } from \"../../kernel/path-safety.js\";\nimport { COMMIT_INTENT, writeDurable } from \"../interrupted.js\";\nimport { isDigest, sha256, type StagedWrite } from \"../writes.js\";\nimport { quietRm } from \"../commit.js\";\n\n/** The version-1 record: archive's and unarchive's snapshot-backed journal. */\nconst COMMIT_INTENT_VERSION = 1;\n\nexport interface CommitIntentFile {\n  /** Docs-repo-relative path, forward slashes. */\n  path: string;\n  /** sha256 of the bytes before the swap; null when the swap creates the file. */\n  before: string | null;\n  /** sha256 of the bytes the swap writes; null when the swap deletes the file. */\n  after: string | null;\n}\n\nexport interface CommitIntent {\n  version: number;\n  /** Which command was committing — the sentence a human reads, not a branch. */\n  command: \"archive\" | \"unarchive\";\n  /**\n   * The state a repair returns the docs to. `archive` undoes (its rollback path\n   * would have restored the pre-images anyway); `unarchive` finishes (its target\n   * bytes ARE the pre-images, and the merged text it was replacing is recorded\n   * nowhere else).\n   */\n  restore: \"before\" | \"after\";\n  pid: number;\n  host: string;\n  at: string;\n  feature: string;\n  /** Docs-repo-relative feature directory the commit's final move takes FROM. */\n  moveFrom: string;\n  /** …and TO. Both landed ⇒ every earlier step landed too. */\n  moveTo: string;\n  files: CommitIntentFile[];\n}\n\n/**\n * Write the intent record and get it onto the disk before the first swap.\n *\n * fsync, not just write — through `writeDurable`, whose doc says why: the\n * point of the record is to survive the crash that interrupts the commit.\n */\nexport async function writeCommitIntent(\n  docsDir: string,\n  spec: {\n    command: CommitIntent[\"command\"];\n    restore: CommitIntent[\"restore\"];\n    feature: string;\n    moveFrom: string;\n    moveTo: string;\n  },\n  staged: StagedWrite[],\n): Promise<void> {\n  const intent: CommitIntent = {\n    version: COMMIT_INTENT_VERSION,\n    command: spec.command,\n    restore: spec.restore,\n    pid: process.pid,\n    host: hostname(),\n    at: new Date().toISOString(),\n    feature: spec.feature,\n    moveFrom: repoPath(docsDir, spec.moveFrom),\n    moveTo: repoPath(docsDir, spec.moveTo),\n    files: staged.map((s) => ({\n      path: repoPath(docsDir, s.write.path),\n      before: s.before === null ? null : sha256(s.before),\n      after: s.content === null ? null : sha256(s.content),\n    })),\n  };\n  await writeDurable(join(docsDir, COMMIT_INTENT), JSON.stringify(intent, null, 2) + \"\\n\");\n}\n\n/** The commit finished (or was rolled back): there is nothing left to recover from. */\nexport async function clearCommitIntent(docsDir: string): Promise<void> {\n  await quietRm(join(docsDir, COMMIT_INTENT));\n}\n\n/** The intent record as written, or null when it is absent or unreadable. */\nexport async function readCommitIntent(docsDir: string): Promise<CommitIntent | null> {\n  const path = join(docsDir, COMMIT_INTENT);\n  if (!existsSync(path)) return null;\n  let parsed: unknown;\n  try {\n    parsed = JSON.parse(await readFile(path, \"utf8\"));\n  } catch {\n    return null;\n  }\n  const i = parsed as Partial<CommitIntent>;\n  if (i === null || typeof i !== \"object\") return null;\n  if (i.version !== COMMIT_INTENT_VERSION) return null;\n  if (i.command !== \"archive\" && i.command !== \"unarchive\") return null;\n  if (i.restore !== \"before\" && i.restore !== \"after\") return null;\n  if (typeof i.feature !== \"string\" || typeof i.moveFrom !== \"string\" || typeof i.moveTo !== \"string\") return null;\n  if (!Array.isArray(i.files)) return null;\n  // The journal is untrusted input, and recovery writes over what it names —\n  // the same containment the version-2 reader enforces, because an entry\n  // escaping the docs repo would turn repair into an arbitrary write.\n  const inside = (rel: string): boolean => isPathInside(join(docsDir), join(docsDir, ...rel.split(\"/\")));\n  if (!inside(i.moveFrom) || !inside(i.moveTo)) return null;\n  for (const f of i.files) {\n    if (typeof f?.path !== \"string\") return null;\n    if (!isDigestOrNull(f.before) || !isDigestOrNull(f.after)) return null;\n    if (!inside(f.path)) return null;\n  }\n  return i as CommitIntent;\n}\n\nfunction isDigestOrNull(value: unknown): boolean {\n  return value === null || isDigest(value);\n}\n\n"]}