diff --git a/src/editor/refactor/ChangeSignatureDialog.tsx b/src/editor/refactor/ChangeSignatureDialog.tsx index 866041cee..1fc82f810 100644 --- a/src/editor/refactor/ChangeSignatureDialog.tsx +++ b/src/editor/refactor/ChangeSignatureDialog.tsx @@ -1,5 +1,5 @@ /** IDEA's Change Signature dialog for Java methods (`signature.ts`). */ -import { useState } from "react"; +import { useEffect, useRef, useState } from "react"; import type { MethodSignature } from "@/bindings"; import { Checkbox, Dialog, IconButton, Input, Select, Spinner, T, Toolbar } from "@/ui"; import { useTx } from "@/platform/i18n"; @@ -46,7 +46,11 @@ function ChangeSignatureDialogInner({ request }: { request: SignatureRequest }) const ready = !busy && !problem && signatureChanged(info, signature); const current = Math.min(selected, rows.length - 1); + // Closing the dialog cancels a refactoring still being checked: it applies nothing. + const running = useRef(null); + useEffect(() => () => running.current?.abort(), []); const close = () => { + running.current?.abort(); useSignatureDialog.setState({ request: null }); request.view.focus(); }; @@ -72,9 +76,10 @@ function ChangeSignatureDialogInner({ request }: { request: SignatureRequest }) }; const submit = async (preview: boolean) => { if (!ready) return; + const run = (running.current = new AbortController()); setBusy(true); setError(null); - const outcome = await changeSignature(request, signature, delegate, preview); + const outcome = await changeSignature(request, signature, delegate, preview, run.signal); if (useSignatureDialog.getState().request !== request) return; setBusy(false); if (outcome.status === "done") close(); diff --git a/src/editor/refactor/ExtractInterfaceDialog.tsx b/src/editor/refactor/ExtractInterfaceDialog.tsx index a6a2e5465..25ea64694 100644 --- a/src/editor/refactor/ExtractInterfaceDialog.tsx +++ b/src/editor/refactor/ExtractInterfaceDialog.tsx @@ -1,5 +1,5 @@ /** IDEA's Extract Interface dialog for Java classes (`extractInterface.ts`). */ -import { useState } from "react"; +import { useEffect, useRef, useState } from "react"; import { Checkbox, Dialog, Input, Select, Spinner, T } from "@/ui"; import { useTx } from "@/platform/i18n"; import { @@ -39,7 +39,11 @@ function ExtractInterfaceDialogInner({ request }: { request: InterfaceRequest }) const ready = !busy && !problem && !!target; const allChecked = checked.size === info.members.length; + // Closing the dialog cancels a refactoring still being checked: it applies nothing. + const running = useRef(null); + useEffect(() => () => running.current?.abort(), []); const close = () => { + running.current?.abort(); useExtractInterfaceDialog.setState({ request: null }); request.view.focus(); }; @@ -52,10 +56,11 @@ function ExtractInterfaceDialogInner({ request }: { request: InterfaceRequest }) }); const submit = async (preview: boolean) => { if (!ready) return; + const run = (running.current = new AbortController()); setBusy(true); setError(null); const members = info.members.map((m) => m.handleIdentifier).filter((id) => checked.has(id)); - const outcome = await extractInterface(request, trimmed, target, members, preview); + const outcome = await extractInterface(request, trimmed, target, members, preview, run.signal); if (useExtractInterfaceDialog.getState().request !== request) return; setBusy(false); if (outcome.status === "done") close(); diff --git a/src/editor/refactor/cancellable.test.ts b/src/editor/refactor/cancellable.test.ts new file mode 100644 index 000000000..cbfe3c388 --- /dev/null +++ b/src/editor/refactor/cancellable.test.ts @@ -0,0 +1,33 @@ +import { describe, expect, it, vi } from "vitest"; + +const cancelRequest = vi.fn(async (_id: number) => ({ status: "ok", data: null })); +vi.mock("@/platform/ipc", async (original) => { + const ipc = await original(); + return { ...ipc, commands: { ...ipc.commands, cancelRequest } }; +}); + +const { cancellable } = await import("./signature"); + +describe("cancellable refactoring requests", () => { + it("cancels the request in flight when the dialog closes", async () => { + const run = new AbortController(); + let sent = -1; + let answer!: (v: string) => void; + const reply = cancellable(run.signal, (id) => { + sent = id; + return new Promise((r) => (answer = r)); + }); + run.abort(); + expect(cancelRequest).toHaveBeenCalledWith(sent); + answer("late"); + await expect(reply).resolves.toBe("late"); + }); + + it("leaves a request alone once it answered", async () => { + cancelRequest.mockClear(); + const run = new AbortController(); + await cancellable(run.signal, async () => "done"); + run.abort(); + expect(cancelRequest).not.toHaveBeenCalled(); + }); +}); diff --git a/src/editor/refactor/extractInterface.test.ts b/src/editor/refactor/extractInterface.test.ts index bd5e16e53..8d1b598ce 100644 --- a/src/editor/refactor/extractInterface.test.ts +++ b/src/editor/refactor/extractInterface.test.ts @@ -25,5 +25,9 @@ describe("extract interface", () => { expect(interfaceProblem("Shape", "Shape", 1)).toBe("Interface name should differ from the class name"); expect(interfaceProblem("HasArea", "Shape", 0)).toBe("Select the members to form the interface"); expect(interfaceProblem("HasArea", "Shape", 2)).toBeNull(); + // Java identifiers take letters of any script. + expect(interfaceProblem("处理器", "Shape", 1)).toBeNull(); + expect(interfaceProblem("Größe", "Shape", 1)).toBeNull(); + expect(interfaceProblem("a-b", "Shape", 1)).toBe("Interface name is not a valid identifier"); }); }); diff --git a/src/editor/refactor/extractInterface.ts b/src/editor/refactor/extractInterface.ts index ed98a2370..95e55ab50 100644 --- a/src/editor/refactor/extractInterface.ts +++ b/src/editor/refactor/extractInterface.ts @@ -17,7 +17,7 @@ import { tx } from "@/platform/i18n"; import { commands, isCancelled, nextRequestId, unavailableText } from "@/platform/ipc"; import { editorService } from "@/workbench/contributions"; import { cannotPerform } from "./catalog"; -import { applyEdit, confirmProblems } from "./signature"; +import { JAVA_NAME, applyEdit, cancellable, confirmProblems } from "./signature"; /** Languages whose server extracts interfaces through the dialog. */ export const EXTRACT_INTERFACE_LANGUAGES = new Set(["java"]); @@ -51,8 +51,6 @@ export function memberLabel(m: InterfaceMember): string { return `${m.name}${params}: ${m.typeName}`; } -const JAVA_NAME = /^[A-Za-z_$][\w$]*$/; - /** Why the interface can't be extracted yet, or null. */ export function interfaceProblem(name: string, className: string, members: number): string | null { if (!name) return "No interface name specified"; @@ -127,6 +125,8 @@ export async function extractInterface( pkg: PackageChoice, members: readonly string[], preview: boolean, + /** The dialog closed: nothing is confirmed, previewed or applied any more. */ + signal?: AbortSignal, ): Promise { const { view } = request; if (view.state.doc !== request.text) return { status: "stay", error: "The file changed; open the dialog again" }; @@ -136,18 +136,22 @@ export async function extractInterface( for (;;) { await whenSynced(view); const token: string | null = confirmation; - extracted = await lspRequest(() => - commands.lspExtractInterface(nextRequestId(), request.doc, request.pos, [...members], name, pkg.json, token), + extracted = await cancellable(signal, (id) => + lspRequest(() => + commands.lspExtractInterface(id, request.doc, request.pos, [...members], name, pkg.json, token), + ), ); + if (signal?.aborted) return { status: "stay" }; const fatal = extracted.problems.find((p) => p.severity === "fatal"); if (fatal || (!extracted.edit && !extracted.confirmation)) return { status: "stay", error: fatal?.message ?? "Nothing to change" }; if (!extracted.confirmation) break; - if (!(await confirmProblems(extracted.problems.map((p) => p.message)))) return { status: "stay" }; + if (!(await confirmProblems(extracted.problems.map((p) => p.message))) || signal?.aborted) + return { status: "stay" }; confirmation = extracted.confirmation; } } catch (e) { - if (isCancelled(e)) return { status: "stay" }; + if (isCancelled(e) || signal?.aborted) return { status: "stay" }; return { status: "stay", error: errorText(e) }; } const edit = extracted.edit!; diff --git a/src/editor/refactor/signature.test.ts b/src/editor/refactor/signature.test.ts index f06af6335..f3db23f19 100644 --- a/src/editor/refactor/signature.test.ts +++ b/src/editor/refactor/signature.test.ts @@ -23,6 +23,10 @@ describe("change signature", () => { it("tells what keeps the signature from being submitted", () => { expect(signatureProblem(info)).toBeNull(); expect(signatureProblem({ ...info, methodName: "2x" })).toBe("Method name is not a valid identifier"); + expect(signatureProblem({ ...info, methodName: "处理" })).toBeNull(); + expect( + signatureProblem({ ...info, parameters: info.parameters.map((p, i) => ({ ...p, name: `数量${i}` })) }), + ).toBeNull(); expect(signatureProblem({ ...info, returnType: " " })).toBe("Return type is not specified"); const dup = { ...info, parameters: [info.parameters[0]!, { ...info.parameters[1]!, name: "a" }] }; expect(signatureProblem(dup)).toBe("Duplicate parameter name"); diff --git a/src/editor/refactor/signature.ts b/src/editor/refactor/signature.ts index 102b81f4b..3b79722f9 100644 --- a/src/editor/refactor/signature.ts +++ b/src/editor/refactor/signature.ts @@ -50,7 +50,8 @@ export function signatureText(sig: { return head + throws; } -const JAVA_NAME = /^[A-Za-z_$][\w$]*$/; +/** A Java identifier: letters of any script, `$` and `_`, then digits and combining marks too. */ +export const JAVA_NAME = /^[\p{L}\p{Nl}\p{Sc}\p{Pc}][\p{L}\p{Nl}\p{Sc}\p{Pc}\p{Nd}\p{Mn}\p{Mc}]*$/u; /** Why the edited signature can't be submitted yet, or null. */ export function signatureProblem(sig: MethodSignature): string | null { @@ -137,6 +138,18 @@ export async function applyEdit(view: EditorView, edit: WorkspaceEdit) { } } +/** Sends `send(id)` with a fresh request id that `signal` cancels. */ +export async function cancellable(signal: AbortSignal | undefined, send: (id: number) => Promise): Promise { + const id = nextRequestId(); + const abort = () => void commands.cancelRequest(id); + signal?.addEventListener("abort", abort); + try { + return await send(id); + } finally { + signal?.removeEventListener("abort", abort); + } +} + export async function confirmProblems(messages: readonly string[]): Promise { const { button } = await ask({ title: "Problems Detected", @@ -158,6 +171,8 @@ export async function changeSignature( signature: MethodSignature, delegate: boolean, preview: boolean, + /** The dialog closed: nothing is confirmed, previewed or applied any more. */ + signal?: AbortSignal, ): Promise { const { view } = request; if (view.state.doc !== request.text) return { status: "stay", error: "The file changed; open the dialog again" }; @@ -167,18 +182,20 @@ export async function changeSignature( for (;;) { await whenSynced(view); const token: string | null = confirmation; - changed = await lspRequest(() => - commands.lspChangeSignature(nextRequestId(), request.doc, request.pos, signature, delegate, token), + changed = await cancellable(signal, (id) => + lspRequest(() => commands.lspChangeSignature(id, request.doc, request.pos, signature, delegate, token)), ); + if (signal?.aborted) return { status: "stay" }; const fatal = changed.problems.find((p) => p.severity === "fatal"); if (fatal || (!changed.edit && !changed.confirmation)) return { status: "stay", error: fatal?.message ?? "Nothing to change" }; if (!changed.confirmation) break; - if (!(await confirmProblems(changed.problems.map((p) => p.message)))) return { status: "stay" }; + if (!(await confirmProblems(changed.problems.map((p) => p.message))) || signal?.aborted) + return { status: "stay" }; confirmation = changed.confirmation; } } catch (e) { - if (isCancelled(e)) return { status: "stay" }; + if (isCancelled(e) || signal?.aborted) return { status: "stay" }; return { status: "stay", error: errorText(e) }; } const edit = changed.edit!;