test: add controller recreation for integration tests

Author: Danielku15

src/constants.ts

@@ -23,6 +23,7 @@ export const defaultTestSymbols: IExtensionSettings = {
 
 export const showConfigErrorCommand = 'mocha-vscode.showConfigError';
 export const getControllersForTestCommand = 'mocha-vscode.getControllersForTest';
+export const recreateControllersForTestCommand = 'mocha-vscode.recreateControllersForTestCommand';
 
 function equalsIgnoreCase(a: string, b: string) {
   return a.localeCompare(b, undefined, { sensitivity: 'accent' }) === 0;

src/controller.ts

@@ -134,29 +134,33 @@ export class Controller {
 
     this.disposables.add(
       this.configFile.onActivate(() => {
-        const ctrl = (this.ctrl = vscode.tests.createTestController(
-          configFileUri.toString(),
-          configFileUri.fsPath,
-        ));
-        this.disposables.add(ctrl);
-
-        this.recreateDiscoverer();
-        const rescan = async (reason: string) => {
-          try {
-            logChannel.info(`Rescan of tests triggered (${reason}) - ${this.configFile.uri}}`);
-            this.recreateDiscoverer();
-            await this.scanFiles();
-          } catch (e) {
-            this.logChannel.error(e as Error, 'Failed to rescan tests');
-          }
-        };
-        this.disposables.add(this.configFile.onDidChange(() => rescan('mocharc changed')));
-        this.disposables.add(this.settings.onDidChange(() => rescan('settings changed')));
-        ctrl.refreshHandler = () => {
-          this.configFile.forget();
-          rescan('user');
-        };
-        this.scanFiles();
+        try {
+          const ctrl = (this.ctrl = vscode.tests.createTestController(
+            configFileUri.toString(),
+            configFileUri.fsPath,
+          ));
+          this.disposables.add(ctrl);
+
+          this.recreateDiscoverer();
+          const rescan = async (reason: string) => {
+            try {
+              logChannel.info(`Rescan of tests triggered (${reason}) - ${this.configFile.uri}}`);
+              this.recreateDiscoverer();
+              await this.scanFiles();
+            } catch (e) {
+              this.logChannel.error(e as Error, 'Failed to rescan tests');
+            }
+          };
+          this.disposables.add(this.configFile.onDidChange(() => rescan('mocharc changed')));
+          this.disposables.add(this.settings.onDidChange(() => rescan('settings changed')));
+          ctrl.refreshHandler = () => {
+            this.configFile.forget();
+            rescan('user');
+          };
+          this.scanFiles();
+        } catch (e) {
+          this.logChannel.error(e as Error);
+        }
       }),
     );
 

src/extension.ts

@@ -11,7 +11,7 @@ import * as timers from 'timers/promises';
 import * as vscode from 'vscode';
 import { ConfigValue } from './configValue';
 import { ConsoleOuputChannel } from './consoleLogChannel';
-import { getControllersForTestCommand } from './constants';
+import { getControllersForTestCommand, recreateControllersForTestCommand } from './constants';
 import { initESBuild } from './esbuild';
 import { TestRunner } from './runner';
 import { SourceMapStore } from './source-map-store';
@@ -103,9 +103,7 @@ export function activate(context: vscode.ExtensionContext) {
     }
   };
 
-  const initialSync = (async () => {
-    await initESBuild(context, logChannel);
-
+  async function syncWorkspaceFoldersWithRetry() {
     // Workaround for vscode#179203 where findFiles doesn't work on startup.
     // This extension is only activated on workspaceContains, so we have pretty
     // high confidence that we should find something.
@@ -118,15 +116,31 @@ export function activate(context: vscode.ExtensionContext) {
 
       await timers.setTimeout(1000);
     }
+  }
+
+  const initialSync = (async () => {
+    await initESBuild(context, logChannel);
+    await syncWorkspaceFoldersWithRetry();
   })();
 
   context.subscriptions.push(
     vscode.workspace.onDidChangeWorkspaceFolders(syncWorkspaceFolders),
-    vscode.commands.registerCommand(getControllersForTestCommand, () =>
-      initialSync.then(() =>
-        Array.from(watchers.values()).flatMap((w) => Array.from(w.controllers.values())),
-      ),
-    ),
+    vscode.commands.registerCommand(getControllersForTestCommand, async () => {
+      await initialSync;
+      return Array.from(watchers.values()).flatMap((w) => Array.from(w.controllers.values()));
+    }),
+    vscode.commands.registerCommand(recreateControllersForTestCommand, async () => {
+      logChannel.debug('Destroying all watchers and test controllers');
+      for (const [, watcher] of watchers) {
+        watcher.dispose();
+      }
+      watchers.clear();
+      resyncState = FolderSyncState.Idle;
+
+      logChannel.debug('Destroyed controllers, recreating');
+      await syncWorkspaceFoldersWithRetry();
+      return Array.from(watchers.values()).flatMap((w) => Array.from(w.controllers.values()));
+    }),
     new vscode.Disposable(() => watchers.forEach((c) => c.dispose())),
     logChannel,
   );

src/test/util.ts

@@ -15,7 +15,7 @@ import * as path from 'path';
 import * as sinon from 'sinon';
 import { setTimeout } from 'timers/promises';
 import * as vscode from 'vscode';
-import { getControllersForTestCommand } from '../constants';
+import { getControllersForTestCommand, recreateControllersForTestCommand } from '../constants';
 import type { Controller } from '../controller';
 import { IParsedNode, NodeKind } from '../discoverer/types';
 
@@ -64,12 +64,7 @@ export function integrationTestPrepare(name: string) {
 
   afterEach(async () => {
     await restoreWorkspace(workspaceFolder, workspaceBackup);
-    try {
-      const c = await getController(false);
-      await c.scanFiles();
-    } catch (e) {
-      // ignore
-    }
+    await vscode.commands.executeCommand(recreateControllersForTestCommand);
   });
 
   return workspaceFolder;