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>
175 lines
4.9 KiB
TypeScript
175 lines
4.9 KiB
TypeScript
export const KEYBOARD_SHORTCUT_TEXT_INPUT_SELECTOR = [
|
|
"input",
|
|
"textarea",
|
|
"select",
|
|
"[contenteditable='true']",
|
|
"[contenteditable='plaintext-only']",
|
|
"[role='textbox']",
|
|
"[role='combobox']",
|
|
].join(", ");
|
|
|
|
const PAGE_SEARCH_SHORTCUT_SELECTOR = "[data-page-search-target='true']";
|
|
const MODIFIER_ONLY_KEYS = new Set(["Shift", "Meta", "Control", "Alt"]);
|
|
|
|
export type InboxQuickArchiveKeyAction = "ignore" | "archive" | "disarm";
|
|
export type InboxUndoArchiveKeyAction = "ignore" | "undo_archive";
|
|
export type IssueDetailGoKeyAction =
|
|
| "ignore"
|
|
| "arm"
|
|
| "navigate_inbox"
|
|
| "focus_comment"
|
|
| "open_file_viewer"
|
|
| "disarm";
|
|
|
|
export function isKeyboardShortcutTextInputTarget(target: EventTarget | null): boolean {
|
|
if (!(target instanceof HTMLElement)) return false;
|
|
if (target.isContentEditable) return true;
|
|
return !!target.closest(KEYBOARD_SHORTCUT_TEXT_INPUT_SELECTOR);
|
|
}
|
|
|
|
export function hasBlockingShortcutDialog(root: ParentNode = document): boolean {
|
|
return !!root.querySelector("[role='dialog'][aria-modal='true']");
|
|
}
|
|
|
|
function isVisibleShortcutTarget(element: HTMLElement): boolean {
|
|
if (!element.isConnected) return false;
|
|
if ("disabled" in element && typeof element.disabled === "boolean" && element.disabled) return false;
|
|
if (element.closest("[hidden], [aria-hidden='true'], [inert]")) return false;
|
|
if (element.closest("[role='dialog'][aria-modal='true']")) return false;
|
|
|
|
const style = window.getComputedStyle(element);
|
|
if (style.display === "none" || style.visibility === "hidden") return false;
|
|
|
|
return element.getClientRects().length > 0 || element === document.activeElement;
|
|
}
|
|
|
|
export function findPageSearchShortcutTarget(root: ParentNode = document): HTMLElement | null {
|
|
const candidates = Array.from(root.querySelectorAll<HTMLElement>(PAGE_SEARCH_SHORTCUT_SELECTOR));
|
|
return candidates.find((candidate) => isVisibleShortcutTarget(candidate)) ?? null;
|
|
}
|
|
|
|
export function focusPageSearchShortcutTarget(root: ParentNode = document): boolean {
|
|
const target = findPageSearchShortcutTarget(root);
|
|
if (!target) return false;
|
|
|
|
target.focus();
|
|
if (target instanceof HTMLInputElement || target instanceof HTMLTextAreaElement) {
|
|
target.select();
|
|
}
|
|
return true;
|
|
}
|
|
|
|
export function shouldBlurPageSearchOnEnter({
|
|
key,
|
|
isComposing,
|
|
}: {
|
|
key: string;
|
|
isComposing: boolean;
|
|
}): boolean {
|
|
return key === "Enter" && !isComposing;
|
|
}
|
|
|
|
export function shouldBlurPageSearchOnEscape({
|
|
key,
|
|
isComposing,
|
|
currentValue,
|
|
}: {
|
|
key: string;
|
|
isComposing: boolean;
|
|
currentValue: string;
|
|
}): boolean {
|
|
return key === "Escape" && !isComposing && currentValue.length === 0;
|
|
}
|
|
|
|
export function isModifierOnlyKey(key: string): boolean {
|
|
return MODIFIER_ONLY_KEYS.has(key);
|
|
}
|
|
|
|
export function resolveInboxQuickArchiveKeyAction({
|
|
armed,
|
|
defaultPrevented,
|
|
key,
|
|
metaKey,
|
|
ctrlKey,
|
|
altKey,
|
|
target,
|
|
hasOpenDialog,
|
|
}: {
|
|
armed: boolean;
|
|
defaultPrevented: boolean;
|
|
key: string;
|
|
metaKey: boolean;
|
|
ctrlKey: boolean;
|
|
altKey: boolean;
|
|
target: EventTarget | null;
|
|
hasOpenDialog: boolean;
|
|
}): InboxQuickArchiveKeyAction {
|
|
if (!armed) return "ignore";
|
|
if (defaultPrevented) return "ignore";
|
|
if (metaKey || ctrlKey || altKey || isModifierOnlyKey(key)) return "ignore";
|
|
if (hasOpenDialog || isKeyboardShortcutTextInputTarget(target)) return "ignore";
|
|
if (key.toLowerCase() === "y") return "archive";
|
|
return "ignore";
|
|
}
|
|
|
|
export function resolveInboxUndoArchiveKeyAction({
|
|
hasUndoableArchive,
|
|
defaultPrevented,
|
|
key,
|
|
metaKey,
|
|
ctrlKey,
|
|
altKey,
|
|
target,
|
|
hasOpenDialog,
|
|
}: {
|
|
hasUndoableArchive: boolean;
|
|
defaultPrevented: boolean;
|
|
key: string;
|
|
metaKey: boolean;
|
|
ctrlKey: boolean;
|
|
altKey: boolean;
|
|
target: EventTarget | null;
|
|
hasOpenDialog: boolean;
|
|
}): InboxUndoArchiveKeyAction {
|
|
if (!hasUndoableArchive) return "ignore";
|
|
if (defaultPrevented) return "ignore";
|
|
if (metaKey || ctrlKey || altKey || isModifierOnlyKey(key)) return "ignore";
|
|
if (hasOpenDialog || isKeyboardShortcutTextInputTarget(target)) return "ignore";
|
|
if (key === "u") return "undo_archive";
|
|
return "ignore";
|
|
}
|
|
|
|
export function resolveIssueDetailGoKeyAction({
|
|
armed,
|
|
defaultPrevented,
|
|
key,
|
|
metaKey,
|
|
ctrlKey,
|
|
altKey,
|
|
target,
|
|
hasOpenDialog,
|
|
}: {
|
|
armed: boolean;
|
|
defaultPrevented: boolean;
|
|
key: string;
|
|
metaKey: boolean;
|
|
ctrlKey: boolean;
|
|
altKey: boolean;
|
|
target: EventTarget | null;
|
|
hasOpenDialog: boolean;
|
|
}): IssueDetailGoKeyAction {
|
|
if (defaultPrevented) return armed ? "disarm" : "ignore";
|
|
if (metaKey || ctrlKey || altKey || isModifierOnlyKey(key)) return "ignore";
|
|
if (hasOpenDialog || isKeyboardShortcutTextInputTarget(target)) {
|
|
return armed ? "disarm" : "ignore";
|
|
}
|
|
|
|
const normalizedKey = key.toLowerCase();
|
|
if (!armed) return normalizedKey === "g" ? "arm" : "ignore";
|
|
if (normalizedKey === "i") return "navigate_inbox";
|
|
if (normalizedKey === "c") return "focus_comment";
|
|
if (normalizedKey === "f") return "open_file_viewer";
|
|
if (normalizedKey === "g") return "arm";
|
|
return "disarm";
|
|
}
|