spawnfile 0.1.13 → 0.1.17

package/dist/deployment/organizationHandoffAuthorityFsWorker.js

@@ -0,0 +1,431 @@
+import { constants } from "node:fs";
+import { link, lstat, open, unlink } from "node:fs/promises";
+import { OrganizationHandoffAuthorityBudget, OrganizationHandoffAuthorityFailure, toOrganizationHandoffAuthorityFailureDetail } from "./organizationHandoffAuthorityFsBudget.js";
+import { createAuthorityLeafInspector } from "./organizationHandoffAuthorityFsElection.js";
+const VERSION = "spawnfile.organization-handoff-fs-worker.v1";
+const MAX_BYTES = 32_768;
+// Store keys encode either a 64-character pending key or a 71-character
+// `opaque_` handoff handle. No other leaf namespace is reachable.
+const NAME = /^(?:[a-f0-9]{128}|[a-f0-9]{142})\.json$/u;
+const owner = typeof process.getuid === "function" ? process.getuid() : undefined;
+const fail = (code, state) => {
+    throw new OrganizationHandoffAuthorityFailure({ code, ...(state === undefined ? {} : { state }) });
+};
+/** Fail with the budget's attempt/wall-clock accounting and the contending shape. */
+const failBudget = (budget, code, loop, state) => {
+    throw new OrganizationHandoffAuthorityFailure(budget.snapshot(code, loop, state));
+};
+/**
+ * Re-raise a race failure that the election check refused to retry, recording
+ * the verdict. Without it a fail-closed admission decision is indistinguishable
+ * from the underlying race in a log.
+ */
+const failElection = (error, election, loop) => {
+    const detail = toOrganizationHandoffAuthorityFailureDetail(error);
+    throw new OrganizationHandoffAuthorityFailure({
+        ...detail,
+        state: `${detail.state === undefined ? "" : `${detail.state} `}loop=${loop} election=${String(election)}`
+    });
+};
+const bytes = (value) => Buffer.byteLength(value, "utf8");
+const validName = (value) => typeof value === "string" && NAME.test(value) ? value : fail("invalid_name");
+const validRequest = (raw) => {
+    if (!raw || typeof raw !== "object" || Array.isArray(raw) || Object.getPrototypeOf(raw) !== Object.prototype)
+        return fail("malformed_request");
+    const value = raw;
+    if (value.version !== VERSION || !Number.isSafeInteger(value.id) || typeof value.op !== "string" || (value.op !== "read" && value.op !== "write" && value.op !== "create"))
+        return fail("unsupported_request");
+    const content = value.content;
+    const keys = Object.keys(value).sort();
+    const expected = value.op === "read" ? ["id", "name", "op", "version"] : ["content", "id", "name", "op", "version"];
+    if (keys.length !== expected.length || keys.some((key, index) => key !== expected[index]))
+        return fail("unexpected_request_keys");
+    if (content !== undefined && (typeof content !== "string" || bytes(content) > MAX_BYTES))
+        return fail("oversized_content");
+    return { version: VERSION, id: value.id, op: value.op, name: validName(value.name), ...(content === undefined ? {} : { content }) };
+};
+const send = (value) => {
+    const serialized = JSON.stringify(value);
+    if (bytes(serialized) > MAX_BYTES || typeof process.send !== "function")
+        process.exit(1);
+    process.send(JSON.parse(serialized));
+};
+const { aliasesOf, expectedElectionState, statFile } = createAuthorityLeafInspector(owner === undefined ? {} : { owner });
+const publicationSidecars = (name) => [`${name}.pending`, `${name}.recovery`];
+/**
+ * Structural description of the contending state for a diagnostic. Reports
+ * only shape — presence, link count, size, mode. Never record bytes, leaf
+ * names, or paths: this is the secret-publication path.
+ */
+const describeContention = async (name) => {
+    const roles = [["final", name], ["pending", `${name}.pending`], ["recovery", `${name}.recovery`]];
+    const parts = await Promise.all(roles.map(async ([role, leaf]) => {
+        const stat = await lstat(leaf).catch(() => null);
+        return stat === null
+            ? `${role}:absent`
+            : `${role}:nlink=${stat.nlink},size=${stat.size},mode=${(stat.mode & 0o777).toString(8)}`;
+    }));
+    return parts.join(" ");
+};
+const read = async (name) => {
+    let before = await statFile(name);
+    if (before === null)
+        return null;
+    if (before.nlink === 2) {
+        let match;
+        for (const alias of aliasesOf(name)) {
+            const stat = await lstat(alias).catch((error) => error.code === "ENOENT" ? null : fail("alias_lstat_failed"));
+            if (stat && stat.isFile() && !stat.isSymbolicLink() && stat.nlink === 2 && stat.dev === before.dev && stat.ino === before.ino) {
+                if (match)
+                    return fail("ambiguous_link_alias");
+                match = alias;
+            }
+        }
+        if (!match) {
+            // The counterpart can be unlinked between the two lstat calls by the
+            // helper that won this link election. Re-read only if that left this
+            // same checked file with its ordinary single link.
+            const current = await statFile(name);
+            if (current === null)
+                return null;
+            if (current.nlink !== 1)
+                return fail("unresolved_second_link");
+            before = current;
+        }
+        // Reading the canonical record completes a crashed publisher. An
+        // intermediate-name reader may be racing that publisher, so it merely
+        // observes the linked content and lets its normal publish path converge.
+        if (match && !name.endsWith(".pending") && !name.endsWith(".recovery")) {
+            await unlink(match).catch((error) => { if (error.code !== "ENOENT")
+                fail("alias_unlink_failed"); });
+            await sync();
+            before = await statFile(name);
+            if (before === null)
+                return fail("record_vanished_after_join");
+        }
+    }
+    const handle = await open(name, constants.O_RDONLY | constants.O_NOFOLLOW).catch((error) => error.code === "ENOENT" ? null : fail("open_failed"));
+    if (handle === null)
+        return null;
+    try {
+        const stat = await handle.stat();
+        // A simultaneous helper may complete the observed link publication while
+        // this descriptor is open, reducing nlink from two to one. That is the
+        // sole permitted link-count transition; inode, device, size, and all
+        // increases remain fail-closed.
+        if (!stat.isFile() || stat.nlink < 1 || stat.nlink > before.nlink || stat.dev !== before.dev || stat.ino !== before.ino || stat.size !== before.size)
+            return fail("record_drifted_while_open");
+        return await handle.readFile({ encoding: "utf8" });
+    }
+    catch (error) {
+        if (error instanceof OrganizationHandoffAuthorityFailure)
+            throw error;
+        return fail("read_failed");
+    }
+    finally {
+        await handle.close().catch(() => undefined);
+    }
+};
+const sync = async () => { const handle = await open(".", constants.O_RDONLY | constants.O_DIRECTORY).catch(() => fail("directory_open_failed")); try {
+    await handle.sync();
+}
+finally {
+    await handle.close().catch(() => undefined);
+} };
+const readDuringPublication = async (name, budget) => {
+    try {
+        return await read(name);
+    }
+    catch (error) {
+        // Re-validate the leaf before retrying. This permits only a checked,
+        // ordinary one/two-link publication race; symlinks, mode/owner drift,
+        // extra links, and other malformed states still fail immediately.
+        const election = await expectedElectionState(name);
+        if (election === null)
+            return null;
+        if (election !== true)
+            return failElection(error, election, "read");
+        if (budget.exhausted())
+            return failBudget(budget, "read_budget_exhausted", "read", await describeContention(name));
+        await budget.wait();
+        return readDuringPublication(name, budget);
+    }
+};
+/**
+ * A sidecar may change between lstat and fd inspection while another worker
+ * publishes. Re-prove an exact immutable final first, then retry the sidecar
+ * so cleanup still relies on a stable checked sidecar rather than an inference.
+ */
+const readStaging = async (staging, final, content, budget) => {
+    try {
+        const observed = await read(staging);
+        if (observed === null)
+            return "absent";
+        if (observed === content)
+            return "exact";
+        return content.startsWith(observed) ? "expected-prefix" : fail("staging_content_unrelated");
+    }
+    catch (error) {
+        if (error instanceof OrganizationHandoffAuthorityFailure && error.detail.budget !== undefined)
+            throw error;
+        const published = await readDuringPublication(final, budget);
+        if (published !== null) {
+            if (published !== content)
+                return fail("published_content_mismatch");
+            if (budget.exhausted())
+                return failBudget(budget, "staging_budget_exhausted", "staging", await describeContention(final));
+            await budget.wait();
+            return readStaging(staging, final, content, budget);
+        }
+        const election = await expectedElectionState(staging);
+        if (election === null)
+            return "absent";
+        if (election !== true)
+            return failElection(error, election, "staging");
+        if (budget.exhausted())
+            return failBudget(budget, "staging_budget_exhausted", "staging", await describeContention(final));
+        await budget.wait();
+        return readStaging(staging, final, content, budget);
+    }
+};
+/**
+ * A successful link election can race a peer which had already created the
+ * other staging leaf.  The final immutable record is authoritative, but the
+ * stale leaf must not survive a completed join: it would otherwise be
+ * mistaken for an in-progress publication after restart. Delete exact bytes
+ * immediately. An incomplete expected prefix may still belong to a publisher,
+ * so wait for it first; once the budget's patience expires, removing that
+ * proven prefix is safe because the final record already prevents it from
+ * winning a later link election.
+ */
+const settlePublished = async (name, content, budget) => {
+    if (budget.exhausted())
+        return failBudget(budget, "settle_budget_exhausted", "settle", await describeContention(name));
+    if (await readDuringPublication(name, budget) !== content)
+        return fail("settle_record_mismatch");
+    let incomplete = false;
+    for (const sidecar of publicationSidecars(name)) {
+        const observed = await readStaging(sidecar, name, content, budget);
+        if (observed === "absent")
+            continue;
+        if (observed === "expected-prefix" && budget.patient()) {
+            incomplete = true;
+            continue;
+        }
+        await unlink(sidecar).catch((error) => { if (error.code !== "ENOENT")
+            fail("sidecar_unlink_failed"); });
+        await sync();
+    }
+    if (incomplete) {
+        await budget.wait();
+        return settlePublished(name, content, budget);
+    }
+    if (await readDuringPublication(name, budget) !== content)
+        return fail("settle_record_mismatch");
+    const remaining = await Promise.all(publicationSidecars(name).map(async (sidecar) => readStaging(sidecar, name, content, budget)));
+    if (remaining.every((sidecar) => sidecar === "absent"))
+        return;
+    if (budget.exhausted())
+        return failBudget(budget, "settle_budget_exhausted", "settle", await describeContention(name));
+    await budget.wait();
+    return settlePublished(name, content, budget);
+};
+const readPublished = async (name, budget) => {
+    const content = await readDuringPublication(name, budget);
+    if (content === null)
+        return null;
+    await settlePublished(name, content, budget);
+    return content;
+};
+const write = async (name, content, budget) => {
+    if (budget.exhausted())
+        return failBudget(budget, "write_budget_exhausted", "write", await describeContention(name));
+    const joinOrRetry = async () => {
+        const published = await readDuringPublication(name, budget);
+        if (published !== null) {
+            if (published !== content)
+                return fail("join_content_mismatch");
+            await settlePublished(name, content, budget);
+            return false;
+        }
+        await budget.wait();
+        return write(name, content, budget);
+    };
+    const reproveStaging = async () => {
+        const published = await readDuringPublication(name, budget);
+        if (published === content) {
+            await settlePublished(name, content, budget);
+            return true;
+        }
+        if (published !== null)
+            return fail("reprove_content_mismatch");
+        await budget.wait();
+        return false;
+    };
+    const existing = await readDuringPublication(name, budget);
+    if (existing !== null) {
+        if (existing !== content)
+            fail("existing_content_mismatch");
+        await settlePublished(name, content, budget);
+        return false;
+    }
+    const pending = `${name}.pending`;
+    const recovery = `${name}.recovery`;
+    const incomplete = await readStaging(pending, name, content, budget);
+    if (incomplete === "expected-prefix") {
+        let recovered = await readStaging(recovery, name, content, budget);
+        if (recovered === "expected-prefix") {
+            if (budget.patient()) {
+                await budget.wait();
+                return write(name, content, budget);
+            }
+            // A crashed recovery publisher can leave the same bounded prefix. It
+            // cannot win after this writer links the immutable final record, so
+            // retire it only after the budget's patience expires and reconstruct it
+            // below.
+            await unlink(recovery).catch((error) => { if (error.code !== "ENOENT")
+                fail("recovery_unlink_failed"); });
+            await sync();
+            recovered = "absent";
+        }
+        if (recovered === "absent") {
+            const handle = await open(recovery, constants.O_CREAT | constants.O_EXCL | constants.O_WRONLY | constants.O_NOFOLLOW, 0o600).catch((error) => error.code === "EEXIST" ? null : fail("recovery_create_failed"));
+            if (handle === null) {
+                await budget.wait();
+                return write(name, content, budget);
+            }
+            try {
+                await handle.writeFile(content, "utf8");
+                await handle.sync();
+            }
+            finally {
+                await handle.close().catch(() => undefined);
+            }
+            const staged = await readStaging(recovery, name, content, budget);
+            if (staged !== "exact") {
+                if (await reproveStaging())
+                    return false;
+                return write(name, content, budget);
+            }
+            await sync();
+        }
+        const recoveredLinked = await link(recovery, name).then(() => true).catch((error) => {
+            if (error.code === "EEXIST")
+                return false;
+            if (error.code === "ENOENT")
+                return null;
+            return fail("recovery_link_failed");
+        });
+        if (recoveredLinked !== true)
+            return joinOrRetry();
+        await sync();
+        await unlink(recovery).catch((error) => { if (error.code !== "ENOENT")
+            fail("recovery_unlink_failed"); });
+        await sync();
+        if (await readDuringPublication(name, budget) !== content)
+            fail("recovery_publish_mismatch");
+        await settlePublished(name, content, budget);
+        return true;
+    }
+    if (incomplete === "absent") {
+        const handle = await open(pending, constants.O_CREAT | constants.O_EXCL | constants.O_WRONLY | constants.O_NOFOLLOW, 0o600).catch((error) => error.code === "EEXIST" ? null : fail("pending_create_failed"));
+        if (handle === null) {
+            await budget.wait();
+            return write(name, content, budget);
+        }
+        try {
+            await handle.writeFile(content, "utf8");
+            await handle.sync();
+        }
+        finally {
+            await handle.close().catch(() => undefined);
+        }
+        const staged = await readStaging(pending, name, content, budget);
+        if (staged !== "exact") {
+            if (await reproveStaging())
+                return false;
+            return write(name, content, budget);
+        }
+        await sync();
+    }
+    const linked = await link(pending, name).then(() => true).catch((error) => {
+        if (error.code === "EEXIST")
+            return false;
+        if (error.code === "ENOENT")
+            return null;
+        return fail("pending_link_failed");
+    });
+    if (linked !== true)
+        return joinOrRetry();
+    await sync();
+    await unlink(pending).catch((error) => { if (error.code !== "ENOENT")
+        fail("pending_unlink_failed"); });
+    await sync();
+    if (await readDuringPublication(name, budget) !== content)
+        fail("pending_publish_mismatch");
+    await settlePublished(name, content, budget);
+    return true;
+};
+let anchor;
+let queue = Promise.resolve();
+const start = async () => {
+    const raw = process.env.SPAWNFILE_AUTHORITY_FS_ANCHOR;
+    if (!raw)
+        return fail("missing_anchor");
+    const expected = JSON.parse(raw);
+    const stat = await lstat(".");
+    if (!stat.isDirectory() || stat.isSymbolicLink() || stat.dev !== expected.dev || stat.ino !== expected.ino
+        || (stat.mode & 0o077) !== 0 || owner !== undefined && stat.uid !== expected.uid
+        || !Number.isSafeInteger(expected.parent_pid) || expected.parent_pid < 1 || process.ppid !== expected.parent_pid)
+        return fail("anchor_mismatch");
+    anchor = expected;
+    send({ version: VERSION, ready: true });
+};
+process.on("message", (raw) => {
+    queue = queue.then(async () => {
+        const request = validRequest(raw);
+        if (!anchor)
+            return fail("not_ready");
+        const stat = await lstat(".");
+        if (stat.dev !== anchor.dev || stat.ino !== anchor.ino || (stat.mode & 0o077) !== 0)
+            return fail("anchor_drifted");
+        // One budget per request: the request is the thing with a deadline, and
+        // the client's own request deadline must exceed it.
+        const budget = new OrganizationHandoffAuthorityBudget();
+        const result = request.op === "read"
+            ? { content: await readPublished(request.name, budget) }
+            : { created: request.content === undefined ? fail("missing_content") : await write(request.name, request.content, budget) };
+        send({ version: VERSION, id: request.id, ok: true, ...(result.content === null ? {} : { content: result.content }), ...(request.op === "create" ? { created: result.created } : {}) });
+    }).catch((error) => send({
+        version: VERSION,
+        id: typeof raw === "object" && raw !== null && Number.isSafeInteger(raw.id) ? raw.id : 0,
+        ok: false,
+        failure: toOrganizationHandoffAuthorityFailureDetail(error)
+    }));
+});
+process.on("disconnect", () => process.exit(0));
+/**
+ * Expected parent pid read synchronously at module load, before any await.
+ *
+ * The watchdog below previously exited whenever `anchor` was still unset. That
+ * made a liveness net race the startup path: on a loaded host the interpreter
+ * and the anchor's `lstat` can take longer than one 100ms tick, and the helper
+ * killed itself before it could ever report ready. Deriving the pid from the
+ * environment removes the dependency on startup having finished, without
+ * weakening anything: `start` still validates the full anchor independently,
+ * and no request is served until it does.
+ */
+const watchedParentPid = (() => {
+    try {
+        const value = JSON.parse(process.env.SPAWNFILE_AUTHORITY_FS_ANCHOR ?? "{}");
+        return Number.isSafeInteger(value.parent_pid) ? value.parent_pid : undefined;
+    }
+    catch {
+        return undefined;
+    }
+})();
+// IPC disconnect covers a cooperative parent shutdown. ppid surveillance also
+// covers abrupt parent death, where an orphan might otherwise retain its cwd.
+setInterval(() => { if (watchedParentPid === undefined || process.ppid !== watchedParentPid)
+    process.exit(0); }, 100).unref();
+void start().catch(() => process.exit(1));

