mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-19 16:29:42 +01:00
> [!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>
104 lines
4.3 KiB
TypeScript
104 lines
4.3 KiB
TypeScript
import { EventEmitter } from "node:events";
|
|
import { execFile, spawn } from "node:child_process";
|
|
import { createWriteStream } from "node:fs";
|
|
import { PassThrough, Readable, Writable } from "node:stream";
|
|
import { afterEach, expect, it, vi } from "vitest";
|
|
import { restoreWorkspaceFromSshExecution } from "./ssh.js";
|
|
|
|
vi.mock("node:child_process", async (importOriginal) => ({
|
|
...await importOriginal<typeof import("node:child_process")>(),
|
|
spawn: vi.fn(),
|
|
execFile: vi.fn(),
|
|
}));
|
|
vi.mock("node:fs", async (importOriginal) => ({
|
|
...await importOriginal<typeof import("node:fs")>(),
|
|
createWriteStream: vi.fn(),
|
|
}));
|
|
|
|
afterEach(() => vi.resetAllMocks());
|
|
|
|
it.each(["stdout", "sink", "exit", "spawn"])("rejects an SSH export %s failure and releases the streams", async (failure) => {
|
|
const error = new Error("transfer failed");
|
|
const stdout = new PassThrough();
|
|
const stderr = new PassThrough();
|
|
const sink = new Writable({ write(_chunk, _encoding, callback) { callback(); } });
|
|
const child = Object.assign(new EventEmitter(), { stdout, stderr, kill: vi.fn() });
|
|
vi.mocked(createWriteStream).mockReturnValue(sink as ReturnType<typeof createWriteStream>);
|
|
vi.mocked(spawn).mockImplementation(() => {
|
|
setImmediate(() => {
|
|
if (failure === "stdout") stdout.destroy(error);
|
|
if (failure === "sink") sink.destroy(error);
|
|
if (failure === "spawn") child.emit("error", error);
|
|
if (failure === "exit") {
|
|
stderr.write(error.message);
|
|
stdout.end();
|
|
child.emit("close", 1);
|
|
}
|
|
});
|
|
return child as unknown as ReturnType<typeof spawn>;
|
|
});
|
|
vi.mocked(execFile).mockImplementation((...args: unknown[]) => {
|
|
const callback = args.at(-1) as (error: null, stdout: string, stderr: string) => void;
|
|
callback(null, "", "");
|
|
return {} as ReturnType<typeof execFile>;
|
|
});
|
|
await expect(restoreWorkspaceFromSshExecution({
|
|
spec: {
|
|
host: "fixture.invalid", username: "fixture", port: 22,
|
|
remoteCwd: "/remote", remoteWorkspacePath: "/remote",
|
|
privateKey: null, knownHosts: null, strictHostKeyChecking: true,
|
|
},
|
|
localDir: "/local",
|
|
baselineSnapshot: { entries: new Map(), exclude: [] },
|
|
restoreGitHistory: true,
|
|
onProgress: async () => {},
|
|
})).rejects.toThrow(error.message);
|
|
expect(stdout.destroyed).toBe(true);
|
|
expect(sink.destroyed).toBe(true);
|
|
expect(child.kill).toHaveBeenCalledWith("SIGTERM");
|
|
expect(vi.mocked(execFile).mock.calls.some((call) => (call[1] as string[]).includes("fetch"))).toBe(false);
|
|
});
|
|
|
|
it.each([false, true])("drains SSH export before fetching with progress=%s", async (withProgress) => {
|
|
const chunks = Array.from({ length: 16 }, (_, index) => Buffer.alloc(64 * 1024, index));
|
|
const received: Buffer[] = [];
|
|
let fetched: Buffer | undefined;
|
|
const sink = new Writable({
|
|
highWaterMark: 1024,
|
|
write(chunk, _encoding, callback) {
|
|
setTimeout(() => { received.push(Buffer.from(chunk)); callback(); }, 2);
|
|
},
|
|
});
|
|
vi.mocked(createWriteStream).mockReturnValue(sink as ReturnType<typeof createWriteStream>);
|
|
vi.mocked(spawn).mockImplementation(() => {
|
|
const child = Object.assign(new EventEmitter(), {
|
|
stdout: Readable.from(chunks), stderr: new PassThrough(), kill: vi.fn(),
|
|
});
|
|
child.stdout.on("end", () => child.emit("close", 0));
|
|
return child as unknown as ReturnType<typeof spawn>;
|
|
});
|
|
vi.mocked(execFile).mockImplementation((...args: unknown[]) => {
|
|
const argv = args[1] as string[];
|
|
const callback = args.at(-1) as (error: Error | null, stdout: string, stderr: string) => void;
|
|
if (argv.includes("fetch")) {
|
|
fetched = Buffer.concat(received);
|
|
callback(new Error("stop after fetch"), "", "");
|
|
} else {
|
|
callback(null, "", "");
|
|
}
|
|
return {} as ReturnType<typeof execFile>;
|
|
});
|
|
await expect(restoreWorkspaceFromSshExecution({
|
|
spec: {
|
|
host: "fixture.invalid", username: "fixture", port: 22,
|
|
remoteCwd: "/remote", remoteWorkspacePath: "/remote",
|
|
privateKey: null, knownHosts: null, strictHostKeyChecking: true,
|
|
},
|
|
localDir: "/local",
|
|
baselineSnapshot: { entries: new Map(), exclude: [] },
|
|
restoreGitHistory: true,
|
|
...(withProgress ? { onProgress: async () => {} } : {}),
|
|
})).rejects.toThrow("stop after fetch");
|
|
expect(fetched).toEqual(Buffer.concat(chunks));
|
|
});
|