import { execFile } from "node:child_process"; import { randomUUID } from "node:crypto"; import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; import { promisify } from "node:util"; import { afterEach, describe, expect, it } from "vitest"; import type { PluginExecutionWorkspaceMetadata } from "@paperclipai/plugin-sdk"; import type { WorkspaceDiffQueryOptions } from "../src/contracts.js"; import { WORKSPACE_DIFF_CAPS, workspaceDiffService } from "../src/workspace-diff.js"; const execFileAsync = promisify(execFile); const tempDirs = new Set(); async function runGit(cwd: string, args: string[]) { await execFileAsync("git", ["-C", cwd, ...args], { cwd }); } async function createTempRepo() { const repoRoot = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-plugin-workspace-diff-")); tempDirs.add(repoRoot); await runGit(repoRoot, ["init"]); await runGit(repoRoot, ["config", "user.name", "Paperclip Test"]); await runGit(repoRoot, ["config", "user.email", "test@paperclip.local"]); await fs.writeFile(path.join(repoRoot, "tracked-staged.txt"), "alpha\n", "utf8"); await fs.writeFile(path.join(repoRoot, "tracked-unstaged.txt"), "bravo\n", "utf8"); await fs.writeFile(path.join(repoRoot, "delete-me.txt"), "charlie\n", "utf8"); await fs.writeFile(path.join(repoRoot, "rename-me.txt"), "delta\n", "utf8"); await fs.writeFile(path.join(repoRoot, "binary.bin"), Buffer.from([0, 1, 2, 3])); await runGit(repoRoot, ["add", "."]); await runGit(repoRoot, ["commit", "-m", "Initial commit"]); await runGit(repoRoot, ["branch", "-M", "main"]); return repoRoot; } function createWorkspace(cwd: string | null, overrides: Partial = {}): PluginExecutionWorkspaceMetadata { return { id: randomUUID(), companyId: randomUUID(), projectId: randomUUID(), projectWorkspaceId: null, path: cwd, cwd, repoUrl: null, baseRef: null, branchName: "feature", providerType: "git_worktree", providerMetadata: null, ...overrides, }; } function workingTreeQuery(overrides: Partial = {}): WorkspaceDiffQueryOptions { return { view: "working-tree", baseRef: null, includeUntracked: true, paths: [], ...overrides, }; } afterEach(async () => { for (const dir of tempDirs) { await fs.rm(dir, { recursive: true, force: true }); } tempDirs.clear(); }); describe("plugin workspace diff service", () => { it("returns staged, unstaged, renamed, deleted, untracked, binary, and oversized working-tree changes", async () => { const repoRoot = await createTempRepo(); await fs.writeFile(path.join(repoRoot, "tracked-staged.txt"), "alpha\nstaged\n", "utf8"); await runGit(repoRoot, ["add", "tracked-staged.txt"]); await fs.writeFile(path.join(repoRoot, "tracked-unstaged.txt"), "bravo\nunstaged\n", "utf8"); await runGit(repoRoot, ["mv", "rename-me.txt", "renamed.txt"]); await fs.rm(path.join(repoRoot, "delete-me.txt")); await fs.writeFile(path.join(repoRoot, "binary.bin"), Buffer.from([0, 1, 2, 3, 4, 5])); await fs.writeFile(path.join(repoRoot, "untracked.txt"), "brand new\n", "utf8"); await fs.writeFile(path.join(repoRoot, "empty-untracked.txt"), "", "utf8"); await fs.writeFile(path.join(repoRoot, "oversized.txt"), "x".repeat(WORKSPACE_DIFF_CAPS.maxFileBytes + 1), "utf8"); const diff = await workspaceDiffService().getDiff(createWorkspace(repoRoot), workingTreeQuery()); const byPath = new Map(diff.files.map((file) => [file.path, file])); expect(diff.view).toBe("working-tree"); expect(byPath.get("tracked-staged.txt")).toMatchObject({ staged: true, unstaged: false, status: "modified", additions: 1 }); expect(byPath.get("tracked-staged.txt")?.patches.map((patch) => patch.kind)).toEqual(["staged"]); expect(byPath.get("tracked-unstaged.txt")).toMatchObject({ staged: false, unstaged: true, status: "modified", additions: 1 }); expect(byPath.get("renamed.txt")).toMatchObject({ oldPath: "rename-me.txt", staged: true, status: "renamed" }); expect(byPath.get("delete-me.txt")).toMatchObject({ unstaged: true, status: "deleted", deletions: 1 }); expect(byPath.get("untracked.txt")).toMatchObject({ untracked: true, status: "untracked", additions: 1 }); expect(byPath.get("untracked.txt")?.patches[0]?.patch).toContain("+brand new"); expect(byPath.get("empty-untracked.txt")?.patches[0]?.patch).toBe([ "diff --git a/empty-untracked.txt b/empty-untracked.txt", "new file mode 100644", "--- /dev/null", "+++ b/empty-untracked.txt", "", ].join("\n")); expect(byPath.get("binary.bin")).toMatchObject({ binary: true, unstaged: true }); expect(byPath.get("oversized.txt")).toMatchObject({ oversized: true, untracked: true }); expect(diff.warnings.map((item) => item.code)).toEqual(expect.arrayContaining(["binary_file", "file_oversized"])); }, 20_000); it("returns head diffs against the requested base ref", async () => { const repoRoot = await createTempRepo(); await runGit(repoRoot, ["checkout", "-b", "feature"]); await fs.writeFile(path.join(repoRoot, "tracked-staged.txt"), "alpha\ncommitted\n", "utf8"); await runGit(repoRoot, ["add", "tracked-staged.txt"]); await runGit(repoRoot, ["commit", "-m", "Feature change"]); const diff = await workspaceDiffService().getDiff( createWorkspace(repoRoot, { baseRef: "main" }), workingTreeQuery({ view: "head", includeUntracked: false }), ); expect(diff.baseRef).toBe("main"); expect(diff.files).toHaveLength(1); expect(diff.files[0]).toMatchObject({ path: "tracked-staged.txt", staged: false, unstaged: false, untracked: false, additions: 1, deletions: 0, }); expect(diff.files[0]?.patches.map((patch) => patch.kind)).toEqual(["head"]); }, 20_000); it("filters changed files by relative workspace paths", async () => { const repoRoot = await createTempRepo(); await fs.writeFile(path.join(repoRoot, "tracked-staged.txt"), "alpha\none\n", "utf8"); await fs.writeFile(path.join(repoRoot, "tracked-unstaged.txt"), "bravo\ntwo\n", "utf8"); const diff = await workspaceDiffService().getDiff( createWorkspace(repoRoot), workingTreeQuery({ paths: ["tracked-staged.txt"] }), ); expect(diff.paths).toEqual(["tracked-staged.txt"]); expect(diff.files.map((file) => file.path)).toEqual(["tracked-staged.txt"]); }, 20_000); it("applies output caps to large workspace responses", async () => { const repoRoot = await createTempRepo(); for (let index = 0; index < WORKSPACE_DIFF_CAPS.maxFiles + 1; index += 1) { await fs.writeFile(path.join(repoRoot, `untracked-${String(index).padStart(3, "0")}.txt`), "", "utf8"); } const diff = await workspaceDiffService().getDiff(createWorkspace(repoRoot), workingTreeQuery()); expect(diff.files).toHaveLength(WORKSPACE_DIFF_CAPS.maxFiles); expect(diff.truncated).toBe(true); expect(diff.warnings).toContainEqual(expect.objectContaining({ code: "file_count_truncated" })); }, 20_000); it("does not follow untracked symlinks outside the repo", async () => { const repoRoot = await createTempRepo(); const outsideDir = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-plugin-workspace-diff-secret-")); tempDirs.add(outsideDir); const secretContent = "external secret should not appear\n"; const secretPath = path.join(outsideDir, "secret.txt"); await fs.writeFile(secretPath, secretContent, "utf8"); await fs.symlink(secretPath, path.join(repoRoot, "leak.txt")); const diff = await workspaceDiffService().getDiff(createWorkspace(repoRoot), workingTreeQuery()); const leak = diff.files.find((file) => file.path === "leak.txt"); const serialized = JSON.stringify(diff); expect(leak).toMatchObject({ untracked: true, status: "untracked", additions: 0, sizeBytes: null }); expect(leak?.patches[0]).toMatchObject({ kind: "untracked", patch: null, warnings: [expect.objectContaining({ code: "symlink_target_outside_workspace" })], }); expect(diff.warnings).toContainEqual(expect.objectContaining({ code: "symlink_target_outside_workspace", path: "leak.txt", })); expect(serialized).not.toContain(secretContent.trim()); }, 20_000); it("surfaces missing cwd, non-git, invalid base refs, and unsafe path filters as plugin errors", async () => { const svc = workspaceDiffService(); await expect(svc.getDiff(createWorkspace(null), workingTreeQuery())) .rejects.toMatchObject({ status: 422, details: { code: "missing_cwd" } }); const nonGitDir = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-plugin-workspace-diff-non-git-")); tempDirs.add(nonGitDir); await expect(svc.getDiff(createWorkspace(nonGitDir), workingTreeQuery())) .rejects.toMatchObject({ status: 422, details: { code: "non_git_workspace" } }); const repoRoot = await createTempRepo(); await expect(svc.getDiff(createWorkspace(repoRoot), workingTreeQuery({ paths: ["../secret"] }))) .rejects.toMatchObject({ status: 422, details: { code: "path_filter_invalid" } }); await expect(svc.getDiff(createWorkspace(repoRoot), workingTreeQuery({ view: "head", baseRef: "missing-ref" }))) .rejects.toMatchObject({ status: 422, details: { code: "base_ref_invalid" } }); }, 20_000); });