mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-30 21:49:18 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The board reads API data and keeps the current task on screen. > - A restart or temporary network failure can interrupt those reads. > - Separate page error handlers can hide cached data or expose raw server codes. > - The app needs one connection state, readable error copy and a consistent read policy. > - This change provides that foundation and moves affected read surfaces onto it. > - The dependent write layer in #17960 preserves edits and submissions across the same failures. ## Linked Issues or Issue Description **What happened?** Temporary API failures could replace loaded content with errors. Different surfaces handled the same outage differently. Some showed raw server codes. A successful query to an unrelated service could also falsely report that Paperclip had recovered. **Expected behavior** Keep cached content visible. Show one connection banner during sustained trouble. Confirm recovery through the Paperclip health probe or its WebSocket. Retry transient reads and show readable errors for permanent failures. **Steps to reproduce** 1. Open a populated task or workspace page. 2. Interrupt API requests with a 503 or a dropped connection. 3. Keep an unrelated external request in flight. 4. Confirm that cached content remains and that the external result cannot clear the outage. 5. Restore the API and check that reads refresh. The write layer first merged into this feature branch in #15769 now has its own dependent PR, #17960. This PR contains the shared foundation and read changes. Merge this PR first. ## What Changed - Classify API errors and provide readable error copy, including non-JSON proxy responses and Retry-After handling. - Use one connection store and health probe with bounded backoff. Confirm recovery from the server health probe or live-updates WebSocket. - Pause reads while disconnected, retry transient errors, and refresh active reads after recovery. - Keep cached data visible through shared query views and affected page, panel and plugin read surfaces. - Add one app-level connection banner and support the pending-write count consumed by the dependent write layer. - Add a query-error rendering guard. Call it directly from the existing CI step. Update development documentation. ## Verification - Historical-chat lookup now follows the same ready/stale roster state as rendering. Three regressions fail before the fix; the six new cases pass after it, including working Retry, fresh data, no-cache error, permanent 403 and company isolation. All six focused query/recovery suites pass 200 tests. Final-commit CI passes and Apex is 5/5 with no unresolved findings. Canary Dry Run initially refused a preview version that was already on npm. It passed after one rerun with fresh registry metadata; no check was disabled. - Integrated current master and retained both transcript interest registration and connectivity reporting on socket open. The seven focused recovery/query suites pass 288 tests, and UI typecheck and production build pass. All 9,451 UI tests across 799 files pass on the merge commit. Final-commit CI passes and Apex is 5/5 with no unresolved findings. - Current head `70d9335d732219352ef0f98414439766bbcb33df`: all hosted CI checks pass. Apex is **5/5** on that head with no unresolved findings. The branch has no merge conflict. GitHub still requires code-owner approval. - The foundation passes 9,430 UI tests in 804 files. After integrating current master page paths, 190 focused page tests pass. - Two unrelated-success regressions fail before the latest fix. With the fix, 62 focused UI tests, all six guard tests and UI TypeScript pass. - The composed foundation and write layer pass **9,505 UI tests in 808 files**, UI TypeScript, a production UI build, and query-error, token and map guards. - A real Chromium journey on the composed source injects a 503 during title save. The loaded task stays visible; one reconnect banner appears; the edit saves after recovery; another task stays unchanged; the saved title survives reload. - Full recursive local checks were not repeated because Runner compilation exhausted local disk during another repair. Hosted checks must pass before merge. No new staging deployment is claimed. - Latest review follow-up: a cached CaseDetail now survives a failed HTTP 429 refresh. Its page regression fails before the fix and passes after it. Eighty focused foundation tests, UI TypeScript, build and guards pass after that change. - Earlier CI evidence is retained: several foundation jobs received a runner shutdown signal together. The write-layer head also failed an unchanged Runner descriptor close test with `provider_transport_failed`. The same Runner source passed that suite in the foundation run. New CI runs cover the updated heads; no check or assertion was weakened. ## Risks - Shared retry defaults change the time before transient read errors appear. Permanent errors still fail promptly. - ApiError.message now contains readable copy. Callers that compare raw codes must use ApiError.code. - Cache success can come from another service or local data. It must not confirm Paperclip recovery. - Durable writes are reviewed separately in #17960. This PR does not change database or mutation contracts. ## Model Used Anthropic Claude Opus 5.5 (`claude-opus-5-5`) produced the original work with tool use. OpenAI Codex, GPT-6 family, assisted with restoration, integration, tests and review fixes. The Codex session does not expose its exact serving model ID or context window size. ## 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 - [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: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Amy (Opus) <claude@users.noreply.github.com>
174 lines
6.5 KiB
TypeScript
174 lines
6.5 KiB
TypeScript
/**
|
|
* Plain-language copy for a *failed* issue-thread interaction resolution
|
|
* (PAP-17287).
|
|
*
|
|
* The resolution routes deny with a specific reason — human-only, creator
|
|
* excluded, addressee mismatch, a governed action, an already-resolved card.
|
|
* Collapsing all of that to `Try again` tells an operator to repeat an action
|
|
* that will never succeed, so this module keeps the server's explanation and,
|
|
* for an audience denial, follows it with who *can* respond.
|
|
*
|
|
* Presentation only. Authority is the server's: nothing here decides whether an
|
|
* action is permitted, it only explains the answer the server already gave.
|
|
*/
|
|
|
|
import { describeError, errorCopy, isRawErrorCode, isTransientError } from "@/api/errors";
|
|
import type { InteractionAudienceDescription } from "./interaction-audience";
|
|
|
|
/**
|
|
* Denials that mean "you are outside this card's resolver audience". Mirrors the
|
|
* codes the server's audience evaluator can return
|
|
* (`server/src/services/issue-thread-interaction-resolution.ts`), plus the
|
|
* scope denial raised before it.
|
|
*/
|
|
export const INTERACTION_AUDIENCE_DENIAL_CODES = [
|
|
"interaction_human_only",
|
|
"interaction_creator_excluded",
|
|
"interaction_addressee_mismatch",
|
|
"interaction_governed_action_denied",
|
|
"interaction_run_attribution_required",
|
|
"interaction_scope_denied",
|
|
] as const;
|
|
|
|
/**
|
|
* Denials that are permanent for a different reason: the card moved on. Retrying
|
|
* cannot help, so these lose the retry prompt too.
|
|
*/
|
|
const INTERACTION_SETTLED_CODES = [
|
|
"interaction_not_found",
|
|
"interaction_already_resolved",
|
|
"interaction_superseded",
|
|
"interaction_stale_target",
|
|
"interaction_issue_closed",
|
|
] as const;
|
|
|
|
export type InteractionResolutionFailureKind = "audience_denied" | "settled" | "transient";
|
|
|
|
export interface InteractionResolutionFailure {
|
|
kind: InteractionResolutionFailureKind;
|
|
/** Copy for the inline error region. Never invites a retry that cannot work. */
|
|
message: string;
|
|
/** Server-provided denial code, when the response carried one. */
|
|
code: string | null;
|
|
}
|
|
|
|
function record(value: unknown): Record<string, unknown> | null {
|
|
return value && typeof value === "object" && !Array.isArray(value)
|
|
? value as Record<string, unknown>
|
|
: null;
|
|
}
|
|
|
|
/** The server's `code`, from either the top-level field or the details object. */
|
|
export function interactionResolutionErrorCode(error: unknown): string | null {
|
|
const body = record(record(error)?.body);
|
|
if (!body) return null;
|
|
if (typeof body.code === "string" && body.code) return body.code;
|
|
const details = record(body.details);
|
|
return typeof details?.code === "string" && details.code ? details.code : null;
|
|
}
|
|
|
|
function errorStatus(error: unknown): number | null {
|
|
const status = record(error)?.status;
|
|
return typeof status === "number" ? status : null;
|
|
}
|
|
|
|
/**
|
|
* The server's human-readable reason, preserved verbatim apart from
|
|
* punctuation. A raw code (`tenant_app_unavailable`) is not a reason.
|
|
*/
|
|
function serverReason(error: unknown): string | null {
|
|
const body = record(record(error)?.body);
|
|
const fromBody = typeof body?.error === "string" ? body.error.trim() : "";
|
|
const fromError = error instanceof Error ? error.message.trim() : "";
|
|
const reason = [fromBody, fromError].find((text) => text && !isRawErrorCode(text));
|
|
if (!reason) return null;
|
|
// The API writes reasons as bare clauses ("This interaction is human-only").
|
|
return /[.!?]$/.test(reason) ? reason : `${reason}.`;
|
|
}
|
|
|
|
export function isInteractionAudienceDenial(error: unknown): boolean {
|
|
const code = interactionResolutionErrorCode(error);
|
|
if (code) return (INTERACTION_AUDIENCE_DENIAL_CODES as readonly string[]).includes(code);
|
|
// A 403 with no code is still an authorization refusal, not a hiccup.
|
|
return errorStatus(error) === 403;
|
|
}
|
|
|
|
/** The audience of the card being resolved, as far as this client knows it. */
|
|
export type InteractionResolutionAudience = Pick<
|
|
InteractionAudienceDescription,
|
|
"shortSummary" | "isOpen"
|
|
>;
|
|
|
|
/**
|
|
* Classify a rejected resolution and produce the copy to show inline.
|
|
*
|
|
* `audience` is the effective audience of the card being resolved; when the
|
|
* failure is an audience denial *and* that audience is narrower than the open
|
|
* default, its short form is appended so the reader learns who can respond
|
|
* instead of being told to retry.
|
|
*/
|
|
export function describeInteractionResolutionFailure(
|
|
error: unknown,
|
|
audience?: InteractionResolutionAudience | null,
|
|
): InteractionResolutionFailure {
|
|
const code = interactionResolutionErrorCode(error);
|
|
const reason = serverReason(error);
|
|
|
|
if (isInteractionAudienceDenial(error)) {
|
|
// Only a *narrowed* audience has a responder worth naming. Appending the
|
|
// open-default clause to a refusal produces copy that refutes itself —
|
|
// "You are not in this card's resolver audience. Anyone can respond." —
|
|
// which happens whenever the snapshot the client holds is wider than the
|
|
// policy the server just enforced (PAP-17289).
|
|
const responder = audience && !audience.isOpen && audience.shortSummary
|
|
? `${audience.shortSummary}.`
|
|
: null;
|
|
// Without a code the server has told us only that this is forbidden, not
|
|
// *why*. Restate the status; do not invent a resolver-audience cause it
|
|
// never claimed.
|
|
const coded = code !== null
|
|
&& (INTERACTION_AUDIENCE_DENIAL_CODES as readonly string[]).includes(code);
|
|
return {
|
|
kind: "audience_denied",
|
|
code,
|
|
message: [
|
|
reason
|
|
?? (coded
|
|
? errorCopy("interaction_audience_denied").body
|
|
: errorCopy("interaction_forbidden").body),
|
|
responder,
|
|
]
|
|
.filter(Boolean)
|
|
.join(" "),
|
|
};
|
|
}
|
|
|
|
if (code && (INTERACTION_SETTLED_CODES as readonly string[]).includes(code)) {
|
|
return {
|
|
kind: "settled",
|
|
code,
|
|
message: reason ?? errorCopy("interaction_settled").body,
|
|
};
|
|
}
|
|
|
|
// An outage or gateway blip: the server's text is a status line or a raw
|
|
// code, so use the shared copy (which already invites a retry).
|
|
if (isTransientError(error)) {
|
|
return { kind: "transient", code, message: describeError(error).body };
|
|
}
|
|
|
|
return {
|
|
kind: "transient",
|
|
code,
|
|
message: reason ? `${reason} Try again.` : errorCopy("interaction_submit_failed").body,
|
|
};
|
|
}
|
|
|
|
/** Convenience for the many call sites that only need the sentence. */
|
|
export function interactionResolutionErrorMessage(
|
|
error: unknown,
|
|
audience?: InteractionResolutionAudience | null,
|
|
): string {
|
|
return describeInteractionResolutionFailure(error, audience).message;
|
|
}
|