@dynamicagents/plugins 0.14.0 → 0.16.0

package/dist/workspace/container-fault.js

@@ -1,73 +0,0 @@
-/**
- * The container failures that are the deployment's fault, not the workspace's.
- *
- * Everything else this host catches is the kind of thing a retry clears: a
- * container that is starting, a connection that dropped, a command that died
- * with it. These are not. They describe a Worker and a container application
- * that cannot work together no matter how many times they are asked, and they
- * end only when an operator deploys.
- *
- * **This changes what is said, not what is done.** No caller branches its
- * control flow on the answer, and none should start: the match is on a string
- * the library is free to reword, so a misread has to cost a misleading sentence
- * rather than a workspace that stopped trying. What it earns is the log line.
- * The cause is already in the thrown message, but a caller logs its own
- * sentence and the cause travels in a detail field a log digest truncates — so
- * an operator scanning for what broke reads the symptom ("could not trust the
- * interception CA") and not the reason. {@link deploymentFault} is how a caller
- * puts the reason in the message instead, and how the install record stops
- * offering advice that cannot work.
- */
-/**
- * Match on the shape the backend formats, not on the prose after it.
- *
- * `[stage=auth]` is the stage label `ContainerBackend` writes into every
- * message it throws from that stage, and the container-application sentence is
- * the runtime's own, surfaced verbatim through the backend's `priorExit=` field.
- * `prepared images` is in both of the backend's refusals to start without an
- * image — none prepared at all, and none under the key it was asked for — and
- * survives the reconnect wrapper's truncation of either. All are stabler than
- * the explanations they introduce, and none has a `code` to key on the way a
- * lost exec does.
- */
-const AUTH_STAGE = "[stage=auth]";
-const NO_APPLICATION = "no container application";
-const NO_IMAGE = "prepared images";
-/**
- * Whether this error says the deployment is wrong, and what to say about it.
- *
- * `undefined` for everything else, which is the answer that keeps the existing
- * behaviour: a caller that gets it logs and retries exactly as before.
- */
-export function deploymentFault(err) {
-    const text = String(err);
-    if (text.includes(AUTH_STAGE))
-        return {
-            summary: "the container image is older than this Worker",
-            remedy: "the container is running an image that predates this Worker, so the " +
-                "two cannot authenticate and nothing can reach it. The image and the " +
-                "Worker are released as a pair and have to be deployed together, so " +
-                "this clears when an operator redeploys the Worker with its container " +
-                "image — no command here can recover it."
-        };
-    if (text.includes(NO_APPLICATION))
-        return {
-            summary: "this Worker has no container application",
-            remedy: "the container application this workspace starts containers from does " +
-                "not exist, so no container can start. Deploying the Worker is what " +
-                "creates it — deleting it does not cause it to be rebuilt — so this " +
-                "clears when an operator redeploys, and not before."
-        };
-    if (text.includes(NO_IMAGE))
-        return {
-            summary: "this Worker prepared no image for the workspace container",
-            remedy: "the container application has no image under the name this workspace " +
-                "starts, so no container can start. The workspace schedules its own " +
-                'containers, which takes `scheduling_policy: "durable_object"` and an ' +
-                "`images` entry for that name in the Worker's containers block, and an " +
-                "application created under another policy is deleted before that " +
-                "deploy rather than switched. This clears when an operator redeploys " +
-                "with both in place, and not before."
-        };
-    return undefined;
-}

package/dist/workspace/deps-snapshot.d.ts

