Merge remote-tracking branch 'origin/main' into restructure-e2e-test-runner

This also includes re-applying changes from #6381 from scratch

Author: gribnoysup

.evergreen/functions.yml

@@ -664,7 +664,7 @@ functions:
           DEBUG: ${debug|}
           MONGODB_VERSION: ${mongodb_version|}
           MONGODB_RUNNER_VERSION: ${mongodb_version|}
-          BROWSER_NAME: ${browser_name}
+          COMPASS_WEB_BROWSER_NAME: ${browser_name}
           E2E_TEST_GROUPS: ${e2e_test_groups}
           E2E_TEST_GROUP: ${e2e_test_group}
         script: |

.evergreen/print-compass-env.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-export MONGODB_DEFAULT_VERSION=6.0.x
+export MONGODB_DEFAULT_VERSION=7.0.x
 
 if [[ $OSTYPE == "cygwin" ]]; then
     export PLATFORM='win32'

AUTHORS

@@ -92,3 +92,4 @@ admin-token-bot <[email protected]>
 Kræn Hansen <[email protected]>
 Kræn Hansen <[email protected]>
 Ruchitha Rajaghatta <[email protected]>
+syn-zhu <[email protected]>

THIRD-PARTY-NOTICES.md

@@ -1,5 +1,5 @@
 The following third-party software is used by and included in **Mongodb Compass**.
-This document was automatically generated on Thu Oct 17 2024.
+This document was automatically generated on Tue Oct 22 2024.
 
 ## List of dependencies
 

docs/tracking-plan.md

@@ -1,7 +1,7 @@
 
 # Compass Tracking Plan
 
-Generated on Thu, Oct 17, 2024 at 03:33 PM
+Generated on Tue, Oct 22, 2024 at 04:10 PM
 
 ## Table of Contents
 

packages/atlas-service/src/main.ts

@@ -376,10 +376,7 @@ export class CompassAuthService {
 
       await throwIfNotOk(res);
 
-      const userInfo = (await res.json()) as AtlasUserInfo;
-
-      // TODO: Remove hadcoded `enabledAIFeature: true` when Atlas returns the actual value.
-      return { ...userInfo, enabledAIFeature: true };
+      return (await res.json()) as AtlasUserInfo;
     })();
     return this.currentUser;
   }

packages/atlas-service/src/util.ts

@@ -9,7 +9,7 @@ export type AtlasUserInfo = {
   lastName: string;
   primaryEmail: string;
   login: string;
-} & { enabledAIFeature: boolean };
+};
 
 export type IntrospectInfo = { active: boolean };
 

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

@@ -41,7 +41,12 @@ import {
   TEST_COMPASS_DESKTOP_PACKAGED_APP,
   ELECTRON_PATH,
   COMPASS_WEB_BROWSER_NAME,
-  COPMASS_WEB_BROWSER_VERSION,
+  COMPASS_WEB_BROWSER_VERSION,
+  TEST_ATLAS_CLOUD_EXTERNAL,
+  TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE,
+  TEST_ATLAS_CLOUD_EXTERNAL_URL,
+  TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID,
+  COMPASS_WEB_SANDBOX_URL,
 } from './test-runner-context';
 
 const debug = Debug('compass-e2e-tests');
@@ -710,6 +715,16 @@ async function startCompassElectron(
   return compass;
 }
 
