chore: refactor ConnectionsManager and InstancesManager to throw when…

… DataService / Instance is not available (#5827)
mongodb-js · May 23, 2024 · 8409035 · 8409035
1 parent cbb9acc
commit 8409035
Show file tree

Hide file tree

Showing 18 changed files with 52 additions and 106 deletions.
diff --git a/packages/compass-aggregations/src/modules/create-view/index.ts b/packages/compass-aggregations/src/modules/create-view/index.ts
@@ -218,11 +218,6 @@ export const createView = (): CreateViewThunkAction<Promise<void>> => {
     try {
       const dataService =
         connectionsManager.getDataServiceForConnection(connectionId);
-      if (!dataService) {
-        throw new Error(
-          `DataService for connectionId ${connectionId} not found`
-        );
-      }
 
       dispatch(toggleIsRunning(true));
       await dataService.createView(

diff --git a/packages/compass-app-stores/src/instances-manager.spec.ts b/packages/compass-app-stores/src/instances-manager.spec.ts
@@ -73,9 +73,9 @@ describe('InstancesManager', function () {
   });
 
   it('should be able return a MongoDBInstance if available', function () {
-    const nonExistentInstance =
+    expect(() => {
       instancesManager.getMongoDBInstanceForConnection('1234'); // non-existent
-    expect(nonExistentInstance).to.be.undefined;
+    }).to.throw;
     instancesManager.createMongoDBInstanceForConnection(
       TEST_CONNECTION_INFO.id,
       {
@@ -89,10 +89,9 @@ describe('InstancesManager', function () {
         },
       }
     );
-    const existingInstance = instancesManager.getMongoDBInstanceForConnection(
-      TEST_CONNECTION_INFO.id
-    );
-    expect(existingInstance).to.not.be.undefined;
+    expect(() =>
+      instancesManager.getMongoDBInstanceForConnection(TEST_CONNECTION_INFO.id)
+    ).to.not.throw;
   });
 
   it('should be able to remove MongoDBInstance for a connection', function () {
@@ -109,15 +108,15 @@ describe('InstancesManager', function () {
         },
       }
     );
-    expect(
+    expect(() =>
       instancesManager.getMongoDBInstanceForConnection(TEST_CONNECTION_INFO.id)
-    ).to.not.be.undefined;
+    ).to.not.throw;
     instancesManager.removeMongoDBInstanceForConnection(
       TEST_CONNECTION_INFO.id
     );
-    expect(
+    expect(() =>
       instancesManager.getMongoDBInstanceForConnection(TEST_CONNECTION_INFO.id)
-    ).to.be.undefined;
+    ).to.throw;
   });
 
   it('should emit instances removed event when an instance is removed', function () {

diff --git a/packages/compass-app-stores/src/instances-manager.ts b/packages/compass-app-stores/src/instances-manager.ts
@@ -51,8 +51,16 @@ export class MongoDBInstancesManager extends EventEmitter {
     return new Map(this.instances);
   }
 
-  getMongoDBInstanceForConnection(connectionInfoId: ConnectionInfo['id']) {
-    return this.instances.get(connectionInfoId);
+  getMongoDBInstanceForConnection(
+    connectionInfoId: ConnectionInfo['id']
+  ): MongoDBInstance {
+    const instance = this.instances.get(connectionInfoId);
+    if (!instance) {
+      throw new Error(
+        `MongoDBInstance for connectionId - ${connectionInfoId} not present in InstancesManager.`
+      );
+    }
+    return instance;
   }
 
   removeMongoDBInstanceForConnection(connectionInfoId: ConnectionInfo['id']) {

diff --git a/packages/compass-app-stores/src/provider.tsx b/packages/compass-app-stores/src/provider.tsx
@@ -73,13 +73,7 @@ export const mongoDBInstanceLocator = createServiceLocator(
   function useMongoDBInstance(): MongoDBInstance {
     const connectionInfo = useConnectionInfo();
     const instancesManager = mongoDBInstancesManagerLocator();
-    const instance = instancesManager.getMongoDBInstanceForConnection(
-      connectionInfo.id
-    );
-    if (!instance) {
-      throw new Error('No MongoDBInstance available in this context');
-    }
-    return instance;
+    return instancesManager.getMongoDBInstanceForConnection(connectionInfo.id);
   },
   'mongoDBInstanceLocator'
 );

diff --git a/packages/compass-app-stores/src/stores/instance-store.spec.ts b/packages/compass-app-stores/src/stores/instance-store.spec.ts
@@ -108,12 +108,12 @@ describe('InstanceStore [Store]', function () {
       );
     }
 
-    expect(instancesManager.getMongoDBInstanceForConnection('1')).to.not.be
-      .undefined;
-    expect(instancesManager.getMongoDBInstanceForConnection('2')).to.not.be
-      .undefined;
-    expect(instancesManager.getMongoDBInstanceForConnection('3')).to.not.be
-      .undefined;
+    expect(() => instancesManager.getMongoDBInstanceForConnection('1')).to.not
+      .throw;
+    expect(() => instancesManager.getMongoDBInstanceForConnection('2')).to.not
+      .throw;
+    expect(() => instancesManager.getMongoDBInstanceForConnection('3')).to.not
+      .throw;
   });
 
   context('when connected', function () {
@@ -129,7 +129,7 @@ describe('InstanceStore [Store]', function () {
         connectedConnectionInfoId
       );
       expect(instance).to.not.be.undefined;
-      connectedInstance = instance as MongoDBInstance;
+      connectedInstance = instance;
       initialInstanceRefreshedPromise =
         waitForInstanceRefresh(connectedInstance);
     });
@@ -145,7 +145,7 @@ describe('InstanceStore [Store]', function () {
         );
         expect(instance).to.have.nested.property('build.version', '1.2.3');
         globalAppRegistry.emit('refresh-data');
-        await waitForInstanceRefresh(instance as MongoDBInstance);
+        await waitForInstanceRefresh(instance);
       });
 
       it('calls instance model fetch', function () {

diff --git a/packages/compass-connections/src/connections-manager.spec.ts b/packages/compass-connections/src/connections-manager.spec.ts
@@ -185,16 +185,16 @@ describe('ConnectionsManager', function () {
             getConnectionConfigurationOptions()
           ),
         ]);
-        expect(
+        expect(() =>
           connectionsManager.getDataServiceForConnection(
             connectedConnectionInfo1.id
           )
-        ).to.be.undefined;
-        expect(
+        ).to.throw;
+        expect(() =>
           connectionsManager.getDataServiceForConnection(
             connectedConnectionInfo2.id
           )
-        ).to.be.undefined;
+        ).to.throw;
       });
 
       context('when all connection attempts are cancelled', function () {
@@ -279,16 +279,16 @@ describe('ConnectionsManager', function () {
           });
           connectionsManager.cancelAllConnectionAttempts();
           await canceledPromise;
-          expect(
+          expect(() =>
             connectionsManager.getDataServiceForConnection(
               connectedConnectionInfo1.id
             )
-          ).to.be.undefined;
-          expect(
+          ).to.throw;
+          expect(() =>
             connectionsManager.getDataServiceForConnection(
               connectedConnectionInfo2.id
             )
-          ).to.be.undefined;
+          ).to.throw;
         });
       });
     }
@@ -370,11 +370,11 @@ describe('ConnectionsManager', function () {
         });
       void connectionsManager.closeConnection(connectedConnectionInfo1.id);
       await canceledPromise;
-      expect(
+      expect(() =>
         connectionsManager.getDataServiceForConnection(
           connectedConnectionInfo1.id
         )
-      ).to.be.undefined;
+      ).to.throw;
     });
 
     context(
@@ -573,9 +573,9 @@ describe('ConnectionsManager', function () {
       } catch (error) {
         // nothing
       }
-      expect(
+      expect(() =>
         connectionsManager.getDataServiceForConnection(failedConnectionInfo.id)
-      ).to.be.undefined;
+      ).to.throw;
     });
   });
 