@@ -1,110 +0,0 @@
-import type { Workspace } from "@cloudflare/computer";
-export interface DepsSnapshotRecord {
-    /** The platform's snapshot id. */
-    id: string;
-    /** In bytes, as the platform reported it. */
-    size: number;
-    /** The image reference it was taken on — see the file comment. */
-    image: string;
-    /** Where the install ran. */
-    dir: string;
-    /** The install fingerprint its marker holds. */
-    fingerprint: string;
-    /** Every package root with a tree on the disk, and its inputs' digest then. */
-    roots: {
-        dir: string;
-        fingerprint: string | null;
-    }[];
-    /** {@link packageRootSet} of the checkout then. */
-    rootSet: string;
-    at: number;
-}
-/** What a restore is checked against: the install a cold start would run. */
-export interface ExpectedTree {
-    dir: string;
-    fingerprint: string;
-}
-/** A tree an install finished, as its record names it — `at` tells two apart. */
-export interface InstalledTree extends ExpectedTree {
-    at: number;
-}
-export interface DepsSnapshotDeps {
-    storage: DurableObjectStorage;
-    container: () => Container | undefined;
-    /** The image a start from no snapshot would boot. */
-    image: () => string | undefined;
-    workspace: () => Workspace;
-    rootFingerprint: (dir: string) => Promise<string | null>;
-    /** The tree the install record says this container holds. */
-    tree: () => Promise<{
-        dir: string;
-        fingerprint: string | null;
-        at: number;
-    } | undefined>;
-    tag: () => string;
-    id: () => string;
-}
-/**
- * Which package roots a checkout has, as one digest: every directory under
- * `dir` with a `package.json`, and the submodules `.gitmodules` declares — one a
- * bootstrap clones in the container has no `package.json` here until then.
- */
-export declare function packageRootSet(fs: Workspace["fs"], dir: string): Promise<string>;
-export declare class DepsSnapshot {
-    #private;
-    private readonly deps;
-    readonly launch: {
-        readonly containerSnapshot: ContainerSnapshotRestoreParams | undefined;
-    };
-    constructor(deps: DepsSnapshotDeps);
-    /**
-     * Restore with the next start if the record fits it, and say which record.
-     *
-     * `expected` is a thunk because it reads the checkout, and a workspace with no
-     * snapshot or one from another image should not pay for that.
-     */
-    arm(expected: () => Promise<ExpectedTree | undefined>): Promise<DepsSnapshotRecord | undefined>;
-    /** Forget an armed restore, taken or not. */
-    disarm(): void;
-    /**
-     * Whether the container that came up holds `record`'s tree, judged by the
-     * marker the setup read in it.
-     *
-     * Drops the record when a start took it and the tree is not there; leaves it
-     * when no start did, since nothing was learned about it.
-     */
-    restored(record: DepsSnapshotRecord, marker: string | null | undefined): Promise<boolean>;
-    /**
-     * Snapshot the running container, which has just installed `tree`, after any
-     * snapshot already in flight — a later install's request is never dropped for
-     * an earlier one's.
-     *
-     * Never throws: a container that cannot be snapshotted installs again next
-     * time, which is today's cost and no worse.
-     */
-    take(tree: InstalledTree): Promise<void>;
-    /** Snapshots in flight, finished — for whatever is about to stop the container. */
-    settled(): Promise<void>;
-    /**
-     * The entries that ask for `tree`'s snapshot, for the install to write with
-     * its verdict — see the file comment, and {@link takeDue}.
-     */
-    dueEntries(tree: InstalledTree): Record<string, unknown>;
-    /** Take the snapshot an install asked for, if one is waiting. */
-    takeDue(): Promise<void>;
-    /** The container went, and the disk an asked-for snapshot was of with it. */
-    forgetDue(): Promise<void>;
-    get(): Promise<DepsSnapshotRecord | undefined>;
-    /**
-     * Start from another workspace's snapshot — one taken for the same checkout
-     * path on the same image, as a worktree shares with the checkout it was cut
-     * from.
-     *
-     * Kept out when this workspace's own snapshot already fits, and refused when
-     * the offered one does not.
-     */
-    seed(record: DepsSnapshotRecord, expected: () => Promise<ExpectedTree | undefined>): Promise<{
-        seeded: boolean;
-        reason?: string;
-    }>;
-}

package/dist/workspace/deps-snapshot.js

