chore(e2e): provide clearer names for runtime assertion methods (#7891)

gribnoysup · web-flow · commit 6b001f78667b · 2026-03-23T14:01:36.000+01:00
* chore(e2e): provide clearer names for runtime assertion methods

* chore(e2e): a better name and clearer comment
diff --git a/packages/compass-e2e-tests/helpers/commands/connect-form.ts b/packages/compass-e2e-tests/helpers/commands/connect-form.ts
@@ -6,7 +6,7 @@ import type { ConnectFormState } from '../connect-form-state';
 import Debug from 'debug';
 import {
   DEFAULT_CONNECTIONS,
-  isTestingAtlasCloud,
+  isTestingWebAtlasCloud,
 } from '../test-runner-context';
 import { getConnectionTitle } from '@mongodb-js/connection-info';
 const debug = Debug('compass-e2e-tests');
@@ -935,7 +935,7 @@ let screenshotCounter = 0;
 export async function setupDefaultConnections(browser: CompassBrowser) {
   // When running tests against Atlas Cloud, connections can't be added or
   // removed from the UI manually, so we skip setup for default connections
-  if (isTestingAtlasCloud()) {
+  if (isTestingWebAtlasCloud()) {
     return;
   }
 
diff --git a/packages/compass-e2e-tests/helpers/commands/connect.ts b/packages/compass-e2e-tests/helpers/commands/connect.ts
@@ -6,7 +6,7 @@ import Debug from 'debug';
 import {
   getDefaultConnectionNames,
   getDefaultConnectionStrings,
-  isTestingAtlasCloud,
+  isTestingWebAtlasCloud,
 } from '../test-runner-context';
 
 const debug = Debug('compass-e2e-tests');
@@ -52,7 +52,7 @@ export async function connectWithConnectionString(
   // When testing Atlas Cloud, we can't really create a new connection, so just
   // assume a connection name was passed (with a fallback to a default one) and
   // try to use it
-  if (isTestingAtlasCloud()) {
+  if (isTestingWebAtlasCloud()) {
     await browser.connectByName(
       connectionStringOrName ?? getDefaultConnectionNames(0)
     );
diff --git a/packages/compass-e2e-tests/helpers/compass.ts b/packages/compass-e2e-tests/helpers/compass.ts
@@ -27,7 +27,7 @@ import {
   isTestingDesktop,
   context,
   assertTestingWeb,
-  isTestingAtlasCloud,
+  isTestingWebAtlasCloud,
   getCloudUrlsFromContext,
 } from './test-runner-context';
 import {
@@ -807,7 +807,7 @@ export async function startBrowser(
   const { webdriverOptions, wdioOptions } = await processCommonOpts();
 
   const browserName = context.browserName as 'chrome' | 'firefox';
-  const redirectExtension = isTestingAtlasCloud(context)
+  const redirectExtension = isTestingWebAtlasCloud(context)
     ? await (async () => {
         return getExtension(
           COMPASS_WEB_ENTRYPOINT_HOST,
@@ -821,7 +821,7 @@ export async function startBrowser(
       prefs: {
         'download.default_directory': downloadPath,
       },
-      args: isTestingAtlasCloud(context)
+      args: isTestingWebAtlasCloud(context)
         ? [
             // We're going to be hitting localhost from remote domain, LNA needs
             // to be disabled
@@ -842,7 +842,7 @@ export async function startBrowser(
         // Hide the download (progress) panel
         'browser.download.alwaysOpenPanel': false,
 
-        ...(isTestingAtlasCloud(context) && {
+        ...(isTestingWebAtlasCloud(context) && {
           // Need to disable LNA (see above)
           'network.lna.skip-domains': '*.mongodb.com',
         }),
@@ -873,7 +873,7 @@ export async function startBrowser(
     needsCloseWelcomeModal: false,
   });
 
-  if (isTestingAtlasCloud(context)) {
+  if (isTestingWebAtlasCloud(context)) {
     // In firefox extension needs to be loaded via special Gecko command and
     // should be provided as a base64 string with compressed extension
     if (browserName === 'firefox') {
@@ -1123,7 +1123,7 @@ export async function init(
 
   const { browser } = compass;
 
-  if (isTestingAtlasCloud(context)) {
+  if (isTestingWebAtlasCloud(context)) {
     await browser.signInToAtlas(
       context.atlasCloudUsername,
       context.atlasCloudPassword
@@ -1141,7 +1141,7 @@ export async function init(
   if (isTestingWeb(context)) {
     await opts.onBeforeNavigate?.(browser);
 
-    if (isTestingAtlasCloud(context)) {
+    if (isTestingWebAtlasCloud(context)) {
       const urls = getCloudUrlsFromContext();
       await browser.navigateTo(
         `${urls.cloudUrl}/v2/${context.atlasCloudProjectId}#/explorer`
diff --git a/packages/compass-e2e-tests/helpers/test-runner-context.ts b/packages/compass-e2e-tests/helpers/test-runner-context.ts
@@ -276,10 +276,16 @@ if (context.browserVersion === undefined) {
     context.browserName === 'firefox' ? 'latest' : 'stable';
 }
 
+/**
+ * Returns true if the tests are running against Compass desktop
+ */
 export function isTestingDesktop(ctx = context): ctx is DesktopParsedArgs {
   return testEnv === 'desktop';
 }
 
+/**
+ * Returns if tests are running against Compass desktop. Throws otherwise
+ */
 export function assertTestingDesktop(
   ctx = context
 ): asserts ctx is DesktopParsedArgs {
@@ -290,10 +296,16 @@ export function assertTestingDesktop(
   }
 }
 
+/**
+ * Returns true if tests are running against compass-web in either local sandbox or integrated in Atlas Cloud
+ */
 export function isTestingWeb(ctx = context): ctx is WebParsedArgs {
   return testEnv === 'web';
 }
 
+/**
+ * Returns if tests are running against compass-web in either local sandbox or integrated in Atlas Cloud. Throws otherwise
+ */
 export function assertTestingWeb(ctx = context): asserts ctx is WebParsedArgs {
   if (!isTestingWeb(ctx)) {
     throw new Error(
@@ -302,16 +314,22 @@ export function assertTestingWeb(ctx = context): asserts ctx is WebParsedArgs {
   }
 }
 
-export function isTestingAtlasCloud(
+/**
+ * Returns true if tests are running against compass-web in cloud-<env>.mongodb.com
+ */
+export function isTestingWebAtlasCloud(
   ctx = context
 ): ctx is AtlasCloudParsedArgs {
   return isTestingWeb(ctx) && !!ctx.testAtlasCloud;
 }
 
-export function assertTestingAtlasCloud(
+/**
+ * Returns if tests are running against compass-web in cloud-<env>.mongodb.com. Throws otherwise
+ */
+export function assertTestingWebAtlasCloud(
   ctx = context
 ): asserts ctx is WebParsedArgs & AtlasCloudParsedArgs {
-  if (!isTestingAtlasCloud(ctx)) {
+  if (!isTestingWebAtlasCloud(ctx)) {
     throw new Error(`Expected tested runtime to be web w/ Atlas Cloud account`);
   }
 }
@@ -342,7 +360,7 @@ type TestConnectionInfo = ConnectionInfo & {
   testServer?: Partial<MongoClusterOptions>;
 };
 
-export const DEFAULT_CONNECTIONS: TestConnectionInfo[] = isTestingAtlasCloud(
+export const DEFAULT_CONNECTIONS: TestConnectionInfo[] = isTestingWebAtlasCloud(
   context
 )
   ? []
@@ -437,7 +455,7 @@ const CLOUD_URLS = {
 } as const;
 
 export function getCloudUrlsFromContext(ctx = context) {
-  assertTestingAtlasCloud(ctx);
+  assertTestingWebAtlasCloud(ctx);
   return CLOUD_URLS[context.atlasCloudEnvironment as keyof typeof CLOUD_URLS];
 }
 
@@ -459,7 +477,7 @@ export const ATLAS_CLOUD_TEST_UTILS: {
     : 'null'
 );
 
-if (isTestingAtlasCloud() && !ATLAS_CLOUD_TEST_UTILS) {
+if (isTestingWebAtlasCloud() && !ATLAS_CLOUD_TEST_UTILS) {
   throw new Error(
     'Trying to test Atlas Cloud environment, but test utils config is not provided. Make sure that ATLAS_CLOUD_TEST_UTILS env variable is available'
   );
diff --git a/packages/compass-e2e-tests/helpers/test-runner-global-fixtures.ts b/packages/compass-e2e-tests/helpers/test-runner-global-fixtures.ts
@@ -1,13 +1,13 @@
 import gunzip from './gunzip';
 import fs from 'fs';
 import {
-  assertTestingAtlasCloud,
+  assertTestingWebAtlasCloud,
   ATLAS_CLOUD_TEST_UTILS,
   context,
   DEFAULT_CONNECTIONS,
   DEFAULT_CONNECTIONS_SERVER_INFO,
   getCloudUrlsFromContext,
-  isTestingAtlasCloud,
+  isTestingWebAtlasCloud,
   isTestingDesktop,
   isTestingWeb,
   RUN_ID,
@@ -81,7 +81,7 @@ export function allowServerWarnings(...filters: WarningFilter[]): () => void {
 }
 
 async function createAtlasCloudResources() {
-  assertTestingAtlasCloud(context);
+  assertTestingWebAtlasCloud(context);
 
   debug('Creating Atlas Cloud resources...');
 
@@ -305,7 +305,7 @@ export async function mochaGlobalSetup(this: Mocha.Runner) {
         throwIfAborted();
       }
 
-      if (isTestingAtlasCloud(context)) {
+      if (isTestingWebAtlasCloud(context)) {
         // Both tasks can take a decent amount of time and are not overlapping
         // with each other, so we can run them in parallel
         await Promise.all([
diff --git a/packages/compass-e2e-tests/tests/atlas-cloud/collection-ai-query.test.ts b/packages/compass-e2e-tests/tests/atlas-cloud/collection-ai-query.test.ts
@@ -10,15 +10,15 @@ import {
 import type { Compass } from '../../helpers/compass';
 import * as Selectors from '../../helpers/selectors';
 import { createNumbersCollection } from '../../helpers/mongo-clients';
-import { isTestingAtlasCloud } from '../../helpers/test-runner-context';
+import { isTestingWebAtlasCloud } from '../../helpers/test-runner-context';
 import { switchPipelineMode } from '../../helpers/commands/switch-pipeline-mode';
 
 describe('Collection ai query (with real Cloud backend)', function () {
   let compass: Compass;
   let browser: CompassBrowser;
 
   before(function () {
-    if (!isTestingAtlasCloud()) {
+    if (!isTestingWebAtlasCloud()) {
       this.skip();
     }
   });
diff --git a/packages/compass-e2e-tests/tests/atlas-cloud/error-states.test.ts b/packages/compass-e2e-tests/tests/atlas-cloud/error-states.test.ts
@@ -2,15 +2,15 @@ import type { Compass } from '../../helpers/compass';
 import { cleanup, init, screenshotIfFailed } from '../../helpers/compass';
 import {
   context,
-  assertTestingAtlasCloud,
-  isTestingAtlasCloud,
+  assertTestingWebAtlasCloud,
+  isTestingWebAtlasCloud,
 } from '../../helpers/test-runner-context';
 
 describe('Error states', function () {
   let compass: Compass;
 
   before(function () {
-    if (!isTestingAtlasCloud()) {
+    if (!isTestingWebAtlasCloud()) {
       this.skip();
     }
   });
@@ -23,7 +23,7 @@ describe('Error states', function () {
   it('should show error state if fetching connection info failed initially', async function () {
     compass = await init(this.test?.fullTitle(), {
       async onBeforeNavigate(browser) {
-        assertTestingAtlasCloud(context);
+        assertTestingWebAtlasCloud(context);
         const mock = await browser.mock(
           `/explorer/v1/groups/${context.atlasCloudProjectId}/clusters/connectionInfo`
         );
diff --git a/packages/compass-e2e-tests/tests/atlas-cloud/global-writes.test.ts b/packages/compass-e2e-tests/tests/atlas-cloud/global-writes.test.ts
@@ -10,7 +10,7 @@ import type { CompassBrowser } from '../../helpers/compass-browser';
 import { createGeospatialCollection } from '../../helpers/mongo-clients';
 import {
   getDefaultConnectionNames,
-  isTestingAtlasCloud,
+  isTestingWebAtlasCloud,
 } from '../../helpers/test-runner-context';
 
 type GeoShardingFormData = {
@@ -74,7 +74,7 @@ describe('Global writes', function () {
   let browser: CompassBrowser;
 
   before(function () {
-    if (!isTestingAtlasCloud()) {
+    if (!isTestingWebAtlasCloud()) {
       this.skip();
     }
   });
diff --git a/packages/compass-e2e-tests/tests/atlas-cloud/rolling-indexes.test.ts b/packages/compass-e2e-tests/tests/atlas-cloud/rolling-indexes.test.ts
@@ -9,15 +9,15 @@ import type { CompassBrowser } from '../../helpers/compass-browser';
 import { createNumbersCollection } from '../../helpers/mongo-clients';
 import {
   getDefaultConnectionNames,
-  isTestingAtlasCloud,
+  isTestingWebAtlasCloud,
 } from '../../helpers/test-runner-context';
 
 describe('Rolling indexes', function () {
   let compass: Compass;
   let browser: CompassBrowser;
 
   before(function () {
-    if (!isTestingAtlasCloud()) {
+    if (!isTestingWebAtlasCloud()) {
       this.skip();
     }
   });
