Skip to content

Commit 0152d9d

Browse files
committed
fix(web): Escape while recording a shortcut no longer closes Settings
1 parent 4092c4a commit 0152d9d

2 files changed

Lines changed: 118 additions & 3 deletions

File tree

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
import { describe, expect, it, vi } from "vite-plus/test";
2+
import { page, userEvent, type Locator } from "vite-plus/test/browser";
3+
4+
import { render } from "../../../test/render";
5+
6+
vi.mock(import("../../state/session"), async (original) => ({
7+
...(await original()),
8+
useEnvironmentScope: () => true,
9+
useEnvironmentsWithScope: ((environments: ReadonlyArray<{ environmentId: string }>) =>
10+
new Set(environments.map(({ environmentId }) => environmentId))) as never,
11+
readEnvironmentScope: () => true,
12+
}));
13+
vi.mock(import("../../state/use-atom-command"), async (original) => ({
14+
...(await original()),
15+
useAtomCommand: (() => vi.fn()) as never,
16+
}));
17+
vi.mock(import("./SettingsScopeContext"), async (original) => ({
18+
...(await original()),
19+
useSettingsScope: (() => {
20+
const environment = { environmentId: "env", serverConfig: { keybindings: [] } };
21+
return { environment, connectedEnvironments: [environment] };
22+
}) as never,
23+
}));
24+
25+
import { Dialog, DialogPopup, DialogTitle } from "../ui/dialog";
26+
import { KeybindingsSettingsPanel } from "./KeybindingsSettings";
27+
28+
// The modal dialog's inert layer swallows pointer events in this harness, so drive the DOM.
29+
async function activate(locator: Locator, action: "click" | "focus") {
30+
await expect.element(locator).toBeVisible();
31+
(locator.element() as HTMLElement)[action]();
32+
}
33+
34+
const existingField = page.getByRole("textbox", { name: "Keybinding for Sidebar: Toggle" });
35+
const existingPill = page.getByRole("button", { name: /^Edit shortcut for Sidebar: Toggle:/ });
36+
const newField = page.getByRole("textbox", { name: "Keybinding for new keybinding" });
37+
38+
describe("Esc in a shortcut recorder", () => {
39+
it.each<{
40+
name: string;
41+
field: Locator;
42+
open: () => Promise<void>;
43+
expectReset: () => Promise<void>;
44+
}>([
45+
{
46+
name: "existing binding",
47+
field: existingField,
48+
open: () => activate(existingPill, "click"),
49+
expectReset: async () => {
50+
await expect.element(existingField).not.toBeInTheDocument();
51+
await expect.element(existingPill).toHaveFocus();
52+
await expect.element(page.getByRole("button", { name: "Save" })).not.toBeInTheDocument();
53+
},
54+
},
55+
{
56+
name: "new binding",
57+
field: newField,
58+
open: async () => {
59+
await activate(page.getByRole("button", { name: "Add keybinding" }), "click");
60+
await activate(newField, "focus");
61+
},
62+
expectReset: async () => {
63+
await expect.element(newField).toHaveValue("");
64+
await expect.element(newField).toHaveAttribute("placeholder", "Unassigned");
65+
},
66+
},
67+
])("leaves the $name field without closing Settings", async ({ field, open, expectReset }) => {
68+
const onOpenChange = vi.fn();
69+
await using _screen = await render(
70+
<Dialog open onOpenChange={onOpenChange}>
71+
<DialogPopup>
72+
<DialogTitle>Settings</DialogTitle>
73+
<KeybindingsSettingsPanel />
74+
</DialogPopup>
75+
</Dialog>,
76+
);
77+
78+
await open();
79+
await userEvent.keyboard("{Control>}k{/Control}");
80+
await expect.element(field).not.toHaveValue("");
81+
await userEvent.tab();
82+
await activate(field, "focus");
83+
await expect.element(field).toHaveAttribute("placeholder", "Press shortcut");
84+
85+
await userEvent.keyboard("{Escape}");
86+
87+
expect(onOpenChange).not.toHaveBeenCalled();
88+
expect(document.activeElement?.matches("[data-keybinding-capture]")).toBe(false);
89+
await expectReset();
90+
91+
await userEvent.keyboard("{Escape}");
92+
expect(onOpenChange).toHaveBeenCalledWith(false, expect.anything());
93+
});
94+
});

