chore(home, app-stores): remove unused data-service-* and instance-* globalAppRegistry events (#5495)

Author: gribnoysup

package-lock.json

@@ -1,7 +1,6 @@
 import { EventEmitter } from 'events';
 import AppRegistry, { createActivateHelpers } from 'hadron-app-registry';
 import { createInstanceStore } from './instance-store';
-import { once } from 'events';
 import sinon from 'sinon';
 import { expect } from 'chai';
 import { createNoopLoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
@@ -47,21 +46,28 @@ describe('InstanceStore [Store]', function () {
   let store: ReturnType<typeof createInstanceStore>;
   let instance: MongoDBInstance;
 
-  let emitSpy: any;
   let initialInstanceRefreshedPromise: Promise<unknown>;
   let sandbox: sinon.SinonSandbox;
 
+  function waitForInstanceRefresh(): Promise<void> {
+    return new Promise((resolve) => {
+      if (instance.refreshingStatus === 'ready') {
+        resolve();
+      }
+      instance.on('change:refreshingStatus', () => {
+        if (instance.refreshingStatus === 'ready') {
+          resolve();
+        }
+      });
+    });
+  }
+
   beforeEach(function () {
     globalAppRegistry = new AppRegistry();
     sandbox = sinon.createSandbox();
 
-    emitSpy = sandbox.spy(globalAppRegistry, 'emit');
     dataService = createDataService();
     const logger = createNoopLoggerAndTelemetry();
-    initialInstanceRefreshedPromise = once(
-      globalAppRegistry,
-      'instance-refreshed'
-    );
 
     store = createInstanceStore(
       {
@@ -72,22 +78,15 @@ describe('InstanceStore [Store]', function () {
       createActivateHelpers()
     );
     instance = store.state.instance;
+
+    initialInstanceRefreshedPromise = waitForInstanceRefresh();
   });
 
   afterEach(function () {
-    emitSpy = null;
     sandbox.restore();
     store.deactivate();
   });
 
-  context('when data service connects', function () {
-    it('emits instance-refreshed event', async function () {
-      await initialInstanceRefreshedPromise;
-      const events = emitSpy.args.map(([evtName]: any) => evtName);
-      expect(events).to.eql(['instance-created', 'instance-refreshed']);
-    });
-  });
-
   context('on refresh data', function () {
     beforeEach(async function () {
       sandbox
@@ -99,22 +98,12 @@ describe('InstanceStore [Store]', function () {
         '1.2.3'
       );
       globalAppRegistry.emit('refresh-data');
-      await once(globalAppRegistry, 'instance-refreshed');
+      await waitForInstanceRefresh();
     });
 
     it('calls instance model fetch', function () {
       expect(instance).to.have.nested.property('build.version', '3.2.1');
     });
-
-    it('emits instance-changed event', function () {
-      const events = emitSpy.args.map(([evtName]: any) => evtName);
-      expect(events).to.eql([
-        'instance-created',
-        'instance-refreshed',
-        'refresh-data',
-        'instance-refreshed',
-      ]);
-    });
   });
 
   context('when instance ready', function () {

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

@@ -37,9 +37,9 @@ function getTopologyDescription(
 
 export function createInstanceStore(
   {
-    globalAppRegistry: appRegistry,
+    globalAppRegistry,
     dataService,
-    logger: { debug },
+    logger: { log, mongoLogId },
   }: {
     dataService: DataService;
     logger: LoggerAndTelemetry;
@@ -57,19 +57,17 @@ export function createInstanceStore(
 
     try {
       await instance.refresh({ dataService, ...refreshOptions });
-
-      appRegistry.emit('instance-refreshed', {
-        instance,
-        dataService,
-        errorMessage: '',
-      });
     } catch (err: any) {
-      appRegistry.emit('instance-refreshed', {
-        instance,
-        dataService,
-        errorMessage: err.message,
-      });
-
+      log.warn(
+        mongoLogId(1_001_000_295),
+        'Instance Store',
+        'Failed to refresh instance',
+        {
+          message: (err as Error).message,
+          connectionId: dataService.id,
+          isFirstRun,
+        }
+      );
       // The `instance.refresh` method is catching all expected errors: we treat
       // a lot of metadata as optional so failing to fetch it shouldn't throw.
       // In most cases if this failed on subsequent runs, user is probably
@@ -92,16 +90,28 @@ export function createInstanceStore(
     }
   }
 
-  // Event emitted when the Databases grid needs to be refreshed
-  // We additionally refresh the list of collections as well
-  // since there is the side navigation which could be in expanded mode
+  // Event emitted when the Databases grid needs to be refreshed. We
+  // additionally refresh the list of collections as well since there is the
+  // side navigation which could be in expanded mode
   async function refreshDatabases() {
-    await instance.fetchDatabases({ dataService, force: true });
-    await Promise.allSettled(
-      instance.databases.map((db) =>
-        db.fetchCollections({ dataService, force: true })
-      )
-    );
+    try {
+      await instance.fetchDatabases({ dataService, force: true });
+      await Promise.allSettled(
+        instance.databases.map((db) =>
+          db.fetchCollections({ dataService, force: true })
+        )
+      );
+    } catch (err: any) {
+      log.warn(
+        mongoLogId(1_001_000_296),
+        'Instance Store',
+        'Failed to refresh databases',
+        {
+          message: (err as Error).message,
+          connectionId: dataService.id,
+        }
+      );
+    }
   }
 
   async function fetchAllCollections() {
@@ -174,12 +184,8 @@ export function createInstanceStore(
 
   addCleanup(() => {
     instance.removeAllListeners();
-    appRegistry.emit('instance-destroyed', { instance: null });
   });
 
-  debug('instance-created');
-  appRegistry.emit('instance-created', { instance });
-
   void refreshInstance({
     fetchDatabases: true,
     fetchDbStats: true,
@@ -197,22 +203,22 @@ export function createInstanceStore(
 
   on(dataService, 'topologyDescriptionChanged', onTopologyDescriptionChanged);
 
-  on(appRegistry, 'sidebar-expand-database', (dbName: string) => {
+  on(globalAppRegistry, 'sidebar-expand-database', (dbName: string) => {
     void instance.databases.get(dbName)?.fetchCollections({ dataService });
   });
 
-  on(appRegistry, 'sidebar-filter-navigation-list', fetchAllCollections);
+  on(globalAppRegistry, 'sidebar-filter-navigation-list', fetchAllCollections);
 
-  on(appRegistry, 'refresh-data', refreshInstance);
+  on(globalAppRegistry, 'refresh-data', refreshInstance);
 
-  on(appRegistry, 'database-dropped', (dbName: string) => {
+  on(globalAppRegistry, 'database-dropped', (dbName: string) => {
     const db = instance.databases.remove(dbName);
     if (db) {
       MongoDBInstance.removeAllListeners(db);
     }
   });
 
-  on(appRegistry, 'collection-dropped', (namespace: string) => {
+  on(globalAppRegistry, 'collection-dropped', (namespace: string) => {
     const { database } = toNS(namespace);
     const db = instance.databases.get(database);
     const coll = db?.collections.get(namespace, '_id');
@@ -236,10 +242,10 @@ export function createInstanceStore(
     }
   });
 
-  on(appRegistry, 'refresh-databases', refreshDatabases);
+  on(globalAppRegistry, 'refresh-databases', refreshDatabases);
 
   on(
-    appRegistry,
+    globalAppRegistry,
     'collection-renamed',
     ({ from, to }: { from: string; to: string }) => {
       const { database, collection } = toNS(from);
@@ -250,16 +256,20 @@ export function createInstanceStore(
     }
   );
 
-  on(appRegistry, 'document-deleted', refreshNamespaceStats);
-  on(appRegistry, 'document-inserted', refreshNamespaceStats);
-  on(appRegistry, 'import-finished', refreshNamespaceStats);
+  on(globalAppRegistry, 'document-deleted', refreshNamespaceStats);
+  on(globalAppRegistry, 'document-inserted', refreshNamespaceStats);
+  on(globalAppRegistry, 'import-finished', refreshNamespaceStats);
 
-  on(appRegistry, 'collection-created', maybeAddAndRefreshCollectionModel);
+  on(
+    globalAppRegistry,
+    'collection-created',
+    maybeAddAndRefreshCollectionModel
+  );
 
-  on(appRegistry, 'view-created', maybeAddAndRefreshCollectionModel);
+  on(globalAppRegistry, 'view-created', maybeAddAndRefreshCollectionModel);
 
   on(
-    appRegistry,
+    globalAppRegistry,
     'agg-pipeline-out-executed',
     // null means the out / merge stage destination wasn't a namespace in the
     // same cluster
@@ -271,7 +281,7 @@ export function createInstanceStore(
     }
   );
 
-  on(appRegistry, 'view-edited', (namespace: string) => {
+  on(globalAppRegistry, 'view-edited', (namespace: string) => {
     const { database } = toNS(namespace);
     void instance.databases
       .get(database)

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

@@ -108,6 +108,7 @@
     "@mongodb-js/tsconfig-compass": "^1.0.3",
     "@mongodb-js/webpack-config-compass": "^1.3.3",
     "@testing-library/react": "^12.1.4",
+    "@testing-library/user-event": "^13.5.0",
     "@types/chai": "^4.2.21",
     "chai": "^4.1.2",
     "depcheck": "^1.4.1",