chore(e2e): use DEFAULT_CONNECTIONS in connect form helpers

Author: gribnoysup

package-lock.json

@@ -3,14 +3,10 @@ import { expect } from 'chai';
 import type { CompassBrowser } from '../compass-browser';
 import * as Selectors from '../selectors';
 import type { ConnectFormState } from '../connect-form-state';
-import {
-  DEFAULT_CONNECTION_NAME_1,
-  DEFAULT_CONNECTION_NAME_2,
-  DEFAULT_CONNECTION_STRING_1,
-  DEFAULT_CONNECTION_STRING_2,
-  TEST_MULTIPLE_CONNECTIONS,
-} from '../compass';
+import { TEST_MULTIPLE_CONNECTIONS } from '../compass';
 import Debug from 'debug';
+import { DEFAULT_CONNECTIONS } from '../test-runner-context';
+import { getConnectionTitle } from '@mongodb-js/connection-info';
 const debug = Debug('compass-e2e-tests');
 
 export async function resetConnectForm(browser: CompassBrowser): Promise<void> {
@@ -938,29 +934,13 @@ export async function setConnectFormState(
 
 export async function saveConnection(
   browser: CompassBrowser,
-  state: ConnectFormState,
-
-  // TODO(COMPASS-8023): Just remove these once the single connection code is removed
-  favouriteName: string,
-  color: string
+  state: ConnectFormState
 ): Promise<void> {
   await browser.setConnectFormState(state);
-  if (TEST_MULTIPLE_CONNECTIONS) {
-    await browser.clickVisible(Selectors.ConnectionModalSaveButton);
-    await browser
-      .$(Selectors.ConnectionModal)
-      .waitForDisplayed({ reverse: true });
-  } else {
-    await browser.clickVisible(Selectors.ConnectionEditFavouriteButton);
-    await browser.$(Selectors.FavoriteModal).waitForDisplayed();
-    await browser.setValueVisible(Selectors.FavoriteNameInput, favouriteName);
-    await browser.clickVisible(
-      `${Selectors.FavoriteColorSelector} [data-testid="color-pick-${color}"]`
-    );
-    await browser.$(Selectors.FavoriteSaveButton).waitForEnabled();
-    await browser.clickVisible(Selectors.FavoriteSaveButton);
-    await browser.$(Selectors.FavoriteModal).waitForExist({ reverse: true });
-  }
+  await browser.clickVisible(Selectors.ConnectionModalSaveButton);
+  await browser
+    .$(Selectors.ConnectionModal)
+    .waitForDisplayed({ reverse: true });
 }
 
 export async function setupDefaultConnections(browser: CompassBrowser) {
@@ -986,39 +966,20 @@ export async function setupDefaultConnections(browser: CompassBrowser) {
   whereas we do have some tests that try and use those. We can easily change
   this in future if needed, though.
   */
-  for (const connectionName of [
-    DEFAULT_CONNECTION_NAME_1,
-    DEFAULT_CONNECTION_NAME_2,
-  ]) {
+  for (const connectionInfo of DEFAULT_CONNECTIONS) {
+    const connectionName = getConnectionTitle(connectionInfo);
     if (await browser.removeConnection(connectionName)) {
       debug('Removing existing connection so we do not create a duplicate', {
         connectionName,
       });
     }
   }
 
-  await browser.saveConnection(
-    {
-      connectionString: DEFAULT_CONNECTION_STRING_1,
-      // NOTE: no connectionName, we're going with the auto-generated one. Also no
-      // connectionColor. Passing a name and colour for single connection world,
-      // though, because that's the only way to create a favourite.
-    },
-    DEFAULT_CONNECTION_NAME_1,
-    'color1'
-  );
-
-  // no need for a second connection in single connection mode
-  if (TEST_MULTIPLE_CONNECTIONS) {
-    await browser.saveConnection(
-      {
-        connectionString: DEFAULT_CONNECTION_STRING_2,
-        // NOTE: filling in a name so that this one does _not_ have the auto-generated one
-        connectionName: DEFAULT_CONNECTION_NAME_2,
-        connectionColor: 'Iris',
-      },
-      DEFAULT_CONNECTION_NAME_2,
-      'color8'
-    );
+  for (const connectionInfo of DEFAULT_CONNECTIONS) {
+    await browser.saveConnection({
+      connectionString: connectionInfo.connectionOptions.connectionString,
+      connectionName: connectionInfo.favorite?.name,
+      connectionColor: connectionInfo.favorite?.color,
+    });
   }
 }

packages/compass-e2e-tests/helpers/commands/connect-form.ts

@@ -40,6 +40,8 @@ import {
   WEBDRIVER_DEFAULT_WAITFOR_INTERVAL,
   TEST_COMPASS_DESKTOP_PACKAGED_APP,
   ELECTRON_PATH,
+  COMPASS_WEB_BROWSER_NAME,
+  COPMASS_WEB_BROWSER_VERSION,
 } from './test-runner-context';
 
 const debug = Debug('compass-e2e-tests');
@@ -70,12 +72,6 @@ export function skipForWeb(
   }
 }
 
-function getBrowserName() {
-  return process.env.BROWSER_NAME ?? 'chrome';
-}
-
-export const BROWSER_NAME = getBrowserName();
-
 export const MONGODB_TEST_SERVER_PORT = Number(
   process.env.MONGODB_TEST_SERVER_PORT ?? 27091
 );
@@ -724,18 +720,10 @@ export async function startBrowser(
 
   const options: RemoteOptions = {
     capabilities: {
-      browserName: BROWSER_NAME, // 'chrome' or 'firefox'
-      // https://webdriver.io/docs/driverbinaries/
-      // If you leave out browserVersion it will try and find the browser binary
-      // on your system. If you specify it it will download that version. The
-      // main limitation then is that 'latest' is the only 'semantic' version
-      // that is supported for Firefox.
-      // https://github.com/puppeteer/puppeteer/blob/ab5d4ac60200d1cea5bcd4910f9ccb323128e79a/packages/browsers/src/browser-data/browser-data.ts#L66
-      // Alternatively we can download it ourselves and specify the path to the
-      // binary or we can even start and stop chromedriver/geckodriver manually.
-      // NOTE: The version of chromedriver or geckodriver in play might also be
-      // relevant.
-      browserVersion: 'latest',
+      browserName: COMPASS_WEB_BROWSER_NAME,
+      ...(COPMASS_WEB_BROWSER_VERSION && {
+        browserVersion: COPMASS_WEB_BROWSER_VERSION,
+      }),
     },
     ...webdriverOptions,
     ...wdioOptions,

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

@@ -2,16 +2,16 @@ import {
   getConnectionTitle,
   type ConnectionInfo,
 } from '@mongodb-js/connection-info';
-import ConnectionString from 'mongodb-connection-string-url';
 import path from 'path';
 import electronPath from 'electron';
 import electronPackageJson from 'electron/package.json';
 // @ts-expect-error no types for this package
 import { electronToChromium } from 'electron-to-chromium';
+import type { MongoClusterOptions } from 'mongodb-runner';
 
 if (typeof electronPath !== 'string') {
   throw new Error(
-    'Running e2e tests in an unsupported runtime: `electron` is not a string'
+    'Running e2e tests in an unsupported runtime: `electronPath` is not a string'
   );
 }
 
@@ -43,12 +43,42 @@ export const SKIP_NATIVE_MODULE_REBUILD =
 export const DISABLE_START_STOP = process.argv.includes('--disable-start-stop');
 export const MOCHA_BAIL = process.argv.includes('--bail');
 
-export const DEFAULT_CONNECTIONS: ConnectionInfo[] = [
+export const COMPASS_WEB_BROWSER_NAME = process.env.BROWSER_NAME ?? 'chrome';
+// https://webdriver.io/docs/driverbinaries/
+//
+// If you leave out browserVersion it will try and find the browser binary on
+// your system. If you specify it it will download that version. The main
+// limitation then is that 'latest' is the only 'semantic' version that is
+// supported for Firefox.
+// https://github.com/puppeteer/puppeteer/blob/ab5d4ac60200d1cea5bcd4910f9ccb323128e79a/packages/browsers/src/browser-data/browser-data.ts#L66
+//
+// Alternatively we can download it ourselves and specify the path to the binary
+// or we can even start and stop chromedriver/geckodriver manually.
+//
+// NOTE: The version of chromedriver or geckodriver in play might also be
+// relevant.
+export const COPMASS_WEB_BROWSER_VERSION =
+  process.env.BROWSER_VERSION === 'unset'
+    ? undefined
+    : process.env.BROWSER_VERSION ?? 'latest';
+
+const MONGODB_TESTSERVER_VERSION =
+  process.env.MONGODB_VERSION ?? process.env.MONGODB_RUNNER_VERSION;
+
+export const DEFAULT_CONNECTIONS: (ConnectionInfo & {
+  testServer?: Partial<MongoClusterOptions>;
+})[] = [
   {
     id: 'test-connection-1',
     connectionOptions: {
       connectionString: 'mongodb://127.0.0.1:27091/test',
     },
+    testServer: {
+      version: MONGODB_TESTSERVER_VERSION,
+      topology: 'replset',
+      secondaries: 0,
+      args: ['--port', '27091'],
+    },
   },
   {
     id: 'test-connection-2',
@@ -57,6 +87,13 @@ export const DEFAULT_CONNECTIONS: ConnectionInfo[] = [
     },
     favorite: {
       name: 'connection-2',
+      color: 'Iris',
+    },
+    testServer: {
+      version: MONGODB_TESTSERVER_VERSION,
+      topology: 'replset',
+      secondaries: 0,
+      args: ['--port', '27092'],
     },
   },
 ];
@@ -69,11 +106,6 @@ export const DEFAULT_CONNECTION_NAMES = DEFAULT_CONNECTIONS.map((info) => {
   return getConnectionTitle(info);
 });
 
-export const DEFAULT_CONNECTION_PORTS = DEFAULT_CONNECTIONS.map((info) => {
-  const str = new ConnectionString(info.connectionOptions.connectionString);
-  return Number(str.hosts[0].split(':')[1]);
-});
-
 export const DEFAULT_CONNECTIONS_SERVER_INFO: {
   version: string;
   enterprise: boolean;

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

@@ -2,7 +2,7 @@ import gunzip from './gunzip';
 import path from 'path';
 import fs from 'fs';
 import {
-  DEFAULT_CONNECTION_PORTS,
+  DEFAULT_CONNECTIONS,
   DEFAULT_CONNECTIONS_SERVER_INFO,
   DISABLE_START_STOP,
   E2E_WORKSPACE_PATH,
@@ -26,6 +26,7 @@ import {
   rebuildNativeModules,
   removeUserDataDir,
 } from './compass';
+import { getConnectionTitle } from '@mongodb-js/connection-info';
 
 export const globalFixturesAbortController = new AbortController();
 
@@ -75,21 +76,22 @@ export async function mochaGlobalSetup(this: Mocha.Runner) {
     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();
-        });
+      for (const connectionInfo of DEFAULT_CONNECTIONS) {
+        if (connectionInfo.testServer) {
+          debug(
+            'Starting MongoDB server for connection %s',
+            getConnectionTitle(connectionInfo)
+          );
+          const server = await startTestServer(connectionInfo.testServer);
+          servers.push(server);
+          cleanupFns.push(() => {
+            debug(
+              'Stopping server for connection %s',
+              getConnectionTitle(connectionInfo)
+            );
+            return server.close();
+          });
+        }
         throwIfAborted();
       }
 

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

@@ -80,7 +80,7 @@ async function main() {
     return index >= minGroupIndex && index <= maxGroupIndex;
   });
 
-  console.info('Test files:', rawTests);
+  debug('Test files:', rawTests);
 
   // The only test file that's interested in the first-run experience (at the
   // time of writing) is time-to-first-query.ts and that happens to be
@@ -107,7 +107,7 @@ async function main() {
   mocha.rootHooks(mochaRootHooks);
 
   // print the test order for debugging purposes and so we can tweak the groups later
-  console.log('test order', tests);
+  debug('Test order:', tests);
 
   tests.forEach((testPath: string) => {
     mocha.addFile(path.join(__dirname, testPath));

packages/compass-e2e-tests/index.ts

@@ -72,6 +72,7 @@
     "tree-kill": "^1.2.2",
     "ts-node": "^10.9.1",
     "webdriverio": "^8.40.0",
+    "why-is-node-running": "^3.2.0",
     "xvfb-maybe": "^0.2.1"
   }
 }