+export type StoredAtlasCloudCookies = {
+  name: string;
+  value: string;
+  domain: string;
+  path: string;
+  secure: boolean;
+  httpOnly: boolean;
+  expirationDate: number;
+}[];
+
 export async function startBrowser(
   name: string,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -721,19 +736,66 @@ export async function startBrowser(
   const options: RemoteOptions = {
     capabilities: {
       browserName: COMPASS_WEB_BROWSER_NAME,
-      ...(COPMASS_WEB_BROWSER_VERSION && {
-        browserVersion: COPMASS_WEB_BROWSER_VERSION,
+      ...(COMPASS_WEB_BROWSER_VERSION && {
+        browserVersion: COMPASS_WEB_BROWSER_VERSION,
       }),
     },
     ...webdriverOptions,
     ...wdioOptions,
   };
 
-  debug('Starting compass via webdriverio with the following configuration:');
+  debug('Starting browser 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/');
+
+  if (TEST_ATLAS_CLOUD_EXTERNAL) {
+    // To be able to use `setCookies` method, we need to first open any page on
+    // the same domain as the cookies we are going to set
+    // https://webdriver.io/docs/api/browser/setCookies/
+    await browser.navigateTo(`${TEST_ATLAS_CLOUD_EXTERNAL_URL!}/404`);
+
+    type StoredAtlasCloudCookies = {
+      name: string;
+      value: string;
+      domain: string;
+      path: string;
+      secure: boolean;
+      httpOnly: boolean;
+      expirationDate: number;
+    }[];
+
+    const cookies: StoredAtlasCloudCookies = JSON.parse(
+      await fs.readFile(TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE!, 'utf8')
+    );
+
+    await browser.setCookies(
+      cookies
+        .filter((cookie) => {
+          // These are the relevant cookies for auth:
+          // https://github.com/10gen/mms/blob/6d27992a6ab9ab31471c8bcdaa4e347aa39f4013/server/src/features/com/xgen/svc/cukes/helpers/Client.java#L122-L130
+          return (
+            cookie.name.includes('mmsa-') ||
+            cookie.name.includes('mdb-sat') ||
+            cookie.name.includes('mdb-srt')
+          );
+        })
+        .map((cookie) => ({
+          name: cookie.name,
+          value: cookie.value,
+          domain: cookie.domain,
+          path: cookie.path,
+          secure: cookie.secure,
+          httpOnly: cookie.httpOnly,
+        }))
+    );
+
+    await browser.navigateTo(
+      `${TEST_ATLAS_CLOUD_EXTERNAL_URL!}/v2/${TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID!}#/explorer`
+    );
+  } else {
+    await browser.navigateTo(COMPASS_WEB_SANDBOX_URL);
+  }
 
   const compass = new Compass(name, browser, {
     mode: 'web',

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

@@ -25,7 +25,46 @@ export const ALLOWED_RUNNER_ARGS = [
   '--bail',
 ];
 
-export const TEST_COMPASS_WEB = process.argv.includes('--test-compass-web');
+/**
+ * Variables used by a special use-case of running e2e tests against a
+ * cloud(-dev).mongodb.com URL. If you're changing anything related to these,
+ * make sure that the tests in mms are also updated to account for that
+ */
+export const TEST_ATLAS_CLOUD_EXTERNAL_URL =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_URL;
+export const TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE;
+export const TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID;
+const TEST_ATLAS_CLOUD_EXTERNAL_DEFAULT_CONNECTIONS: ConnectionInfo[] | null =
+  JSON.parse(process.env.TEST_ATLAS_CLOUD_DEFAULT_CONNECTIONS ?? 'null');
+
+const ALL_ATLAS_CLOUD_EXTERNAL_VARS = [
+  TEST_ATLAS_CLOUD_EXTERNAL_URL,
+  TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE,
+  TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID,
+  TEST_ATLAS_CLOUD_EXTERNAL_DEFAULT_CONNECTIONS,
+];
+
+export const TEST_ATLAS_CLOUD_EXTERNAL = ALL_ATLAS_CLOUD_EXTERNAL_VARS.some(
+  (val) => {
+    return !!val;
+  }
+);
+
+if (
+  TEST_ATLAS_CLOUD_EXTERNAL &&
+  ALL_ATLAS_CLOUD_EXTERNAL_VARS.some((val) => {
+    return !val;
+  })
+) {
+  throw new Error(
+    'Trying to test Atlas Cloud external URL but some required variables are missing'
+  );
+}
+
+export const TEST_COMPASS_WEB =
+  process.argv.includes('--test-compass-web') || TEST_ATLAS_CLOUD_EXTERNAL;
 export const TEST_COMPASS_DESKTOP = !TEST_COMPASS_WEB;
 export const TEST_COMPASS_DESKTOP_PACKAGED_APP = process.argv.includes(
   '--test-packaged-app'
@@ -57,46 +96,50 @@ export const COMPASS_WEB_BROWSER_NAME = process.env.BROWSER_NAME ?? 'chrome';
 //
 // NOTE: The version of chromedriver or geckodriver in play might also be
 // relevant.
-export const COPMASS_WEB_BROWSER_VERSION =
+export const COMPASS_WEB_BROWSER_VERSION =
   process.env.BROWSER_VERSION === 'unset'
     ? undefined
     : process.env.BROWSER_VERSION ?? 'latest';
+export const COMPASS_WEB_SANDBOX_URL = 'http://localhost:7777';
 
 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',
-    connectionOptions: {
-      connectionString: 'mongodb://127.0.0.1:27092/test',
-    },
-    favorite: {
-      name: 'connection-2',
-      color: 'Iris',
-    },
-    testServer: {
-      version: MONGODB_TESTSERVER_VERSION,
-      topology: 'replset',
-      secondaries: 0,
-      args: ['--port', '27092'],
-    },
-  },
-];
+})[] =
+  TEST_ATLAS_CLOUD_EXTERNAL && TEST_ATLAS_CLOUD_EXTERNAL_DEFAULT_CONNECTIONS
+    ? TEST_ATLAS_CLOUD_EXTERNAL_DEFAULT_CONNECTIONS
+    : [
+        {
+          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',
+          connectionOptions: {
+            connectionString: 'mongodb://127.0.0.1:27092/test',
+          },
+          favorite: {
+            name: 'connection-2',
+            color: 'Iris',
+          },
+          testServer: {
+            version: MONGODB_TESTSERVER_VERSION,
+            topology: 'replset',
+            secondaries: 0,
+            args: ['--port', '27092'],
+          },
+        },
+      ];
 
 export const DEFAULT_CONNECTION_STRINGS = DEFAULT_CONNECTIONS.map((info) => {
   return info.connectionOptions.connectionString;

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

@@ -1,19 +1,20 @@
 import gunzip from './gunzip';
 import fs from 'fs';
 import {
+  COMPASS_WEB_SANDBOX_URL,
   DEFAULT_CONNECTIONS,
   DEFAULT_CONNECTIONS_SERVER_INFO,
   DISABLE_START_STOP,
   E2E_WORKSPACE_PATH,
   LOG_PATH,
   SKIP_COMPASS_DESKTOP_COMPILE,
   SKIP_NATIVE_MODULE_REBUILD,
+  TEST_ATLAS_CLOUD_EXTERNAL,
   TEST_COMPASS_DESKTOP,
   TEST_COMPASS_DESKTOP_PACKAGED_APP,
   TEST_COMPASS_WEB,
 } from './test-runner-context';
 import Debug from 'debug';
-import type { MongoCluster } from '@mongodb-js/compass-test-server';
 import { startTestServer } from '@mongodb-js/compass-test-server';
 import crossSpawn from 'cross-spawn';
 import kill from 'tree-kill';
@@ -46,8 +47,6 @@ const wait = (ms: number) =>
 
 const cleanupFns: (() => Promise<void> | void)[] = [];
 
-const servers: MongoCluster[] = [];
-
 /**
  * Main hook that does all the main pre-setup before running tests:
  *  - Unpacks the fixtures
@@ -85,7 +84,6 @@ export async function mochaGlobalSetup(this: Mocha.Runner) {
             getConnectionTitle(connectionInfo)
           );
           const server = await startTestServer(connectionInfo.testServer);
-          servers.push(server);
           cleanupFns.push(() => {
             debug(
               'Stopping server for connection %s',
@@ -97,8 +95,8 @@ export async function mochaGlobalSetup(this: Mocha.Runner) {
         throwIfAborted();
       }
 
-      if (TEST_COMPASS_WEB) {
-        debug('Starting Compass Web');
+      if (TEST_COMPASS_WEB && !TEST_ATLAS_CLOUD_EXTERNAL) {
+        debug('Starting Compass Web server ...');
         const compassWeb = spawnCompassWeb();
         cleanupFns.push(() => {
           if (compassWeb.pid) {
@@ -196,7 +194,7 @@ async function waitForCompassWebToBeReady() {
       );
     }
     try {
-      const res = await fetch('http://localhost:7777');
+      const res = await fetch(COMPASS_WEB_SANDBOX_URL);
       serverReady = res.ok;
       debug('Web server ready:', serverReady);
     } catch (err) {
@@ -208,22 +206,19 @@ async function waitForCompassWebToBeReady() {
 
 async function updateMongoDBServerInfo() {
   try {
-    const [info1, info2] = await Promise.all(
-      servers.map(async (server) => {
-        let client: MongoClient | undefined;
-        try {
-          client = new MongoClient(server.connectionString);
-          const info = await client.db('admin').command({ buildInfo: 1 });
-          return {
-            version: info.version,
-            enterprise: isEnterprise(info),
-          };
-        } finally {
-          void client?.close(true);
-        }
-      })
-    );
-    DEFAULT_CONNECTIONS_SERVER_INFO.push(info1, info2);
+    for (const { connectionOptions } of DEFAULT_CONNECTIONS) {
+      let client: MongoClient | undefined;
+      try {
+        client = new MongoClient(connectionOptions.connectionString);
+        const info = await client.db('admin').command({ buildInfo: 1 });
+        DEFAULT_CONNECTIONS_SERVER_INFO.push({
+          version: info.version,
+          enterprise: isEnterprise(info),
+        });
+      } finally {
+        void client?.close(true);
+      }
+    }
   } catch (err) {
     debug('Failed to get MongoDB server info:', err);
   }