fix(compass-preferences-model): ignore squirrel options (#3802)

Author: addaleax

packages/compass-preferences-model/src/global-config.spec.ts

@@ -44,6 +44,18 @@ describe('Global config file handling', function () {
     });
   });
 
+  it('ignores startup with --squirrel-firstrun', async function () {
+    const result = await parseAndValidateGlobalPreferences({
+      globalConfigPaths: [],
+      argv: ['--squirrel-firstrun'],
+    });
+    expect(result).to.deep.equal({
+      global: {},
+      cli: {},
+      preferenceParseErrors: [],
+    });
+  });
+
   it('parses global config files (YAML)', async function () {
     const file = path.join(tmpdir, 'config');
     await fs.writeFile(file, 'enableMaps: false\n');

packages/compass-preferences-model/src/global-config.ts

@@ -130,6 +130,10 @@ function parseCliArgs(argv: string[]): unknown {
     result.positionalArguments = result._;
   }
   delete (result as any)._;
+  for (const key of Object.keys(result)) {
+    // Remove command line flags added by the Windows .exe installer.
+    if (key.startsWith('squirrel')) delete (result as any)[key];
+  }
   return result;
 }
 
@@ -220,11 +224,12 @@ export async function parseAndValidateGlobalPreferences(
   }
   const cliPreferences = parseCliArgs(argv);
   if (cliPreferences && typeof cliPreferences === 'object') {
-    // Remove positional arguments and common Electron/Chromium flags
-    // that we want to allow.
-    const ignoreFlags = ['disableGpu', 'sandbox'];
-    for (const flag of ignoreFlags) {
-      delete (cliPreferences as Record<string, unknown>)[flag];
+    // Remove common Electron/Chromium/Installer flags that we want to allow.
+    const ignoreFlags = /^(disableGpu$|sandbox$|squirrel)/;
+    for (const key of Object.keys(cliPreferences)) {
+      if (key.match(ignoreFlags)) {
+        delete (cliPreferences as Record<string, unknown>)[key];
+      }
     }
   }