@adaptabletools/adaptable 23.0.4 → 23.0.5-canary.1

package/src/Redux/Store/AdaptableStore.js

@@ -51,7 +51,6 @@ const NON_PERSIST_ACTIONS = {
     '@@redux/init': true,
     [LOAD_STATE]: true,
     [INIT_STATE]: true,
-    // progress indicators should NOT interfere with state management as it may lead to race conditions due to load/persist state being async
     [PROGRESS_INDICATOR_SHOW]: true,
     [PROGRESS_INDICATOR_HIDE]: true,
 };
@@ -83,7 +82,7 @@ export class AdaptableStore {
     currentStorageState;
     previousStorageState;
     loadStorageInProgress = false;
-    loadStateOnStartup = true; // set to false if you want no state
+    loadStateOnStartup = true;
     on = (eventName, callback) => {
         return this.emitter.on(eventName, callback);
     };
@@ -96,22 +95,12 @@ export class AdaptableStore {
     emit = (eventName, data) => {
         return this.emitter.emit(eventName, data);
     };
-    /**
-     *
-     * @param adaptable The Adaptable instance
-     * @param postLoadHook A function that hydrates the state after it has been loaded from storage
-     */
     constructor(adaptable) {
-        /*
-          This is the main store for Adaptable State
-        */
         let rootReducerObject = {
-            //  Reducers for Non-Persisted State
             Popup: PopupRedux.PopupReducer,
             Internal: InternalRedux.InternalReducer,
             Plugins: PluginsRedux.PluginsReducer,
             Comment: CommentsRedux.CommentsReducer,
-            // Reducers for Persisted State
             Alert: AlertRedux.AlertReducer,
             Application: ApplicationRedux.ApplicationReducer,
             CalculatedColumn: CalculatedColumnRedux.CalculatedColumnReducer,
@@ -135,7 +124,6 @@ export class AdaptableStore {
             ToolPanel: ToolPanelRedux.ToolPanelReducer,
             UserInterface: UserInterfaceRedux.UserInterfaceReducer,
         };
-        // allow plugins to participate in the root reducer
         adaptable.forPlugins((plugin) => {
             if (plugin.rootReducer) {
                 rootReducerObject = {
@@ -144,9 +132,7 @@ export class AdaptableStore {
                 };
             }
         });
-        const initialRootReducer = 
-        // @ts-ignore
-        Redux.combineReducers(rootReducerObject);
+        const initialRootReducer = Redux.combineReducers(rootReducerObject);
         const rootReducerWithResetManagement = (state, action) => {
             switch (action.type) {
                 case LOAD_STATE:
@@ -161,9 +147,6 @@ export class AdaptableStore {
         let storageEngine;
         this.emitter = new Emitter();
         this.beforeEmitter = new Emitter();
-        // If the user has remote storage set then we use Remote Engine, otherwise we use Local Enginge
-        // not sure we can do this as we need to be backwardly compatible with existing users so need to stick with adaptable id (which should be unique)
-        // const localStorageKey =  'adaptable-adaptable-state-' + adaptable.adaptableOptions.primaryKey;
         storageEngine = createEngineLocal({
             adaptableId: adaptable.adaptableOptions.adaptableId,
             adaptableStateKey: adaptable.adaptableOptions.adaptableStateKey,
@@ -181,7 +164,6 @@ export class AdaptableStore {
                 return state?.[key] !== newState?.[key];
             });
         };
-        // this is now VERY BADLY NAMED!
         let rootReducer = mergeReducer(rootReducerWithResetManagement, LOAD_STATE);
         const composeEnhancers = (x) => x;
         const persistedReducer = (state, action) => {
@@ -190,9 +172,6 @@ export class AdaptableStore {
             }
             const init = state === undefined;
             const newState = rootReducer(state, action);
-            // ideally the reducer should be pure,
-            // but having the emitter emit the event here
-            // is really useful
             const emitterArg = { action, state, newState };
             if (!NON_PERSIST_ACTIONS[action.type]) {
                 this.emitter.emit(action.type, emitterArg);
@@ -225,10 +204,6 @@ export class AdaptableStore {
                 });
                 const isProgressActive = middlewareAPI.getState().Popup?.ProgressIndicator?.active;
                 if (!wasProgressActive && isProgressActive) {
-                    // double rAF: first frame lets React render + ProgressIndicator's
-                    // useEffect schedule its own rAF for setVisible(); second frame
-                    // runs after the browser has actually painted the indicator
-                    // see #raf_progress_indicator
                     requestAnimationFrame(() => {
                         requestAnimationFrame(() => {
                             next(action);
@@ -247,13 +222,11 @@ export class AdaptableStore {
             }
         });
         const middlewares = [
-            beforeEmitterMiddleware, // fires before anything else processes the action
+            beforeEmitterMiddleware,
             devToolsActionMarkerMiddleware,
-            adaptableMiddleware(adaptable), // the main middleware that actually does stuff,
-            ...pluginsMiddleware, // the plugins middleware
+            adaptableMiddleware(adaptable),
+            ...pluginsMiddleware,
         ].filter(Boolean);
-        //TODO: need to check if we want the storage to be done before or after
-        //we enrich the state with the AB middleware
         this.TheStore = Redux.createStore(persistedReducer, composeEnhancers(Redux.applyMiddleware(...middlewares)));
         this.storageEngine = storageEngine;
     }
@@ -280,7 +253,6 @@ export class AdaptableStore {
         const { adaptable, adaptableStateKey, initialState, postLoadHook } = config;
         const postProcessState = postLoadHook ?? ((state) => state);
         this.storageEngine.setStateKey(adaptableStateKey);
-        // START STATE LOAD
         this.loadStorageInProgress = true;
         return (this.Load = this.storageEngine
             .load(adaptable, initialState)
@@ -291,14 +263,10 @@ export class AdaptableStore {
         })
             .then(() => {
             this.TheStore.dispatch(InitState());
-            // END STATE LOAD
             this.loadStorageInProgress = false;
         }, (e) => {
             adaptable.api.consoleError('Failed to load saved Adaptable state.', e);
-            //for now i'm still initializing Adaptable even if loading state has failed....
-            //we may revisit that later
             this.TheStore.dispatch(InitState());
-            // END STATE LOAD
             this.loadStorageInProgress = false;
             this.TheStore.dispatch(PopupRedux.PopupShowAlert({
                 alertType: 'generic',
@@ -412,22 +380,11 @@ function coerceMarkerDetailValue(value) {
         return '[unserializable]';
     }
 }
-// this is the main function for dealing with Redux Actions which require additional functionality to be triggered.
-// Please document each use case where we have to use the Store rather than a module or a popup screen
-// This should ideally be the ONLY place where we LISTEN to store changes
 const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
     return function (next) {
         return function (action) {
             switch (action.type) {
-                /*******************
-                 * NAMED QUERY ACTIONS
-                 *******************/
-                /**
-                 * Use Case: User has deleted a Named Query
-                 * Action: Check whether it is referenced elsewhere before deleting
-                 */
                 case NamedQueryRedux.NAMED_QUERY_DELETE: {
-                    // check if Named Query is not referenced elsewhere
                     const actionTyped = action;
                     if (!adaptable.api.namedQueryApi.internalApi.validateDeletedNamedQuery(actionTyped.namedQuery.Name)) {
                         return;
@@ -435,10 +392,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     const ret = next(action);
                     return ret;
                 }
-                /**
-                 * Use Case: User has renamed a Named Query
-                 * Action: Check whether it is referenced elsewhere before allowing rename
-                 */
                 case NamedQueryRedux.NAMED_QUERY_EDIT: {
                     const actionTyped = action;
                     const editedNamedQuery = actionTyped.namedQuery;
@@ -453,17 +406,11 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     const ret = next(action);
                     return ret;
                 }
-                /*******************
-                 * System Row Summary ACTIONS
-                 *******************/
                 case InternalRedux.SUMMARY_ROW_SET: {
                     let nextAction = next(action);
                     adaptable.api.layoutApi.internalApi.setupRowSummaries();
                     return nextAction;
                 }
-                /*******************
-                 * System Quick Filter ACTIONS
-                 *******************/
                 case InternalRedux.QUICK_FILTER_BAR_SHOW: {
                     let nextAction = next(action);
                     adaptable.showQuickFilter();
@@ -474,9 +421,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.hideQuickFilter();
                     return nextAction;
                 }
-                /*******************
-                 * ALERT DEFINITION ACTIONS
-                 *******************/
                 case AlertRedux.ALERT_DEFINITION_ADD:
                 case AlertRedux.ALERT_DEFINITION_EDIT:
                 case AlertRedux.ALERT_DEFINITION_DELETE:
@@ -491,7 +435,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             (returnAction.type === AlertRedux.ALERT_DEFINITION_ADD ||
                                 returnAction.type === AlertRedux.ALERT_DEFINITION_EDIT ||
                                 returnAction.type === AlertRedux.ALERT_DEFINITION_UNSUSPEND)) {
-                            // in case of edit, the existing reactive alert will be deleted and recreated
                             adaptable.api.internalApi.getAlertService().createReactiveAlert(alertDefinition);
                         }
                         if (!isScheduledAlertDefinition(alertDefinition) &&
@@ -521,9 +464,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             }
                         });
                     }
-                    // called also for rendered column actions, see RENDERED COLUMN ACTIONS block
                     adaptable.updateColumnModelAndRefreshGrid();
-                    // tell Alert Module to check if need to listen to Cell Change
                     let module = (adaptable.adaptableModules.get(ModuleConstants.AlertModuleId));
                     if (module) {
                         module.checkListenToCellDataChanged();
@@ -531,9 +472,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     refreshScheduledAlertJobs(adaptable);
                     return returnAction;
                 }
-                /*******************
-                 * Flashing Cell ACTIONS
-                 *******************/
                 case FlashingCellRedux.FLASHING_CELL_DEFINITION_ADD:
                 case FlashingCellRedux.FLASHING_CELL_DEFINITION_EDIT:
                 case FlashingCellRedux.FLASHING_CELL_DEFINITION_DELETE:
@@ -542,27 +480,16 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 case FlashingCellRedux.FLASHING_CELL_DEFINITION_UNSUSPEND_ALL:
                 case FlashingCellRedux.FLASHING_CELL_DEFINITION_SUSPEND_ALL: {
                     const returnAction = next(action);
-                    // called also for rendered column actions, see RENDERED COLUMN ACTIONS block
                     adaptable.updateColumnModelAndRefreshGrid();
-                    // check if cell data change listening needs to be activated
                     let module = (adaptable.adaptableModules.get(ModuleConstants.FlashingCellModuleId));
                     if (module) {
                         module.checkListenToCellDataChanged();
                     }
                     return returnAction;
                 }
-                /*******************
-                 * FREE TEXT COLUMN ACTIONS
-                 *******************/
-                /**
-                 * Use Case: We have added / edited / deleted a Free Text Column
-                 * Actions: We check if a deleted Column has references and return if so
-                 * Actions: We update the Special ColumnDefs and refresh the Layout
-                 */
                 case FreeTextColumnRedux.FREE_TEXT_COLUMN_ADD:
                 case FreeTextColumnRedux.FREE_TEXT_COLUMN_EDIT:
                 case FreeTextColumnRedux.FREE_TEXT_COLUMN_DELETE: {
-                    // First check to see Deleted Free Text Column is referenced elsewhwere and return if so
                     if (action.type === FreeTextColumnRedux.FREE_TEXT_COLUMN_DELETE) {
                         const actionTyped = action;
                         if (!adaptable.api.freeTextColumnApi.internalApi.validateDeletedFreeTextColumn(actionTyped.freeTextColumn)) {
@@ -570,7 +497,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         }
                     }
                     const returnAction = next(action);
-                    // Check listen to Cell Data Changes and refresh the layout
                     let module = (adaptable.adaptableModules.get(ModuleConstants.FreeTextColumnModuleId));
                     if (module) {
                         module.checkListenToCellDataChanged();
@@ -578,26 +504,17 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.layoutApi.internalApi.refreshLayout();
                     return returnAction;
                 }
-                /*******************
-                 * CALCULATED COLUMN ACTIONS
-                 *******************/
-                /**
-                 * Use Case: We have added / edited / deleted a Calculated Column
-                 * Action: We update the Special ColumnDefs and refresh the Layout
-                 */
                 case CalculatedColumnRedux.CALCULATED_COLUMN_ADD:
                 case CalculatedColumnRedux.CALCULATED_COLUMN_EDIT:
                 case CalculatedColumnRedux.CALCULATED_COLUMN_DELETE: {
                     const actionTypedCC = action;
                     const calculatedColumn = actionTypedCC.calculatedColumn;
-                    // First check for Deleted Calculated Columns with references and return if found
                     if (action.type === CalculatedColumnRedux.CALCULATED_COLUMN_DELETE) {
                         if (!adaptable.api.calculatedColumnApi.internalApi.validateDeletedCalculatedColumn(calculatedColumn)) {
                             return;
                         }
                     }
                     const returnAction = next(action);
-                    // Manage Aggregations, fire Event, set up listener and refresh Layout
                     if (action.type === CalculatedColumnRedux.CALCULATED_COLUMN_ADD ||
                         action.type === CalculatedColumnRedux.CALCULATED_COLUMN_EDIT) {
                         adaptable.api.internalApi
@@ -617,13 +534,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.layoutApi.internalApi.refreshLayout();
                     return returnAction;
                 }
-                /*******************
-                 * RENDERED COLUMN ACTIONS
-                 *******************/
-                /**
-                 * Use Case: We have updated an AdapTable Module that affects rendering
-                 * Action: We set up all columns again
-                 */
                 case QuickSearchRedux.QUICK_SEARCH_SET_CELL_MATCHING_STYLE:
                 case QuickSearchRedux.QUICK_SEARCH_SET_TEXT_MATCHING_STYLE:
                 case QuickSearchRedux.QUICK_SEARCH_SET_CURRENT_TEXT_MATCHING_STYLE: {
@@ -661,25 +571,15 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 case CustomSortRedux.CUSTOM_SORT_SUSPEND_ALL:
                 case CustomSortRedux.CUSTOM_SORT_UNSUSPEND_ALL: {
                     const returnAction = next(action);
-                    // called also for alert actions, see ALERT ACTIONS block
                     adaptable.updateColumnModelAndRefreshGrid();
                     return returnAction;
                 }
-                /*******************
-                 * QUICK SEARCH ACTIONS
-                 *******************/
-                /**
-                 * Use Case: User has run a Quick Search
-                 * Action1: Call Adaptable to redraw body so cells can be highlighted
-                 * Action2: Run Query using Quick Search text
-                 */
                 case QuickSearchRedux.QUICK_SEARCH_RUN: {
                     let returnAction = next(action);
                     const actionTyped = action;
                     const searchText = actionTyped.quickSearchText;
                     adaptable.setAgGridFindSearchValue(searchText);
                     adaptable.api.gridApi.refreshAllCells(true);
-                    // if set then return a query on the text
                     if (adaptable.adaptableOptions.quickSearchOptions.filterGridAfterQuickSearch) {
                         if (StringExtensions.IsNotNullOrEmpty(searchText)) {
                             adaptable.setAgGridQuickSearch(searchText);
@@ -690,13 +590,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                /*******************
-                 * INTERNAL ACTIONS
-                 *******************/
-                /**
-                 * Use Case: User has deleted a System Alert which has a Highlight Cell or Highlight Row
-                 * Action: Refresh the cell / Row (to clear the Highlight)
-                 */
                 case InternalRedux.ALERT_DELETE: {
                     const actionTyped = action;
                     let ret = next(action);
@@ -714,10 +607,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return ret;
                 }
-                /**
-                 * Use Case: User has deleted all System Alerts some of which have a Highlight Cell
-                 * Action: Refresh the cell (to clear the style)
-                 */
                 case InternalRedux.ALERT_DELETE_ALL: {
                     const actionTyped = action;
                     let ret = next(action);
@@ -737,10 +626,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     });
                     return ret;
                 }
-                /**
-                 * Use Case: A System Alert had a Highlight Cell with a limited duration
-                 * Action: Refresh the cell (to clear the style)
-                 */
                 case InternalRedux.ALERT_REMOVE_CELL_HIGHLIGHT: {
                     let ret = next(action);
                     const actionTyped = action;
@@ -894,14 +779,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.internalApi.setCellSummaryInfo(apiSummaryReturn);
                     return returnAction;
                 }
-                /*******************
-                 * DATA SOURCE ACTIONS
-                 *******************/
-                /**
-                 * Use Case: Data Sources have been amended
-                 * Action1: Fire Data Source Changed event
-                 * Action2: Display a DataSet form if supplied
-                 */
                 case InternalRedux.DATA_SET_SELECT: {
                     let returnAction = next(action);
                     const dataSet = adaptable.api.dataSetApi.getCurrentDataSet();
@@ -913,25 +790,11 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                /*******************
-                 * THEME ACTIONS
-                 *******************/
-                /**
-                 * Use Case: Theme has changed
-                 * Action: Apply new Theme
-                 */
                 case ThemeRedux.THEME_SELECT: {
                     let returnAction = next(action);
                     adaptable.api.themeApi.applyCurrentTheme();
                     return returnAction;
                 }
-                /*******************
-                 * Note ACTIONS
-                 *******************/
-                /**
-                 * Use Case: Note has been edited/deleted/added
-                 * Action: Triangle can be removed/added
-                 */
                 case NoteRedux.NOTE_ADD:
                 case NoteRedux.NOTE_EDIT:
                 case NoteRedux.NOTE_DELETE: {
@@ -941,13 +804,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.gridApi.refreshCell(rowNode, returnAction.adaptableNote.ColumnId, true);
                     return returnAction;
                 }
-                /*******************
-                 * Comment ACTIONS
-                 *******************/
-                /**
-                 * Use Case: Comments has been edited/deleted/added
-                 * Action: Triangle can be removed/added
-                 */
                 case CommentsRedux.COMMENT_ADD:
                 case CommentsRedux.COMMENT_EDIT:
                 case CommentsRedux.COMMENT_DELETE:
@@ -996,9 +852,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                                 deletedCommentThreads.push(commentThread);
                             }
                         }
-                        // This cannot be called because it would trigger an infinite loop
-                        // adaptable.api.eventApi.emit('CommentChanged', commentThreads);
-                        // refresh all comments cells to show or hide the triangle
                         [...addedCommentThreads, ...deletedCommentThreads].forEach((commentThread) => {
                             const node = adaptable.api.gridApi.getRowNodeForPrimaryKey(commentThread.PrimaryKeyValue);
                             if (node && commentThread.ColumnId) {
@@ -1008,9 +861,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     });
                     return returnAction;
                 }
-                /*******************
-                 * SCHEDULED JOB ACTIONS (export report schedules)
-                 *******************/
                 case ExportRedux.EXPORT_ENSURE_SCHEDULE_UUIDS:
                 case ExportRedux.SCHEDULED_REPORT_ADD:
                 case ExportRedux.SCHEDULED_REPORT_EDIT:
@@ -1021,34 +871,24 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     refreshScheduledReportJobs(adaptable);
                     return returnAction;
                 }
-                /*******************
-                 * USER INTERFACE ACTIONS
-                 *******************/
                 case UserInterfaceRedux.USER_INTERFACE_SET_HIDE_ADAPTABLE_UI: {
                     const returnAction = next(action);
                     const { hideAdaptableUI } = action;
-                    // Hide or show Dashboard
                     middlewareAPI.dispatch(DashboardRedux.DashboardSetIsHidden(hideAdaptableUI));
-                    // Hide or show Adaptable ToolPanel in the AG Grid sidebar
                     if (hideAdaptableUI) {
                         adaptable.hideAdaptableToolPanel();
                     }
                     else {
                         adaptable.showAdaptableToolPanel();
                     }
-                    // Hide or show Adaptable StatusBar panels
                     if (hideAdaptableUI) {
                         adaptable.hideAdaptableStatusBar();
                     }
                     else {
                         adaptable.showAdaptableStatusBar();
                     }
-                    // Column and Context Menus are handled in the AgGridMenuAdapter
                     return returnAction;
                 }
-                /*******************
-                 * DASHBOARD ACTIONS
-                 *******************/
                 case DashboardRedux.DASHBOARD_SET_IS_COLLAPSED:
                 case DashboardRedux.DASHBOARD_SET_MODULE_BUTTONS:
                 case DashboardRedux.DASHBOARD_ACTIVE_TAB_INDEX_CHANGE:
@@ -1063,16 +903,12 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.eventApi.internalApi.fireDashboardChangedEvent(action.type, oldDashboardState, newDashboardState);
                     return returnAction;
                 }
-                /*******************
-                 * LAYOUT ACTIONS
-                 *******************/
                 case LayoutRedux.LAYOUT_ADD:
                 case LayoutRedux.LAYOUT_EDIT:
                 case LayoutRedux.LAYOUT_SAVE:
                 case LayoutRedux.LAYOUT_DELETE:
                 case LayoutRedux.LAYOUT_SELECT: {
                     const oldLayoutState = middlewareAPI.getState().Layout;
-                    // this must be called before 'next(action)'
                     const previousLayout = adaptable.api.layoutApi.getCurrentLayout();
                     let returnAction = next(action);
                     const newLayoutState = middlewareAPI.getState().Layout;
@@ -1083,12 +919,10 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         ERROR_LAYOUT;
                     if (returnAction.type == LayoutRedux.LAYOUT_SELECT ||
                         returnAction.type == LayoutRedux.LAYOUT_DELETE) {
-                        // tell AdapTable the Layout has been selected
                         if (newLayout) {
                             adaptable.updateLayoutInManagerAfterStoreHasChanged(newLayout);
                         }
                     }
-                    // !!! filter refresh has to be AFTER the layout has been set in the store
                     let refreshColumnFilters = false;
                     if (adaptable.api.filterApi.columnFilterApi.internalApi.areColumnFiltersDifferent(oldLayout.ColumnFilters, newLayout.ColumnFilters)) {
                         refreshColumnFilters = true;
@@ -1100,24 +934,16 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     if (refreshColumnFilters || refreshGridFilter) {
                         adaptable.applyFiltering({ updateColumnFilterModel: refreshColumnFilters });
                     }
-                    // when changing current layout via the api, the layout should update
                     if (returnAction.type == LayoutRedux.LAYOUT_SAVE) {
                         const savingLayout = returnAction.layout;
                         if (previousLayout.Name === savingLayout.Name &&
                             previousLayout !== savingLayout &&
-                            // objects may have changed, but have the same contents
-                            // this prevents pivot layout from infinite set-layout
                             !adaptable.api.layoutApi.internalApi.areLayoutsEqual(previousLayout, savingLayout)) {
                             adaptable.updateLayoutInManagerAfterStoreHasChanged(savingLayout);
                         }
                     }
                     return returnAction;
                 }
-                /**
-                 * Use Case: Column Filters have changed
-                 * Action: Apply Column Filtering and fire associated events
-                 * Note: For LAYOUT_COLUMN_FILTER_EDIT we do not filter (as it seems to be already handled)
-                 */
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_ADD:
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_EDIT:
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_SET:
@@ -1128,13 +954,9 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_UNSUSPEND:
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_UNSUSPEND_ALL: {
                     let returnAction;
-                    // needs to be called before 'next' so previous and next column filters are known
                     const shouldTriggerColumnFiltering = adaptable.api.filterApi.columnFilterApi.internalApi.shouldNewColumnFilterTriggerColumnFiltering(action);
                     const oldLayoutState = middlewareAPI.getState().Layout;
                     returnAction = next(action);
-                    // we need to update the current layout model
-                    // in the layout manager, so that onLayoutChange
-                    // it will come back with the correct fields
                     adaptable.silentUpdateCurrentLayoutModel();
                     if (shouldTriggerColumnFiltering) {
                         setTimeout(() => {
@@ -1145,10 +967,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.eventApi.internalApi.fireLayoutChangedEvent(action.type, oldLayoutState, middlewareAPI.getState().Layout);
                     return returnAction;
                 }
-                /**
-                 * Use Case: Grid Filter has changed
-                 * Action: Apply Grid Filtering and fire associated events
-                 */
                 case LayoutRedux.LAYOUT_GRID_FILTER_SET:
                 case LayoutRedux.LAYOUT_GRID_FILTER_CLEAR:
                 case LayoutRedux.LAYOUT_GRID_FILTER_SUSPEND:
@@ -1161,35 +979,16 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }, 5);
                     return next(returnAction);
                 }
-                /*******************
-                 * SMART EDIT ACTIONS
-                 *******************/
-                /**
-                 * Use Case: User wants to perform Smart Edit and we need to check if the cell selection is valid
-                 * Action (1):  Get the result from the SmartEdit module
-                 * If the return is an Alert:
-                 * Action (2): If there is a popup open, close it and show the Alert; otherwise just set false valid selection
-                 * If the return is valid:
-                 * Action (2): Set the valid selection to true
-                 * Action (3): Build the Preview Values (via Smart Edit module)
-                 * Action (4): Set the Preview Values (this will populate the preview screen)
-                 */
                 case InternalRedux.SMARTEDIT_CHECK_CELL_SELECTION: {
                     let module = (adaptable.adaptableModules.get(ModuleConstants.SmartEditModuleId));
                     let state = middlewareAPI.getState();
                     let returnAction = next(action);
                     let apiReturn = module.CheckCorrectCellSelection();
                     let popup = state.Popup.ScreenPopup;
-                    // this is a horrible hack and fix for a weird issue
-                    // we really need to do smart edit and bulk update better
-                    // but this fixes it for now
                     if (popup.ComponentName != 'LayoutPopup') {
                         if (apiReturn.Alert) {
-                            // check if Smart Edit is showing as popup and then close and show error (dont want to do that if from toolbar)
                             if (popup.ComponentName == 'SmartEditPopup') {
-                                // We are in SmartEditPopup so let's close it
                                 adaptable.api.internalApi.hidePopupScreen();
-                                // and now show the alert Popup
                                 adaptable.api.alertApi.displayAdaptableAlertNotification(apiReturn.Alert);
                             }
                             middlewareAPI.dispatch(InternalRedux.SmartEditSetValidSelection(false));
@@ -1202,16 +1001,9 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                /**
-                 * Use Case: User has changed a Smmart Edit property or requested a preview
-                 * Action (1):  Get the new preview set from the Smart Edit module
-                 * Action (2):  Set the Preview Values (this will populate the preview screen)
-                 */
                 case InternalRedux.SMART_EDIT_CHANGE_OPERATION:
                 case InternalRedux.SMART_EDIT_CHANGE_VALUE:
                 case InternalRedux.SMARTEDIT_FETCH_PREVIEW: {
-                    //all our logic needs to be executed AFTER the main reducers
-                    //so our state is up to date which allow us not to care about the data within each different action
                     let returnAction = next(action);
                     let module = (adaptable.adaptableModules.get(ModuleConstants.SmartEditModuleId));
                     let state = middlewareAPI.getState();
@@ -1219,11 +1011,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     middlewareAPI.dispatch(InternalRedux.SmartEditSetPreview(apiReturn));
                     return returnAction;
                 }
-                /**
-                 * Use Case: User has clicked 'Apply' in Smart Edit popup or toolbar
-                 * Action (1): Gets the values that need to be applied from the Preview Info and passes to Preview Helper (incl. whether to bypass validation)
-                 * Action (2): Sets the cell values in the Grid
-                 */
                 case SmartEditRedux.SMART_EDIT_APPLY: {
                     const actionTyped = action;
                     let thePreview = middlewareAPI.getState().Internal.SmartEdit.SmartEditPreviewInfo;
@@ -1232,25 +1019,16 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.internalApi.hidePopupScreen();
                     return next(action);
                 }
-                /*******************
-                 * BULK UPDATE ACTIONS
-                 *******************/
                 case InternalRedux.BULK_UPDATE_CHECK_CELL_SELECTION: {
                     let module = (adaptable.adaptableModules.get(ModuleConstants.BulkUpdateModuleId));
                     let state = middlewareAPI.getState();
                     let returnAction = next(action);
                     let apiReturn = module.checkCorrectCellSelection();
                     let popup = state.Popup.ScreenPopup;
-                    // this is a horrible hack and fix for a weird issue
-                    // we really need to do smart edit and bulk update better
-                    // but this fixes it for now
                     if (popup.ComponentName != 'LayoutPopup') {
                         if (apiReturn.Alert) {
-                            // check if BulkUpdate is showing as popup
                             if (popup.ComponentName == 'BulkUpdatePopup') {
-                                //We close the BulkUpdatePopup
                                 adaptable.api.internalApi.hidePopupScreen();
-                                //We show the Error Popup -- assume that will alwasy be an Error
                                 adaptable.api.alertApi.displayAdaptableAlertNotification(apiReturn.Alert);
                             }
                         }
@@ -1258,10 +1036,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                // Here we have all actions that triggers a refresh of the BulkUpdatePreview
                 case InternalRedux.BULK_UPDATE_CHANGE_VALUE: {
-                    //all our logic needs to be executed AFTER the main reducers
-                    //so our state is up to date which allow us not to care about the data within each different action
                     let returnAction = next(action);
                     let module = (adaptable.adaptableModules.get(ModuleConstants.BulkUpdateModuleId));
                     let state = middlewareAPI.getState();
@@ -1277,13 +1052,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.internalApi.hidePopupScreen();
                     return next(action);
                 }
-                /*******************
-                 * PLUS MINUS ACTIONS
-                 *******************/
-                /**
-                 * Use Case: Plus Minus Rules have changed
-                 * Action: Get Plus Minus module to know if it needs to listen to keydown
-                 */
                 case PlusMinusRedux.PLUS_MINUS_RULE_ADD:
                 case PlusMinusRedux.PLUS_MINUS_RULE_EDIT:
                 case PlusMinusRedux.PLUS_MINUS_RULE_DELETE:
@@ -1298,23 +1066,12 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                /**
-                 * Use Case: Plus Minus has been applied
-                 * Action: update the grid cells
-                 */
                 case PlusMinusRedux.PLUS_MINUS_APPLY: {
                     let returnAction = next(action);
                     const actionTyped = action;
                     adaptable.api.gridApi.setCellValues(actionTyped.cellUpdateRequests);
                     return returnAction;
                 }
-                /*******************
-                 * SHORTCUT ACTIONS
-                 *******************/
-                /**
-                 * Use Case: Shortcuts have changed
-                 * Action: Get Shortcut module to know if it needs to listen to keydown
-                 */
                 case ShortcutRedux.SHORTCUT_ADD:
                 case ShortcutRedux.SHORTCUT_EDIT:
                 case ShortcutRedux.SHORTCUT_DELETE: {
@@ -1325,10 +1082,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                /*******************
-                 * EXPORT ACTIONS
-                 *******************/
-                // When selected report is undefined, clear the format
                 case ExportRedux.REPORT_SELECT: {
                     const actionTyped = action;
                     let returnAction = next(action);
@@ -1338,7 +1091,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                // When deleting a report, if it is currently selected clear it
                 case ExportRedux.REPORT_DELETE: {
                     const actionTyped = action;
                     let report = actionTyped.report;
@@ -1350,9 +1102,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     refreshScheduledReportJobs(adaptable);
                     return returnAction;
                 }
-                /*******************
-                 * CHARTING ACTIONS
-                 *******************/
                 case ChartingRedux.CHARTING_DELETE_CHART: {
                     const deleteAction = action;
                     closeAgChartDefinitionIfOpen(adaptable.api, deleteAction.chartDefinition);
@@ -1364,9 +1113,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.chartingApi.internalApi.onDeleteExternalChart(returnAction.chartDefinition);
                     return returnAction;
                 }
-                /*******************
-                 * TEAM SHARING ACTIONS
-                 *******************/
                 case TeamSharingRedux.TEAMSHARING_GET: {
                     let returnAction = next(action);
                     adaptable.api.teamSharingApi
@@ -1391,7 +1137,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     let returnAction = next(action);
                     const { Entity, Configuration } = actionTyped;
                     let shareSuccessful;
-                    // load latest state from TeamSharing server
                     adaptable.api.teamSharingApi
                         .loadSharedEntities()
                         .then((sharedEntities) => {
@@ -1400,7 +1145,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             .buildCustomSharedEntity(Entity, Configuration);
                         let newCustomShare = true;
                         const updatedSharedEntities = sharedEntities.map((entity) => {
-                            // if it has the same UUID, override it
                             if (isCustomSharedEntity(entity) && entity.Uuid === customSharedEntity.Uuid) {
                                 newCustomShare = false;
                                 return {
@@ -1415,7 +1159,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             updatedSharedEntities.push(customSharedEntity);
                         }
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(updatedSharedEntities));
-                        // update the server state
                         shareSuccessful = true;
                         return adaptable.api.teamSharingApi.persistSharedEntities(updatedSharedEntities);
                     })
@@ -1429,20 +1172,14 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     });
                     return returnAction;
                 }
-                // share the given AdaptableObject:
-                // - if it has dependencies, share them as well
-                // - if it's active, ensure that there is not already one present
-                // - if it's active, all the dependencies will be active as well
                 case TeamSharingRedux.TEAMSHARING_SHARE: {
                     const actionTyped = action;
                     let returnAction = next(action);
                     const { Entity, Configuration, Module } = actionTyped;
                     let shareSuccessful;
-                    // load latest state from TeamSharing server
                     adaptable.api.teamSharingApi
                         .loadSharedEntities()
                         .then((sharedEntities) => {
-                        // check if there is not already one active SharedEntity for this object
                         const existingActiveSharedEntity = Configuration.type === 'Active' &&
                             middlewareAPI.getState().TeamSharing.ActiveSharedEntityMap[Entity.Uuid];
                         if (existingActiveSharedEntity) {
@@ -1456,15 +1193,12 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             shareSuccessful = false;
                             return;
                         }
-                        // build the new shared entities incl. all their dependencies
                         const newSharedEntityInclDependencies = adaptable.api.internalApi
                             .getTeamSharingService()
                             .buildSharedEntityWithDependencies(Entity, Module, Configuration);
                         sharedEntities.push(...newSharedEntityInclDependencies);
-                        // update the local state
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingLinkItem(...newSharedEntityInclDependencies.filter((sharedEntity) => sharedEntity.Type === 'Active')));
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(sharedEntities));
-                        // update the server state
                         shareSuccessful = true;
                         return adaptable.api.teamSharingApi.persistSharedEntities(sharedEntities);
                     })
@@ -1491,17 +1225,13 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     });
                     return returnAction;
                 }
-                // remove the given shared entity:
-                // - ensure that no other shared entities depend on it
                 case TeamSharingRedux.TEAMSHARING_REMOVE_ITEM: {
                     let returnAction = next(action);
                     const actionTyped = action;
                     const removedEntityId = actionTyped.Uuid;
-                    // load latest state from TeamSharing server
                     adaptable.api.teamSharingApi
                         .loadSharedEntities()
                         .then((sharedEntities) => {
-                        // ensure that no other SharedDependencies reference the to-be-deleted entity
                         const adaptableSharedEntities = sharedEntities.filter(isAdaptableSharedEntity);
                         const sharedEntityDependants = adaptable.api.internalApi
                             .getTeamSharingService()
@@ -1519,10 +1249,8 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             adaptable.api.alertApi.displayAdaptableAlertNotification(alert);
                             return;
                         }
-                        // remove the deleted SharedEntity from local state
                         const newSharedEntities = sharedEntities.filter((s) => s.Uuid !== removedEntityId);
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(newSharedEntities));
-                        // update TeamSharing server
                         return adaptable.api.teamSharingApi.persistSharedEntities(newSharedEntities);
                     })
                         .catch((error) => {
@@ -1537,10 +1265,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     });
                     return returnAction;
                 }
-                // Import 1. step
-                // prepare import of the given shared entity (the actual import is done in 'TEAMSHARING_PROCESS_IMPORT'):
-                // - all dependencies will be also included in the import bundle
-                // - if there is at least one local AdaptableObject which will be overwritten, display a confirmation pop
                 case TeamSharingRedux.TEAMSHARING_IMPORT_ITEM: {
                     let returnAction = next(action);
                     const actionTyped = action;
@@ -1567,15 +1291,11 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return returnAction;
                 }
-                // Import 2. step
-                // import the actual AdaptableObjects (either create or update them)
                 case TeamSharingRedux.TEAMSHARING_PROCESS_IMPORT: {
                     let returnAction = next(action);
                     const actionTyped = action;
                     const { ImportSteps } = actionTyped;
                     const activeSharedEntities = [];
-                    // iterate backwards to import the dependencies first
-                    // it should work also the other way around, but nevertheless...
                     for (let i = ImportSteps.length - 1; i >= 0; i--) {
                         const { sharedEntity, importAction } = ImportSteps[i];
                         if (importAction) {
@@ -1591,7 +1311,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     if (activeSharedEntities.length) {
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingLinkItem(...activeSharedEntities));
                     }
-                    // mark the import process as ended after (we assume that) the import is finished
                     adaptable.api.teamSharingApi.internalApi
                         .waitForTeamSharingImportEnd()
                         .then(() => middlewareAPI.dispatch(TeamSharingRedux.TeamSharingCommitImport()))
@@ -1605,13 +1324,10 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.alertApi.displayAdaptableAlertNotification(alert);
                     return returnAction;
                 }
-                // update the active SharedEntity with the latest (updated) state of the local AdaptableObject
-                // - if the remote server already has a newer version of it, the update is skipped
                 case TeamSharingRedux.TEAMSHARING_UPDATE_ITEM: {
                     const returnAction = next(action);
                     const actionTyped = action;
                     if (middlewareAPI.getState().TeamSharing.importProcessInProgress) {
-                        // we are in the middle of an import process, we don't have to react to these object changes
                         return returnAction;
                     }
                     const { ChangedAdaptableObject, UserName } = actionTyped;
@@ -1619,12 +1335,10 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         .loadSharedEntities()
                         .then((sharedEntities) => {
                         const adaptableSharedEntities = sharedEntities.filter(isAdaptableSharedEntity);
-                        // check if remote server has a newer revision
                         const [localRevision, remoteRevision] = adaptable.api.internalApi
                             .getTeamSharingService()
                             .getSharedEntityLocalAndRemoteRevisions(ChangedAdaptableObject.Uuid, adaptableSharedEntities);
                         if (remoteRevision > localRevision) {
-                            // if remote has a newer version, we will NOT overwrite it
                             return;
                         }
                         const [updatedSharedEntities, newActiveEntities] = adaptable.api.internalApi
@@ -1651,7 +1365,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     adaptable.api.teamSharingApi
                         .loadSharedEntities()
                         .then((sharedEntities) => {
-                        // update local state
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(sharedEntities));
                         adaptable.api.internalApi.getTeamSharingService().showUpdateNotifications();
                     })
@@ -1667,9 +1380,6 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     });
                     return returnAction;
                 }
-                /*******************
-                 * POPUP (INTERNAL) ACTIONS
-                 *******************/
                 case PopupRedux.POPUP_SHOW_ALERT: {
                     showToast({
                         api: adaptable.api,
@@ -1700,15 +1410,9 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     }
                     return next(action);
                 }
-                /*******************
-                 * MANAGING STATE ACTIONS
-                 *******************/
                 case INIT_STATE: {
                     let returnAction = next(action);
                     if (adaptable.isReady) {
-                        // we need this here for when the state key is changed
-                        // since we need the transient state to be restored in the same
-                        // way as when Adaptable is initialised.
                         adaptable.ModuleService.createModuleUIItems();
                     }
                     return returnAction;