chore(aggregations): refactor create-view to use service injection CO…

…MPASS-7410 (#5087) chore(aggregations): refactor create-view to use service injection
mongodb-js · Nov 10, 2023 · 93eb5ce · 93eb5ce
1 parent 20aa4f5
commit 93eb5ce
Show file tree

Hide file tree

Showing 20 changed files with 335 additions and 491 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/compass-aggregations/package.json b/packages/compass-aggregations/package.json
@@ -54,6 +54,7 @@
     "hadron-app-registry": "^9.0.14",
     "hadron-document": "^8.4.3",
     "hadron-type-checker": "^7.1.0",
+    "mongodb-data-service": "^22.15.1",
     "react": "^17.0.2"
   },
   "devDependencies": {
@@ -80,7 +81,6 @@
     "lodash": "^4.17.21",
     "mocha": "^10.2.0",
     "mongodb": "^6.0.0",
-    "mongodb-data-service": "^22.15.1",
     "mongodb-ns": "^2.4.0",
     "mongodb-query-parser": "^3.1.3",
     "mongodb-schema": "^12.0.0",
@@ -113,7 +113,8 @@
     "compass-preferences-model": "^2.15.6",
     "hadron-app-registry": "^9.0.13",
     "hadron-document": "^8.4.3",
-    "hadron-type-checker": "^7.1.0"
+    "hadron-type-checker": "^7.1.0",
+    "mongodb-data-service": "^22.15.1"
   },
   "homepage": "https://github.com/mongodb-js/compass",
   "bugs": {

diff --git a/...s/create-view-modal/create-view-modal.jsx → ...s/create-view-modal/create-view-modal.tsx b/...s/create-view-modal/create-view-modal.jsx → ...s/create-view-modal/create-view-modal.tsx
@@ -1,7 +1,5 @@
 import React, { PureComponent } from 'react';
-import PropTypes from 'prop-types';
 import { connect } from 'react-redux';
-
 import {
   Banner,
   Body,
@@ -11,38 +9,36 @@ import {
   spacing,
   TextInput,
 } from '@mongodb-js/compass-components';
-
-import { createView } from '../../modules/create-view';
-import { changeViewName } from '../../modules/create-view/name';
-import { toggleIsVisible } from '../../modules/create-view/is-visible';
-import { createLoggerAndTelemetry } from '@mongodb-js/compass-logging';
-const { track } = createLoggerAndTelemetry('COMPASS-AGGREGATIONS-UI');
+import {
+  createView,
+  changeViewName,
+  toggleIsVisible,
+} from '../../modules/create-view';
+import type { LoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
+import { withLoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
+import type { CreateViewRootState } from '../../stores/create-view';
 
 const progressContainerStyles = css({
   display: 'flex',
   gap: spacing[2],
   alignItems: 'center',
 });
 
-class CreateViewModal extends PureComponent {
-  static displayName = 'CreateViewModalComponent';
-
-  static propTypes = {
-    createView: PropTypes.func.isRequired,
-
-    isVisible: PropTypes.bool.isRequired,
-    toggleIsVisible: PropTypes.func.isRequired,
-
-    name: PropTypes.string,
-    changeViewName: PropTypes.func.isRequired,
-    isDuplicating: PropTypes.bool.isRequired,
-
-    source: PropTypes.string.isRequired,
-    pipeline: PropTypes.array.isRequired,
-    isRunning: PropTypes.bool.isRequired,
-    error: PropTypes.object,
-  };
-
+type CreateViewModalProps = {
+  createView: () => void;
+  isVisible?: boolean;
+  toggleIsVisible: (newVal: boolean) => void;
+  name?: string;
+  changeViewName: (name: string) => void;
+  isDuplicating?: boolean;
+  source?: string;
+  pipeline?: unknown[];
+  isRunning?: boolean;
+  error: Error | null;
+  logger: LoggerAndTelemetry;
+};
+
+class CreateViewModal extends PureComponent<CreateViewModalProps> {
   static defaultProps = {
     name: '',
     source: '',
@@ -52,19 +48,17 @@ class CreateViewModal extends PureComponent {
     isDuplicating: false,
   };
 
-  componentDidUpdate(prevProps) {
+  componentDidUpdate(prevProps: CreateViewModalProps) {
     if (prevProps.isVisible !== this.props.isVisible && this.props.isVisible) {
-      track('Screen', { name: 'create_view_modal' });
+      this.props.logger.track('Screen', { name: 'create_view_modal' });
     }
   }
 
-  onNameChange = (evt) => {
-    this.props.changeViewName(evt.target.value);
+  onNameChange = (evt: React.ChangeEvent<HTMLInputElement>) => {
+    this.props.changeViewName(evt.currentTarget.value);
   };
 
-  onFormSubmit = (evt) => {
-    evt.preventDefault();
-    evt.stopPropagation();
+  onFormSubmit = () => {
     this.props.createView();
   };
 
@@ -74,15 +68,13 @@ class CreateViewModal extends PureComponent {
 
   /**
    * Render the save pipeline component.
-   *
-   * @returns {Component} The component.
    */
   render() {
     return (
       <FormModal
         title={this.props.isDuplicating ? 'Duplicate View' : 'Create a View'}
         open={this.props.isVisible}
-        onSubmit={this.props.createView}
+        onSubmit={this.onFormSubmit}
         onCancel={this.onCancel}
         submitButtonText="Create"
         data-testid="create-view-modal"
@@ -110,12 +102,8 @@ class CreateViewModal extends PureComponent {
 
 /**
  * Map the store state to properties to pass to the components.
- *
- * @param {Object} state - The store state.
- *
- * @returns {Object} The mapped properties.
  */
-const mapStateToProps = (state) => ({
+const mapStateToProps = (state: CreateViewRootState) => ({
   isRunning: state.isRunning,
   isVisible: state.isVisible,
   isDuplicating: state.isDuplicating,
@@ -129,11 +117,14 @@ const mapStateToProps = (state) => ({
  * Connect the redux store to the component.
  * (dispatch)
  */
-const MappedCreateViewModal = connect(mapStateToProps, {
-  createView,
-  changeViewName,
-  toggleIsVisible,
-})(CreateViewModal);
+const MappedCreateViewModal = withLoggerAndTelemetry(
+  connect(mapStateToProps, {
+    createView,
+    changeViewName,
+    toggleIsVisible,
+  })(CreateViewModal),
+  'COMPASS-CREATE-VIEW-UI'
+);
 
 export default MappedCreateViewModal;
 export { CreateViewModal };
diff --git a/...src/components/create-view-modal/index.js → ...src/components/create-view-modal/index.ts b/...src/components/create-view-modal/index.js → ...src/components/create-view-modal/index.ts
diff --git a/packages/compass-aggregations/src/index.ts b/packages/compass-aggregations/src/index.ts
@@ -6,6 +6,8 @@ import { Aggregations } from './components/aggregations';
 import { activateCreateViewPlugin } from './stores/create-view';
 import StageEditor from './components/stage-editor';
 import CreateViewModal from './components/create-view-modal';
+import { dataServiceLocator } from 'mongodb-data-service/provider';
+import { createLoggerAndTelemetryLocator } from '@mongodb-js/compass-logging/provider';
 
 /**
  * A sample role for the component.
@@ -40,11 +42,17 @@ const deactivate = (appRegistry: AppRegistry) => {
   appRegistry.deregisterRole('Collection.Tab', ROLE);
 };
 
-export const CreateViewPlugin = registerHadronPlugin({
-  name: 'CreateView',
-  component: CreateViewModal,
-  activate: activateCreateViewPlugin,
-});
+export const CreateViewPlugin = registerHadronPlugin(
+  {
+    name: 'CreateView',
+    component: CreateViewModal,
+    activate: activateCreateViewPlugin,
+  },
+  {
+    dataService: dataServiceLocator as typeof dataServiceLocator<'createView'>,
+    logger: createLoggerAndTelemetryLocator('COMPASS-CREATE-VIEW-UI'),
+  }
+);
 
 export default AggregationsPlugin;
 export { activate, deactivate, Aggregations, StageEditor, configureStore };

diff --git a/packages/compass-aggregations/src/modules/create-view/error.js b/packages/compass-aggregations/src/modules/create-view/error.js