mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-09 07:10:34 +01:00
## Thinking Path > - Paperclip lets people manage agent work through the board. > - The board reads task, agent, settings, plugin, and run data from the server. > - A deploy can interrupt those reads after content is already visible. > - Local error branches can replace that content with an error or show raw codes. > - This pull request moves the remaining reads to the shared recovery behavior. > - The query-error guard prevents new local error patterns from returning. ## Linked Issues or Issue Description **What happened?** Loaded lists, settings, task panels, and manual reads could clear their content or show errors during a server restart. Some reads also disabled the shared retry policy. **Expected behavior** Keep loaded content during a temporary failure. Show the shared connection banner. Retry reads after recovery. Replace content after a real access denial or missing resource, with readable copy. **Steps to reproduce** Open a task, settings page, or run log. Return 503 with `tenant_app_unavailable` from the API. Restore the API and check that content refreshes. Repeat with 403 and 404 to check the failure state. Related merged work: Refs #15754, Refs #15772, Refs #17960. This change covers remaining reads and enforcement. Browser persistence and the outage browser suite follow separately. ## What Changed - Repair an existing PostgreSQL deadline fixture at UTC boundaries. A daily cap defers a heartbeat until both its original interval and the next UTC day allow it. Keep the counted run in its seeded day and cover noon, just before midnight and the first second after midnight with explicit clocks and real PostgreSQL. Production scheduling is unchanged. - Integrate the saved list, settings, shell, task, and manual-read recovery changes against current master. Preserve the current task, Inbox, and run-log structure. - Add `useResilientFetch` for component-local reads. Preserve loaded data, cancel stale requests, and retry through the shared connectivity policy. Keep browser and pairing capabilities in memory. - Retain run log chunks across stream changes and catch up after recovery without duplicate chunks or stalled requests. - Keep genuine authorization and missing-resource failures visible. Translate known single-word codes such as `forbidden`. Show known skills and disconnected-app failures before sibling loading states. Keep Retry bound to its failed request. - Make the query-error guard enforce by default and run it in the CI policy job. Document the narrow exceptions and the read recovery contract. - Invalidate pending OAuth discovery when the operator leaves setup or its context changes. Keep reserved-popup cleanup bound to the current attempt. ## Verification - Current read head `09d1db29dea` is merge-ready: all 59 check runs are completed (54 successful, three skipped, two neutral), the legacy Snyk status is successful, and both required `ci / verify` and `ci / e2e` gates pass. Greptile Apex reviewed this exact head at 5/5 with no unresolved threads; the branch has no merge conflicts. The current CI run is `41748339602`. - Current read head `09d1db29dea` includes master `683fa4725e9`. The latest change touches only the existing server deadline test fixture. Application source remains the previously verified `86376fa751e` revision: all 60 affected skills/disconnected-app tests and both application UI typechecks passed, along with token gates and the enforcing query-error guard. Those UI suites were not repeated for this test-only repair. - 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. - Twelve new regressions fail against the previous implementation. Both skills variants and disconnected-app pages show either request's 403 or 429 while the sibling pauses or remains fetching. Permission failures stay visible. Retry stays usable for its failed request and recovers independently. An initial test-fixture query-key typo was corrected before the passing run. The finding is replied to and resolved. Greptile reviewed prior application revision `86376fa751e` at 5/5 with no new actionable findings or unresolved threads. The current test-only head has now received its own Apex 5/5 review with no unresolved threads, and its CI is successful as recorded above. - The preceding OAuth fix passed all 237 setup tests on both application branches. Its ten regressions prove that Back, Cancel, unmount, or context changes retire initial discovery without creating a connection, caching old identities, navigating an abandoned popup, or closing a newer attempt. - Earlier master integration `e992f770339` passed all 309 tests across eight affected Slack, recovery, retry, submission and task files, plus UI typecheck, token gates, enforcing query-error scan and seven guard tests. The integration preserves Slack workspace reconnect and shared recovery, readable execution errors, source-inspection company scoping, and current submission behavior. Newly inherited retained-file recovery controls keep cached data through transient failures and hide it after definitive denial. - The preceding cache head `97c0bc3966f` passed 1,038 focused cache/write/editor/account/task/API tests. All 22 built-UI outage/write/loading cases passed in 4.7 minutes on exact browser head `b7deaaee5da`, with strict checking of all three specs. The latest skills/app rendering fix is covered by its affected component suites; those broader cases were not repeated for this separate read path. - Historical broader UI, CLI and build results and unresolved aggregate server/DB/adapter failures remain in the PR discussion. Interrupted CI runs were audited and recorded separately; they are not counted as passes. Controlled local outages do not prove hosted authentication or a real Cloud restart/deploy. Real hosted acceptance remains required after merge and deployment. Commands for the latest fix: ```sh pnpm --filter @paperclipai/ui exec vitest run src/pages/CompanySkills.test.tsx src/pages/apps/AppNotConnected.test.tsx pnpm --filter @paperclipai/ui typecheck pnpm check:token-gates node scripts/check-query-error-rendering.mjs --enforce --summary ``` ## Risks This migration touches many read surfaces. The main risks are initial loading, request cancellation, retained authorization state, and run-log paging. The tests cover those states. There are no server, schema, dependency, or API contract changes. The follow-up browser suite and hosted deploy acceptance are required before release acceptance. Recovered commits retain their original authors. If squash-merging, preserve `Co-Authored-By: Bender (Fable) <bender@agents.paperclip.ing>` and the Paperclip trailer. ## 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. Saved source commits keep their original authorship. ## 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 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 affected local tests pass; broader limitations are recorded above - [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 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>
399 lines
16 KiB
TypeScript
399 lines
16 KiB
TypeScript
import { useEffect, useState } from "react";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import type { PatchInstanceGeneralSettings, BackupRetentionPolicy } from "@paperclipai/shared";
|
|
import {
|
|
DAILY_RETENTION_PRESETS,
|
|
WEEKLY_RETENTION_PRESETS,
|
|
MONTHLY_RETENTION_PRESETS,
|
|
DEFAULT_BACKUP_RETENTION,
|
|
} from "@paperclipai/shared";
|
|
import { LogOut, SlidersHorizontal } from "lucide-react";
|
|
import { describeError } from "@/api/errors";
|
|
import { healthApi } from "@/api/health";
|
|
import { instanceSettingsApi } from "@/api/instanceSettings";
|
|
import { QueryErrorState, useQueryView } from "@/components/QueryView";
|
|
import { ModeBadge } from "@/components/access/ModeBadge";
|
|
import { Button } from "../components/ui/button";
|
|
import { useBreadcrumbs } from "../context/BreadcrumbContext";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import { ToggleSwitch } from "@/components/ui/toggle-switch";
|
|
import { cn } from "../lib/utils";
|
|
import { useSignOut } from "@/hooks/useSignOut";
|
|
|
|
const FEEDBACK_TERMS_URL = import.meta.env.VITE_FEEDBACK_TERMS_URL?.trim() || "https://paperclip.ing/tos";
|
|
|
|
export function InstanceGeneralSettings({ embedded = false }: { embedded?: boolean }) {
|
|
const { setBreadcrumbs } = useBreadcrumbs();
|
|
const queryClient = useQueryClient();
|
|
const [actionError, setActionError] = useState<string | null>(null);
|
|
|
|
const signOutMutation = useSignOut();
|
|
|
|
useEffect(() => {
|
|
if (embedded) return;
|
|
setBreadcrumbs([
|
|
{ label: "Settings", href: "/company/settings" },
|
|
{ label: "General" },
|
|
]);
|
|
}, [embedded, setBreadcrumbs]);
|
|
|
|
const generalQuery = useQuery({
|
|
queryKey: queryKeys.instance.generalSettings,
|
|
queryFn: () => instanceSettingsApi.getGeneral(),
|
|
});
|
|
const generalView = useQueryView(generalQuery);
|
|
const healthQuery = useQuery({
|
|
queryKey: queryKeys.health,
|
|
queryFn: () => healthApi.get(),
|
|
});
|
|
|
|
const updateGeneralMutation = useMutation({
|
|
mutationFn: instanceSettingsApi.updateGeneral,
|
|
onMutate: () => {
|
|
setActionError(null);
|
|
signOutMutation.reset();
|
|
},
|
|
onSuccess: async () => {
|
|
setActionError(null);
|
|
signOutMutation.reset();
|
|
await queryClient.invalidateQueries({ queryKey: queryKeys.instance.generalSettings });
|
|
},
|
|
onError: (error) => {
|
|
setActionError(describeError(error).body);
|
|
},
|
|
});
|
|
|
|
if (generalQuery.isLoading || generalView.kind === "reconnecting" || healthQuery.isLoading) {
|
|
return <div className="text-sm text-muted-foreground">Loading general settings...</div>;
|
|
}
|
|
|
|
if (generalView.kind === "error") {
|
|
return (
|
|
<QueryErrorState
|
|
size={embedded ? "panel" : "page"}
|
|
error={generalQuery.error}
|
|
action="load general settings"
|
|
onRetry={generalView.retry}
|
|
retrying={generalView.isFetching}
|
|
/>
|
|
);
|
|
}
|
|
|
|
const censorUsernameInLogs = generalQuery.data?.censorUsernameInLogs === true;
|
|
const feedbackDataSharingPreference = generalQuery.data?.feedbackDataSharingPreference ?? "prompt";
|
|
const backupRetention: BackupRetentionPolicy = generalQuery.data?.backupRetention ?? DEFAULT_BACKUP_RETENTION;
|
|
const hiddenSettings = new Set(healthQuery.data?.hiddenSettings ?? []);
|
|
const showDeploymentStatus = !hiddenSettings.has("instance.general.deploymentStatus");
|
|
const showCensorUsernameInLogs = !hiddenSettings.has("instance.general.censorUsernameInLogs");
|
|
const showBackupRetention = !hiddenSettings.has("instance.general.backupRetention");
|
|
const showFeedbackDataSharing = !hiddenSettings.has("instance.general.feedbackDataSharingPreference");
|
|
const showSignOut = !hiddenSettings.has("instance.general.signOut");
|
|
const visibleTopics = [
|
|
...(showCensorUsernameInLogs ? ["log display"] : []),
|
|
...(showBackupRetention ? ["backup retention"] : []),
|
|
...(showFeedbackDataSharing ? ["data sharing"] : []),
|
|
];
|
|
const topicSummary = visibleTopics.length > 2
|
|
? `${visibleTopics.slice(0, -1).join(", ")}, and ${visibleTopics[visibleTopics.length - 1]}`
|
|
: visibleTopics.join(" and ");
|
|
const visibleActionError = signOutMutation.error
|
|
? describeError(signOutMutation.error).body
|
|
: actionError;
|
|
|
|
return (
|
|
<div className={embedded ? "space-y-8" : "max-w-4xl space-y-8"}>
|
|
{!embedded ? (
|
|
<div className="space-y-2">
|
|
<div className="flex items-center gap-2">
|
|
<SlidersHorizontal className="h-5 w-5 text-muted-foreground" />
|
|
<h1 className="text-lg font-semibold">General</h1>
|
|
</div>
|
|
<p className="text-sm text-muted-foreground">
|
|
Configure instance-wide preferences
|
|
{visibleTopics.length > 0 ? <> including {topicSummary}</> : null}.
|
|
</p>
|
|
</div>
|
|
) : null}
|
|
|
|
{visibleActionError && (
|
|
<div className="rounded-md border border-destructive/40 bg-destructive/5 px-3 py-2 text-sm text-destructive">
|
|
{visibleActionError}
|
|
</div>
|
|
)}
|
|
|
|
{showDeploymentStatus && (
|
|
<section>
|
|
<div className="space-y-3">
|
|
<div className="flex items-center gap-2">
|
|
<h2 className="text-sm font-semibold">Deployment and auth</h2>
|
|
<ModeBadge
|
|
deploymentMode={healthQuery.data?.deploymentMode}
|
|
deploymentExposure={healthQuery.data?.deploymentExposure}
|
|
/>
|
|
</div>
|
|
<div className="text-sm text-muted-foreground">
|
|
{healthQuery.data?.deploymentMode === "local_trusted"
|
|
? "Local trusted mode is optimized for a local operator. Browser requests run as local board context and no sign-in is required."
|
|
: healthQuery.data?.deploymentExposure === "public"
|
|
? "Authenticated public mode requires sign-in for board access and is intended for public URLs."
|
|
: "Authenticated private mode requires sign-in and is intended for LAN, VPN, or other private-network deployments."}
|
|
</div>
|
|
<div className="grid gap-3 md:grid-cols-3">
|
|
<StatusBox
|
|
label="Auth readiness"
|
|
value={healthQuery.data?.authReady ? "Ready" : "Not ready"}
|
|
/>
|
|
<StatusBox
|
|
label="Bootstrap status"
|
|
value={healthQuery.data?.bootstrapStatus === "bootstrap_pending" ? "Setup required" : "Ready"}
|
|
/>
|
|
<StatusBox
|
|
label="Bootstrap invite"
|
|
value={healthQuery.data?.bootstrapInviteActive ? "Active" : "None"}
|
|
/>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
)}
|
|
|
|
{showCensorUsernameInLogs && (
|
|
<section>
|
|
<div className="flex items-start justify-between gap-4">
|
|
<div className="space-y-1.5">
|
|
<h2 className="text-sm font-semibold">Censor username in logs</h2>
|
|
<p className="max-w-2xl text-sm text-muted-foreground">
|
|
Hide the username segment in home-directory paths and similar operator-visible log output. Standalone
|
|
username mentions outside of paths are not yet masked in the live transcript view. This is off by
|
|
default.
|
|
</p>
|
|
</div>
|
|
<ToggleSwitch
|
|
checked={censorUsernameInLogs}
|
|
onCheckedChange={() => updateGeneralMutation.mutate({ censorUsernameInLogs: !censorUsernameInLogs })}
|
|
disabled={updateGeneralMutation.isPending || signOutMutation.isPending}
|
|
aria-label="Toggle username log censoring"
|
|
/>
|
|
</div>
|
|
</section>
|
|
)}
|
|
|
|
{showBackupRetention && (
|
|
<section>
|
|
<div className="space-y-5">
|
|
<div className="space-y-1.5">
|
|
<h2 className="text-sm font-semibold">Backup retention</h2>
|
|
<p className="max-w-2xl text-sm text-muted-foreground">
|
|
Configure how long automatic database backups are retained. Backups run roughly
|
|
every hour and are compressed with gzip. Within the daily window all backups are
|
|
kept; beyond that, one backup per week and one per month are preserved.
|
|
</p>
|
|
</div>
|
|
|
|
<div className="space-y-1.5">
|
|
<h3 className="text-xs font-medium text-muted-foreground uppercase tracking-wide">Daily</h3>
|
|
<div className="flex flex-wrap gap-2">
|
|
{DAILY_RETENTION_PRESETS.map((days) => {
|
|
const active = backupRetention.dailyDays === days;
|
|
return (
|
|
<button
|
|
key={days}
|
|
type="button"
|
|
disabled={updateGeneralMutation.isPending || signOutMutation.isPending}
|
|
className={cn(
|
|
"rounded-lg border px-3 py-2 text-left transition-colors disabled:cursor-not-allowed disabled:opacity-60",
|
|
active
|
|
? "border-foreground bg-accent text-foreground"
|
|
: "border-border bg-background hover:bg-accent/50",
|
|
)}
|
|
onClick={() =>
|
|
updateGeneralMutation.mutate({
|
|
backupRetention: { ...backupRetention, dailyDays: days },
|
|
})
|
|
}
|
|
>
|
|
<div className="text-sm font-medium">{days} days</div>
|
|
</button>
|
|
);
|
|
})}
|
|
</div>
|
|
</div>
|
|
|
|
<div className="space-y-1.5">
|
|
<h3 className="text-xs font-medium text-muted-foreground uppercase tracking-wide">Weekly</h3>
|
|
<div className="flex flex-wrap gap-2">
|
|
{WEEKLY_RETENTION_PRESETS.map((weeks) => {
|
|
const active = backupRetention.weeklyWeeks === weeks;
|
|
const label = weeks === 1 ? "1 week" : `${weeks} weeks`;
|
|
return (
|
|
<button
|
|
key={weeks}
|
|
type="button"
|
|
disabled={updateGeneralMutation.isPending || signOutMutation.isPending}
|
|
className={cn(
|
|
"rounded-lg border px-3 py-2 text-left transition-colors disabled:cursor-not-allowed disabled:opacity-60",
|
|
active
|
|
? "border-foreground bg-accent text-foreground"
|
|
: "border-border bg-background hover:bg-accent/50",
|
|
)}
|
|
onClick={() =>
|
|
updateGeneralMutation.mutate({
|
|
backupRetention: { ...backupRetention, weeklyWeeks: weeks },
|
|
})
|
|
}
|
|
>
|
|
<div className="text-sm font-medium">{label}</div>
|
|
</button>
|
|
);
|
|
})}
|
|
</div>
|
|
</div>
|
|
|
|
<div className="space-y-1.5">
|
|
<h3 className="text-xs font-medium text-muted-foreground uppercase tracking-wide">Monthly</h3>
|
|
<div className="flex flex-wrap gap-2">
|
|
{MONTHLY_RETENTION_PRESETS.map((months) => {
|
|
const active = backupRetention.monthlyMonths === months;
|
|
const label = months === 1 ? "1 month" : `${months} months`;
|
|
return (
|
|
<button
|
|
key={months}
|
|
type="button"
|
|
disabled={updateGeneralMutation.isPending || signOutMutation.isPending}
|
|
className={cn(
|
|
"rounded-lg border px-3 py-2 text-left transition-colors disabled:cursor-not-allowed disabled:opacity-60",
|
|
active
|
|
? "border-foreground bg-accent text-foreground"
|
|
: "border-border bg-background hover:bg-accent/50",
|
|
)}
|
|
onClick={() =>
|
|
updateGeneralMutation.mutate({
|
|
backupRetention: { ...backupRetention, monthlyMonths: months },
|
|
})
|
|
}
|
|
>
|
|
<div className="text-sm font-medium">{label}</div>
|
|
</button>
|
|
);
|
|
})}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
)}
|
|
|
|
{showFeedbackDataSharing && (
|
|
<section>
|
|
<div className="space-y-4">
|
|
<div className="space-y-1.5">
|
|
<h2 className="text-sm font-semibold">AI feedback sharing</h2>
|
|
<p className="max-w-2xl text-sm text-muted-foreground">
|
|
Control whether thumbs up and thumbs down votes can send the voted AI output to
|
|
Paperclip Labs. Votes are always saved locally.
|
|
</p>
|
|
{FEEDBACK_TERMS_URL ? (
|
|
<a
|
|
href={FEEDBACK_TERMS_URL}
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
className="inline-flex text-sm text-muted-foreground underline underline-offset-4 hover:text-foreground"
|
|
>
|
|
Read our terms of service
|
|
</a>
|
|
) : null}
|
|
</div>
|
|
{feedbackDataSharingPreference === "prompt" ? (
|
|
<div className="rounded-lg bg-accent/20 px-3 py-2 text-sm text-muted-foreground">
|
|
No default is saved yet. The next thumbs up or thumbs down choice will ask once and
|
|
then save the answer here.
|
|
</div>
|
|
) : null}
|
|
<div className="flex flex-wrap gap-2">
|
|
{[
|
|
{
|
|
value: "allowed",
|
|
label: "Always allow",
|
|
description: "Share voted AI outputs automatically.",
|
|
},
|
|
{
|
|
value: "not_allowed",
|
|
label: "Don't allow",
|
|
description: "Keep voted AI outputs local only.",
|
|
},
|
|
].map((option) => {
|
|
const active = feedbackDataSharingPreference === option.value;
|
|
return (
|
|
<button
|
|
key={option.value}
|
|
type="button"
|
|
disabled={updateGeneralMutation.isPending || signOutMutation.isPending}
|
|
className={cn(
|
|
"rounded-lg border px-3 py-2 text-left transition-colors disabled:cursor-not-allowed disabled:opacity-60",
|
|
active
|
|
? "border-foreground bg-accent text-foreground"
|
|
: "border-border bg-background hover:bg-accent/50",
|
|
)}
|
|
onClick={() =>
|
|
updateGeneralMutation.mutate({
|
|
feedbackDataSharingPreference: option.value as
|
|
| "allowed"
|
|
| "not_allowed",
|
|
})
|
|
}
|
|
>
|
|
<div className="text-sm font-medium">{option.label}</div>
|
|
<div className="text-xs text-muted-foreground">
|
|
{option.description}
|
|
</div>
|
|
</button>
|
|
);
|
|
})}
|
|
</div>
|
|
<p className="text-xs text-muted-foreground">
|
|
To retest the first-use prompt in local dev, remove the{" "}
|
|
<code>feedbackDataSharingPreference</code> key from the{" "}
|
|
<code>instance_settings.general</code> JSON row for this instance, or set it back to{" "}
|
|
<code>"prompt"</code>. Unset and <code>"prompt"</code> both mean no default has been
|
|
chosen yet.
|
|
</p>
|
|
</div>
|
|
</section>
|
|
|
|
)}
|
|
|
|
{showSignOut && (
|
|
<section>
|
|
<div className="flex items-start justify-between gap-4">
|
|
<div className="space-y-1.5">
|
|
<h2 className="text-sm font-semibold">Sign out</h2>
|
|
<p className="max-w-2xl text-sm text-muted-foreground">
|
|
Sign out of this Paperclip instance. You will be redirected to the login page.
|
|
</p>
|
|
</div>
|
|
<Button
|
|
variant="outline"
|
|
size="sm"
|
|
disabled={signOutMutation.isPending || updateGeneralMutation.isPending}
|
|
onClick={() => {
|
|
setActionError(null);
|
|
signOutMutation.mutate();
|
|
}}
|
|
>
|
|
<LogOut className="size-4" />
|
|
{signOutMutation.isPending ? "Signing out..." : "Sign out"}
|
|
</Button>
|
|
</div>
|
|
</section>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function StatusBox({ label, value }: { label: string; value: string }) {
|
|
return (
|
|
<div className="space-y-1">
|
|
<div className="text-xs font-medium uppercase tracking-wide text-muted-foreground">{label}</div>
|
|
<div className="text-sm font-medium">{value}</div>
|
|
</div>
|
|
);
|
|
}
|