‎apps/web/src/components/settings/KeybindingsSettings.tsx‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import {
2020
useRef,
2121
useState,
2222
} from "react";
23+
import { flushSync } from "react-dom";
2324
import {
2425
AuthOrchestrationOperateScope,
2526
AuthSettingsWriteScope,
@@ -717,6 +718,7 @@ function useKeybindingRowEditor({
717718
onSave: (input: ServerUpsertKeybindingInput) => void;
718719
}) {
719720
const [draft, setDraft] = useReducer(keybindingRowDraftReducer, row, createKeybindingRowDraft);
721+
const pillRef = useRef<HTMLButtonElement>(null);
720722
const { keyDraft, whenDraft, isRecording, isWhenDraftValid } = draft;
721723
const whenDraftExpression = whenAstToExpression(whenDraft);
722724
const isDirty = keyDraft !== row.key || whenDraftExpression !== row.when;
@@ -739,7 +741,13 @@ function useKeybindingRowEditor({
739741
if (event.key === "Tab" && !isRecording) return;
740742
event.preventDefault();
741743
if (event.key === "Escape") {
742-
setDraft({ keyDraft: row.key, isRecording: false });
744+
// An unhandled Escape closes the settings page.
745+
event.stopPropagation();
746+
const field = event.currentTarget;
747+
flushSync(() => setDraft({ keyDraft: row.key, isRecording: false }));
748+
// The field may unmount for the pill; focus would otherwise drop to the page.
749+
if (pillRef.current) pillRef.current.focus();
750+
else field.blur();
743751
return;
744752
}
745753
const next = keybindingFromKeyboardEvent(event.nativeEvent, navigator.platform, {
@@ -760,6 +768,7 @@ function useKeybindingRowEditor({
760768
setDraft,
761769
save,
762770
captureKeybinding,
771+
pillRef,
763772
};
764773
}
765774

@@ -790,8 +799,16 @@ function KeybindingKeyControl({
790799
isSaving: boolean;
791800
pillClassName?: string | undefined;
792801
}) {
793-
const { keyDraft, isRecording, isDirty, isWhenDraftValid, setDraft, save, captureKeybinding } =
794-
editor;
802+
const {
803+
keyDraft,
804+
isRecording,
805+
isDirty,
806+
isWhenDraftValid,
807+
setDraft,
808+
save,
809+
captureKeybinding,
810+
pillRef,
811+
} = editor;
795812
const showPill = !isRecording && keyDraft === row.key && row.key.length > 0 && !isDirty;
796813

797814
return (
@@ -807,6 +824,7 @@ function KeybindingKeyControl({
807824
) : null}
808825
{showPill ? (
809826
<button
827+
ref={pillRef}
810828
type="button"
811829
onClick={() => setDraft({ isRecording: true })}
812830
aria-label={`Edit shortcut for ${commandLabel(row.command)}: ${formatShortcutLabel(row.binding.shortcut)}`}
@@ -1051,7 +1069,10 @@ function useNewKeybindingDraft({
10511069
if (event.key === "Tab" && !isRecording) return;
10521070
event.preventDefault();
10531071
if (event.key === "Escape") {
1072+
// An unhandled Escape closes the settings page.
1073+
event.stopPropagation();
10541074
setDraft({ keyDraft: "", isRecording: false });
1075+
event.currentTarget.blur();
10551076
return;
10561077
}
10571078
const next = keybindingFromKeyboardEvent(event.nativeEvent, navigator.platform, {

0 commit comments

Comments
 (0)