Squashed 'third_party/pi/' content from commit d981de122
git-subtree-dir: third_party/pi git-subtree-split: d981de1229ef899957bbe968bc8dcda02a21f477
This commit is contained in:
210
packages/coding-agent/test/clipboard.test.ts
Normal file
210
packages/coding-agent/test/clipboard.test.ts
Normal file
@@ -0,0 +1,210 @@
|
||||
import { execFileSync, execSync, spawn } from "child_process";
|
||||
import { platform } from "os";
|
||||
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
|
||||
import { copyToClipboard, readClipboardText } from "../src/utils/clipboard.ts";
|
||||
|
||||
const mocks = vi.hoisted(() => {
|
||||
return {
|
||||
clipboard: {
|
||||
getText: vi.fn<() => Promise<string>>(),
|
||||
setText: vi.fn<(text: string) => Promise<void>>(),
|
||||
},
|
||||
execFileSync: vi.fn(),
|
||||
execSync: vi.fn(),
|
||||
spawn: vi.fn(),
|
||||
platform: vi.fn<() => NodeJS.Platform>(),
|
||||
isWaylandSession: vi.fn<() => boolean>(),
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("../src/utils/clipboard-native.js", () => {
|
||||
return {
|
||||
clipboard: mocks.clipboard,
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("child_process", () => {
|
||||
return {
|
||||
execFileSync: mocks.execFileSync,
|
||||
execSync: mocks.execSync,
|
||||
spawn: mocks.spawn,
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("os", () => {
|
||||
return {
|
||||
platform: mocks.platform,
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("../src/utils/clipboard-image.js", () => {
|
||||
return {
|
||||
isWaylandSession: mocks.isWaylandSession,
|
||||
};
|
||||
});
|
||||
|
||||
const mockedExecFileSync = vi.mocked(execFileSync);
|
||||
const mockedExecSync = vi.mocked(execSync);
|
||||
const mockedSpawn = vi.mocked(spawn);
|
||||
const mockedPlatform = vi.mocked(platform);
|
||||
|
||||
let originalWrite: typeof process.stdout.write;
|
||||
let stdoutWrites: string[];
|
||||
let nativeResolved = false;
|
||||
|
||||
function osc52Writes(): string[] {
|
||||
return stdoutWrites.filter((write) => write.startsWith("\x1b]52;c;"));
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
vi.stubEnv("SSH_CONNECTION", "");
|
||||
vi.stubEnv("SSH_CLIENT", "");
|
||||
vi.stubEnv("MOSH_CONNECTION", "");
|
||||
stdoutWrites = [];
|
||||
nativeResolved = false;
|
||||
mocks.clipboard.getText.mockReset();
|
||||
mocks.clipboard.setText.mockReset();
|
||||
mocks.execFileSync.mockReset();
|
||||
mocks.execSync.mockReset();
|
||||
mocks.spawn.mockReset();
|
||||
mocks.platform.mockReset();
|
||||
mocks.isWaylandSession.mockReset();
|
||||
mockedPlatform.mockReturnValue("darwin");
|
||||
mocks.isWaylandSession.mockReturnValue(false);
|
||||
mocks.clipboard.getText.mockResolvedValue("");
|
||||
mocks.clipboard.setText.mockImplementation(async () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 1));
|
||||
nativeResolved = true;
|
||||
});
|
||||
originalWrite = process.stdout.write.bind(process.stdout);
|
||||
process.stdout.write = ((...args: Parameters<typeof process.stdout.write>) => {
|
||||
const [chunk] = args;
|
||||
if (typeof chunk === "string" && chunk.startsWith("\x1b]52;c;")) {
|
||||
stdoutWrites.push(chunk);
|
||||
return true;
|
||||
}
|
||||
return originalWrite(...args);
|
||||
}) as typeof process.stdout.write;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
process.stdout.write = originalWrite;
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
describe("readClipboardText", () => {
|
||||
test("returns native clipboard text", async () => {
|
||||
mocks.clipboard.getText.mockResolvedValue("clipboard text");
|
||||
|
||||
await expect(readClipboardText()).resolves.toBe("clipboard text");
|
||||
});
|
||||
|
||||
test("reads the Wayland clipboard before the stale native X11 clipboard", async () => {
|
||||
// Regression test for #7248.
|
||||
mockedPlatform.mockReturnValue("linux");
|
||||
mocks.isWaylandSession.mockReturnValue(true);
|
||||
vi.stubEnv("WAYLAND_DISPLAY", "wayland-0");
|
||||
mockedExecFileSync.mockReturnValue("Wayland text");
|
||||
mocks.clipboard.getText.mockResolvedValue("stale X11 text");
|
||||
|
||||
await expect(readClipboardText()).resolves.toBe("Wayland text");
|
||||
expect(mockedExecFileSync).toHaveBeenCalledWith("wl-paste", ["--no-newline", "--type", "text"], {
|
||||
encoding: "utf8",
|
||||
maxBuffer: 50 * 1024 * 1024,
|
||||
timeout: 5000,
|
||||
});
|
||||
expect(mocks.clipboard.getText).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test("does not fall back to stale X11 text when the Wayland clipboard is empty", async () => {
|
||||
mockedPlatform.mockReturnValue("linux");
|
||||
mocks.isWaylandSession.mockReturnValue(true);
|
||||
vi.stubEnv("WAYLAND_DISPLAY", "wayland-0");
|
||||
mockedExecFileSync.mockReturnValue("");
|
||||
mocks.clipboard.getText.mockResolvedValue("stale X11 text");
|
||||
|
||||
await expect(readClipboardText()).resolves.toBeNull();
|
||||
expect(mocks.clipboard.getText).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test("falls back to the native clipboard when wl-paste is unavailable", async () => {
|
||||
mockedPlatform.mockReturnValue("linux");
|
||||
mocks.isWaylandSession.mockReturnValue(true);
|
||||
vi.stubEnv("WAYLAND_DISPLAY", "wayland-0");
|
||||
mockedExecFileSync.mockImplementation(() => {
|
||||
throw new Error("wl-paste unavailable");
|
||||
});
|
||||
mocks.clipboard.getText.mockResolvedValue("X11 fallback text");
|
||||
|
||||
await expect(readClipboardText()).resolves.toBe("X11 fallback text");
|
||||
});
|
||||
|
||||
test("returns null for empty or unavailable clipboard text", async () => {
|
||||
await expect(readClipboardText()).resolves.toBeNull();
|
||||
|
||||
mocks.clipboard.getText.mockRejectedValue(new Error("clipboard unavailable"));
|
||||
await expect(readClipboardText()).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe("copyToClipboard", () => {
|
||||
test("local native success skips OSC 52 and shell fallbacks", async () => {
|
||||
await copyToClipboard("hello");
|
||||
|
||||
expect(mocks.clipboard.setText).toHaveBeenCalledWith("hello");
|
||||
expect(osc52Writes()).toHaveLength(0);
|
||||
expect(mockedExecSync).not.toHaveBeenCalled();
|
||||
expect(mockedSpawn).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test("remote native success emits OSC 52 after native write", async () => {
|
||||
vi.stubEnv("SSH_CONNECTION", "client server");
|
||||
mocks.clipboard.setText.mockImplementation(async () => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 1));
|
||||
expect(osc52Writes()).toHaveLength(0);
|
||||
nativeResolved = true;
|
||||
});
|
||||
|
||||
await copyToClipboard("hello");
|
||||
|
||||
expect(nativeResolved).toBe(true);
|
||||
expect(osc52Writes()).toHaveLength(1);
|
||||
expect(mockedExecSync).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test("local shell fallback success skips OSC 52", async () => {
|
||||
mocks.clipboard.setText.mockRejectedValue(new Error("native failed"));
|
||||
mockedExecSync.mockReturnValue(Buffer.alloc(0));
|
||||
|
||||
await copyToClipboard("hello");
|
||||
|
||||
expect(mockedExecSync).toHaveBeenCalledWith("pbcopy", {
|
||||
input: "hello",
|
||||
stdio: ["pipe", "ignore", "ignore"],
|
||||
timeout: 5000,
|
||||
});
|
||||
expect(osc52Writes()).toHaveLength(0);
|
||||
});
|
||||
|
||||
test("uses OSC 52 fallback when native and shell tools fail", async () => {
|
||||
mocks.clipboard.setText.mockRejectedValue(new Error("native failed"));
|
||||
mockedExecSync.mockImplementation(() => {
|
||||
throw new Error("pbcopy failed");
|
||||
});
|
||||
|
||||
await copyToClipboard("hello");
|
||||
|
||||
expect(osc52Writes()).toHaveLength(1);
|
||||
});
|
||||
|
||||
test("does not emit oversized OSC 52 payloads", async () => {
|
||||
mocks.clipboard.setText.mockRejectedValue(new Error("native failed"));
|
||||
mockedExecSync.mockImplementation(() => {
|
||||
throw new Error("pbcopy failed");
|
||||
});
|
||||
|
||||
await expect(copyToClipboard("x".repeat(80_000))).rejects.toThrow("Failed to copy to clipboard");
|
||||
expect(osc52Writes()).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user