pi-mono/packages/coding-agent/test/interactive-mode-extension-dialogs.test.ts
Petr Houška 5b520b0efc Merge origin/main: share overlay removal between done() and reset
#11851 added blocked status tracking for overlays. done() and
resetExtensionUI() now both remove an overlay through one function,
which hides it, clears its blocked status and disposes it.
2026-11-05 23:27:38 +01:00

314 lines
12 KiB
TypeScript

import { type Component, Container, Text } from "@earendil-works/pi-tui";
import { beforeAll, describe, expect, it, vi } from "vitest";
import { InteractiveMode } from "../src/modes/interactive/interactive-mode.ts";
import { initTheme } from "../src/modes/interactive/theme/theme.ts";
type DialogContext = {
extensionDialogs: Component[];
editorContainer: Container;
editor: Component & { getText(): string; setText(text: string): void };
focused: Component | undefined;
ui: {
setFocus: (component: Component) => void;
requestRender: () => void;
showOverlay: (component: Component) => { hide: () => void; setHidden: (hidden: boolean) => void };
};
overlays: Component[];
nextBlockingOverlayId: number;
extensionOverlays: Map<unknown, () => void>;
programStatus: { setBlocked: ReturnType<typeof vi.fn> };
disposeActiveSelector: () => void;
toggleToolOutputExpansion: () => void;
};
type DialogMethods = {
showExtensionConfirm(title: string, message: string, opts?: { signal?: AbortSignal }): Promise<boolean>;
showExtensionCustom<T>(
factory: (tui: unknown, theme: unknown, keybindings: unknown, done: (result: T) => void) => Component,
options?: {
overlay?: boolean;
onHandle?: (handle: { setHidden: (hidden: boolean) => void }) => void;
blocked?: { kind: "permission" | "question" | "auth"; message: string };
},
): Promise<T>;
setCustomEditorComponent(
factory: ((tui: unknown, theme: unknown, keybindings: unknown) => Component) | undefined,
): void;
resetExtensionUI(): void;
};
function createContext(): DialogContext & DialogMethods {
const prototype = InteractiveMode.prototype as unknown as Record<string, unknown>;
let editorText = "";
const editor = Object.assign(new Text("editor"), {
getText: () => editorText,
setText: (text: string) => {
editorText = text;
},
});
const context: DialogContext = {
extensionDialogs: [],
editorContainer: new Container(),
editor,
focused: undefined,
ui: {
setFocus: (component) => {
context.focused = component;
},
requestRender: vi.fn(),
showOverlay: (component) => {
context.overlays.push(component);
return {
hide: () => {
context.overlays = context.overlays.filter((overlay) => overlay !== component);
},
setHidden: vi.fn(),
};
},
},
overlays: [],
nextBlockingOverlayId: 0,
extensionOverlays: new Map(),
programStatus: { setBlocked: vi.fn() },
disposeActiveSelector: vi.fn(),
toggleToolOutputExpansion: vi.fn(),
};
return new Proxy(context, {
get(target, key, receiver) {
if (key in target) return Reflect.get(target, key, receiver);
const value = prototype[key as string];
return typeof value === "function" ? value.bind(receiver) : value;
},
}) as DialogContext & DialogMethods;
}
function visible(context: DialogContext): string {
expect(context.editorContainer.children).toEqual([context.focused]);
return (context.focused?.render(80) ?? []).join("\n");
}
describe("InteractiveMode extension dialogs", () => {
beforeAll(() => initTheme("dark"));
// Regression for #11166: a second dialog replaced the first one and the first promise never settled.
it("shows the earlier confirm again after the later one is answered", async () => {
const context = createContext();
const first = context.showExtensionConfirm("First", "first dialog");
const second = context.showExtensionConfirm("Second", "second dialog");
expect(visible(context)).toContain("Second");
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-dialog", {
kind: "permission",
message: "Second",
});
context.focused?.handleInput?.("\x1b");
await expect(second).resolves.toBe(false);
expect(visible(context)).toContain("First");
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-dialog", {
kind: "permission",
message: "First",
});
context.focused?.handleInput?.("\r");
await expect(first).resolves.toBe(true);
expect(context.focused).toBe(context.editor);
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-dialog", undefined);
});
it("removes a hidden dialog when its signal aborts", async () => {
const context = createContext();
const controller = new AbortController();
const first = context.showExtensionConfirm("First", "first dialog", { signal: controller.signal });
const second = context.showExtensionConfirm("Second", "second dialog");
controller.abort();
await expect(first).resolves.toBe(false);
expect(visible(context)).toContain("Second");
context.focused?.handleInput?.("\r");
await expect(second).resolves.toBe(true);
expect(context.focused).toBe(context.editor);
});
// Regression for #9909: a second inline custom component replaced the first one and the first promise never settled.
it("stacks concurrent inline custom components", async () => {
const context = createContext();
const dones: Array<(result: string) => void> = [];
const open = (label: string) =>
context.showExtensionCustom<string>((_tui, _theme, _keybindings, done) => {
dones.push(done);
return new Text(label);
});
const first = open("custom one");
const second = open("custom two");
await vi.waitFor(() => expect(dones).toHaveLength(2));
await vi.waitFor(() => expect(visible(context)).toContain("custom two"));
dones[1]("two");
await expect(second).resolves.toBe("two");
expect(visible(context)).toContain("custom one");
dones[0]("one");
await expect(first).resolves.toBe("one");
expect(context.focused).toBe(context.editor);
});
it("shows a confirm opened from an inline custom component and then restores the component", async () => {
const context = createContext();
let confirmed: Promise<boolean> | undefined;
let done: ((result: string) => void) | undefined;
const custom = context.showExtensionCustom<string>((_tui, _theme, _keybindings, finish) => {
done = finish;
return Object.assign(new Text("custom form"), {
handleInput: () => {
confirmed = context.showExtensionConfirm("Discard?", "discard changes");
},
});
});
await vi.waitFor(() => expect(visible(context)).toContain("custom form"));
context.focused?.handleInput?.("x");
expect(visible(context)).toContain("Discard?");
context.focused?.handleInput?.("\x1b");
await expect(confirmed).resolves.toBe(false);
expect(visible(context)).toContain("custom form");
done?.("kept");
await expect(custom).resolves.toBe("kept");
expect(context.focused).toBe(context.editor);
});
// Regression for #11428: inline custom dialogs could not report blocked program status.
it("reports blocked status for an inline custom component that opts in", async () => {
const context = createContext();
const dones: Array<(result: string) => void> = [];
const first = context.showExtensionCustom<string>(
(_tui, _theme, _keybindings, done) => {
dones.push(done);
return new Text("approval");
},
{ blocked: { kind: "permission", message: "Approve?" } },
);
await vi.waitFor(() => expect(visible(context)).toContain("approval"));
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-dialog", {
kind: "permission",
message: "Approve?",
});
const loader = context.showExtensionCustom<string>((_tui, _theme, _keybindings, done) => {
dones.push(done);
return new Text("loading");
});
await vi.waitFor(() => expect(visible(context)).toContain("loading"));
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-dialog", undefined);
dones[1]("loaded");
await expect(loader).resolves.toBe("loaded");
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-dialog", {
kind: "permission",
message: "Approve?",
});
dones[0]("yes");
await expect(first).resolves.toBe("yes");
expect(context.focused).toBe(context.editor);
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-dialog", undefined);
});
// Regression for #11816: overlays ignored the blocked option.
it("reports blocked status for each opted-in overlay until it is done, also while hidden", async () => {
const context = createContext();
const dones: Array<(result: string) => void> = [];
const handles: Array<{ setHidden: (hidden: boolean) => void }> = [];
const open = (text: string, blocked?: { kind: "question"; message: string }) =>
context.showExtensionCustom<string>(
(_tui, _theme, _keybindings, done) => {
dones.push(done);
return new Text(text);
},
{ overlay: true, onHandle: (handle) => handles.push(handle), blocked },
);
const first = open("first", { kind: "question", message: "First?" });
await vi.waitFor(() => expect(context.overlays).toHaveLength(1));
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-overlay:0", {
kind: "question",
message: "First?",
});
const second = open("second", { kind: "question", message: "Second?" });
await vi.waitFor(() => expect(context.overlays).toHaveLength(2));
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-overlay:1", {
kind: "question",
message: "Second?",
});
const loader = open("loading");
await vi.waitFor(() => expect(context.overlays).toHaveLength(3));
dones[2]("loaded");
await expect(loader).resolves.toBe("loaded");
handles[0].setHidden(true);
dones[1]("two");
await expect(second).resolves.toBe("two");
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-overlay:1", undefined);
dones[0]("one");
await expect(first).resolves.toBe("one");
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-overlay:0", undefined);
expect(context.programStatus.setBlocked).toHaveBeenCalledTimes(4);
});
// Regression for #11816: /reload and session switches drop overlays without calling done().
it("clears overlay blocked status when the extension UI is reset", async () => {
const context = createContext();
Object.assign(context, {
clearExtensionTerminalInputListeners: vi.fn(),
setExtensionFooter: vi.fn(),
setExtensionHeader: vi.fn(),
clearExtensionWidgets: vi.fn(),
footerDataProvider: { clearExtensionStatuses: vi.fn() },
footer: { invalidate: vi.fn() },
setCustomEditorComponent: vi.fn(),
setupAutocompleteProvider: vi.fn(),
defaultEditor: {},
updateTerminalTitle: vi.fn(),
setWorkingIndicator: vi.fn(),
setHiddenThinkingLabel: vi.fn(),
});
void context.showExtensionCustom<string>(() => new Text("question"), {
overlay: true,
blocked: { kind: "question", message: "Question?" },
});
await vi.waitFor(() => expect(context.overlays).toHaveLength(1));
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-overlay:0", {
kind: "question",
message: "Question?",
});
context.resetExtensionUI();
expect(context.programStatus.setBlocked).toHaveBeenLastCalledWith("extension-overlay:0", undefined);
expect(context.extensionOverlays.size).toBe(0);
expect(context.overlays).toHaveLength(0);
});
// Regression for #11431: replacing the editor while a dialog was open hid the dialog and left it unanswerable.
it("keeps an open dialog visible when the editor component is replaced", async () => {
const context = createContext();
(context as unknown as { defaultEditor: unknown }).defaultEditor = context.editor;
const confirmed = context.showExtensionConfirm("Title", "Continue?");
const customEditor: Component & { getText(): string; setText(text: string): void } = {
render: () => ["custom editor"],
invalidate: () => {},
getText: () => "",
setText: () => {},
};
context.setCustomEditorComponent(() => customEditor);
expect(visible(context)).toContain("Title");
context.focused?.handleInput?.("\r");
await expect(confirmed).resolves.toBe(true);
expect(context.focused).toBe(customEditor);
expect(context.editorContainer.children).toEqual([customEditor]);
});
});