Fix comment completion tests (#1735)

* Try to fix comment completion tests

Issues using the `activeTextEditor` property so we'll "show", preserving focus,
so that we get an editor instance. Also don't update position unless edit completes

* Use a workspace edit

* Don't show document in tests

* Cleanup

* Test cleanup

Author: award999

src/editor/CommentCompletion.ts

@@ -60,12 +60,6 @@ class DocCommentCompletionProvider implements vscode.CompletionItemProvider {
         document: vscode.TextDocument,
         position: vscode.Position
     ) {
-        const editor = vscode.window.visibleTextEditors.find(
-            e => e.document.uri.toString() === document.uri.toString()
-        );
-        if (!editor || editor.document.isClosed) {
-            return;
-        }
         // Fixes https://github.com/swiftlang/vscode-swift/issues/1648
         const lineText = document.lineAt(position.line).text;
         // Continue the comment if its a white space only line, or if VS Code has already continued
@@ -75,17 +69,13 @@ class DocCommentCompletionProvider implements vscode.CompletionItemProvider {
                 ? [lineText, lineText, ""]
                 : /^(\s*)\/\/\s(.+)/.exec(lineText);
         if (match) {
-            await editor.edit(
-                edit => {
-                    edit.replace(
-                        new vscode.Range(position.line, 0, position.line, match[0].length),
-                        `${match[1]}/// ${match[2]}`
-                    );
-                },
-                { undoStopBefore: false, undoStopAfter: true }
+            const edit = new vscode.WorkspaceEdit();
+            edit.replace(
+                document.uri,
+                new vscode.Range(position.line, 0, position.line, match[0].length),
+                `${match[1]}/// ${match[2]}`
             );
-            const newPosition = new vscode.Position(position.line, match[1].length + 4);
-            editor.selection = new vscode.Selection(newPosition, newPosition);
+            await vscode.workspace.applyEdit(edit);
         }
     }
 }

test/integration-tests/BackgroundCompilation.test.ts

@@ -16,8 +16,8 @@ import * as assert from "assert";
 import * as vscode from "vscode";
 import { WorkspaceContext } from "../../src/WorkspaceContext";
 import { testAssetUri } from "../fixtures";
-import { Workbench } from "../../src/utilities/commands";
 import { activateExtensionForTest, updateSettings } from "./utilities/testutilities";
+import { closeAllEditors } from "../utilities/commands";
 
 suite("BackgroundCompilation Test Suite", () => {
     let workspaceContext: WorkspaceContext;
@@ -33,7 +33,7 @@ suite("BackgroundCompilation Test Suite", () => {
     });
 
     suiteTeardown(async () => {
-        await vscode.commands.executeCommand(Workbench.ACTION_CLOSEALLEDITORS);
+        await closeAllEditors();
     });
 
     test("build all on save @slow", async () => {

test/integration-tests/editor/CommentCompletion.test.ts

@@ -15,7 +15,6 @@
 import * as assert from "assert";
 import * as vscode from "vscode";
 import { CommentCompletionProviders } from "../../../src/editor/CommentCompletion";
-import { Workbench } from "../../../src/utilities/commands";
 
 suite("CommentCompletion Test Suite", () => {
     let provider: CommentCompletionProviders;
@@ -223,7 +222,12 @@ suite("CommentCompletion Test Suite", () => {
             ]);
         });
 
-        test("Comment insertion", async () => {
+        test("Comment insertion", async function () {
+            if (process.platform === "linux") {
+                // Linux tests are having issues with open text editors
+                this.skip();
+            }
+
             const { document, positions } = await openDocument(`
             /// 1️⃣
             func foo(bar: Int, baz: String) -> Data throws { return Data() }`);
@@ -393,12 +397,6 @@ suite("CommentCompletion Test Suite", () => {
     });
 
     suite("Document Comment Completion", function () {
-        setup(function () {
-            if (process.platform === "linux") {
-                // Skip as these tests access the active test editor which will sometimes crash on Linux.
-                this.skip();
-            }
-        });
         test("Should not provide completions on first line", async () => {
             const { document, positions } = await openDocument(`1️⃣
             public func foo() {}`);
@@ -473,27 +471,6 @@ public func foo() {}`);
             assert.deepEqual(documentText, originalText, "Document text should not change");
         });
 
-        test("Should handle case when no active text editor", async () => {
-            const { document: doc, positions } = await openDocument(`
-            /// aaa
-            1️⃣
-            public func foo() {}`);
-
-            const position = positions["1️⃣"];
-
-            // Close all editors to simulate no active text editor
-            await vscode.commands.executeCommand(Workbench.ACTION_CLOSEALLEDITORS);
-
-            // This should not throw an error
-            const items = await provider.docCommentCompletion.provideCompletionItems(doc, position);
-
-            assert.equal(
-                items,
-                undefined,
-                "Should not provide completions when no active text editor"
-            );
-        });
-
         test("Should handle when previous line has // but not ///", async () => {
             const { document, positions } = await openDocument(`
             // aaa
@@ -521,9 +498,6 @@ public func foo() {}`);
 
             const position = positions["1️⃣"];
 
-            // Show the document to ensure there's an active editor
-            await vscode.window.showTextDocument(document);
-
             const items = await provider.docCommentCompletion.provideCompletionItems(
                 document,
                 position
@@ -545,9 +519,6 @@ public func foo() {}`);
 
             const position = positions["1️⃣"];
 
-            // Show the document to ensure there's an active editor
-            await vscode.window.showTextDocument(document);
-
             const originalText = document.getText();
             const items = await provider.docCommentCompletion.provideCompletionItems(
                 document,
@@ -609,8 +580,6 @@ public func foo() {}`);
             content: purgedContent,
         });
 
-        await vscode.window.showTextDocument(doc);
-
         return { document: doc, positions };
     }
 });