improves: Add state restart for modules that manage and store data. (#397)

plop-templates/ADempiere/store/index.hbs

@@ -5,7 +5,13 @@ const {{name}} = {
   },
   {{/if}}
   {{#if mutations}}
-  mutations: {},
+  mutations: {
+    {{#if state}}
+    resetState{{name}}(state) {
+      state = {}
+    }
+    {{/if}}
+  },
   {{/if}}
   {{#if actions}}
   actions: {},

src/store/modules/ADempiere/containerInfo.js

@@ -1,8 +1,14 @@
-import { requestListRecordsLogs, requestListWorkflowsLogs, requestListWorkflows, requestListRecordChats, requestListChatEntries, requestCreateChatEntry } from '@/api/ADempiere/data'
+import {
+  requestListRecordsLogs,
+  requestListWorkflowsLogs,
+  requestListWorkflows,
+  requestListRecordChats,
+  requestListChatEntries,
+  requestCreateChatEntry
+} from '@/api/ADempiere/data'
 import { isEmptyValue } from '@/utils/ADempiere/valueUtils'
 
-const containerInfo = {
+const initStateContainerInfo = {
-  state: {
   listworkflowLog: [],
   listRecordLogs: [],
   listRecordChats: [],
@@ -11,7 +17,10 @@ const containerInfo = {
   chat: [],
   note: [],
   isNote: false
-  },
+}
+
+const containerInfo = {
+  state: initStateContainerInfo,
   mutations: {
     addListWorkflow(state, payload) {
       state.listworkflowLog = payload
@@ -36,6 +45,9 @@ const containerInfo = {
     },
     isNote(state, payload) {
       state.isNote = payload
+    },
+    resetStateContainerInfo(state) {
+      state = initStateContainerInfo
     }
   },
   actions: {
@@ -66,17 +78,17 @@ const containerInfo = {
       const pageToken = 0
       return requestListRecordChats({ tableName, recordId, pageSize, pageToken })
         .then(response => {
-          var chatList = response.recordChatsList
+          const chatList = response.recordChatsList
-          var listRecord = {
+          const listRecord = {
             recordChatsList: response.recordChatsList,
             recordCount: response.recordCount,
             nextPageToken: response.nextPageToken
           }
           chatList.forEach(chat => {
-            var uuid = chat.chatUuid
+            const uuid = chat.chatUuid
             requestListChatEntries({ uuid, pageSize, pageToken })
               .then(response => {
-                var listlogsChat = state.chat
+                const listlogsChat = state.chat
                 let chatUpgrade = []
                 let chatAll
                 if (recordId === chat.recordId) {
@@ -102,24 +114,25 @@ const containerInfo = {
           console.warn(`Error getting List Chat: ${error.message}. Code: ${error.code}.`)
         })
     },
-    listRecordLogs({ commit, state }, params) {
+    listRecordLogs({ commit }, params) {
       const tableName = params.tableName
       const recordId = params.recordId
       const pageSize = 0
       const pageToken = 0
       return requestListRecordsLogs({ tableName, recordId, pageSize, pageToken })
         .then(response => {
-          var listRecord = {
+          const listRecord = {
             recordCount: response.recordCount,
             recorLogs: response.recordLogsList
           }
           commit('addListRecordLogs', listRecord)
+          return listRecord
         })
         .catch(error => {
           console.warn(`Error getting List Record Logs: ${error.message}. Code: ${error.code}.`)
         })
     },
-    listWorkflowLogs({ commit, state, dispatch }, params) {
+    listWorkflowLogs({ commit, dispatch }, params) {
       const tableName = params.tableName
       const recordId = params.recordId
       const pageSize = 0
@@ -127,28 +140,30 @@ const containerInfo = {
       dispatch('listWorkflows', tableName)
       return requestListWorkflowsLogs({ tableName, recordId, pageSize, pageToken })
         .then(response => {
-          var workflowLog = {
+          const workflowLog = {
             recordCount: response.recordCount,
             workflowLogsList: response.workflowLogsList,
             nextPageToken: response.nextPageToken
           }
           commit('addListWorkflow', workflowLog)
+          return workflowLog
         })
         .catch(error => {
           console.warn(`Error getting List workflow: ${error.message}. Code: ${error.code}.`)
         })
     },
-    listWorkflows({ commit, state }, tableName) {
+    listWorkflows({ commit }, tableName) {
       const pageSize = 0
       const pageToken = 0
       return requestListWorkflows({ tableName, pageSize, pageToken })
         .then(response => {
-          var nodeWorflow = {
+          const nodeWorflow = {
             nextPageToken: response.nextPageToken,
             recordCount: response.recordCount,
             workflowsList: response.workflowsList
           }
           commit('addListWorkflows', nodeWorflow)
+          return nodeWorflow
         })
         .catch(error => {
           console.warn(`Error getting List workflow: ${error.message}. Code: ${error.code}.`)

src/store/modules/ADempiere/contextMenu.js

@@ -4,7 +4,7 @@ import { requestListDocumentActions, requestListDocumentStatuses } from '@/api/A
 // Store used for set all related to context menu
 // for Window, Process, Smart Browser andother customized component
 // See structure:
-// menu: [
+// contextMenu: [
 //   {
 //     containerUuid: '',
 //     relations: [],
@@ -14,8 +14,7 @@ import { requestListDocumentActions, requestListDocumentStatuses } from '@/api/A
 //     lastAction: {}
 //   }
 // ]
-const contextMenu = {
+const initStateContextMenu = {
-  state: {
   contextMenu: [],
   listDocumentStatus: {
     defaultDocumentAction: undefined,
@@ -29,7 +28,10 @@ const contextMenu = {
     recordId: undefined,
     recordUuid: undefined
   }
-  },
+}
+
+const contextMenu = {
+  state: initStateContextMenu,
   mutations: {
     setContextMenu(state, payload) {
       state.contextMenu.push(payload)
@@ -42,6 +44,9 @@ const contextMenu = {
     },
     addlistDocumentStatus(state, payload) {
       state.listDocumentStatus = payload
+    },
+    resetContextMenu(state) {
+      state = initStateContextMenu
     }
   },
   actions: {

src/store/modules/ADempiere/data.js

@@ -13,13 +13,15 @@ import { parseContext } from '@/utils/ADempiere/contextUtils'
 import { showMessage } from '@/utils/ADempiere/notification'
 import language from '@/lang'
 
-const data = {
+const initStateBusinessData = {
-  state: {
   recordSelection: [], // record data and selection
   inGetting: [],
   contextInfoField: [],
   recordPrivateAccess: {}
-  },
+}
+
+const data = {
+  state: initStateBusinessData,
   mutations: {
     addInGetting(state, payload) {
       state.inGetting.push(payload)
@@ -81,6 +83,9 @@ const data = {
     },
     setPrivateAccess(state, payload) {
       state.recordPrivateAccess = payload
+    },
+    resetStateBusinessData(state) {
+      state = initStateBusinessData
     }
   },
   actions: {
@@ -900,6 +905,18 @@ const data = {
           })
           console.warn(`Error unlock private access: ${error.message}. Code: ${error.code}.`)
         })
+    },
+    resetStateBusinessData({ commit }) {
+      commit('resetStateContainerInfo')
+      commit('setInitialContext', {})
+      commit('resetStateTranslations')
+      commit('resetStateBusinessData')
+      commit('resetContextMenu')
+      commit('resetStateTranslations')
+      commit('resetStateLookup')
+      commit('resetStateProcessControl')
+      commit('resetStateUtils')
+      commit('resetStateWindowControl')
     }
   },
   getters: {

src/store/modules/ADempiere/languageControl.js

@@ -4,6 +4,7 @@ import {
   updateEntity
 } from '@/api/ADempiere/data'
 import { isEmptyValue } from '@/utils/ADempiere/valueUtils'
+
 const languageControl = {
   state: {
     languagesList: [],
@@ -25,6 +26,9 @@ const languageControl = {
     },
     addTranslationChangeRecord(state, payload) {
       payload.currentTranslation = payload.newTranlation
+    },
+    resetStateTranslations(state) {
+      state.translationsList = []
     }
   },
   actions: {

src/store/modules/ADempiere/lookup.js

@@ -3,11 +3,13 @@ import { getCurrentRole } from '@/utils/ADempiere/auth'
 import { isEmptyValue } from '@/utils/ADempiere/valueUtils'
 import { parseContext } from '@/utils/ADempiere/contextUtils'
 
-const lookup = {
+const initStateLookup = {
-  state: {
   lookupItem: [],
   lookupList: []
-  },
+}
+
+const lookup = {
+  state: initStateLookup,
   mutations: {
     addLoockupItem(state, payload) {
       state.lookupItem.push(payload)
@@ -18,6 +20,9 @@ const lookup = {
     deleteLookupList(state, payload) {
       state.lookupItem = payload.lookupItem
       state.lookupList = payload.lookupList
+    },
+    resetStateLookup(state) {
+      state = initStateLookup
     }
   },
   actions: {

src/store/modules/ADempiere/processControl.js

@@ -7,8 +7,7 @@ import { isEmptyValue } from '@/utils/ADempiere/valueUtils'
 import language from '@/lang'
 import router from '@/router'
 
-const processControl = {
+const initStateProcessControl = {
-  state: {
   inExecution: [], // process not response from server
   isVisibleDialog: false,
   reportObject: {},
@@ -24,7 +23,10 @@ const processControl = {
   totalSelection: 0,
   errorSelection: 0,
   successSelection: 0
-  },
+}
+
+const processControl = {
+  state: initStateProcessControl,
   mutations: {
     // Add process in execution
     addInExecution(state, payload) {
@@ -49,8 +51,8 @@ const processControl = {
     addStartedProcess(state, payload) {
       state.process.push(payload)
     },
-    dataResetCacheProcess(state, payload) {
+    resetStateProcessControl(state) {
-      state.process = payload
+      state = initStateProcessControl
     },
     /**
      *
@@ -78,16 +80,6 @@ const processControl = {
     changeFormatReport(state, payload) {
       state.reportFormat = payload
     },
-    clearProcessControl(state) {
-      state.inExecution = [] // process not response from server
-      state.reportObject = {}
-      state.reportList = []
-      state.metadata = {}
-      state.process = [] // process to run finish
-      state.sessionProcess = []
-      state.notificationProcess = []
-      state.inRequestMetadata = []
-    },
     setReportViewsList(state, payload) {
       state.reportViewList.push(payload)
     },
@@ -913,9 +905,6 @@ const processControl = {
       if (reportFormat !== undefined) {
         commit('changeFormatReport', reportFormat)
       }
-    },
-    clearProcessControl({ commit }) {
-      commit('clearProcessControl')
     }
   },
   getters: {

src/store/modules/ADempiere/reportControl.js

@@ -1,12 +1,20 @@
-import { requestReportViews, requestPrintFormats, requestDrillTables, getReportOutput } from '@/api/ADempiere'
+import {
-import { isEmptyValue } from '@/utils/ADempiere'
+  requestReportViews,
-const contextMenu = {
+  requestPrintFormats,
-  state: {
+  requestDrillTables,
+  getReportOutput
+} from '@/api/ADempiere/data'
+import { isEmptyValue } from '@/utils/ADempiere/valueUtils'
+
+const initStateReportControl = {
   reportFormatsList: [],
   reportViewsList: [],
   drillTablesList: [],
   reportOutput: {}
-  },
+}
+
+const reportControl = {
+  state: initStateReportControl,
   mutations: {
     setReportFormatsList(state, payload) {
       state.reportFormatsList.push(payload)
@@ -19,6 +27,9 @@ const contextMenu = {
     },
     setNewReportOutput(state, payload) {
       state.reportOutput = payload
+    },
+    resetReportControl(state) {
+      state = initStateReportControl
     }
   },
   actions: {
@@ -181,7 +192,7 @@ const contextMenu = {
   },
   getters: {
     getPrintFormatList: (state) => (containerUuid) => {
-      var printFormatList = state.reportFormatsList.find(list => list.containerUuid === containerUuid)
+      const printFormatList = state.reportFormatsList.find(list => list.containerUuid === containerUuid)
       if (printFormatList) {
         return printFormatList.printFormatList
       }
@@ -191,14 +202,14 @@ const contextMenu = {
       return getters.getPrintFormatList(containerUuid).find(printFormat => printFormat.isDefault)
     },
     getReportViewList: (state) => (containerUuid) => {
-      var reportViewList = state.reportViewsList.find(list => list.containerUuid === containerUuid)
+      const reportViewList = state.reportViewsList.find(list => list.containerUuid === containerUuid)
       if (reportViewList) {
         return reportViewList.viewList
       }
       return []
     },
     getDrillTablesList: (state) => (containerUuid) => {
-      var drillTablesList = state.drillTablesList.find(list => list.containerUuid === containerUuid)
+      const drillTablesList = state.drillTablesList.find(list => list.containerUuid === containerUuid)
       if (drillTablesList) {
         return drillTablesList.viewList
       }
@@ -207,4 +218,4 @@ const contextMenu = {
   }
 }
 
-export default contextMenu
+export default reportControl

src/store/modules/ADempiere/utils.js

@@ -1,7 +1,6 @@
 import Vue from 'vue'
 
-const utils = {
+const initStateUtils = {
-  state: {
   width: 0,
   height: 0,
   splitHeight: 50,
@@ -30,7 +29,10 @@ const utils = {
     isLoaded: false
   },
   panelRight: ''
-  },
+}
+
+const utils = {
+  state: initStateUtils,
   mutations: {
     setWidth(state, width) {
       state.width = width
@@ -92,6 +94,9 @@ const utils = {
     },
     setPanelRight(state, payload) {
       state.panelRight = payload
+    },
+    resetStateUtils(state) {
+      state = initStateUtils
     }
   },
   actions: {

src/store/modules/ADempiere/window.js

@@ -8,19 +8,20 @@ import language from '@/lang'
 import router from '@/router'
 import { generateField, getFieldTemplate } from '@/utils/ADempiere/dictionaryUtils'
 
-const window = {
+const initStateWindow = {
-  state: {
   window: [],
   windowIndex: 0
-  },
+}
+
+const window = {
+  state: initStateWindow,
   mutations: {
     addWindow(state, payload) {
       state.window.push(payload)
       state.windowIndex++
     },
     dictionaryResetCacheWindow(state) {
-      state.window = []
+      state = initStateWindow
-      state.windowIndex = 0
     },
     changeWindow(state, payload) {
       payload.window = payload.newWindow

src/store/modules/ADempiere/windowControl.js

@@ -5,8 +5,7 @@ import { showMessage } from '@/utils/ADempiere/notification'
 import language from '@/lang'
 import router from '@/router'
 
-const windowControl = {
+const initStateWindowControl = {
-  state: {
   inCreate: [],
   references: [],
   windowOldRoute: {
@@ -18,7 +17,10 @@ const windowControl = {
   tabSequenceRecord: [],
   totalResponse: 0,
   totalRequest: 0
-  },
+}
+
+const windowControl = {
+  state: initStateWindowControl,
   mutations: {
     addInCreate(state, payload) {
       state.inCreate.push(payload)
@@ -43,6 +45,9 @@ const windowControl = {
     },
     setTotalRequest(state, payload) {
       state.totalRequest = payload
+    },
+    resetStateWindowControl(state) {
+      state = initStateWindowControl
     }
   },
   actions: {

src/store/modules/user.js

@@ -162,7 +162,7 @@ const actions = {
         commit('SET_TOKEN', '')
         commit('SET_ROLES', [])
         commit('setIsSession', false)
-        dispatch('clearProcessControl', null, {
+        dispatch('resetStateBusinessData', null, {
           root: true
         })
         dispatch('dictionaryResetCache', null, {
@@ -227,7 +227,7 @@ const actions = {
         // Update user info and context associated with session
         dispatch('getInfo', changeRoleResponse.uuid)
 
-        dispatch('clearProcessControl', null, {
+        dispatch('resetStateBusinessData', null, {
           root: true
         })
         dispatch('dictionaryResetCache', null, {