mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 19:35:13 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - This change touches several already-shipped subsystems — document-comment annotations, the selected-agent Conference Room chat surface, routine description annotations, workspace-operation tracking, and the board polling/inbox UI > - A batch of incremental fixes and two small backend additions had accumulated on a local mainline and were deployed to a live instance, but never landed upstream — so each `origin/master` sync kept re-diverging > - Leaving them un-upstreamed means the same delta has to be re-merged on every sync and risks being lost or silently reverted > - This pull request rebases that delta cleanly on top of current `origin/master` (preserving recent upstream work such as reusable sandbox leases and the relation-list collapse controls) and brings it up for review > - The benefit is that mainline and the deployed instance converge, and these fixes/additions get normal review + CI + Greptile coverage ## Linked Issues or Issue Description No single GitHub issue tracks this; it is a bundle of bug fixes and two small feature additions. Following the issue-template fields: **Bug fixes (what was wrong → what this does):** - Document comments rendered out of document order, didn't live-update across clients, swallowed save failures, and lost the markdown text selection on re-render. Now: doc-order sort, live updates, surfaced save-failure state, stable selection across re-renders. - The board polling hot path returned oversized payloads on every poll. Now: an opt-in `summary` projection trims the heartbeat-run list payload. - Assorted UI fixes: sidebar nav peek/streamlining edge cases, markdown file-viewer re-mount/line-height issues on iOS Safari, inbox badge/skill deep-link tab selection, and `⌘.` work-mode cycling on iOS. **Feature additions:** - `workspace_operations.issue_id` — associate a workspace operation with the issue that triggered it (new migration `0106`, schema, service, shared type). - Routine **description annotations** — comment threads on a routine's description document, mirroring issue document annotations (new migration `0107`, `routine_documents` schema, routes/service, editable-sections UI). - Selected-agent **Conference Room chat** surface wiring and live issue-thread updates. **Related PR:** #8229 (`feat(control-plane): add annotation and workspace controls`, draft) covers overlapping annotation/workspace-control territory — flagging it so a reviewer can reconcile the two rather than double-merging. ## What Changed - `feat(workspace)`: `workspace_operations.issue_id` migration + schema/service/type; issue workspace property controls reconciled with upstream's evolved "Service" row. - `feat(routines)`: routine description annotations — `routine_documents` schema, migration `0107`, routes/service, `editable-sections` UI. - `fix(document-comments)`: doc-order sort, live updates, save-failure surfacing, stable markdown selection (+ storybook story, rerender test). - `feat(chat)`: selected-agent Conference Room chat surface and live issue-thread updates (`LiveUpdatesProvider`, `issue-chat-messages`, interactions service). - `perf(board)`: opt-in `summary` projection for the board polling/heartbeat-run list payload, plus assorted sidebar / file-viewer / inbox / IssueProperties UI fixes. Organized into 5 logical commits. Migrations are numbered incrementally after upstream's latest (`0105`) — `0106` then `0107`, no journal collision. ## Verification - Built by 3-way merging the deployed delta onto current `origin/master`; the only merge conflict (`IssueProperties.test.tsx`, two adjacent test blocks) was resolved in favor of upstream's evolved "green service link above the workspace row" layout, which matches the merged component's rendered output. - Confirmed recent upstream work is preserved post-merge: reusable sandbox lease teardown (`#8513`), the IssueProperties relation-list collapse controls, and the sidebar streamlined-nav default. - Confirmed the net diff vs `origin/master` is exactly the intended feature delta (65 files) and that overlapping server files (`issues.ts`, `agents.ts`, `heartbeat.ts`) only add feature code without disturbing upstream logic. - This delta is already running on a live deployed instance. - Full typecheck/test suite + Greptile to run in CI (see checklist). ## Risks - Two new migrations (`0106`, `0107`). Both are additive (new table / new nullable column) and ordered after upstream's `0105`; no data backfill, low risk. If another migration-bearing PR merges first, renumber before merge. - Largest blast radius is in the merged overlapping UI/service files; covered by the existing test suites for those files plus CI. - Overlaps thematically with draft PR #8229 — reviewers should reconcile rather than merge both blindly. ## Model Used Claude Opus 4.8 (`claude-opus-4-8`), extended thinking, with tool use (git, shell). Agentic coding workflow. ## 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) - [ ] 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 - [ ] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
218 lines
6.6 KiB
TypeScript
218 lines
6.6 KiB
TypeScript
import { useEffect, useMemo, useState } from "react";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import { accessApi } from "../api/access";
|
|
import { ApiError } from "../api/client";
|
|
import { inboxDismissalsApi } from "../api/inboxDismissals";
|
|
import { approvalsApi } from "../api/approvals";
|
|
import { authApi } from "../api/auth";
|
|
import { dashboardApi } from "../api/dashboard";
|
|
import { heartbeatsApi } from "../api/heartbeats";
|
|
import { issuesApi } from "../api/issues";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import {
|
|
buildInboxDismissedAtByKey,
|
|
computeInboxBadgeData,
|
|
getRecentTouchedIssues,
|
|
loadDismissedInboxAlerts,
|
|
saveDismissedInboxAlerts,
|
|
loadReadInboxItems,
|
|
saveReadInboxItems,
|
|
READ_ITEMS_KEY,
|
|
} from "../lib/inbox";
|
|
|
|
const INBOX_ISSUE_STATUSES = "backlog,todo,in_progress,in_review,blocked,done";
|
|
const INBOX_BADGE_ISSUE_LIMIT = 500;
|
|
const INBOX_BADGE_HEARTBEAT_RUN_LIMIT = 200;
|
|
const INBOX_BADGE_HOT_PATH_STALE_MS = 30_000;
|
|
|
|
export function useDismissedInboxAlerts() {
|
|
const [dismissed, setDismissed] = useState<Set<string>>(loadDismissedInboxAlerts);
|
|
|
|
useEffect(() => {
|
|
const handleStorage = (event: StorageEvent) => {
|
|
if (event.key !== "paperclip:inbox:dismissed") return;
|
|
setDismissed(loadDismissedInboxAlerts());
|
|
};
|
|
window.addEventListener("storage", handleStorage);
|
|
return () => window.removeEventListener("storage", handleStorage);
|
|
}, []);
|
|
|
|
const dismiss = (id: string) => {
|
|
setDismissed((prev) => {
|
|
const next = new Set(prev);
|
|
next.add(id);
|
|
saveDismissedInboxAlerts(next);
|
|
return next;
|
|
});
|
|
};
|
|
|
|
return { dismissed, dismiss };
|
|
}
|
|
|
|
export function useInboxDismissals(companyId: string | null | undefined) {
|
|
const queryClient = useQueryClient();
|
|
const queryKey = companyId
|
|
? queryKeys.inboxDismissals(companyId)
|
|
: ["inbox-dismissals", "__disabled__"] as const;
|
|
|
|
const { data: dismissals = [] } = useQuery({
|
|
queryKey,
|
|
queryFn: () => inboxDismissalsApi.list(companyId!),
|
|
enabled: !!companyId,
|
|
});
|
|
|
|
const dismissMutation = useMutation({
|
|
mutationFn: ({ itemKey }: { itemKey: string }) => inboxDismissalsApi.dismiss(companyId!, itemKey),
|
|
onMutate: async ({ itemKey }) => {
|
|
if (!companyId) return { previous: [] as typeof dismissals };
|
|
await queryClient.cancelQueries({ queryKey });
|
|
const previous = queryClient.getQueryData<typeof dismissals>(queryKey) ?? [];
|
|
const now = new Date();
|
|
queryClient.setQueryData(queryKey, [
|
|
{
|
|
id: `optimistic:${itemKey}`,
|
|
companyId,
|
|
userId: "me",
|
|
itemKey,
|
|
dismissedAt: now,
|
|
createdAt: now,
|
|
updatedAt: now,
|
|
},
|
|
...previous.filter((dismissal) => dismissal.itemKey !== itemKey),
|
|
]);
|
|
return { previous };
|
|
},
|
|
onError: (_error, _variables, context) => {
|
|
if (!context) return;
|
|
queryClient.setQueryData(queryKey, context.previous);
|
|
},
|
|
onSettled: () => {
|
|
if (!companyId) return;
|
|
queryClient.invalidateQueries({ queryKey });
|
|
queryClient.invalidateQueries({ queryKey: queryKeys.sidebarBadges(companyId) });
|
|
},
|
|
});
|
|
|
|
const dismissedAtByKey = useMemo(
|
|
() => buildInboxDismissedAtByKey(dismissals),
|
|
[dismissals],
|
|
);
|
|
|
|
return {
|
|
dismissals,
|
|
dismissedAtByKey,
|
|
dismiss: (itemKey: string) => dismissMutation.mutate({ itemKey }),
|
|
isPending: dismissMutation.isPending,
|
|
};
|
|
}
|
|
|
|
export function useReadInboxItems() {
|
|
const [readItems, setReadItems] = useState<Set<string>>(loadReadInboxItems);
|
|
|
|
useEffect(() => {
|
|
const handleStorage = (event: StorageEvent) => {
|
|
if (event.key !== READ_ITEMS_KEY) return;
|
|
setReadItems(loadReadInboxItems());
|
|
};
|
|
window.addEventListener("storage", handleStorage);
|
|
return () => window.removeEventListener("storage", handleStorage);
|
|
}, []);
|
|
|
|
const markRead = (id: string) => {
|
|
setReadItems((prev) => {
|
|
const next = new Set(prev);
|
|
next.add(id);
|
|
saveReadInboxItems(next);
|
|
return next;
|
|
});
|
|
};
|
|
|
|
const markUnread = (id: string) => {
|
|
setReadItems((prev) => {
|
|
const next = new Set(prev);
|
|
next.delete(id);
|
|
saveReadInboxItems(next);
|
|
return next;
|
|
});
|
|
};
|
|
|
|
return { readItems, markRead, markUnread };
|
|
}
|
|
|
|
export function useInboxBadge(companyId: string | null | undefined) {
|
|
const { dismissed: dismissedAlerts } = useDismissedInboxAlerts();
|
|
const { dismissedAtByKey } = useInboxDismissals(companyId);
|
|
const { data: session } = useQuery({
|
|
queryKey: queryKeys.auth.session,
|
|
queryFn: () => authApi.getSession(),
|
|
});
|
|
|
|
const { data: approvals = [] } = useQuery({
|
|
queryKey: queryKeys.approvals.list(companyId!),
|
|
queryFn: () => approvalsApi.list(companyId!),
|
|
enabled: !!companyId,
|
|
});
|
|
|
|
const { data: joinRequests = [] } = useQuery({
|
|
queryKey: queryKeys.access.joinRequests(companyId!),
|
|
queryFn: async () => {
|
|
try {
|
|
return await accessApi.listJoinRequests(companyId!, "pending_approval");
|
|
} catch (err) {
|
|
if (err instanceof ApiError && (err.status === 401 || err.status === 403)) {
|
|
return [];
|
|
}
|
|
throw err;
|
|
}
|
|
},
|
|
enabled: !!companyId,
|
|
retry: false,
|
|
});
|
|
|
|
const { data: dashboard } = useQuery({
|
|
queryKey: queryKeys.dashboard(companyId!),
|
|
queryFn: () => dashboardApi.summary(companyId!),
|
|
enabled: !!companyId,
|
|
});
|
|
|
|
const { data: mineIssuesRaw = [] } = useQuery({
|
|
queryKey: queryKeys.issues.listMineByMe(companyId!),
|
|
queryFn: () =>
|
|
issuesApi.list(companyId!, {
|
|
touchedByUserId: "me",
|
|
inboxArchivedByUserId: "me",
|
|
status: INBOX_ISSUE_STATUSES,
|
|
limit: INBOX_BADGE_ISSUE_LIMIT,
|
|
}),
|
|
enabled: !!companyId,
|
|
refetchOnWindowFocus: false,
|
|
staleTime: INBOX_BADGE_HOT_PATH_STALE_MS,
|
|
});
|
|
|
|
const mineIssues = useMemo(() => getRecentTouchedIssues(mineIssuesRaw), [mineIssuesRaw]);
|
|
const currentUserId = session?.user.id ?? session?.session.userId ?? null;
|
|
|
|
const { data: heartbeatRuns = [] } = useQuery({
|
|
queryKey: [...queryKeys.heartbeats(companyId!), "limit", INBOX_BADGE_HEARTBEAT_RUN_LIMIT],
|
|
queryFn: () => heartbeatsApi.list(companyId!, undefined, INBOX_BADGE_HEARTBEAT_RUN_LIMIT, { summary: true }),
|
|
enabled: !!companyId,
|
|
refetchOnWindowFocus: false,
|
|
staleTime: INBOX_BADGE_HOT_PATH_STALE_MS,
|
|
});
|
|
|
|
return useMemo(
|
|
() =>
|
|
computeInboxBadgeData({
|
|
approvals,
|
|
joinRequests,
|
|
dashboard,
|
|
heartbeatRuns,
|
|
mineIssues,
|
|
dismissedAlerts,
|
|
dismissedAtByKey,
|
|
currentUserId,
|
|
}),
|
|
[approvals, joinRequests, dashboard, heartbeatRuns, mineIssues, dismissedAlerts, dismissedAtByKey, currentUserId],
|
|
);
|
|
}
|