chore(e2e): consolidate shared initial preferences configuration in init command; use preferences to disable guide cues (#7530)

* chore(e2e): consolidate shared initial preferences configuration in init command; use preferences to disable guide cues

* fix(e2e): await the invoke when checking for ipc channel being ready

* chore(e2e): set zoomLevel to 0 (1 is not default)

* fix(e2e): only validate whether preference was set if it exists

Author: gribnoysup

packages/compass-components/src/components/guide-cue/guide-cue.tsx

@@ -256,8 +256,7 @@ export const GuideCue = <T extends HTMLElement>({
     };
   }, [isCueOpen, cueData, onNext, setOpen]);
 
-  const isCueDisabled =
-    context.disabled || process.env.DISABLE_GUIDE_CUES === 'true';
+  const isCueDisabled = context.disabled;
 
   return (
     <>

packages/compass-e2e-tests/helpers/commands/close-welcome-modal.ts

@@ -22,5 +22,5 @@ export async function closeWelcomeModal(
   // does something like location.reload() immediately it definitely won't show
   // the welcome modal a second time. It is kinda irrelevant which setting we
   // use, but it must be an uncontrolled one
-  await browser.setFeature('zoomLevel', 1);
+  await browser.setFeature('zoomLevel', 0);
 }

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

@@ -6,36 +6,39 @@ import type {
 import { isTestingWeb } from '../test-runner-context';
 import { inspect } from 'util';
 
-function _waitUntilPreferencesAccessAvailable(
+async function _waitUntilPreferencesAccessAvailable(
   browser: CompassBrowser
 ): Promise<void> {
+  const waitUntilOptions = {
+    timeoutMsg: 'Preferences are not available',
+    interval: 3000,
+  };
+
   if (!isTestingWeb()) {
-    return browser.waitUntil(() => {
-      return browser.execute(() => {
+    await browser.waitUntil(() => {
+      return browser.execute(async () => {
         try {
           // eslint-disable-next-line @typescript-eslint/no-require-imports
-          require('electron').ipcRenderer.invoke(
-            'compass:save-preferences', // this will throw if handler is not registered yet
+          await require('electron').ipcRenderer.invoke(
+            'compass:save-preferences', // this will reject if handler is not registered yet
             {}
           );
           return true;
         } catch {
           return false;
         }
       });
-    });
-  }
-  return browser.waitUntil(
-    () => {
+    }, waitUntilOptions);
+  } else {
+    await browser.waitUntil(() => {
       return browser.execute(() => {
         const kSandboxPreferencesAccess = Symbol.for(
           '@compass-web-sandbox-preferences-access'
         );
         return kSandboxPreferencesAccess in globalThis;
       });
-    },
-    { timeoutMsg: 'Preferences are not available' }
-  );
+    }, waitUntilOptions);
+  }
 }
 
 function _setFeatureWeb<K extends keyof UserPreferences>(
@@ -57,18 +60,19 @@ function _setFeatureWeb<K extends keyof UserPreferences>(
   );
 }
 
-function _setFeatureDesktop<K extends keyof UserPreferences>(
+async function _setFeatureDesktop<K extends keyof UserPreferences>(
   browser: CompassBrowser,
   name: K,
   value: UserPreferences[K]
 ): Promise<AllPreferences> {
-  return browser.execute(
-    (_name, _value) => {
+  return await browser.execute(
+    async (_name, _value) => {
       // eslint-disable-next-line @typescript-eslint/no-require-imports
-      return require('electron').ipcRenderer.invoke(
+      const newPreferences = await require('electron').ipcRenderer.invoke(
         'compass:save-preferences',
         { [_name]: _value === null ? undefined : _value }
       );
+      return newPreferences;
     },
     name,
     value
@@ -94,15 +98,20 @@ export async function setFeature<K extends keyof UserPreferences>(
   let latestValue: UserPreferences[K];
   try {
     await _waitUntilPreferencesAccessAvailable(browser);
+    const currentPreferences = await getFeatures(browser);
+    // We can be running tests against compass version where the preference
+    // doesn't exist yet (older compass build in smoke tests for example), in
+    // that case setting preference does nothing, so we will skip the validation
+    const doesPreferenceExists = name in currentPreferences;
     await browser.waitUntil(
       async () => {
         const newPreferences = await (isTestingWeb()
           ? _setFeatureWeb
           : _setFeatureDesktop)(browser, name, value);
         latestValue = newPreferences[name];
-        return isEqual(latestValue, value);
+        return doesPreferenceExists ? isEqual(latestValue, value) : true;
       },
-      { interval: 500 }
+      { interval: 1000 }
     );
   } catch (err) {
     const expected = inspect(value);
@@ -135,9 +144,14 @@ export async function getFeature<K extends keyof AllPreferences>(
   browser: CompassBrowser,
   name: K
 ): Promise<AllPreferences[K]> {
+  return (await getFeatures(browser))[name];
+}
+
+export async function getFeatures(
+  browser: CompassBrowser
+): Promise<AllPreferences> {
   await _waitUntilPreferencesAccessAvailable(browser);
-  const allPreferences = await (isTestingWeb()
-    ? _getFeaturesWeb
-    : _getFeaturesDesktop)(browser);
-  return allPreferences[name];
+  return await (isTestingWeb() ? _getFeaturesWeb : _getFeaturesDesktop)(
+    browser
+  );
 }

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

@@ -655,14 +655,6 @@ async function startCompassElectron(
     process.env.HADRON_PRODUCT_NAME_OVERRIDE = 'MongoDB Compass WebdriverIO';
   }
 
-  // Guide cues might affect too many tests in a way where the auto showing of the cue prevents
-  // clicks from working on elements. Dealing with this case-by-case is way too much work, so
-  // we disable the cues completely for the e2e tests
-  process.env.DISABLE_GUIDE_CUES = 'true';
-
-  // Making sure end-of-life connection modal is not shown, simplify any test connecting to such a server
-  process.env.COMPASS_DISABLE_END_OF_LIFE_CONNECTION_MODAL = 'true';
-
   // TODO(COMPASS-9977) Turn off virtual scrolling in e2e tests until we can fix
   // browser.scrollToVirtualItem() to work with it
   process.env.COMPASS_DISABLE_VIRTUAL_TABLE_RENDERING = 'true';
@@ -1084,6 +1076,26 @@ function augmentError(error: Error, stack: string) {
   error.stack = `${error.stack ?? ''}\nvia ${strippedLines.join('\n')}`;
 }
 
+async function setSharedConfigOnStart(browser: CompassBrowser) {
+  // Guide cues might affect too many tests in a way where the auto showing of
+  // the cue prevents clicks from working on elements. Dealing with this
+  // case-by-case is way too much work, so we disable the cues completely for
+  // the e2e tests
+  await browser.setFeature('enableGuideCues', false);
+
+  // Making sure end-of-life connection modal is not shown, simplify any test
+  // connecting to such a server
+  await browser.setFeature('showEndOfLifeConnectionModal', false);
+
+  // Nice-to-have for desktop tests: if devtools are enabled, you don't need to
+  // spend time enabling them manually in settings
+  await browser.setFeature('enableDevTools', true, () => {
+    // Do not validate that the value was set: some tests might pre-configure
+    // Compass in a way where changing this config is not allowed
+    return true;
+  });
+}
+
 export async function init(
   name?: string,
   opts: StartCompassOptions = {}
@@ -1100,8 +1112,7 @@ export async function init(
 
   const { browser } = compass;
 
-  // For browser.executeAsync(). Trying to see if it will work for browser.execute() too.
-  await browser.setTimeout({ script: 5_000 });
+  await setSharedConfigOnStart(browser);
 
   if (TEST_COMPASS_WEB) {
     // larger window for more consistent results

packages/compass-preferences-model/src/preferences-schema.tsx

@@ -134,6 +134,7 @@ export type InternalUserPreferences = {
     isMaximized?: boolean;
     isFullScreen?: boolean;
   };
+  enableGuideCues: boolean;
 };
 
 // UserPreferences contains all preferences stored to disk.
@@ -450,11 +451,7 @@ export const storedUserPreferencesProps: Required<{
     cli: false,
     global: false,
     description: null,
-    validator: z
-      .boolean()
-      .default(
-        process.env.COMPASS_DISABLE_END_OF_LIFE_CONNECTION_MODAL !== 'true'
-      ),
+    validator: z.boolean().default(true),
     type: 'boolean',
   },
   /**
@@ -488,6 +485,17 @@ export const storedUserPreferencesProps: Required<{
       .optional(),
     type: 'object',
   },
+  /**
+   * Whether or not guide cues are enabled in the application
+   */
+  enableGuideCues: {
+    ui: false,
+    cli: false,
+    global: false,
+    description: null,
+    validator: z.boolean().default(true),
+    type: 'boolean',
+  },
   /**
    * Enable/disable the AI services. This is currently set
    * in the atlas-service initialization where we make a request to the
@@ -721,7 +729,7 @@ export const storedUserPreferencesProps: Required<{
       long: `Enable the Chromium Developer Tools that can be used to debug Electron's process.`,
     },
     deriveValue: deriveFeatureRestrictingOptionsState('enableDevTools'),
-    validator: z.boolean().default(process.env.APP_ENV === 'webdriverio'),
+    validator: z.boolean().default(false),
     type: 'boolean',
   },
   /**