fix: fix the shortcuts on windows to be the app name, not executable name COMPASS-8367 (#6846)

* Add shortcutName to MSI Creator so it will have the expected space

* Also fix the shortcut that's made by squirrel

* spaces

* quotes

* better link

* do not strip spaces from the windows executable name

* comment

* replace spaces

* rather rename the shortcut

* turns out that, at this point, HADRON_PRODUCT_NAME already contains Dev or Beta

* incorrect comment

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,131 @@
+import { promises as fs } from 'fs';
+import os from 'os';
+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() {
+  return process.env.HADRON_PRODUCT_NAME ?? 'MongoDB Compass';
+}
+
+async function renameShortcuts(from: string, to: string) {
+  const folders: string[] = [];
+
+  if (process.env.APPDATA) {
+    // start menu shortcut
+    // NOTE: This includes the non-ideal "MongoDB Inc" folder name as opposed to
+    // "MongoDB".
+    folders.push(
+      path.join(
+        process.env.APPDATA,
+        'Microsoft',
+        'Windows',
+        'Start Menu',
+        'Programs',
+        'MongoDB Inc'
+      )
+    );
+  }
+
+  // desktop shortcut
+  folders.push(path.join(os.homedir(), 'Desktop'));
+
+  for (const folder of folders) {
+    const source = path.join(folder, from);
+    const destination = path.join(folder, to);
+    try {
+      // only rename the shortcut if it exists at the standard, expected location
+      if (await fs.stat(source)) {
+        debug('renaming shortcut from %s to %s', source, destination);
+        await fs.rename(source, destination);
+      } else {
+        debug('shortcut %s does not exist, skipping rename', source);
+      }
+    } catch (err: unknown) {
+      debug(
+        'error renaming shortcut from %s to %s: %s',
+        source,
+        destination,
+        err
+      );
+    }
+  }
+}
+
+/*
+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;
+  }
+
+  // This has to be an executable that was packaged up with the app. There's no
+  // way to control what the shortcut name will be - it is always the same as
+  // the executable.
+  const exeName = path.basename(process.execPath);
+
+  // We want the desktop and start menu shortcuts to be named with spaces in
+  // them so that when the user searches for "compass" in the start menu it will
+  // find it.
+  const correctShortcutName = getShortcutName() + '.lnk';
+  const wrongShortcutName = getShortcutName().replace(/ /g, '') + '.lnk';
+
+  const cmd = process.argv[1];
+  debug('processing squirrel command `%s`', cmd);
+
+  /*
+  For more detailed info on these commands, so Electron, electron-winstaller and Squirrel Windows'
+  documentation:
+
+  https://github.com/electron/windows-installer?tab=readme-ov-file#handling-squirrel-events
+  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=${exeName}`]);
+      // Rename the shortcut that was just created to be what we want it to be.
+      await renameShortcuts(wrongShortcutName, correctShortcutName);
+      debug(`${cmd} handled sucessfully`);
+      return true;
+
+    case '--squirrel-uninstall':
+      // Rename the shortcut back to the original name so it can be removed as
+      // usual.
+      await renameShortcuts(correctShortcutName, wrongShortcutName);
+      await runUpdateExe([`--removeShortcut=${exeName}`]);
+      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

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

@@ -313,6 +313,11 @@ class Target {
      * remoteToken: this.githubToken,
      */
     Object.assign(this.packagerOptions, {
+      // This name becomes the .exe name, but it is also used to determine
+      // various other parts including the nupkg file and its metadata and the
+      // code that makes that validates that the filename does not contain
+      // spaces. So basically the .exe we build is not allowed to contain
+      // spaces and it is out of our control.
       name: this.productName.replace(/ /g, ''),
       icon: this.src(platformSettings.icon),
       'version-string': {
@@ -393,6 +398,10 @@ class Target {
       iconUrl: platformSettings.favicon_url,
       appDirectory: this.appPath,
       outputDirectory: this.packagerOptions.out,
+      // NOTE: This also becomes the name of the shortcut folder. Will be
+      // "MongoDB Inc" if it uses this.author. Tempting to use
+      // this.shortcutFolderName so it becomes MongoDB like for the .msi, but
+      // who knows what else will be affected.
       authors: this.author,
       version: this.version,
       exe: `${this.packagerOptions.name}.exe`,
@@ -450,10 +459,12 @@ class Target {
         outputDirectory: this.packagerOptions.out,
         exe: this.packagerOptions.name,
         name: this.productName,
+        // NOTE: falling back to author would result in MongoDB Inc
+        shortcutFolderName: this.shortcutFolderName || this.author,
+        shortcutName: this.productName,
         description: this.description,
         manufacturer: this.author,
         version: windowsInstallerVersion(this.installerVersion || this.version),
-        shortcutFolderName: this.shortcutFolderName || this.author,
         programFilesFolderName: this.programFilesFolderName || this.productName,
         appUserModelId: this.bundleId,
         upgradeCode: this.upgradeCode,