@@ -1,424 +0,0 @@
-var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
-    if (value !== null && value !== void 0) {
-        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
-        var dispose, inner;
-        if (async) {
-            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
-            dispose = value[Symbol.asyncDispose];
-        }
-        if (dispose === void 0) {
-            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
-            dispose = value[Symbol.dispose];
-            if (async) inner = dispose;
-        }
-        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
-        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
-        env.stack.push({ value: value, dispose: dispose, async: async });
-    }
-    else if (async) {
-        env.stack.push({ async: true });
-    }
-    return value;
-};
-var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
-    return function (env) {
-        function fail(e) {
-            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
-            env.hasError = true;
-        }
-        var r, s = 0;
-        function next() {
-            while (r = env.stack.pop()) {
-                try {
-                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
-                    if (r.dispose) {
-                        var result = r.dispose.call(r.value);
-                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
-                    }
-                    else s |= 1;
-                }
-                catch (e) {
-                    fail(e);
-                }
-            }
-            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
-            if (env.hasError) throw env.error;
-        }
-        return next();
-    };
-})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-});
-import { DEPS_ROOTS_COMMAND, parseDepsRoots } from "./container-deps.js";
-/**
- * A snapshot of a container that has just installed, so the next container
- * starts from it instead of installing again.
- *
- * Dependency trees live on the container's disk (see `./container-deps.ts`), so
- * a new container reinstalls before its first command can use them — what that
- * costs is in `./install-job.ts`. A Containers snapshot is that disk: restored,
- * the trees are back. It holds nothing else worth having — the checkout is this
- * object's storage, mounted over FUSE, and a mount is not in a snapshot.
- *
- * ## When a snapshot is restored
- *
- * Only into a start that would otherwise install the same thing, which takes
- * all of:
- *
- * - **The image it was taken on.** A snapshot replaces the image rather than
- *   layering on it, so one from before a deploy boots the old image's
- *   `computerd`, which nothing downstream catches.
- * - **The same checkout and install fingerprint**, so the marker it carries is
- *   the one an install would write now.
- * - **Every package root's inputs unchanged.** A bootstrap installs roots the
- *   fingerprint does not cover — a submodule's lockfile — and a restore brings
- *   all of them back at once.
- * - **The same set of package roots.** A root added since — a new submodule —
- *   has no tree in the snapshot, and restoring it would skip the install that
- *   gives it one: see {@link packageRootSet}.
- *
- * What came up is then checked, not assumed: the setup mounts the restored trees
- * and reads the marker, and only a match is adopted as installed. Anything else —
- * an expired snapshot, which the platform reports as a failed start, after which
- * the backend's restart takes the image — drops the record, and the install runs
- * and snapshots again.
- *
- * ## Taken of the tree it was asked for, and nothing since
- *
- * An install asks for its snapshot in the same write as its verdict, so a stop
- * that comes before the wake still sees the request. Snapshots run one at a
- * time, and one is recorded only if the install record still names the tree it
- * was taken of: a reinstall empties the tree before it rebuilds it, and a
- * snapshot taken across that is of neither.
- *
- * ## The record outlives the container, and the snapshot outlives the record
- *
- * Unlike the tree record, which goes with its container, this is what a later
- * container starts from. The platform keeps a snapshot for thirty days from its
- * last restore and offers no way to delete one, so a dropped record leaves its
- * snapshot to expire.
- */
-/** Where the record lives. */
-const RECORD_KEY = "deps:snapshot";
-/** The tree a finished install asked to have snapshotted, until it is. */
-const DUE_KEY = "deps:snapshot-due";
-/**
- * Which package roots a checkout has, as one digest: every directory under
- * `dir` with a `package.json`, and the submodules `.gitmodules` declares — one a
- * bootstrap clones in the container has no `package.json` here until then.
- */
-export async function packageRootSet(fs, dir) {
-    const found = await fs
-        .find(dir, "**/package.json", { exclude: ["**/.git", "**/node_modules"] })
-        .catch((err) => {
-        if (err?.code === "ENOENT")
-            return [];
-        throw err;
-    });
-    const gitmodules = await fs
-        .readFile(`${dir}/.gitmodules`, "utf8")
-        .catch(() => "");
-    const input = [
-        ...found.map((entry) => entry.path).sort(),
-        "\0.gitmodules",
-        gitmodules
-    ].join("\n");
-    const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(input));
-    return [...new Uint8Array(digest)]
-        .map((b) => b.toString(16).padStart(2, "0"))
-        .join("");
-}
-/**
- * The launch options `ContainerBackend` spreads into every start, whose
- * `containerSnapshot` is read at that moment.
- *
- * A getter, because the backend keeps this object for its lifetime and builds
- * each start from it — the initial one and every restart after a failed health
- * check — and only the first of those may restore: a restart is the backend
- * recovering from a start that did not come up, which an expired snapshot is.
- */
-function launchOptions(take) {
-    return {
-        get containerSnapshot() {
-            return take();
-        }
-    };
-}
-export class DepsSnapshot {
-    deps;
-    /** Restore with the next start, once. */
-    #pending;
-    /** Whether a start has taken {@link #pending} since it was armed. */
-    #launched = false;
-    #taking;
-    launch = launchOptions(() => {
-        const pending = this.#pending;
-        if (!pending)
-            return undefined;
-        this.#pending = undefined;
-        this.#launched = true;
-        return pending;
-    });
-    constructor(deps) {
-        this.deps = deps;
-    }
-    /**
-     * Restore with the next start if the record fits it, and say which record.
-     *
-     * `expected` is a thunk because it reads the checkout, and a workspace with no
-     * snapshot or one from another image should not pay for that.
-     */
-    async arm(expected) {
-        this.disarm();
-        const record = await this.get();
-        if (!record)
-            return undefined;
-        const refused = await this.#refusal(record, expected);
-        if (refused) {
-            console.info(`[${this.deps.tag()}] not restoring the dependency snapshot`, {
-                id: this.deps.id(),
-                snapshot: record.id,
-                reason: refused
-            });
-            return undefined;
-        }
-        this.#pending = { id: record.id };
-        console.info(`[${this.deps.tag()}] restoring the dependency snapshot`, {
-            id: this.deps.id(),
-            snapshot: record.id,
-            bytes: record.size,
-            dir: record.dir
-        });
-        return record;
-    }
-    /** Forget an armed restore, taken or not. */
-    disarm() {
-        this.#pending = undefined;
-        this.#launched = false;
-    }
-    /**
-     * Whether the container that came up holds `record`'s tree, judged by the
-     * marker the setup read in it.
-     *
-     * Drops the record when a start took it and the tree is not there; leaves it
-     * when no start did, since nothing was learned about it.
-     */
-    async restored(record, marker) {
-        if (!this.#launched)
-            return false;
-        if (marker === record.fingerprint)
-            return true;
-        await this.#drop(record, marker === undefined
-            ? "the restored container could not be read"
-            : "the restored container does not hold the tree");
-        return false;
-    }
-    /**
-     * Snapshot the running container, which has just installed `tree`, after any
-     * snapshot already in flight — a later install's request is never dropped for
-     * an earlier one's.
-     *
-     * Never throws: a container that cannot be snapshotted installs again next
-     * time, which is today's cost and no worse.
-     */
-    async take(tree) {
-        const turn = (this.#taking ?? Promise.resolve()).then(() => this.#take(tree));
-        this.#taking = turn;
-        try {
-            await turn;
-        }
-        finally {
-            if (this.#taking === turn)
-                this.#taking = undefined;
-        }
-    }
-    /** Snapshots in flight, finished — for whatever is about to stop the container. */
-    async settled() {
-        await this.#taking;
-    }
-    /**
-     * The entries that ask for `tree`'s snapshot, for the install to write with
-     * its verdict — see the file comment, and {@link takeDue}.
-     */
-    dueEntries(tree) {
-        return { [DUE_KEY]: tree };
-    }
-    /** Take the snapshot an install asked for, if one is waiting. */
-    async takeDue() {
-        const due = await this.deps.storage.get(DUE_KEY);
-        if (!due)
-            return;
-        await this.deps.storage.delete(DUE_KEY);
-        await this.take(due);
-    }
-    /** The container went, and the disk an asked-for snapshot was of with it. */
-    async forgetDue() {
-        await this.deps.storage.delete(DUE_KEY);
-    }
-    async get() {
-        return await this.deps.storage.get(RECORD_KEY);
-    }
-    /**
-     * Start from another workspace's snapshot — one taken for the same checkout
-     * path on the same image, as a worktree shares with the checkout it was cut
-     * from.
-     *
-     * Kept out when this workspace's own snapshot already fits, and refused when
-     * the offered one does not.
-     */
-    async seed(record, expected) {
-        if (!isRecord(record))
-            return { seeded: false, reason: "not a snapshot" };
-        const now = await expected();
-        const fits = async () => now;
-        const own = await this.get();
-        if (own && !(await this.#refusal(own, fits)))
-            return { seeded: false, reason: "this workspace's own snapshot fits" };
-        const refused = await this.#refusal(record, fits);
-        if (refused)
-            return { seeded: false, reason: refused };
-        await this.deps.storage.put(RECORD_KEY, record);
-        console.info(`[${this.deps.tag()}] seeded a dependency snapshot`, {
-            id: this.deps.id(),
-            snapshot: record.id,
-            dir: record.dir
-        });
-        return { seeded: true };
-    }
-    /**
-     * Why `record` must not be restored now, or `undefined` if it may. A check
-     * that throws refuses: a start must not fail for a snapshot it can go without.
-     */
-    async #refusal(record, expected) {
-        if (record.image !== this.deps.image())
-            return "taken on another image";
-        try {
-            const tree = await expected();
-            if (!tree)
-                return "there is nothing to install here";
-            if (record.dir !== tree.dir)
-                return "taken for another checkout";
-            if (record.fingerprint !== tree.fingerprint)
-                return "the install's inputs have changed";
-            for (const root of record.roots) {
-                if ((await this.deps.rootFingerprint(root.dir)) !== root.fingerprint)
-                    return `${root.dir} has changed`;
-            }
-            if ((await packageRootSet(this.deps.workspace().fs, tree.dir)) !==
-                record.rootSet)
-                return "the checkout's package roots have changed";
-            return undefined;
-        }
-        catch (err) {
-            return `it could not be checked: ${String(err)}`;
-        }
-    }
-    /** Whether the install record still names `tree`. */
-    async #holds(tree) {
-        const now = await this.deps.tree();
-        return (now?.dir === tree.dir &&
-            now.fingerprint === tree.fingerprint &&
-            now.at === tree.at);
-    }
-    async #drop(record, reason) {
-        // Only this record: a later install may have put a newer one there.
-        if ((await this.get())?.id === record.id)
-            await this.deps.storage.delete(RECORD_KEY);
-        console.warn(`[${this.deps.tag()}] dropped the dependency snapshot`, {
-            id: this.deps.id(),
-            snapshot: record.id,
-            reason
-        });
-    }
-    async #take(tree) {
-        const container = this.deps.container();
-        const image = this.deps.image();
-        if (!container?.running || image === undefined)
-            return;
-        // Replaced, or reinstalling, since the install asked.
-        if (!(await this.#holds(tree)))
-            return;
-        const startedAt = Date.now();
-        try {
-            const roots = await this.#roots();
-            // Without a root to mount, a restore would read no marker and be dropped.
-            if (roots.length === 0) {
-                console.warn(`[${this.deps.tag()}] no dependency tree to snapshot on this disk`, { id: this.deps.id(), dir: tree.dir });
-                return;
-            }
-            const fingerprinted = [];
-            for (const dir of roots)
-                fingerprinted.push({
-                    dir,
-                    fingerprint: await this.deps.rootFingerprint(dir)
-                });
-            const rootSet = await packageRootSet(this.deps.workspace().fs, tree.dir);
-            const snapshot = await container.snapshotContainer({
-                name: `deps-${tree.fingerprint.slice(0, 16)}`
-            });
-            if (!(await this.#holds(tree))) {
-                console.warn(`[${this.deps.tag()}] discarded a dependency snapshot taken while the tree changed`, { id: this.deps.id(), snapshot: snapshot.id, dir: tree.dir });
-                return;
-            }
-            await this.deps.storage.put(RECORD_KEY, {
-                id: snapshot.id,
-                size: snapshot.size,
-                image,
-                dir: tree.dir,
-                fingerprint: tree.fingerprint,
-                roots: fingerprinted,
-                rootSet,
-                at: Date.now()
-            });
-            console.info(`[${this.deps.tag()}] took a dependency snapshot`, {
-                id: this.deps.id(),
-                snapshot: snapshot.id,
-                bytes: snapshot.size,
-                roots,
-                ms: Date.now() - startedAt
-            });
-        }
-        catch (err) {
-            console.warn(`[${this.deps.tag()}] could not take a dependency snapshot`, {
-                id: this.deps.id(),
-                err: String(err)
-            });
-        }
-    }
-    /** The package roots whose trees are on this container's disk. */
-    async #roots() {
-        const env_1 = { stack: [], error: void 0, hasError: false };
-        try {
-            const handle = __addDisposableResource(env_1, await this.deps
-                .workspace()
-                .runtime.exec(DEPS_ROOTS_COMMAND, {
-                cwd: "/",
-                encoding: "utf8",
-                timeoutMs: 30_000
-            }), false);
-            const result = await handle.result();
-            if (result.exitCode !== 0)
-                throw new Error(`could not list the dependency trees: ${result.stderr || `exit ${result.exitCode}`}`);
-            return parseDepsRoots(result.stdout ?? "");
-        }
-        catch (e_1) {
-            env_1.error = e_1;
-            env_1.hasError = true;
-        }
-        finally {
-            __disposeResources(env_1);
-        }
-    }
-}
-/** Enough of a record's shape to restore from — it arrives over RPC. */
-function isRecord(value) {
-    const r = value;
-    return (typeof r?.id === "string" &&
-        typeof r.image === "string" &&
-        typeof r.dir === "string" &&
-        typeof r.fingerprint === "string" &&
-        typeof r.rootSet === "string" &&
-        Array.isArray(r.roots) &&
-        r.roots.every((root) => typeof root?.dir === "string"));
-}