package/dist/deployment/organizationHandoffAuthorityFsWorkerParent.fixture.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/deployment/organizationHandoffAuthorityFsWorkerParent.fixture.js

@@ -0,0 +1,26 @@
+import { fork } from "node:child_process";
+import { createRequire } from "node:module";
+import { lstat } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+const directory = process.argv[2];
+if (typeof directory !== "string")
+    process.exit(1);
+const stat = await lstat(directory).catch(() => undefined);
+if (!stat?.isDirectory())
+    process.exit(1);
+const worker = fork(fileURLToPath(new URL("./organizationHandoffAuthorityFsWorker.ts", import.meta.url)), [], {
+    cwd: directory,
+    env: { SPAWNFILE_AUTHORITY_FS_ANCHOR: JSON.stringify({ dev: stat.dev, ino: stat.ino, uid: typeof process.getuid === "function" ? process.getuid() : undefined, parent_pid: process.pid }) },
+    execArgv: ["--import", createRequire(import.meta.url).resolve("tsx")],
+    silent: true
+});
+worker.stdout?.resume();
+worker.stderr?.resume();
+worker.once("message", (message) => {
+    if (message?.ready !== true || typeof process.send !== "function")
+        process.exit(1);
+    process.send({ worker_pid: worker.pid });
+});
+// Keep the fixture parent alive until the test kills it; the worker must then
+// notice its changed ppid and exit on its own.
+setInterval(() => undefined, 1_000);

