Files
PaperClipAI/ui/src/lib/workspace-file-availability.ts
T
DottaandPaperclip 7ea2068ef8 fix(files): only highlight accessible workspace file links (#11090)
## 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>
2026-08-11 12:11:45 -04:00

108 lines
3.9 KiB
TypeScript

import type { ResolvedWorkspaceResource, WorkspaceFileSelector } from "@paperclipai/shared";
import type { ParsedWorkspaceFileRef } from "./workspace-file-parser";
/** Server cap on `POST /file-resources/availability` (`queries` max length). */
export const WORKSPACE_FILE_AVAILABILITY_MAX_BATCH = 100;
/** Matches the file viewer's existing resolve/content cache window. */
export const WORKSPACE_FILE_AVAILABILITY_STALE_MS = 30_000;
/** The subset of a parsed ref that identifies an availability lookup. */
export interface WorkspaceFileAvailabilityRef {
path: string;
workspace: WorkspaceFileSelector;
projectId: string | null;
workspaceId: string | null;
}
/**
* The workspace the server confirmed can serve a reference. Chips bind this to
* their viewer URL so the click reuses the target that passed preflight instead
* of repeating an unconstrained auto-discovery pass.
*/
export interface WorkspaceFileAvailabilityTarget {
workspace: WorkspaceFileSelector;
projectId: string | null;
workspaceId: string | null;
projectName: string | null;
}
export type WorkspaceFileAvailability =
/** Not yet requested, in flight, or the batch failed — render as plain code. */
| { state: "pending" }
| { state: "unavailable"; reason: string | null }
| { state: "openable"; target: WorkspaceFileAvailabilityTarget };
export const WORKSPACE_FILE_AVAILABILITY_PENDING: WorkspaceFileAvailability = { state: "pending" };
export function workspaceFileAvailabilityRef(ref: ParsedWorkspaceFileRef): WorkspaceFileAvailabilityRef {
return {
path: ref.path,
workspace: ref.workspace ?? "auto",
projectId: ref.projectId ?? null,
workspaceId: ref.workspaceId ?? null,
};
}
/**
* Stable identity for a reference. Mirrors the server's dedup key
* (`[workspace, projectId, workspaceId, path]`) so responses can be matched back
* to the requests that produced them without relying on array order.
*/
export function workspaceFileAvailabilityKey(ref: WorkspaceFileAvailabilityRef): string {
return JSON.stringify([ref.workspace, ref.projectId, ref.workspaceId, ref.path]);
}
/** Split a deduplicated ref list into request-sized chunks. */
export function chunkWorkspaceFileAvailabilityRefs<T>(
refs: T[],
size: number = WORKSPACE_FILE_AVAILABILITY_MAX_BATCH,
): T[][] {
if (refs.length <= size) return refs.length > 0 ? [refs] : [];
const chunks: T[][] = [];
for (let index = 0; index < refs.length; index += size) {
chunks.push(refs.slice(index, index + size));
}
return chunks;
}
/**
* Derive the viewer target from a resolved resource. Project workspaces carry
* explicit ids; execution workspaces are addressed by selector because they are
* scoped to the issue already.
*/
export function workspaceFileAvailabilityTarget(
resource: ResolvedWorkspaceResource,
): WorkspaceFileAvailabilityTarget {
if (resource.workspaceKind === "project_workspace" && resource.projectId && resource.workspaceId) {
return {
workspace: "project",
projectId: resource.projectId,
workspaceId: resource.workspaceId,
projectName: resource.projectName ?? null,
};
}
return {
workspace: resource.workspaceKind === "project_workspace" ? "project" : "execution",
projectId: null,
workspaceId: null,
projectName: resource.projectName ?? null,
};
}
/**
* Fail closed: only a server result that is explicitly openable and carries a
* resolved resource becomes a chip. Denied, missing, ambiguous, remote,
* unsupported, and unmatched refs stay ordinary inline code.
*/
export function workspaceFileAvailabilityFromResult(result: {
openable: boolean;
unavailableReason?: string | null;
resource: ResolvedWorkspaceResource | null;
}): WorkspaceFileAvailability {
if (!result.openable || !result.resource) {
return { state: "unavailable", reason: result.unavailableReason ?? null };
}
return { state: "openable", target: workspaceFileAvailabilityTarget(result.resource) };
}