feat(schema): run schema anaylsis with secondaryPreferred when read pref not set COMPASS-8854

Author: Anemy

packages/compass-schema/src/stores/reducer.ts

@@ -1,5 +1,7 @@
 import type { Schema } from 'mongodb-schema';
 import type { Action, AnyAction, Reducer } from 'redux';
+import ConnectionString from 'mongodb-connection-string-url';
+import type { AggregateOptions } from 'mongodb';
 import { type AnalysisState } from '../constants/analysis-states';
 import {
   ANALYSIS_STATE_ANALYZING,
@@ -212,6 +214,12 @@ export const stopAnalysis = (): SchemaThunkAction<void> => {
   };
 };
 
+function isReadPreferenceSet(connectionString: string): boolean {
+  return !!new ConnectionString(connectionString).searchParams.get(
+    'readPreference'
+  );
+}
+
 export const startAnalysis = (): SchemaThunkAction<
   Promise<void>,
   AnalysisStartedAction | AnalysisFinishedAction | AnalysisFailedAction
@@ -250,8 +258,18 @@ export const startAnalysis = (): SchemaThunkAction<
       fields: query.project ?? undefined,
     };
 
-    const driverOptions = {
+    const driverOptions: AggregateOptions = {
       maxTimeMS: capMaxTimeMSAtPreferenceLimit(preferences, query.maxTimeMS),
+      // When the read preference isn't set in the connection string explicitly,
+      // then we default to secondaryPreferred to avoid using the primary for
+      // schema analysis.
+      ...(isReadPreferenceSet(
+        connectionInfoRef.current.connectionOptions.connectionString
+      )
+        ? {}
+        : {
+            readPreference: 'secondaryPreferred',
+          }),
     };
 
     try {

packages/compass-schema/src/stores/store.spec.ts

@@ -1,4 +1,5 @@
-import { activateSchemaPlugin, type SchemaStore } from './store';
+import { activateSchemaPlugin } from './store';
+import type { SchemaStore, SchemaPluginServices } from './store';
 import AppRegistry, { createActivateHelpers } from 'hadron-app-registry';
 import { expect } from 'chai';
 
@@ -7,7 +8,6 @@ import { createSandboxFromDefaultPreferences } from 'compass-preferences-model';
 import { createNoopLogger } from '@mongodb-js/compass-logging/provider';
 import type { FieldStoreService } from '@mongodb-js/compass-field-store';
 import { createNoopTrack } from '@mongodb-js/compass-telemetry/provider';
-import type { ConnectionInfoRef } from '@mongodb-js/compass-connections/provider';
 import { startAnalysis, stopAnalysis } from './reducer';
 import Sinon from 'sinon';
 
@@ -26,46 +26,61 @@ const mockQueryBar = {
 };
 
 describe('Schema Store', function () {
-  describe('#configureStore', function () {
-    let store: SchemaStore;
-    let deactivate: () => void;
-    let sandbox: Sinon.SinonSandbox;
-    const localAppRegistry = new AppRegistry();
-    const globalAppRegistry = new AppRegistry();
-    const namespace = 'db.coll';
+  let store: SchemaStore;
+  let deactivate: () => void;
+  let sandbox: Sinon.SinonSandbox;
+  const localAppRegistry = new AppRegistry();
+  const globalAppRegistry = new AppRegistry();
+  const namespace = 'db.coll';
+  let sampleStub: Sinon.SinonStub;
+  let isCancelErrorStub: Sinon.SinonStub;
+
+  beforeEach(function () {
+    sandbox = Sinon.createSandbox();
+    sampleStub = sandbox.stub();
+    isCancelErrorStub = sandbox.stub();
+  });
+
+  async function createStore(services: Partial<SchemaPluginServices> = {}) {
+    const dataService = {
+      sample: sampleStub,
+      isCancelError: isCancelErrorStub,
+    };
     const connectionInfoRef = {
-      current: {},
-    } as ConnectionInfoRef;
-    let sampleStub: Sinon.SinonStub;
-    let isCancelErrorStub: Sinon.SinonStub;
+      current: {
+        connectionOptions: {
+          connectionString: 'mongodb://localhost:27017',
+        },
+        title: 'test',
+        id: 'test',
+      },
+    };
+
+    const plugin = activateSchemaPlugin(
+      {
+        namespace: namespace,
+      },
+      {
+        localAppRegistry: localAppRegistry,
+        globalAppRegistry: globalAppRegistry,
+        dataService,
+        logger: dummyLogger,
+        track: dummyTrack,
+        preferences: await createSandboxFromDefaultPreferences(),
+        fieldStoreService: mockFieldStoreService,
+        queryBar: mockQueryBar as any,
+        connectionInfoRef,
+        ...services,
+      },
+      createActivateHelpers()
+    );
+    store = plugin.store;
+    deactivate = () => plugin.deactivate();
+  }
 
+  describe('#configureStore', function () {
     beforeEach(async function () {
-      sandbox = Sinon.createSandbox();
-      sampleStub = sandbox.stub();
-      isCancelErrorStub = sandbox.stub();
-      const dataService = {
-        sample: sampleStub,
-        isCancelError: isCancelErrorStub,
-      };
-      const plugin = activateSchemaPlugin(
-        {
-          namespace: namespace,
-        },
-        {
-          localAppRegistry: localAppRegistry,
-          globalAppRegistry: globalAppRegistry,
-          dataService: dataService as any,
-          logger: dummyLogger,
-          track: dummyTrack,
-          preferences: await createSandboxFromDefaultPreferences(),
-          fieldStoreService: mockFieldStoreService,
-          queryBar: mockQueryBar as any,
-          connectionInfoRef,
-        },
-        createActivateHelpers()
-      );
-      store = plugin.store;
-      deactivate = () => plugin.deactivate();
+      await createStore();
     });
 
     afterEach(function () {
@@ -107,5 +122,37 @@ describe('Schema Store', function () {
       await analysisPromise;
       expect(store.getState().analysisState).to.equal('initial');
     });
+
+    it('runs the analysis with read pref secondaryPreferred', async function () {
+      sampleStub.resolves([{ name: 'Hans' }, { name: 'Greta' }]);
+      await store.dispatch(startAnalysis());
+      expect(sampleStub.getCall(0).args[2])
+        .property('readPreference')
+        .to.equal('secondaryPreferred');
+    });
+  });
+
+  describe('with a connection string with explicit read preference set', function () {
+    beforeEach(async function () {
+      await createStore({
+        connectionInfoRef: {
+          current: {
+            connectionOptions: {
+              connectionString:
+                'mongodb://localhost:27017/?readPreference=primary',
+            },
+            title: 'test',
+            id: 'test',
+          },
+        },
+      });
+    });
+
+    it('does not set read preference to secondaryPreferred', async function () {
+      await store.dispatch(startAnalysis());
+      expect(sampleStub.getCall(0).args[2]).not.to.have.property(
+        'readPreference'
+      );
+    });
   });
 });