chore(compass-import-export): Convert import-export to a global plugin instead of a scoped one COMPASS-5537 COMPASS-4911 COMPASS-5143 (#2835)

* chore(compass-import-export): Convert import-export to a global plugin instead of a scoped one

* chore(import-export): Clean-up import-finished event usage

Author: gribnoysup

packages/compass-aggregations/src/stores/store.js

@@ -193,13 +193,6 @@ const configureStore = (options = {}) => {
     const localAppRegistry = options.localAppRegistry;
     setLocalAppRegistry(store, localAppRegistry);
 
-    /**
-     * When the collection is changed, update the store.
-     */
-    localAppRegistry.on('import-finished', () => {
-      refreshInput(store);
-    });
-
     /**
      * Refresh documents on data refresh.
      */
@@ -229,6 +222,13 @@ const configureStore = (options = {}) => {
       refreshInput(store);
     });
 
+    globalAppRegistry.on('import-finished', ({ ns }) => {
+      const { namespace } = store.getState();
+      if (ns === namespace) {
+        refreshInput(store);
+      }
+    });
+
     /**
      * Set the environment.
      */

packages/compass-collection/src/stores/store.js

@@ -139,6 +139,33 @@ store.onActivated = (appRegistry) => {
     }
   });
 
+  ipc.on('compass:open-export', () => {
+    const state = store.getState();
+    if (state.tabs) {
+      const activeTab = state.tabs.find((tab) => tab.isActive === true);
+      if (activeTab) {
+        const crudStore = activeTab.localAppRegistry.getStore('CRUD.Store');
+        const { query: crudQuery, count } = crudStore.state;
+        const { filter, limit, skip } = crudQuery;
+        appRegistry.emit('open-export', {
+          namespace: activeTab.namespace,
+          query: { filter, limit, skip },
+          count,
+        });
+      }
+    }
+  });
+
+  ipc.on('compass:open-import', () => {
+    const state = store.getState();
+    if (state.tabs) {
+      const activeTab = state.tabs.find((tab) => tab.isActive === true);
+      if (activeTab) {
+        appRegistry.emit('open-import', { namespace: activeTab.namespace });
+      }
+    }
+  });
+
   /**
    * Set the app registry to use later.
    */

packages/compass-crud/src/stores/crud-store.js

