fix: strip unknown preferences when loading COMPASS-7026 (#4654)

strip unknown preferences when loading

Author: lerouxb

packages/compass-preferences-model/src/storage.spec.ts

@@ -1,8 +1,9 @@
 import { mkdtempSync, rmdirSync } from 'fs';
 import path from 'path';
 import os from 'os';
-import { UserStorage, type User } from './storage';
+import { UserStorage, StoragePreferences, type User } from './storage';
 import { expect } from 'chai';
+import type { UserPreferences } from './preferences';
 
 describe('storage', function () {
   let tmpDir: string;
@@ -41,4 +42,28 @@ describe('storage', function () {
       });
     });
   });
+
+  describe('StoragePreferences', function () {
+    before(function () {
+      tmpDir = mkdtempSync(path.join(os.tmpdir()));
+    });
+
+    after(function () {
+      rmdirSync(tmpDir, { recursive: true });
+    });
+
+    it('will strip unknown prefs', async function () {
+      const prefsStorage = new StoragePreferences(
+        { showedNetworkOptIn: true, foo: true } as unknown as UserPreferences,
+        tmpDir
+      );
+      await prefsStorage.setup();
+
+      // roundabout way to make it load because setup doesn't fill prefsStorage.preferences if it writes the file
+      await prefsStorage.updatePreferences({});
+
+      const prefs = prefsStorage.getPreferences();
+      expect(prefs).to.deep.equal({ showedNetworkOptIn: true });
+    });
+  });
 });

packages/compass-preferences-model/src/storage.ts

@@ -1,7 +1,9 @@
+import { UUID } from 'bson';
 import { promises as fs } from 'fs';
+import { pick } from 'lodash';
 import { join } from 'path';
 import type { UserPreferences } from './preferences';
-import { UUID } from 'bson';
+import { allPreferencesProps } from './preferences';
 
 export abstract class BasePreferencesStorage {
   abstract setup(): Promise<void>;
@@ -71,7 +73,19 @@ export class StoragePreferences extends BasePreferencesStorage {
   }
 
   private async readPreferences(): Promise<UserPreferences> {
-    return JSON.parse(await fs.readFile(this.getFilePath(), 'utf8'));
+    const preferences = JSON.parse(
+      await fs.readFile(this.getFilePath(), 'utf8')
+    );
+
+    // Exclude old and renamed preferences so we don't try and save those back.
+    // (This is still technically a lie because we could only have a subset of
+    // UserPreferences. ie. imagine a JSON file that has an empty object. Or
+    // that was saved with the previous version of compass where we had fewer
+    // settings.)
+    return pick(
+      preferences,
+      Object.keys(allPreferencesProps)
+    ) as UserPreferences;
   }
 
   getPreferences() {