mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-08 12:33:05 +01:00
## Thinking Path > - Paperclip lets people manage agent work through the board. > - The board already retains loaded reads during a temporary server failure. > - Reloading the page removes that in-memory data. > - A deploy can then leave a returning user without the shell or recent tasks. > - This pull request saves an explicit, limited set of reads in the browser. > - Cached identity supports display while fresh session checks protect writes. ## Linked Issues or Issue Description **What happened?** A reload during an API outage loses the board's loaded reads. An automatic worker update can also reload a hidden tab while a write is pending. **Expected behavior** Show the cached shell and recent tasks during a temporary outage. Limit saved content by user, company, age and build. Clear it on sign-out. Wait for a fresh session before sending account-bound writes. Defer automatic reloads while work is pending. **Steps to reproduce** Open a task and settings while online. Return 503 from the API and reload. Restore the API. Sign out and confirm that saved query records are gone. Discover a worker update while offline or during an autosave and confirm that it waits. Stacked on Refs #18822. Related durable-write foundation: Refs #17960. The outage browser suite follows in a separate test PR. ## What Changed - Persist an exact read allowlist through TanStack Query dehydration and hydration. Save shell preferences, company/sidebar data, agent/project lists, plugin UI metadata, the first inbox page, and 20 recent tasks. Task UUID and identifier reads share one recent-task slot. - Namespace records by user and company. Retain eligible reads across normal memory garbage collection, expire each read after 24 hours, and discard them after a build change. Unstamped builds disable hydration and persistence while retaining sign-out cleanup. Use the existing instance-wide plugin contribution query in the user's root record. - Exclude session credentials and bootstrap data, embedded plan documents, comments, preview work products, provider credentials and environment values, browser capabilities, pairing data, other queries, and mutations. Restore only display identity from session data. Preserve safe agent provider/model display fields and configuration object shapes. Apply the projection on save and restore. - Clear saved reads on sign-out, cross-tab account changes, and definitive session denial. Keep revocation working on plain HTTP without crypto.randomUUID. Use per-user revocation revisions to reject delayed writes and stale records. Preserve a newer account. Remove every UUID/identifier projection and nested inbox copy of a denied task. - Detach shared GETs when the account changes or signs out. Load complete, freshly authorized agents before opening bulk settings from a display-only roster. Retire a pending bulk-editor result or error when row, select-all or clear changes the selection, including a clear/reselect of the same agent. - Require a fresh server lookup before account-bound writes, pending task creation, or mounted autosaves resume. This includes automatic task read receipts, inbox archives, workspace preferences and primary-agent choices, with optimistic archive changes gated too. Cancel the old write scope when the verified user changes. Release completed archives through account-independent cleanup without restoring old cached rows; an old operation cannot clear a newer hide flag. Retry unconfirmed read receipts after a fresh session succeeds for the original account, and remember confirmed receipts across refreshes. Track pending reads per task so opening another task sends its receipt immediately; revisiting reuses an outstanding receipt and its original account scope. - Defer a hidden-tab worker reload until connectivity, mutations, durable sends, and autosaves are safe. Synchronously count each unresolved operation across online rate-limit retries. Release a cancelled target’s unused dirty token when an editor changes tasks; keep stored drafts, admitted saves and queued retries. Cover autosave debounce, newer edits, navigation and undo. ## Verification - Current head `fe4f682c879` is merge-ready: all 54 check runs completed (52 successful, one skipped, one neutral), the legacy Snyk status is successful, and both `ci / verify` and `ci / e2e` pass in run `41752927822`. Greptile Apex reviewed this exact head at 5/5 with zero unresolved threads; the branch has no merge conflicts. All three PRs now meet the merge-ready bar; the stack remains unmerged pending operator approval. - Greptile Apex reviewed exact current head `fe4f682c879` at 5/5 with no actionable findings and zero unresolved threads (summary updated 2026-11-04 at 01:24:40 UTC). Both settings-account and pending-selection findings are fixed, replied to and resolved. The branch has no merge conflicts. Current-head CI now passes in run `41752927822`. - Seventeen new cases cover settings restored from actual saved query records, matching/changed/signed-out identities, denied verification, late crown responses without overwriting newer reads, and bulk-selection changes during successful/failed reads. Sixteen fail the preceding source and one preserves denial compatibility. Both settings paths reuse the existing account-bound mutation guard; its optional explicit QueryClient supports the workspace hook’s existing detached-host mode. Primary-agent optimistic updates begin only after verification and cleanup checks ownership and the cache revision. - Earlier CI run `41749456480` on prior head `2cf7516f18c` has one real server test failure: the owned-runtime case in `idle-completed-history.test.ts` could not reach its HTTP child on port 34757 within 10 seconds (99 refused probes). Its other 1,829 cases pass and three skip; the only other unsuccessful job is the downstream `verify` gate. The exact selected case passes locally, and the entire 75-case file passes in 72.19 seconds on the exact `2cf7516f18c` source tree with isolated PostgreSQL and a real child process on macOS arm64/Node 25.6.1. The Linux CI startup cause remains unknown; these local results are not a fix or CI acceptance. One failed-jobs retry with debug logging was accepted on that unchanged head, then superseded by the later settings fixes. Current-head CI remains required; no source change was made for this failure. - Current cache head `fe4f682c879`, based on read head `09d1db29dea` and master `683fa4725e9`, passes all 1,198 focused tests across twenty-eight files, UI typecheck, token gates and the enforcing query-error guard. Dependent browser head `228c1b68d30` contains this exact application source and passes standalone strict checking of all three browser specs. Current-head CI now passes in run `41752927822`. - Three new navigation regressions fail the preceding application source and pass with the fix. They open three cached tasks before any receipt resolves, leave the page before success or failure, revisit an outstanding read without duplicating it, and recover an older failed receipt after a fresh session succeeds while a later task remains pending. - The fixture repair passes all seven deadline integration cases and the complete server typecheck, including the server test layer. The old assertion deterministically fails at 23:59:06.888 UTC; its one-second-old run also fails the first-second-of-day probe. The corrected fixture passes noon and both midnight probes. The permanent three-case coverage uses seeded 2099 clocks. - Nine new cases cover archive success/failure after sign-out and another account takes over, both mounted and unmounted; cleanup ownership when a newer archive uses the same task; session-check 429 exhaustion followed by matching, changed or signed-out identity; and a failed read receipt followed by a new session read. They verify no old-cache restoration, toast or navigation, retained newer hide flags, no failed-check loop and no duplicate confirmed receipt. Seven fail the previous implementation; two compatibility cases retain account-change suppression. Initial test error-constructor and query-notification timing assumptions were corrected before the passing checks. - The inherited skills/app error-priority fix passes all 60 affected tests and UI typecheck on both application branches. Its twelve new regression cases fail the preceding read implementation. The persisted-cache suite includes 48 cases. - Six new regressions fail against the preceding application source and pass with the fix. Actual worker-update and mutation-cache listeners cannot reload a hidden tab between online 429 retries; the original create key survives, and the update reloads once after a receipt. Real self-hosted and Cloud sign-out work without crypto.randomUUID, with stamped and unstamped builds. Saved reads are removed and account write scopes are invalidated. An initial test-fixture type annotation error was corrected before the passing typecheck. - The 48 cache tests cover actual five-minute memory GC, the 20-task bound across saved and live reads, original 24-hour expiry, denial before session verification, unstamped cleanup, cross-tab revocation and delayed flushes. Private GETs cannot cross account transitions. Bulk edits require complete current agent data. Undo releases the update blocker while preserving the Saved indicator. - All 23 built-UI outage/write/loading cases pass in 4.5 minutes on exact integrated head `228c1b68d30`, containing current cache revision `fe4f682c879`: ten outage, six durable-write and seven loading cases. The run uses bundled Chromium, the built UI, a fresh local-trusted server and isolated embedded PostgreSQL on macOS arm64/Node 25.6.1. All three specs pass standalone strict TypeScript checking. Owned temporary server and database stopped. - Earlier browser runs exposed and fixed cached-header, native Storage cleanup and replay/session defects. A prior run passed 21/22 because real WebSockets contradicted the simulated HTTP outage; the fixture now closes existing socket pairs and holds new sockets through the same outage deadline. An older CI run exposed a disposed response in the Inbox route callback; pre-navigation snapshots remove that lifetime, and the current full run includes that repair. Earlier failures and their diagnosis remain in the discussion. The current full run passes. Broader historical workspace failures remain documented in Refs #18822; this does not claim a clean full workspace suite. - Current-head CI passes on `fe4f682c879`. Controlled local outages do not complete hosted authentication or a real Cloud restart/deploy acceptance. Commands for the current cache change and inherited read fix (the current focused run also includes src/lib/inboxArchiveCache.test.ts and src/pages/Inbox.test.ts): ```sh pnpm --filter @paperclipai/ui exec vitest run src/pages/CompanySkills.test.tsx src/pages/apps/AppNotConnected.test.tsx pnpm --filter @paperclipai/ui exec vitest run src/hooks/useDurableSubmit.test.tsx src/hooks/useDurableAutosave.test.tsx src/hooks/useSignOut.test.tsx src/lib/persisted-query-cache.test.ts src/lib/service-worker-updates.test.ts src/lib/service-worker-cache-policy.test.ts src/lib/pending-send.test.ts src/lib/issue-execution-policy.test.ts src/components/InlineEditor.test.tsx src/components/MarkdownEditor.test.tsx src/components/NewIssueDialog.test.tsx pnpm --filter @paperclipai/ui exec vitest run src/components/agents/AgentBulkRoster.test.tsx src/components/agents/AgentBulkSettingsSheet.test.tsx src/hooks/useAccountBoundMutation.test.tsx src/pages/IssueDetail.test.tsx src/components/TaskChatThread.test.tsx src/components/TaskChatThread.task-creation-order.test.tsx src/api/client.test.ts src/api/agents.test.ts pnpm --filter @paperclipai/ui exec vitest run src/hooks/useCoordinatorWorkspaceEnabled.test.tsx src/context/PrimaryAgentProvider.test.tsx src/components/CoordinatorWorkspaceSetting.test.tsx src/components/primary-agent/PrimaryAgentPresentation.test.tsx src/components/MobileBottomNav.coordinator.test.tsx src/components/CoordinatorSidebar.test.tsx src/pages/Issues.coordinator-routing.test.tsx pnpm --filter @paperclipai/ui typecheck pnpm check:token-gates node scripts/check-query-error-rendering.mjs --enforce --summary ``` ## Risks This deliberately saves task content on the local browser for up to 24 hours. The allowlist excludes credentials and ephemeral capabilities. Local storage can be disabled or full; persistence then fails without blocking the app. Restored data can be stale and never grants server access. A user or access change clears cached account reads and invalidates pending writes. The browser outage suite and real hosted deploy acceptance remain release requirements. There are no migrations or new dependencies. ## Model Used OpenAI `gpt-6.1-sol` through Codex, with xhigh reasoning effort, tool use, and code execution. The context window size is not exposed. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used - [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 described the issue in-PR following the bug report template - [x] I have not referenced internal/instance-local Paperclip issues or links - [x] My branch name describes the change and contains no internal ticket id - [x] The focused local tests for this change pass - [x] I have added tests and updated relevant documentation - [x] I have considered and documented risks above - [x] All Paperclip CI gates are green - [x] 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: devinfoley <139239+devinfoley@users.noreply.github.com> Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Bender (Fable) <bender@agents.paperclip.ing> Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
196 lines
11 KiB
TypeScript
196 lines
11 KiB
TypeScript
// @vitest-environment jsdom
|
|
import { act, useState } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { PrimaryAgentProvider } from "./PrimaryAgentProvider";
|
|
import { usePrimaryAgentPresentation } from "@/components/primary-agent/PrimaryAgentPresentation";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { startPersistedQueryCache } from "@/lib/persisted-query-cache";
|
|
import { ApiError } from "@/api/client";
|
|
|
|
const state = vi.hoisted(() => ({
|
|
companyId: "company-a", get: vi.fn(), set: vi.fn(), session: vi.fn(), toast: vi.fn(),
|
|
}));
|
|
vi.mock("./CompanyContext", () => ({ useCompany: () => ({ selectedCompanyId: state.companyId }) }));
|
|
vi.mock("./ToastContext", () => ({ useToastActions: () => ({ pushToast: state.toast }) }));
|
|
vi.mock("@/api/auth", () => ({ authApi: { getSession: state.session } }));
|
|
vi.mock("@/api/primaryAgent", () => ({ primaryAgentApi: { get: state.get, set: state.set } }));
|
|
vi.mock("@/api/agents", () => ({ agentsApi: { list: async (companyId: string) => [
|
|
{ id: "maia", name: "Maia", companyId, status: "idle" },
|
|
{ id: "alex", name: "Alex", companyId, status: "idle" },
|
|
] } }));
|
|
|
|
let root: Root, container: HTMLDivElement, client: QueryClient;
|
|
let cache: ReturnType<typeof startPersistedQueryCache> | undefined;
|
|
const preference = (companyId = "company-a", userId = "user-a", primaryAgentId: string | null = "maia") => ({
|
|
companyId, userId, primaryAgentId, initialized: true,
|
|
});
|
|
function Harness() {
|
|
const value = usePrimaryAgentPresentation(state.companyId);
|
|
const [onboarding, setOnboarding] = useState(false);
|
|
return <>
|
|
<output>{value?.loading ? "loading" : value?.error ? "error" : value?.primaryAgentId ?? "none"}</output>
|
|
<button onClick={() => value?.onChange("alex")}>Choose Alex</button>
|
|
<button onClick={() => value?.onRetry?.()}>Retry</button>
|
|
<button onClick={() => setOnboarding(true)}>Continue onboarding</button>
|
|
{onboarding ? <aside>Onboarding is open</aside> : null}
|
|
<span data-pending>{value?.pendingAgentId ?? "none"}</span>
|
|
</>;
|
|
}
|
|
async function render() {
|
|
await act(async () => root.render(<QueryClientProvider client={client}><PrimaryAgentProvider><Harness /></PrimaryAgentProvider></QueryClientProvider>));
|
|
}
|
|
async function waitForOutput(text: string) {
|
|
await vi.waitFor(async () => {
|
|
await act(async () => { await new Promise(resolve => setTimeout(resolve, 0)); });
|
|
expect(container.querySelector("output")?.textContent).toBe(text);
|
|
});
|
|
}
|
|
beforeEach(() => {
|
|
localStorage.clear();
|
|
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
|
|
state.companyId = "company-a";
|
|
state.get.mockReset().mockResolvedValue(preference());
|
|
state.set.mockReset(); state.toast.mockReset();
|
|
state.session.mockReset().mockResolvedValue({ user: { id: "user-a" } });
|
|
client = new QueryClient({ defaultOptions: { queries: { retry: false }, mutations: { retry: false } } });
|
|
container = document.createElement("div"); document.body.append(container); root = createRoot(container);
|
|
});
|
|
afterEach(async () => {
|
|
await act(async () => root.unmount()); cache?.dispose(); cache = undefined; client.clear(); container.remove(); localStorage.clear(); vi.unstubAllGlobals();
|
|
});
|
|
|
|
function restorePreference() {
|
|
const source = new QueryClient();
|
|
source.setQueryData(queryKeys.auth.session, { user: { id: "user-a" } });
|
|
source.setQueryData(queryKeys.companies.list("user-a"), { companies: [{ id: "company-a", name: "Example" }], unauthorized: false });
|
|
source.setQueryData(queryKeys.primaryAgent.mine("company-a", "user-a"), preference());
|
|
const saved = startPersistedQueryCache(source, { storage: localStorage, buildId: "test", eventTarget: null });
|
|
saved.flush(); saved.dispose(); source.clear();
|
|
cache = startPersistedQueryCache(client, { storage: localStorage, buildId: "test", eventTarget: null });
|
|
expect(client.getQueryData(queryKeys.primaryAgent.mine("company-a", "user-a"))).toEqual(preference());
|
|
}
|
|
|
|
describe("primary agent persistence provider", () => {
|
|
it.each(["user-a", "user-b", null])("waits for fresh identity before changing a restored primary agent (verified=%s)", async verified => {
|
|
let finish!: (value: { user: { id: string } } | null) => void;
|
|
state.session.mockReturnValue(new Promise(resolve => { finish = resolve; }));
|
|
state.set.mockResolvedValue(preference("company-a", "user-a", "alex"));
|
|
restorePreference();
|
|
await render(); await waitForOutput("maia");
|
|
await act(async () => container.querySelector("button")!.click());
|
|
try {
|
|
expect(state.set).not.toHaveBeenCalled();
|
|
expect(client.getQueryData(queryKeys.primaryAgent.mine("company-a", "user-a"))).toEqual(preference());
|
|
} finally {
|
|
state.get.mockResolvedValue(preference("company-a", verified ?? "local-board", verified === "user-a" ? "alex" : null));
|
|
await act(async () => finish(verified ? { user: { id: verified } } : null));
|
|
}
|
|
await vi.waitFor(() => expect(client.isMutating()).toBe(0));
|
|
expect(state.set).toHaveBeenCalledTimes(verified === "user-a" ? 1 : 0);
|
|
if (verified === "user-a") await waitForOutput("alex");
|
|
else expect(state.toast).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not change a restored primary agent when fresh session verification is denied", async () => {
|
|
let deny!: (error: Error) => void;
|
|
state.session.mockReturnValue(new Promise((_resolve, reject) => { deny = reject; }));
|
|
restorePreference();
|
|
await render(); await waitForOutput("maia");
|
|
await act(async () => container.querySelector("button")!.click());
|
|
await act(async () => deny(new ApiError("Sign in again", 401, {})));
|
|
await vi.waitFor(() => expect(client.isMutating()).toBe(0));
|
|
expect(state.set).not.toHaveBeenCalled();
|
|
expect(state.toast).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("optimistically switches, restores the previous crown on failure, and offers a working retry", async () => {
|
|
let reject!: (error: Error) => void;
|
|
state.set.mockImplementationOnce(() => new Promise((_resolve, onReject) => { reject = onReject; }));
|
|
await render(); await waitForOutput("maia");
|
|
await act(async () => container.querySelector("button")!.click());
|
|
await waitForOutput("alex");
|
|
await act(async () => reject(new Error("Connection lost")));
|
|
await waitForOutput("maia");
|
|
expect(state.toast).toHaveBeenCalledWith(expect.objectContaining({ tone: "error", body: "Connection lost" }));
|
|
state.get.mockResolvedValue(preference("company-a", "user-a", "alex"));
|
|
state.set.mockResolvedValue(preference("company-a", "user-a", "alex"));
|
|
await act(async () => state.toast.mock.calls[0][0].action.onClick());
|
|
await waitForOutput("alex");
|
|
expect(state.set).toHaveBeenLastCalledWith("company-a", { primaryAgentId: "alex" });
|
|
});
|
|
|
|
it("keeps cached preferences separate across companies and users", async () => {
|
|
await render(); await waitForOutput("maia");
|
|
state.companyId = "company-b";
|
|
state.get.mockResolvedValue(preference("company-b", "user-a", "alex"));
|
|
await render(); await waitForOutput("alex");
|
|
state.get.mockResolvedValue(preference("company-b", "user-b", null));
|
|
await act(async () => client.setQueryData(queryKeys.auth.session, { user: { id: "user-b" } }));
|
|
await waitForOutput("none");
|
|
expect(client.getQueryData(queryKeys.primaryAgent.mine("company-a", "user-a"))).toEqual(preference());
|
|
expect(client.getQueryData(queryKeys.primaryAgent.mine("company-b", "user-a"))).toEqual(preference("company-b", "user-a", "alex"));
|
|
expect(client.getQueryData(queryKeys.primaryAgent.mine("company-b", "user-b"))).toEqual(preference("company-b", "user-b", null));
|
|
});
|
|
|
|
it("preserves app and onboarding state when the company or authenticated user changes", async () => {
|
|
await render(); await waitForOutput("maia");
|
|
await act(async () => container.querySelectorAll("button")[2].click());
|
|
state.companyId = "company-b";
|
|
state.get.mockResolvedValue(preference("company-b", "user-a", "alex"));
|
|
await render(); await waitForOutput("alex");
|
|
expect(container.querySelector("aside")?.textContent).toBe("Onboarding is open");
|
|
state.get.mockResolvedValue(preference("company-b", "user-b", null));
|
|
await act(async () => client.setQueryData(queryKeys.auth.session, { user: { id: "user-b" } }));
|
|
await waitForOutput("none");
|
|
expect(container.querySelector("aside")?.textContent).toBe("Onboarding is open");
|
|
});
|
|
|
|
it("keeps a late mutation failure in its original company and user scope", async () => {
|
|
let reject!: (error: Error) => void;
|
|
state.set.mockImplementationOnce(() => new Promise((_resolve, onReject) => { reject = onReject; }));
|
|
await render(); await waitForOutput("maia");
|
|
await act(async () => container.querySelector("button")!.click());
|
|
await waitForOutput("alex");
|
|
state.companyId = "company-b";
|
|
state.get.mockResolvedValue(preference("company-b", "user-b", null));
|
|
await act(async () => client.setQueryData(queryKeys.auth.session, { user: { id: "user-b" } }));
|
|
await render(); await waitForOutput("none");
|
|
expect(container.querySelector("[data-pending]")?.textContent).toBe("none");
|
|
await act(async () => reject(new Error("Old request failed")));
|
|
await waitForOutput("none");
|
|
expect(client.getQueryData(queryKeys.primaryAgent.mine("company-a", "user-a"))).toEqual(preference());
|
|
expect(client.getQueryData(queryKeys.primaryAgent.mine("company-b", "user-b"))).toEqual(preference("company-b", "user-b", null));
|
|
expect(state.toast).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it.each(["success", "failure"] as const)("preserves a newer crown read when an old account's save finishes with %s", async outcome => {
|
|
let finish!: (value: ReturnType<typeof preference>) => void, reject!: (error: Error) => void;
|
|
state.set.mockReturnValue(new Promise((resolve, fail) => { finish = resolve; reject = fail; }));
|
|
await render(); await waitForOutput("maia");
|
|
await act(async () => container.querySelector("button")!.click());
|
|
await waitForOutput("alex");
|
|
const key = queryKeys.primaryAgent.mine("company-a", "user-a");
|
|
await act(async () => {
|
|
client.setQueryData(queryKeys.auth.session, { user: { id: "user-b" } });
|
|
client.setQueryData(queryKeys.auth.session, { user: { id: "user-a" } });
|
|
client.setQueryData(key, preference("company-a", "user-a", "alex"));
|
|
if (outcome === "success") finish(preference("company-a", "user-a", "alex"));
|
|
else reject(new Error("Old request failed"));
|
|
});
|
|
await vi.waitFor(() => expect(client.isMutating()).toBe(0));
|
|
expect(client.getQueryData(key)).toEqual(preference("company-a", "user-a", "alex"));
|
|
expect(state.toast).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("retries session failures before fetching a personal preference", async () => {
|
|
state.session.mockRejectedValueOnce(new Error("Session unavailable"));
|
|
await render(); await waitForOutput("error");
|
|
expect(state.get).not.toHaveBeenCalled();
|
|
await act(async () => container.querySelectorAll("button")[1].click());
|
|
await waitForOutput("maia");
|
|
expect(state.session).toHaveBeenCalledTimes(2);
|
|
});
|
|
});
|