From adbf6149cf1778cd48a9bbf8e97332669dbcb7cb Mon Sep 17 00:00:00 2001
From: Paul Slaughter <pslaughter@gitlab.com>
Date: Thu, 27 Sep 2018 16:57:30 -0500
Subject: Keep IDE RightPane views alive

**Why?**
- This is needed for the Web Terminal feature.
  https://gitlab.com/gitlab-org/gitlab-ee/issues/5426

**Notes:**
- Introduces a `pane` Vuex module.
- Some views should not be kept alive (i.e. job details).
  This is why a `keepAlive` flag was introduced for views.
---
 app/assets/javascripts/ide/stores/actions.js       |  4 ---
 app/assets/javascripts/ide/stores/index.js         |  2 ++
 .../javascripts/ide/stores/modules/pane/actions.js | 30 ++++++++++++++++++++++
 .../javascripts/ide/stores/modules/pane/getters.js |  4 +++
 .../javascripts/ide/stores/modules/pane/index.js   | 12 +++++++++
 .../ide/stores/modules/pane/mutation_types.js      |  3 +++
 .../ide/stores/modules/pane/mutations.js           | 19 ++++++++++++++
 .../javascripts/ide/stores/modules/pane/state.js   |  5 ++++
 .../ide/stores/modules/pipelines/actions.js        |  2 +-
 .../javascripts/ide/stores/mutation_types.js       |  2 --
 app/assets/javascripts/ide/stores/mutations.js     |  5 ----
 app/assets/javascripts/ide/stores/state.js         |  1 -
 12 files changed, 76 insertions(+), 13 deletions(-)
 create mode 100644 app/assets/javascripts/ide/stores/modules/pane/actions.js
 create mode 100644 app/assets/javascripts/ide/stores/modules/pane/getters.js
 create mode 100644 app/assets/javascripts/ide/stores/modules/pane/index.js
 create mode 100644 app/assets/javascripts/ide/stores/modules/pane/mutation_types.js
 create mode 100644 app/assets/javascripts/ide/stores/modules/pane/mutations.js
 create mode 100644 app/assets/javascripts/ide/stores/modules/pane/state.js

(limited to 'app/assets/javascripts/ide/stores')

diff --git a/app/assets/javascripts/ide/stores/actions.js b/app/assets/javascripts/ide/stores/actions.js
index b8b64aead30..e10a132ab4b 100644
--- a/app/assets/javascripts/ide/stores/actions.js
+++ b/app/assets/javascripts/ide/stores/actions.js
@@ -184,10 +184,6 @@ export const burstUnusedSeal = ({ state, commit }) => {
   }
 };
 
-export const setRightPane = ({ commit }, view) => {
-  commit(types.SET_RIGHT_PANE, view);
-};
-
 export const setLinks = ({ commit }, links) => commit(types.SET_LINKS, links);
 
 export const setErrorMessage = ({ commit }, errorMessage) =>
diff --git a/app/assets/javascripts/ide/stores/index.js b/app/assets/javascripts/ide/stores/index.js
index 877d88bb060..f1f544b52b2 100644
--- a/app/assets/javascripts/ide/stores/index.js
+++ b/app/assets/javascripts/ide/stores/index.js
@@ -9,6 +9,7 @@ import pipelines from './modules/pipelines';
 import mergeRequests from './modules/merge_requests';
 import branches from './modules/branches';
 import fileTemplates from './modules/file_templates';
+import paneModule from './modules/pane';
 
 Vue.use(Vuex);
 
@@ -24,6 +25,7 @@ export const createStore = () =>
       mergeRequests,
       branches,
       fileTemplates: fileTemplates(),
+      rightPane: paneModule(),
     },
   });
 
