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>
This commit is contained in:
Dotta
@@ -320,12 +320,14 @@ export {
|
||||
|
||||
export {
|
||||
createIssueWorkProductSchema,
|
||||
issueWorkProductMetadataSchema,
|
||||
updateIssueWorkProductSchema,
|
||||
attachmentArtifactWorkProductMetadataSchema,
|
||||
issueWorkProductTypeSchema,
|
||||
issueWorkProductStatusSchema,
|
||||
issueWorkProductReviewStateSchema,
|
||||
type CreateIssueWorkProduct,
|
||||
type IssueWorkProductMetadata,
|
||||
type UpdateIssueWorkProduct,
|
||||
} from "./work-product.js";
|
||||
|
||||
@@ -356,6 +358,21 @@ export {
|
||||
type UpdateExecutionWorkspace,
|
||||
} from "./execution-workspace.js";
|
||||
|
||||
export {
|
||||
resolvedWorkspaceResourceSchema,
|
||||
workspaceFileListModeSchema,
|
||||
workspaceFileListQuerySchema,
|
||||
workspaceFileContentSchema,
|
||||
workspaceFilePreviewKindSchema,
|
||||
workspaceFileRefSchema,
|
||||
workspaceFileResourceKindSchema,
|
||||
workspaceFileResourceQuerySchema,
|
||||
workspaceFileSelectorSchema,
|
||||
workspaceFileWorkspaceKindSchema,
|
||||
type WorkspaceFileListQuery,
|
||||
type WorkspaceFileResourceQuery,
|
||||
} from "./workspace-file-resource.js";
|
||||
|
||||
export {
|
||||
createGoalSchema,
|
||||
updateGoalSchema,
|
||||
|
||||
@@ -40,6 +40,7 @@ export const instanceExperimentalSettingsSchema = z.object({
|
||||
enableIsolatedWorkspaces: z.boolean().default(false),
|
||||
enableStreamlinedLeftNavigation: z.boolean().default(false),
|
||||
enableIssuePlanDecompositions: z.boolean().default(false),
|
||||
enableExperimentalFileViewer: z.boolean().default(false),
|
||||
enableCloudSync: z.boolean().default(false),
|
||||
autoRestartDevServerWhenIdle: z.boolean().default(false),
|
||||
enableIssueGraphLivenessAutoRecovery: z.boolean().default(false),
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { z } from "zod";
|
||||
import { workspaceFileRefSchema } from "./workspace-file-resource.js";
|
||||
|
||||
function attachmentContentPath(attachmentId: string): string {
|
||||
return `/api/attachments/${attachmentId}/content`;
|
||||
@@ -68,6 +69,14 @@ export const attachmentArtifactWorkProductMetadataSchema = z.object({
|
||||
|
||||
export type AttachmentArtifactWorkProductMetadata = z.infer<typeof attachmentArtifactWorkProductMetadataSchema>;
|
||||
|
||||
export const issueWorkProductMetadataSchema = z
|
||||
.object({
|
||||
resourceRef: workspaceFileRefSchema.optional().nullable(),
|
||||
})
|
||||
.passthrough();
|
||||
|
||||
export type IssueWorkProductMetadata = z.infer<typeof issueWorkProductMetadataSchema>;
|
||||
|
||||
export const createIssueWorkProductSchema = z.object({
|
||||
projectId: z.string().uuid().optional().nullable(),
|
||||
executionWorkspaceId: z.string().uuid().optional().nullable(),
|
||||
@@ -82,7 +91,7 @@ export const createIssueWorkProductSchema = z.object({
|
||||
isPrimary: z.boolean().optional().default(false),
|
||||
healthStatus: z.enum(["unknown", "healthy", "unhealthy"]).optional().default("unknown"),
|
||||
summary: z.string().optional().nullable(),
|
||||
metadata: z.record(z.string(), z.unknown()).optional().nullable(),
|
||||
metadata: issueWorkProductMetadataSchema.optional().nullable(),
|
||||
createdByRunId: z.string().uuid().optional().nullable(),
|
||||
});
|
||||
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
import { z } from "zod";
|
||||
|
||||
const workspaceFileListSearchMaxBytes = 128;
|
||||
|
||||
function utf8ByteLength(value: string) {
|
||||
return new TextEncoder().encode(value).length;
|
||||
}
|
||||
|
||||
export const workspaceFileWorkspaceKindSchema = z.enum(["execution_workspace", "project_workspace"]);
|
||||
export const workspaceFileSelectorSchema = z.enum(["auto", "execution", "project"]).default("auto");
|
||||
export const workspaceFileListModeSchema = z.enum(["all", "recent", "changed"]).default("all");
|
||||
export const workspaceFilePreviewKindSchema = z.enum(["text", "image", "video", "pdf", "unsupported"]);
|
||||
export const workspaceFileResourceKindSchema = z.enum(["file", "directory", "remote_resource"]);
|
||||
|
||||
export const workspaceFileRefSchema = z.object({
|
||||
kind: z.literal("workspace_file"),
|
||||
issueId: z.string().uuid().optional(),
|
||||
projectId: z.string().uuid().optional(),
|
||||
projectName: z.string().min(1).optional(),
|
||||
workspaceKind: workspaceFileWorkspaceKindSchema,
|
||||
workspaceId: z.string().uuid(),
|
||||
relativePath: z.string().min(1),
|
||||
line: z.number().int().positive().nullable().optional(),
|
||||
column: z.number().int().positive().nullable().optional(),
|
||||
displayPath: z.string().min(1),
|
||||
});
|
||||
|
||||
export const workspaceFileResourceQuerySchema = z.object({
|
||||
projectId: z.string().uuid().optional(),
|
||||
workspaceId: z.string().uuid().optional(),
|
||||
path: z
|
||||
.string()
|
||||
.min(1)
|
||||
.refine((value) => !/[\x00-\x1f\x7f]/.test(value), {
|
||||
message: "Workspace file path contains an invalid character",
|
||||
params: { code: "invalid_path" },
|
||||
}),
|
||||
workspace: workspaceFileSelectorSchema.optional(),
|
||||
}).refine((value) => Boolean(value.projectId) === Boolean(value.workspaceId), {
|
||||
message: "Workspace file target requires both projectId and workspaceId",
|
||||
path: ["workspaceId"],
|
||||
params: { code: "invalid_target" },
|
||||
});
|
||||
|
||||
export const workspaceFileListQuerySchema = z.object({
|
||||
projectId: z.string().uuid().optional(),
|
||||
workspaceId: z.string().uuid().optional(),
|
||||
workspace: workspaceFileSelectorSchema.optional(),
|
||||
path: z
|
||||
.string()
|
||||
.min(1)
|
||||
.refine((value) => !/[\x00-\x1f\x7f]/.test(value), {
|
||||
message: "Workspace folder path contains an invalid character",
|
||||
params: { code: "invalid_path" },
|
||||
})
|
||||
.optional(),
|
||||
mode: workspaceFileListModeSchema.optional(),
|
||||
q: z
|
||||
.string()
|
||||
.refine((value) => !/[\x00-\x1f\x7f]/.test(value), {
|
||||
message: "Workspace file search contains an invalid character",
|
||||
params: { code: "invalid_query" },
|
||||
})
|
||||
.refine((value) => utf8ByteLength(value.trim()) <= workspaceFileListSearchMaxBytes, {
|
||||
message: "Workspace file search is too long",
|
||||
params: { code: "invalid_query" },
|
||||
})
|
||||
.optional(),
|
||||
limit: z.coerce.number().int().min(1).max(100).default(25),
|
||||
offset: z.coerce.number().int().min(0).max(10_000).default(0),
|
||||
}).refine((value) => Boolean(value.projectId) === Boolean(value.workspaceId), {
|
||||
message: "Workspace file target requires both projectId and workspaceId",
|
||||
path: ["workspaceId"],
|
||||
params: { code: "invalid_target" },
|
||||
});
|
||||
|
||||
export const resolvedWorkspaceResourceSchema = z.object({
|
||||
kind: workspaceFileResourceKindSchema,
|
||||
provider: z.string().min(1),
|
||||
title: z.string().min(1),
|
||||
displayPath: z.string().min(1),
|
||||
workspaceLabel: z.string().min(1),
|
||||
workspaceKind: workspaceFileWorkspaceKindSchema,
|
||||
workspaceId: z.string().uuid(),
|
||||
projectId: z.string().uuid().nullable().optional(),
|
||||
projectName: z.string().min(1).nullable().optional(),
|
||||
contentType: z.string().nullable().optional(),
|
||||
byteSize: z.number().int().nonnegative().nullable().optional(),
|
||||
previewKind: workspaceFilePreviewKindSchema,
|
||||
denialReason: z.string().nullable().optional(),
|
||||
capabilities: z.object({
|
||||
preview: z.boolean(),
|
||||
download: z.literal(false),
|
||||
listChildren: z.boolean(),
|
||||
}),
|
||||
});
|
||||
|
||||
export const workspaceFileContentSchema = z.object({
|
||||
resource: resolvedWorkspaceResourceSchema,
|
||||
content: z.object({
|
||||
encoding: z.enum(["utf8", "base64"]),
|
||||
data: z.string(),
|
||||
}),
|
||||
});
|
||||
|
||||
export type WorkspaceFileResourceQuery = z.infer<typeof workspaceFileResourceQuerySchema>;
|
||||
export type WorkspaceFileListQuery = z.infer<typeof workspaceFileListQuerySchema>;
|
||||
Reference in New Issue
Block a user