Fix 'Extract to function' switching to the header. (#11616)

* Fix 'Extract to function' switching to the header.

Author: sean-mcmanus

Extension/src/LanguageServer/Providers/documentFormattingEditProvider.ts

@@ -4,7 +4,7 @@
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
 import { DefaultClient, FormatDocumentRequest, FormatParams, FormatResult } from '../client';
-import { CppSettings, getEditorConfigSettings, OtherSettings } from '../settings';
+import { CppSettings, OtherSettings, getEditorConfigSettings } from '../settings';
 import { makeVscodeTextEdits } from '../utils';
 
 export class DocumentFormattingEditProvider implements vscode.DocumentFormattingEditProvider {
@@ -20,11 +20,12 @@ export class DocumentFormattingEditProvider implements vscode.DocumentFormatting
         }
         await this.client.ready;
         const filePath: string = document.uri.fsPath;
-        const onChanges: string | number | boolean = options.onChanges;
-        if (onChanges) {
+        if (options.onChanges) {
             let insertSpacesSet: boolean = false;
             let tabSizeSet: boolean = false;
-            const editor: vscode.TextEditor = await vscode.window.showTextDocument(document, undefined, true);
+            // Even when preserveFocus is true, VS Code is making the document active (when we don't want that).
+            // The workaround is for the code invoking the formatting to call showTextDocument again afterwards on the previously active document.
+            const editor: vscode.TextEditor = await vscode.window.showTextDocument(document, { preserveFocus: options.preserveFocus as boolean });
             if (editor.options.insertSpaces && typeof editor.options.insertSpaces === "boolean") {
                 options.insertSpaces = editor.options.insertSpaces;
                 insertSpacesSet = true;
@@ -63,7 +64,7 @@ export class DocumentFormattingEditProvider implements vscode.DocumentFormatting
                         line: 0
                     }
                 },
-                onChanges: onChanges === true
+                onChanges: options.onChanges === true
             };
             // We do not currently pass the CancellationToken to sendRequest
             // because there is not currently cancellation logic for formatting

Extension/src/LanguageServer/client.ts

@@ -3257,7 +3257,8 @@ export class DefaultClient implements Client {
                 }
                 const formatEdits: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
                 for (const uri of editedFiles) {
-                    const formatTextEdits: vscode.TextEdit[] | undefined = await vscode.commands.executeCommand<vscode.TextEdit[] | undefined>("vscode.executeFormatDocumentProvider", uri, { onChanges: true });
+                    const formatTextEdits: vscode.TextEdit[] | undefined = await vscode.commands.executeCommand<vscode.TextEdit[] | undefined>(
+                        "vscode.executeFormatDocumentProvider", uri, { onChanges: true, preserveFocus: false });
                     if (formatTextEdits && formatTextEdits.length > 0) {
                         formatEdits.set(uri, formatTextEdits);
                     }
@@ -3539,7 +3540,7 @@ export class DefaultClient implements Client {
                         if (edit.newText.includes("#pragma once")) {
                             // Commit this so that it can be undone separately, to avoid leaving an empty file,
                             // which causes the next refactor to not add the #pragma once.
-                            await vscode.workspace.applyEdit(workspaceEdits);
+                            await vscode.workspace.applyEdit(workspaceEdits, { isRefactoring: true });
                             headerFileLineOffset = nextLineOffset;
                             workspaceEdits = new vscode.WorkspaceEdit();
                             continue;
@@ -3599,10 +3600,9 @@ export class DefaultClient implements Client {
         }
 
         // Apply the extract to function text edits.
-        await vscode.workspace.applyEdit(workspaceEdits);
+        await vscode.workspace.applyEdit(workspaceEdits, { isRefactoring: true });
 
         const firstUri: vscode.Uri = formatUriAndRanges[0].uri;
-        await vscode.window.showTextDocument(firstUri, { selection: replaceEditRange });
 
         // Format the new text edits.
         const formatEdits: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
@@ -3611,7 +3611,8 @@ export class DefaultClient implements Client {
             const formatOptions: vscode.FormattingOptions = {
                 insertSpaces: settings.editorInsertSpaces ?? true,
                 tabSize: settings.editorTabSize ?? 4,
-                onChanges: true
+                onChanges: true,
+                preserveFocus: true
             };
 
             const doFormat = async () => {
@@ -3641,8 +3642,12 @@ export class DefaultClient implements Client {
         }
 
         if (formatEdits.size > 0) {
-            await vscode.workspace.applyEdit(formatEdits);
+            await vscode.workspace.applyEdit(formatEdits, { isRefactoring: true });
         }
+
+        // This is required to be done after the formatting is done, because that can trigger the
+        // active document to switch to the wrong file (the header).
+        await vscode.window.showTextDocument(firstUri, { selection: replaceEditRange, preserveFocus: false });
     }
 
     public onInterval(): void {