Files
kandev/apps/web/lib/plugins/modal-manager.test.ts
João Salavisa 99dfbbde58 feat(plugins): add keybindings and modal window capabilities (#1895)
* feat(plugins): add keybindings and modal window capabilities

Add two independent plugin UI capabilities.

Keybindings: plugins declare keybindings in the manifest under
ui.keybindings ({id, default, description}), validated backend-side
(combo grammar + unique ids, requires a UI bundle) and exposed to the
frontend. Plugin JS binds a handler via registry.registerKeybinding(id,
handler); a global dispatcher fires it. Combos are user-overridable in
Settings > Keyboard Shortcuts (namespaced plugin:{pluginId}:{id}) with
conflict detection against core and other plugins.

Modals: host.openModal({title?, content, size?, dismissible?}) returns a
{ close() } handle and renders in a single host-owned Dialog isolated by
PluginErrorBoundary, cleaned up on plugin unload.

Fixture plugin, PLUGIN-API.md / spec, and a Playwright e2e demonstrate a
keybinding handler opening a modal.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(plugins): address review feedback on keybinding dispatch and validation

Core shortcuts now take precedence over plugin keybindings on a colliding
combo (defaultPrevented cooperation between the two capture-phase
dispatchers), a throwing plugin handler no longer aborts dispatch to other
plugins, and the keybinding combo grammar is tightened: the backend validator
and frontend parser both drop the undocumented control/super modifier
aliases and reject shift+digit/symbol combos that can never actually fire
(KeyboardEvent.key reports the shifted character, not the token).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(plugins): stop conflicting core shortcut from double-firing with plugin keybindings

The earlier defaultPrevented guard only covered the central useAppShortcuts
dispatcher. Per-component core shortcuts registered via useKeyboardShortcut
run in the bubble phase, after the capture-phase plugin keybinding dispatcher,
so a plugin-handled-and-prevented combo still triggered the core action too.
Guard useKeyboardShortcut (and use-editor-keybinds, another capture-phase core
listener) on event.defaultPrevented so exactly one action fires per combo.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(plugins): make core shortcuts always win over plugin keybindings

Panel-search, task-switcher, and other core listeners never checked
event.defaultPrevented, so a plugin bound to the same combo (e.g. Cmd/Ctrl+F)
could still fire alongside them. Instead of patching every core listener,
usePluginShortcuts now computes the set of effective core shortcut combos
(registry, resolved through user overrides, plus FIND_IN_PANEL/SAVE) and
skips invoking any plugin handler whose combo is in that set, so the
matching core listener always handles the event exactly once.

Also adds a hook-level regression test for useEditorKeybinds' existing
defaultPrevented guard, and fixes a leaked capture-phase window listener in
use-keyboard-shortcut.test.ts that could bleed into later tests.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(web): keep Cmd+K closing the command panel after shortcut-precedence guard

cmdk's built-in vim bindings intercept Ctrl/Cmd+K and +P as list-navigation
shortcuts and call preventDefault() before the event reaches our window-level
useKeyboardShortcut listeners. Once that hook started bailing on
event.defaultPrevented (added to fix core/plugin shortcut double-firing), the
palette's own Cmd+K close/reopen toggle got silently suppressed whenever focus
was inside the open panel. Disable cmdk's vim bindings on the command palette
so its Ctrl/Cmd+K and +P always reach the app-level toggle.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs(plugins): document keybindings and modal window plugin APIs

Fill in the public author-facing docs that the internal plugin-keybindings
and modal-window contract (PLUGIN-API.md, spec.md) already covers: the
registry.registerKeybinding / host.openModal JS surface, the ui.keybindings
manifest field with its combo grammar, and a capability mention on the
Plugins overview page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-24 11:45:28 +01:00

88 lines
3.1 KiB
TypeScript

import { describe, it, expect } from "vitest";
import { pluginModalManager } from "./modal-manager";
import type { PluginModalOptions } from "./types";
function noopContent() {
return null;
}
const baseOptions: PluginModalOptions = { content: noopContent };
describe("pluginModalManager", () => {
it("open() returns a handle and adds the modal to the snapshot", () => {
const before = pluginModalManager.getSnapshot().length;
const handle = pluginModalManager.openModal("jira", baseOptions);
const snapshot = pluginModalManager.getSnapshot();
expect(snapshot).toHaveLength(before + 1);
expect(snapshot[snapshot.length - 1].pluginId).toBe("jira");
handle.close();
});
it("close() removes only the closed modal instance", () => {
const handleA = pluginModalManager.openModal("jira", baseOptions);
const handleB = pluginModalManager.openModal("jira", baseOptions);
const before = pluginModalManager.getSnapshot().length;
handleA.close();
const snapshot = pluginModalManager.getSnapshot();
expect(snapshot).toHaveLength(before - 1);
expect(snapshot.some((m) => m.pluginId === "jira")).toBe(true);
handleB.close();
});
it("supports multiple concurrently open modals", () => {
const before = pluginModalManager.getSnapshot().length;
const handleA = pluginModalManager.openModal("jira", baseOptions);
const handleB = pluginModalManager.openModal("linear", baseOptions);
expect(pluginModalManager.getSnapshot()).toHaveLength(before + 2);
handleA.close();
handleB.close();
expect(pluginModalManager.getSnapshot()).toHaveLength(before);
});
it("closeAllForPlugin removes only that plugin's modals", () => {
const jiraHandle = pluginModalManager.openModal("jira", baseOptions);
const linearHandle = pluginModalManager.openModal("linear", baseOptions);
const before = pluginModalManager.getSnapshot().length;
pluginModalManager.closeAllForPlugin("jira");
const snapshot = pluginModalManager.getSnapshot();
expect(snapshot).toHaveLength(before - 1);
expect(snapshot.some((m) => m.pluginId === "jira")).toBe(false);
expect(snapshot.some((m) => m.pluginId === "linear")).toBe(true);
void jiraHandle;
linearHandle.close();
});
it("generates monotonically increasing, unique instance ids", () => {
const handleA = pluginModalManager.openModal("jira", baseOptions);
const snapshotA = pluginModalManager.getSnapshot();
const idA = snapshotA[snapshotA.length - 1].instanceId;
const handleB = pluginModalManager.openModal("jira", baseOptions);
const snapshotB = pluginModalManager.getSnapshot();
const idB = snapshotB[snapshotB.length - 1].instanceId;
expect(idA).not.toBe(idB);
handleA.close();
handleB.close();
});
it("close() is a no-op when the modal is already closed", () => {
const handle = pluginModalManager.openModal("jira", baseOptions);
handle.close();
const before = pluginModalManager.getSnapshot().length;
expect(() => handle.close()).not.toThrow();
expect(pluginModalManager.getSnapshot()).toHaveLength(before);
});
});