chore(welcome): refactor welcome modal to a plugin; only change showedNetworkOptIn after welcome modal is closed

Author: gribnoysup

packages/compass-preferences-model/src/compass-web-preferences-access.ts

@@ -31,10 +31,6 @@ export class CompassWebPreferencesAccess implements PreferencesAccess {
     return this._preferences.getPreferences();
   }
 
-  ensureDefaultConfigurableUserPreferences() {
-    return this._preferences.ensureDefaultConfigurableUserPreferences();
-  }
-
   getConfigurableUserPreferences() {
     return Promise.resolve(this._preferences.getConfigurableUserPreferences());
   }

packages/compass-preferences-model/src/preferences-schema.tsx

@@ -594,7 +594,7 @@ export const storedUserPreferencesProps: Required<{
       long: 'Allow Compass to make requests to a 3rd party mapping service.',
     },
     deriveValue: deriveNetworkTrafficOptionState('enableMaps'),
-    validator: z.boolean().default(false),
+    validator: z.boolean().default(true),
     type: 'boolean',
   },
   enableGenAIFeatures: {
@@ -621,7 +621,7 @@ export const storedUserPreferencesProps: Required<{
       long: 'Enables a tool that our Product team can use to occasionally reach out for feedback about Compass.',
     },
     deriveValue: deriveNetworkTrafficOptionState('enableFeedbackPanel'),
-    validator: z.boolean().default(false),
+    validator: z.boolean().default(true),
     type: 'boolean',
   },
   /**
@@ -637,7 +637,7 @@ export const storedUserPreferencesProps: Required<{
       long: 'Allow Compass to send anonymous usage statistics.',
     },
     deriveValue: deriveNetworkTrafficOptionState('trackUsageStatistics'),
-    validator: z.boolean().default(false),
+    validator: z.boolean().default(true),
     type: 'boolean',
   },
   /**
@@ -652,7 +652,7 @@ export const storedUserPreferencesProps: Required<{
       long: 'Allow Compass to periodically check for new updates.',
     },
     deriveValue: deriveNetworkTrafficOptionState('autoUpdates'),
-    validator: z.boolean().default(false),
+    validator: z.boolean().default(true),
     type: 'boolean',
   },
   /**

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

@@ -50,7 +50,7 @@ describe('Preferences class', function () {
     const preferences = await setupPreferences(tmpdir);
     const result = preferences.getPreferences();
     expect(result.id).to.equal('General');
-    expect(result.enableMaps).to.equal(false);
+    expect(result.enableMaps).to.equal(true);
     expect(result.enableShell).to.equal(true);
   });
 
@@ -98,13 +98,12 @@ describe('Preferences class', function () {
     const preferences = await setupPreferences(tmpdir);
     const calls: any[] = [];
     preferences.onPreferencesChanged((prefs) => calls.push(prefs));
-    await preferences.savePreferences({ enableMaps: true });
-    expect(calls).to.deep.equal([{ enableMaps: true }]);
+    await preferences.savePreferences({ enableMaps: false });
+    expect(calls).to.deep.equal([{ enableMaps: false }]);
   });
 
   it('can return user-configurable preferences after setting their defaults', async function () {
     const preferences = await setupPreferences(tmpdir);
-    await preferences.ensureDefaultConfigurableUserPreferences();
     const result = preferences.getConfigurableUserPreferences();
     expect(result).not.to.have.property('id');
     expect(result.enableMaps).to.equal(true);
@@ -121,7 +120,6 @@ describe('Preferences class', function () {
         trackUsageStatistics: false,
       },
     });
-    await preferences.ensureDefaultConfigurableUserPreferences();
     const result = preferences.getConfigurableUserPreferences();
     expect(result).not.to.have.property('id');
     expect(result.autoUpdates).to.equal(true);
@@ -214,18 +212,10 @@ describe('Preferences class', function () {
     const preferences = await setupPreferences(tmpdir);
     const calls: any[] = [];
     preferences.onPreferencesChanged((prefs) => calls.push(prefs));
-    await preferences.ensureDefaultConfigurableUserPreferences();
     preferences.getConfigurableUserPreferences(); // set defaults
     await preferences.savePreferences({ networkTraffic: false });
     await preferences.savePreferences({ readOnly: true });
     expect(calls).to.deep.equal([
-      {
-        showedNetworkOptIn: true,
-        enableMaps: true,
-        enableFeedbackPanel: true,
-        trackUsageStatistics: true,
-        autoUpdates: true,
-      },
       {
         networkTraffic: false,
         enableMaps: false,

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

@@ -22,7 +22,6 @@ export interface PreferencesAccess {
   ): Promise<AllPreferences>;
   refreshPreferences(): Promise<AllPreferences>;
   getPreferences(): AllPreferences;
-  ensureDefaultConfigurableUserPreferences(): Promise<void>;
   getConfigurableUserPreferences(): Promise<UserConfigurablePreferences>;
   getPreferenceStates(): Promise<PreferenceStateInformation>;
   onPreferenceValueChanged<K extends keyof AllPreferences>(
@@ -248,26 +247,6 @@ export class Preferences {
     return { values, states };
   }
 
-  /**
-   * If this is the first call to this method, this sets the defaults for
-   * user preferences.
-   */
-  async ensureDefaultConfigurableUserPreferences(): Promise<void> {
-    // Set the defaults and also update showedNetworkOptIn flag.
-    const { showedNetworkOptIn } = this.getPreferences();
-    if (!showedNetworkOptIn) {
-      await this.savePreferences({
-        autoUpdates: true,
-        enableGenAIFeatures: true,
-        enableMaps: true,
-        trackUsageStatistics: true,
-        enableFeedbackPanel: true,
-        showedNetworkOptIn: true,
-        theme: 'LIGHT',
-      });
-    }
-  }
-
   /**
    * Return the subset of preferences that can be edited through the UI.
    *

packages/compass-preferences-model/src/read-only-preferences-access.ts

@@ -29,10 +29,6 @@ export class ReadOnlyPreferenceAccess implements PreferencesAccess {
     return this._preferences.getPreferences();
   }
 
-  ensureDefaultConfigurableUserPreferences() {
-    return this._preferences.ensureDefaultConfigurableUserPreferences();
-  }
-
   getConfigurableUserPreferences() {
     return Promise.resolve(this._preferences.getConfigurableUserPreferences());
   }

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

@@ -10,9 +10,6 @@ describe('Renderer IPC', function () {
     'compass:get-preferences'() {
       return { getPreferences: 1 };
     },
-    'compass:ensure-default-configurable-user-preferences'() {
-      return { ensureDefaultConfigurableUserPreferences: 1 };
-    },
     'compass:get-configurable-user-preferences'() {
       return { getConfigurableUserPreferences: 1 };
     },
@@ -40,12 +37,6 @@ describe('Renderer IPC', function () {
     });
   });
 
-  it('should be able to call ensureDefaultConfigurableUserPreferences', async function () {
-    expect(
-      await preferencesIpc.ensureDefaultConfigurableUserPreferences()
-    ).to.deep.equal({ ensureDefaultConfigurableUserPreferences: 1 });
-  });
-
   it('should be able to call getConfigurableUserPreferences', async function () {
     expect(await preferencesIpc.getConfigurableUserPreferences()).to.deep.equal(
       { getConfigurableUserPreferences: 1 }

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

@@ -52,11 +52,6 @@ export const makePreferencesIpc = (
       return refreshCachedPreferences();
     },
     getPreferences,
-    ensureDefaultConfigurableUserPreferences(): Promise<void> {
-      return ipcRenderer.invoke(
-        'compass:ensure-default-configurable-user-preferences'
-      );
-    },
     getConfigurableUserPreferences(): Promise<UserConfigurablePreferences> {
       return ipcRenderer.invoke('compass:get-configurable-user-preferences');
     },

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

@@ -72,10 +72,6 @@ export async function setupPreferences(
     return preferences.getPreferenceStates();
   });
 
-  ipcMain.handle('compass:ensure-default-configurable-user-preferences', () => {
-    return preferences.ensureDefaultConfigurableUserPreferences();
-  });
-
   ipcMain.handle('compass:get-configurable-user-preferences', () => {
     return preferences.getConfigurableUserPreferences();
   });
@@ -103,9 +99,6 @@ const makePreferenceMain = (
   getPreferences(): AllPreferences {
     return preferences()?.getPreferences?.() ?? ({} as AllPreferences);
   },
-  async ensureDefaultConfigurableUserPreferences(): Promise<void> {
-    return preferences()?.ensureDefaultConfigurableUserPreferences?.();
-  },
   // eslint-disable-next-line @typescript-eslint/require-await
   async getConfigurableUserPreferences(): Promise<UserConfigurablePreferences> {
     return (

packages/compass-settings/src/stores/index.ts

@@ -11,6 +11,7 @@ import type { SettingsTabId } from './settings';
 import { openModal, reducer as settingsReducer } from './settings';
 import type { Logger } from '@mongodb-js/compass-logging/provider';
 import type { PreferencesAccess } from 'compass-preferences-model';
+import type { ActivateHelpers } from '@mongodb-js/compass-app-registry';
 
 export type Public<T> = { [K in keyof T]: T[K] };
 
@@ -65,25 +66,26 @@ export type SettingsThunkAction<
   A extends AnyAction = AnyAction
 > = ThunkAction<R, RootState, SettingsThunkExtraArgs, A>;
 
-const onActivated = (_: unknown, services: SettingsPluginServices) => {
+const onActivated = (
+  _: unknown,
+  services: SettingsPluginServices,
+  { on, cleanup }: ActivateHelpers
+) => {
   const store = configureStore(services);
   const { globalAppRegistry } = services;
 
   const onOpenSettings = (tabId?: SettingsTabId) => {
     void store.dispatch(openModal(tabId));
   };
 
-  ipcRenderer?.on('window:show-settings', () => onOpenSettings());
-  globalAppRegistry.on('open-compass-settings', onOpenSettings);
+  if (ipcRenderer) {
+    on(ipcRenderer, 'window:show-settings', () => onOpenSettings());
+  }
+  on(globalAppRegistry, 'open-compass-settings', onOpenSettings);
 
   return {
     store,
-    deactivate() {
-      ipcRenderer?.removeListener('window:show-settings', () =>
-        onOpenSettings()
-      );
-      globalAppRegistry.removeListener('open-compass-settings', onOpenSettings);
-    },
+    deactivate: cleanup,
   };
 };
 

packages/compass-settings/src/stores/preferences-sandbox.ts

@@ -18,10 +18,7 @@ export class PreferencesSandbox {
   constructor(
     private preferences: Pick<
       PreferencesAccess,
-      | 'createSandbox'
-      | 'ensureDefaultConfigurableUserPreferences'
-      | 'getPreferences'
-      | 'savePreferences'
+      'createSandbox' | 'getPreferences' | 'savePreferences'
     >
   ) {}