@agentxm/workspace-operations 0.28.12 → 0.28.13

package/dist/src/operations/transition-lock.js

@@ -1,298 +0,0 @@
-// @effect-diagnostics nodeBuiltinImport:off — proper-lockfile requires a callback-style fs; the adapter is confined to the lock path
-/**
- * Workspace transition lock.
- *
- * One cross-process lock serializes mutation-class operations on a workspace.
- * A plan-family apply acquires it after confirmation — planning, network
- * acquisition, preview, and the confirmation decision stay lock-free — then
- * revalidates its candidate and applies while holding it; the workspace
- * transaction reuses the invocation's hold, or acquires its own when no
- * plan-family hold exists. A contending invocation waits with a visible
- * reason up to a bound, then terminates blocked with a machine-readable
- * reference to the holder.
- *
- * Each acquisition records a distinct owner token in the holder metadata.
- * Ownership is proven only by an exact token match — never inferred from a
- * pid or from missing or unreadable metadata — and a holder write that fails
- * releases the acquisition instead of holding anonymously.
- *
- * The lock file lives at `.axm/tmp/workspace-transition.lock`; its path is
- * load-bearing for operational tooling and must not move casually.
- *
- * Acquisition is atomic with respect to interruption: the narrow region from
- * the library granting the hold through finalizer registration is masked, so
- * an interrupt can never strand a granted lock, while contention waits stay
- * interruptible. Only the lock-is-held error class is absorbed by the bounded
- * wait; any other acquisition error surfaces immediately as a typed failure.
- *
- * @experimental This API is unstable and may change without notice.
- */
-import * as nodeFs from "node:fs";
-import { randomBytes } from "node:crypto";
-import * as Deferred from "effect/Deferred";
-import * as Duration from "effect/Duration";
-import * as Effect from "effect/Effect";
-import * as FileSystem from "effect/FileSystem";
-import * as Option from "effect/Option";
-import * as Path from "effect/Path";
-import * as lockfile from "proper-lockfile";
-import { TransitionLockError, WorkspaceDirectoryError, WorkspaceTransitionCompromised, } from "@agentxm/workspace-state";
-export const TRANSITION_LOCK_FILENAME = "workspace-transition.lock";
-// Staleness must tolerate a saturated event loop: a heavy apply starves the
-// mtime-update timer, and a slack smaller than the starvation lets a LIVE
-// holder's lock self-declare compromised — after which release refuses and the
-// dir is left for the next invocation to wait out. 25 s of slack covers the
-// longest observed starvation with room; a crashed holder delays a contender
-// at most this long, still inside the 60 s wait bound.
-const LOCK_STALE_MILLIS = 30_000;
-const LOCK_UPDATE_MILLIS = 5_000;
-const WAIT_INTERVAL = Duration.millis(250);
-/** How long a contending invocation serializes behind the holder. */
-export const TRANSITION_WAIT_BOUND_MILLIS = 60_000;
-/**
- * Held transition locks in this process, keyed by resolved workspace
- * directory. Owned exclusively by `acquireWorkspaceTransitionLock`, whose
- * scope finalizer removes the entry, so an entry's lifetime is exactly the
- * lock's; the workspace transaction consults it to avoid deadlocking on the
- * invocation's own hold and to observe compromise of that hold.
- */
-// eslint-disable-next-line no-restricted-syntax -- Owned exclusively by acquireWorkspaceTransitionLock: an entry's lifetime is exactly the lock's, and the acquisition's scope finalizer removes it.
-const heldTransitions = new Map();
-export const isWorkspaceTransitionHeldByThisInvocation = (workspaceDir) => heldTransitions.has(workspaceDir);
-/** The live hold for a workspace this process acquired, when one exists. */
-export const heldWorkspaceTransition = (workspaceDir) => heldTransitions.get(workspaceDir);
-const errorCode = (cause) => typeof cause === "object" && cause !== null && "code" in cause && typeof cause.code === "string"
-    ? cause.code
-    : undefined;
-export const transitionLockPath = (path, workspaceDir) => path.join(workspaceDir, "tmp", TRANSITION_LOCK_FILENAME);
-/**
- * The filesystem handed to `proper-lockfile`. Identical to the platform fs
- * except that removing a transition-lock directory first clears the tool's
- * own holder metadata inside it. The library reclaims a stale lock and
- * releases a held one with a non-recursive `rmdir`; without this, a lock
- * directory left by a crashed process — which always still contains
- * `holder.json` — could never be reclaimed, and every later mutation would
- * wait out its bound and report a false contention. Removal stays
- * non-recursive past that one owned name, so foreign content keeps blocking
- * removal the way it always did.
- */
-const lockDirectoryFs = {
-    ...nodeFs,
-    rmdir: (target, callback) => {
-        if (typeof target === "string" && target.endsWith(TRANSITION_LOCK_FILENAME)) {
-            nodeFs.unlink(`${target}/holder.json`, () => {
-                nodeFs.rmdir(target, callback);
-            });
-            return;
-        }
-        nodeFs.rmdir(target, callback);
-    },
-    rmdirSync: (target) => {
-        if (typeof target === "string" && target.endsWith(TRANSITION_LOCK_FILENAME)) {
-            try {
-                nodeFs.unlinkSync(`${target}/holder.json`);
-            }
-            catch {
-                // Absent metadata blocks nothing; foreign content still blocks rmdir.
-            }
-        }
-        nodeFs.rmdirSync(target);
-    },
-};
-/**
- * Acquisition-error classes the bounded contention wait absorbs: the lock is
- * held (`ELOCKED`), or the attempt raced the holder's own acquire, release,
- * or staleness sweep (`ENOENT`/`EEXIST` from proper-lockfile's internal
- * stat-remove-retry). Every other class — permissions, foreign state
- * squatting the path — is not resolved by waiting and surfaces immediately.
- */
-const isContentionErrorCode = (code) => code === "ELOCKED" || code === "ENOENT" || code === "EEXIST";
-const readHolder = (fs, path, lockPath) => fs.readFileString(path.join(lockPath, "holder.json")).pipe(Effect.map((content) => {
-    const parsed = JSON.parse(content);
-    if (typeof parsed === "object" &&
-        parsed !== null &&
-        "command" in parsed &&
-        typeof parsed.command === "string" &&
-        "pid" in parsed &&
-        typeof parsed.pid === "number") {
-        return Option.some({
-            command: parsed.command,
-            pid: parsed.pid,
-            ...("candidateId" in parsed && typeof parsed.candidateId === "string"
-                ? { candidateId: parsed.candidateId }
-                : {}),
-            ...("token" in parsed && typeof parsed.token === "string" ? { token: parsed.token } : {}),
-        });
-    }
-    return Option.none();
-}), Effect.catch(() => Effect.succeed(Option.none())));
-const writeHolder = (fs, path, lockPath, holder) => fs
-    .writeFileString(path.join(lockPath, "holder.json"), JSON.stringify(holder))
-    .pipe(Effect.mapError((cause) => new TransitionLockError({ path: lockPath, step: "record-holder", cause })));
-/**
- * Acquire the workspace transition lock, waiting up to the bound while
- * another invocation holds it. Resolves `None` when acquired (the release is
- * a scope finalizer) and `Some(contention)` when the bound elapsed.
- */
-export const acquireWorkspaceTransitionLock = (args) => Effect.gen(function* () {
-    const fs = yield* FileSystem.FileSystem;
-    const path = yield* Path.Path;
-    const workspaceDir = path.resolve(args.workspaceDir);
-    const scratchDir = path.join(workspaceDir, "tmp");
-    const lockPath = path.join(scratchDir, TRANSITION_LOCK_FILENAME);
-    const waitBound = args.waitBoundMillis ?? TRANSITION_WAIT_BOUND_MILLIS;
-    const workspaceExisted = yield* fs
-        .exists(workspaceDir)
-        .pipe(Effect.mapError((cause) => new WorkspaceDirectoryError({ path: workspaceDir, step: "inspect", cause })));
-    const removeEmptyScratch = fs.readDirectory(scratchDir).pipe(Effect.flatMap((entries) => entries.length === 0
-        ? fs.remove(scratchDir, { recursive: true, force: false })
-        : Effect.void), Effect.ignore);
-    const removeNewEmptyWorkspace = workspaceExisted
-        ? Effect.void
-        : fs.readDirectory(workspaceDir).pipe(Effect.flatMap((entries) => entries.length === 0
-            ? fs.remove(workspaceDir, { recursive: true, force: false })
-            : Effect.void), Effect.ignore);
-    const compromisedSignal = Deferred.makeUnsafe();
-    let waitedMillis = 0;
-    let reportedWaiting = false;
-    while (true) {
-        // The previous holder removes an empty scratch directory when it
-        // releases. Recreate it before every attempt so that a waiter can
-        // acquire after that cleanup instead of mistaking ENOENT for a hold.
-        yield* fs
-            .makeDirectory(scratchDir, { recursive: true })
-            .pipe(Effect.mapError((cause) => new TransitionLockError({ path: scratchDir, step: "create-scratch", cause })));
-        // One attempt is atomic with respect to interruption: from the library
-        // granting the hold through finalizer registration there is no
-        // interruptible gap, so an interrupt requested mid-acquisition defers
-        // until the release finalizer exists and then releases through it. The
-        // mask stays narrow — a single no-retry grant plus local metadata —
-        // and the contention wait below remains interruptible.
-        const attempt = yield* Effect.uninterruptible(Effect.gen(function* () {
-            const granted = yield* Effect.tryPromise({
-                try: () => lockfile.lock(workspaceDir, {
-                    lockfilePath: lockPath,
-                    realpath: false,
-                    retries: 0,
-                    fs: lockDirectoryFs,
-                    stale: args.timingMillis?.stale ?? LOCK_STALE_MILLIS,
-                    update: args.timingMillis?.update ?? LOCK_UPDATE_MILLIS,
-                    // The default handler throws inside a timer: an uncatchable
-                    // crash that sprays raw frames on stderr. Complete the typed
-                    // compromise signal instead — the workspace transaction races
-                    // against it and never continues mutating after ownership is
-                    // lost.
-                    onCompromised: (cause) => {
-                        Deferred.doneUnsafe(compromisedSignal, Effect.fail(new WorkspaceTransitionCompromised({ workspaceDir, lockPath, cause })));
-                    },
-                }),
-                catch: (cause) => ({ cause, code: errorCode(cause) }),
-            }).pipe(Effect.result);
-            if (granted._tag === "Failure") {
-                if (isContentionErrorCode(granted.failure.code)) {
-                    return { _tag: "held" };
-                }
-                return {
-                    _tag: "failed",
-                    error: new TransitionLockError({
-                        path: lockPath,
-                        step: "acquire",
-                        cause: granted.failure.cause,
-                    }),
-                };
-            }
-            const release = granted.success;
-            const token = randomBytes(16).toString("hex");
-            const holderStamped = yield* Effect.gen(function* () {
-                const lockInfo = yield* fs
-                    .stat(lockPath)
-                    .pipe(Effect.mapError((cause) => new TransitionLockError({ path: lockPath, step: "inspect-timestamp", cause })));
-                const lockMtime = yield* Option.match(lockInfo.mtime, {
-                    onNone: () => Effect.fail(new TransitionLockError({ path: lockPath, step: "missing-timestamp" })),
-                    onSome: Effect.succeed,
-                });
-                yield* writeHolder(fs, path, lockPath, {
-                    ...args.holder,
-                    token,
-                });
-                // proper-lockfile proves ownership by comparing the directory's
-                // mtime with the timestamp it recorded at acquisition. Writing
-                // holder.json changes that directory mtime, so restore the exact
-                // acquired value before the first refresh observes it.
-                yield* fs
-                    .utimes(lockPath, lockMtime, lockMtime)
-                    .pipe(Effect.mapError((cause) => new TransitionLockError({ path: lockPath, step: "preserve-timestamp", cause })));
-            }).pipe(Effect.result);
-            if (holderStamped._tag === "Failure") {
-                // The holder metadata is the only ownership evidence this
-                // acquisition will ever have; holding without it would be
-                // indistinguishable from a successor's half-written acquisition.
-                // Release the lock and fail rather than hold anonymously.
-                yield* Effect.tryPromise({
-                    try: () => release(),
-                    catch: (cause) => new TransitionLockError({ path: lockPath, step: "release", cause }),
-                }).pipe(Effect.ignore);
-                return { _tag: "failed", error: holderStamped.failure };
-            }
-            heldTransitions.set(workspaceDir, {
-                compromised: Deferred.await(compromisedSignal),
-                isCompromised: () => Deferred.isDoneUnsafe(compromisedSignal),
-            });
-            yield* Effect.addFinalizer(() => Effect.gen(function* () {
-                heldTransitions.delete(workspaceDir);
-                // Removal requires an exact owner-token match, proven before
-                // release() — which would remove the directory unconditionally.
-                // Absent or unreadable holder metadata is indistinguishable from
-                // a successor that reclaimed the stale hold but has not yet
-                // written its holder file, and is never license to remove; the
-                // unowned in-process bookkeeping self-resolves as compromised on
-                // its next update tick without touching the directory.
-                const residualHolder = yield* readHolder(fs, path, lockPath);
-                const ownsResidual = Option.match(residualHolder, {
-                    onNone: () => false,
-                    onSome: (value) => value.token === token,
-                });
-                if (ownsResidual) {
-                    yield* Effect.tryPromise({
-                        try: () => release(),
-                        catch: (cause) => new TransitionLockError({ path: lockPath, step: "release", cause }),
-                    }).pipe(Effect.ignore);
-                    // A compromised hold makes release() refuse; the directory is
-                    // still ours by exact token match — remove it directly.
-                    yield* fs.remove(lockPath, { recursive: true, force: true }).pipe(Effect.ignore);
-                }
-                yield* removeEmptyScratch;
-                yield* removeNewEmptyWorkspace;
-            }));
-            return { _tag: "acquired" };
-        }));
-        if (attempt._tag === "acquired") {
-            return Option.none();
-        }
-        if (attempt._tag === "failed") {
-            yield* removeEmptyScratch;
-            yield* removeNewEmptyWorkspace;
-            return yield* attempt.error;
-        }
-        // The lock is held: serialize behind the holder with a visible reason,
-        // up to the bound — the loser serializes or times out into a
-        // categorized blocked, never an internal crash.
-        const holder = yield* readHolder(fs, path, lockPath);
-        if (!reportedWaiting && args.onWaiting !== undefined) {
-            reportedWaiting = true;
-            yield* args.onWaiting(holder);
-        }
-        if (waitedMillis >= waitBound) {
-            yield* removeEmptyScratch;
-            yield* removeNewEmptyWorkspace;
-            return Option.some({ holder, waitedMillis });
-        }
-        yield* Effect.sleep(WAIT_INTERVAL);
-        waitedMillis += Duration.toMillis(WAIT_INTERVAL);
-    }
-});
-export const liveWorkspaceTransitionLock = {
-    acquire: acquireWorkspaceTransitionLock,
-    held: heldWorkspaceTransition,
-};
-//# sourceMappingURL=transition-lock.js.map