@@ -717,16 +717,22 @@ const configureStore = (options = {}) => {
      * Emits a global app registry event the plugin listens to.
      */
     openImportFileDialog() {
-      this.localAppRegistry.emit('open-import');
+      this.globalAppRegistry.emit('open-import', { namespace: this.state.ns });
     },
 
     /**
      * Open an export file dialog from compass-import-export-plugin.
      * Emits a global app registry event the plugin listens to.
      */
     openExportFileDialog() {
-      // Pass the doc count to the export modal so we can avoid re-counting.
-      this.localAppRegistry.emit('open-export', this.state.count);
+      // Only three query fields that export modal will handle
+      const { filter, limit, skip } = this.state.query;
+      this.globalAppRegistry.emit('open-export', {
+        namespace: this.state.ns,
+        query: { filter, limit, skip },
+        // Pass the doc count to the export modal so we can avoid re-counting.
+        count: this.state.count
+      });
     },
 
     /**
@@ -1228,7 +1234,6 @@ const configureStore = (options = {}) => {
     const localAppRegistry = options.localAppRegistry;
 
     localAppRegistry.on('query-changed', store.onQueryChanged.bind(store));
-    localAppRegistry.on('import-finished', store.refreshDocuments.bind(store));
     localAppRegistry.on('refresh-data', store.refreshDocuments.bind(store));
 
     setLocalAppRegistry(store, options.localAppRegistry);
@@ -1241,10 +1246,17 @@ const configureStore = (options = {}) => {
     globalAppRegistry.on('instance-created', ({ instance }) => {
       store.onInstanceCreated(instance);
     });
+
     globalAppRegistry.on('refresh-data', () => {
       store.refreshDocuments();
     });
 
+    globalAppRegistry.on('import-finished', ({ ns }) => {
+      if (ns === store.state.ns) {
+        store.refreshDocuments();
+      }
+    });
+
     setGlobalAppRegistry(store, globalAppRegistry);
   }
 

packages/compass-import-export/src/components/export-modal/export-modal.jsx

@@ -386,12 +386,6 @@ class ExportModal extends PureComponent {
  * @returns {Object} The mapped properties.
  */
 const mapStateToProps = (state) => {
-  const exportCount = state.exportData.count;
-  const rawCount = state.stats.rawDocumentCount;
-
-  // 0 is a valid number of documents
-  const count = typeof exportCount === 'number' ? exportCount : rawCount;
-
   return {
     ns: state.ns,
     error: state.exportData.error,
@@ -405,7 +399,8 @@ const mapStateToProps = (state) => {
     exportStep: state.exportData.exportStep,
     isFullCollection: state.exportData.isFullCollection,
     exportedDocsCount: state.exportData.exportedDocsCount,
-    count
+    // 0 is a valid number of documents, only ignore null or undefined
+    count: state.exportData.count ?? null
   };
 };
 

packages/compass-import-export/src/components/export-modal/export-modal.spec.js

@@ -2,21 +2,19 @@ import React from 'react';
 import { mount } from 'enzyme';
 import { expect } from 'chai';
 
-import configureExportstore from '../../stores/export-store';
+import store from '../../stores/export-store';
 import ExportModal from './export-modal';
 
-function renderModal(store) {
+function renderModal() {
   return mount(
     <ExportModal store={store}/>
   );
 }
 
 describe('ExportModal Component', function() {
-  let store;
   let state;
 
   beforeEach(function() {
-    store = configureExportstore();
     state = store.getState();
 
     // all the state for all export stores is the same state until we make a copy here
@@ -26,23 +24,23 @@ describe('ExportModal Component', function() {
 
   it('should render zero results', function() {
     state.exportData.count = 0;
-    const component = renderModal(store);
+    const component = renderModal();
     const elements = component.find('[data-test-id="export-with-filters-label"]');
     expect(elements).to.have.lengthOf(1);
     expect(elements.first().text()).to.equal('Export query with filters — 0 results (Recommended)');
   });
 
   it('should render 5 results', function() {
     state.exportData.count = 5;
-    const component = renderModal(store);
+    const component = renderModal();
     const elements = component.find('[data-test-id="export-with-filters-label"]');
     expect(elements).to.have.lengthOf(1);
     expect(elements.first().text()).to.equal('Export query with filters — 5 results (Recommended)');
   });
 
   it('should render 5 results', function() {
     state.exportData.count = null;
-    const component = renderModal(store);
+    const component = renderModal();
     const elements = component.find('[data-test-id="export-with-filters-label"]');
     expect(elements).to.have.lengthOf(1);
     expect(elements.first().text()).to.equal('Export query with filters (Recommended)');

packages/compass-import-export/src/export-plugin.js

@@ -1,22 +1,17 @@
 import React, { Component } from 'react';
-import PropTypes from 'prop-types';
 import { Provider } from 'react-redux';
 import ExportModal from './components/export-modal';
+import exportStore from './stores/export-store';
 
 class ExportPlugin extends Component {
-  static displayName = 'ExportPlugin';
-  static propTypes = {
-    store: PropTypes.object.isRequired
-  }
-
   /**
    * Connect the Plugin to the store and render.
    *
    * @returns {React.Component} The rendered component.
    */
   render() {
     return (
-      <Provider store={this.props.store}>
+      <Provider store={exportStore}>
         <ExportModal />
       </Provider>
     );

packages/compass-import-export/src/import-plugin.js

@@ -1,22 +1,17 @@
 import React, { Component } from 'react';
-import PropTypes from 'prop-types';
 import { Provider } from 'react-redux';
 import ImportModal from './components/import-modal';
+import importStore from './stores/import-store';
 
 class ImportPlugin extends Component {
-  static displayName = 'ImportPlugin';
-  static propTypes = {
-    store: PropTypes.object.isRequired
-  }
-
   /**
    * Connect the Plugin to the store and render.
    *
    * @returns {React.Component} The rendered component.
    */
   render() {
     return (
-      <Provider store={this.props.store}>
+      <Provider store={importStore}>
         <ImportModal />
       </Provider>
     );

packages/compass-import-export/src/index.js

@@ -1,18 +1,15 @@
 import Plugin from './plugin';
 import ImportPlugin from './import-plugin';
 import ExportPlugin from './export-plugin';
-import configureExportStore from './stores/export-store';
-import configureImportStore from './stores/import-store';
+import exportStore from './stores/export-store';
+import importStore from './stores/import-store';
 
 /**
  * The import plugin.
  */
 const IMPORT_ROLE = {
   name: 'Import',
   component: ImportPlugin,
-  configureStore: configureImportStore,
-  configureActions: () => {},
-  storeName: 'Import.Store'
 };
 
 /**
@@ -21,36 +18,30 @@ const IMPORT_ROLE = {
 const EXPORT_ROLE = {
   name: 'Export',
   component: ExportPlugin,
-  configureStore: configureExportStore,
-  configureActions: () => {},
-  storeName: 'Export.Store'
 };
 
 /**
  * Activate all the components in the Import Export package.
  * @param {Object} appRegistry - The Hadron appRegisrty to activate this plugin with.
  **/
 function activate(appRegistry) {
-  appRegistry.registerRole('Collection.ScopedModal', IMPORT_ROLE);
-  appRegistry.registerRole('Collection.ScopedModal', EXPORT_ROLE);
+  appRegistry.registerRole('Global.Modal', EXPORT_ROLE);
+  appRegistry.registerStore('ExportModal.Store', exportStore);
+  appRegistry.registerRole('Global.Modal', IMPORT_ROLE);
+  appRegistry.registerStore('ImportModal.Store', importStore);
 }
 
 /**
  * Deactivate all the components in the Import Export package.
  * @param {Object} appRegistry - The Hadron appRegisrty to deactivate this plugin with.
  **/
 function deactivate(appRegistry) {
-  appRegistry.deregisterRole('Collection.ScopedModal', IMPORT_ROLE);
-  appRegistry.deregisterRole('Collection.ScopedModal', EXPORT_ROLE);
+  appRegistry.deregisterRole('Global.Modal', EXPORT_ROLE);
+  appRegistry.deregisterStore('ExportModal.Store', exportStore);
+  appRegistry.deregisterRole('Global.Modal', IMPORT_ROLE);
+  appRegistry.deregisterStore('ImportModal.Store', importStore);
 }
 
 export default Plugin;
-export {
-  activate,
-  deactivate,
-  ImportPlugin,
-  ExportPlugin,
-  configureExportStore,
-  configureImportStore
-};
+export { activate, deactivate, ImportPlugin, ExportPlugin };
 export { default as metadata } from '../package.json';