mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-15 18:56:05 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The board UI sidebar shows the person's recent tasks on every page, including the Mine inbox > - The sidebar refreshes those rows through `GET /companies/:id/issues/summaries`, which accepted at most five IDs > - `useRecentTasks` sent the chunks one after another, so a 25-task history cost five sequential requests > - On staging each request took 3–6 s, so the recent-task rows settled about 20 s after load and every request competed with the inbox rows > - This pull request raises the per-request cap to 50 and fetches any remaining chunks in parallel > - The benefit is one summaries request for a typical history instead of a serial chain ## Linked Issues or Issue Description **What existing behavior does this improve?** The refresh of the sidebar's recent tasks on page load. **Subsystem affected** Board UI (`ui/src/hooks/useRecentTasks.ts`) and the `/issues/summaries` route bound (`packages/shared`, `server/src/routes/issues.ts`). **Current behavior** A history of N recent tasks sends ceil(N/5) summaries requests in series. Measured on staging on 2026-11-09 for a cold Mine load: five requests of five IDs, started at 1.0 s, 4.3 s, 8.1 s, 12.3 s and 18.4 s, each taking 3.3–6.1 s. **Proposed behavior** Up to 50 recent tasks are one request. Longer histories send their chunks at the same time. **Reason and benefit** The staging server is saturated, so each extra serial round trip delays the sidebar and the inbox rows. One request removes four round trips from a typical load. ## What Changed - `ISSUE_SUMMARIES_MAX_IDS` is now 50 (was 5). The shared validator, the route's 400 message, the service guard and the OpenAPI description use the new bound. - `useRecentTasks` builds all chunks first and fetches them at most three at a time (`RECENT_TASK_SUMMARY_CONCURRENCY`). The recent list has no size cap, so this keeps a long history from becoming a burst. The cache key, omission handling and pruning are unchanged. A failed chunk still fails the batch, so nothing is pruned on a partial failure. - Tests: the route test accepts exactly `MAX` IDs and rejects `MAX + 1`; a hook test checks that at most three chunks are in flight; the API test uses the constant; `useRecentTasks` tests cover a 25-task history in one request and a 103-task history with three chunks in flight together, with and without a failed chunk. - New browser check `tests/perf/collections/recent-task-summaries.spec.ts`: a Mine load with a 12-task history sends summaries requests that each carry all 12 IDs, and the server answers 200 with all 12 tasks. ## Verification - `pnpm verify` (selected Vitest files) passes. - `server`: `npx vitest run src/__tests__/issue-summaries-routes.test.ts src/__tests__/issue-display-status.test.ts` passes (embedded PostgreSQL). - `ui`: `npx vitest run src/hooks/useRecentTasks.test.tsx src/api/issue-summaries.test.ts src/components/task-chat/TaskChatBlockerLinks.test.tsx src/components/CoordinatorSidebar.test.tsx src/components/SidebarRecentTasks.test.tsx` passes. - Browser check against a disposable local instance: `PAPERCLIP_COLLECTION_PERF_BASE_URL=http://127.0.0.1:<port> pnpm exec playwright test --config tests/perf/collections/playwright.config.ts recent-task-summaries.spec.ts`. It passes on this branch. With `master`'s hook and constant it fails: three requests of 5, 5 and 2 IDs. ## Risks - Low risk. The route still validates UUIDs, deduplicates, and applies the same read authorization per row. Blocker attention is computed with set-based queries, so 50 IDs is the same number of queries as 5. - During a rolling deploy, a new UI against an old server would get a 400 for a history above five tasks. The server serves the UI bundle, so both change together on a normal deploy. The sidebar keeps its stored snapshot when the refresh fails. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, via Claude Code with tool use (shell, file edits, browser). 1M-token context window. Extended thinking was off. ## 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 - [ ] 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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
166 lines
11 KiB
TypeScript
166 lines
11 KiB
TypeScript
import { randomUUID } from "node:crypto";
|
|
import express from "express";
|
|
import request from "supertest";
|
|
import { eq } from "drizzle-orm";
|
|
import { afterAll, beforeAll, expect, it, vi } from "vitest";
|
|
import {
|
|
agents, chatConversations, chatEndpoints, heartbeatRuns, issueRelations, issues, toolApplications, toolConnections,
|
|
} from "@paperclipai/db";
|
|
import { ISSUE_SUMMARIES_MAX_IDS } from "@paperclipai/shared";
|
|
import { issueRoutes } from "../routes/issues.js";
|
|
import * as issueServices from "../services/issues.js";
|
|
import { errorHandler } from "../middleware/index.js";
|
|
import { describeEmbeddedPostgres, seedCompanyWithBoardAccess, useEmbeddedPostgres, type BoardActor } from "./helpers/route-test-harness.js";
|
|
|
|
describeEmbeddedPostgres("bounded issue summaries", () => {
|
|
const ctx = useEmbeddedPostgres("paperclip-issue-summaries-");
|
|
const oldPrivacy = process.env.PAPERCLIP_ISSUE_PRIVACY_MODE;
|
|
beforeAll(() => { process.env.PAPERCLIP_ISSUE_PRIVACY_MODE = "enforce"; });
|
|
afterAll(() => {
|
|
if (oldPrivacy === undefined) delete process.env.PAPERCLIP_ISSUE_PRIVACY_MODE;
|
|
else process.env.PAPERCLIP_ISSUE_PRIVACY_MODE = oldPrivacy;
|
|
});
|
|
|
|
async function fixture() {
|
|
const company = await seedCompanyWithBoardAccess(ctx.db, "Summaries");
|
|
const rows = await ctx.db.insert(issues).values([
|
|
{ companyId: company.companyId, title: "First", description: "Do not serialize this".repeat(100), status: "todo" },
|
|
{ companyId: company.companyId, title: "Second", status: "done" },
|
|
]).returning();
|
|
return { ...company, rows };
|
|
}
|
|
function app(actor: BoardActor | Express.Request["actor"]) {
|
|
const result = express();
|
|
result.use(express.json());
|
|
result.use((req, _res, next) => { req.actor = actor as Express.Request["actor"]; next(); });
|
|
result.use("/api", issueRoutes(ctx.db, {} as never));
|
|
result.use(errorHandler);
|
|
return result;
|
|
}
|
|
const url = (companyId: string) => `/api/companies/${companyId}/issues/summaries`;
|
|
|
|
it("returns only summaries in requested order without full-detail reads", async () => {
|
|
const f = await fixture();
|
|
const original = issueServices.issueService;
|
|
const forbiddenRead = vi.fn(() => { throw new Error("Full detail read invoked"); });
|
|
const spy = vi.spyOn(issueServices, "issueService").mockImplementation((...args) => ({
|
|
...original(...args), getById: forbiddenRead, list: forbiddenRead,
|
|
}));
|
|
try {
|
|
const res = await request(app(f.actor)).get(url(f.companyId)).query({ ids: ` ${f.rows[1]!.id.toUpperCase()},${f.rows[0]!.id},${f.rows[1]!.id} ` }).expect(200);
|
|
expect(res.headers["cache-control"]).toBe("private, no-store");
|
|
expect(res.body.map((row: { id: string }) => row.id)).toEqual([f.rows[1]!.id, f.rows[0]!.id]);
|
|
expect(Object.keys(res.body[0]).sort()).toEqual([
|
|
"companyId", "displayStatus", "externalConversationState", "id", "identifier", "status", "title", "updatedAt",
|
|
]);
|
|
expect(res.body[0].externalConversationState).toBeNull();
|
|
expect(forbiddenRead).not.toHaveBeenCalled();
|
|
} finally { spy.mockRestore(); }
|
|
});
|
|
|
|
it.each(["", "?ids=", "?ids=nope", "?ids=,", "?ids[]=nope", "?ids[x]=nope",
|
|
`?ids=${randomUUID()}&ids[]=nope`, `?ids=${randomUUID()}&ids[x]=nope`,
|
|
`?ids=${randomUUID()}&ids=${randomUUID()}`, `?ids=${Array.from({ length: ISSUE_SUMMARIES_MAX_IDS + 1 }, () => randomUUID()).join(",")}`,
|
|
])("rejects invalid query %s", async (query) => {
|
|
const f = await fixture();
|
|
await request(app(f.actor)).get(url(f.companyId) + query).expect(400);
|
|
});
|
|
|
|
it("accepts exactly the maximum number of IDs", async () => {
|
|
const f = await fixture();
|
|
const ids = [f.rows[0]!.id, f.rows[1]!.id,
|
|
...Array.from({ length: ISSUE_SUMMARIES_MAX_IDS - 2 }, () => randomUUID())];
|
|
const res = await request(app(f.actor)).get(url(f.companyId)).query({ ids: ids.join(",") }).expect(200);
|
|
expect(res.body.map((row: { id: string }) => row.id)).toEqual([f.rows[0]!.id, f.rows[1]!.id]);
|
|
});
|
|
|
|
it("omits hidden, private, foreign and missing IDs without revealing them", async () => {
|
|
const f = await fixture();
|
|
const foreign = await fixture();
|
|
const hidden = f.rows[1]!;
|
|
await ctx.db.update(issues).set({ hiddenAt: new Date() }).where(eq(issues.id, hidden.id));
|
|
const privateId = randomUUID();
|
|
await ctx.db.insert(issues).values({ id: privateId, companyId: f.companyId, title: "Private", visibility: "private", privacyRootIssueId: privateId, responsibleUserId: "someone-else", createdByUserId: "someone-else" });
|
|
const ids = [f.rows[0]!.id, hidden.id, privateId, foreign.rows[0]!.id, randomUUID()];
|
|
const res = await request(app(f.actor)).get(url(f.companyId)).query({ ids: ids.join(",") }).expect(200);
|
|
expect(res.body.map((row: { id: string }) => row.id)).toEqual([f.rows[0]!.id]);
|
|
const empty = await request(app(f.actor)).get(url(f.companyId)).query({ ids: ids.slice(1).join(",") }).expect(200);
|
|
expect(empty.body).toEqual([]);
|
|
await request(app(f.actor)).get(url(foreign.companyId)).query({ ids: foreign.rows[0]!.id }).expect(403);
|
|
});
|
|
|
|
it("permits ordinary same-company agents and rejects task-bridge keys", async () => {
|
|
const f = await fixture();
|
|
const [agent] = await ctx.db.insert(agents).values({ companyId: f.companyId, name: "Reader", role: "engineer", adapterType: "process" }).returning();
|
|
const actor: Express.Request["actor"] = { type: "agent", agentId: agent!.id, companyId: f.companyId, source: "agent_key" };
|
|
const res = await request(app(actor)).get(url(f.companyId)).query({ ids: f.rows[0]!.id }).expect(200);
|
|
expect(res.body).toHaveLength(1);
|
|
await request(app({ ...actor, keyScope: { kind: "task_bridge", issueId: f.rows[0]!.id } } as Express.Request["actor"]))
|
|
.get(url(f.companyId)).query({ ids: f.rows[0]!.id }).expect(403);
|
|
});
|
|
|
|
it("projects conversation readiness changes without advancing the task version", async () => {
|
|
const f = await fixture();
|
|
const [agent] = await ctx.db.insert(agents).values({ companyId: f.companyId, name: "Chat", role: "general", adapterType: "process" }).returning();
|
|
const issue = f.rows[0]!;
|
|
await ctx.db.update(issues).set({ status: "in_review", assigneeAgentId: agent!.id }).where(eq(issues.id, issue.id));
|
|
const [application] = await ctx.db.insert(toolApplications).values({ companyId: f.companyId, name: "Slack", type: "chat" }).returning();
|
|
const connectionId = randomUUID();
|
|
await ctx.db.insert(toolConnections).values({ id: connectionId, companyId: f.companyId, applicationId: application!.id, uid: connectionId, name: "Slack", transport: "chat_sdk", connectionPurpose: "channel" });
|
|
const endpointId = randomUUID();
|
|
await ctx.db.insert(chatEndpoints).values({ id: endpointId, companyId: f.companyId, connectionId, provider: "slack", publicId: endpointId, assignedAgentId: agent!.id, status: "active" });
|
|
const [conversation] = await ctx.db.insert(chatConversations).values({ companyId: f.companyId, endpointId, issueId: issue.id, externalConversationId: "channel", externalThreadId: issue.id, externalLabel: "#summary-test", state: "waiting" }).returning();
|
|
const read = () => request(app(f.actor)).get(url(f.companyId)).query({ ids: issue.id }).expect(200);
|
|
const waiting = (await read()).body[0];
|
|
expect(waiting.externalConversationState).toBe("waiting");
|
|
expect((await issueServices.issueService(ctx.db).getById(issue.id))?.externalConversationState).toBe("waiting");
|
|
await ctx.db.update(chatConversations).set({ state: "active" }).where(eq(chatConversations.id, conversation!.id));
|
|
const active = (await read()).body[0];
|
|
expect(active.externalConversationState).toBe("active");
|
|
expect(active.updatedAt).toBe(waiting.updatedAt);
|
|
});
|
|
|
|
it("projects the covered-blocker state so every task view picks the same queued glyph (BUG-07)", async () => {
|
|
const f = await fixture();
|
|
const [agent] = await ctx.db.insert(agents).values({ companyId: f.companyId, name: "Builder", role: "engineer", adapterType: "process" }).returning();
|
|
const [parent] = await ctx.db.insert(issues).values({ companyId: f.companyId, title: "Parent", status: "blocked" }).returning();
|
|
const [child] = await ctx.db.insert(issues).values({
|
|
companyId: f.companyId, title: "Running child", identifier: "SUM-9", status: "todo", parentId: parent!.id, assigneeAgentId: agent!.id,
|
|
}).returning();
|
|
await ctx.db.insert(issueRelations).values({ companyId: f.companyId, issueId: child!.id, relatedIssueId: parent!.id, type: "blocks" });
|
|
const runId = randomUUID();
|
|
await ctx.db.insert(heartbeatRuns).values({ id: runId, companyId: f.companyId, agentId: agent!.id, status: "running", contextSnapshot: { issueId: child!.id } });
|
|
await ctx.db.update(issues).set({ executionRunId: runId }).where(eq(issues.id, child!.id));
|
|
|
|
const res = await request(app(f.actor)).get(url(f.companyId)).query({ ids: `${parent!.id},${f.rows[0]!.id}` }).expect(200);
|
|
expect(res.body[0].blockerAttention).toMatchObject({ state: "covered", reason: "active_child", sampleBlockerIdentifier: "SUM-9" });
|
|
// Only what the glyph needs: no blocker titles or IDs.
|
|
expect(Object.keys(res.body[0].blockerAttention).sort()).toEqual([
|
|
"attentionBlockerCount", "coveredBlockerCount", "reason", "sampleBlockerIdentifier",
|
|
"sampleStalledBlockerIdentifier", "stalledBlockerCount", "state", "unresolvedBlockerCount",
|
|
]);
|
|
expect(JSON.stringify(res.body)).not.toContain("Running child");
|
|
expect(JSON.stringify(res.body)).not.toContain(child!.id);
|
|
// Unblocked tasks keep the bounded summary shape.
|
|
expect(res.body[1]).not.toHaveProperty("blockerAttention");
|
|
});
|
|
|
|
it("does not disclose a private blocker through a readable blocked task's summary", async () => {
|
|
const f = await fixture();
|
|
const [parent] = await ctx.db.insert(issues).values({ companyId: f.companyId, title: "Public parent", status: "blocked" }).returning();
|
|
const privateId = randomUUID();
|
|
await ctx.db.insert(issues).values({
|
|
id: privateId, companyId: f.companyId, title: "Secret blocker title", status: "todo", visibility: "private",
|
|
privacyRootIssueId: privateId, responsibleUserId: "someone-else", createdByUserId: "someone-else",
|
|
});
|
|
await ctx.db.insert(issueRelations).values({ companyId: f.companyId, issueId: privateId, relatedIssueId: parent!.id, type: "blocks" });
|
|
|
|
const res = await request(app(f.actor)).get(url(f.companyId)).query({ ids: parent!.id }).expect(200);
|
|
expect(res.body).toHaveLength(1);
|
|
expect(res.body[0].blockerAttention?.state).toBeDefined();
|
|
expect(JSON.stringify(res.body)).not.toContain("Secret blocker title");
|
|
expect(JSON.stringify(res.body)).not.toContain(privateId);
|
|
expect(res.body[0].blockerAttention).not.toHaveProperty("terminalBlocker");
|
|
});
|
|
});
|