mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 02:44:50 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - A core part of that experience is watching active agent runs without dropping into raw logs first > - Local and sandbox-backed adapters already record useful run output, progress, and tool activity > - But active issue threads could sit visually stale while the agent was syncing workspaces, tailing sandbox output, or emitting incremental tool-call updates > - Operators need timely, human-readable progress while preserving the raw transcript underneath > - This pull request streams sandbox run-log progress into runtime status, keeps visible issue threads refreshed, and folds repeated ACPX tool updates into stable transcript cards > - The benefit is that long-running agent work becomes easier to supervise without changing the task/comment control-plane model ## Linked Issues or Issue Description No public GitHub issue exists for this exact change. Problem/motivation: - During long-running sandboxed agent work, the issue UI can appear idle even though the agent is actively syncing, running tools, or producing incremental output. - Operators need realtime feedback at the issue-thread layer, not only after opening raw logs or waiting for the final heartbeat result. - Related public context: #1808 previously added live-run status dots to Projects; #4362 touches heartbeat wakeup behavior but is not a duplicate of this runtime/UI feedback change. ## What Changed - Added sandbox run-log streaming support and defaulted sandbox-capable local adapters into the richer live-feedback path. - Surfaced environment/sandbox sync progress through heartbeat runtime status with bounded, redacted snippets. - Added live issue-thread cache patching so visible active runs update as progress events arrive. - Folded repeated ACPX `tool_call` updates into one transcript card instead of stacking duplicate cards. - Updated adapter docs and added focused regression coverage for sandbox log streaming, runtime status, ACPX parsing, live updates, transcript rendering, and issue chat messages. ## Verification - `pnpm install --frozen-lockfile` - `pnpm exec vitest run ui/src/context/LiveUpdatesProvider.test.ts` - `pnpm exec vitest run server/src/services/heartbeat-run-runtime-status.test.ts server/src/__tests__/heartbeat-runtime-state.test.ts ui/src/context/LiveUpdatesProvider.test.ts` - `pnpm exec vitest run packages/adapter-utils/src/execution-target-sandbox.test.ts packages/adapter-utils/src/sandbox-managed-runtime.test.ts server/src/services/heartbeat-run-runtime-status.test.ts server/src/__tests__/agent-live-run-routes.test.ts server/src/__tests__/heartbeat-runtime-state.test.ts packages/adapters/acpx-local/src/ui/parse-stdout.test.ts ui/src/context/LiveUpdatesProvider.test.ts ui/src/components/transcript/RunTranscriptView.test.tsx ui/src/lib/issue-chat-messages.test.ts ui/src/components/IssueChatThread.test.tsx` - GitHub PR workflow on head `8397953e7b41ccd42e5d9457ee7e4dfb996e4ec5`: `verify`, build, typecheck/release-registry, e2e, general shards, serialized server shards, and canary dry run passed. - Greptile Review on head `8397953e7b41ccd42e5d9457ee7e4dfb996e4ec5`: Confidence Score 5/5, no unresolved review threads. ## Risks - Live issue-thread cache patching could miss an edge case for a route shape not covered by tests. - Surfacing active-run snippets needs continued care around redaction; this PR keeps snippets bounded and adds redaction-focused coverage. - More frequent active-run UI refreshes could expose performance issues on very large issue threads, though updates are scoped to visible run/query caches. ## Model Used OpenAI GPT-5 via Codex, operating as a tool-enabled coding agent with shell, git, and repository-editing capabilities. Context window size is not exposed in this runtime. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge Co-authored-by: Paperclip <noreply@paperclip.ing>
708 lines
26 KiB
TypeScript
708 lines
26 KiB
TypeScript
import { execFile as execFileCallback } from "node:child_process";
|
|
import { constants as fsConstants, promises as fs } from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { promisify } from "node:util";
|
|
import {
|
|
buildRemoteGitDeltaBundleScript,
|
|
createImportedGitRef,
|
|
createRemoteGitExportRef,
|
|
deleteLocalGitRef,
|
|
fetchGitBundleIntoLocalRef,
|
|
GIT_ARCHIVE_EXCLUDES,
|
|
integrateImportedGitHead,
|
|
readGitWorkspaceSnapshot,
|
|
resetLocalGitIndexToHead,
|
|
withShallowGitWorkspaceClone,
|
|
} from "./git-workspace-sync.js";
|
|
import { captureDirectorySnapshot, mergeDirectoryWithBaseline } from "./workspace-restore-merge.js";
|
|
import {
|
|
createRuntimeProgressReporter,
|
|
type RuntimeProgressDirection,
|
|
type RuntimeProgressPhase,
|
|
type RuntimeProgressSink,
|
|
type RuntimeStatusPhase,
|
|
type RuntimeStatusSink,
|
|
} from "./runtime-progress.js";
|
|
import { isRelativePathOrDescendant, shouldExcludePath } from "./exclude-patterns.js";
|
|
|
|
const execFile = promisify(execFileCallback);
|
|
const SANDBOX_WORKSPACE_HEAVY_DIR_NAMES = [
|
|
"node_modules",
|
|
"vendor",
|
|
"dist",
|
|
"build",
|
|
"out",
|
|
"coverage",
|
|
".next",
|
|
".turbo",
|
|
".cache",
|
|
] as const;
|
|
const SANDBOX_WORKSPACE_HEAVY_DIR_EXCLUDES = SANDBOX_WORKSPACE_HEAVY_DIR_NAMES.flatMap((entry) => [
|
|
entry,
|
|
`${entry}/*`,
|
|
`*/${entry}`,
|
|
`*/${entry}/*`,
|
|
]);
|
|
|
|
export interface SandboxRemoteExecutionSpec {
|
|
transport: "sandbox";
|
|
provider: string;
|
|
sandboxId: string;
|
|
remoteCwd: string;
|
|
timeoutMs: number;
|
|
apiKey: string | null;
|
|
}
|
|
|
|
export interface SandboxManagedRuntimeAsset {
|
|
key: string;
|
|
localDir: string;
|
|
followSymlinks?: boolean;
|
|
exclude?: string[];
|
|
}
|
|
|
|
/**
|
|
* Per-call byte-level progress hook. `transferredBytes`/`totalBytes` are decoded
|
|
* file bytes (not the base64 wire size). `totalBytes` is null when the size is
|
|
* not known up front. The transport is the source of truth for byte counts; the
|
|
* orchestrator owns the phase label and direction.
|
|
*/
|
|
export interface SandboxTransferProgressOptions {
|
|
onProgress?: (transferredBytes: number, totalBytes: number | null) => void | Promise<void>;
|
|
}
|
|
|
|
export interface SandboxManagedRuntimeClient {
|
|
makeDir(remotePath: string): Promise<void>;
|
|
writeFile(remotePath: string, bytes: ArrayBuffer, options?: SandboxTransferProgressOptions): Promise<void>;
|
|
readFile(
|
|
remotePath: string,
|
|
options?: SandboxTransferProgressOptions,
|
|
): Promise<Buffer | Uint8Array | ArrayBuffer>;
|
|
listFiles(remotePath: string): Promise<string[]>;
|
|
remove(remotePath: string): Promise<void>;
|
|
run(command: string, options: { timeoutMs: number }): Promise<void>;
|
|
}
|
|
|
|
export interface PreparedSandboxManagedRuntime {
|
|
spec: SandboxRemoteExecutionSpec;
|
|
workspaceLocalDir: string;
|
|
workspaceRemoteDir: string;
|
|
runtimeRootDir: string;
|
|
assetDirs: Record<string, string>;
|
|
restoreWorkspace(onProgress?: RuntimeProgressSink): Promise<void>;
|
|
}
|
|
|
|
function asObject(value: unknown): Record<string, unknown> {
|
|
return value && typeof value === "object" && !Array.isArray(value)
|
|
? (value as Record<string, unknown>)
|
|
: {};
|
|
}
|
|
|
|
function asString(value: unknown): string {
|
|
return typeof value === "string" ? value : "";
|
|
}
|
|
|
|
function asNumber(value: unknown): number {
|
|
return typeof value === "number" ? value : Number(value);
|
|
}
|
|
|
|
function shellQuote(value: string) {
|
|
return `'${value.replace(/'/g, `'\"'\"'`)}'`;
|
|
}
|
|
|
|
export function parseSandboxRemoteExecutionSpec(value: unknown): SandboxRemoteExecutionSpec | null {
|
|
const parsed = asObject(value);
|
|
const transport = asString(parsed.transport).trim();
|
|
const provider = asString(parsed.provider).trim();
|
|
const sandboxId = asString(parsed.sandboxId).trim();
|
|
const remoteCwd = asString(parsed.remoteCwd).trim();
|
|
const timeoutMs = asNumber(parsed.timeoutMs);
|
|
|
|
if (
|
|
transport !== "sandbox" ||
|
|
provider.length === 0 ||
|
|
sandboxId.length === 0 ||
|
|
remoteCwd.length === 0 ||
|
|
!Number.isFinite(timeoutMs) ||
|
|
timeoutMs <= 0
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
return {
|
|
transport: "sandbox",
|
|
provider,
|
|
sandboxId,
|
|
remoteCwd,
|
|
timeoutMs,
|
|
apiKey: asString(parsed.apiKey).trim() || null,
|
|
};
|
|
}
|
|
|
|
export function buildSandboxExecutionSessionIdentity(spec: SandboxRemoteExecutionSpec | null) {
|
|
if (!spec) return null;
|
|
return {
|
|
transport: "sandbox",
|
|
provider: spec.provider,
|
|
sandboxId: spec.sandboxId,
|
|
remoteCwd: spec.remoteCwd,
|
|
} as const;
|
|
}
|
|
|
|
export function sandboxExecutionSessionMatches(saved: unknown, current: SandboxRemoteExecutionSpec | null): boolean {
|
|
const currentIdentity = buildSandboxExecutionSessionIdentity(current);
|
|
if (!currentIdentity) return false;
|
|
const parsedSaved = asObject(saved);
|
|
return (
|
|
asString(parsedSaved.transport) === currentIdentity.transport &&
|
|
asString(parsedSaved.provider) === currentIdentity.provider &&
|
|
asString(parsedSaved.sandboxId) === currentIdentity.sandboxId &&
|
|
asString(parsedSaved.remoteCwd) === currentIdentity.remoteCwd
|
|
);
|
|
}
|
|
|
|
async function withTempDir<T>(prefix: string, fn: (dir: string) => Promise<T>): Promise<T> {
|
|
const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix));
|
|
try {
|
|
return await fn(dir);
|
|
} finally {
|
|
await fs.rm(dir, { recursive: true, force: true }).catch(() => undefined);
|
|
}
|
|
}
|
|
|
|
async function execTar(args: string[]): Promise<void> {
|
|
await execFile("tar", args, {
|
|
env: {
|
|
...process.env,
|
|
COPYFILE_DISABLE: "1",
|
|
},
|
|
maxBuffer: 32 * 1024 * 1024,
|
|
});
|
|
}
|
|
|
|
async function createTarballFromDirectory(input: {
|
|
localDir: string;
|
|
archivePath: string;
|
|
exclude?: string[];
|
|
followSymlinks?: boolean;
|
|
}): Promise<void> {
|
|
const excludeArgs = ["._*", ...(input.exclude ?? [])].flatMap((entry) => ["--exclude", entry]);
|
|
// Archive the directory's top-level entries BY NAME rather than ".". Archiving
|
|
// "." embeds a "./" self-entry whose mode/mtime tar then tries to restore onto
|
|
// the extraction target directory; that chmod/utime fails with "Operation not
|
|
// permitted" when the target is a directory the extracting (non-root) user does
|
|
// not own, e.g. an emptyDir mount in a hardened/gVisor sandbox pod. Enumerating
|
|
// entries avoids the self-entry entirely and is portable across GNU/BSD/busybox
|
|
// tar (no GNU-only --no-overwrite-dir needed). --exclude still filters nested
|
|
// matches and any named entry it matches.
|
|
const entries = (await fs.readdir(input.localDir)).sort((left, right) => left.localeCompare(right));
|
|
if (entries.length === 0) {
|
|
// A workspace can legitimately be empty (blank-workspace agent runs). Write a
|
|
// valid empty tar archive (1024-byte all-zero EOF marker) so extraction is a
|
|
// clean no-op rather than tar refusing to create an empty archive.
|
|
await fs.writeFile(input.archivePath, Buffer.alloc(1024));
|
|
return;
|
|
}
|
|
await execTar([
|
|
"-c",
|
|
// Prevent macOS bsdtar from embedding LIBARCHIVE.xattr.* PAX extended
|
|
// headers for extended attributes (e.g. com.apple.provenance). GNU tar on
|
|
// Linux does not recognise these proprietary headers and fails extraction
|
|
// with "This does not look like a tar archive". COPYFILE_DISABLE=1 (set in
|
|
// execTar) already suppresses AppleDouble ._* sidecar files; --no-xattrs
|
|
// additionally suppresses the inline PAX xattr entries.
|
|
"--no-xattrs",
|
|
...(input.followSymlinks ? ["-h"] : []),
|
|
"-f",
|
|
input.archivePath,
|
|
"-C",
|
|
input.localDir,
|
|
...excludeArgs,
|
|
"--",
|
|
...entries,
|
|
]);
|
|
}
|
|
|
|
async function extractTarballToDirectory(input: {
|
|
archivePath: string;
|
|
localDir: string;
|
|
}): Promise<void> {
|
|
await fs.mkdir(input.localDir, { recursive: true });
|
|
await execTar(["-xf", input.archivePath, "-C", input.localDir]);
|
|
}
|
|
|
|
async function walkDirectory(root: string, relative = ""): Promise<string[]> {
|
|
const current = path.join(root, relative);
|
|
const entries = await fs.readdir(current, { withFileTypes: true }).catch(() => []);
|
|
const out: string[] = [];
|
|
for (const entry of entries) {
|
|
const nextRelative = relative ? path.posix.join(relative, entry.name) : entry.name;
|
|
out.push(nextRelative);
|
|
if (entry.isDirectory()) {
|
|
out.push(...(await walkDirectory(root, nextRelative)));
|
|
}
|
|
}
|
|
return out.sort((left, right) => right.length - left.length);
|
|
}
|
|
|
|
async function copyWorkspaceEntry(sourceRoot: string, targetRoot: string, relative: string): Promise<void> {
|
|
const sourcePath = path.join(sourceRoot, relative);
|
|
const targetPath = path.join(targetRoot, relative);
|
|
const stats = await fs.lstat(sourcePath);
|
|
|
|
if (stats.isDirectory()) {
|
|
await fs.mkdir(targetPath, { recursive: true });
|
|
return;
|
|
}
|
|
|
|
await fs.mkdir(path.dirname(targetPath), { recursive: true });
|
|
await fs.rm(targetPath, { recursive: true, force: true }).catch(() => undefined);
|
|
if (stats.isSymbolicLink()) {
|
|
const linkTarget = await fs.readlink(sourcePath);
|
|
await fs.symlink(linkTarget, targetPath);
|
|
return;
|
|
}
|
|
|
|
await fs.copyFile(sourcePath, targetPath, fsConstants.COPYFILE_FICLONE).catch(async () => {
|
|
await fs.copyFile(sourcePath, targetPath);
|
|
});
|
|
await fs.chmod(targetPath, stats.mode);
|
|
}
|
|
|
|
export async function mirrorDirectory(
|
|
sourceDir: string,
|
|
targetDir: string,
|
|
options: { preserveAbsent?: string[] } = {},
|
|
): Promise<void> {
|
|
await fs.mkdir(targetDir, { recursive: true });
|
|
const preserveAbsent = new Set(options.preserveAbsent ?? []);
|
|
const shouldPreserveAbsent = (relative: string) =>
|
|
[...preserveAbsent].some((candidate) => isRelativePathOrDescendant(relative, candidate));
|
|
|
|
const sourceEntries = new Set(await walkDirectory(sourceDir));
|
|
const targetEntries = await walkDirectory(targetDir);
|
|
for (const relative of targetEntries) {
|
|
if (shouldPreserveAbsent(relative)) continue;
|
|
if (!sourceEntries.has(relative)) {
|
|
await fs.rm(path.join(targetDir, relative), { recursive: true, force: true }).catch(() => undefined);
|
|
}
|
|
}
|
|
|
|
const entries = (await walkDirectory(sourceDir)).sort((left, right) => left.localeCompare(right));
|
|
for (const relative of entries) {
|
|
await copyWorkspaceEntry(sourceDir, targetDir, relative);
|
|
}
|
|
}
|
|
|
|
async function copySelectedWorkspaceEntries(input: {
|
|
sourceDir: string;
|
|
targetDir: string;
|
|
relativePaths: string[];
|
|
exclude: string[];
|
|
}): Promise<void> {
|
|
await fs.mkdir(input.targetDir, { recursive: true });
|
|
for (const relative of input.relativePaths) {
|
|
if (shouldExcludePath(relative, input.exclude)) continue;
|
|
const sourceStats = await fs.lstat(path.join(input.sourceDir, relative)).catch(() => null);
|
|
if (!sourceStats) continue;
|
|
await copyWorkspaceEntry(input.sourceDir, input.targetDir, relative);
|
|
}
|
|
}
|
|
|
|
function toArrayBuffer(bytes: Buffer): ArrayBuffer {
|
|
return Uint8Array.from(bytes).buffer;
|
|
}
|
|
|
|
function toBuffer(bytes: Buffer | Uint8Array | ArrayBuffer): Buffer {
|
|
if (Buffer.isBuffer(bytes)) return bytes;
|
|
if (bytes instanceof ArrayBuffer) return Buffer.from(bytes);
|
|
return Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength);
|
|
}
|
|
|
|
function tarExcludeFlags(exclude: string[] | undefined): string {
|
|
return ["._*", ...(exclude ?? [])].map((entry) => `--exclude ${shellQuote(entry)}`).join(" ");
|
|
}
|
|
|
|
function createRemoteTarballFromDirectoryCommand(input: {
|
|
remoteDir: string;
|
|
archivePath: string;
|
|
exclude?: string[];
|
|
}): string {
|
|
// Match the local archive path: name top-level entries explicitly so tar
|
|
// does not include a "." self-entry that it later tries to chmod/utime.
|
|
return [
|
|
`mkdir -p ${shellQuote(path.posix.dirname(input.archivePath))}`,
|
|
`cd ${shellQuote(input.remoteDir)}`,
|
|
"set -- *",
|
|
`if [ "$#" -eq 1 ] && [ "$1" = "*" ] && [ ! -e "$1" ] && [ ! -L "$1" ]; then set --; fi`,
|
|
`for entry in .[!.]* ..?*; do [ -e "$entry" ] || [ -L "$entry" ] || continue; set -- "$@" "$entry"; done`,
|
|
`if [ "$#" -eq 0 ]; then ` +
|
|
`dd if=/dev/zero of=${shellQuote(input.archivePath)} bs=1024 count=1; ` +
|
|
`else tar -cf ${shellQuote(input.archivePath)} ${tarExcludeFlags(input.exclude)} -- "$@"; fi`,
|
|
].join(" && ");
|
|
}
|
|
|
|
async function emitRuntimeStatus(
|
|
sink: RuntimeStatusSink | undefined,
|
|
phase: RuntimeStatusPhase,
|
|
message: string,
|
|
): Promise<void> {
|
|
if (!sink) return;
|
|
await Promise.resolve(sink({ phase, message })).catch(() => undefined);
|
|
}
|
|
|
|
function mergeExcludes(...groups: Array<string[] | undefined>): string[] {
|
|
return [...new Set(groups.flatMap((group) => group ?? []))];
|
|
}
|
|
|
|
function preserveFindArgs(entries: string[]): string {
|
|
return entries.map((entry) => `! -name ${shellQuote(entry)}`).join(" ");
|
|
}
|
|
|
|
async function removeDeletedPathsInSandbox(input: {
|
|
client: SandboxManagedRuntimeClient;
|
|
spec: SandboxRemoteExecutionSpec;
|
|
remoteDir: string;
|
|
deletedPaths: string[];
|
|
}): Promise<void> {
|
|
if (input.deletedPaths.length === 0) return;
|
|
const quotedPaths = input.deletedPaths.map((entry) => shellQuote(entry)).join(" ");
|
|
await input.client.run(
|
|
`sh -c ${shellQuote(`cd ${shellQuote(input.remoteDir)} && rm -rf -- ${quotedPaths}`)}`,
|
|
{ timeoutMs: input.spec.timeoutMs },
|
|
);
|
|
}
|
|
|
|
// Bridge a single byte-level transfer to the throttled progress reporter. The
|
|
// transport reports decoded bytes via `options.onProgress`; the reporter turns
|
|
// them into a throttled, fully-formatted log line. `finish()` emits the terminal
|
|
// completion line (idempotent) once the transfer returns.
|
|
function makeTransferProgress(
|
|
sink: RuntimeProgressSink | undefined,
|
|
phase: RuntimeProgressPhase,
|
|
direction: RuntimeProgressDirection,
|
|
label?: string,
|
|
runtimeStatus?: {
|
|
sink: RuntimeStatusSink | undefined;
|
|
phase: RuntimeStatusPhase;
|
|
},
|
|
): {
|
|
options: SandboxTransferProgressOptions | undefined;
|
|
finish: (doneBytes?: number, totalBytes?: number | null) => Promise<void>;
|
|
} {
|
|
if (!sink && !runtimeStatus?.sink) {
|
|
return { options: undefined, finish: async () => {} };
|
|
}
|
|
const reporter = createRuntimeProgressReporter({
|
|
sink: async (line) => {
|
|
await sink?.(line);
|
|
if (runtimeStatus?.sink) {
|
|
await emitRuntimeStatus(
|
|
runtimeStatus.sink,
|
|
runtimeStatus.phase,
|
|
line.replace(/^\[paperclip\]\s*/, "").trim(),
|
|
);
|
|
}
|
|
},
|
|
phase,
|
|
direction,
|
|
target: "sandbox",
|
|
label,
|
|
});
|
|
return {
|
|
options: {
|
|
onProgress: async (transferredBytes, totalBytes) => {
|
|
await reporter.report(transferredBytes, totalBytes);
|
|
},
|
|
},
|
|
finish: async (doneBytes, totalBytes) => {
|
|
await reporter.complete(doneBytes, totalBytes);
|
|
},
|
|
};
|
|
}
|
|
|
|
export async function prepareSandboxManagedRuntime(input: {
|
|
spec: SandboxRemoteExecutionSpec;
|
|
adapterKey: string;
|
|
client: SandboxManagedRuntimeClient;
|
|
workspaceLocalDir: string;
|
|
workspaceRemoteDir?: string;
|
|
workspaceExclude?: string[];
|
|
preserveAbsentOnRestore?: string[];
|
|
assets?: SandboxManagedRuntimeAsset[];
|
|
// Upload progress sink. Threaded for the byte-counting transport rewrite; the
|
|
// child task wires it into writeFile/readFile.
|
|
onProgress?: RuntimeProgressSink;
|
|
onRuntimeProgress?: RuntimeStatusSink;
|
|
}): Promise<PreparedSandboxManagedRuntime> {
|
|
const workspaceRemoteDir = input.workspaceRemoteDir ?? input.spec.remoteCwd;
|
|
const runtimeRootDir = path.posix.join(workspaceRemoteDir, ".paperclip-runtime", input.adapterKey);
|
|
const gitSnapshot = await readGitWorkspaceSnapshot(input.workspaceLocalDir);
|
|
const gitIgnoredExcludes = gitSnapshot?.ignoredPaths;
|
|
const workspaceArchiveExclude = mergeExcludes(
|
|
SANDBOX_WORKSPACE_HEAVY_DIR_EXCLUDES,
|
|
[...GIT_ARCHIVE_EXCLUDES],
|
|
input.workspaceExclude,
|
|
gitIgnoredExcludes,
|
|
);
|
|
const restoreExclude = mergeExcludes(
|
|
SANDBOX_WORKSPACE_HEAVY_DIR_EXCLUDES,
|
|
[...GIT_ARCHIVE_EXCLUDES],
|
|
[".paperclip-runtime"],
|
|
input.preserveAbsentOnRestore,
|
|
input.workspaceExclude,
|
|
gitIgnoredExcludes,
|
|
);
|
|
const baselineSnapshot = await captureDirectorySnapshot(input.workspaceLocalDir, {
|
|
exclude: restoreExclude,
|
|
});
|
|
|
|
await withTempDir("paperclip-sandbox-sync-", async (tempDir) => {
|
|
const preservedNames = new Set([
|
|
".paperclip-runtime",
|
|
...(gitSnapshot ? [".git"] : []),
|
|
...(input.preserveAbsentOnRestore ?? []),
|
|
]);
|
|
if (gitSnapshot) {
|
|
await emitRuntimeStatus(input.onRuntimeProgress, "git_sync", "Syncing git history to sandbox");
|
|
await withShallowGitWorkspaceClone({
|
|
localDir: input.workspaceLocalDir,
|
|
snapshot: gitSnapshot,
|
|
}, async (cloneDir) => {
|
|
const gitTarPath = path.join(tempDir, "git-workspace.tar");
|
|
await createTarballFromDirectory({
|
|
localDir: cloneDir,
|
|
archivePath: gitTarPath,
|
|
exclude: [".paperclip-runtime"],
|
|
});
|
|
const gitTarBytes = await fs.readFile(gitTarPath);
|
|
const remoteGitTar = path.posix.join(runtimeRootDir, "git-workspace-upload.tar");
|
|
await input.client.makeDir(runtimeRootDir);
|
|
const gitUpload = makeTransferProgress(
|
|
input.onProgress,
|
|
"Syncing",
|
|
"to",
|
|
"git history",
|
|
{ sink: input.onRuntimeProgress, phase: "git_sync" },
|
|
);
|
|
await input.client.writeFile(remoteGitTar, toArrayBuffer(gitTarBytes), gitUpload.options);
|
|
await gitUpload.finish(gitTarBytes.byteLength, gitTarBytes.byteLength);
|
|
await input.client.run(
|
|
`sh -c ${shellQuote(
|
|
`mkdir -p ${shellQuote(workspaceRemoteDir)} && ` +
|
|
`find ${shellQuote(workspaceRemoteDir)} -mindepth 1 -maxdepth 1 ${preserveFindArgs([".paperclip-runtime"])} -exec rm -rf -- {} + && ` +
|
|
`tar -xf ${shellQuote(remoteGitTar)} -C ${shellQuote(workspaceRemoteDir)} && ` +
|
|
`rm -f ${shellQuote(remoteGitTar)}`,
|
|
)}`,
|
|
{ timeoutMs: input.spec.timeoutMs },
|
|
);
|
|
});
|
|
}
|
|
|
|
const workspaceTarPath = path.join(tempDir, "workspace.tar");
|
|
const workspaceArchiveDir = gitSnapshot ? path.join(tempDir, "workspace-overlay") : input.workspaceLocalDir;
|
|
await emitRuntimeStatus(input.onRuntimeProgress, "config_sync", "Syncing workspace to sandbox");
|
|
if (gitSnapshot) {
|
|
await copySelectedWorkspaceEntries({
|
|
sourceDir: input.workspaceLocalDir,
|
|
targetDir: workspaceArchiveDir,
|
|
relativePaths: gitSnapshot.overlayPaths,
|
|
exclude: workspaceArchiveExclude,
|
|
});
|
|
}
|
|
await createTarballFromDirectory({
|
|
localDir: workspaceArchiveDir,
|
|
archivePath: workspaceTarPath,
|
|
exclude: gitSnapshot ? undefined : workspaceArchiveExclude,
|
|
});
|
|
const workspaceTarBytes = await fs.readFile(workspaceTarPath);
|
|
const remoteWorkspaceTar = path.posix.join(runtimeRootDir, "workspace-upload.tar");
|
|
await input.client.makeDir(runtimeRootDir);
|
|
const workspaceUpload = makeTransferProgress(
|
|
input.onProgress,
|
|
"Syncing",
|
|
"to",
|
|
"workspace",
|
|
{ sink: input.onRuntimeProgress, phase: "config_sync" },
|
|
);
|
|
await input.client.writeFile(
|
|
remoteWorkspaceTar,
|
|
toArrayBuffer(workspaceTarBytes),
|
|
workspaceUpload.options,
|
|
);
|
|
await workspaceUpload.finish(workspaceTarBytes.byteLength, workspaceTarBytes.byteLength);
|
|
const extractWorkspaceTarCommand = gitSnapshot
|
|
? `mkdir -p ${shellQuote(workspaceRemoteDir)} && ` +
|
|
`tar -xf ${shellQuote(remoteWorkspaceTar)} -C ${shellQuote(workspaceRemoteDir)} && ` +
|
|
`rm -f ${shellQuote(remoteWorkspaceTar)}`
|
|
: `mkdir -p ${shellQuote(workspaceRemoteDir)} && ` +
|
|
`find ${shellQuote(workspaceRemoteDir)} -mindepth 1 -maxdepth 1 ${preserveFindArgs([...preservedNames])} -exec rm -rf -- {} + && ` +
|
|
`tar -xf ${shellQuote(remoteWorkspaceTar)} -C ${shellQuote(workspaceRemoteDir)} && ` +
|
|
`rm -f ${shellQuote(remoteWorkspaceTar)}`;
|
|
await input.client.run(
|
|
`sh -c ${shellQuote(extractWorkspaceTarCommand)}`,
|
|
{ timeoutMs: input.spec.timeoutMs },
|
|
);
|
|
if (gitSnapshot) {
|
|
await removeDeletedPathsInSandbox({
|
|
client: input.client,
|
|
spec: input.spec,
|
|
remoteDir: workspaceRemoteDir,
|
|
deletedPaths: gitSnapshot.deletedPaths,
|
|
});
|
|
}
|
|
|
|
for (const asset of input.assets ?? []) {
|
|
await emitRuntimeStatus(input.onRuntimeProgress, "config_sync", "Syncing runtime assets to sandbox");
|
|
const assetTarPath = path.join(tempDir, `${asset.key}.tar`);
|
|
await createTarballFromDirectory({
|
|
localDir: asset.localDir,
|
|
archivePath: assetTarPath,
|
|
followSymlinks: asset.followSymlinks,
|
|
exclude: asset.exclude,
|
|
});
|
|
const assetTarBytes = await fs.readFile(assetTarPath);
|
|
const remoteAssetDir = path.posix.join(runtimeRootDir, asset.key);
|
|
const remoteAssetTar = path.posix.join(runtimeRootDir, `${asset.key}-upload.tar`);
|
|
const assetUpload = makeTransferProgress(
|
|
input.onProgress,
|
|
"Syncing",
|
|
"to",
|
|
asset.key,
|
|
{ sink: input.onRuntimeProgress, phase: "config_sync" },
|
|
);
|
|
await input.client.writeFile(remoteAssetTar, toArrayBuffer(assetTarBytes), assetUpload.options);
|
|
await assetUpload.finish(assetTarBytes.byteLength, assetTarBytes.byteLength);
|
|
await input.client.run(
|
|
`sh -c ${shellQuote(
|
|
`rm -rf ${shellQuote(remoteAssetDir)} && ` +
|
|
`mkdir -p ${shellQuote(remoteAssetDir)} && ` +
|
|
`tar -xf ${shellQuote(remoteAssetTar)} -C ${shellQuote(remoteAssetDir)} && ` +
|
|
`rm -f ${shellQuote(remoteAssetTar)}`,
|
|
)}`,
|
|
{ timeoutMs: input.spec.timeoutMs },
|
|
);
|
|
}
|
|
});
|
|
|
|
const assetDirs = Object.fromEntries(
|
|
(input.assets ?? []).map((asset) => [asset.key, path.posix.join(runtimeRootDir, asset.key)]),
|
|
);
|
|
|
|
return {
|
|
spec: input.spec,
|
|
workspaceLocalDir: input.workspaceLocalDir,
|
|
workspaceRemoteDir,
|
|
runtimeRootDir,
|
|
assetDirs,
|
|
restoreWorkspace: async (onProgress?: RuntimeProgressSink) => {
|
|
const restoreSink = onProgress ?? input.onProgress;
|
|
await withTempDir("paperclip-sandbox-restore-", async (tempDir) => {
|
|
let importedRef: string | null = null;
|
|
let importedHead: string | null = null;
|
|
let remoteWorkspaceStatus = "dirty";
|
|
try {
|
|
if (gitSnapshot) {
|
|
await emitRuntimeStatus(input.onRuntimeProgress, "export", "Exporting git changes from sandbox");
|
|
importedRef = createImportedGitRef("sandbox");
|
|
const remoteGitBundle = path.posix.join(runtimeRootDir, "git-delta.bundle");
|
|
const remoteWorkspaceStatusPath = path.posix.join(runtimeRootDir, "workspace-status.txt");
|
|
const exportRef = createRemoteGitExportRef("sandbox");
|
|
await input.client.run(
|
|
`sh -c ${shellQuote(buildRemoteGitDeltaBundleScript({
|
|
remoteDir: workspaceRemoteDir,
|
|
baseSha: gitSnapshot.headCommit,
|
|
exportRef,
|
|
bundlePath: remoteGitBundle,
|
|
statusPath: remoteWorkspaceStatusPath,
|
|
}))}`,
|
|
{ timeoutMs: input.spec.timeoutMs },
|
|
);
|
|
const gitExport = makeTransferProgress(
|
|
restoreSink,
|
|
"Exporting git history",
|
|
"from",
|
|
undefined,
|
|
{ sink: input.onRuntimeProgress, phase: "export" },
|
|
);
|
|
const bundleBytes = await input.client.readFile(remoteGitBundle, gitExport.options);
|
|
const bundleBuffer = toBuffer(bundleBytes);
|
|
await gitExport.finish(bundleBuffer.byteLength, bundleBuffer.byteLength);
|
|
await input.client.remove(remoteGitBundle).catch(() => undefined);
|
|
remoteWorkspaceStatus = await input.client.readFile(remoteWorkspaceStatusPath)
|
|
.then((bytes) => toBuffer(bytes).toString("utf8").trim())
|
|
.catch(() => "dirty");
|
|
remoteWorkspaceStatus = remoteWorkspaceStatus === "clean" ? "clean" : "dirty";
|
|
await input.client.remove(remoteWorkspaceStatusPath).catch(() => undefined);
|
|
const bundlePath = path.join(tempDir, "git-delta.bundle");
|
|
await fs.writeFile(bundlePath, bundleBuffer);
|
|
importedHead = await fetchGitBundleIntoLocalRef({
|
|
localDir: input.workspaceLocalDir,
|
|
bundlePath,
|
|
exportRef,
|
|
importedRef,
|
|
baseSha: gitSnapshot.headCommit,
|
|
});
|
|
}
|
|
|
|
const remoteWorkspaceTar = path.posix.join(runtimeRootDir, "workspace-download.tar");
|
|
await emitRuntimeStatus(input.onRuntimeProgress, "restore", "Restoring workspace from sandbox");
|
|
await input.client.run(
|
|
`sh -c ${shellQuote(createRemoteTarballFromDirectoryCommand({
|
|
remoteDir: workspaceRemoteDir,
|
|
archivePath: remoteWorkspaceTar,
|
|
exclude: restoreExclude,
|
|
}))}`,
|
|
{ timeoutMs: input.spec.timeoutMs },
|
|
);
|
|
const workspaceRestore = makeTransferProgress(
|
|
restoreSink,
|
|
"Restoring",
|
|
"from",
|
|
"workspace",
|
|
{ sink: input.onRuntimeProgress, phase: "restore" },
|
|
);
|
|
const archiveBytes = await input.client.readFile(remoteWorkspaceTar, workspaceRestore.options);
|
|
const archiveBuffer = toBuffer(archiveBytes);
|
|
await workspaceRestore.finish(archiveBuffer.byteLength, archiveBuffer.byteLength);
|
|
await input.client.remove(remoteWorkspaceTar).catch(() => undefined);
|
|
const localArchivePath = path.join(tempDir, "workspace.tar");
|
|
const extractedDir = path.join(tempDir, "workspace");
|
|
await fs.writeFile(localArchivePath, archiveBuffer);
|
|
await extractTarballToDirectory({
|
|
archivePath: localArchivePath,
|
|
localDir: extractedDir,
|
|
});
|
|
const gitHeadToIntegrate = importedHead;
|
|
await mergeDirectoryWithBaseline({
|
|
baseline: baselineSnapshot,
|
|
sourceDir: extractedDir,
|
|
targetDir: input.workspaceLocalDir,
|
|
beforeApply: gitHeadToIntegrate
|
|
? async () => {
|
|
await integrateImportedGitHead({
|
|
localDir: input.workspaceLocalDir,
|
|
importedHead: gitHeadToIntegrate,
|
|
});
|
|
}
|
|
: undefined,
|
|
afterApply: gitSnapshot
|
|
? async () => {
|
|
await resetLocalGitIndexToHead({
|
|
localDir: input.workspaceLocalDir,
|
|
checkWorkingTreeClean: remoteWorkspaceStatus === "clean",
|
|
});
|
|
}
|
|
: undefined,
|
|
});
|
|
} finally {
|
|
await emitRuntimeStatus(input.onRuntimeProgress, "finalize", "Finalizing sandbox workspace");
|
|
if (importedRef) {
|
|
await deleteLocalGitRef({ localDir: input.workspaceLocalDir, ref: importedRef });
|
|
}
|
|
}
|
|
});
|
|
},
|
|
};
|
|
}
|