test: VSCode test setup and switch to insiders VSCODE-700 (#1186)

Co-authored-by: Himanshu Singh <himanshu.singhs@outlook.in>

Author: tculig

.github/workflows/actions/test-and-build/action.yaml

@@ -68,6 +68,7 @@ runs:
     - name: Run Tests
       env:
         NODE_OPTIONS: "--max_old_space_size=4096"
+        MDB_IS_TEST: "true"
       run: |
         npm run test
       shell: bash

.github/workflows/draft-release.yaml

@@ -96,6 +96,7 @@ jobs:
           GARASIGN_USERNAME: ${{ secrets.GARASIGN_USERNAME }}
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
           JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+          MDB_IS_TEST: "true"
 
       - name: Create Draft Release
         run: |

.github/workflows/test-and-build-from-fork.yaml

@@ -40,4 +40,5 @@ jobs:
         env:
           NODE_OPTIONS: "--max_old_space_size=4096"
           SEGMENT_KEY: "test-segment-key"
+          MDB_IS_TEST: "true"
         run: npm run test

.github/workflows/test-and-build.yaml

@@ -48,3 +48,4 @@ jobs:
           GARASIGN_USERNAME: ${{ secrets.GARASIGN_USERNAME }}
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
           JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+          MDB_IS_TEST: "true"

.vscode/launch.json

@@ -53,10 +53,11 @@
         "--extensionTestsPath=${workspaceFolder}/out/test/suite"
       ],
       "env": {
-        "MOCHA_GREP": "${input:mochaGrep}"
+        "MOCHA_GREP": "${input:mochaGrep}",
+        "MDB_IS_TEST": "true"
       },
       "outFiles": ["${workspaceFolder}/out/**/*.js"],
-      "preLaunchTask": "npm: compile:extension",
+      "preLaunchTask": "npm: compile:extension"
     }
   ],
   "inputs": [

package.json

@@ -52,7 +52,7 @@
     "watch:extension-bundles": "webpack --mode development --watch",
     "pretest": "npm run compile",
     "test": "npm run test-webview && npm run test-extension",
-    "test-extension": "cross-env NODE_OPTIONS=--no-force-async-hooks-checks xvfb-maybe node ./out/test/runTest.js",
+    "test-extension": "cross-env MDB_IS_TEST=true NODE_OPTIONS=--no-force-async-hooks-checks xvfb-maybe node ./out/test/runTest.js",
     "test-webview": "mocha -r ts-node/register --grep=\"${MOCHA_GREP}\" --file ./src/test/setup-webview.ts src/test/suite/views/webview-app/**/*.test.tsx",
     "ai-accuracy-tests": "env TS_NODE_FILES=true mocha -r ts-node/register --grep=\"${MOCHA_GREP}\" --file ./src/test/ai-accuracy-tests/test-setup.ts ./src/test/ai-accuracy-tests/ai-accuracy-tests.ts",
     "analyze-bundle": "webpack --mode production --analyze",

src/connectionController.ts

@@ -729,6 +729,7 @@ export default class ConnectionController {
 
     if (!this._activeDataService) {
       log.error('Unable to disconnect: no active connection');
+      this._disconnecting = false;
       return false;
     }
 

src/extension.ts

@@ -21,7 +21,9 @@ debug.log = log.debug.bind(log);
 
 import MDBExtensionController from './mdbExtensionController';
 
-let mdbExtension: MDBExtensionController;
+let mdbExtension: MDBExtensionController | undefined;
+
+const isUnderTest = process.env.MDB_IS_TEST === 'true';
 
 // Called when our extension is activated.
 // See "activationEvents" in `package.json` for the events that cause activation.
@@ -51,13 +53,24 @@ export async function activate(
     },
   });
 
-  mdbExtension = new MDBExtensionController(context, {
-    shouldTrackTelemetry: true,
-  });
-  await mdbExtension.activate();
+  // Solution to VSCODE-700. If we are running tests, don't activate the extension.
+  // This avoids registering multiple providers when running the tests, which causes errors in recent versions of vscode.
+  if (isUnderTest) {
+    log.info(
+      'Skipping MDBExtensionController activation because MDB_IS_TEST is set.',
+    );
+    return;
+  }
 
-  // Add our extension to a list of disposables for when we are deactivated.
-  context.subscriptions.push(mdbExtension);
+  if (!mdbExtension) {
+    mdbExtension = new MDBExtensionController(context, {
+      shouldTrackTelemetry: true,
+    });
+    await mdbExtension.activate();
+
+    // Add our extension to a list of disposables for when we are deactivated.
+    context.subscriptions.push(mdbExtension);
+  }
 }
 
 // Called when our extension is deactivated.

src/test/runTest.ts

@@ -39,7 +39,7 @@ async function main(): Promise<any> {
 
   // Download VS Code, unzip it and run the integration test
   await runTests({
-    version: '1.103.2', // TODO(VSCODE-700) Once we fix the test setup issues, we should revert this to 'insiders'
+    version: 'insiders',
     extensionDevelopmentPath,
     extensionTestsPath,
     launchArgs: [testWorkspace, '--disable-extensions'],

src/test/suite/connectionController.test.ts

@@ -42,7 +42,7 @@ const sleep = (ms: number): Promise<void> => {
 };
 
 suite('Connection Controller Test Suite', function () {
-  this.timeout(5000);
+  this.timeout(10000);
 
   const extensionContextStub = new ExtensionContextStub();
   const testStorageController = new StorageController(extensionContextStub);
@@ -73,6 +73,8 @@ suite('Connection Controller Test Suite', function () {
     extensionContextStub._workspaceState = {};
     extensionContextStub._globalState = {};
 
+    testConnectionController.cancelConnectionAttempt();
+
     await testConnectionController.disconnect();
     testConnectionController.clearAllConnections();