package/dist/deployment/organizationHandoffAuthorityFsWorkerStall.fixture.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/deployment/organizationHandoffAuthorityFsWorkerStall.fixture.js

@@ -0,0 +1,16 @@
+import { pbkdf2 } from "node:crypto";
+/**
+ * Test-only preload that delays the authority worker's startup filesystem call.
+ *
+ * The worker validates its anchor with an `lstat`, which libuv runs on the
+ * threadpool. Forked with `UV_THREADPOOL_SIZE=1`, this preload occupies that
+ * single slot long enough that the anchor cannot be established until well
+ * after the worker's 100ms liveness watchdog has ticked several times — the
+ * deterministic equivalent of what CPU contention does to worker startup on a
+ * loaded host, and the condition under which the watchdog used to reap the
+ * helper before it could ever report readiness.
+ *
+ * The event loop itself stays free throughout, so the watchdog does tick.
+ */
+const STALL_ITERATIONS = 1_500_000;
+pbkdf2("spawnfile-stall", "spawnfile-stall", STALL_ITERATIONS, 64, "sha512", () => undefined);

package/dist/deployment/organizationHandoffAuthorityStore.d.ts

@@ -0,0 +1,41 @@
+import { createOrganizationHandoffCapabilityPending, type OrganizationHandoffCapabilityFinalized, type OrganizationHandoffCapabilityPending, type OrganizationHandoffDockerObservation } from "./organizationHandoffAuthorityTypes.js";
+import { type OrganizationHandoffAuthorityFsClient, type OrganizationHandoffAuthorityFsClientOptions } from "./organizationHandoffAuthorityFsClient.js";
+export declare const resolveOrganizationHandoffAuthorityRoot: () => string;
+export interface OrganizationHandoffAuthorityStore {
+    begin(input: Parameters<typeof createOrganizationHandoffCapabilityPending>[0]): Promise<{
+        readonly created: boolean;
+        readonly pending: OrganizationHandoffCapabilityPending;
+    }>;
+    close(input: {
+        readonly expectedHandoff: unknown;
+        readonly organizationHandoffHandle: unknown;
+    }): Promise<void>;
+    dispose(): Promise<void>;
+    finalize(pendingKey: unknown, container: {
+        readonly containerId: unknown;
+        readonly deploymentLabels: unknown;
+    }): Promise<OrganizationHandoffCapabilityFinalized>;
+    observeDockerMutation(pendingKey: unknown, container: {
+        readonly containerId: unknown;
+        readonly deploymentLabels: unknown;
+        readonly imageId: unknown;
+    }): Promise<OrganizationHandoffDockerObservation>;
+    readDockerMutation(pendingKey: unknown): Promise<OrganizationHandoffDockerObservation | null>;
+    reserve(input: Parameters<typeof createOrganizationHandoffCapabilityPending>[0]): Promise<OrganizationHandoffCapabilityPending>;
+    resolver: {
+        resolve(input: {
+            authorization: unknown;
+            signal?: AbortSignal;
+        }): Promise<unknown>;
+    };
+}
+export interface OrganizationHandoffAuthorityStoreTestHooks {
+    beforeLeafOperation?(kind: "close" | "finalize" | "reserve" | "resolve"): Promise<void>;
+    duringLeafOperation?(kind: "reserve", operation: () => Promise<void>): Promise<void>;
+}
+export interface OrganizationHandoffAuthorityStoreInitializeOptions {
+    readonly testHooks?: OrganizationHandoffAuthorityStoreTestHooks;
+    readonly testInitializeFsClient?: (options: OrganizationHandoffAuthorityFsClientOptions) => Promise<OrganizationHandoffAuthorityFsClient>;
+    readonly workerPath?: string;
+}
+export declare const initializeOrganizationHandoffAuthorityStore: (options?: OrganizationHandoffAuthorityStoreInitializeOptions) => Promise<OrganizationHandoffAuthorityStore>;