mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-10 03:08:10 +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>
122 lines
4.7 KiB
TypeScript
122 lines
4.7 KiB
TypeScript
// @vitest-environment node
|
|
|
|
import { describe, expect, it } from "vitest";
|
|
import type { ResolvedWorkspaceResource } from "@paperclipai/shared";
|
|
import {
|
|
chunkWorkspaceFileAvailabilityRefs,
|
|
workspaceFileAvailabilityFromResult,
|
|
workspaceFileAvailabilityKey,
|
|
workspaceFileAvailabilityRef,
|
|
workspaceFileAvailabilityTarget,
|
|
WORKSPACE_FILE_AVAILABILITY_MAX_BATCH,
|
|
} from "./workspace-file-availability";
|
|
|
|
function resource(overrides: Partial<ResolvedWorkspaceResource> = {}): ResolvedWorkspaceResource {
|
|
return {
|
|
kind: "file",
|
|
provider: "git_worktree",
|
|
title: "a.ts",
|
|
displayPath: "ui/src/a.ts",
|
|
workspaceLabel: "Execution workspace",
|
|
workspaceKind: "execution_workspace",
|
|
workspaceId: "0de5f74f-a7d4-4f73-a9a0-455a2b968cf2",
|
|
previewKind: "text",
|
|
capabilities: { preview: true, download: true, listChildren: false },
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("workspaceFileAvailabilityRef", () => {
|
|
it("drops line/column so anchors of the same file share one lookup", () => {
|
|
const a = workspaceFileAvailabilityRef({ path: "ui/src/a.ts", line: 4, column: 2, raw: "ui/src/a.ts:4:2" });
|
|
const b = workspaceFileAvailabilityRef({ path: "ui/src/a.ts", line: 90, column: null, raw: "ui/src/a.ts:90" });
|
|
expect(workspaceFileAvailabilityKey(a)).toBe(workspaceFileAvailabilityKey(b));
|
|
});
|
|
|
|
it("defaults an unbound reference to the auto selector", () => {
|
|
expect(workspaceFileAvailabilityRef({ path: "a/b.ts", line: null, column: null, raw: "a/b.ts" })).toEqual({
|
|
path: "a/b.ts",
|
|
workspace: "auto",
|
|
projectId: null,
|
|
workspaceId: null,
|
|
});
|
|
});
|
|
|
|
it("keeps distinct targets on distinct keys", () => {
|
|
const auto = workspaceFileAvailabilityKey({ path: "a/b.ts", workspace: "auto", projectId: null, workspaceId: null });
|
|
const execution = workspaceFileAvailabilityKey({ path: "a/b.ts", workspace: "execution", projectId: null, workspaceId: null });
|
|
const folder = workspaceFileAvailabilityKey({ path: "a/b.ts/", workspace: "auto", projectId: null, workspaceId: null });
|
|
expect(new Set([auto, execution, folder]).size).toBe(3);
|
|
});
|
|
|
|
it("matches the server's dedup key ordering", () => {
|
|
expect(workspaceFileAvailabilityKey({ path: "a/b.ts", workspace: "auto", projectId: null, workspaceId: null }))
|
|
.toBe(JSON.stringify(["auto", null, null, "a/b.ts"]));
|
|
});
|
|
});
|
|
|
|
describe("chunkWorkspaceFileAvailabilityRefs", () => {
|
|
it("returns nothing for an empty list", () => {
|
|
expect(chunkWorkspaceFileAvailabilityRefs([])).toEqual([]);
|
|
});
|
|
|
|
it("keeps a batch at the cap in one request", () => {
|
|
const refs = Array.from({ length: WORKSPACE_FILE_AVAILABILITY_MAX_BATCH }, (_, index) => index);
|
|
expect(chunkWorkspaceFileAvailabilityRefs(refs)).toHaveLength(1);
|
|
});
|
|
|
|
it("chunks only above the cap", () => {
|
|
const refs = Array.from({ length: 250 }, (_, index) => index);
|
|
expect(chunkWorkspaceFileAvailabilityRefs(refs).map((chunk) => chunk.length)).toEqual([100, 100, 50]);
|
|
});
|
|
});
|
|
|
|
describe("workspaceFileAvailabilityTarget", () => {
|
|
it("binds a project workspace by explicit ids", () => {
|
|
expect(workspaceFileAvailabilityTarget(resource({
|
|
workspaceKind: "project_workspace",
|
|
projectId: "17acae7d-9d0c-46bf-9c82-be9694ac3461",
|
|
projectName: "Paperclip App",
|
|
}))).toEqual({
|
|
workspace: "project",
|
|
projectId: "17acae7d-9d0c-46bf-9c82-be9694ac3461",
|
|
workspaceId: "0de5f74f-a7d4-4f73-a9a0-455a2b968cf2",
|
|
projectName: "Paperclip App",
|
|
});
|
|
});
|
|
|
|
it("binds an execution workspace by selector alone", () => {
|
|
expect(workspaceFileAvailabilityTarget(resource())).toMatchObject({
|
|
workspace: "execution",
|
|
projectId: null,
|
|
workspaceId: null,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("workspaceFileAvailabilityFromResult", () => {
|
|
it("accepts an openable result with a resolved resource", () => {
|
|
expect(workspaceFileAvailabilityFromResult({ openable: true, resource: resource() }).state).toBe("openable");
|
|
});
|
|
|
|
it("rejects a non-openable result and keeps the reason", () => {
|
|
expect(workspaceFileAvailabilityFromResult({
|
|
openable: false,
|
|
unavailableReason: "not_found",
|
|
resource: null,
|
|
})).toEqual({ state: "unavailable", reason: "not_found" });
|
|
});
|
|
|
|
it("fails closed when a result claims openable without a resource", () => {
|
|
expect(workspaceFileAvailabilityFromResult({ openable: true, resource: null }).state).toBe("unavailable");
|
|
});
|
|
|
|
it("fails closed for remote resources the viewer cannot preview", () => {
|
|
expect(workspaceFileAvailabilityFromResult({
|
|
openable: false,
|
|
unavailableReason: "remote_workspace",
|
|
resource: resource({ kind: "remote_resource", capabilities: { preview: false, download: false, listChildren: false } }),
|
|
}).state).toBe("unavailable");
|
|
});
|
|
});
|