No floating promises (#1576)

* Eliminate problematic flaoting promises

We have a lot of floating promises in our code, some explicitly so, others
likely being oversights. Will add a new eslint rule to watch for floating
promises, fixing some and using "void" to ignore the others.

* Split captured output

Author: award999

.eslintrc.json

@@ -3,7 +3,8 @@
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 2020,
-    "sourceType": "module"
+    "sourceType": "module",
+    "project": true
   },
   "plugins": ["@typescript-eslint"],
   "rules": {
@@ -13,6 +14,7 @@
     // TODO "@typescript-eslint/semi" rule moved to https://eslint.style
     "semi": "error",
     "no-console": "warn",
+    "@typescript-eslint/no-floating-promises": "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/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "composite": true,
+
+    "rootDir": ".",
+    "outDir": "dist",
+
+    "lib": ["ES2021"],
+    "target": "ES2020",
+    "module": "commonjs",
+
+    "strict": true,
+
+    "sourceMap": true,
+
+    "types": []
+  }
+}

src/BackgroundCompilation.ts

@@ -58,7 +58,7 @@ export class BackgroundCompilation implements vscode.Disposable {
             this.workspaceFileWatcher.onDidChange(
                 debounce(
                     () => {
-                        this.runTask();
+                        void this.runTask();
                     },
                     100 /* 10 times per second */,
                     { trailing: true }

src/FolderContext.ts

@@ -154,7 +154,7 @@ export class FolderContext implements vscode.Disposable {
      * @param event event type
      */
     async fireEvent(event: FolderOperation) {
-        this.workspaceContext.fireEvent(this, event);
+        await this.workspaceContext.fireEvent(this, event);
     }
 
     /** Return edited Packages folder */

src/PackageWatcher.ts

@@ -128,7 +128,7 @@ export class PackageWatcher {
     async handleSwiftVersionFileChange() {
         const version = await this.readSwiftVersionFile();
         if (version && version.toString() !== this.currentVersion?.toString()) {
-            this.workspaceContext.fireEvent(
+            await this.workspaceContext.fireEvent(
                 this.folderContext,
                 FolderOperation.swiftVersionUpdated
             );
@@ -162,7 +162,7 @@ export class PackageWatcher {
     async handlePackageSwiftChange() {
         // Load SwiftPM Package.swift description
         await this.folderContext.reload();
-        this.workspaceContext.fireEvent(this.folderContext, FolderOperation.packageUpdated);
+        await this.workspaceContext.fireEvent(this.folderContext, FolderOperation.packageUpdated);
     }
 
     /**
@@ -175,7 +175,10 @@ export class PackageWatcher {
         await this.folderContext.reloadPackageResolved();
         // if file contents has changed then send resolve updated message
         if (this.folderContext.swiftPackage.resolved?.fileHash !== packageResolvedHash) {
-            this.workspaceContext.fireEvent(this.folderContext, FolderOperation.resolvedUpdated);
+            await this.workspaceContext.fireEvent(
+                this.folderContext,
+                FolderOperation.resolvedUpdated
+            );
         }
     }
 
@@ -186,6 +189,9 @@ export class PackageWatcher {
      */
     private async handleWorkspaceStateChange() {
         await this.folderContext.reloadWorkspaceState();
-        this.workspaceContext.fireEvent(this.folderContext, FolderOperation.workspaceStateUpdated);
+        await this.workspaceContext.fireEvent(
+            this.folderContext,
+            FolderOperation.workspaceStateUpdated
+        );
     }
 }

src/TestExplorer/TestExplorer.ts

@@ -87,9 +87,9 @@ export class TestExplorer {
                 this.testFileEdited = false;
 
                 // only run discover tests if the library has tests
-                this.folderContext.swiftPackage.getTargets(TargetType.test).then(targets => {
+                void this.folderContext.swiftPackage.getTargets(TargetType.test).then(targets => {
                     if (targets.length > 0) {
-                        this.discoverTestsInWorkspace(this.tokenSource.token);
+                        void this.discoverTestsInWorkspace(this.tokenSource.token);
                     }
                 });
             }
@@ -98,7 +98,7 @@ export class TestExplorer {
         // add file watcher to catch changes to swift test files
         const fileWatcher = this.folderContext.workspaceContext.onDidChangeSwiftFiles(({ uri }) => {
             if (this.testFileEdited === false) {
-                this.folderContext.getTestTarget(uri).then(target => {
+                void this.folderContext.getTestTarget(uri).then(target => {
                     if (target) {
                         this.testFileEdited = true;
                     }
@@ -138,7 +138,7 @@ export class TestExplorer {
                 switch (operation) {
                     case FolderOperation.add:
                         if (folder) {
-                            folder.swiftPackage.getTargets(TargetType.test).then(targets => {
+                            void folder.swiftPackage.getTargets(TargetType.test).then(targets => {
                                 if (targets.length === 0) {
                                     return;
                                 }
@@ -149,7 +149,7 @@ export class TestExplorer {
                                 if (
                                     !configuration.folder(folder.workspaceFolder).disableAutoResolve
                                 ) {
-                                    folder.testExplorer?.discoverTestsInWorkspace(
+                                    void folder.testExplorer?.discoverTestsInWorkspace(
                                         tokenSource.token
                                     );
                                 }
@@ -158,7 +158,7 @@ export class TestExplorer {
                         break;
                     case FolderOperation.packageUpdated:
                         if (folder) {
-                            folder.swiftPackage.getTargets(TargetType.test).then(targets => {
+                            void folder.swiftPackage.getTargets(TargetType.test).then(targets => {
                                 const hasTestTargets = targets.length > 0;
                                 if (hasTestTargets && !folder.hasTestExplorer()) {
                                     folder.addTestExplorer();
@@ -168,7 +168,7 @@ export class TestExplorer {
                                         !configuration.folder(folder.workspaceFolder)
                                             .disableAutoResolve
                                     ) {
-                                        folder.testExplorer?.discoverTestsInWorkspace(
+                                        void folder.testExplorer?.discoverTestsInWorkspace(
                                             tokenSource.token
                                         );
                                     }
@@ -219,7 +219,7 @@ export class TestExplorer {
         const testExplorer = folder?.testExplorer;
         if (testExplorer && symbols && uri && uri.scheme === "file") {
             if (isPathInsidePath(uri.fsPath, folder.folder.fsPath)) {
-                folder.swiftPackage.getTarget(uri.fsPath).then(target => {
+                void folder.swiftPackage.getTarget(uri.fsPath).then(target => {
                     if (target && target.type === "test") {
                         testExplorer.lspTestDiscovery
                             .getDocumentTests(folder.swiftPackage, uri)

src/TestExplorer/TestParsers/SwiftTestingOutputParser.ts

@@ -211,7 +211,7 @@ export class SwiftTestingOutputParser {
 
         rl.on("line", line => this.parse(JSON.parse(line), runState));
 
-        reader.start(readlinePipe);
+        void reader.start(readlinePipe);
     }
 
     /**

src/TestExplorer/TestRunner.ts

@@ -729,7 +729,7 @@ export class TestRunner {
                 // discarded. If the test run has already started this is a no-op so its safe to call it multiple times.
                 this.testRun.testRunStarted();
 
-                this.swiftTestOutputParser.close();
+                void this.swiftTestOutputParser.close();
             }
         } finally {
             outputStream.end();
@@ -807,7 +807,7 @@ export class TestRunner {
                 }
             });
 
-            this.folderContext.taskQueue.queueOperation(
+            void this.folderContext.taskQueue.queueOperation(
                 new TaskOperation(task),
                 this.testRun.token
             );

src/WorkspaceContext.ts

@@ -133,7 +133,7 @@ export class WorkspaceContext implements vscode.Disposable {
                     break;
                 case FolderOperation.focus:
                     this.updateContextKeys(event.folder);
-                    this.updateContextKeysForFile();
+                    void this.updateContextKeysForFile();
                     break;
                 case FolderOperation.unfocus:
                     this.updateContextKeys(event.folder);
@@ -233,7 +233,7 @@ export class WorkspaceContext implements vscode.Disposable {
             return;
         }
 
-        Promise.all([
+        void Promise.all([
             folderContext.swiftPackage.foundPackage,
             folderContext.swiftPackage.executableProducts,
             folderContext.swiftPackage.dependencies,
@@ -259,7 +259,7 @@ export class WorkspaceContext implements vscode.Disposable {
 
         if (this.currentFolder) {
             const languageClient = this.languageClientManager.get(this.currentFolder);
-            languageClient.useLanguageClient(async client => {
+            await languageClient.useLanguageClient(async client => {
                 const experimentalCaps = client.initializeResult?.capabilities.experimental;
                 if (!experimentalCaps) {
                     contextKeys.supportsReindexing = false;
@@ -299,7 +299,7 @@ export class WorkspaceContext implements vscode.Disposable {
                 console.log("Trying to run onDidChangeWorkspaceFolders on deleted context");
                 return;
             }
-            this.onDidChangeWorkspaceFolders(event);
+            void this.onDidChangeWorkspaceFolders(event);
         });
         // add event listener for when the active edited text document changes
         const onDidChangeActiveWindow = vscode.window.onDidChangeActiveTextEditor(async editor => {
@@ -330,7 +330,7 @@ export class WorkspaceContext implements vscode.Disposable {
                 await this.focusFolder(null);
             }
         }
-        this.initialisationComplete();
+        await this.initialisationComplete();
     }
 
     /**
@@ -453,7 +453,7 @@ export class WorkspaceContext implements vscode.Disposable {
             // if current folder is this folder send unfocus event by setting
             // current folder to undefined
             if (this.currentFolder === folder) {
-                this.focusFolder(null);
+                await this.focusFolder(null);
             }
             // run observer functions in reverse order when removing
             const observersReversed = [...this.observers];
@@ -522,10 +522,10 @@ export class WorkspaceContext implements vscode.Disposable {
         }
     }
 
-    private initialisationComplete() {
+    private async initialisationComplete() {
         this.initialisationFinished = true;
         if (this.lastFocusUri) {
-            this.focusUri(this.lastFocusUri);
+            await this.focusUri(this.lastFocusUri);
             this.lastFocusUri = undefined;
         }
     }

src/commands/createNewProject.ts

@@ -30,7 +30,7 @@ export async function createNewProject(toolchain: SwiftToolchain | undefined): P
     // run before the Swift extension is activated. Show the toolchain error notification in
     // this case.
     if (!toolchain) {
-        showToolchainError();
+        void showToolchainError();
         return;
     }