From db8319896da2fc281c66c70963bcb3fae027af33 Mon Sep 17 00:00:00 2001 From: Morgan Chang Date: Fri, 30 Oct 2026 14:38:03 -0400 Subject: [PATCH] Handle confirmation support for Inline refactorings Signed-off-by: Morgan Chang --- src/extension.ts | 1 + src/protocol.ts | 1 + src/refactorAction.ts | 37 ++++++++----------------- src/refactoring/changeSignaturePanel.ts | 13 +++++++-- src/refactoring/confirmation.ts | 28 +++++++++++++++++++ 5 files changed, 52 insertions(+), 28 deletions(-) create mode 100644 src/refactoring/confirmation.ts diff --git a/src/extension.ts b/src/extension.ts index daa1a0a9e..86f4a830c 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -256,6 +256,7 @@ export async function activate(context: ExtensionContext): Promise inferSelectionSupport: ["extractMethod", "extractVariable", "extractField"], moveRefactoringSupport: true, moveRefactoringConfirmationSupport: true, + inlineRefactoringConfirmationSupport: true, clientHoverProvider: true, clientDocumentSymbolProvider: true, gradleChecksumWrapperPromptSupport: true, diff --git a/src/protocol.ts b/src/protocol.ts index 6e9f61b9d..152c72592 100644 --- a/src/protocol.ts +++ b/src/protocol.ts @@ -361,6 +361,7 @@ export interface GetRefactorEditParams { context: CodeActionParams; options: FormattingOptions; commandArguments: any[]; + confirmationToken?: string; } export namespace GetRefactorEditRequest { diff --git a/src/refactorAction.ts b/src/refactorAction.ts index 64d3cace5..523bb4d5d 100644 --- a/src/refactorAction.ts +++ b/src/refactorAction.ts @@ -6,7 +6,8 @@ import { commands, ExtensionContext, Position, QuickPickItem, TextDocument, Uri, import { FormattingOptions, WorkspaceEdit, RenameFile, DeleteFile, TextDocumentEdit, CodeActionParams, SymbolInformation } from 'vscode-languageclient'; import { LanguageClient } from 'vscode-languageclient/node'; import { Commands as javaCommands } from './commands'; -import { GetRefactorEditRequest, MoveRequest, RefactorWorkspaceEdit, RenamePosition, GetMoveDestinationsRequest, SearchSymbols, SelectionInfo, InferSelectionRequest, GetChangeSignatureInfoRequest, ChangeSignatureInfo, MoveParams } from './protocol'; +import { GetRefactorEditRequest, MoveRequest, RefactorWorkspaceEdit, RenamePosition, GetMoveDestinationsRequest, SearchSymbols, SelectionInfo, InferSelectionRequest, GetChangeSignatureInfoRequest, ChangeSignatureInfo, MoveParams, GetRefactorEditParams } from './protocol'; +import { requestWithConfirmation } from './refactoring/confirmation'; import { ChangeSignaturePanel } from './refactoring/changeSignaturePanel'; import { getExtractInterfaceArguments, revealExtractedInterface } from './refactoring/extractInterface'; @@ -46,6 +47,9 @@ function registerApplyRefactorCommand(languageClient: LanguageClient, context: E || command === 'convertVariableToField' || command === 'invertVariable' || command === 'introduceParameter' + || command === 'inlineMethod' + || command === 'inlineConstant' + || command === 'inlineLocalVariable' || command === 'convertAnonymousClassToNestedCommand') { const currentEditor = window.activeTextEditor; if (!currentEditor || !currentEditor.options) { @@ -121,16 +125,18 @@ function registerApplyRefactorCommand(languageClient: LanguageClient, context: E return; } - const result: RefactorWorkspaceEdit = await languageClient.sendRequest(GetRefactorEditRequest.type, { + const refactorParams: GetRefactorEditParams = { command, context: params, options: formattingOptions, commandArguments, - }); + }; + const result = await requestWithConfirmation(refactorParams, + requestParams => languageClient.sendRequest(GetRefactorEditRequest.type, requestParams)); await applyRefactorEdit(languageClient, result); - if (command === 'extractInterface') { + if (command === 'extractInterface' && result) { await revealExtractedInterface(result); } } else if (command === 'moveFile') { @@ -253,27 +259,8 @@ async function applyRefactorEdit(languageClient: LanguageClient, refactorEdit: R } async function requestMoveWithConfirmation(languageClient: LanguageClient, moveParams: MoveParams): Promise { - let refactorEdit: RefactorWorkspaceEdit = await languageClient.sendRequest(MoveRequest.type, moveParams); - if (!refactorEdit?.confirmationToken) { - await applyRefactorEdit(languageClient, refactorEdit); - return refactorEdit; - } - - const continueAction = 'Continue'; - const detail = 'Review the details below before continuing:\n\n' + refactorEdit.errorMessage; - const selection = await window.showWarningMessage( - 'This refactoring may change program behavior. Continue anyway?', - { modal: true, detail }, - continueAction, - ); - if (selection !== continueAction) { - return undefined; - } - - refactorEdit = await languageClient.sendRequest(MoveRequest.type, { - ...moveParams, - confirmationToken: refactorEdit.confirmationToken, - }); + const refactorEdit = await requestWithConfirmation(moveParams, + requestParams => languageClient.sendRequest(MoveRequest.type, requestParams)); await applyRefactorEdit(languageClient, refactorEdit); return refactorEdit; } diff --git a/src/refactoring/changeSignaturePanel.ts b/src/refactoring/changeSignaturePanel.ts index f5f7728a0..100f15bdb 100644 --- a/src/refactoring/changeSignaturePanel.ts +++ b/src/refactoring/changeSignaturePanel.ts @@ -1,7 +1,8 @@ import * as path from "path"; import { Disposable, Webview, WebviewPanel, window, Uri, ViewColumn, workspace, WorkspaceEdit } from "vscode"; import { LanguageClient } from "vscode-languageclient/node"; -import { GetRefactorEditRequest, RefactorWorkspaceEdit } from "../protocol"; +import { GetRefactorEditParams, GetRefactorEditRequest } from "../protocol"; +import { requestWithConfirmation } from "./confirmation"; import { getNonce, getUri } from "../webviewUtils"; interface MethodParameter { @@ -173,12 +174,18 @@ export class ChangeSignaturePanel { * @returns true if the refactoring is successful, false otherwise. */ private async doRefactor(methodIdentifier: string, isDelegate: boolean, methodName: string, accessType: string, returnType: string, parameters: MethodParameter[], exceptions: MethodException[], preview: boolean): Promise { - const clientWorkspaceEdit: RefactorWorkspaceEdit = await this.languageClient.sendRequest(GetRefactorEditRequest.type, { + const refactorParams: GetRefactorEditParams = { command: this.command, context: this.params, options: this.formattingOptions, commandArguments: [methodIdentifier, isDelegate, methodName, accessType, returnType, parameters, exceptions, preview] - }); + }; + const clientWorkspaceEdit = await requestWithConfirmation(refactorParams, + params => this.languageClient.sendRequest(GetRefactorEditRequest.type, params)); + if (clientWorkspaceEdit?.errorMessage) { + window.showErrorMessage(clientWorkspaceEdit.errorMessage); + return false; + } if (clientWorkspaceEdit?.edit) { const codeEdit: WorkspaceEdit = await this.languageClient.protocol2CodeConverter.asWorkspaceEdit(clientWorkspaceEdit.edit); if (codeEdit) { diff --git a/src/refactoring/confirmation.ts b/src/refactoring/confirmation.ts new file mode 100644 index 000000000..f23b46a4d --- /dev/null +++ b/src/refactoring/confirmation.ts @@ -0,0 +1,28 @@ +import { window } from 'vscode'; +import { RefactorWorkspaceEdit } from '../protocol'; + +export async function requestWithConfirmation( + params: T, + request: (params: T) => Promise, +): Promise { + const refactorEdit = await request(params); + if (!refactorEdit?.confirmationToken) { + return refactorEdit; + } + + const continueAction = 'Continue'; + const detail = `Review the details below before continuing:\n\n${refactorEdit.errorMessage}`; + const selection = await window.showWarningMessage( + 'This refactoring may change program behavior. Continue anyway?', + { modal: true, detail }, + continueAction, + ); + if (selection !== continueAction) { + return undefined; + } + + return request({ + ...params, + confirmationToken: refactorEdit.confirmationToken, + }); +}