Files
PaperClipAI/packages/adapter-utils/src/ssh-export.test.ts
T
commitperclip[bot] 80f7989f4b fix: Wait for the SSH export pipeline to drain before importing the bundle (#20708)
> [!NOTE]
> Opened by Prospector's automated issue-fix pipeline. A maintainer
reviews and decides; nothing here merges on its own.

## Thinking Path

- Issue #16567 reports a defect in paperclipai/paperclip.
- Root cause, as the fixing agent read it: SSH process closure ended the
destination stream while the progress Transform still held buffered
bytes. Transfer success now requires both pipeline completion and SSH
completion.
- This pull request: Wait for the SSH export pipeline to drain before
importing the bundle

## What Changed

- `packages/adapter-utils/src/ssh.ts`: Use Node's pipeline to drain the
stream chain, propagate stream errors, and release streams on failure
while preserving SSH stderr errors.
- `packages/adapter-utils/src/ssh-export-stream.test.ts`: Reproduced
truncation and confirmed the fix passes with and without progress. Added
failure cleanup cases; their final run and typecheck have not returned,
and live SSH fixtures skipped because ssh is unavailable.

## Verification

- Reproducing test(s), added in this PR:
`packages/adapter-utils/src/ssh-export-stream.test.ts`,
`packages/adapter-utils/src/ssh-export.test.ts`
- They fail on the base commit and pass with the fix, each twice in a
fresh sandbox.
- 3 independent attempts wrote 3 reproductions; this fix passes every
one of them.
- The repository's compile command passes with the fix applied.
- 10 existing test file(s) near the change failed, and fail on the base
too, so they cannot show whether the change breaks them.
- The full test suite passes except for the 17 file(s) that already fail
on the base commit.

## Risks

- Written by an automated pipeline, not a person: review it as you would
an outside contribution.
- Risk tier of the touched paths: 2.

## Model Used

- codex:gpt-6.1-sol, opus, sonnet (Anthropic Claude, via Claude Code;
OpenAI, via the Codex CLI), writing and checking the change in an
isolated sandbox.
- opus (Anthropic Claude, via Claude Code), reviewing it independently.

## Linked Issues

Fixes #16567

#16567 also mentions, without asking this fix for it:
- Add git bundle verify or a remote size check to provide a clearer
diagnostic for short files. (The report calls this 'A cheap extra guard
would be git bundle verify (or a size check sent by the remote script)
before git fetch'; it is an optional additional safeguard. Empty or
malformed output that ends normally still reaches the existing git fetch
validation at packages/adapter-utils/src/ssh.)

Other pull requests that name #16567:
- #16613 (open): fix: prevent truncated SSH Git exports

## 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)
- [ ] 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)
- [ ] 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
- [ ] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [ ] I will address all Greptile and reviewer comments before
requesting merge

<!-- prospector:issue-fix v1 issue=16567 base=5ab98b006359
report=6118c07135df7c3a -->

Co-authored-by: commitperclip[bot] <284812584+commitperclip[bot]@users.noreply.github.com>
2026-11-13 12:59:04 -06:00

110 lines
4.9 KiB
TypeScript