@@ -638,9 +638,9 @@ describe('ConnectionsManager', function () {
         getConnectionConfigurationOptions()
       );
       await connectionsManager.closeConnection(activeConnectionInfo.id);
-      expect(
+      expect(() =>
         connectionsManager.getDataServiceForConnection(activeConnectionInfo.id)
-      ).to.be.undefined;
+      ).to.throw;
     });
   });
 

diff --git a/packages/compass-connections/src/connections-manager.ts b/packages/compass-connections/src/connections-manager.ts
@@ -139,10 +139,14 @@ export class ConnectionsManager extends EventEmitter {
     this.__TEST_CONNECT_FN = __TEST_CONNECT_FN;
   }
 
-  getDataServiceForConnection(
-    connectionInfoId: ConnectionInfoId
-  ): DataService | undefined {
-    return this.dataServices.get(connectionInfoId);
+  getDataServiceForConnection(connectionInfoId: ConnectionInfoId): DataService {
+    const dataService = this.dataServices.get(connectionInfoId);
+    if (!dataService) {
+      throw new Error(
+        `DataService for connectionId - ${connectionInfoId} not present in ConnectionsManager.`
+      );
+    }
+    return dataService;
   }
 
   statusOf(connectionInfoId: ConnectionInfoId): ConnectionStatus {
@@ -172,8 +176,7 @@ export class ConnectionsManager extends EventEmitter {
     }: ConnectionConfiguration = {}
   ): Promise<DataService> {
     try {
-      const existingDataService =
-        this.getDataServiceForConnection(connectionId);
+      const existingDataService = this.dataServices.get(connectionId);
 
       if (
         existingDataService &&

diff --git a/packages/compass-connections/src/provider.ts b/packages/compass-connections/src/provider.ts
@@ -70,9 +70,6 @@ export const dataServiceLocator = createServiceLocator(
     const ds = connectionsManager.getDataServiceForConnection(
       connectionInfo.id
     );
-    if (!ds) {
-      throw new Error('DataService is not available for the active connection');
-    }
     return ds;
   }
 );

diff --git a/packages/compass-import-export/src/modules/export.ts b/packages/compass-import-export/src/modules/export.ts
@@ -296,9 +296,6 @@ export const selectFieldsToExport = (): ExportThunkAction<
 
       const dataService =
         connectionsManager.getDataServiceForConnection(connectionId);
-      if (!dataService) {
-        throw new Error(`DataService for connection ${connectionId} not found`);
-      }
 
       gatherFieldsResult = await gatherFieldsFromQuery({
         ns: namespace,
@@ -456,9 +453,6 @@ export const runExport = ({
 
       const dataService =
         connectionsManager.getDataServiceForConnection(connectionId);
-      if (!dataService) {
-        throw new Error(`DataService for connection ${connectionId} not found`);
-      }
 
       const baseExportOptions = {
         ns: namespace,

diff --git a/packages/compass-import-export/src/modules/import.ts b/packages/compass-import-export/src/modules/import.ts
@@ -318,11 +318,6 @@ export const startImport = (): ImportThunkAction<Promise<void>> => {
 
       dataService =
         connectionsManager.getDataServiceForConnection(connectionId);
-      if (!dataService) {
-        throw new Error(
-          `DataService for connectionId ${connectionId} not found`
-        );
-      }
 
       if (fileType === 'csv') {
         result = await importCSV({

diff --git a/packages/compass-sidebar/src/modules/data-service.ts b/packages/compass-sidebar/src/modules/data-service.ts
@@ -9,12 +9,6 @@ export const setConnectionIsCSFLEEnabled = (
     const dataService =
       connectionsManager.getDataServiceForConnection(connectionId);
 
-    if (!dataService) {
-      throw new Error(
-        'unreachable: This is only visible when we are connected.'
-      );
-    }
-
     dataService.setCSFLEEnabled(enable);
     queueMicrotask(() => {
       globalAppRegistry?.emit('refresh-data');

diff --git a/packages/compass-sidebar/src/modules/instance.ts b/packages/compass-sidebar/src/modules/instance.ts
@@ -184,11 +184,6 @@ export const setupInstance =
 
     const dataService =
       connectionsManager.getDataServiceForConnection(connectionId);
-    if (!dataService) {
-      // This should be unreachable, because the instance state is only available
-      // whenever we have a Data Service connected, as it reads server metadata.
-      return;
-    }
 
     const connectionOptions = dataService.getConnectionOptions();
     dispatch(changeConnectionOptions(connectionId, connectionOptions)); // stores ssh tunnel status

diff --git a/packages/compass-workspaces/src/stores/workspaces.ts b/packages/compass-workspaces/src/stores/workspaces.ts
@@ -609,20 +609,10 @@ export const openWorkspace = (
             const dataService = connectionsManager.getDataServiceForConnection(
               workspaceOptions.connectionId
             );
-            if (!dataService) {
-              throw new Error(
-                `DataService not available for connectionId=${workspaceOptions.connectionId}`
-              );
-            }
 
             const instance = instancesManager.getMongoDBInstanceForConnection(
               workspaceOptions.connectionId
             );
-            if (!instance) {
-              throw new Error(
-                `MongoDBInstance not available for connectionId=${workspaceOptions.connectionId}`
-              );
-            }
 
             const coll = await instance.getNamespace({
               dataService,

diff --git a/packages/databases-collections/src/modules/create-namespace.ts b/packages/databases-collections/src/modules/create-namespace.ts
@@ -376,9 +376,6 @@ export const createNamespace = (
     try {
       dispatch(toggleIsRunning(true));
       const ds = connectionsManager.getDataServiceForConnection(connectionId);
-      if (!ds) {
-        throw new Error('DataService not available for connection');
-      }
 
       const options = await handleFLE2Options(ds, data.options);
 

diff --git a/packages/databases-collections/src/modules/rename-collection/rename-collection.ts b/packages/databases-collections/src/modules/rename-collection/rename-collection.ts
@@ -152,12 +152,6 @@ export const renameCollection = (
     const dataService =
       connectionsManager.getDataServiceForConnection(connectionId);
 
-    if (!dataService) {
-      throw new Error(
-        'unreachable: The modal is only shown when the connection is active.'
-      );
-    }
-
     dispatch(renameRequestInProgress());
     const oldNamespace = `${databaseName}.${initialCollectionName}`;
     const newNamespace = `${databaseName}.${newCollectionName}`;

diff --git a/packages/databases-collections/src/stores/create-namespace.spec.tsx b/packages/databases-collections/src/stores/create-namespace.spec.tsx
@@ -75,6 +75,7 @@ describe('CreateNamespacePlugin', function () {
         } else if (id === '2') {
           return dataService2;
         }
+        throw new Error('unknown id provided');
       });
 
     const instancesManager = new TestMongoDBInstanceManager();

diff --git a/packages/databases-collections/src/stores/drop-namespace.tsx b/packages/databases-collections/src/stores/drop-namespace.tsx
@@ -69,11 +69,6 @@ export function activatePlugin(
         const method = isCollection ? 'dropCollection' : 'dropDatabase';
         const dataService =
           connectionsManager.getDataServiceForConnection(connectionId);
-        if (!dataService) {
-          throw new Error(
-            'unreachable: only available when there is an open connection.'
-          );
-        }
 
         await dataService[method](ns);
         globalAppRegistry.emit(

diff --git a/packages/databases-collections/src/stores/rename-collection.ts b/packages/databases-collections/src/stores/rename-collection.ts
@@ -73,11 +73,6 @@ export function activateRenameCollectionPlugin(
 
       const instance =
         instancesManager.getMongoDBInstanceForConnection(connectionId);
-      if (!instance) {
-        throw new Error(
-          'unreachable: this modal is only shown when the connection is open.'
-        );
-      }
 
       const collections: { name: string }[] =
         instance.databases.get(ns.database)?.collections ?? [];