@botlearn-course/daemon 0.0.19 → 0.0.20-beta.2

package/dist/workspace-snapshot-staging.js

@@ -0,0 +1,275 @@
+import { createHash, randomUUID } from "node:crypto";
+import { chmodSync, closeSync, constants, existsSync, fstatSync, fsyncSync, lstatSync, mkdirSync, openSync, readdirSync, readSync, realpathSync, rmSync, writeSync, } from "node:fs";
+import path from "node:path";
+import { isWorkspaceQuiescenceProof, } from "./runtime-quiescence.js";
+import { defaultCaseFold, validateWorkspaceEntrySet, WORKSPACE_ENTRY_SET_SCHEMA, } from "./workspace-entry-set.js";
+const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
+const EXCLUDED_NAMES = new Set(["node_modules"]);
+const COPY_CHUNK_BYTES = 64 * 1024;
+export class WorkspaceSnapshotStagingError extends Error {
+    code;
+    retryable;
+    constructor(code, retryable = false) {
+        super(code);
+        this.code = code;
+        this.retryable = retryable;
+        this.name = "WorkspaceSnapshotStagingError";
+    }
+}
+function fail(code, retryable = false) {
+    throw new WorkspaceSnapshotStagingError(code, retryable);
+}
+function containsPath(parent, candidate) {
+    const relative = path.relative(parent, candidate);
+    return relative === "" || (!relative.startsWith(".." + path.sep) && relative !== "..");
+}
+function sameIdentity(left, right) {
+    return left.dev === right.dev && left.ino === right.ino && left.size === right.size &&
+        left.mtimeNs === right.mtimeNs && left.ctimeNs === right.ctimeNs;
+}
+function decodeName(name) {
+    const decoded = name.toString("utf8");
+    if (!Buffer.from(decoded, "utf8").equals(name) || decoded.includes("\0")) {
+        fail("workspace_snapshot_invalid_utf8");
+    }
+    return decoded;
+}
+function excludedName(name) {
+    return name.startsWith(".") || EXCLUDED_NAMES.has(defaultCaseFold(name));
+}
+function normalizedMode(stats) {
+    return (stats.mode & 73n) !== 0n ? "0700" : "0600";
+}
+function assertSourceNode(stats, options) {
+    if (stats.dev !== options.rootDevice)
+        fail("workspace_snapshot_cross_device");
+    if (options.expected === "file") {
+        if (!stats.isFile())
+            fail("workspace_snapshot_unsupported_file_type");
+        if (stats.nlink !== 1n)
+            fail("workspace_snapshot_hard_link");
+    }
+    else if (!stats.isDirectory()) {
+        fail("workspace_snapshot_unsupported_file_type");
+    }
+}
+function copyStableFile(source, destination, options) {
+    const before = lstatSync(source, { bigint: true });
+    assertSourceNode(before, { rootDevice: options.rootDevice, expected: "file" });
+    if (before.size > BigInt(options.limits.maxFileBytes)) {
+        fail("workspace_snapshot_limit_exceeded");
+    }
+    const sourceHandle = openSync(source, constants.O_RDONLY | constants.O_NOFOLLOW);
+    let destinationHandle = null;
+    try {
+        const opened = fstatSync(sourceHandle, { bigint: true });
+        assertSourceNode(opened, { rootDevice: options.rootDevice, expected: "file" });
+        if (!sameIdentity(before, opened))
+            fail("workspace_snapshot_source_changed", true);
+        destinationHandle = openSync(destination, constants.O_WRONLY | constants.O_CREAT | constants.O_EXCL |
+            constants.O_NOFOLLOW, 0o600);
+        const hash = createHash("sha256");
+        const buffer = Buffer.allocUnsafe(COPY_CHUNK_BYTES);
+        let copied = 0;
+        while (true) {
+            const bytesRead = readSync(sourceHandle, buffer, 0, buffer.length, null);
+            if (bytesRead === 0)
+                break;
+            hash.update(buffer.subarray(0, bytesRead));
+            let written = 0;
+            while (written < bytesRead) {
+                written += writeSync(destinationHandle, buffer, written, bytesRead - written, null);
+            }
+            copied += bytesRead;
+            if (copied > options.limits.maxFileBytes)
+                fail("workspace_snapshot_limit_exceeded");
+        }
+        const after = fstatSync(sourceHandle, { bigint: true });
+        if (!sameIdentity(opened, after) || BigInt(copied) !== after.size) {
+            fail("workspace_snapshot_source_changed", true);
+        }
+        fsyncSync(destinationHandle);
+        const mode = normalizedMode(after);
+        chmodSync(destination, mode === "0700" ? 0o700 : 0o600);
+        return { sizeBytes: copied, sha256: hash.digest("hex"), mode };
+    }
+    finally {
+        if (destinationHandle !== null)
+            closeSync(destinationHandle);
+        closeSync(sourceHandle);
+    }
+}
+function fsyncDirectory(directory) {
+    const handle = openSync(directory, constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW);
+    try {
+        fsyncSync(handle);
+    }
+    finally {
+        closeSync(handle);
+    }
+}
+function descriptorPath(handle, fallback) {
+    if (existsSync("/proc/self/fd")) {
+        const value = path.join("/proc/self/fd", String(handle));
+        if (!existsSync(value))
+            fail("workspace_snapshot_fd_traversal_unavailable");
+        return value;
+    }
+    // Darwin has no procfs open-file path that supports relative child lookup. It is used
+    // only by local tests/BYOA; managed durable sandboxes are Linux and fail closed above.
+    return fallback;
+}
+function stageOnce(options, paths) {
+    const stagingDirectory = path.join(paths.checkpointRoot, randomUUID());
+    mkdirSync(stagingDirectory, { mode: 0o700 });
+    chmodSync(stagingDirectory, 0o700);
+    try {
+        const rootHandle = openSync(paths.workspace, constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW);
+        const rootStats = fstatSync(rootHandle, { bigint: true });
+        if (!rootStats.isDirectory()) {
+            closeSync(rootHandle);
+            fail("workspace_snapshot_root_invalid");
+        }
+        const entries = [];
+        const files = [];
+        let fileCount = 0;
+        let totalBytes = 0;
+        let estimatedEntrySetBytes = Buffer.byteLength('{"schemaVersion":"agent-workspace-entry-set/1","entries":[]}', "utf8");
+        function appendEntry(entry) {
+            estimatedEntrySetBytes += Buffer.byteLength(JSON.stringify(entry), "utf8") + 1;
+            if (estimatedEntrySetBytes > options.limits.maxEntrySetBytes) {
+                fail("workspace_snapshot_limit_exceeded");
+            }
+            entries.push(entry);
+        }
+        function walk(sourceHandle, sourceFallback, destinationDirectory, segments) {
+            const directoryBefore = fstatSync(sourceHandle, { bigint: true });
+            assertSourceNode(directoryBefore, {
+                rootDevice: rootStats.dev,
+                expected: "directory",
+            });
+            const sourceDirectory = descriptorPath(sourceHandle, sourceFallback);
+            const children = readdirSync(sourceDirectory, {
+                encoding: "buffer",
+            }).sort((left, right) => Buffer.compare(left, right));
+            for (const child of children) {
+                const name = decodeName(child);
+                if (excludedName(name))
+                    continue;
+                const relativeSegments = [...segments, name];
+                if (relativeSegments.length > options.limits.maxDepth) {
+                    fail("workspace_snapshot_limit_exceeded");
+                }
+                const relativePath = relativeSegments.join("/");
+                const source = path.join(sourceDirectory, name);
+                const destination = path.join(destinationDirectory, name);
+                const stats = lstatSync(source, { bigint: true });
+                if (stats.isSymbolicLink())
+                    fail("workspace_snapshot_unsupported_file_type");
+                if (stats.isDirectory()) {
+                    assertSourceNode(stats, { rootDevice: rootStats.dev, expected: "directory" });
+                    const childHandle = openSync(source, constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW);
+                    const openedDirectory = fstatSync(childHandle, { bigint: true });
+                    if (!sameIdentity(stats, openedDirectory)) {
+                        closeSync(childHandle);
+                        fail("workspace_snapshot_source_changed", true);
+                    }
+                    mkdirSync(destination, { mode: 0o700 });
+                    chmodSync(destination, 0o700);
+                    appendEntry({ type: "directory", path: relativePath, mode: "0700" });
+                    try {
+                        walk(childHandle, source, destination, relativeSegments);
+                    }
+                    finally {
+                        closeSync(childHandle);
+                    }
+                    continue;
+                }
+                const copied = copyStableFile(source, destination, {
+                    rootDevice: rootStats.dev,
+                    limits: options.limits,
+                });
+                fileCount += 1;
+                totalBytes += copied.sizeBytes;
+                if (fileCount > options.limits.maxFileCount ||
+                    totalBytes > options.limits.maxTotalBytes)
+                    fail("workspace_snapshot_limit_exceeded");
+                appendEntry({
+                    type: "file",
+                    path: relativePath,
+                    mode: copied.mode,
+                    sizeBytes: copied.sizeBytes,
+                    sha256: copied.sha256,
+                });
+                files.push({
+                    path: relativePath,
+                    stagingPath: destination,
+                    sizeBytes: copied.sizeBytes,
+                    sha256: copied.sha256,
+                });
+            }
+            const directoryAfter = fstatSync(sourceHandle, { bigint: true });
+            if (!sameIdentity(directoryBefore, directoryAfter)) {
+                fail("workspace_snapshot_source_changed", true);
+            }
+            fsyncDirectory(destinationDirectory);
+        }
+        try {
+            walk(rootHandle, paths.workspace, stagingDirectory, []);
+        }
+        finally {
+            closeSync(rootHandle);
+        }
+        entries.sort((left, right) => Buffer.compare(Buffer.from(left.path, "utf8"), Buffer.from(right.path, "utf8")));
+        files.sort((left, right) => Buffer.compare(Buffer.from(left.path, "utf8"), Buffer.from(right.path, "utf8")));
+        const entrySet = validateWorkspaceEntrySet({ schemaVersion: WORKSPACE_ENTRY_SET_SCHEMA, entries }, options.limits);
+        return { stagingDirectory, entrySet, files };
+    }
+    catch (error) {
+        rmSync(stagingDirectory, { recursive: true, force: true });
+        throw error;
+    }
+}
+export function stageWorkspaceSnapshot(options) {
+    if (!UUID.test(options.checkpointId))
+        fail("workspace_snapshot_checkpoint_invalid");
+    if (!isWorkspaceQuiescenceProof(options.quiescenceProof) ||
+        options.quiescenceProof.proofVersion !== "workspace-quiescence-proof/1" ||
+        !UUID.test(options.quiescenceProof.sandboxId) ||
+        !UUID.test(options.quiescenceProof.runtimeSessionId) ||
+        options.quiescenceProof.checkpointId !== options.checkpointId ||
+        !Number.isSafeInteger(options.quiescenceProof.sandboxGeneration) ||
+        options.quiescenceProof.sandboxGeneration < 1 ||
+        options.quiescenceProof.allWritersStopped !== true)
+        fail("workspace_snapshot_writer_isolation_unproven");
+    if (!Number.isSafeInteger(options.maxStabilityRetries) || options.maxStabilityRetries < 0) {
+        fail("workspace_snapshot_retry_limit_invalid");
+    }
+    const workspace = realpathSync(options.workspaceDirectory);
+    const requestedControl = path.resolve(options.controlDirectory);
+    if (containsPath(workspace, requestedControl)) {
+        fail("workspace_snapshot_control_path_invalid");
+    }
+    mkdirSync(options.controlDirectory, { recursive: true, mode: 0o700 });
+    chmodSync(options.controlDirectory, 0o700);
+    const control = realpathSync(options.controlDirectory);
+    if (containsPath(workspace, control))
+        fail("workspace_snapshot_control_path_invalid");
+    const checkpointRoot = path.join(control, "workspace-snapshot-staging", options.checkpointId);
+    mkdirSync(checkpointRoot, { recursive: true, mode: 0o700 });
+    chmodSync(checkpointRoot, 0o700);
+    let attempt = 0;
+    while (true) {
+        try {
+            return stageOnce(options, { workspace, checkpointRoot });
+        }
+        catch (error) {
+            if (error instanceof WorkspaceSnapshotStagingError && error.retryable &&
+                attempt < options.maxStabilityRetries) {
+                attempt += 1;
+                continue;
+            }
+            throw error;
+        }
+    }
+}

