actually fix (pass in document) and also respect detect indentation

Author: dibarbet

src/lsptoolshost/autoInsert/onAutoInsert.ts

@@ -4,7 +4,6 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-
 import {
     FormattingOptions,
     InsertTextFormat,
@@ -82,10 +81,20 @@ export function registerOnAutoInsert(languageServer: RoslynLanguageServer, langu
         // We need to calculate what that position would be after the change is applied and send that to the server.
         const position = vscodeRange.start.translate(0, change.text.length - rangeLength);
 
+        const formattingOptions = getFormattingOptions(document);
+
         source.cancel();
         source = new vscode.CancellationTokenSource();
         try {
-            await applyAutoInsertEdit(position, changeTrimmed, e.textDocument, uri, languageServer, source.token);
+            await applyAutoInsertEdit(
+                position,
+                changeTrimmed,
+                e.textDocument,
+                uri,
+                formattingOptions,
+                languageServer,
+                source.token
+            );
         } catch (e) {
             if (e instanceof vscode.CancellationError) {
                 return;
@@ -101,10 +110,10 @@ async function applyAutoInsertEdit(
     changeTextTrimmed: string,
     textDocumentIdentifier: TextDocumentIdentifier,
     uri: vscode.Uri,
+    formattingOptions: FormattingOptions,
     languageServer: RoslynLanguageServer,
     token: vscode.CancellationToken
 ) {
-    const formattingOptions = getFormattingOptions(uri);
     const request: RoslynProtocol.OnAutoInsertParams = {
         _vs_textDocument: textDocumentIdentifier,
         _vs_position: position,
@@ -142,9 +151,18 @@ async function applyAutoInsertEdit(
     }
 }
 
-function getFormattingOptions(resource: vscode.Uri): FormattingOptions {
-    const editorConfig = vscode.workspace.getConfiguration('editor', resource);
-    const tabSize = editorConfig.get<number>('tabSize') ?? 4;
-    const insertSpaces = editorConfig.get<boolean>('insertSpaces') ?? true;
+function getFormattingOptions(document: vscode.TextDocument): FormattingOptions {
+    const editorConfig = vscode.workspace.getConfiguration('editor', document);
+    const detectIndentation = editorConfig.get<boolean>('detectIndentation');
+
+    const editor = detectIndentation
+        ? vscode.window.visibleTextEditors.find((e) => e.document === document)
+        : undefined;
+
+    // VSCode guarantees that retrieving the editor.options.tabSize will return a number
+    const tabSize = (editor?.options.tabSize as number | undefined) ?? editorConfig.get<number>('tabSize') ?? 4;
+    // VSCode guarantees that retrieving the editor.options.insertSpaces will return a boolean
+    const insertSpaces =
+        (editor?.options.insertSpaces as boolean | undefined) ?? editorConfig.get<boolean>('insertSpaces') ?? true;
     return FormattingOptions.create(tabSize, insertSpaces);
 }

test/lsptoolshost/integrationTests/onAutoInsert.integration.test.ts

@@ -11,7 +11,6 @@ import {
     closeAllEditorsAsync,
     openFileInWorkspaceAsync,
     revertActiveFile,
-    sleep,
     waitForExpectedResult,
 } from './integrationHelpers';
 import { describe, beforeAll, beforeEach, afterAll, test, expect, afterEach } from '@jest/globals';
@@ -36,7 +35,6 @@ describe(`OnAutoInsert Tests`, () => {
     });
 
     test('Triple slash inserts doc comment snippet', async () => {
-        await sleep(1);
         await vscode.window.activeTextEditor!.edit((editBuilder) => {
             editBuilder.insert(new vscode.Position(2, 6), '/');
         });
@@ -123,22 +121,17 @@ describe(`OnAutoInsert Tests`, () => {
         const originalCsharpTabSize = csharpConfig.get('tabSize');
 
         try {
-            // Configure global tabSize to 2
-            await globalConfig.update('tabSize', 2, vscode.ConfigurationTarget.Global);
-            // Configure C# tabSize to 4
-            await vscode.workspace
-                .getConfiguration('[csharp]', vscode.window.activeTextEditor!.document.uri)
-                .update('editor.tabSize', 4, vscode.ConfigurationTarget.Global);
+            // Turn off detect indentation to ensure it consistently uses the settings.
+            await globalConfig.update('detectIndentation', false, vscode.ConfigurationTarget.Global);
 
-            // Wait for configuration to propagate
-            await sleep(100);
+            // Customize tab sizes
+            await globalConfig.update('tabSize', 4, vscode.ConfigurationTarget.Global);
+            await csharpConfig.update('tabSize', 2, vscode.ConfigurationTarget.Global);
 
             await vscode.window.activeTextEditor!.edit((editBuilder) => {
                 editBuilder.insert(new vscode.Position(11, 15), '\n');
             });
 
-            // OnAutoInsert is triggered by the change event but completes asynchronously, so wait for the buffer to be updated.
-
             const expectedLines = [
                 'class DocComments',
                 '{',
@@ -152,9 +145,9 @@ describe(`OnAutoInsert Tests`, () => {
                 '',
                 '    /// </summary>',
                 '    void M2()',
-                '    {',
-                '        ', // Should be 4 spaces (C# setting), not 2 (global setting)
-                '    }',
+                '  {',
+                '    ', // Should be 2 spaces (C# setting), not 4 (global setting)
+                '  }',
                 '}',
                 '',
             ];
@@ -169,10 +162,9 @@ describe(`OnAutoInsert Tests`, () => {
             );
         } finally {
             // Restore original settings
+            await globalConfig.update('detectIndentation', true, vscode.ConfigurationTarget.Global);
             await globalConfig.update('tabSize', originalGlobalTabSize, vscode.ConfigurationTarget.Global);
-            await vscode.workspace
-                .getConfiguration('[csharp]', vscode.window.activeTextEditor!.document.uri)
-                .update('editor.tabSize', originalCsharpTabSize, vscode.ConfigurationTarget.Global);
+            await csharpConfig.update('tabSize', originalCsharpTabSize, vscode.ConfigurationTarget.Global);
         }
     });
 });