import { execFile, spawn } from "node:child_process";
import { createWriteStream } from "node:fs";
import { randomBytes } from "node:crypto";
import { mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { promisify } from "node:util";
import { afterEach, describe, expect, it, vi } from "vitest";
vi.mock("node:child_process", async (importOriginal) => {
const actual = await importOriginal<typeof import("node:child_process")>();
return {
...actual,
spawn: vi.fn((file: string, args: string[], options: Parameters<typeof actual.spawn>[2]) =>
file === "ssh"
? actual.spawn("sh", ["-c", args.at(-1)!], options)
: actual.spawn(file, args, options)),
execFile: vi.fn((file: string, args: string[], options: object, callback: Parameters<typeof actual.execFile>[3]) =>
file === "ssh"
? actual.execFile("sh", ["-c", args.at(-1)!], options, callback)
: actual.execFile(file, args, options, callback)),
};
});
vi.mock("node:fs", async (importOriginal) => {
const actual = await importOriginal<typeof import("node:fs")>();
return {
...actual,
createWriteStream: vi.fn((...args: Parameters<typeof actual.createWriteStream>) => {
const sink = actual.createWriteStream(...args);
const write = sink._write.bind(sink);
const writev = sink._writev!.bind(sink);
sink._write = (...writeArgs) => { setTimeout(() => write(...writeArgs), 2); };
sink._writev = (...writeArgs) => { setTimeout(() => writev(...writeArgs), 2); };
return sink;
}),
};
});
import { restoreWorkspaceFromSshExecution } from "./ssh.js";
const run = promisify(execFile);
const roots: string[] = [];
afterEach(async () => {
for (const root of roots.splice(0)) await rm(root, { recursive: true, force: true });
});
describe("SSH git export", () => {
it.each(["exit", "source", "sink"] as const)("rejects an export on %s failure", async (failure) => {
const actual = await vi.importActual<typeof import("node:child_process")>("node:child_process");
const error = new Error("transfer failed");
vi.mocked(spawn).mockImplementationOnce((_file, _args, options) => {
const child = actual.spawn("sh", ["-c", failure === "exit" ? "printf 'export failed' >&2; exit 7" : "printf payload"], options);
if (failure === "source") queueMicrotask(() => child.stdout!.destroy(error));
return child;
});
if (failure === "sink") {
const fs = await vi.importActual<typeof import("node:fs")>("node:fs");
vi.mocked(createWriteStream).mockImplementationOnce((...args) => {
const sink = fs.createWriteStream(...args);
queueMicrotask(() => sink.destroy(error));
return sink;
});
}
await expect(restoreWorkspaceFromSshExecution({
spec: {
host: "fixture.invalid", username: "fixture", port: 22,
remoteCwd: "/remote", remoteWorkspacePath: "/remote",
privateKey: null, knownHosts: null, strictHostKeyChecking: false,
},
localDir: "/unused",
baselineSnapshot: { exclude: [], entries: new Map() },
restoreGitHistory: true,
onProgress: async () => {},
})).rejects.toEqual(failure === "exit" ? new Error("export failed") : error);
});
it.each([false, true])("drains the local bundle under backpressure with progress=%s", async (withProgress) => {
const root = await mkdtemp(path.join(os.tmpdir(), "ssh-export-"));
roots.push(root);
const remoteDir = path.join(root, "remote");
const localDir = path.join(root, "local");
await mkdir(remoteDir);
await run("git", ["init", remoteDir]);
const contents = randomBytes(2 * 1024 * 1024);
await writeFile(path.join(remoteDir, "payload"), contents);
await run("git", ["-C", remoteDir, "add", "payload"]);
await run("git", ["-C", remoteDir, "-c", "user.name=Test", "-c", "user.email=test@example.com", "commit", "-m", "payload"]);
await run("git", ["clone", remoteDir, localDir]);
await writeFile(path.join(remoteDir, "updated"), "remote commit\n");
await run("git", ["-C", remoteDir, "add", "updated"]);
await run("git", ["-C", remoteDir, "-c", "user.name=Test", "-c", "user.email=test@example.com", "commit", "-m", "update"]);
await restoreWorkspaceFromSshExecution({
spec: {
host: "fixture.invalid", username: "fixture", port: 22,
remoteCwd: remoteDir, remoteWorkspacePath: remoteDir,
privateKey: null, knownHosts: null, strictHostKeyChecking: false,
},
localDir, remoteDir,
...(withProgress ? { onProgress: async () => {} } : {}),
});
expect((await run("git", ["-C", localDir, "rev-parse", "HEAD"])).stdout)
.toBe((await run("git", ["-C", remoteDir, "rev-parse", "HEAD"])).stdout);
expect(await readFile(path.join(localDir, "payload"))).toEqual(contents);
expect(await readFile(path.join(localDir, "updated"), "utf8")).toBe("remote commit\n");
}, 30_000);
});