package/dist/workspace.d.ts

@@ -26,6 +26,61 @@ export declare function runtimeSessionRootDir(runtimeSessionId: string, sandboxG
  */
 export declare function runtimeSessionWorkspaceDir(runtimeSessionId: string, sandboxGeneration: number): string;
 export declare function runtimeSessionTranscriptPath(runtimeSessionId: string, sandboxGeneration: number, agentRunId: string): string;
+export declare const WORKSPACE_COPY_POLICY_V1: Readonly<{
+    policyId: "WorkspaceCopyPolicyV1";
+    maxTotalEntries: 25000;
+    maxFiles: 20000;
+    maxSymlinks: 2000;
+    maxBytes: number;
+    maxDepth: 64;
+    maxRelativePathBytes: 4096;
+    maxDurationSeconds: 600;
+    markerName: ".botlearn-workspace-copy";
+}>;
+export type WorkspaceCopyErrorCode = "workspace_migration_source_unavailable" | "workspace_migration_content_unsafe" | "workspace_migration_limit_exceeded" | "workspace_migration_io_failed" | "workspace_migration_receipt_mismatch";
+export declare class WorkspaceCopyError extends Error {
+    readonly code: WorkspaceCopyErrorCode;
+    constructor(code: WorkspaceCopyErrorCode);
+}
+export interface WorkspaceCopyReceiptV1 {
+    schema_version: "botlearn-workspace-copy-receipt/1";
+    policy_id: "WorkspaceCopyPolicyV1";
+    copy_id: string;
+    source_runtime_session_id: string;
+    target_runtime_session_id: string;
+    source_sandbox_id: string;
+    source_generation: number;
+    file_count: number;
+    directory_count: number;
+    symlink_count: number;
+    total_bytes: number;
+    manifest_digest: string;
+}
+export interface WorkspaceCopyResult {
+    receipt: WorkspaceCopyReceiptV1;
+    markerPath: string;
+}
+interface ManifestEntry {
+    type: "file" | "dir" | "link";
+    relativePath: string;
+    modeTag: "file-0600" | "file-0700" | "dir-0700" | "link";
+    byteSize?: number;
+    contentDigest?: Buffer;
+    linkTarget?: string;
+}
+export declare function workspaceCopyManifestDigest(entries: ManifestEntry[]): string;
+export declare function workspaceCopyV1Supported(): boolean;
+/** Remove crash-left staging directories before advertising workspace_copy_v1. */
+export declare function cleanupRuntimeSessionWorkspaceCopyStaging(): Promise<void>;
+/** Copy learner-owned files into a new Session and durably stage a content-free receipt. */
+export declare function copyRuntimeSessionWorkspace(request: {
+    copyId: string;
+    sourceRuntimeSessionId: string;
+    targetRuntimeSessionId: string;
+    sandboxId: string;
+    sandboxGeneration: number;
+}): Promise<WorkspaceCopyResult>;
+export declare function finalizeRuntimeSessionWorkspaceCopy(markerPath: string): Promise<void>;
 export declare function ensureRunWorkspace(agentRunId: string): {
     rootDir: string;
     workspaceDir: string;
@@ -53,3 +108,4 @@ export declare function ensureRuntimeSessionWorkspace(runtimeSessionId: string,
     workspaceDir: string;
     transcriptFile: string;
 };
+export {};