chore: enhance npm start command to run compass sync and sandbox COMPASS-9851 #7338

nbbeeken · 2025-09-18T03:57:14Z

Description

`npm start++`

There is now a script responsible for multi-process launching to enable and encourage mulitplatform testing of compass and DE changes. npm start will still launch compass as per usual.

New Commands:

npm start desktop sync sandbox

Provide each one of the subcommands optionally to combine launching each environment to start testing changes in parallel.

Note that the sync command still requires use of a redirector / redwood extension in your browser.

Checklist

New tests and/or benchmarks are included
Documentation is changed or added
If this change updates the UI, screenshots/videos are added and a design review is requested
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

In the effort of DE and Compass unification hopefully this change will make verifying in both environements easy and commonplace to squash inconsistency early on in development.

Bugfix
New feature
Dependency update
Misc

Open Questions

Dependents

Types of changes

Backport Needed
Patch (non-breaking change which fixes an issue)
Minor (non-breaking change which adds functionality)
Major (fix or feature that would cause existing functionality to change)

packages/compass-web/scripts/sync-dist-to-mms.mts

packages/compass-web/scripts/sync-dist-to-mms.mjs

scripts/start.mts

packages/compass-web/scripts/sync-dist-to-mms.mjs

gribnoysup · 2025-09-18T07:37:05Z

packages/compass-web/scripts/sync-dist-to-mms.mjs

+  child_process.execFileSync('pnpm', ['run', 'init'], {
+    cwd: process.env.MMS_HOME,
+    stdio: 'inherit',
+  });


You don't need init, it's doing the same thing that start will do right after

Yea I always thought the output looks similar but pressing enter on the command in my terminal history was easier than looking into why 🤦🏻 lol thank you!

gribnoysup · 2025-09-18T07:48:24Z

scripts/start.mts

+  desktop: { enabled: false, args: [] as string[] },
+  sandbox: { enabled: false, args: [] as string[] },


desktop and sandbox currently have ports in common, so you can't run then in parallel, you might want to adjust that

just made sandbox something you have to run alone because of the way things are shared, I think desktop & sync are more likely to be used in parallel? at least by our team. But happy to dig deeper if you have a better idea of what needs to be changed.

Like I changed the compass-web dev server port but then something else is using that config because I get a port reuse error 🤔

Yeah, this makes sense

gribnoysup · 2025-09-18T07:51:47Z

scripts/start.mts

+
+  const paddedName = targetName.padEnd(8);
+  console.log(`start    | ${spawnArgs[0]} ${spawnArgs[1].join(' ')}`);
+  const subProcess = child_process.spawn(...spawnArgs);


You need to pipe stdin also. Desktop command in particular has support for extra commands to restart the process / pass extra args:

desktop | <i> [webpack-plugin-start-electron] Starting electron application desktop | <i> [webpack-plugin-start-electron] - Ctrl+R to restart the main process desktop | <i> [webpack-plugin-start-electron] - Ctrl+A to restart the main process with extra arguments

And none of it is working at the moment

should be working now 🎉

Copilot

Pull Request Overview

This PR adds a new npm start command that allows launching multiple Compass environments (desktop, sandbox, sync) in parallel to streamline testing across different platforms.

New multi-process launcher script that can start desktop, sandbox, and sync environments together
Enhanced sync script converted from JS to MJS with improved MMS dev server management
Updated package.json configurations to support the new start command

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
scripts/start.mts	New multi-process launcher script handling argument parsing and subprocess management
scripts/start.md	Help documentation for the new start command
packages/compass-web/scripts/sync-dist-to-mms.mjs	Converted sync script from JS to MJS with enhanced MMS server handling
packages/compass-web/scripts/sync-dist-to-mms.js	Removed old JS version of sync script
packages/compass-web/package.json	Updated sync command to use new MJS script
packages/compass-web/.eslintrc.js	Added ESLint configuration for MJS files
package.json	Updated root start command to use new launcher script

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

scripts/start.mts

packages/compass-web/scripts/sync-dist-to-mms.mjs

…ASS-9851

gribnoysup · 2025-09-30T08:41:17Z

packages/compass-web/scripts/sync-dist-to-mms.mjs

+  // If a copy is already in progress, return early (debounce)
+  if (oneSec) return;
+  fs.cpSync(srcDir, destDir, { recursive: true });
+  oneSec = timers.setTimeout(1000);


