Files
PaperClipAI/ui/src/pages/InstanceGeneralSettings.test.tsx
T
Devin Foley f38b5693f6 fix: always enable keyboard shortcuts (#14643)
## 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
2026-09-29 21:28:06 -07:00

270 lines
10 KiB
TypeScript

// @vitest-environment jsdom
import { flushSync } from "react-dom";
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 { queryKeys } from "@/lib/queryKeys";
import { InstanceGeneralSettings } from "./InstanceGeneralSettings";
const mockAuthApi = vi.hoisted(() => ({ signOut: vi.fn() }));
const mockHealthApi = vi.hoisted(() => ({ get: vi.fn() }));
const mockInstanceSettingsApi = vi.hoisted(() => ({
getGeneral: vi.fn(),
updateGeneral: vi.fn(),
}));
const mockNavigateTopLevel = vi.hoisted(() => vi.fn());
vi.mock("@/api/auth", () => ({ authApi: mockAuthApi }));
vi.mock("@/api/health", () => ({ healthApi: mockHealthApi }));
vi.mock("@/api/instanceSettings", () => ({ instanceSettingsApi: mockInstanceSettingsApi }));
vi.mock("@/lib/browserNavigation", () => ({ navigateTopLevel: mockNavigateTopLevel }));
vi.mock("../context/BreadcrumbContext", () => ({
useBreadcrumbs: () => ({ setBreadcrumbs: vi.fn() }),
}));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
const SELF_HOSTED_HEALTH = {
status: "ok" as const,
deploymentMode: "authenticated" as const,
deploymentExposure: "private" as const,
authReady: true,
bootstrapStatus: "ready" as const,
bootstrapInviteActive: false,
};
const CLOUD_HEALTH = {
...SELF_HOSTED_HEALTH,
cloud: {
managed: true as const,
managedBy: "paperclip-cloud" as const,
stackSlug: "acme",
cloudBaseUrl: "https://cloud.example.test",
},
};
describe("InstanceGeneralSettings sign-out", () => {
let container: HTMLDivElement;
let root: Root | null;
let queryClient: QueryClient;
beforeEach(() => {
container = document.createElement("div");
document.body.appendChild(container);
root = null;
queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
mockInstanceSettingsApi.getGeneral.mockResolvedValue({
censorUsernameInLogs: false,
feedbackDataSharingPreference: "not_allowed",
backupRetention: { dailyDays: 7, weeklyWeeks: 4, monthlyMonths: 1 },
});
mockInstanceSettingsApi.updateGeneral.mockResolvedValue(undefined);
mockAuthApi.signOut.mockResolvedValue({ success: true });
});
afterEach(() => {
flushSync(() => root?.unmount());
queryClient.clear();
container.remove();
vi.clearAllMocks();
});
async function renderPage(health: typeof SELF_HOSTED_HEALTH | typeof CLOUD_HEALTH) {
mockHealthApi.get.mockResolvedValue(health);
queryClient.setQueryData(queryKeys.health, health);
root = createRoot(container);
flushSync(() => {
root?.render(
<QueryClientProvider client={queryClient}>
<InstanceGeneralSettings />
</QueryClientProvider>,
);
});
await vi.waitFor(() => expect(container.textContent).toContain("Deployment and auth"));
expect(container.querySelector('[data-slot="card"]')).toBeNull();
}
function signOutButton() {
return Array.from(container.querySelectorAll("button"))
.find((button) => button.textContent?.trim() === "Sign out");
}
it("uses the Cloud-managed top-level logout without calling local auth", async () => {
await renderPage(CLOUD_HEALTH);
flushSync(() => signOutButton()?.click());
await vi.waitFor(() => expect(mockNavigateTopLevel).toHaveBeenCalledOnce());
expect(mockNavigateTopLevel).toHaveBeenCalledWith("/cloud/logout");
expect(mockAuthApi.signOut).not.toHaveBeenCalled();
});
it("keeps authenticated self-hosted sign-out local and drops the account caches", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
await renderPage(SELF_HOSTED_HEALTH);
queryClient.setQueryData(queryKeys.auth.session, { session: { id: "session-1" } });
queryClient.setQueryData(queryKeys.companies.all, {
companies: [{ id: "company-a", name: "Account A Co" }],
unauthorized: false,
});
flushSync(() => signOutButton()?.click());
await vi.waitFor(() => expect(mockAuthApi.signOut).toHaveBeenCalledOnce());
// Account-scoped entries are cleared outright, not marked stale — a stale
// entry keeps serving the previous account's data until a refetch succeeds.
await vi.waitFor(() =>
expect(queryClient.getQueryData(queryKeys.auth.session)).toBeUndefined(),
);
expect(queryClient.getQueryData(queryKeys.companies.all)).toBeUndefined();
// Health describes the instance, so it is refreshed rather than dropped.
expect(invalidateQueries).toHaveBeenCalledWith({ queryKey: queryKeys.health });
expect(queryClient.getQueryData(queryKeys.health)).toEqual(SELF_HOSTED_HEALTH);
expect(mockNavigateTopLevel).not.toHaveBeenCalled();
});
it("shows a current sign-out failure instead of a stale settings error", async () => {
mockInstanceSettingsApi.updateGeneral.mockRejectedValue(new Error("Settings update failed"));
mockAuthApi.signOut.mockRejectedValue(new Error("Sign-out request failed"));
await renderPage(SELF_HOSTED_HEALTH);
const censorToggle = container.querySelector<HTMLButtonElement>(
'[aria-label="Toggle username log censoring"]',
);
flushSync(() => censorToggle?.click());
await vi.waitFor(() => expect(container.textContent).toContain("Settings update failed"));
flushSync(() => signOutButton()?.click());
await vi.waitFor(() => expect(container.textContent).toContain("Sign-out request failed"));
expect(container.textContent).not.toContain("Settings update failed");
});
it("clears a stale sign-out failure after a settings update succeeds", async () => {
mockAuthApi.signOut.mockRejectedValue(new Error("Sign-out request failed"));
await renderPage(SELF_HOSTED_HEALTH);
flushSync(() => signOutButton()?.click());
await vi.waitFor(() => expect(container.textContent).toContain("Sign-out request failed"));
const censorToggle = container.querySelector<HTMLButtonElement>(
'[aria-label="Toggle username log censoring"]',
);
flushSync(() => censorToggle?.click());
await vi.waitFor(() => expect(mockInstanceSettingsApi.updateGeneral).toHaveBeenCalledOnce());
await vi.waitFor(() => expect(container.textContent).not.toContain("Sign-out request failed"));
});
it("disables settings changes while sign-out is pending", async () => {
let resolveSignOut: ((result: { success: boolean }) => void) | undefined;
mockAuthApi.signOut.mockImplementation(
() => new Promise<{ success: boolean }>((resolve) => {
resolveSignOut = resolve;
}),
);
await renderPage(SELF_HOSTED_HEALTH);
const censorToggle = container.querySelector<HTMLButtonElement>(
'[aria-label="Toggle username log censoring"]',
);
flushSync(() => signOutButton()?.click());
await vi.waitFor(() => expect(mockAuthApi.signOut).toHaveBeenCalledOnce());
expect(censorToggle?.disabled).toBe(true);
flushSync(() => censorToggle?.click());
expect(mockInstanceSettingsApi.updateGeneral).not.toHaveBeenCalled();
resolveSignOut?.({ success: true });
await vi.waitFor(() => expect(censorToggle?.disabled).toBe(false));
});
it("disables sign-out while a settings update is pending", async () => {
let resolveSettings: (() => void) | undefined;
mockInstanceSettingsApi.updateGeneral.mockImplementation(
() => new Promise<void>((resolve) => {
resolveSettings = resolve;
}),
);
await renderPage(SELF_HOSTED_HEALTH);
const censorToggle = container.querySelector<HTMLButtonElement>(
'[aria-label="Toggle username log censoring"]',
);
flushSync(() => censorToggle?.click());
await vi.waitFor(() => expect(mockInstanceSettingsApi.updateGeneral).toHaveBeenCalledOnce());
expect(signOutButton()?.disabled).toBe(true);
flushSync(() => signOutButton()?.click());
expect(mockAuthApi.signOut).not.toHaveBeenCalled();
resolveSettings?.();
await vi.waitFor(() => expect(signOutButton()?.disabled).toBe(false));
});
});
describe("InstanceGeneralSettings operator-hidden sections", () => {
let container: HTMLDivElement;
let root: Root | null;
let queryClient: QueryClient;
beforeEach(() => {
container = document.createElement("div");
document.body.appendChild(container);
root = null;
queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
mockInstanceSettingsApi.getGeneral.mockResolvedValue({
censorUsernameInLogs: false,
feedbackDataSharingPreference: "not_allowed",
backupRetention: { dailyDays: 7, weeklyWeeks: 4, monthlyMonths: 1 },
});
});
afterEach(() => {
flushSync(() => root?.unmount());
queryClient.clear();
container.remove();
vi.clearAllMocks();
});
async function renderPage(health: Record<string, unknown>) {
mockHealthApi.get.mockResolvedValue(health);
queryClient.setQueryData(queryKeys.health, health);
root = createRoot(container);
flushSync(() => {
root?.render(
<QueryClientProvider client={queryClient}>
<InstanceGeneralSettings />
</QueryClientProvider>,
);
});
await vi.waitFor(() => expect(container.textContent).toContain("Backup retention"));
}
it("hides an operator-hidden field-backed section and a UI-only section", async () => {
await renderPage({
...SELF_HOSTED_HEALTH,
hiddenSettings: [
"instance.general.censorUsernameInLogs",
"instance.general.deploymentStatus",
],
});
expect(container.textContent).not.toContain("Censor username in logs");
expect(container.textContent).not.toContain("Deployment and auth");
expect(container.textContent).toContain("Backup retention");
expect(container.textContent).toContain("AI feedback sharing");
expect(container.textContent).toContain("Sign out");
});
it("shows every section when nothing is hidden", async () => {
await renderPage(SELF_HOSTED_HEALTH);
expect(container.textContent).toContain("Deployment and auth");
expect(container.textContent).toContain("Censor username in logs");
expect(container.textContent).toContain("Backup retention");
});
});