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>
74 lines
3.1 KiB
JavaScript
74 lines
3.1 KiB
JavaScript
#!/usr/bin/env node
|
|
// Screenshots every FileViewerSheet Storybook state at desktop + mobile viewports.
|
|
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { chromium } from "@playwright/test";
|
|
|
|
const BASE = "http://localhost:6006/iframe.html";
|
|
const OUT_DIR = path.resolve(process.argv[2] || "/tmp/pap-1963");
|
|
|
|
const SHOTS = [
|
|
{ id: "components-file-viewer-sheet--text-content-with-highlighted-line", label: "content-highlighted-line" },
|
|
{ id: "components-file-viewer-sheet--text-content-long-path-truncation", label: "content-long-path" },
|
|
{ id: "components-file-viewer-sheet--open-file-prompt", label: "open-file-prompt" },
|
|
{ id: "components-file-viewer-sheet--loading-spinner", label: "loading-spinner" },
|
|
{ id: "components-file-viewer-sheet--error-not-found-with-fallback", label: "error-not-found" },
|
|
{ id: "components-file-viewer-sheet--error-no-workspace", label: "error-no-workspace" },
|
|
{ id: "components-file-viewer-sheet--error-outside-workspace", label: "error-outside-workspace" },
|
|
{ id: "components-file-viewer-sheet--error-denied-sensitive", label: "error-denied" },
|
|
{ id: "components-file-viewer-sheet--remote-workspace", label: "remote-workspace" },
|
|
{ id: "components-file-viewer-sheet--workspace-archived", label: "workspace-archived" },
|
|
{ id: "components-file-viewer-sheet--binary-unsupported", label: "binary-unsupported" },
|
|
{ id: "components-file-viewer-sheet--too-large-to-preview", label: "too-large" },
|
|
];
|
|
|
|
const VIEWPORTS = [
|
|
{ name: "desktop", width: 1440, height: 900 },
|
|
{ name: "mobile", width: 390, height: 844 },
|
|
];
|
|
|
|
async function run() {
|
|
await fs.mkdir(OUT_DIR, { recursive: true });
|
|
const browser = await chromium.launch({ headless: true });
|
|
try {
|
|
for (const vp of VIEWPORTS) {
|
|
const context = await browser.newContext({
|
|
viewport: { width: vp.width, height: vp.height },
|
|
deviceScaleFactor: 2,
|
|
});
|
|
const page = await context.newPage();
|
|
for (const shot of SHOTS) {
|
|
const url = `${BASE}?id=${shot.id}&viewMode=story&args=`;
|
|
console.log(`[${vp.name}] → ${shot.label}`);
|
|
await page.goto(url, { waitUntil: "domcontentloaded" });
|
|
// Give the sheet animation + potential network stubs ~1.5s to settle.
|
|
await page.waitForTimeout(shot.label === "loading-spinner" ? 900 : 1600);
|
|
const out = path.join(OUT_DIR, `${vp.name}-${shot.label}.png`);
|
|
await page.screenshot({ path: out, fullPage: false });
|
|
}
|
|
// Extra capture: mobile view story (its own viewport story) as a cross-check.
|
|
if (vp.name === "mobile") {
|
|
await page.goto(
|
|
`${BASE}?id=components-file-viewer-sheet--mobile-view&viewMode=story&args=`,
|
|
{ waitUntil: "domcontentloaded" },
|
|
);
|
|
await page.waitForTimeout(1600);
|
|
await page.screenshot({
|
|
path: path.join(OUT_DIR, `mobile-story-variant.png`),
|
|
fullPage: false,
|
|
});
|
|
}
|
|
await context.close();
|
|
}
|
|
} finally {
|
|
await browser.close();
|
|
}
|
|
console.log(`\nScreenshots written to ${OUT_DIR}`);
|
|
}
|
|
|
|
run().catch((error) => {
|
|
console.error(error);
|
|
process.exit(1);
|
|
});
|