From 69498b44f0ea372ad08313c82a23cf848efbded6 Mon Sep 17 00:00:00 2001
From: mvdbeek <m.vandenbeek@gmail.com>
Date: Fri, 17 Jun 2022 14:04:28 +0200
Subject: [PATCH] Uniform refresh for old and new history panel

Fixes https://github.com/galaxyproject/galaxy/issues/13731
---
 .../History/adapters/HistoryPanelProxy.js         |  3 ++-
 client/src/components/RuleCollectionBuilder.vue   | 10 +++-------
 client/src/components/Tool/ToolForm.vue           |  6 ++----
 client/src/components/Upload/Collection.vue       |  4 ++--
 client/src/components/Upload/Composite.vue        |  5 ++---
 client/src/components/Upload/UploadBoxMixin.js    |  6 ++----
 client/src/utils/data.js                          | 15 ++++++++++-----
 7 files changed, 23 insertions(+), 26 deletions(-)

diff --git a/client/src/components/History/adapters/HistoryPanelProxy.js b/client/src/components/History/adapters/HistoryPanelProxy.js
index 15ae565a61b..936b8bdb761 100644
--- a/client/src/components/History/adapters/HistoryPanelProxy.js
+++ b/client/src/components/History/adapters/HistoryPanelProxy.js
@@ -56,7 +56,8 @@ export class HistoryPanelProxy {
         watchHistory();
     }
     refreshContents() {
-        // to be removed after disabling legacy history
+        // to be removed after disabling legacy history, present to provide uniform interface
+        // with History Panel Backbone View.
     }
     loadCurrentHistory() {
         store.dispatch("history/loadCurrentHistory");
diff --git a/client/src/components/RuleCollectionBuilder.vue b/client/src/components/RuleCollectionBuilder.vue
index 64c0a1124c4..2ccd47ff1ce 100644
--- a/client/src/components/RuleCollectionBuilder.vue
+++ b/client/src/components/RuleCollectionBuilder.vue
@@ -572,6 +572,7 @@ import { getAppRoot } from "onload/loadConfig";
 import { getGalaxyInstance } from "app";
 import axios from "axios";
 import _l from "utils/localization";
+import { refreshContentsWrapper } from "utils/data";
 import HotTable from "@handsontable/vue";
 import UploadUtils from "mvc/upload/upload-utils";
 import JobStatesModel from "mvc/history/job-states-model";
@@ -1313,10 +1314,7 @@ export default {
             this.mapping.splice(index, 1);
         },
         refreshAndWait(response) {
-            const Galaxy = getGalaxyInstance();
-            if (Galaxy && Galaxy.currHistoryPanel) {
-                Galaxy.currHistoryPanel.refreshContents();
-            }
+            refreshContentsWrapper();
             this.waitOnJob(response);
         },
         waitOnJob(response) {
@@ -1332,9 +1330,7 @@ export default {
                         "Unknown error encountered while running your upload job, this could be a server issue or a problem with the upload definition.";
                     this.doFullJobCheck(jobId);
                 } else {
-                    const Galaxy = getGalaxyInstance();
-                    const history = Galaxy && Galaxy.currHistoryPanel && Galaxy.currHistoryPanel.model;
-                    history.refresh && history.refresh();
+                    refreshContentsWrapper();
                     this.oncreate();
                 }
             };
diff --git a/client/src/components/Tool/ToolForm.vue b/client/src/components/Tool/ToolForm.vue
index b236bf8329f..b62a8b10571 100644
--- a/client/src/components/Tool/ToolForm.vue
+++ b/client/src/components/Tool/ToolForm.vue
@@ -91,6 +91,7 @@
 import { getGalaxyInstance } from "app";
 import { getToolFormData, updateToolFormData, submitJob } from "./services";
 import { allowCachedJobs } from "./utilities";
+import { refreshContentsWrapper } from "utils/data";
 import ToolCard from "./ToolCard";
 import ButtonSpinner from "components/Common/ButtonSpinner";
 import CurrentUser from "components/providers/CurrentUser";
@@ -274,7 +275,6 @@ export default {
                 return;
             }
             this.showExecuting = true;
-            const Galaxy = getGalaxyInstance();
             const jobDef = {
                 history_id: historyId,
                 tool_id: this.formConfig.id,
@@ -296,9 +296,7 @@ export default {
             submitJob(jobDef).then(
                 (jobResponse) => {
                     this.showExecuting = false;
-                    if (Galaxy.currHistoryPanel) {
-                        Galaxy.currHistoryPanel.refreshContents();
-                    }
+                    refreshContentsWrapper();
                     if (jobResponse.produces_entry_points) {
                         this.showEntryPoints = true;
                         this.entryPoints = jobResponse.jobs;
diff --git a/client/src/components/Upload/Collection.vue b/client/src/components/Upload/Collection.vue
index 2bf7f590193..748000471b7 100644
--- a/client/src/components/Upload/Collection.vue
+++ b/client/src/components/Upload/Collection.vue
@@ -120,6 +120,7 @@
 import _l from "utils/localization";
 import _ from "underscore";
 import { getGalaxyInstance } from "app";
+import { refreshContentsWrapper } from "utils/data";
 import UploadRow from "mvc/upload/collection/collection-row";
 import UploadBoxMixin from "./UploadBoxMixin";
 import { uploadModelsToPayload } from "./helpers";
@@ -250,8 +251,7 @@ export default {
             const outputs = incoming.outputs || incoming.data.outputs || {};
             it.set({ percentage: 100, status: "success", outputs });
             this._updateStateForSuccess(it);
-            const Galaxy = getGalaxyInstance();
-            Galaxy.currHistoryPanel.refreshContents();
+            refreshContentsWrapper();
         },
 
         _eventBuild: function () {
diff --git a/client/src/components/Upload/Composite.vue b/client/src/components/Upload/Composite.vue
index eeb1b58ef9c..fc8329ad95c 100644
--- a/client/src/components/Upload/Composite.vue
+++ b/client/src/components/Upload/Composite.vue
@@ -61,7 +61,7 @@
 <script>
 import _l from "utils/localization";
 import _ from "underscore";
-import { getGalaxyInstance } from "app";
+import { refreshContentsWrapper } from "utils/data";
 import UploadRow from "mvc/upload/composite/composite-row";
 import UploadBoxMixin from "./UploadBoxMixin";
 import { uploadModelsToPayload } from "./helpers";
@@ -193,11 +193,10 @@ export default {
 
         /** Refresh success state */
         _eventSuccess: function (message) {
-            const Galaxy = getGalaxyInstance();
             this.collection.each((it) => {
                 it.set("status", "success");
             });
-            Galaxy.currHistoryPanel.refreshContents();
+            refreshContentsWrapper();
         },
 
         /** Refresh error state */
diff --git a/client/src/components/Upload/UploadBoxMixin.js b/client/src/components/Upload/UploadBoxMixin.js
index 596f82fd0ff..4942866d004 100644
--- a/client/src/components/Upload/UploadBoxMixin.js
+++ b/client/src/components/Upload/UploadBoxMixin.js
@@ -6,11 +6,10 @@ import UploadExtension from "mvc/upload/upload-extension";
 import UploadModel from "mvc/upload/upload-model";
 import UploadWrapper from "./UploadWrapper";
 import { defaultNewFileName, uploadModelsToPayload } from "./helpers";
-import { getGalaxyInstance } from "app";
 import UploadFtp from "mvc/upload/upload-ftp";
 import LazyLimited from "mvc/lazy/lazy-limited";
 import { findExtension } from "./utils";
-import { filesDialog } from "utils/data";
+import { filesDialog, refreshContentsWrapper } from "utils/data";
 import { getAppRoot } from "onload";
 import { UploadQueue } from "utils/uploadbox";
 import axios from "axios";
@@ -195,8 +194,7 @@ export default {
             this.counterAnnounce--;
             this.counterSuccess++;
             this._updateStateForCounters();
-            const Galaxy = getGalaxyInstance();
-            Galaxy.currHistoryPanel.refreshContents();
+            refreshContentsWrapper();
         },
         /** A new file has been dropped/selected through the uploadbox plugin */
         _eventAnnounce: function (index, file) {
diff --git a/client/src/utils/data.js b/client/src/utils/data.js
index 90ef1a76f0a..8f0856364a3 100644
--- a/client/src/utils/data.js
+++ b/client/src/utils/data.js
@@ -9,6 +9,7 @@ import { uploadModelsToPayload } from "components/Upload/helpers";
 import { getGalaxyInstance } from "app";
 import { getAppRoot } from "onload/loadConfig";
 import { submitUpload } from "utils/uploadbox";
+import { rewatchHistory } from "store/historyStore/model/watchHistory";
 
 // This should be moved more centrally (though still hanging off Galaxy for
 // external use?), and populated from the store; just using this as a temporary
@@ -85,8 +86,6 @@ function _mountSelectionDialog(clazz, options) {
  * TODO: This should live somewhere else.
  */
 export function create(options) {
-    const Galaxy = getGalaxyInstance();
-    const history_panel = Galaxy.currHistoryPanel;
     async function getHistory() {
         if (!options.history_id) {
             return getCurrentGalaxyHistory();
@@ -97,9 +96,7 @@ export function create(options) {
         submitUpload({
             url: `${getAppRoot()}api/tools/fetch`,
             success: (response) => {
-                if (history_panel) {
-                    history_panel.refreshContents();
-                }
+                refreshContentsWrapper();
                 if (options.success) {
                     options.success(response);
                 }
@@ -111,3 +108,11 @@ export function create(options) {
         });
     });
 }
+
+export function refreshContentsWrapper() {
+    const Galaxy = getGalaxyInstance();
+    // Legacy Panel Interface. no-op if using new history
+    Galaxy?.currHistoryPanel?.refreshContents();
+    // Will not do anything in legacy interface
+    rewatchHistory();
+}