Nightly failure fixes (#1586)

* Capture promise before running command

It times out after long wait so thinking there may be a timing issue here

* Try match expression in case it's a equality issue

* Try to do a better job of capturing further data after exit

Inspiration from microsoft/vscode@9464b54

* Debug logging

* Also check no floating thenables

* Make command callbacks async

* Fix failing test

* See if using correct WorkspaceContext instance

* More debug logging

* Try to return instead of resolve

* Specify expected arguments

* Allow passing count as command parameter

* Fix failing test

* Debug logging

* Run function directly

* Make these unit tests

Don't require activated extension to test these

* Remove debug logging

* Make sure debugger extensions are activated

Only activate first time since never will deactivate

* Only need one folder for this test

* Remove more debug logging

* Move to unit level

* Fix review comment

Author: award999

.eslintrc.json

@@ -14,7 +14,8 @@
     // TODO "@typescript-eslint/semi" rule moved to https://eslint.style
     "semi": "error",
     "no-console": "warn",
-    "@typescript-eslint/no-floating-promises": "warn",
+    "@typescript-eslint/no-floating-promises": ["warn", { "checkThenables": true }],
+    "@typescript-eslint/await-thenable": "warn",
     // Mostly fails tests, ex. expect(...).to.be.true returns a Chai.Assertion
     "@typescript-eslint/no-unused-expressions": "off",
     "@typescript-eslint/no-non-null-assertion": "off",

scripts/check_package_json.ts

@@ -15,6 +15,7 @@
 
 import { getExtensionVersion, main } from "./lib/utilities";
 
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 main(async () => {
     const version = await getExtensionVersion();
     if (version.minor % 2 !== 0) {

scripts/compile_icons.ts

@@ -51,6 +51,7 @@ function minifyIcon(icon: string, color: string = "#424242"): string {
     }).data;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 main(async () => {
     const iconsSourceDirectory = path.join(__dirname, "../src/icons");
     const iconAssetsDirectory = path.join(__dirname, "../assets/icons");

scripts/dev_package.ts

@@ -15,6 +15,7 @@
 
 import { exec, getExtensionVersion, getRootDirectory, main } from "./lib/utilities";
 
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 main(async () => {
     const rootDirectory = getRootDirectory();
     const version = await getExtensionVersion();

scripts/download_vsix.ts

@@ -33,6 +33,7 @@ const repository = process.env["GITHUB_REPOSITORY"] || "swiftlang/vscode-swift";
 const owner = repository.split("/")[0];
 const repo = repository.split("/")[1];
 
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 (async function () {
     const octokit = new Octokit({
         auth: token,

scripts/preview_package.ts

@@ -28,6 +28,7 @@ function formatDate(date: Date): string {
     return year + month + day;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 main(async () => {
     const rootDirectory = getRootDirectory();
     const version = await getExtensionVersion();

scripts/update_swift_docc_render.ts

@@ -56,6 +56,7 @@ async function cloneSwiftDocCRender(buildDirectory: string): Promise<string> {
     return swiftDocCRenderDirectory;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 main(async () => {
     const outputDirectory = path.join(getRootDirectory(), "assets", "swift-docc-render");
     if (process.argv.includes("postinstall")) {

src/FolderContext.ts

@@ -93,7 +93,7 @@ export class FolderContext implements vscode.Disposable {
 
         const error = await swiftPackage.error;
         if (error) {
-            vscode.window.showErrorMessage(
+            void vscode.window.showErrorMessage(
                 `Failed to load ${folderContext.name}/Package.swift: ${error.message}`
             );
             workspaceContext.outputChannel.log(
@@ -179,7 +179,7 @@ export class FolderContext implements vscode.Disposable {
     /** Refresh the tests in the test explorer for this folder */
     refreshTestExplorer() {
         if (this.testExplorer?.controller.resolveHandler) {
-            this.testExplorer.controller.resolveHandler(undefined);
+            void this.testExplorer.controller.resolveHandler(undefined);
         }
     }
 

src/TestExplorer/TestExplorer.ts

@@ -204,7 +204,9 @@ export class TestExplorer {
      */
     private updateSwiftTestContext() {
         const items = flattenTestItemCollection(this.controller.items).map(({ id }) => id);
-        vscode.commands.executeCommand("setContext", "swift.tests", items);
+        void vscode.commands.executeCommand("setContext", "swift.tests", items).then(() => {
+            /* Put in worker queue */
+        });
     }
 
     /**
@@ -285,7 +287,7 @@ export class TestExplorer {
                 const ok = "OK";
                 const enable = "Enable SourceKit-LSP";
                 if (firstTry && configuration.lsp.disable === true) {
-                    vscode.window
+                    void vscode.window
                         .showInformationMessage(
                             `swift-testing tests will not be detected since SourceKit-LSP
                             has been disabled for this workspace.`,
@@ -297,9 +299,12 @@ export class TestExplorer {
                                 explorer.folderContext.workspaceContext.outputChannel.log(
                                     `Enabling SourceKit-LSP after swift-testing message`
                                 );
-                                vscode.workspace
+                                void vscode.workspace
                                     .getConfiguration("swift")
-                                    .update("sourcekit-lsp.disable", false);
+                                    .update("sourcekit-lsp.disable", false)
+                                    .then(() => {
+                                        /* Put in worker queue */
+                                    });
                             } else if (selected === ok) {
                                 explorer.folderContext.workspaceContext.outputChannel.log(
                                     `User acknowledged that SourceKit-LSP is disabled`

src/TestExplorer/TestRunner.ts

@@ -1021,8 +1021,7 @@ export class TestRunner {
                                     "Test Debugging Cancelled",
                                     this.folderContext.name
                                 );
-                                vscode.debug.stopDebugging(session);
-                                resolve();
+                                void vscode.debug.stopDebugging(session).then(() => resolve());
                             });
                             subscriptions.push(cancellation);
                         });
@@ -1051,11 +1050,9 @@ export class TestRunner {
                                                 // dispose terminate debug handler
                                                 subscriptions.forEach(sub => sub.dispose());
 
-                                                vscode.commands.executeCommand(
-                                                    "workbench.view.extension.test"
-                                                );
-
-                                                resolve();
+                                                void vscode.commands
+                                                    .executeCommand("workbench.view.extension.test")
+                                                    .then(() => resolve());
                                             });
                                         subscriptions.push(terminateSession);
                                     } else {