diff --git a/app/assets/javascripts/ide/stores/modules/pane/actions.js b/app/assets/javascripts/ide/stores/modules/pane/actions.js
new file mode 100644
index 00000000000..7f5d167a14f
--- /dev/null
+++ b/app/assets/javascripts/ide/stores/modules/pane/actions.js
@@ -0,0 +1,30 @@
+import * as types from './mutation_types';
+
+export const toggleOpen = ({ dispatch, state }, view) => {
+  if (state.isOpen) {
+    dispatch('close');
+  } else {
+    dispatch('open', view);
+  }
+};
+
+export const open = ({ commit }, view) => {
+  commit(types.SET_OPEN, true);
+
+  if (view) {
+    const { name, keepAlive } = view;
+
+    commit(types.SET_CURRENT_VIEW, name);
+
+    if (keepAlive) {
+      commit(types.KEEP_ALIVE_VIEW, name);
+    }
+  }
+};
+
+export const close = ({ commit }) => {
+  commit(types.SET_OPEN, false);
+};
+
+// prevent babel-plugin-rewire from generating an invalid default during karma tests
+export default () => {};
diff --git a/app/assets/javascripts/ide/stores/modules/pane/getters.js b/app/assets/javascripts/ide/stores/modules/pane/getters.js
new file mode 100644
index 00000000000..c346cf13689
--- /dev/null
+++ b/app/assets/javascripts/ide/stores/modules/pane/getters.js
@@ -0,0 +1,4 @@
+export const isActiveView = state => view => state.currentView === view;
+
+export const isAliveView = (state, getters) => view =>
+  state.keepAliveViews[view] || (state.isOpen && getters.isActiveView(view));
diff --git a/app/assets/javascripts/ide/stores/modules/pane/index.js b/app/assets/javascripts/ide/stores/modules/pane/index.js
new file mode 100644
index 00000000000..5f61cb732c8
--- /dev/null
+++ b/app/assets/javascripts/ide/stores/modules/pane/index.js
@@ -0,0 +1,12 @@
+import * as actions from './actions';
+import * as getters from './getters';
+import mutations from './mutations';
+import state from './state';
+
+export default () => ({
+  namespaced: true,
+  state: state(),
+  actions,
+  getters,
+  mutations,
+});
diff --git a/app/assets/javascripts/ide/stores/modules/pane/mutation_types.js b/app/assets/javascripts/ide/stores/modules/pane/mutation_types.js
new file mode 100644
index 00000000000..abdebc4d913
--- /dev/null
+++ b/app/assets/javascripts/ide/stores/modules/pane/mutation_types.js
@@ -0,0 +1,3 @@
+export const SET_OPEN = 'SET_OPEN';
+export const SET_CURRENT_VIEW = 'SET_CURRENT_VIEW';
+export const KEEP_ALIVE_VIEW = 'KEEP_ALIVE_VIEW';
diff --git a/app/assets/javascripts/ide/stores/modules/pane/mutations.js b/app/assets/javascripts/ide/stores/modules/pane/mutations.js
new file mode 100644
index 00000000000..c16484b4402
--- /dev/null
+++ b/app/assets/javascripts/ide/stores/modules/pane/mutations.js
@@ -0,0 +1,19 @@
+import * as types from './mutation_types';
+
+export default {
+  [types.SET_OPEN](state, isOpen) {
+    Object.assign(state, {
+      isOpen,
+    });
+  },
+  [types.SET_CURRENT_VIEW](state, currentView) {
+    Object.assign(state, {
+      currentView,
+    });
+  },
+  [types.KEEP_ALIVE_VIEW](state, viewName) {
+    Object.assign(state.keepAliveViews, {
+      [viewName]: true,
+    });
+  },
+};
diff --git a/app/assets/javascripts/ide/stores/modules/pane/state.js b/app/assets/javascripts/ide/stores/modules/pane/state.js
new file mode 100644
index 00000000000..353065b5735
--- /dev/null
+++ b/app/assets/javascripts/ide/stores/modules/pane/state.js
@@ -0,0 +1,5 @@
+export default () => ({
+  isOpen: false,
+  currentView: null,
+  keepAliveViews: {},
+});
diff --git a/app/assets/javascripts/ide/stores/modules/pipelines/actions.js b/app/assets/javascripts/ide/stores/modules/pipelines/actions.js
index 3e67b222e66..8fa86995ef0 100644
--- a/app/assets/javascripts/ide/stores/modules/pipelines/actions.js
+++ b/app/assets/javascripts/ide/stores/modules/pipelines/actions.js
@@ -113,7 +113,7 @@ export const toggleStageCollapsed = ({ commit }, stageId) =>
 
 export const setDetailJob = ({ commit, dispatch }, job) => {
   commit(types.SET_DETAIL_JOB, job);
-  dispatch('setRightPane', job ? rightSidebarViews.jobsDetail : rightSidebarViews.pipelines, {
+  dispatch('rightPane/open', job ? rightSidebarViews.jobsDetail : rightSidebarViews.pipelines, {
     root: true,
   });
 };
diff --git a/app/assets/javascripts/ide/stores/mutation_types.js b/app/assets/javascripts/ide/stores/mutation_types.js
index 5a7991d2fa7..a5f8098dc17 100644
--- a/app/assets/javascripts/ide/stores/mutation_types.js
+++ b/app/assets/javascripts/ide/stores/mutation_types.js
@@ -68,8 +68,6 @@ export const UPDATE_TEMP_FLAG = 'UPDATE_TEMP_FLAG';
 export const TOGGLE_FILE_FINDER = 'TOGGLE_FILE_FINDER';
 export const BURST_UNUSED_SEAL = 'BURST_UNUSED_SEAL';
 
-export const SET_RIGHT_PANE = 'SET_RIGHT_PANE';
-
 export const CLEAR_PROJECTS = 'CLEAR_PROJECTS';
 export const RESET_OPEN_FILES = 'RESET_OPEN_FILES';
 
diff --git a/app/assets/javascripts/ide/stores/mutations.js b/app/assets/javascripts/ide/stores/mutations.js
index 2c8535bda59..78cdfda74f0 100644
--- a/app/assets/javascripts/ide/stores/mutations.js
+++ b/app/assets/javascripts/ide/stores/mutations.js
@@ -166,11 +166,6 @@ export default {
       unusedSeal: false,
     });
   },
-  [types.SET_RIGHT_PANE](state, view) {
-    Object.assign(state, {
-      rightPane: state.rightPane === view ? null : view,
-    });
-  },
   [types.SET_LINKS](state, links) {
     Object.assign(state, { links });
   },
diff --git a/app/assets/javascripts/ide/stores/state.js b/app/assets/javascripts/ide/stores/state.js
index 46b52fa00fc..d400b9831a9 100644
--- a/app/assets/javascripts/ide/stores/state.js
+++ b/app/assets/javascripts/ide/stores/state.js
@@ -23,7 +23,6 @@ export default () => ({
   currentActivityView: activityBarViews.edit,
   unusedSeal: true,
   fileFindVisible: false,
-  rightPane: null,
   links: {},
   errorMessage: null,
   entryModal: {
-- 
cgit v1.2.1