Files
paperclip/ui/storybook/stories/workspace-file-browser.stories.tsx
T
Dotta 468edd8b22 Add workspace file viewer and artifact links (#7681)
## 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>
2026-06-09 17:17:43 -05:00

213 lines
7.4 KiB
TypeScript

import { useEffect } from "react";
import { useQueryClient } from "@tanstack/react-query";
import type { Meta, StoryObj } from "@storybook/react-vite";
import type {
ResolvedWorkspaceResource,
WorkspaceFileContent,
WorkspaceFileListFileItem,
WorkspaceFileListResponse,
} from "@paperclipai/shared";
import { FileViewerProvider, useRequiredFileViewer } from "@/context/FileViewerContext";
import { FileViewerSheet } from "@/components/FileViewerSheet";
import { IssueWorkspaceCard } from "@/components/IssueWorkspaceCard";
import { queryKeys } from "@/lib/queryKeys";
/**
* Screenshot-review surface for PAP-10511, rendering the REAL FileViewerSheet /
* IssueWorkspaceCard (not a static frame) so the captures are visual truth.
* Stories seed the react-query cache so the components render without a backend.
* Capture each at desktop + 360px and in both themes via the Storybook theme global.
*/
const ISSUE_ID = "issue-browse-demo";
function listKey(issueId: string) {
return queryKeys.issues.fileResources(issueId, { workspace: "auto", mode: "changed", q: null, limit: 100, offset: 0 });
}
function item(relativePath: string, minutesAgo: number, overrides: Partial<WorkspaceFileListFileItem> = {}): WorkspaceFileListFileItem {
return {
kind: "file",
provider: "git_worktree",
title: relativePath.split("/").pop() ?? relativePath,
relativePath,
displayPath: relativePath,
workspaceLabel: "issue execution workspace · PAP-1953",
workspaceKind: "execution_workspace",
workspaceId: "ws-1",
contentType: "text/plain; charset=utf-8",
byteSize: 2048,
modifiedAt: new Date(Date.now() - minutesAgo * 60_000).toISOString(),
previewKind: "text",
capabilities: { preview: true, download: false, listChildren: false },
...overrides,
};
}
const recentList: WorkspaceFileListResponse = {
kind: "workspace_file_list",
state: "available",
workspace: {
provider: "git_worktree",
workspaceLabel: "issue execution workspace · PAP-1953",
workspaceKind: "execution_workspace",
workspaceId: "ws-1",
},
query: { workspace: "auto", mode: "changed", q: null, limit: 100, offset: 0 },
items: [
item("ui/src/components/WorkspaceFileBrowser.tsx", 2),
item("ui/src/components/FileViewerSheet.tsx", 2),
item("server/src/routes/file-resources.ts", 14),
item("doc/PRODUCT.md", 60),
item("packages/shared/src/types/workspace-file-resource.ts", 64),
item("server/src/services/very/deeply/nested/structure/workspace-file-resources.ts", 180),
],
scannedCount: 412,
truncated: true,
};
function unavailable(reason: string): WorkspaceFileListResponse {
return {
kind: "workspace_file_list",
state: "unavailable",
unavailableReason: reason,
workspace: null,
query: { workspace: "auto", mode: "changed", q: null, limit: 100, offset: 0 },
items: [],
scannedCount: 0,
truncated: false,
};
}
const viewedResource: ResolvedWorkspaceResource = {
kind: "file",
provider: "git_worktree",
title: "FileViewerSheet.tsx",
displayPath: "ui/src/components/FileViewerSheet.tsx",
workspaceLabel: "issue execution workspace · PAP-1953",
workspaceKind: "execution_workspace",
workspaceId: "ws-1",
contentType: "text/plain; charset=utf-8",
byteSize: 2048,
previewKind: "text",
capabilities: { preview: true, download: false, listChildren: false },
};
const viewedContent: WorkspaceFileContent = {
resource: viewedResource,
content: {
encoding: "utf8",
data: [
"export function FileViewerSheet({ issueId, state, open }: FileViewerSheetProps) {",
" const viewer = useRequiredFileViewer();",
" const browseMode = state === null && (showPromptWhenEmpty || viewer.browse);",
" const cameFromBrowse = state !== null && viewer.browse;",
" // … single sheet, two modes: browse ⇄ view",
" return <Sheet open={open}>…</Sheet>;",
"}",
].join("\n"),
},
};
function BrowseSheet({ data }: { data: WorkspaceFileListResponse }) {
const queryClient = useQueryClient();
queryClient.setQueryData(listKey(ISSUE_ID), data);
return (
<FileViewerProvider issueId={ISSUE_ID}>
<FileViewerSheet issueId={ISSUE_ID} showPromptWhenEmpty />
</FileViewerProvider>
);
}
function ViewFromBrowseInner() {
const viewer = useRequiredFileViewer();
useEffect(() => {
viewer.open(
{ path: "ui/src/components/FileViewerSheet.tsx", line: 3, column: null, workspace: "auto" },
{ fromBrowse: true },
);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
return <FileViewerSheet issueId={ISSUE_ID} />;
}
function ViewFromBrowse() {
const queryClient = useQueryClient();
queryClient.setQueryData(listKey(ISSUE_ID), recentList);
queryClient.setQueryData(
queryKeys.issues.fileResource(ISSUE_ID, {
path: "ui/src/components/FileViewerSheet.tsx",
workspace: "auto",
}),
viewedResource,
);
queryClient.setQueryData(
queryKeys.issues.fileResourceContent(ISSUE_ID, {
path: "ui/src/components/FileViewerSheet.tsx",
workspace: "auto",
}),
viewedContent,
);
return (
<FileViewerProvider issueId={ISSUE_ID}>
<ViewFromBrowseInner />
</FileViewerProvider>
);
}
function Placement() {
const queryClient = useQueryClient();
queryClient.setQueryData(queryKeys.instance.experimentalSettings, {
enableEnvironments: false,
enableIsolatedWorkspaces: true,
});
return (
<FileViewerProvider issueId={ISSUE_ID}>
<div className="mx-auto max-w-3xl space-y-3 p-6">
<h3 className="text-sm font-medium text-muted-foreground">Workspace</h3>
<IssueWorkspaceCard
issue={{
companyId: "company-1",
projectId: "project-1",
projectWorkspaceId: "pw-1",
executionWorkspaceId: "ws-1",
executionWorkspacePreference: "isolated_workspace",
executionWorkspaceSettings: { mode: "isolated_workspace", environmentId: null },
// eslint-disable-next-line @typescript-eslint/no-explicit-any
currentExecutionWorkspace: {
id: "ws-1",
mode: "isolated_workspace",
status: "active",
branchName: "PAP-1953-plan-a-file-viewer",
cwd: "/srv/paperclip/.../worktrees/PAP-1953",
repoUrl: null,
projectWorkspaceId: "pw-1",
name: "PAP-1953",
config: {},
} as any,
}}
project={{ id: "project-1", executionWorkspacePolicy: { enabled: true, defaultMode: "isolated_workspace" } }}
onUpdate={() => {}}
onBrowseFiles={() => {}}
onOpenFileByPath={() => {}}
/>
</div>
</FileViewerProvider>
);
}
const meta: Meta = {
title: "Issue/Workspace File Browser",
parameters: { layout: "fullscreen" },
};
export default meta;
type Story = StoryObj;
export const BrowseRecent: Story = { render: () => <BrowseSheet data={recentList} /> };
export const BrowseNoWorkspace: Story = { render: () => <BrowseSheet data={unavailable("no_workspace")} /> };
export const BrowseRemoteWorkspace: Story = { render: () => <BrowseSheet data={unavailable("remote_workspace")} /> };
export const BrowseCleanedUpWorkspace: Story = { render: () => <BrowseSheet data={unavailable("workspace_unavailable")} /> };
export const ViewModeFromBrowse: Story = { render: () => <ViewFromBrowse /> };
export const CardPlacement: Story = { render: () => <Placement /> };