fix(editor): restore configurable completion acceptance
This commit is contained in:
17 files changed
+367
-73
No files matched your search
@@ -1,6 +1,7 @@
|
||||
import { readFileSync } from "node:fs";
|
||||
import ts from "typescript";
|
||||
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||
import { acceptSelectedCompletionWithRetry, acceptSelectedOrFirstCompletion } from "@/lib/editor/queryEditorCompletionAcceptance";
|
||||
import { DEFAULT_SHORTCUT_SETTINGS, normalizeShortcutSettings, shortcutToCodeMirrorKey } from "@/lib/editor/shortcutRegistry";
|
||||
|
||||
const queryEditorSource = readFileSync(new URL("../../../components/editor/QueryEditor.vue", import.meta.url), "utf8");
|
||||
@@ -47,6 +48,7 @@ interface MockView {
|
||||
|
||||
interface TabHarness {
|
||||
handleTab: (view: MockView) => boolean;
|
||||
handleEnter: (view: MockView) => boolean;
|
||||
insertNewlineWithoutCompletion: (view: MockView) => boolean;
|
||||
acceptCompletionOrNextSnippetField: (view: MockView) => boolean;
|
||||
clearPendingCompletionTab: () => void;
|
||||
@@ -56,24 +58,31 @@ interface TabHarness {
|
||||
function createHarness(options: {
|
||||
completionStatus: (state: MockState) => "active" | "pending" | null;
|
||||
acceptCompletion?: (view: MockView) => boolean;
|
||||
selectedCompletionIndex?: (state: MockState) => number | null;
|
||||
selectFirstCompletion?: (view: MockView) => boolean;
|
||||
closeCompletion?: (view: MockView) => boolean;
|
||||
insertNewlineKeepIndent?: (view: MockView) => boolean;
|
||||
nextSnippetField?: (view: MockView) => boolean;
|
||||
indentMore?: (view: MockView) => boolean;
|
||||
acceptCompletionShortcut?: string;
|
||||
selectFirstCompletionOnOpen?: boolean;
|
||||
}): TabHarness {
|
||||
const source = [
|
||||
extractDeclaration(/const COMPLETION_REMOTE_LATENCY_BUDGET_MS = \d+;/, "remote completion latency budget"),
|
||||
extractDeclaration(/const COMPLETION_DEBOUNCE_DELAY_MS = \d+;/, "completion debounce delay"),
|
||||
extractDeclaration(/const COMPLETION_TAB_RETRY_DELAY_MS = \d+;/, "completion retry delay"),
|
||||
extractDeclaration(/const COMPLETION_TAB_MAX_WAIT_MS = [^;]+;/, "completion wait timeout"),
|
||||
extractDeclaration(/const COMPLETION_ENTER_MAX_WAIT_MS = \d+;/, "completion Enter wait timeout"),
|
||||
"let pendingCompletionTabTimer: ReturnType<typeof setTimeout> | null = null;",
|
||||
"let cancelPendingCompletionEnter: (() => void) | null = null;",
|
||||
"let suppressNextSqlCompletionAutoStartUntil = 0;",
|
||||
extractFunction("editorIndentUnit"),
|
||||
extractFunction("handleTab"),
|
||||
extractFunction("tabKeyAcceptsCompletion"),
|
||||
extractFunction("handleTabWithoutAcceptingCompletion"),
|
||||
extractFunction("performNormalTab"),
|
||||
extractFunction("handleEnter"),
|
||||
extractFunction("clearPendingCompletionEnter"),
|
||||
extractFunction("insertNewlineWithoutCompletion"),
|
||||
extractFunction("acceptCompletionOrNextSnippetField"),
|
||||
extractFunction("clearPendingCompletionTab"),
|
||||
@@ -86,6 +95,10 @@ function createHarness(options: {
|
||||
const factory = new Function(
|
||||
"codeMirrorCompletionStatus",
|
||||
"codeMirrorAcceptCompletion",
|
||||
"codeMirrorSelectedCompletionIndex",
|
||||
"codeMirrorSelectFirstCompletion",
|
||||
"acceptSelectedCompletionWithRetry",
|
||||
"acceptSelectedOrFirstCompletion",
|
||||
"codeMirrorCloseCompletion",
|
||||
"codeMirrorInsertNewlineKeepIndent",
|
||||
"insertQueryEditorNewline",
|
||||
@@ -95,11 +108,15 @@ function createHarness(options: {
|
||||
"normalizeShortcutSettings",
|
||||
"shortcutToCodeMirrorKey",
|
||||
"props",
|
||||
`${javascript}\nreturn { handleTab, insertNewlineWithoutCompletion, acceptCompletionOrNextSnippetField, clearPendingCompletionTab, consumeSqlCompletionAutoStartSuppression };`,
|
||||
`${javascript}\nreturn { handleTab, handleEnter, insertNewlineWithoutCompletion, acceptCompletionOrNextSnippetField, clearPendingCompletionTab, consumeSqlCompletionAutoStartSuppression };`,
|
||||
);
|
||||
return factory(
|
||||
options.completionStatus,
|
||||
options.acceptCompletion ?? (() => false),
|
||||
options.selectedCompletionIndex ?? (() => 0),
|
||||
options.selectFirstCompletion ?? (() => false),
|
||||
acceptSelectedCompletionWithRetry,
|
||||
acceptSelectedOrFirstCompletion,
|
||||
options.closeCompletion ?? (() => false),
|
||||
options.insertNewlineKeepIndent ?? (() => false),
|
||||
(view: MockView, fallback: ((view: MockView) => boolean) | null | undefined) => fallback?.(view) ?? false,
|
||||
@@ -109,6 +126,7 @@ function createHarness(options: {
|
||||
editorSettings: {
|
||||
sqlFormatter: { useTabs: false, tabWidth: 2 },
|
||||
shortcuts: { ...DEFAULT_SHORTCUT_SETTINGS, acceptCompletion: options.acceptCompletionShortcut ?? DEFAULT_SHORTCUT_SETTINGS.acceptCompletion },
|
||||
selectFirstCompletionOnOpen: options.selectFirstCompletionOnOpen ?? false,
|
||||
},
|
||||
},
|
||||
normalizeShortcutSettings,
|
||||
@@ -156,6 +174,19 @@ describe("QueryEditor completion Tab keymap", () => {
|
||||
expect(harness.consumeSqlCompletionAutoStartSuppression()).toBe(false);
|
||||
});
|
||||
|
||||
it("accepts the selected completion on Enter only in first-option mode", () => {
|
||||
const acceptCompletion = vi.fn(() => true);
|
||||
const closeCompletion = vi.fn(() => true);
|
||||
const insertNewlineKeepIndent = vi.fn(() => true);
|
||||
const harness = createHarness({ completionStatus: () => "active", acceptCompletion, closeCompletion, insertNewlineKeepIndent, selectFirstCompletionOnOpen: true });
|
||||
const view = createView();
|
||||
|
||||
expect(harness.handleEnter(view)).toBe(true);
|
||||
expect(acceptCompletion).toHaveBeenCalledWith(view);
|
||||
expect(closeCompletion).not.toHaveBeenCalled();
|
||||
expect(insertNewlineKeepIndent).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does not suppress later completion when Enter cannot insert a newline", () => {
|
||||
const harness = createHarness({ completionStatus: () => null, insertNewlineKeepIndent: () => false });
|
||||
|
||||
|
||||
+93
-16
@@ -2,14 +2,16 @@
|
||||
|
||||
import { readFileSync } from "node:fs";
|
||||
import { resolve } from "node:path";
|
||||
import { acceptCompletion, autocompletion, completionStatus, currentCompletions, selectedCompletionIndex, startCompletion } from "@codemirror/autocomplete";
|
||||
import { EditorState, Transaction } from "@codemirror/state";
|
||||
import { acceptCompletion, autocompletion, completionStatus, currentCompletions, moveCompletionSelection, selectedCompletionIndex, startCompletion } from "@codemirror/autocomplete";
|
||||
import { EditorState, Prec, Transaction } from "@codemirror/state";
|
||||
import { insertNewlineKeepIndent } from "@codemirror/commands";
|
||||
import { EditorView, keymap, runScopeHandlers } from "@codemirror/view";
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
import { acceptSelectedCompletionWithRetry, acceptSelectedOrFirstCompletion } from "@/lib/editor/queryEditorCompletionAcceptance";
|
||||
|
||||
const queryEditorSource = readFileSync(resolve(process.cwd(), "apps/desktop/src/components/editor/QueryEditor.vue"), "utf8");
|
||||
|
||||
function createCompletionView(doc = "") {
|
||||
function createCompletionView(doc = "", selectFirstCompletionOnOpen = false, interactionDelay: number | null = 0) {
|
||||
return new EditorView({
|
||||
parent: document.createElement("div"),
|
||||
state: EditorState.create({
|
||||
@@ -19,11 +21,36 @@ function createCompletionView(doc = "") {
|
||||
autocompletion({
|
||||
activateOnTyping: true,
|
||||
activateOnTypingDelay: 0,
|
||||
interactionDelay: 0,
|
||||
selectOnOpen: false,
|
||||
...(interactionDelay === null ? {} : { interactionDelay }),
|
||||
selectOnOpen: selectFirstCompletionOnOpen,
|
||||
override: [() => ({ from: 0, options: [{ label: "select" }, { label: "set" }] })],
|
||||
}),
|
||||
keymap.of([{ key: "Tab", run: acceptCompletion }]),
|
||||
Prec.highest(
|
||||
keymap.of([
|
||||
{
|
||||
key: "Tab",
|
||||
run: (view) => acceptSelectedOrFirstCompletion(view, acceptCompletion, selectedCompletionIndex, moveCompletionSelection(true)),
|
||||
},
|
||||
{
|
||||
key: "Enter",
|
||||
run: (view) => {
|
||||
if (selectFirstCompletionOnOpen) {
|
||||
const result = acceptSelectedCompletionWithRetry(view, {
|
||||
completionStatus,
|
||||
acceptCompletion,
|
||||
selectedCompletionIndex,
|
||||
selectFirstCompletion: moveCompletionSelection(true),
|
||||
retryDelayMs: 16,
|
||||
maxWaitMs: 125,
|
||||
onUnavailable: () => insertNewlineKeepIndent(view),
|
||||
});
|
||||
if (result.handled) return true;
|
||||
}
|
||||
return insertNewlineKeepIndent(view);
|
||||
},
|
||||
},
|
||||
]),
|
||||
),
|
||||
],
|
||||
}),
|
||||
});
|
||||
@@ -41,34 +68,84 @@ async function expectCompletionOpenWithoutSelection(view: EditorView) {
|
||||
|
||||
describe("QueryEditor completion selection", () => {
|
||||
it("binds SQL completion to CodeMirror's unselected-on-open mode", () => {
|
||||
expect(queryEditorSource).toMatch(/buildSqlCompletionExtension = \(\) =>\s+autocompletion\(\{\s+activateOnTyping: true,\s+selectOnOpen: false,/);
|
||||
expect(queryEditorSource).toMatch(/selectOnOpen: settingsStore\.editorSettings\.selectFirstCompletionOnOpen/);
|
||||
});
|
||||
|
||||
it("opens manual completion unselected until ArrowDown selects the first option", async () => {
|
||||
it("opens manual completion unselected and accepts the first option with Tab", async () => {
|
||||
const view = createCompletionView();
|
||||
|
||||
expect(startCompletion(view)).toBe(true);
|
||||
await expectCompletionOpenWithoutSelection(view);
|
||||
expect(press(view, "Tab")).toBe(false);
|
||||
expect(view.state.doc.toString()).toBe("");
|
||||
|
||||
expect(press(view, "ArrowDown")).toBe(true);
|
||||
expect(selectedCompletionIndex(view.state)).toBe(0);
|
||||
expect(press(view, "Tab")).toBe(true);
|
||||
expect(view.state.doc.toString()).toBe("select");
|
||||
view.destroy();
|
||||
});
|
||||
|
||||
it("accepts an explicitly selected option instead of resetting to the first option", async () => {
|
||||
const view = createCompletionView();
|
||||
|
||||
expect(startCompletion(view)).toBe(true);
|
||||
await expectCompletionOpenWithoutSelection(view);
|
||||
expect(press(view, "ArrowUp")).toBe(true);
|
||||
expect(selectedCompletionIndex(view.state)).toBe(1);
|
||||
expect(press(view, "Tab")).toBe(true);
|
||||
expect(view.state.doc.toString()).toBe("set");
|
||||
view.destroy();
|
||||
});
|
||||
|
||||
it("opens typing-triggered completion without selecting the first option", async () => {
|
||||
const view = createCompletionView();
|
||||
|
||||
view.dispatch({
|
||||
changes: { from: 0, insert: "s" },
|
||||
selection: { anchor: 1 },
|
||||
annotations: Transaction.userEvent.of("input.type"),
|
||||
});
|
||||
await expectCompletionOpenWithoutSelection(view);
|
||||
expect(press(view, "Tab")).toBe(false);
|
||||
expect(view.state.doc.toString()).toBe("s");
|
||||
expect(press(view, "Tab")).toBe(true);
|
||||
expect(view.state.doc.toString()).toBe("select");
|
||||
view.destroy();
|
||||
});
|
||||
|
||||
it("keeps Enter as a newline while no completion option is selected", async () => {
|
||||
const view = createCompletionView();
|
||||
|
||||
expect(startCompletion(view)).toBe(true);
|
||||
await expectCompletionOpenWithoutSelection(view);
|
||||
expect(press(view, "Enter")).toBe(true);
|
||||
expect(view.state.doc.toString()).toBe("\n");
|
||||
view.destroy();
|
||||
});
|
||||
|
||||
it("restores first-option selection and Enter acceptance when explicitly enabled", async () => {
|
||||
const view = createCompletionView("", true);
|
||||
|
||||
expect(startCompletion(view)).toBe(true);
|
||||
await expect.poll(() => completionStatus(view.state)).toBe("active");
|
||||
expect(selectedCompletionIndex(view.state)).toBe(0);
|
||||
expect(press(view, "Enter")).toBe(true);
|
||||
expect(view.state.doc.toString()).toBe("select");
|
||||
view.destroy();
|
||||
});
|
||||
|
||||
it("waits through CodeMirror's default interaction delay before accepting Enter", async () => {
|
||||
let now = 0;
|
||||
const dateNow = vi.spyOn(Date, "now").mockImplementation(() => now);
|
||||
const view = createCompletionView("", true, null);
|
||||
|
||||
try {
|
||||
expect(startCompletion(view)).toBe(true);
|
||||
await expect.poll(() => completionStatus(view.state), { interval: 1 }).toBe("active");
|
||||
expect(selectedCompletionIndex(view.state)).toBe(0);
|
||||
expect(acceptCompletion(view)).toBe(false);
|
||||
expect(press(view, "Enter")).toBe(true);
|
||||
expect(view.state.doc.toString()).toBe("");
|
||||
|
||||
now = 100;
|
||||
await expect.poll(() => view.state.doc.toString(), { interval: 10 }).toBe("select");
|
||||
} finally {
|
||||
dateNow.mockRestore();
|
||||
view.destroy();
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,77 @@
|
||||
import type { EditorState } from "@codemirror/state";
|
||||
import type { Command, EditorView } from "@codemirror/view";
|
||||
|
||||
type SelectedCompletionIndex = (state: EditorState) => number | null;
|
||||
type CompletionStatus = (state: EditorState) => "active" | "pending" | null;
|
||||
|
||||
interface RetryCompletionAcceptanceOptions {
|
||||
completionStatus: CompletionStatus;
|
||||
acceptCompletion: Command | null;
|
||||
selectedCompletionIndex: SelectedCompletionIndex | null;
|
||||
selectFirstCompletion: Command | null;
|
||||
retryDelayMs: number;
|
||||
maxWaitMs: number;
|
||||
onUnavailable: () => void;
|
||||
onSettled?: () => void;
|
||||
}
|
||||
|
||||
interface CompletionAcceptanceAttempt {
|
||||
handled: boolean;
|
||||
cancel?: () => void;
|
||||
}
|
||||
|
||||
export function acceptSelectedOrFirstCompletion(view: EditorView, acceptCompletion: Command | null, selectedCompletionIndex: SelectedCompletionIndex | null, selectFirstCompletion: Command | null): boolean {
|
||||
if (!acceptCompletion) return false;
|
||||
if (!selectedCompletionIndex || !selectFirstCompletion) return acceptCompletion(view);
|
||||
if (selectedCompletionIndex(view.state) !== null) return acceptCompletion(view);
|
||||
if (!selectFirstCompletion(view)) return false;
|
||||
return acceptCompletion(view);
|
||||
}
|
||||
|
||||
export function acceptSelectedCompletionWithRetry(view: EditorView, options: RetryCompletionAcceptanceOptions): CompletionAcceptanceAttempt {
|
||||
if (options.completionStatus(view.state) !== "active") return { handled: false };
|
||||
if (acceptSelectedOrFirstCompletion(view, options.acceptCompletion, options.selectedCompletionIndex, options.selectFirstCompletion)) return { handled: true };
|
||||
|
||||
const initialDoc = view.state.doc;
|
||||
const initialSelectionRanges = view.state.selection.ranges.map((range) => ({ anchor: range.anchor, head: range.head }));
|
||||
const startedAt = Date.now();
|
||||
let timer: ReturnType<typeof setTimeout> | null = null;
|
||||
let settled = false;
|
||||
|
||||
const settle = () => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
if (timer !== null) {
|
||||
clearTimeout(timer);
|
||||
timer = null;
|
||||
}
|
||||
options.onSettled?.();
|
||||
};
|
||||
|
||||
const retry = () => {
|
||||
timer = null;
|
||||
if (settled) return;
|
||||
|
||||
const selectionRanges = view.state.selection.ranges;
|
||||
if (view.state.doc !== initialDoc || selectionRanges.length !== initialSelectionRanges.length || selectionRanges.some((range, index) => range.anchor !== initialSelectionRanges[index]?.anchor || range.head !== initialSelectionRanges[index]?.head)) {
|
||||
settle();
|
||||
return;
|
||||
}
|
||||
|
||||
const completionStatus = options.completionStatus(view.state);
|
||||
if (completionStatus === "active" && acceptSelectedOrFirstCompletion(view, options.acceptCompletion, options.selectedCompletionIndex, options.selectFirstCompletion)) {
|
||||
settle();
|
||||
return;
|
||||
}
|
||||
if (completionStatus && Date.now() - startedAt < options.maxWaitMs) {
|
||||
timer = setTimeout(retry, options.retryDelayMs);
|
||||
return;
|
||||
}
|
||||
|
||||
settle();
|
||||
options.onUnavailable();
|
||||
};
|
||||
|
||||
timer = setTimeout(retry, options.retryDelayMs);
|
||||
return { handled: true, cancel: settle };
|
||||
}
|
||||
@@ -22,6 +22,7 @@ export const EDITOR_SETTINGS_DRAFT_KEYS = [
|
||||
"autoAliasTables",
|
||||
"insertSpaceAfterCompletion",
|
||||
"sortCompletionColumnsAlphabetically",
|
||||
"selectFirstCompletionOnOpen",
|
||||
"wordWrap",
|
||||
"vimModeEnabled",
|
||||
"autoCloseBrackets",
|
||||
|
||||
Reference in new issue
Block a user