468edd8b22
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent work is issue-centered, and reviewers often need to inspect files, artifacts, and path references produced during that work. > - Before this branch, workspace-relative paths and artifact file references were not first-class inspectable objects in the board UI. > - Safe file viewing needs shared resource contracts, server-side workspace boundary checks, and UI that opens files without exposing arbitrary host paths. > - The workspace file viewer branch needed to stay as one active PR and be rebased onto current `paperclipai/paperclip:master` for review. > - This pull request adds the workspace file resource API, issue-page file viewer and browser, markdown file-reference links, and artifact file chips. > - The benefit is that board users can inspect relevant files from issue context while preserving workspace boundaries and auditability. ## Linked Issues or Issue Description No public GitHub issue exists for this branch. Internal Paperclip issues: `PAP-1953`, `PAP-10539`, `PAP-10733`. Problem / motivation: - Board users need to open workspace-relative files mentioned by agents or attached as work-product metadata without switching to a terminal. - The UI needs to support both direct file-path opening and workspace browsing/searching from an issue page. - The server must enforce company access, workspace boundaries, size limits, rate limits, and safe audit logging. Related PR: - Prior closed attempt: #4442 - Single active PR for this branch: #7681 ## What Changed - Added shared workspace file resource types, validators, and workspace-file `resourceRef` metadata validation for work products. - Added server routes/services for resolving, listing, and previewing workspace-relative files with access checks, scan caps, list-specific limits, and audit logging. - Added the issue file viewer provider, sheet, workspace browser, command-palette action, markdown workspace-file autolinks, and artifact file chips. - Updated issue workspace UI and stories/tests for file browsing and workspace file opening. - Rebased the branch onto current `paperclipai/paperclip:master` and updated the existing single PR branch. - Addressed current-head Greptile follow-ups by applying `offset` consistently across search/recent/changed file listings, restoring stopped-service port ownership checks before auto-port reuse, and stabilizing the workspace browser pagination test. ## Verification Current local verification after rebase to `public/master`: - `pnpm exec vitest run packages/shared/src/work-product.test.ts server/src/__tests__/file-resources.test.ts server/src/__tests__/instance-settings-routes.test.ts server/src/__tests__/instance-settings-service.test.ts server/src/__tests__/workspace-runtime.test.ts ui/src/components/FileViewerSheet.test.tsx ui/src/components/FileViewerSheet.copy.test.tsx ui/src/components/WorkspaceFileBrowser.test.tsx ui/src/components/WorkspaceFileMarkdownBody.test.tsx ui/src/context/FileViewerContext.test.ts ui/src/lib/remark-workspace-file-refs.test.ts ui/src/lib/workspace-file-parser.test.ts ui/src/components/IssueWorkspaceCard.test.tsx` - 13 files passed, 197 tests passed. - `pnpm -r --filter @paperclipai/shared --filter @paperclipai/server --filter @paperclipai/ui typecheck` - passed. - `pnpm exec vitest run ui/src/components/WorkspaceFileBrowser.test.tsx` - 1 file passed, 25 tests passed. - `pnpm exec vitest run server/src/__tests__/file-resources.test.ts server/src/__tests__/workspace-runtime.test.ts` - 2 files passed, 90 tests passed. - `pnpm -r --filter @paperclipai/server typecheck` - passed. - Confirmed branch is `0` behind and `46` ahead of current `public/master` after rebase and follow-up commits. - Confirmed the PR diff does not include `pnpm-lock.yaml`. - Confirmed the PR diff does not include `.github/workflows` changes. - Searched GitHub for duplicate or related workspace file viewer PRs/issues; #4442 is the prior closed attempt and this PR is the single active PR for the branch. - No screenshots were committed; the task explicitly asked not to add design screenshots or images unless they were part of the work. Current remote verification on head `a698a7bc10137baf7d25bd5722e1d6e0343387c1`: - Greptile Review - success, 64 files reviewed, 0 comments added, no unresolved Greptile review threads. - PR workflow `verify` - success. - Typecheck + Release Registry, General tests, workspace test shards, serialized server suites, Build, Canary Dry Run, e2e, Socket, and Snyk - success. - `security-review` - neutral, with output saying a draft advisory was filed for maintainer review and is not a merge block. - `commitperclip PR Review / review` - cancelled after the security gate detected flags and timed out while creating/reviewing the advisory. I reran it once and it cancelled the same way; no actionable code/test failure was exposed in the job logs. ## Risks - This is a broad UI/server feature PR, so review needs to pay attention to route authorization, workspace boundary handling, and markdown autolink false positives. - Workspace browsing intentionally caps list results and scan depth; very large workspaces may require users to refine search terms. - Remote workspace preview remains unavailable until remote file-access support is implemented. - The neutral commitperclip security-review advisory needs maintainer review, but the check output says it is not a merge block. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected - check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, GPT-5 coding agent in a Paperclip/Codex local tool-use environment, medium reasoning, with shell/GitHub CLI tool use for branch inspection, verification, rebase, PR update, Greptile review, and CI inspection. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] 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> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
209 lines
6.8 KiB
TypeScript
209 lines
6.8 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import type { ResolvedWorkspaceResource, WorkspaceFileContent } from "@paperclipai/shared";
|
|
import { FileViewerSheet } from "./FileViewerSheet";
|
|
|
|
const useQueryMock = vi.fn();
|
|
const viewerMock = {
|
|
state: null,
|
|
browse: false,
|
|
query: null,
|
|
folderPath: null,
|
|
browseProjectId: null,
|
|
browseWorkspaceId: null,
|
|
open: vi.fn(),
|
|
updateBrowseState: vi.fn(),
|
|
close: vi.fn(),
|
|
backToFiles: vi.fn(),
|
|
};
|
|
|
|
vi.mock("@tanstack/react-query", async () => {
|
|
const actual = await vi.importActual<typeof import("@tanstack/react-query")>("@tanstack/react-query");
|
|
return {
|
|
...actual,
|
|
useQuery: (options: unknown) => useQueryMock(options),
|
|
};
|
|
});
|
|
|
|
vi.mock("@/context/FileViewerContext", () => ({
|
|
useRequiredFileViewer: () => viewerMock,
|
|
}));
|
|
|
|
vi.mock("@/components/WorkspaceFileBrowser", () => ({
|
|
WorkspaceFileBrowser: () => null,
|
|
}));
|
|
|
|
vi.mock("@/components/WorkspaceFileMarkdownBody", () => ({
|
|
WorkspaceFileMarkdownBody: ({ children }: { children: string }) => (
|
|
<div data-testid="mock-rendered-markdown">Rendered Markdown: {children}</div>
|
|
),
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function ok<T>(data: T) {
|
|
return { data, isFetching: false, isError: false, error: null, refetch: vi.fn(async () => ({ data })) };
|
|
}
|
|
|
|
const resolvedResource: ResolvedWorkspaceResource = {
|
|
kind: "file",
|
|
provider: "git_worktree",
|
|
title: "tweet.md",
|
|
displayPath: "videos/90-days-paperclip/tweet.md",
|
|
workspaceLabel: "Isolated workspace",
|
|
workspaceKind: "execution_workspace",
|
|
workspaceId: "ws-1",
|
|
contentType: "text/markdown; charset=utf-8",
|
|
byteSize: 42,
|
|
previewKind: "text",
|
|
capabilities: { preview: true, download: false, listChildren: false },
|
|
};
|
|
|
|
const content: WorkspaceFileContent = {
|
|
resource: resolvedResource,
|
|
content: {
|
|
encoding: "utf8",
|
|
data: "hello from the file",
|
|
},
|
|
};
|
|
|
|
describe("FileViewerSheet copy actions", () => {
|
|
let container: HTMLDivElement;
|
|
let root: Root;
|
|
let writeText: ReturnType<typeof vi.fn>;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
useQueryMock.mockImplementation((options: { queryKey?: readonly unknown[] }) => {
|
|
const key = JSON.stringify(options.queryKey ?? []);
|
|
if (key.includes('"content"')) return ok(content);
|
|
return ok(resolvedResource);
|
|
});
|
|
writeText = vi.fn(async () => undefined);
|
|
Object.defineProperty(navigator, "clipboard", {
|
|
configurable: true,
|
|
value: { writeText },
|
|
});
|
|
Object.defineProperty(window, "isSecureContext", {
|
|
configurable: true,
|
|
value: true,
|
|
});
|
|
window.history.pushState({}, "", "/PAP/issues/PAP-10629?file=videos%2F90-days-paperclip%2Ftweet.md");
|
|
});
|
|
|
|
afterEach(() => {
|
|
flushSync(() => root.unmount());
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
function renderSheet() {
|
|
flushSync(() => {
|
|
root.render(
|
|
<FileViewerSheet
|
|
issueId="issue-1"
|
|
state={{
|
|
path: "videos/90-days-paperclip/tweet.md",
|
|
workspace: "auto",
|
|
line: null,
|
|
column: null,
|
|
projectId: null,
|
|
workspaceId: null,
|
|
}}
|
|
open
|
|
/>,
|
|
);
|
|
});
|
|
}
|
|
|
|
async function click(label: string) {
|
|
const button = document.body.querySelector(`button[aria-label="${label}"]`) as HTMLButtonElement | null;
|
|
expect(button).not.toBeNull();
|
|
flushSync(() => {
|
|
button!.dispatchEvent(new MouseEvent("click", { bubbles: true, cancelable: true }));
|
|
});
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
}
|
|
|
|
it("copies file contents and shows confirmation", async () => {
|
|
renderSheet();
|
|
|
|
await click("Copy file contents");
|
|
|
|
expect(writeText).toHaveBeenCalledWith("hello from the file");
|
|
expect(document.body.textContent).toContain("Copied contents");
|
|
});
|
|
|
|
it("copies the current file view link and shows confirmation", async () => {
|
|
renderSheet();
|
|
|
|
await click("Copy link to this file view");
|
|
|
|
expect(writeText).toHaveBeenCalledWith(window.location.href);
|
|
expect(document.body.textContent).toContain("Copied link");
|
|
});
|
|
|
|
it("renders a keyboard-addressable file tree resize separator", () => {
|
|
renderSheet();
|
|
const separator = document.body.querySelector('[role="separator"][aria-label="Resize file tree"]');
|
|
expect(separator).not.toBeNull();
|
|
expect(separator?.getAttribute("aria-valuenow")).toBe("288");
|
|
});
|
|
|
|
it("keeps split panes unframed so file selection does not shift the browser", () => {
|
|
renderSheet();
|
|
const separator = document.body.querySelector('[role="separator"][aria-label="Resize file tree"]');
|
|
const browserPane = separator?.previousElementSibling;
|
|
const previewPane = separator?.nextElementSibling;
|
|
|
|
expect(browserPane?.className).not.toContain("border");
|
|
expect(browserPane?.className).not.toContain("rounded");
|
|
expect(previewPane?.className).not.toContain("border");
|
|
expect(previewPane?.className).not.toContain("rounded");
|
|
});
|
|
|
|
it("defaults Markdown files to rendered mode and switches back to raw source", async () => {
|
|
useQueryMock.mockImplementation((options: { queryKey?: readonly unknown[] }) => {
|
|
const key = JSON.stringify(options.queryKey ?? []);
|
|
if (key.includes('"content"')) {
|
|
return ok({
|
|
...content,
|
|
resource: {
|
|
...resolvedResource,
|
|
title: "launch.md",
|
|
displayPath: "docs/launch.md",
|
|
contentType: "text/markdown; charset=utf-8",
|
|
},
|
|
content: { encoding: "utf8", data: "# Launch note\n\nRendered body" },
|
|
});
|
|
}
|
|
return ok({
|
|
...resolvedResource,
|
|
title: "launch.md",
|
|
displayPath: "docs/launch.md",
|
|
contentType: "text/markdown; charset=utf-8",
|
|
});
|
|
});
|
|
renderSheet();
|
|
|
|
expect(document.body.querySelector('[aria-label="launch.md rendered Markdown"]')).not.toBeNull();
|
|
expect(document.body.querySelector('[aria-label="launch.md source"]')).toBeNull();
|
|
expect(document.body.querySelector('button[aria-label="Show rendered Markdown"]')).not.toBeNull();
|
|
expect(document.body.querySelector('button[aria-label="Show raw Markdown"]')).not.toBeNull();
|
|
expect(document.body.textContent).toContain("Rendered Markdown: # Launch note");
|
|
|
|
await click("Show raw Markdown");
|
|
|
|
expect(document.body.querySelector('[aria-label="launch.md source"]')).not.toBeNull();
|
|
expect(document.body.querySelector('[aria-label="launch.md rendered Markdown"]')).toBeNull();
|
|
});
|
|
});
|