chore(compass-collection): Add more types to tab reducers (#3545)

Author: Anemy

package-lock.json

@@ -104,7 +104,6 @@
     "redux": "^4.2.0",
     "redux-thunk": "^2.3.0",
     "rimraf": "^3.0.2",
-    "semver": "^5.4.1",
     "sinon": "^9.2.3",
     "xvfb-maybe": "^0.2.1"
   }

packages/compass-collection/package.json

@@ -117,7 +117,7 @@ type CollectionHeaderProps = {
   isFLE: boolean;
   selectOrCreateTab: (options: any) => any;
   sourceName?: string;
-  sourceReadonly: boolean;
+  sourceReadonly?: boolean;
   sourceViewOn?: string;
   editViewName?: string;
   pipeline: Document[];

packages/compass-collection/src/components/collection-header/collection-header.tsx

@@ -40,7 +40,7 @@ type CollectionProps = {
   isClustered: boolean;
   isFLE: boolean;
   editViewName?: string;
-  sourceReadonly: boolean;
+  sourceReadonly?: boolean;
   sourceViewOn?: string;
   selectOrCreateTab: (options: any) => any;
   pipeline: Document[];

packages/compass-collection/src/components/collection/collection.tsx

@@ -51,10 +51,7 @@ export default function reducer(
  *
  * @returns {Object} The data service connected action.
  */
-export const dataServiceConnected = (
-  error: any,
-  dataService: DataService
-): any => ({
+export const dataServiceConnected = (error: any, dataService: DataService) => ({
   type: DATA_SERVICE_CONNECTED,
   error: error,
   dataService: dataService,

packages/compass-collection/src/modules/data-service.ts

@@ -40,7 +40,7 @@ export default function reducer(
  *
  * @returns {Object} The server version changed action.
  */
-export const serverVersionChanged = (version: string): any => ({
+export const serverVersionChanged = (version: string) => ({
   type: SERVER_VERSION_CHANGED,
   version: version,
 });

packages/compass-collection/src/modules/server-version.ts

@@ -1,11 +1,14 @@
-import type { AnyAction } from 'redux';
+import type { AnyAction, Dispatch } from 'redux';
+import type { ThunkAction, ThunkDispatch } from 'redux-thunk';
 import type AppRegistry from 'hadron-app-registry';
 import type { Document } from 'mongodb';
 import { ObjectId } from 'bson';
 import toNS from 'mongodb-ns';
 
 import createContext from '../stores/context';
+import type { ContextProps } from '../stores/context';
 import { appRegistryEmit } from './app-registry';
+import type { RootState } from '../stores';
 
 /**
  * The prefix.
@@ -77,7 +80,7 @@ export interface WorkspaceTabObject {
   scopedModals: any[];
   sourceName: string;
   editViewName: string;
-  sourceReadonly?: any;
+  sourceReadonly?: boolean;
   sourceViewOn?: string;
   localAppRegistry: AppRegistry;
 }
@@ -87,6 +90,8 @@ export interface WorkspaceTabObject {
  */
 export const INITIAL_STATE = [];
 
+type State = WorkspaceTabObject[];
+
 const showCollectionSubmenu = ({ isReadOnly }: { isReadOnly: boolean }) => {
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const { ipcRenderer } = require('hadron-ipc');
@@ -113,8 +118,8 @@ const doClearTabs = () => {
  *
  * @returns {Object} The new state.
  */
-const doSelectNamespace = (state: any, action: AnyAction) => {
-  return state.reduce((newState: any, tab: WorkspaceTabObject) => {
+const doSelectNamespace = (state: State, action: AnyAction) => {
+  return state.reduce((newState: State, tab: WorkspaceTabObject) => {
     if (tab.isActive) {
       const subTabIndex = action.editViewName ? 1 : 0;
       newState.push({
@@ -154,7 +159,7 @@ const doSelectNamespace = (state: any, action: AnyAction) => {
  *
  * @returns {Object} The new state.
  */
-const doCreateTab = (state: any, action: AnyAction) => {
+const doCreateTab = (state: State, action: AnyAction) => {
   const newState = state.map((tab: WorkspaceTabObject) => {
     return { ...tab, isActive: false };
   });
@@ -200,16 +205,16 @@ const doCreateTab = (state: any, action: AnyAction) => {
  *
  * @returns {Object} The new state.
  */
-const doCloseTab = (state: any, action: AnyAction) => {
+const doCloseTab = (state: State, action: AnyAction) => {
   const closeIndex = action.index;
   const activeIndex = state.findIndex((tab: WorkspaceTabObject) => {
     return tab.isActive;
   });
   const numTabs = state.length;
 
-  return state.reduce((newState: any, tab: WorkspaceTabObject, i: number) => {
+  return state.reduce((newState: State, tab: WorkspaceTabObject, i: number) => {
     if (closeIndex !== i) {
-      // We follow stnadard browser behaviour with tabs on how we
+      // We follow standard browser behavior with tabs on how we
       // handle which tab gets activated if we close the active tab.
       // If the active tab is the last tab, we activate the one before
       // it, otherwise we activate the next tab.
@@ -226,7 +231,7 @@ const doCloseTab = (state: any, action: AnyAction) => {
   }, []);
 };
 
-const doCollectionDropped = (state: any, action: AnyAction) => {
+const doCollectionDropped = (state: State, action: AnyAction) => {
   const tabs = state.filter((tab: WorkspaceTabObject) => {
     return tab.namespace !== action.namespace;
   });
@@ -238,7 +243,7 @@ const doCollectionDropped = (state: any, action: AnyAction) => {
   return tabs;
 };
 
-const doDatabaseDropped = (state: any, action: AnyAction) => {
+const doDatabaseDropped = (state: State, action: AnyAction) => {
   const tabs = state.filter((tab: WorkspaceTabObject) => {
     const tabDbName = toNS(tab.namespace).database;
     return tabDbName !== action.name;
@@ -259,7 +264,7 @@ const doDatabaseDropped = (state: any, action: AnyAction) => {
  *
  * @returns {Object} The new state.
  */
-const doMoveTab = (state: any, action: AnyAction) => {
+const doMoveTab = (state: State, action: AnyAction) => {
   if (action.fromIndex === action.toIndex) return state;
   const newState = state.map((tab: WorkspaceTabObject) => ({ ...tab }));
   newState.splice(action.toIndex, 0, newState.splice(action.fromIndex, 1)[0]);
@@ -273,7 +278,7 @@ const doMoveTab = (state: any, action: AnyAction) => {
  *
  * @returns {Object} The new state.
  */
-const doNextTab = (state: any) => {
+const doNextTab = (state: State) => {
   const activeIndex = state.findIndex(
     (tab: WorkspaceTabObject) => tab.isActive
   );
@@ -292,7 +297,7 @@ const doNextTab = (state: any) => {
  *
  * @returns {Object} The new state.
  */
-const doPrevTab = (state: any) => {
+const doPrevTab = (state: State) => {
   const activeIndex = state.findIndex(
     (tab: WorkspaceTabObject) => tab.isActive
   );
@@ -312,7 +317,7 @@ const doPrevTab = (state: any) => {
  *
  * @returns {Object} The new state.
  */
-const doSelectTab = (state: any, action: AnyAction) => {
+const doSelectTab = (state: State, action: AnyAction) => {
   return state.map((tab: WorkspaceTabObject, i: number) => {
     return { ...tab, isActive: action.index === i ? true : false };
   });
@@ -326,7 +331,7 @@ const doSelectTab = (state: any, action: AnyAction) => {
  *
  * @returns {Array} The new state.
  */
-const doChangeActiveSubTab = (state: any, action: AnyAction) => {
+const doChangeActiveSubTab = (state: State, action: AnyAction) => {
   return state.map((tab: WorkspaceTabObject) => {
     const subTab =
       action.id === tab.id ? action.activeSubTab : tab.activeSubTab;
@@ -397,7 +402,23 @@ export const createTab = ({
   sourceViewOn,
   query,
   aggregation,
-}: any): any => ({
+}: Pick<
+  WorkspaceTabObject,
+  | 'id'
+  | 'namespace'
+  | 'isReadonly'
+  | 'isTimeSeries'
+  | 'isClustered'
+  | 'isFLE'
+  | 'sourceName'
+  | 'editViewName'
+  | 'sourceReadonly'
+  | 'sourceViewOn'
+> & {
+  context: ContextProps;
+  query?: any; // TODO(COMPASS-6162): type query.
+  aggregation?: any; // TODO(COMPASS-6162): type aggregation.
+}): AnyAction => ({
   type: CREATE_TAB,
   id,
   namespace,
@@ -443,7 +464,21 @@ export const selectNamespace = ({
   context,
   sourceReadonly,
   sourceViewOn,
-}: any): any => ({
+}: Pick<
+  WorkspaceTabObject,
+  | 'id'
+  | 'namespace'
+  | 'isReadonly'
+  | 'isTimeSeries'
+  | 'isClustered'
+  | 'isFLE'
+  | 'sourceName'
+  | 'editViewName'
+  | 'sourceReadonly'
+  | 'sourceViewOn'
+> & {
+  context: ContextProps;
+}): AnyAction => ({
   type: SELECT_NAMESPACE,
   id,
   namespace,
@@ -466,8 +501,7 @@ export const selectNamespace = ({
  * @returns {Object} The close tab action.
  */
 export const closeTab =
-  (index: number): any =>
-  (dispatch: any, getState: any) => {
+  (index: number) => (dispatch: Dispatch, getState: () => RootState) => {
     const { tabs } = getState();
     if (tabs.length === 1) {
       dispatch(appRegistryEmit('all-collection-tabs-closed'));
@@ -604,8 +638,24 @@ export const selectOrCreateTab = ({
   sourceReadonly,
   sourceViewOn,
   sourcePipeline,
-}: any): any => {
-  return (dispatch: any, getState: any) => {
+}: Pick<
+  WorkspaceTabObject,
+  | 'namespace'
+  | 'isReadonly'
+  | 'isTimeSeries'
+  | 'isClustered'
+  | 'isFLE'
+  | 'sourceName'
+  | 'editViewName'
+  | 'sourceReadonly'
+  | 'sourceViewOn'
+> & {
+  sourcePipeline: Document[];
+}): ThunkAction<void, RootState, void, AnyAction> => {
+  return (
+    dispatch: ThunkDispatch<RootState, void, AnyAction>,
+    getState: () => RootState
+  ) => {
     const state = getState();
     if (state.tabs.length === 0) {
       dispatch(
@@ -668,8 +718,23 @@ export const createNewTab = ({
   sourcePipeline,
   query,
   aggregation,
-}: any): any => {
-  return (dispatch: any, getState: any) => {
+}: Pick<
+  WorkspaceTabObject,
+  | 'namespace'
+  | 'isReadonly'
+  | 'isTimeSeries'
+  | 'isClustered'
+  | 'isFLE'
+  | 'sourceName'
+  | 'editViewName'
+  | 'sourceReadonly'
+  | 'sourceViewOn'
+> & {
+  sourcePipeline?: Document[];
+  query?: any; // TODO(COMPASS-6162): type query.
+  aggregation?: any; // TODO(COMPASS-6162): type aggregation.
+}): ThunkAction<void, RootState, void, AnyAction> => {
+  return (dispatch: Dispatch, getState: () => RootState) => {
     const state = getState();
     const context = createContext({
       state,
@@ -723,8 +788,21 @@ export const replaceTabContent = ({
   sourceReadonly,
   sourceViewOn,
   sourcePipeline,
-}: any): any => {
-  return (dispatch: any, getState: any) => {
+}: Pick<
+  WorkspaceTabObject,
+  | 'namespace'
+  | 'isReadonly'
+  | 'isTimeSeries'
+  | 'isClustered'
+  | 'isFLE'
+  | 'sourceName'
+  | 'editViewName'
+  | 'sourceReadonly'
+  | 'sourceViewOn'
+> & {
+  sourcePipeline?: Document[];
+}): ThunkAction<void, RootState, void, AnyAction> => {
+  return (dispatch: Dispatch, getState: () => RootState) => {
     const state = getState();
     const context = createContext({
       state,