feat: disable db and coll stats via preferences COMPASS-5387 (#6852)

Author: paula-stacho

package-lock.json

@@ -64,18 +64,18 @@ interface CollectionProps {
   specialish: boolean;
   normal: boolean;
   readonly: boolean;
-  view_on: string;
+  view_on: string | null;
   collation: unknown;
   pipeline: unknown[];
   validation: unknown;
-  is_capped: boolean;
-  document_count: number;
-  document_size: number;
-  avg_document_size: number;
-  storage_size: number;
-  free_storage_size: number;
-  index_count: number;
-  index_size: number;
+  is_capped: boolean | undefined;
+  document_count: number | undefined;
+  document_size: number | undefined;
+  avg_document_size: number | undefined;
+  storage_size: number | undefined;
+  free_storage_size: number | undefined;
+  index_count: number | undefined;
+  index_size: number | undefined;
   isTimeSeries: boolean;
   isView: boolean;
   /** Only relevant for a view and identifies collection/view from which this view was created. */
@@ -85,7 +85,13 @@ interface CollectionProps {
   is_non_existent: boolean;
 }
 
-type CollectionDataService = Pick<DataService, 'collectionStats' | 'collectionInfo' | 'listCollections' | 'isListSearchIndexesSupported'>;
+type CollectionDataService = Pick<
+  DataService,
+  | 'collectionStats'
+  | 'collectionInfo'
+  | 'listCollections'
+  | 'isListSearchIndexesSupported'
+>;
 
 interface Collection extends CollectionProps {
   fetch(opts: {
@@ -106,7 +112,10 @@ interface Collection extends CollectionProps {
 }
 
 interface CollectionCollection extends Array<Collection> {
-  fetch(opts: { dataService: CollectionDataService; fetchInfo?: boolean }): Promise<void>;
+  fetch(opts: {
+    dataService: CollectionDataService;
+    fetchInfo?: boolean;
+  }): Promise<void>;
   toJSON(opts?: { derived: boolean }): Array<CollectionProps>;
   at(index: number): Collection | undefined;
   get(id: string, key?: '_id' | 'name'): Collection | undefined;

packages/collection-model/index.d.ts

@@ -104,7 +104,17 @@ function pickCollectionInfo({
   fle2,
   is_non_existent,
 }) {
-  return { type, readonly, view_on, collation, pipeline, validation, clustered, fle2, is_non_existent };
+  return {
+    type,
+    readonly,
+    view_on,
+    collation,
+    pipeline,
+    validation,
+    clustered,
+    fle2,
+    is_non_existent,
+  };
 }
 
 /**
@@ -232,18 +242,30 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
   },
 
   /**
-   * @param {{ dataService: import('mongodb-data-service').DataService }} dataService
+   * @param {{
+   *    dataService: import('mongodb-data-service').DataService,
+   *    fetchInfo: boolean,
+   *    force: boolean
+   * }} options
    * @returns
    */
   async fetch({ dataService, fetchInfo = true, force = false }) {
     if (!shouldFetch(this.status, force)) {
       return;
     }
+
+    const shouldFetchDbAndCollStats = getParentByType(
+      this,
+      'Instance'
+    ).shouldFetchDbAndCollStats;
+
     try {
       const newStatus = this.status === 'initial' ? 'fetching' : 'refreshing';
       this.set({ status: newStatus });
       const [collStats, collectionInfo] = await Promise.all([
-        dataService.collectionStats(this.database, this.name),
+        shouldFetchDbAndCollStats
+          ? dataService.collectionStats(this.database, this.name)
+          : null,
         fetchInfo ? dataService.collectionInfo(this.database, this.name) : null,
       ]);
       this.set({
@@ -255,7 +277,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
       // If the collection is not unprovisioned `is_non_existent` anymore,
       // let's update the parent database model to reflect the change.
       // This happens when a user tries to insert first document into a
-      // collection that doesn't exist yet or creates a new collection 
+      // collection that doesn't exist yet or creates a new collection
       // for an unprovisioned database.
       if (!this.is_non_existent) {
         getParentByType(this, 'Database').set({
@@ -271,7 +293,9 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
   /**
    * Fetches collection info and returns a special format of collection metadata
    * that events like open-in-new-tab, select-namespace, edit-view require
-   * @param {{ dataService: import('mongodb-data-service').DataService }} dataService
+   * @param {{
+   *    dataService: import('mongodb-data-service').DataService,
+   * }} options
    */
   async fetchMetadata({ dataService }) {
     try {

packages/collection-model/lib/model.js

@@ -27,6 +27,7 @@ import { runPipelineConfirmationDescription } from '../utils/modal-descriptions'
 import type { MongoDBInstance } from 'mongodb-instance-model';
 import type { DataService } from '../modules/data-service';
 import toNS from 'mongodb-ns';
+import type { PreferencesAccess } from 'compass-preferences-model';
 
 const WRITE_STAGE_LINK = {
   $merge:
@@ -225,12 +226,18 @@ const reducer: Reducer<State, Action> = (state = INITIAL_STATE, action) => {
   return state;
 };
 
-const confirmWriteOperationIfNeeded = async (
-  instance: MongoDBInstance,
-  dataService: DataService,
-  namespace: string,
-  pipeline: Document[]
-) => {
+const confirmWriteOperationIfNeeded = async ({
+  instance,
+  dataService,
+  namespace,
+  pipeline,
+}: {
+  instance: MongoDBInstance;
+  dataService: DataService;
+  namespace: string;
+  pipeline: Document[];
+  preferences: PreferencesAccess;
+}) => {
   const lastStageOperator = getStageOperator(pipeline[pipeline.length - 1]);
   let typeOfWrite;
 
@@ -289,17 +296,25 @@ export const runAggregation = (): PipelineBuilderThunkAction<Promise<void>> => {
   return async (
     dispatch,
     getState,
-    { pipelineBuilder, instance, dataService, track, connectionInfoRef }
+    {
+      pipelineBuilder,
+      instance,
+      dataService,
+      track,
+      connectionInfoRef,
+      preferences,
+    }
   ) => {
     const pipeline = getPipelineFromBuilderState(getState(), pipelineBuilder);
 
     if (
-      !(await confirmWriteOperationIfNeeded(
+      !(await confirmWriteOperationIfNeeded({
         instance,
         dataService,
-        getState().namespace,
-        pipeline
-      ))
+        namespace: getState().namespace,
+        pipeline,
+        preferences,
+      }))
     ) {
       return;
     }

packages/compass-aggregations/src/modules/aggregation.ts

@@ -79,6 +79,7 @@
     "mongodb-collection-model": "^5.25.8",
     "mongodb-database-model": "^2.25.8",
     "mongodb-instance-model": "^12.26.8",
+    "compass-preferences-model": "^2.33.8",
     "mongodb-ns": "^2.4.2",
     "react": "^17.0.2"
   },

packages/compass-app-stores/package.json

@@ -6,13 +6,19 @@ import {
 } from './instances-manager';
 import { MongoDBInstance } from 'mongodb-instance-model';
 import { createDefaultConnectionInfo } from '@mongodb-js/testing-library-compass';
+import {
+  type PreferencesAccess,
+  createSandboxFromDefaultPreferences,
+} from 'compass-preferences-model';
 
 const TEST_CONNECTION_INFO = createDefaultConnectionInfo();
 
 describe('InstancesManager', function () {
   let instancesManager: MongoDBInstancesManager;
-  beforeEach(function () {
+  let preferences: PreferencesAccess;
+  beforeEach(async function () {
     instancesManager = new MongoDBInstancesManager();
+    preferences = await createSandboxFromDefaultPreferences();
   });
 
   it('should be able to create and return a MongoDB instance', function () {
@@ -27,6 +33,7 @@ describe('InstancesManager', function () {
           servers: [],
           setName: '',
         },
+        preferences,
       }
     );
     expect(instance).to.be.instanceOf(MongoDBInstance);
@@ -44,6 +51,7 @@ describe('InstancesManager', function () {
           servers: [],
           setName: '',
         },
+        preferences,
       }
     );
     expect(instancesManager.listMongoDBInstances()).to.have.lengthOf(1);
@@ -66,6 +74,7 @@ describe('InstancesManager', function () {
           servers: [],
           setName: '',
         },
+        preferences,
       }
     );
     expect(onInstanceCreatedStub).to.be.calledOnceWithExactly(
@@ -89,6 +98,7 @@ describe('InstancesManager', function () {
           servers: [],
           setName: '',
         },
+        preferences,
       }
     );
     expect(() =>
@@ -108,6 +118,7 @@ describe('InstancesManager', function () {
           servers: [],
           setName: '',
         },
+        preferences,
       }
     );
     expect(() =>
@@ -138,6 +149,7 @@ describe('InstancesManager', function () {
           servers: [],
           setName: '',
         },
+        preferences,
       }
     );
     instancesManager.removeMongoDBInstanceForConnection(

packages/compass-app-stores/src/instances-manager.spec.ts

@@ -9,6 +9,8 @@ import { createInstancesStore } from './stores';
 import type { ConnectionsService } from '@mongodb-js/compass-connections/provider';
 import { connectionsLocator } from '@mongodb-js/compass-connections/provider';
 import { type MongoDBInstancesManager } from './instances-manager';
+import type { PreferencesAccess } from 'compass-preferences-model';
+import { preferencesLocator } from 'compass-preferences-model/provider';
 
 interface MongoDBInstancesProviderProps {
   children?: React.ReactNode;
@@ -37,10 +39,12 @@ export const CompassInstanceStorePlugin = registerHadronPlugin(
       {
         connections,
         logger,
+        preferences,
         globalAppRegistry,
       }: {
         connections: ConnectionsService;
         logger: Logger;
+        preferences: PreferencesAccess;
         globalAppRegistry: AppRegistry;
       },
       helpers: ActivateHelpers
@@ -49,6 +53,7 @@ export const CompassInstanceStorePlugin = registerHadronPlugin(
         {
           connections,
           logger,
+          preferences,
           globalAppRegistry,
         },
         helpers
@@ -63,6 +68,7 @@ export const CompassInstanceStorePlugin = registerHadronPlugin(
   },
   {
     logger: createLoggerLocator('COMPASS-INSTANCE-STORE'),
+    preferences: preferencesLocator,
     connections: connectionsLocator,
   }
 );