mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 01:41:42 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The web UI has keyboard shortcuts for the inbox, task lists, cases, and task detail, plus global shortcuts such as `c`, `/`, `?`, `[`, and `]` > - Shortcut enablement was an instance-wide General setting until #14141 moved it to a per-user preference that defaults to off > - The move did not carry the old instance value over, so every existing user lost shortcuts on upgrade and had to find a new toggle under Profile settings > - A toggle that only turns off a standard, input-safe feature costs a setting, a database column, two API routes, and a React context for little benefit > - This pull request removes both the instance setting and the personal preference and enables keyboard shortcuts for every signed-in user > - The benefit is one less thing to configure, no silent loss of shortcuts on upgrade, and less code to maintain ## Linked Issues or Issue Description Refs #14141 (the change that introduced the personal preference). **What existing behavior does this improve?** Keyboard shortcuts in the web UI stay off unless each user turns them on in Profile settings. **Subsystem affected** Web UI shortcuts, Profile settings, instance general settings, the `/api/auth/preferences` routes, and the `user` table. **Current behavior** Shortcuts default to off per user. #14141 moved the toggle from Instance settings → General to Profile settings and did not carry the old instance value over. Users who had shortcuts on lost them after the upgrade and had to find the new toggle. **Proposed behavior** Keyboard shortcuts are always enabled for every signed-in user. There is no instance setting and no personal preference. Shortcuts already ignore key presses inside text inputs and modal dialogs, so an opt-out is not needed. **Reason and benefit** Fewer settings, no silent loss of shortcuts on upgrade, and removal of a database column, two API routes, a query hook, and a React context that existed only to gate this feature. **Breaking changes** `GET` and `PATCH /api/auth/preferences` are removed. `PATCH /api/instance/settings/general` no longer accepts `keyboardShortcuts`; that schema is strict, so the key now returns 400. `instance.general.keyboardShortcuts` is no longer a valid `PAPERCLIP_HIDDEN_SETTINGS` key; the parser ignores unknown keys with a warning. ## What Changed - Removed the Keyboard shortcuts section from Profile settings, the `useUserPreferences` hook, `queryKeys.auth.preferences`, and `authApi.getPreferences` / `authApi.updatePreferences`. - Removed `GeneralSettingsContext`. The inbox, legacy inbox, task list, legacy task list, cases, and task detail pages no longer gate their key handlers. - Removed the `enabled` option from `useKeyboardShortcuts`. The app shell always registers the global shortcuts. - Removed `GET` and `PATCH /api/auth/preferences`, their OpenAPI entries, and the `currentUserPreferencesSchema` / `updateCurrentUserPreferencesSchema` validators. - Removed `keyboardShortcuts` from `InstanceGeneralSettings`, the general settings zod schema, the settings service defaults, and `HIDEABLE_GENERAL_SECTIONS`. - Added migration `0289_drop_user_keyboard_shortcuts`, which drops `user.keyboard_shortcuts`. - Updated `AGENTS.md`, `doc/SPEC.md`, `doc/SPEC-implementation.md`, and `docs/deploy/environment-variables.md`. - Parsed the stored general settings row with `instanceGeneralSettingsSchema.strip()` in the feedback vote path, so a retired key left in the row cannot reset the sharing preference to `prompt` and overwrite the stored choice. - Kept every bare global shortcut (`c`, `?`, `[`, `]`, `/`) out of open modal dialogs in `useKeyboardShortcuts`; only `/` had that guard before. - Updated the affected tests and added a Profile settings test that asserts the toggle is gone, a hook test for the modal dialog guard, and a feedback service regression test for the retired-key case. ## Verification - Typecheck passes for `@paperclipai/shared`, `@paperclipai/db` (including the migration numbering and safety checks), `@paperclipai/server`, and `ui`. - `pnpm exec vitest run server/src/__tests__/instance-settings-routes.test.ts server/src/__tests__/openapi-routes.test.ts server/src/__tests__/auth-routes.test.ts server/src/__tests__/sentry.test.ts` → 119 passed. - `pnpm exec vitest run ui/src/components/Layout.test.tsx ui/src/pages/ProfileSettings.test.tsx ui/src/pages/IssueDetail.test.tsx ui/src/pages/Inbox.test.tsx ui/src/pages/Cases.test.tsx ui/src/hooks/useKeyboardShortcuts.test.tsx ui/src/pages/Agents.test.tsx ui/src/pages/InstanceGeneralSettings.test.tsx` → 286 passed. - `pnpm exec vitest run packages/shared/src/settings-visibility.test.ts` → 16 passed. - `pnpm exec vitest run ui/src/hooks/useKeyboardShortcuts.test.tsx` → 7 passed. - `pnpm exec vitest run server/src/__tests__/feedback-service.test.ts` (embedded Postgres) → the new retired-key test passes with the fix and fails without it. - Manual: sign in with no settings changed, open the inbox, press `j` and `k` to move the selection, press `?` to open the cheatsheet. Open Settings → Profile and confirm there is no Keyboard shortcuts section. ## Risks - The migration drops a column. It uses `DROP COLUMN IF EXISTS`, and the column has no readers after this change. If you roll back to a build from before this PR after the migration has run, re-add the column first: `ALTER TABLE "user" ADD COLUMN "keyboard_shortcuts" boolean DEFAULT false NOT NULL;`. The older build's ORM selects that column when it loads users. - Any external client that still sends `keyboardShortcuts` to `PATCH /api/instance/settings/general` receives a 400. No in-repo client does. - Stored `instance_settings.general.keyboardShortcuts` values are stripped on read and ignored. - Users who never turned the toggle on now get shortcuts. The handlers skip text inputs, contenteditable regions, and modal dialogs, so typing is unaffected. ## Model Used Claude Fable 5.1 (`claude-fable-5-1`) in Claude Code, with extended thinking and tool use. ## 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
278 lines
11 KiB
TypeScript
278 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: "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 an organization 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 an organization to upload an avatar into Paperclip storage.";
|
|
|
|
return (
|
|
<div className="max-w-6xl 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>
|
|
|
|
<InboxAgentPolicyControl companyId={selectedCompanyId} />
|
|
</section>
|
|
</div>
|
|
);
|
|
}
|