chore(scripts): refactor update-electron to general purpose update-dependencies; replace usage in CI

.github/workflows/update-electron.yaml

@@ -40,7 +40,7 @@ jobs:
         run: npm ci
 
       - name: Bump packages
-        run: node scripts/update-electron.js
+        run: npx compass-scripts update-dependencies preset-electron
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # 7.0.5

.github/workflows/update-eslint.yaml

@@ -37,11 +37,7 @@ jobs:
           npm install -g [email protected]
 
       - name: Bump eslint
-        run: |
-          npm i --save --workspace @mongodb-js/eslint-config-compass \
-              eslint@8 \
-              @typescript-eslint/eslint-plugin@latest \
-              @typescript-eslint/parser@latest
+        run: npx compass-scripts update-dependencies preset-eslint
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # 7.0.5

scripts/package.json

@@ -39,8 +39,8 @@
     "@babel/core": "^7.24.3",
     "@mongodb-js/monorepo-tools": "^1.1.16",
     "commander": "^11.0.0",
-    "electron": "^36.5.0",
     "jsdom": "^24.1.3",
+    "lodash": "^4.17.21",
     "make-fetch-happen": "^10.2.1",
     "pacote": "^11.3.5",
     "pkg-up": "^3.1.0",

scripts/update-dependencies-config.js

@@ -0,0 +1,28 @@
+'use strict';
+module.exports = {
+  electron: [
+    '@electron/remote',
+    '@electron/rebuild',
+    'browserslist',
+    // NB: We're always trying to update to latest major, this usually implies
+    // breaking changes, but those rarely affect us. If it becomes a problem, we
+    // can always change this code to lock it to whatever major version of
+    // electron compass is currently at
+    'electron',
+    'electron-to-chromium',
+    'node-abi',
+  ],
+  eslint: [
+    '@typescript-eslint/eslint-plugin',
+    '@typescript-eslint/parser',
+    'eslint@8', // TODO: update to flat config, switch to eslint 9, remove the fixed version
+    'eslint-plugin-jsx-a11y',
+    'eslint-plugin-react',
+    'eslint-plugin-react-hooks',
+  ],
+  // TODO(COMPASS-9443): Update update-* github actions to handle all groups as
+  // a matrix inside one action instead of having separate action for every
+  // group and add more groups following the ones in _dependabot
+  // mongosh: [],
+  // 'devtools-shared-prod': [],
+};

scripts/update-dependencies.js

@@ -0,0 +1,168 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+const { isEqual, cloneDeep } = require('lodash');
+const {
+  listAllPackages,
+  runInDir,
+  updatePackageJson,
+  findMonorepoRoot,
+  withProgress,
+} = require('@mongodb-js/monorepo-tools');
+
+const UPDATE_CONFIGS = require('./update-dependencies-config');
+
+async function hoistSharedDependencies(newVersions) {
+  try {
+    const root = await findMonorepoRoot();
+
+    await withProgress('Cleaning up existing node_modules', async () => {
+      await runInDir("npx lerna exec 'rm -Rf node_modules'", root);
+      await runInDir('rm -Rf node_modules', root);
+    });
+
+    const packageJsonBkp = await withProgress(
+      'Updating package-lock to apply package.json changes',
+      async () => {
+        await runInDir('npm i --package-lock-only --ignore-scripts', root);
+        return await fs.promises.readFile(path.resolve(root, 'package.json'));
+      }
+    );
+
+    await withProgress(
+      'Installing new dependencies at root to make sure they are hoisted',
+      async () => {
+        const versionsToInstall = newVersions
+          .map((spec) => {
+            return spec.join('@');
+          })
+          .join(' ');
+        await runInDir(
+          `npm i ${versionsToInstall} --package-lock-only --ignore-scripts`,
+          root
+        );
+      }
+    );
+
+    await withProgress(
+      'Cleaning-up hoisted `dependencies` from root package.json',
+      async () => {
+        await fs.promises.writeFile(
+          path.resolve(root, 'package.json'),
+          packageJsonBkp
+        );
+        await runInDir('npm i', root);
+      }
+    );
+  } catch (error) {
+    console.error(`Error running command: ${error}`);
+  }
+}
+
+async function getVersion(depSpec) {
+  const [name, versionSpec = 'latest'] = depSpec.split(
+    /(?<!^)@/ // split by version, avoid splitting by optional namespace
+  );
+  const { stdout: output } = await runInDir(
+    `npm view ${name}@${versionSpec} version --json`
+  );
+  const parsed = JSON.parse(output);
+  const version = Array.isArray(parsed) ? parsed.pop() : parsed;
+  return [name, version.trim()];
+}
+
+async function main() {
+  let dependencies;
+
+  const args = process.argv.slice(3);
+
+  if (args.length === 0) {
+    throw new Error(
+      'Missing dependencies list. Provide a list of dependencies to update or a preset name:\n\n  npx compass-scripts update-dependencies <package[@version-range] [...packages] | preset>'
+    );
+  }
+
+  if (args[0].startsWith('preset-')) {
+    const presetName = args[0].replace('preset-', '');
+    dependencies = UPDATE_CONFIGS[args[0].replace('preset-', '')];
+    if (!dependencies) {
+      throw new Error(
+        `Can not find update config for preset "${presetName}". Available presets: ${Object.keys(
+          UPDATE_CONFIGS
+        ).join(', ')}`
+      );
+    }
+    console.log();
+    console.log('Running update for preset "%s" ...', presetName);
+    console.log();
+  } else {
+    dependencies = args;
+  }
+
+  const newVersions = await withProgress(
+    `Collection version information for packages...`,
+    () => {
+      return Promise.all(
+        dependencies.map((depSpec) => {
+          return getVersion(depSpec);
+        })
+      );
+    }
+  );
+
+  console.log();
+  console.log(
+    'Updating following packages:\n\n * %s\n',
+    newVersions
+      .map((spec) => {
+        return spec.join('@');
+      })
+      .join('\n * ')
+  );
+  console.log();
+
+  const newVersionsObj = Object.fromEntries(newVersions);
+  let hasChanged;
+
+  await withProgress('Updating package.json in workspaces', async () => {
+    for await (const props of listAllPackages()) {
+      await updatePackageJson(props.location, (packageJson) => {
+        const origPackageJson = cloneDeep(packageJson);
+        for (const depType of [
+          'dependencies',
+          'devDependencies',
+          'peerDependencies',
+          'optionalDependencies',
+        ]) {
+          if (packageJson[depType]) {
+            for (const packageName of Object.keys(packageJson[depType])) {
+              if (
+                packageJson[depType][packageName] &&
+                newVersionsObj[packageName]
+              ) {
+                packageJson[depType][
+                  packageName
+                ] = `^${newVersionsObj[packageName]}`;
+              }
+            }
+          }
+        }
+        hasChanged = hasChanged || !isEqual(origPackageJson, packageJson);
+        return packageJson;
+      });
+    }
+  });
+
+  if (!hasChanged) {
+    console.log();
+    console.log('Everything is up to date, exiting ...');
+    return;
+  }
+
+  await hoistSharedDependencies(newVersions);
+
+  console.log();
+  console.log('Successfully updated dependencies');
+}
+
+main();