chore(compass-preferences-model): add tests (#3482)

Author: addaleax

package-lock.json

@@ -55,6 +55,7 @@
     "@mongodb-js/mocha-config-compass": "^1.0.0",
     "@types/lodash.isempty": "^4.4.7",
     "@types/lodash.pickby": "^4.6.7",
+    "chai": "^4.3.6",
     "depcheck": "^1.4.1",
     "eslint": "^7.25.0",
     "hadron-ipc": "^3.0.0",

packages/compass-preferences-model/package.json

@@ -0,0 +1,58 @@
+import { promises as fs } from 'fs';
+import path from 'path';
+import os from 'os';
+import Preferences from './preferences';
+import { expect } from 'chai';
+
+describe('Preferences class', function () {
+  let tmpdir: string;
+  let i = 0;
+
+  beforeEach(async function () {
+    tmpdir = path.join(os.tmpdir(), `preferences-test-${Date.now()}-${i++}`);
+    await fs.mkdir(tmpdir, { recursive: true });
+  });
+
+  after(async function () {
+    await fs.rm(tmpdir, { recursive: true });
+  });
+
+  it('allows provides default preferences', async function () {
+    const preferences = new Preferences(tmpdir);
+    const result = await preferences.fetchPreferences();
+    expect(result.id).to.equal('General');
+    expect(result.enableMaps).to.equal(false);
+  });
+
+  it('allows saving preferences', async function () {
+    const preferences = new Preferences(tmpdir);
+    await preferences.savePreferences({ enableMaps: true });
+    const result = await preferences.fetchPreferences();
+    expect(result.id).to.equal('General');
+    expect(result.enableMaps).to.equal(true);
+  });
+
+  it('stores preferences across instances', async function () {
+    const preferences1 = new Preferences(tmpdir);
+    await preferences1.savePreferences({ enableMaps: true });
+    const preferences2 = new Preferences(tmpdir);
+    const result = await preferences2.fetchPreferences();
+    expect(result.id).to.equal('General');
+    expect(result.enableMaps).to.equal(true);
+  });
+
+  it('notifies callers of preferences changes', async function () {
+    const preferences = new Preferences(tmpdir);
+    const calls: any[] = [];
+    preferences.onPreferencesChanged((prefs) => calls.push(prefs));
+    await preferences.savePreferences({ enableMaps: true });
+    expect(calls).to.deep.equal([{ enableMaps: true }]);
+  });
+
+  it('can return user-configurable preferences after setting their defaults', async function () {
+    const preferences = new Preferences(tmpdir);
+    const result = await preferences.getConfigurableUserPreferences();
+    expect(result).not.to.have.property('id');
+    expect(result.enableMaps).to.equal(true);
+  });
+});

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

@@ -0,0 +1,60 @@
+import { makePreferencesIpc } from './renderer-ipc';
+import { EventEmitter } from 'events';
+import { expect } from 'chai';
+
+describe('Renderer IPC', function () {
+  const ipcImpl = {
+    'compass:save-preferences'(attributes) {
+      return { savePreferences: 1, attributes };
+    },
+    'compass:get-preferences'() {
+      return { getPreferences: 1 };
+    },
+    'compass:get-configurable-user-preferences'() {
+      return { getConfigurableUserPreferences: 1 };
+    },
+  };
+  const ipcMock = Object.assign(new EventEmitter(), {
+    invoke(method: string, ...args: any[]) {
+      return Promise.resolve(ipcImpl[method](...args));
+    },
+  });
+  const preferencesIpc = makePreferencesIpc({ ipcRenderer: ipcMock } as any);
+
+  it('should be able to call savePreferences', async function () {
+    expect(
+      await preferencesIpc.savePreferences({ enableMaps: true })
+    ).to.deep.equal({ savePreferences: 1, attributes: { enableMaps: true } });
+  });
+
+  it('should be able to call getPreferences', async function () {
+    expect(await preferencesIpc.getPreferences()).to.deep.equal({
+      getPreferences: 1,
+    });
+  });
+
+  it('should be able to call getConfigurableUserPreferences', async function () {
+    expect(await preferencesIpc.getConfigurableUserPreferences()).to.deep.equal(
+      { getConfigurableUserPreferences: 1 }
+    );
+  });
+
+  it('should be able to listen with onPreferenceValueChanged', function () {
+    const calls: any[] = [];
+    const unsubscribe = preferencesIpc.onPreferenceValueChanged(
+      'enableMaps',
+      (value) => calls.push(value)
+    );
+    ipcMock.emit('compass:preferences-changed', null, {
+      trackUserStatistics: false,
+    });
+    expect(calls).to.deep.equal([]);
+    ipcMock.emit('compass:preferences-changed', null, { enableMaps: true });
+    expect(calls).to.deep.equal([true]);
+    ipcMock.emit('compass:preferences-changed', null, { enableMaps: true });
+    expect(calls).to.deep.equal([true, true]);
+    unsubscribe();
+    ipcMock.emit('compass:preferences-changed', null, { enableMaps: true });
+    expect(calls).to.deep.equal([true, true]);
+  });
+});

packages/compass-preferences-model/src/renderer-ipc.spec.ts

@@ -1,4 +1,4 @@
-import ipc from 'hadron-ipc';
+import hadronIpc from 'hadron-ipc';
 import type {
   GlobalPreferences,
   UserConfigurablePreferences,
@@ -8,7 +8,7 @@ import type {
 /**
  * API to communicate with preferences from the electron renderer process.
  */
-export const preferencesIpc = {
+export const makePreferencesIpc = (ipc: typeof hadronIpc) => ({
   savePreferences(
     attributes: Partial<GlobalPreferences>
   ): Promise<GlobalPreferences> {
@@ -51,4 +51,6 @@ export const preferencesIpc = {
       /** Missing ipc fallback */
     };
   },
-};
+});
+
+export const preferencesIpc = makePreferencesIpc(hadronIpc);