mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 17:45:53 +01:00
## 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>
109 lines
3.7 KiB
TypeScript
109 lines
3.7 KiB
TypeScript
export interface ParsedWorkspaceFileRef {
|
|
path: string;
|
|
resourceKind?: "file" | "directory";
|
|
line: number | null;
|
|
column: number | null;
|
|
projectId?: string | null;
|
|
projectName?: string | null;
|
|
workspaceId?: string | null;
|
|
/** The original matched text (useful for rendering) */
|
|
raw: string;
|
|
}
|
|
|
|
/**
|
|
* Match a workspace file reference inside an inline code span.
|
|
*
|
|
* Accepts POSIX-style relative paths with at least one slash or a recognizable
|
|
* file extension. Supports optional line/column suffixes:
|
|
*
|
|
* - `path/to/file.ext`
|
|
* - `path/to/file.ext:42`
|
|
* - `path/to/file.ext:42:3`
|
|
* - `path/to/file.ext#L42`
|
|
* - `path/to/file.ext#L42C3`
|
|
*/
|
|
const WORKSPACE_FILE_REF_RE =
|
|
/^([A-Za-z0-9_.\-+][A-Za-z0-9_./\-+]*\.[A-Za-z0-9_+\-]{1,10})(?::([1-9]\d*)(?::([1-9]\d*))?|#L([1-9]\d*)(?:C([1-9]\d*))?)?$/;
|
|
|
|
const BARE_NO_EXT_RE = /^([A-Za-z0-9_.\-+][A-Za-z0-9_./\-+]+\/[A-Za-z0-9_.\-+]+)(?::([1-9]\d*)(?::([1-9]\d*))?|#L([1-9]\d*)(?:C([1-9]\d*))?)?$/;
|
|
|
|
const WORKSPACE_DIRECTORY_REF_RE = /^([A-Za-z0-9_.\-+][A-Za-z0-9_./\-+]*\/)$/;
|
|
|
|
const INVALID_PREFIXES = ["/", "./", "../", "~/"];
|
|
|
|
function toPositiveInt(value: string | undefined): number | null {
|
|
if (!value) return null;
|
|
const n = Number.parseInt(value, 10);
|
|
if (!Number.isFinite(n) || n <= 0) return null;
|
|
return n;
|
|
}
|
|
|
|
function looksLikeWorkspacePath(input: string, opts: { allowTrailingSlash: boolean }): boolean {
|
|
if (!input || input.length > 512) return false;
|
|
if (input.includes("\\") || input.includes("\0")) return false;
|
|
if (input.startsWith("/") || input.startsWith("~") || /^[A-Za-z]:/.test(input)) return false;
|
|
if (input.includes("//")) return false;
|
|
if (INVALID_PREFIXES.some((prefix) => input === prefix.slice(0, -1))) return false;
|
|
const path = opts.allowTrailingSlash && input.endsWith("/") ? input.slice(0, -1) : input;
|
|
if (!path || /^\.+$/.test(path)) return false;
|
|
const segments = path.split("/");
|
|
for (const segment of segments) {
|
|
if (segment === "" || segment === "." || segment === "..") return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Attempt to parse the given text as a workspace file reference.
|
|
* Returns null if the text does not look like one.
|
|
*/
|
|
export function parseWorkspaceFileRef(input: string): ParsedWorkspaceFileRef | null {
|
|
if (typeof input !== "string") return null;
|
|
const trimmed = input.trim();
|
|
if (!trimmed) return null;
|
|
|
|
const directoryMatch = trimmed.match(WORKSPACE_DIRECTORY_REF_RE);
|
|
if (directoryMatch) {
|
|
const [, rawPath] = directoryMatch;
|
|
if (!rawPath || !looksLikeWorkspacePath(rawPath, { allowTrailingSlash: true })) return null;
|
|
if (!rawPath.slice(0, -1).includes("/")) return null;
|
|
return {
|
|
path: rawPath,
|
|
resourceKind: "directory",
|
|
line: null,
|
|
column: null,
|
|
raw: trimmed,
|
|
};
|
|
}
|
|
|
|
const match = trimmed.match(WORKSPACE_FILE_REF_RE) ?? trimmed.match(BARE_NO_EXT_RE);
|
|
if (!match) return null;
|
|
const [, rawPath, colonLine, colonCol, hashLine, hashCol] = match;
|
|
if (!rawPath) return null;
|
|
if (!looksLikeWorkspacePath(rawPath, { allowTrailingSlash: false })) return null;
|
|
|
|
const line = toPositiveInt(colonLine) ?? toPositiveInt(hashLine);
|
|
const column = toPositiveInt(colonCol) ?? toPositiveInt(hashCol);
|
|
|
|
// Disambiguate against plain prose filenames like `README.md`:
|
|
// require either a slash in the path or a line anchor.
|
|
if (!rawPath.includes("/") && line === null) return null;
|
|
|
|
return {
|
|
path: rawPath,
|
|
resourceKind: "file",
|
|
line,
|
|
column,
|
|
raw: trimmed,
|
|
};
|
|
}
|
|
|
|
export function formatWorkspaceFileRefDisplay(ref: ParsedWorkspaceFileRef): string {
|
|
const path = ref.line && ref.column
|
|
? `${ref.path}:${ref.line}:${ref.column}`
|
|
: ref.line
|
|
? `${ref.path}:${ref.line}`
|
|
: ref.path;
|
|
return ref.projectName ? `${ref.projectName} / ${path}` : path;
|
|
}
|