mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-29 12:59:13 +01:00
## Thinking Path > - Paperclip is the open source control plane people use to manage AI-agent companies and their work > - The inbox is a per-user attention view, so archiving an item must not alter the underlying issue, assignment, or status > - Agents can help responsible users tidy resolved work only when the action is company-scoped, reversible, policy-controlled, and fully attributable > - The database and authorization foundations landed in #9654 and #9658, but the end-to-end archive routes, audit details, agent workflow guidance, and operator UI still need to ship together > - Separate stacked PRs #9659 and #9661 made the complete behavior harder to review and land as one coherent capability > - This pull request consolidates the remaining server, shared-contract, documentation, skill, and UI work on top of current master > - The benefit is a single reviewable change that lets agents safely archive responsible-user inbox items and lets users control or undo that behavior ## Linked Issues or Issue Description ### Subsystem affected Cross-cutting inbox management across shared contracts, server authorization/routes/services, shipped agent skills, and the board UI. ### Problem or motivation Agents may complete work whose issue remains in the responsible user's Mine inbox. Existing board-user archive behavior does not provide the agent-facing policy endpoints, target resolution, heartbeat-run attribution, typed denials, conservative workflow guidance, or UI needed for safe agent-managed cleanup. ### Proposed solution Allow authorized agents to archive or unarchive responsible-user inbox items under the user's open, allowlist, or disabled policy; preserve actor/agent/run attribution in issue detail and activity records; expose policy controls and agent archive attribution in the UI; and document conservative cleanup rules for agents and PR gardening. ### Alternatives considered - Reuse generic issue mutation permissions: rejected because inbox state belongs to a target user and requires user-scoped authorization. - Automatically archive every completed or closed item: rejected because completion signals can still require human review or a decision. - Keep the backend and UI as separate stacked PRs: superseded by this consolidated PR so the complete user-visible behavior can be reviewed and verified together. ### Related work - Builds on merged foundations #9654 and #9658. - Supersedes the remaining stacked changes in #9659 and #9661. - `ROADMAP.md` has no overlapping inbox archive or inbox authorization initiative. ## What Changed - Added shared inbox-agent policy types and validators plus company-scoped self-service policy routes and OpenAPI coverage. - Enabled agent archive/unarchive mutations with responsible-user targeting, policy enforcement, typed failures, attribution, idempotency, and detailed activity auditing. - Returned agent archive attribution in issue detail and documented reversible inbox cleanup semantics in the implementation spec and Paperclip skill. - Added conservative PR-gardening inbox tidy guidance that keeps GitHub access read-only and avoids archiving work that still needs human action. - Added the Profile settings policy control and Issue Properties attribution/unarchive UI with focused component coverage and narrow-pane handling. ## Verification - `pnpm exec vitest run server/src/__tests__/inbox-archive-routes.test.ts server/src/__tests__/inbox-agent-policy-routes.test.ts server/src/__tests__/authorization-service.test.ts server/src/__tests__/openapi-routes.test.ts ui/src/components/InboxAgentPolicyControl.test.tsx ui/src/components/IssueProperties.test.tsx` — 110 passed. - `pnpm --filter @paperclipai/db exec vitest run src/inbox-archive-agent-policies-migration.test.ts` — 1 passed. - `node --test .agents/skills/pr-gardening/scripts/pr-gardening.test.mjs` — 9 passed. - `pnpm --filter @paperclipai/server typecheck` — passed. - `pnpm --filter @paperclipai/ui typecheck` — passed. - `pnpm check:token-gates` — changed files are clean; the repository-wide command currently reports nine unrelated pre-existing `#9627` literals outside this PR's diff. ## Risks - Agent inbox mutations broaden an existing endpoint path, so authorization and target resolution must remain fail-closed; focused route and authorization tests cover allowed and denied paths. - Archive state affects only the responsible user's inbox presentation and remains reversible; it does not mutate issue status, assignment, or visibility. - The UI policy defaults to the existing open behavior, while allowlist and disabled modes can reduce agent access. - This PR intentionally builds on #9654 and #9658 and contains no new migration number or modification to an already-applied migration. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex using GPT-5.4, medium reasoning, repository tool use, shell execution, code review, and test execution. ## 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 (`feat/inbox-agent-archive-complete`) 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: Paperclip <noreply@paperclip.ing> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
281 lines
11 KiB
TypeScript
281 lines
11 KiB
TypeScript
import { useEffect, useId, useRef, useState } from "react";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import { Camera, LoaderCircle, Save, Trash2, UserRoundPen } from "lucide-react";
|
|
import type { AuthSession, CurrentUserProfile, UpdateCurrentUserProfile } from "@paperclipai/shared";
|
|
import { authApi } from "@/api/auth";
|
|
import { assetsApi } from "@/api/assets";
|
|
import { useBreadcrumbs } from "../context/BreadcrumbContext";
|
|
import { useCompany } from "../context/CompanyContext";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
import { InboxAgentPolicyControl } from "@/components/InboxAgentPolicyControl";
|
|
import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar";
|
|
import { Card } from "@/components/ui/card";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Input } from "@/components/ui/input";
|
|
import { Label } from "@/components/ui/label";
|
|
|
|
function deriveInitials(name: string) {
|
|
const parts = name.trim().split(/\s+/).filter(Boolean);
|
|
if (parts.length >= 2) return `${parts[0]?.[0] ?? ""}${parts[parts.length - 1]?.[0] ?? ""}`.toUpperCase();
|
|
return name.slice(0, 2).toUpperCase();
|
|
}
|
|
|
|
export function ProfileSettings() {
|
|
const { setBreadcrumbs } = useBreadcrumbs();
|
|
const { selectedCompanyId, selectedCompany } = useCompany();
|
|
const queryClient = useQueryClient();
|
|
const avatarInputId = useId();
|
|
const avatarInputRef = useRef<HTMLInputElement | null>(null);
|
|
const [name, setName] = useState("");
|
|
const [image, setImage] = useState("");
|
|
const [actionError, setActionError] = useState<string | null>(null);
|
|
const sessionQuery = useQuery({
|
|
queryKey: queryKeys.auth.session,
|
|
queryFn: () => authApi.getSession(),
|
|
retry: false,
|
|
});
|
|
|
|
useEffect(() => {
|
|
setBreadcrumbs([
|
|
{ label: "Settings", href: "/company/settings" },
|
|
{ label: "Instance settings", href: "/company/settings/instance/general" },
|
|
{ label: "Profile" },
|
|
]);
|
|
}, [setBreadcrumbs]);
|
|
|
|
useEffect(() => {
|
|
const session = sessionQuery.data;
|
|
if (!session) return;
|
|
setName(session.user.name ?? "");
|
|
setImage(session.user.image ?? "");
|
|
}, [sessionQuery.data]);
|
|
|
|
function syncSessionProfile(profile: CurrentUserProfile) {
|
|
queryClient.setQueryData<AuthSession | null>(queryKeys.auth.session, (current) => {
|
|
if (!current) return current;
|
|
return {
|
|
...current,
|
|
user: {
|
|
...current.user,
|
|
...profile,
|
|
},
|
|
};
|
|
});
|
|
}
|
|
|
|
async function persistProfile(input: UpdateCurrentUserProfile) {
|
|
const profile = await authApi.updateProfile(input);
|
|
syncSessionProfile(profile);
|
|
return profile;
|
|
}
|
|
|
|
function resolveProfileName() {
|
|
return name.trim() || sessionQuery.data?.user.name || "Board";
|
|
}
|
|
|
|
const updateMutation = useMutation({
|
|
mutationFn: (input: UpdateCurrentUserProfile) => persistProfile(input),
|
|
onSuccess: (profile) => {
|
|
setActionError(null);
|
|
setName(profile.name ?? "");
|
|
setImage(profile.image ?? "");
|
|
},
|
|
onError: (error) => {
|
|
setActionError(error instanceof Error ? error.message : "Failed to update profile.");
|
|
},
|
|
});
|
|
|
|
const uploadAvatarMutation = useMutation({
|
|
mutationFn: async (file: File) => {
|
|
if (!selectedCompanyId) {
|
|
throw new Error("Select a company before uploading a profile avatar.");
|
|
}
|
|
|
|
const asset = await assetsApi.uploadImage(
|
|
selectedCompanyId,
|
|
file,
|
|
`profiles/${sessionQuery.data?.user.id ?? "board-user"}`,
|
|
);
|
|
return persistProfile({ name: resolveProfileName(), image: asset.contentPath });
|
|
},
|
|
onSuccess: (profile) => {
|
|
setActionError(null);
|
|
setName(profile.name ?? "");
|
|
setImage(profile.image ?? "");
|
|
},
|
|
onError: (error) => {
|
|
setActionError(error instanceof Error ? error.message : "Failed to upload avatar.");
|
|
},
|
|
});
|
|
|
|
const removeAvatarMutation = useMutation({
|
|
mutationFn: () => persistProfile({ name: resolveProfileName(), image: null }),
|
|
onSuccess: (profile) => {
|
|
setActionError(null);
|
|
setName(profile.name ?? "");
|
|
setImage(profile.image ?? "");
|
|
},
|
|
onError: (error) => {
|
|
setActionError(error instanceof Error ? error.message : "Failed to remove avatar.");
|
|
},
|
|
});
|
|
|
|
if (sessionQuery.isLoading) {
|
|
return <div className="text-sm text-muted-foreground">Loading profile...</div>;
|
|
}
|
|
|
|
if (sessionQuery.error || !sessionQuery.data) {
|
|
return (
|
|
<div className="text-sm text-destructive">
|
|
{sessionQuery.error instanceof Error ? sessionQuery.error.message : "Failed to load profile."}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
const currentName = name.trim() || sessionQuery.data.user.name || "Board";
|
|
const currentImage = image.trim() || null;
|
|
const initials = deriveInitials(currentName);
|
|
const isSavingProfile = updateMutation.isPending || uploadAvatarMutation.isPending || removeAvatarMutation.isPending;
|
|
const uploadHint = selectedCompany
|
|
? `Stored in Paperclip file storage for ${selectedCompany.name}.`
|
|
: "Select a company to upload an avatar into Paperclip storage.";
|
|
|
|
return (
|
|
<div className="max-w-4xl space-y-6">
|
|
<div className="space-y-2">
|
|
<div className="flex items-center gap-2">
|
|
<UserRoundPen className="h-5 w-5 text-muted-foreground" />
|
|
<h1 className="text-lg font-semibold">Profile</h1>
|
|
</div>
|
|
<p className="text-sm text-muted-foreground">
|
|
Control how your account appears in the sidebar and other board surfaces.
|
|
</p>
|
|
</div>
|
|
|
|
{actionError ? (
|
|
<div className="rounded-md border border-destructive/40 bg-destructive/5 px-3 py-2 text-sm text-destructive">
|
|
{actionError}
|
|
</div>
|
|
) : null}
|
|
|
|
<section className="space-y-8">
|
|
<Card className="block relative overflow-hidden rounded-(--rad-28) border-border/70">
|
|
<div className="absolute inset-x-0 top-0 h-32 bg-(image:--gradient-extract-26)" />
|
|
<div className="absolute inset-0 bg-(image:--gradient-extract-7)" />
|
|
<div className="relative p-6 pt-10">
|
|
<div className="flex flex-wrap items-end gap-5 rounded-(--rad-24) border border-border/70 bg-background/92 p-5 shadow-(--shadow-extract-18) backdrop-blur-sm">
|
|
<div className="space-y-3">
|
|
<label
|
|
htmlFor={avatarInputId}
|
|
className="group relative block cursor-pointer rounded-full focus-within:outline-none focus-within:ring-2 focus-within:ring-ring focus-within:ring-offset-2 focus-within:ring-offset-background"
|
|
>
|
|
<input
|
|
ref={avatarInputRef}
|
|
id={avatarInputId}
|
|
type="file"
|
|
accept="image/*"
|
|
className="sr-only"
|
|
disabled={!selectedCompanyId || isSavingProfile}
|
|
onChange={(event) => {
|
|
const file = event.target.files?.[0];
|
|
if (!file) return;
|
|
uploadAvatarMutation.mutate(file);
|
|
event.target.value = "";
|
|
}}
|
|
/>
|
|
<span className="absolute inset-0 z-10 rounded-full bg-black/0 transition-colors group-hover:bg-black/14 group-focus-within:bg-black/14" />
|
|
<span className="absolute bottom-1 right-1 z-20 flex size-9 items-center justify-center rounded-full border border-background bg-primary text-primary-foreground shadow-sm">
|
|
{uploadAvatarMutation.isPending ? <LoaderCircle className="size-4 animate-spin" /> : <Camera className="size-4" />}
|
|
</span>
|
|
<Avatar size="lg" className="data-[size=lg]:size-24 ring-4 ring-background shadow-xl">
|
|
{currentImage ? <AvatarImage src={currentImage} alt={currentName} /> : null}
|
|
<AvatarFallback>{initials}</AvatarFallback>
|
|
</Avatar>
|
|
</label>
|
|
<div className="flex flex-wrap items-center gap-2">
|
|
<Button
|
|
type="button"
|
|
variant="secondary"
|
|
onClick={() => avatarInputRef.current?.click()}
|
|
disabled={!selectedCompanyId || isSavingProfile}
|
|
>
|
|
{uploadAvatarMutation.isPending ? <LoaderCircle className="size-4 animate-spin" /> : <Camera className="size-4" />}
|
|
{currentImage ? "Change photo" : "Upload photo"}
|
|
</Button>
|
|
{currentImage ? (
|
|
<Button
|
|
type="button"
|
|
variant="outline"
|
|
onClick={() => removeAvatarMutation.mutate()}
|
|
disabled={isSavingProfile}
|
|
>
|
|
{removeAvatarMutation.isPending ? <LoaderCircle className="size-4 animate-spin" /> : <Trash2 className="size-4" />}
|
|
Remove
|
|
</Button>
|
|
) : null}
|
|
</div>
|
|
</div>
|
|
|
|
<div className="min-w-0 flex-1 space-y-2 pb-1">
|
|
<div>
|
|
<h2 className="truncate text-2xl font-semibold text-foreground">{currentName}</h2>
|
|
<p className="truncate text-sm text-muted-foreground">{sessionQuery.data.user.email ?? "No email"}</p>
|
|
</div>
|
|
<p className="max-w-2xl text-sm leading-6 text-muted-foreground">
|
|
Click the avatar to upload a new image. {uploadHint}
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</Card>
|
|
|
|
<form
|
|
className="grid gap-6 md:grid-cols-2"
|
|
onSubmit={(event) => {
|
|
event.preventDefault();
|
|
updateMutation.mutate({ name: resolveProfileName(), image: image.trim() || null });
|
|
}}
|
|
>
|
|
<div className="space-y-2">
|
|
<Label htmlFor="profile-name">Display name</Label>
|
|
<Input
|
|
id="profile-name"
|
|
value={name}
|
|
onChange={(event) => setName(event.target.value)}
|
|
maxLength={120}
|
|
placeholder="Board"
|
|
/>
|
|
<p className="text-xs text-muted-foreground">
|
|
Shown in the sidebar account footer and comment author surfaces.
|
|
</p>
|
|
</div>
|
|
|
|
<div className="space-y-2">
|
|
<Label htmlFor="profile-email">Email</Label>
|
|
<Input
|
|
id="profile-email"
|
|
value={sessionQuery.data.user.email ?? ""}
|
|
readOnly
|
|
disabled
|
|
/>
|
|
<p className="text-xs text-muted-foreground">
|
|
Email is managed by your auth session and is read-only here.
|
|
</p>
|
|
</div>
|
|
|
|
<div className="md:col-span-2 flex justify-end">
|
|
<Button type="submit" disabled={isSavingProfile || !name.trim()}>
|
|
{updateMutation.isPending ? <LoaderCircle className="size-4 animate-spin" /> : <Save className="size-4" />}
|
|
{updateMutation.isPending ? "Saving..." : "Save profile"}
|
|
</Button>
|
|
</div>
|
|
</form>
|
|
|
|
<Card className="rounded-(--rad-28) border-border/70 p-6">
|
|
<InboxAgentPolicyControl companyId={selectedCompanyId} />
|
|
</Card>
|
|
</section>
|
|
</div>
|
|
);
|
|
}
|