feat: disable db and coll stats via preferences

Author: paula-stacho

package-lock.json

@@ -65,18 +65,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;
+  document_count?: number;
+  document_size?: number;
+  avg_document_size?: number;
+  storage_size?: number;
+  free_storage_size?: number;
+  index_count?: number;
+  index_size?: number;
   isTimeSeries: boolean;
   isView: boolean;
   /** Only relevant for a view and identifies collection/view from which this view was created. */

packages/collection-model/index.d.ts

@@ -260,7 +260,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
 
     try {
       console.log('[collection-model]', 'starting');
-      const newStatus = this.status === 'initialed' ? 'fetching' : 'refreshing';
+      const newStatus = this.status === 'initial' ? 'fetching' : 'refreshing';
       this.set({ status: newStatus });
       const [collStats, collectionInfo] = await Promise.all([
         enableDbAndCollStats

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 { PreferencesAccess } from 'compass-preferences-model';
 
 const WRITE_STAGE_LINK = {
   $merge:
@@ -225,12 +226,19 @@ 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,
+  preferences,
+}: {
+  instance: MongoDBInstance;
+  dataService: DataService;
+  namespace: string;
+  pipeline: Document[];
+  preferences: PreferencesAccess;
+}) => {
   const lastStageOperator = getStageOperator(pipeline[pipeline.length - 1]);
   let typeOfWrite;
 
@@ -252,6 +260,7 @@ const confirmWriteOperationIfNeeded = async (
         dataService,
         database,
         collection,
+        preferences,
       }));
     } else {
       isOverwritingCollection = true;
@@ -289,17 +298,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

@@ -20,6 +20,7 @@ import { MongoDBInstancesManager } from './instances-manager';
 import toNS from 'mongodb-ns';
 import type Collection from 'mongodb-collection-model';
 import type Database from 'mongodb-database-model';
+import { usePreferences } from 'compass-preferences-model/provider';
 
 export {
   MongoDBInstancesManagerEvents,
@@ -130,6 +131,7 @@ export const NamespaceProvider = createServiceProvider(
     const ns = useMemo(() => {
       return toNS(namespace);
     }, [namespace]);
+    const preferences = usePreferences(['enableDbAndCollStats']);
     const [namespaceModel, setNamespaceModel] = useState<
       Database | Collection | null
     >(() => {
@@ -166,7 +168,7 @@ export const NamespaceProvider = createServiceProvider(
           return;
         }
 
-        await db.fetchCollections({ dataService }).catch(() => {
+        await db.fetchCollections({ dataService, preferences }).catch(() => {
           // See above
         });
         const coll = db.collections.get(ns.ns);
@@ -190,6 +192,7 @@ export const NamespaceProvider = createServiceProvider(
       ns.collection,
       ns.database,
       ns.ns,
+      preferences,
     ]);
 
     if (!namespaceModel) {

packages/compass-app-stores/src/provider.tsx

@@ -72,7 +72,7 @@ export function createInstancesStore(
       await instance.fetchDatabases({ dataService });
       await Promise.all(
         instance.databases.map((db) => {
-          return db.fetchCollections({ dataService });
+          return db.fetchCollections({ dataService, preferences });
         })
       );
     } catch (error) {
@@ -91,7 +91,7 @@ export function createInstancesStore(
   const refreshInstance = async (
     refreshOptions: Omit<
       Parameters<MongoDBInstance['refresh']>[0],
-      'dataService'
+      'dataService' | 'preferences'
     > = {},
     { connectionId }: { connectionId?: string } = {}
   ) => {
@@ -105,16 +105,10 @@ export function createInstancesStore(
         instancesManager.getMongoDBInstanceForConnection(connectionId);
       const dataService = connections.getDataServiceForConnection(connectionId);
       isFirstRun = instance.status === 'initial';
-      const { enableDbAndCollStats } = preferences.getPreferences();
       await instance.refresh({
         dataService,
         ...refreshOptions,
-        fetchDbStats: enableDbAndCollStats
-          ? refreshOptions.fetchDbStats
-          : false,
-        fetchCollStats: enableDbAndCollStats
-          ? refreshOptions.fetchCollStats
-          : false,
+        preferences,
       });
     } catch (err: any) {
       log.warn(
@@ -165,7 +159,7 @@ export function createInstancesStore(
       await instance.fetchDatabases({ dataService, force: true });
       await Promise.allSettled(
         instance.databases.map((db) =>
-          db.fetchCollections({ dataService, force: true })
+          db.fetchCollections({ dataService, preferences, force: true })
         )
       );
     } catch (err: any) {
@@ -353,7 +347,7 @@ export function createInstancesStore(
           connections.getDataServiceForConnection(connectionId);
         void instance.databases
           .get(databaseId)
-          ?.fetchCollections({ dataService });
+          ?.fetchCollections({ dataService, preferences });
       } catch (error) {
         log.warn(
           mongoLogId(1_001_000_323),

packages/compass-app-stores/src/stores/instance-store.ts

@@ -461,7 +461,12 @@ export const openSavedItem =
   async (
     dispatch,
     getState,
-    { instancesManager, connections, logger: { log, mongoLogId } }
+    {
+      instancesManager,
+      connections,
+      logger: { log, mongoLogId },
+      preferencesAccess: preferences,
+    }
   ) => {
     const {
       savedItems: { items },
@@ -494,6 +499,7 @@ export const openSavedItem =
           dataService,
           database,
           collection,
+          preferences,
         });
 
         if (coll) {
@@ -594,7 +600,11 @@ export const openSelectedItem =
 
 export const databaseSelected =
   (database: string): SavedQueryAggregationThunkAction<Promise<void>> =>
-  async (dispatch, getState, { instancesManager, connections }) => {
+  async (
+    dispatch,
+    getState,
+    { instancesManager, connections, preferencesAccess: preferences }
+  ) => {
     const {
       openItem: { selectedDatabase, selectedConnection },
     } = getState();
@@ -621,7 +631,7 @@ export const databaseSelected =
         throw new Error('Database not found');
       }
 
-      await db.fetchCollections({ dataService });
+      await db.fetchCollections({ dataService, preferences });
       // Check with the the current value in case db was re-selected while we
       // were fetching
       if (database === getState().openItem.selectedDatabase) {

packages/compass-saved-aggregations-queries/src/stores/open-item.ts

@@ -724,6 +724,7 @@ const fetchCollectionInfo = (
         dataService,
         database,
         collection,
+        preferences,
       });
 
       if (coll) {

packages/compass-workspaces/src/stores/workspaces.ts

@@ -5,7 +5,6 @@ import type { PreferencesAccess } from 'compass-preferences-model';
 interface DatabaseProps {
   _id: string;
   name: string;
-  hasDbStats: boolean;
   status: 'initial' | 'fetching' | 'refreshing' | 'ready' | 'error';
   statusError: string | null;
   collectionsStatus: 'initial' | 'fetching' | 'refreshing' | 'ready' | 'error';
@@ -29,11 +28,13 @@ interface Database extends DatabaseProps {
   }): Promise<void>;
   fetchCollections(opts: {
     dataService: DataService;
+    preferences: PreferenceAccess;
     fetchInfo?: boolean;
     force?: boolean;
   }): Promise<void>;
   fetchCollectionsDetails(opts: {
     dataService: DataService;
+    preferences: PreferenceAccess;
     nameOnly?: boolean;
     force?: boolean;
   }): Promise<void>;

packages/database-model/index.d.ts

@@ -149,7 +149,7 @@ const DatabaseModel = AmpersandModel.extend(
 
       if (!enableDbAndCollStats) {
         console.log('[database-model]', 'Skipping');
-        this.set({ status: 'ready', hasDbStats: 'false' });
+        this.set({ status: 'ready' });
         return;
       } else {
         console.log('[database-model]', 'Not skipping');
@@ -162,7 +162,6 @@ const DatabaseModel = AmpersandModel.extend(
         this.set({
           status: 'ready',
           statusError: null,
-          hasDbStats: true,
           ...stats,
         });
       } catch (err) {
@@ -181,18 +180,25 @@ const DatabaseModel = AmpersandModel.extend(
      */
     async fetchCollections({ dataService, preferences, force = false }) {
       if (!shouldFetch(this.collectionsStatus, force)) {
+        console.log('[database-model]', 'skipping collection');
         return;
       }
 
       try {
         const newStatus =
           this.collectionsStatus === 'initial' ? 'fetching' : 'refreshing';
         this.set({ collectionsStatus: newStatus });
-        console.log('[database-model]', 'Fetching collections');
+        console.log(
+          '[database-model]',
+          'Fetching collections',
+          preferences,
+          this.collections.fetch
+        );
         await this.collections.fetch({ dataService, preferences, force });
         console.log('[database-model]', 'Done with collections');
         this.set({ collectionsStatus: 'ready', collectionsStatusError: null });
       } catch (err) {
+        console.log('[database-model]', 'failure', err);
         this.set({
           collectionsStatus: 'error',
           collectionsStatusError: err.message,
@@ -203,11 +209,13 @@ const DatabaseModel = AmpersandModel.extend(
 
     async fetchCollectionsDetails({
       dataService,
+      preferences,
       nameOnly = false,
       force = false,
     }) {
       await this.fetchCollections({
         dataService,
+        preferences,
         force,
       });
 
@@ -221,6 +229,7 @@ const DatabaseModel = AmpersandModel.extend(
         this.collections.map((coll) => {
           return coll.fetch({
             dataService,
+            preferences,
             // We already fetched it with fetchCollections
             fetchInfo: false,
             force,