chore: replset for test servers and better cleanup

Author: gribnoysup

package.json

@@ -32,8 +32,6 @@
     "package-compass": "npm run package-compass --workspace=mongodb-compass --",
     "package-compass-debug": "npm run package-compass-debug --workspace=mongodb-compass --",
     "package-compass-nocompile": "npm run package-compass-nocompile --workspace=mongodb-compass --",
-    "prestart": "npm run compile --workspace=@mongodb-js/webpack-config-compass",
-    "prestart-web": "npm run prestart",
     "start": "npm run start --workspace=mongodb-compass",
     "start-web": "npm run start --workspace=@mongodb-js/compass-web",
     "test": "lerna run test --concurrency 1 --stream",

packages/compass-e2e-tests/helpers/compass.ts

@@ -8,7 +8,7 @@ import { execFile } from 'child_process';
 import type { ExecFileOptions, ExecFileException } from 'child_process';
 import { promisify } from 'util';
 import zlib from 'zlib';
-import { remote } from 'webdriverio';
+import { remote, RemoteOptions } from 'webdriverio';
 import { rebuild } from '@electron/rebuild';
 import type { RebuildOptions } from '@electron/rebuild';
 import type { ConsoleMessageType } from 'puppeteer';
@@ -721,7 +721,7 @@ export async function startBrowser(
   runCounter++;
   const { webdriverOptions, wdioOptions } = await processCommonOpts();
 
-  const browser: CompassBrowser = (await remote({
+  const options: RemoteOptions = {
     capabilities: {
       browserName: BROWSER_NAME, // 'chrome' or 'firefox'
       // https://webdriver.io/docs/driverbinaries/
@@ -738,8 +738,14 @@ export async function startBrowser(
     },
     ...webdriverOptions,
     ...wdioOptions,
-  })) as CompassBrowser;
+  };
+
+  debug('Starting compass via webdriverio with the following configuration:');
+  debug(JSON.stringify(options, null, 2));
+
+  const browser: CompassBrowser = (await remote(options)) as CompassBrowser;
   await browser.navigateTo('http://localhost:7777/');
+
   const compass = new Compass(name, browser, {
     mode: 'web',
     writeCoverage: false,

packages/compass-e2e-tests/helpers/gunzip.ts

@@ -1,28 +1,34 @@
 import Debug from 'debug';
 import fastGlob from 'fast-glob';
 import { createReadStream, createWriteStream } from 'fs';
-import { pipeline } from 'stream';
-import { promisify } from 'util';
+import { pipeline } from 'stream/promises';
 import { createGunzip } from 'zlib';
 
 const debug = Debug('compass-e2e-tests:gunzip');
 
-const pipe = promisify(pipeline);
-
-async function gunzip(input: string, output: string) {
+async function gunzip(input: string, output: string, signal: AbortSignal) {
   const readStream = createReadStream(input);
   const gunzip = createGunzip();
   const writeStream = createWriteStream(output);
-
-  await pipe(readStream, gunzip, writeStream);
+  try {
+    await pipeline(readStream, gunzip, writeStream, { signal, end: true });
+  } catch (err) {
+    if (signal.aborted) {
+      return;
+    }
+    throw err;
+  }
 }
 
-async function run(glob: string) {
+async function run(glob: string, signal: AbortSignal) {
   const filenames = await fastGlob(glob);
   for (const input of filenames) {
+    if (signal.aborted) {
+      return;
+    }
     const output = input.replace(/\.gz$/, '');
     debug(input, '=>', output);
-    await gunzip(input, output);
+    await gunzip(input, output, signal);
   }
 }
 

packages/compass-e2e-tests/helpers/test-runner-context.ts

@@ -71,7 +71,7 @@ export const DEFAULT_CONNECTION_NAMES = DEFAULT_CONNECTIONS.map((info) => {
 
 export const DEFAULT_CONNECTION_PORTS = DEFAULT_CONNECTIONS.map((info) => {
   const str = new ConnectionString(info.connectionOptions.connectionString);
-  return str.hosts[0].split(':')[1];
+  return Number(str.hosts[0].split(':')[1]);
 });
 
 export const DEFAULT_CONNECTIONS_SERVER_INFO: {

packages/compass-e2e-tests/helpers/test-runner-global-fixtures.ts

@@ -9,6 +9,7 @@ import {
   LOG_PATH,
   SKIP_COMPASS_DESKTOP_COMPILE,
   SKIP_NATIVE_MODULE_REBUILD,
+  TEST_COMPASS_DESKTOP,
   TEST_COMPASS_DESKTOP_PACKAGED_APP,
   TEST_COMPASS_WEB,
 } from './test-runner-context';
@@ -26,6 +27,16 @@ import {
   removeUserDataDir,
 } from './compass';
 
+export const globalFixturesAbortController = new AbortController();
+
+function throwIfAborted() {
+  if (globalFixturesAbortController.signal.aborted) {
+    throw new Error('Mocha run was aborted while global setup was in progress');
+  }
+}
+
+export let abortRunner: (() => void) | undefined;
+
 const debug = Debug('compass-e2e-tests:mocha-global-fixtures');
 
 const wait = (ms: number) =>
@@ -47,74 +58,100 @@ const servers: MongoCluster[] = [];
  *  - Compiles the desktop app
  */
 export async function mochaGlobalSetup(this: Mocha.Runner) {
-  debug('Unzipping fixtures...');
-  await gunzip(path.join(E2E_WORKSPACE_PATH, 'fixtures', '*.gz'));
-
-  debug('X DISPLAY', process.env.DISPLAY);
-
-  if (!DISABLE_START_STOP) {
-    debug('Starting MongoDB servers');
-
-    for (const port of DEFAULT_CONNECTION_PORTS) {
-      const server = await startTestServer({
-        args: ['--port', port],
-        version:
-          process.env.MONGODB_VERSION ?? process.env.MONGODB_RUNNER_VERSION,
-      });
-      servers.push(server);
-      cleanupFns.push(() => {
-        debug('Stopping server at port %s', port);
-        return server.close();
-      });
-    }
+  abortRunner = () => {
+    globalFixturesAbortController.abort();
+    this.abort();
+  };
 
-    if (TEST_COMPASS_WEB) {
-      debug('Starting Compass Web');
-      const compassWeb = spawnCompassWeb();
-      cleanupFns.push(() => {
-        if (compassWeb.pid) {
-          debug(`Killing compass-web [${compassWeb.pid}]`);
-          kill(compassWeb.pid, 'SIGINT');
-        } else {
-          debug('No pid for compass-web');
-        }
-      });
-      await waitForCompassWebToBeReady();
+  try {
+    debug('Unzipping fixtures...');
+    await gunzip(
+      path.join(E2E_WORKSPACE_PATH, 'fixtures', '*.gz'),
+      globalFixturesAbortController.signal
+    );
+
+    throwIfAborted();
+
+    debug('X DISPLAY', process.env.DISPLAY);
+
+    if (!DISABLE_START_STOP) {
+      debug('Starting MongoDB servers');
+
+      for (const port of DEFAULT_CONNECTION_PORTS) {
+        const server = await startTestServer({
+          topology: 'replset',
+          secondaries: 0,
+          args: ['--port', String(port)],
+          version:
+            process.env.MONGODB_VERSION ?? process.env.MONGODB_RUNNER_VERSION,
+        });
+        servers.push(server);
+        cleanupFns.push(() => {
+          debug('Stopping server at port %s', port);
+          return server.close();
+        });
+        throwIfAborted();
+      }
+
+      if (TEST_COMPASS_WEB) {
+        debug('Starting Compass Web');
+        const compassWeb = spawnCompassWeb();
+        cleanupFns.push(() => {
+          if (compassWeb.pid) {
+            debug(`Killing compass-web [${compassWeb.pid}]`);
+            kill(compassWeb.pid, 'SIGINT');
+          } else {
+            debug('No pid for compass-web');
+          }
+        });
+        await waitForCompassWebToBeReady();
+      }
     }
-  }
 
-  debug('Getting mongodb server info');
-  await updateMongoDBServerInfo();
+    debug('Getting mongodb server info');
+    await updateMongoDBServerInfo();
 
-  try {
-    debug('Clearing out past logs');
-    fs.rmdirSync(LOG_PATH, { recursive: true });
-  } catch (e) {
-    debug('.log dir already removed');
-  }
+    throwIfAborted();
 
-  fs.mkdirSync(LOG_PATH, { recursive: true });
+    try {
+      debug('Clearing out past logs');
+      fs.rmdirSync(LOG_PATH, { recursive: true });
+    } catch (e) {
+      debug('.log dir already removed');
+    }
+
+    fs.mkdirSync(LOG_PATH, { recursive: true });
 
-  if (TEST_COMPASS_DESKTOP_PACKAGED_APP) {
-    debug('Building Compass before running the tests ...');
-    await buildCompass();
-  } else {
-    debug('Preparing Compass before running the tests');
+    if (TEST_COMPASS_DESKTOP) {
+      if (TEST_COMPASS_DESKTOP_PACKAGED_APP) {
+        debug('Building Compass before running the tests ...');
+        await buildCompass();
+      } else {
+        debug('Preparing Compass before running the tests');
 
-    if (!SKIP_NATIVE_MODULE_REBUILD) {
-      debug('Rebuilding native modules ...');
-      await rebuildNativeModules();
+        if (!SKIP_NATIVE_MODULE_REBUILD) {
+          debug('Rebuilding native modules ...');
+          await rebuildNativeModules();
+        }
+
+        if (!SKIP_COMPASS_DESKTOP_COMPILE) {
+          debug('Compiling Compass assets ...');
+          await compileCompassAssets();
+        }
+      }
     }
 
-    if (!SKIP_COMPASS_DESKTOP_COMPILE) {
-      debug('Compiling Compass assets ...');
-      await compileCompassAssets();
+    throwIfAborted();
+
+    cleanupFns.push(() => {
+      removeUserDataDir();
+    });
+  } catch (err) {
+    if (globalFixturesAbortController.signal.aborted) {
+      return;
     }
+    throw err;
   }
-
-  cleanupFns.push(() => {
-    removeUserDataDir();
-  });
 }
 
 export async function mochaGlobalTeardown() {
@@ -127,13 +164,18 @@ export async function mochaGlobalTeardown() {
 }
 
 function spawnCompassWeb() {
-  const proc = crossSpawn.spawn('npm', [
-    'run',
-    '--unsafe-perm',
-    'start-web',
-    '--workspace',
-    '@mongodb-js/compass-web',
-  ]);
+  const proc = crossSpawn.spawn(
+    'npm',
+    ['run', '--unsafe-perm', 'start', '--workspace', '@mongodb-js/compass-web'],
+    {
+      env: {
+        ...process.env,
+        OPEN_BROWSER: 'false', // tell webpack dev server not to open the default browser
+        DISABLE_DEVSERVER_OVERLAY: 'true',
+        APP_ENV: 'webdriverio',
+      },
+    }
+  );
   proc.stdout.pipe(process.stdout);
   proc.stderr.pipe(process.stderr);
   return proc;
@@ -143,6 +185,7 @@ async function waitForCompassWebToBeReady() {
   let serverReady = false;
   const start = Date.now();
   while (!serverReady) {
+    throwIfAborted();
     if (Date.now() - start >= 120_000) {
       throw new Error(
         'The compass-web sandbox is still not running after 120000ms'
@@ -153,7 +196,7 @@ async function waitForCompassWebToBeReady() {
       serverReady = res.ok;
       debug('Web server ready:', serverReady);
     } catch (err) {
-      debug('Failed to connect to dev server', err);
+      debug('Failed to connect to dev server:', (err as any).message);
     }
     await wait(1000);
   }