mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-12 08:19:54 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Task comments can contain references to files in project and execution workspaces. > - Paperclip detected path-shaped inline code and showed it as an actionable file chip. > - The UI did not first confirm that the current board session could open the file. > - Missing, denied, ambiguous, remote, and unsupported files therefore looked actionable and failed after a click. > - This pull request adds an issue-scoped availability check and promotes only confirmed files to chips. > - The benefit is that the task thread shows a file action only when that action can succeed. ## Linked Issues or Issue Description **What happened?** Task comments promoted path-shaped inline code to file chips before Paperclip checked the file. A chip could point to a missing, denied, ambiguous, remote, or non-previewable file. The action then failed after the user selected it. **Expected behavior** Paperclip must show a file chip only after the server confirms that the current board session can open the exact file reference. All other path-shaped text must stay ordinary inline code. **Steps to reproduce** 1. Add a task comment that contains inline code with a missing or inaccessible workspace path. 2. Open the task thread as a board user. 3. Observe that the path looks like an actionable file chip. 4. Select the chip and observe that the file cannot open. **Paperclip version or commit** `19be4cf927` and earlier. **Deployment mode** Local dev and self-hosted server. **Access context** Board user. ## What Changed - Added shared request, response, and validation contracts for batched workspace-file availability checks. - Added an issue-scoped server endpoint that resolves file references with company, issue, workspace, and preview-access checks. - Added bounded batch concurrency and tests for missing, denied, ambiguous, remote, unsupported, and available files. - Added an issue-scoped UI availability registry that deduplicates, batches, caches, and invalidates file checks. - Changed task-comment markdown rendering so only confirmed files get chip styling and file-viewer behavior. - Bound each chip to the exact workspace target that passed the availability check. ## Verification - `pnpm exec vitest run packages/shared/src/workspace-file-resource.test.ts server/src/__tests__/file-resources.test.ts ui/src/components/MarkdownBody.test.tsx ui/src/components/WorkspaceFileMarkdownBody.availability.test.tsx ui/src/lib/remark-workspace-file-refs.test.ts ui/src/lib/workspace-file-availability.test.ts` — 93 passed, 35 skipped. - `pnpm check:token-gates` — clean. - `pnpm -r typecheck` — passed. - `pnpm build` — passed. - `pnpm test:run` — all server and UI groups passed. One unchanged CLI test saw the run-injected static AWS credentials and expected only its local `AWS_PROFILE`. The same test passed, 8 of 8, after removing only `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` from its process environment. ## Risks - File chips now appear after an asynchronous availability check, so path-shaped text can briefly render as inline code. - Availability results use the existing 30-second file-resource cache window. File-resource invalidation forces a new check. - The endpoint limits each request to 100 references and the client chunks larger sets. > 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 with GPT-5. The service did not expose a more specific model ID or context-window size. The agent used high-reasoning mode, repository tools, command execution, and test execution. ## 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 not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [ ] 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>
102 lines
4.1 KiB
TypeScript
102 lines
4.1 KiB
TypeScript
import type { MouseEvent, ReactNode } from "react";
|
|
import { FileCode2, FolderOpen } from "lucide-react";
|
|
import { useLocation } from "@/lib/router";
|
|
import { cn } from "@/lib/utils";
|
|
import type { ParsedWorkspaceFileRef } from "@/lib/workspace-file-parser";
|
|
import { formatWorkspaceFileRefDisplay } from "@/lib/workspace-file-parser";
|
|
import {
|
|
useFileViewer,
|
|
writeFolderViewerStateToSearch,
|
|
writeFileViewerStateToSearch,
|
|
} from "@/context/FileViewerContext";
|
|
|
|
export interface WorkspaceFileLinkProps {
|
|
workspaceFileRef: ParsedWorkspaceFileRef;
|
|
/** Override the rendered label. Defaults to `path:line:col`. */
|
|
label?: ReactNode;
|
|
className?: string;
|
|
/** Optional override if the consumer wants to customize activation. */
|
|
onOpen?: (ref: ParsedWorkspaceFileRef) => void;
|
|
showIcon?: boolean;
|
|
title?: string;
|
|
}
|
|
|
|
export function WorkspaceFileLink({
|
|
workspaceFileRef,
|
|
label,
|
|
className,
|
|
onOpen,
|
|
showIcon = true,
|
|
title,
|
|
}: WorkspaceFileLinkProps) {
|
|
const viewer = useFileViewer();
|
|
const location = useLocation();
|
|
const display = typeof label !== "undefined" ? label : formatWorkspaceFileRefDisplay(workspaceFileRef);
|
|
const canOpen = !!(onOpen || viewer);
|
|
const isDirectory = workspaceFileRef.resourceKind === "directory" || workspaceFileRef.path.endsWith("/");
|
|
const lineSuffix = workspaceFileRef.line
|
|
? ` line ${workspaceFileRef.line}${workspaceFileRef.column ? ` column ${workspaceFileRef.column}` : ""}`
|
|
: "";
|
|
const ariaLabel = canOpen
|
|
? `Open ${workspaceFileRef.path}${lineSuffix} in the ${isDirectory ? "workspace browser" : "file viewer"}`
|
|
: `Workspace ${isDirectory ? "folder" : "file"} ${workspaceFileRef.path}${lineSuffix}`;
|
|
const tooltip = title ?? (canOpen
|
|
? `Open ${workspaceFileRef.path}${lineSuffix} in the ${isDirectory ? "workspace browser" : "file viewer"}`
|
|
: `Workspace ${isDirectory ? "folder" : "file"} ${workspaceFileRef.path}${lineSuffix}`);
|
|
|
|
const deepLinkSearch = isDirectory
|
|
? writeFolderViewerStateToSearch(location.search, {
|
|
path: workspaceFileRef.path,
|
|
projectId: workspaceFileRef.projectId ?? null,
|
|
workspaceId: workspaceFileRef.workspaceId ?? null,
|
|
})
|
|
: writeFileViewerStateToSearch(location.search, {
|
|
path: workspaceFileRef.path,
|
|
line: workspaceFileRef.line ?? null,
|
|
column: workspaceFileRef.column ?? null,
|
|
// Preserve the workspace that passed the availability preflight so the
|
|
// click resolves against that target instead of rediscovering one.
|
|
workspace: workspaceFileRef.workspace ?? "auto",
|
|
projectId: workspaceFileRef.projectId ?? null,
|
|
workspaceId: workspaceFileRef.workspaceId ?? null,
|
|
});
|
|
const href = canOpen
|
|
? `${location.pathname}${deepLinkSearch}${location.hash}`
|
|
: "#";
|
|
|
|
const handleClick = (event: MouseEvent<HTMLAnchorElement>) => {
|
|
if (event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) {
|
|
return;
|
|
}
|
|
if (event.button !== 0) return;
|
|
event.preventDefault();
|
|
if (!canOpen) return;
|
|
if (onOpen) onOpen(workspaceFileRef);
|
|
else if (isDirectory) viewer?.openFolder(workspaceFileRef);
|
|
else viewer?.open(workspaceFileRef);
|
|
};
|
|
|
|
return (
|
|
<a
|
|
href={href}
|
|
role={canOpen ? "button" : undefined}
|
|
data-workspace-file-link="true"
|
|
data-workspace-file-path={workspaceFileRef.path}
|
|
aria-label={ariaLabel}
|
|
title={tooltip}
|
|
className={cn(
|
|
"paperclip-workspace-file-link inline-flex items-center gap-1 rounded-sm border border-border bg-muted/60 px-1.5 py-0.5 font-mono text-xs leading-tight text-foreground/90 align-middle no-underline hover:bg-muted focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-1",
|
|
className,
|
|
)}
|
|
onClick={handleClick}
|
|
>
|
|
{showIcon ? (
|
|
isDirectory
|
|
? <FolderOpen aria-hidden="true" className="h-3 w-3 shrink-0 opacity-70" />
|
|
: <FileCode2 aria-hidden="true" className="h-3 w-3 shrink-0 opacity-70" />
|
|
) : null}
|
|
<span className="max-w-full whitespace-normal break-all text-left">{display}</span>
|
|
</a>
|
|
);
|
|
}
|