Also fix the shortcut that's made by squirrel

Author: lerouxb

package-lock.json

@@ -251,7 +251,6 @@
     "electron-devtools-installer": "^3.2.0",
     "electron-dl": "^3.5.0",
     "electron-mocha": "^12.2.0",
-    "electron-squirrel-startup": "^1.0.1",
     "ensure-error": "^3.0.1",
     "glob": "^10.2.5",
     "local-links": "^1.4.0",

packages/compass/package.json

@@ -39,6 +39,7 @@ import {
   extractProxySecrets,
   translateToElectronProxyConfig,
 } from '@mongodb-js/devtools-proxy-support';
+import { handleSquirrelWindowsStartup } from './squirrel-startup';
 
 const { debug, log, mongoLogId } = createLogger('COMPASS-MAIN');
 const track = createIpcTrack();
@@ -121,8 +122,8 @@ class CompassApplication {
     );
 
     // needs to happen after setupProtocolHandlers
-    if ((await import('electron-squirrel-startup')).default) {
-      debug('electron-squirrel-startup event handled sucessfully\n');
+    if (await handleSquirrelWindowsStartup()) {
+      app.quit();
       return;
     }
 

packages/compass/src/main/application.ts

@@ -0,0 +1,80 @@
+import path from 'path';
+import { spawn } from 'child_process';
+import { createLogger } from '@mongodb-js/compass-logging';
+const { debug } = createLogger('SQUIRREL-STARTUP');
+
+function runUpdateExe(args: string[]): Promise<void> {
+  return new Promise<void>(function (resolve) {
+    const updateExe = path.resolve(
+      path.dirname(process.execPath),
+      '..',
+      'Update.exe'
+    );
+    debug('Spawning `%s` with args `%s`', updateExe, args.join(' '));
+    spawn(updateExe, args, {
+      detached: true,
+    }).on('close', () => resolve());
+  });
+}
+
+function getShortcutName() {
+  // The shortcut name is the app name plus the channel name if it is not
+  // stable. ie. "MongoDB Compass Readonly Beta"
+
+  const parts: string[] = [process.env.HADRON_PRODUCT_NAME];
+  if (process.env.HADRON_CHANNEL !== 'stable') {
+    parts.push(
+      process.env.HADRON_CHANNEL.charAt(0).toUpperCase() +
+        process.env.HADRON_CHANNEL.slice(1)
+    );
+  }
+  return parts.join(' ');
+}
+
+/*
+Squirrel will spawn Compass with command line flags on first run, updates, and
+uninstalls. It is very important that we handle these events as early as
+possible, and quit immediately after handling them. Squirrel gives apps a short
+amount of time (~15sec) to apply these operations and quit.
+*/
+export async function handleSquirrelWindowsStartup(): Promise<boolean> {
+  if (process.platform !== 'win32') {
+    return false;
+  }
+
+  const shortcutName = getShortcutName();
+
+  const cmd = process.argv[1];
+  debug('processing squirrel command `%s`', cmd);
+
+  /*
+  For more detailed info on these commands, so Electron and Squirrel Windows'
+  documentation:
+
+  https://github.com/electron-archive/grunt-electron-installer?tab=readme-ov-file#handling-squirrel-events
+  https://github.com/Squirrel/Squirrel.Windows/blob/master/docs/using/custom-squirrel-events-non-cs.md
+  https://github.com/Squirrel/Squirrel.Windows/blob/master/docs/using/install-process.md
+  https://github.com/Squirrel/Squirrel.Windows/blob/master/docs/using/update-process.md#update-process
+  */
+  switch (cmd) {
+    case '--squirrel-install':
+    case '--squirrel-updated':
+      await runUpdateExe([`--createShortcut=${shortcutName}`]);
+      debug(`${cmd} handled sucessfully`);
+      return true;
+
+    case '--squirrel-uninstall':
+      await runUpdateExe([`--removeShortcut=${shortcutName}`]);
+      debug(`${cmd} handled sucessfully`);
+      return true;
+
+    case '--squirrel-obsolete':
+      debug(`${cmd} handled sucessfully`);
+      return true;
+
+    default:
+      debug(`Unknown squirrel command: ${cmd}. Continuing on.`);
+  }
+
+  return false;
+}

packages/compass/src/main/electron-squirrel-startup.d.ts

@@ -213,7 +213,6 @@ And then finally
 
 - User's launch application via a desktop shortcut `${productName}`
 - Installing into `C:\\Program Files\` would require Administrator
-- Desktop shortcut managed for you automatically if you use https://github.com/mongodb-js/electron-squirrel-startup
 - Shortcut Target: `C:\Users\${username}\AppData\Local\${_.titlecase(productName)}\Update.exe --processStart ${_.titlecase(productName)}.exe`
 - Shortcut Start In: `C:\Users\${username}\AppData\Local\${_.titlecase(productName)}\app-${version}`
 
@@ -267,7 +266,6 @@ Which assets are generated depends on the target platform.
 
 ### Windows
 
-- `electron-squirrel-startup`: https://github.com/mongodb-js/electron-squirrel-startup
 - [Update process explained step by step](https://github.com/Squirrel/Squirrel.Windows/blob/master/docs/using/update-process.md#update-process)
 
 ### Linux