chore(e2e): separate chrome flags and compass flags

Author: gribnoysup

packages/compass-e2e-tests/helpers/chrome-startup-flags.ts

@@ -1,7 +1,7 @@
 // Copied from https://github.com/webdriverio/webdriverio/blob/1825c633aead82bc650dff1f403ac30cff7c7cb3/packages/devtools/src/constants.ts
 // These are the default flags that webdriverio uses to start Chrome driver.
 // NOTE: this has since been removed along with the devtools automation protocol https://github.com/webdriverio/webdriverio/commit/28e64e439ffc36a95f24aeda9f1d21111429dfa3#diff-6ea151d6c0687197931735239f397b7f5f0140a588c5b2b82ff584bbe73be069
-const DEFAULT_WEBDRIVER_FLAGS = [
+export const DEFAULT_WEBDRIVER_FLAGS = [
   // suppresses Save Password prompt window
   '--enable-automation',
   // do not block popups
@@ -45,7 +45,7 @@ const DEFAULT_WEBDRIVER_FLAGS = [
 ];
 
 // These flags are used to start Chrome driver based on the CI requirements.
-const CI_FLAGS = [
+export const CI_FLAGS = [
   // Chromecast feature that is enabled by default in some chrome versions
   // and breaks the app on Ubuntu
   '--media-router=0',
@@ -55,21 +55,24 @@ const CI_FLAGS = [
   // Seeing gpu init related errors on at least RHEL, especially when starting
   // the CLI
   '--disable-gpu',
+  '--num-raster-threads=0',
+  // Seems like disabling gpu is not always enough to prevent chromium from
+  // spawning it anyway, activating in process gpu seems to help with that
+  //
+  // See https://github.com/electron/electron/issues/28164 and
+  // https://www.chromium.org/developers/design-documents/gpu-accelerated-compositing-in-chrome/
+  '--in-process-gpu',
 ];
 
-// These flags are used to start Chrome driver based on the Compass requirements.
-const COMPASS_FLAGS = [
+// The shared set of flags that are used to start Chrome when running Compass
+// desktop and web tests in CLI or GUI mode.
+export const CHROME_STARTUP_FLAGS = [...DEFAULT_WEBDRIVER_FLAGS, ...CI_FLAGS];
+
+// These flags are used to start Chrome based on the Compass requirements.
+export const COMPASS_FLAGS = [
   // Allow options such as --user-data-dir to pass through the command line
   // flag validation code.
   '--ignore-additional-command-line-flags',
   // Use the Atlas dev server for generative ai and atlas requests (cloud-dev).
   '--atlasServiceBackendPreset=atlas-dev',
 ];
-
-// The shared set of flags that are used to start Chrome driver when running Compass
-// tests in CLI or GUI mode.
-export const CHROME_STARTUP_FLAGS = [
-  ...DEFAULT_WEBDRIVER_FLAGS,
-  ...CI_FLAGS,
-  ...COMPASS_FLAGS,
-];

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

@@ -11,6 +11,7 @@ import {
 } from './test-runner-paths';
 import type { ConnectionInfo } from '@mongodb-js/connection-info';
 import ConnectionString from 'mongodb-connection-string-url';
+import { CHROME_STARTUP_FLAGS } from './chrome-startup-flags';
 
 const debug = Debug('compass-e2e-tests:compass-web-sandbox');
 
@@ -31,7 +32,16 @@ const wait = (ms: number) => {
 export function spawnCompassWebSandbox() {
   const proc = crossSpawn.spawn(
     'npm',
-    ['run', '--unsafe-perm', 'start', '--workspace', '@mongodb-js/compass-web'],
+    [
+      'run',
+      '--unsafe-perm',
+      '--workspace',
+      '@mongodb-js/compass-web',
+      'start',
+      '--',
+      '--no-sandbox',
+      '--in-process-gpu',
+    ],
     { env: process.env }
   );
   proc.stdout.pipe(process.stdout);
@@ -56,7 +66,7 @@ export async function waitForCompassWebSandboxToBeReady(
     }
     // No point in trying to fetch sandbox URL right away, give the spawn script
     // some time to run
-    await wait(2000);
+    await wait(5000);
     try {
       const res = await fetch(sandboxUrl);
       serverReady = res.ok;
@@ -90,6 +100,7 @@ export async function spawnCompassWebSandboxAndSignInToAtlas(
       'goog:chromeOptions': {
         binary: ELECTRON_PATH,
         args: [
+          ...CHROME_STARTUP_FLAGS,
           `--user-data-dir=${COMPASS_WEB_WDIO_USER_DATA_PATH}`,
           `--app=${COMPASS_WEB_SANDBOX_RUNNER_PATH}`,
         ],

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

@@ -20,7 +20,7 @@ import type { CompassBrowser } from './compass-browser';
 import type { LogEntry } from './telemetry';
 import Debug from 'debug';
 import semver from 'semver';
-import { CHROME_STARTUP_FLAGS } from './chrome-startup-flags';
+import { CHROME_STARTUP_FLAGS, COMPASS_FLAGS } from './chrome-startup-flags';
 import {
   DEFAULT_CONNECTION_STRINGS,
   DEFAULT_CONNECTION_NAMES,
@@ -494,6 +494,7 @@ export async function runCompassOnce(args: string[], timeout = 30_000) {
       // When running binary without webdriver, we need to pass the same flags
       // as we pass when running with webdriverio to have similar behaviour.
       ...CHROME_STARTUP_FLAGS,
+      ...COMPASS_FLAGS,
       `--user-data-dir=${String(defaultUserDataDir)}`,
       ...args,
     ],
@@ -598,6 +599,8 @@ async function startCompassElectron(
   const { needsCloseWelcomeModal, webdriverOptions, wdioOptions, chromeArgs } =
     await processCommonOpts(opts);
 
+  chromeArgs.push(...COMPASS_FLAGS);
+
   if (!testPackagedApp) {
     // https://www.electronjs.org/docs/latest/tutorial/automated-testing#with-webdriverio
     chromeArgs.push(`--app=${COMPASS_DESKTOP_PATH}`);
@@ -761,14 +764,16 @@ export async function startBrowser(
   assertTestingWeb(context);
 
   runCounter++;
-  const { webdriverOptions, wdioOptions } = await processCommonOpts();
+  const { webdriverOptions, wdioOptions, chromeArgs } =
+    await processCommonOpts();
 
   const browserCapabilities: Record<string, Record<string, unknown>> = {
     chrome: {
       'goog:chromeOptions': {
         prefs: {
           'download.default_directory': downloadPath,
         },
+        args: chromeArgs,
       },
     },
     firefox: {