Test auto-updating from the version of Compass that was just packaged

Author: lerouxb

package-lock.json

@@ -1426,3 +1426,12 @@ export const GlobalWrites = {
   SampleFindingDocuments: '[data-testid="sample-finding-documents"]',
   SampleInsertingDocuments: '[data-testid="sample-inserting-documents"]',
 };
+
+// Auto-update toasts
+export const AutoUpdateToast = '[data-testid="toast-compass-update"]';
+export const AutoUpdateRestartButton =
+  '[data-testid="auto-update-restart-button"]';
+export const AutoUpdateDownloadLink =
+  '[data-testid="auto-update-download-link"]';
+export const AutoUpdateReleaseNotesLink =
+  '[data-testid="auto-update-release-notes-link"]';

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

@@ -0,0 +1,67 @@
+import { expect } from 'chai';
+import {
+  init,
+  cleanup,
+  Selectors,
+  screenshotPathName,
+} from '../helpers/compass';
+
+describe('Auto-update', function () {
+  it('auto-update from', async function () {
+    if (process.env.TEST_NAME !== 'AUTO_UPDATE_FROM') {
+      // we don't want this test to execute along with all the others under
+      // normal circumstances because it is destructive - it overwrites Compass
+      // itself
+      this.skip();
+    }
+
+    // run the app and wait for it to auto-update
+    console.log('starting compass the first time');
+    const compass = await init('auto-update from', { firstRun: true });
+    const { browser } = compass;
+    try {
+      await browser.$(Selectors.AutoUpdateToast).waitForDisplayed();
+
+      if (process.env.AUTO_UPDATE_UPDATABLE === 'true') {
+        const restartButton = browser.$(Selectors.AutoUpdateRestartButton);
+        await restartButton.waitForDisplayed();
+
+        // We could click the restart button to apply the update and restart the
+        // app, but restarting the app confuses webdriverio or at least our test
+        // helpers. So we're going to just restart the app manually.
+        await browser.pause(1000);
+      } else {
+        // When auto-update is not supported the toast contains a link to
+        // download
+        const linkElement = browser.$(Selectors.AutoUpdateDownloadLink);
+        await linkElement.waitForDisplayed();
+        expect(await linkElement.getAttribute('href')).to.equal(
+          'https://www.mongodb.com/try/download/compass'
+        );
+      }
+    } finally {
+      await browser.screenshot(screenshotPathName('auto-update-from'));
+      await cleanup(compass);
+    }
+
+    if (process.env.AUTO_UPDATE_UPDATABLE === 'true') {
+      console.log('starting compass a second time');
+      // run the app again and check that the version changed
+      const compass = await init('auto-update from restart', {
+        firstRun: false,
+      });
+      const { browser } = compass;
+      try {
+        await browser.$(Selectors.AutoUpdateToast).waitForDisplayed();
+        await browser
+          .$(Selectors.AutoUpdateReleaseNotesLink)
+          .waitForDisplayed();
+      } finally {
+        await browser.screenshot(
+          screenshotPathName('auto-update-from-restart')
+        );
+        await cleanup(compass);
+      }
+    }
+  });
+});

packages/compass-e2e-tests/tests/auto-update.test.ts

@@ -34,11 +34,13 @@
     "@mongodb-js/eslint-config-compass": "^1.2.1",
     "@mongodb-js/prettier-config-compass": "^1.1.1",
     "@mongodb-js/tsconfig-compass": "^1.1.1",
+    "cross-spawn": "^7.0.5",
     "depcheck": "^1.4.1",
     "eslint": "^7.25.0",
     "hadron-build": "^25.6.1",
     "lodash": "^4.17.21",
     "prettier": "^2.7.1",
+    "tree-kill": "^1.2.2",
     "typescript": "^5.0.4",
     "yargs": "^17.7.2"
   }

packages/compass-smoke-tests/package.json

@@ -3,6 +3,8 @@ import assert from 'node:assert/strict';
 import fs from 'node:fs';
 import path from 'node:path';
 
+import crossSpawn from 'cross-spawn';
+import kill from 'tree-kill';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { pick } from 'lodash';
@@ -175,7 +177,9 @@ async function run() {
     ])
   );
 
-  const { kind, buildInfo, filepath } = await getTestSubject(context);
+  const { kind, buildInfo, filepath, autoUpdatable } = await getTestSubject(
+    context
+  );
   const install = getInstaller(kind);
 
   try {
@@ -188,7 +192,25 @@ async function run() {
     });
 
     try {
-      runTest({ appName, appPath });
+      const server = startAutoUpdateServer({
+        allowDowngrades: true,
+        port: 8080,
+      });
+      try {
+        runTest({
+          appName,
+          appPath,
+          autoUpdatable,
+          testName: 'AUTO_UPDATE_FROM',
+        });
+      } finally {
+        if (server.pid) {
+          console.log('Stopping auto-update server');
+          kill(server.pid, 'SIGINT');
+        } else {
+          console.log('cannnot stop auto-update server because no pid');
+        }
+      }
     } finally {
       await uninstall();
     }
@@ -198,12 +220,55 @@ async function run() {
   }
 }
 
+type AutoUpdateServerOptions = {
+  port: number;
+  allowDowngrades?: boolean;
+};
+
+function startAutoUpdateServer({
+  port,
+  allowDowngrades,
+}: AutoUpdateServerOptions) {
+  const env: Record<string, string> = {
+    ...process.env,
+    PORT: port.toString(),
+  };
+  if (allowDowngrades) {
+    env.UPDATE_CHECKER_ALLOW_DOWNGRADES = 'true';
+  }
+
+  // a git repo that is not published to npm that evergreen clones for us in CI
+  // next to the Compass code
+  const cwd = path.join(
+    __dirname,
+    '..',
+    '..',
+    '..',
+    '..',
+    'compass-mongodb-com'
+  );
+
+  if (!fs.existsSync(cwd)) {
+    throw new Error(`compass-mongodb-com does not exist: ${cwd}`);
+  }
+
+  console.log('Starting auto-update server');
+  return crossSpawn('npm', ['run', 'start'], { env, cwd, shell: true });
+}
+
 type RunTestOptions = {
   appName: string;
   appPath: string;
+  autoUpdatable?: boolean;
+  testName: string;
 };
 
-function runTest({ appName, appPath }: RunTestOptions) {
+function runTest({
+  appName,
+  appPath,
+  autoUpdatable,
+  testName,
+}: RunTestOptions) {
   execute(
     'npm',
     [
@@ -213,11 +278,14 @@ function runTest({ appName, appPath }: RunTestOptions) {
       '--workspace',
       'compass-e2e-tests',
       '--',
-      '--test-filter=time-to-first-query',
+      '--test-filter=auto-update',
     ],
     {
       env: {
         ...process.env,
+        HADRON_AUTO_UPDATE_ENDPOINT_OVERRIDE: 'http://localhost:8080',
+        AUTO_UPDATE_UPDATABLE: (!!autoUpdatable).toString(),
+        TEST_NAME: testName,
         COMPASS_APP_NAME: appName,
         COMPASS_APP_PATH: appPath,
       },