I might be misreading the logic here, but I think we should rather have a trailing debounce, not a leading one, or both (a good thing about lodash was that it was doing both: first run is immediate, if there was a second one during the timeout, it will also happen when debounce is ready to resolve)

gribnoysup · 2025-09-30T08:41:58Z

packages/compass-web/.eslintrc.js

    tsconfigRootDir: __dirname,
    project: ['./tsconfig.json'],
  },
+  overrides: [


I think we might want to extens our shared eslint config with this, not only compass web, but not a blocker

I agree but this problem also goes away if we use .mts which is readily accessible now so we can use that until we're forced to use mjs for some reason

gribnoysup

Looks good! Few small notes, nothing blocking

gribnoysup · 2025-10-02T11:39:53Z

scripts/start.mts

+  }
+
+  // Wait a shorter time for graceful shutdown
+  await timers.setTimeout(3000);


Small nit / note: I think might make sense to bump it a little, to at least 10s maybe. If this is specifically for desktop webpack build, you kinda do want it to exit gracefully to avoid corrupting the build cache as this has an effect on the next start up time

gribnoysup · 2025-10-02T11:45:27Z

packages/compass-web/scripts/sync-dist-to-mms.mts

+    .filter(Boolean)
+    .join(' ');
+
+  devServer = child_process.spawn(


If we're not adding some sort of explicit way to disable strict engine check here, would be nice to monitor for the error and print something along the lines that the check can be disabled with NPM_CONFIG_ENGINE_STRICT=false flag

nbbeeken commented Sep 18, 2025

View reviewed changes

gribnoysup reviewed Sep 18, 2025

View reviewed changes

packages/compass-web/scripts/sync-dist-to-mms.mjs Outdated Show resolved Hide resolved

gribnoysup reviewed Sep 18, 2025

View reviewed changes

nbbeeken marked this pull request as ready for review September 19, 2025 20:55

nbbeeken requested a review from a team as a code owner September 19, 2025 20:55

nbbeeken requested review from Anemy and Copilot and removed request for Anemy September 19, 2025 20:55

Copilot AI reviewed Sep 19, 2025

View reviewed changes

scripts/start.mts Show resolved Hide resolved

scripts/start.mts Show resolved Hide resolved

scripts/start.mts Show resolved Hide resolved

packages/compass-web/scripts/sync-dist-to-mms.mjs Outdated Show resolved Hide resolved

nbbeeken requested a review from gribnoysup September 22, 2025 17:10

nbbeeken added 6 commits September 29, 2025 11:32

chore: enhance npm start command to run compass sync and sandbox COMP…

2b34462

…ASS-9851

make desktop run normally

aa26f8a

remove init

7570add

fix: to avoid port overlap prevent sandbox running with other commands

1e8debf

fix: don't leave behind electron processes

47bcf13

chore: rm lodash

8068f7b

nbbeeken force-pushed the COMPASS-9851 branch from 366558b to 8068f7b Compare September 29, 2025 09:32

nbbeeken added 3 commits September 29, 2025 12:16

fix pnpm version

f242503

fs fix

38271ef

undo typecheck change

4d5ee40

gribnoysup reviewed Sep 30, 2025

View reviewed changes

nbbeeken added 6 commits September 30, 2025 11:18

fix prefixing

39c037b

use fetch head instead

9e545ab

fix shortcuts

c24e856

improve signal handling

c8e8717

fix debouncer

e47e12f

rm eslint change

255706e

nbbeeken requested a review from gribnoysup September 30, 2025 23:37

gribnoysup approved these changes Oct 2, 2025

View reviewed changes

nbbeeken added 2 commits October 2, 2025 15:05

chore: nits

add4ce6

use node execPath

47d21c7

		desktop: { enabled: false, args: [] as string[] },
		sandbox: { enabled: false, args: [] as string[] },

chore: enhance npm start command to run compass sync and sandbox COMPASS-9851 #7338

Are you sure you want to change the base?

chore: enhance npm start command to run compass sync and sandbox COMPASS-9851 #7338

Uh oh!

Conversation

nbbeeken commented Sep 18, 2025

Description

npm start++

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

`npm start++`

gribnoysup Sep 30, 2025 •

edited

Loading

gribnoysup left a comment •

edited

Loading