run the update server programmatically

Author: lerouxb

.evergreen/functions.yml

@@ -677,6 +677,9 @@ functions:
           echo "Using g++ version:"
           g++ --version;
           npm ci --engine-strict=false
+          npm link --engine-strict=false
+          cd ../compass
+          npm link compass-mongodb-com --engine-strict=false
 
   smoketest-packaged-app:
     - command: shell.exec

packages/compass-smoke-tests/package.json

@@ -34,14 +34,20 @@
     "@mongodb-js/eslint-config-compass": "^1.2.5",
     "@mongodb-js/prettier-config-compass": "^1.1.5",
     "@mongodb-js/tsconfig-compass": "^1.1.5",
-    "cross-spawn": "^7.0.5",
     "depcheck": "^1.4.1",
     "eslint": "^7.25.0",
     "hadron-build": "^25.6.5",
     "lodash": "^4.17.21",
     "prettier": "^2.7.1",
-    "tree-kill": "^1.2.2",
     "typescript": "^5.0.4",
     "yargs": "^17.7.2"
+  },
+  "peerDependencies": {
+    "compass-mongodb-com": "*"
+  },
+  "peerDependenciesMeta": {
+    "compass-mongodb-com": {
+      "optional": true
+    }
   }
 }

packages/compass-smoke-tests/src/cli.ts

@@ -2,13 +2,12 @@
 import assert from 'node:assert/strict';
 import fs from 'node:fs';
 import path from 'node:path';
+import { once } from 'node:events';
 
-import crossSpawn from 'cross-spawn';
-import kill from 'tree-kill';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { pick } from 'lodash';
-import { execute } from './execute';
+import { execute, executeAsync } from './execute';
 import {
   type PackageDetails,
   readPackageDetails,
@@ -226,7 +225,7 @@ async function run() {
           });
         }
         if (testName === 'auto-update-from') {
-          runUpdateTest({
+          await runUpdateTest({
             appName,
             appPath,
             autoUpdatable,
@@ -247,45 +246,22 @@ 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';
+async function importUpdateServer() {
+  try {
+    return (await import('compass-mongodb-com')).default;
+  } catch (err: unknown) {
+    console.log('Remember to npm link compass-mongodb-com');
+    throw err;
   }
+}
 
-  // 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}`);
-  }
+async function startAutoUpdateServer() {
+  console.log('Starting auto-update server');
+  const { httpServer, updateChecker, start } = (await importUpdateServer())();
+  start();
+  await once(updateChecker, 'refreshed');
 
-  console.log('Starting auto-update server', cwd);
-  return crossSpawn.spawn('npm', ['run', 'start'], {
-    env,
-    cwd,
-    stdio: 'inherit',
-    shell: true,
-  });
+  return httpServer;
 }
 
 type RunE2ETestOptions = {
@@ -324,18 +300,26 @@ type RunUpdateTestOptions = {
   testName: string;
 };
 
-function runUpdateTest({
+async function runUpdateTest({
   appName,
   appPath,
   autoUpdatable,
   testName,
 }: RunUpdateTestOptions) {
-  const server = startAutoUpdateServer({
-    allowDowngrades: true,
-    port: 8080,
-  });
+  process.env.PORT = '0'; // dynamic port
+  process.env.UPDATE_CHECKER_ALLOW_DOWNGRADES = 'true';
+
+  const server = await startAutoUpdateServer();
+
+  const address = server.address();
+  assert(typeof address === 'object' && address !== null);
+  const port = address.port;
+  const HADRON_AUTO_UPDATE_ENDPOINT_OVERRIDE = `http://localhost:${port}`;
+  console.log({ HADRON_AUTO_UPDATE_ENDPOINT_OVERRIDE });
+
   try {
-    execute(
+    // must be async because the update server is running in the same process
+    await executeAsync(
       'npm',
       [
         'run',
@@ -351,7 +335,7 @@ function runUpdateTest({
         shell: true,
         env: {
           ...process.env,
-          HADRON_AUTO_UPDATE_ENDPOINT_OVERRIDE: 'http://localhost:8080',
+          HADRON_AUTO_UPDATE_ENDPOINT_OVERRIDE,
           AUTO_UPDATE_UPDATABLE: (!!autoUpdatable).toString(),
           TEST_NAME: testName,
           COMPASS_APP_NAME: appName,
@@ -360,12 +344,9 @@ function runUpdateTest({
       }
     );
   } 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');
-    }
+    console.log('Stopping auto-update server');
+    server.close();
+    delete process.env.UPDATE_CHECKER_ALLOW_DOWNGRADES;
   }
 }
 

packages/compass-smoke-tests/src/compass-mongodb-com.d.ts

@@ -0,0 +1,9 @@
+declare module 'compass-mongodb-com' {
+  import type http from 'http';
+  function updateServer(): {
+    start: () => void;
+    httpServer: http.Server;
+    updateChecker: NodeJS.EventEmitter;
+  };
+  export = updateServer;
+}

packages/compass-smoke-tests/src/execute.ts

@@ -1,4 +1,4 @@
-import { spawnSync, type SpawnOptions } from 'node:child_process';
+import { spawn, spawnSync, type SpawnOptions } from 'node:child_process';
 
 export class ExecuteFailure extends Error {
   constructor(
@@ -13,16 +13,11 @@ export class ExecuteFailure extends Error {
     super(`${commandDetails} exited with ${statusDetails} ${signalDetails}`);
   }
 }
-
 export function execute(
   command: string,
   args: string[],
   options?: SpawnOptions
 ) {
-  // print the command so that when it outputs to stdout we can see where it
-  // comes from
-  console.log(command, args);
-
   const { status, signal } = spawnSync(command, args, {
     stdio: 'inherit',
     ...options,
@@ -31,3 +26,40 @@ export function execute(
     throw new ExecuteFailure(command, args, status, signal);
   }
 }
+
+export function executeAsync(
+  command: string,
+  args: string[],
+  options?: SpawnOptions
+): Promise<void> {
+  return new Promise((resolve, reject) => {
+    console.log(command, ...args);
+    const child = spawn(command, args, {
+      stdio: 'inherit',
+      ...options,
+    });
+    const killChild = () => child.kill();
+    const interruptChild = () => child.kill('SIGINT');
+    process.once('exit', killChild);
+    process.once('SIGINT', interruptChild);
+    child.once('error', reject);
+    child.once('exit', (code, signal) => {
+      process.off('exit', killChild);
+      process.off('SIGINT', interruptChild);
+      if (code !== null) {
+        if (code === 0) {
+          resolve();
+        } else {
+          reject(new ExecuteFailure(command, args, code, null));
+        }
+      } else {
+        if (signal !== null) {
+          reject(new ExecuteFailure(command, args, null, signal));
+        } else {
+          // shouldn't happen
+          reject(new ExecuteFailure(command, args, null, null));
+        }
+      }
+    });
+  });
+}

packages/compass-smoke-tests/tsconfig.json

@@ -3,7 +3,11 @@
   "compilerOptions": {
     "noEmit": true,
     "types": ["node"],
-    "lib": ["ES2021"]
+    "lib": ["ES2021"],
+    "module": "NodeNext",
+    "paths": {
+      "compass-mongodb-com": ["./src/compass-mongodb-com.d.ts"]
+    }
   },
   "include": ["src/**/*"]
 }