From 51e6813e8e1375c660a904189a7ed74711ac52f4 Mon Sep 17 00:00:00 2001
From: John Chilton <jmchilton@gmail.com>
Date: Tue, 26 Apr 2022 11:34:46 -0400
Subject: [PATCH] Allow users to view invocations for a particular workflow.

---
 .../components/Workflow/Invocations.test.js   | 34 ++++++++++++++++++-
 .../src/components/Workflow/Invocations.vue   | 23 +++++++++++--
 .../Workflow/StoredWorkflowInvocations.vue    | 30 ++++++++++++++++
 .../components/Workflow/WorkflowDropdown.vue  |  7 ++++
 .../providers/StoredWorkflowsProvider.js      | 15 ++++++++
 client/src/entry/analysis/AnalysisRouter.js   |  6 ++++
 lib/galaxy/webapps/galaxy/buildapp.py         |  1 +
 7 files changed, 113 insertions(+), 3 deletions(-)
 create mode 100644 client/src/components/Workflow/StoredWorkflowInvocations.vue

diff --git a/client/src/components/Workflow/Invocations.test.js b/client/src/components/Workflow/Invocations.test.js
index a5c0371b43e..35ad7eb1285 100644
--- a/client/src/components/Workflow/Invocations.test.js
+++ b/client/src/components/Workflow/Invocations.test.js
@@ -8,7 +8,7 @@ import { parseISO, formatDistanceToNow } from "date-fns";
 
 const localVue = getLocalVue();
 
-describe("Invocations.vue without invocation", () => {
+describe("Invocations.vue without invocations", () => {
     let axiosMock;
     let wrapper;
     let propsData;
@@ -38,6 +38,38 @@ describe("Invocations.vue without invocation", () => {
     });
 });
 
+describe("Invocations.vue for a workflow invocations", () => {
+    let axiosMock;
+    let wrapper;
+    let propsData;
+
+    beforeEach(async () => {
+        axiosMock = new MockAdapter(axios);
+        axiosMock.onAny().reply(200, [], { total_matches: "0" });
+        propsData = {
+            ownerGrid: false,
+            storedWorkflowName: "My Workflow",
+            storedWorkflowId: "abcde145678",
+        };
+        wrapper = mount(Invocations, {
+            propsData,
+            localVue,
+        });
+    });
+
+    afterEach(() => {
+        axiosMock.restore();
+    });
+
+    it("title should be shown", async () => {
+        expect(wrapper.find("#invocations-title").text()).toBe("Workflow Invocations for My Workflow");
+    });
+
+    it("no invocations message should be shown when not loading", async () => {
+        expect(wrapper.find("#no-invocations").exists()).toBe(true);
+    });
+});
+
 describe("Invocations.vue with invocation", () => {
     let wrapper;
     let propsData;
diff --git a/client/src/components/Workflow/Invocations.vue b/client/src/components/Workflow/Invocations.vue
index e3d21c0d0d1..5f35603d978 100644
--- a/client/src/components/Workflow/Invocations.vue
+++ b/client/src/components/Workflow/Invocations.vue
@@ -1,7 +1,7 @@
 <template>
     <div class="invocations-list">
         <h2 class="mb-3">
-            <span id="invocations-title">Workflow Invocations</span>
+            <span id="invocations-title">{{ title }}</span>
         </h2>
         <b-alert v-if="headerMessage" variant="info" show>
             {{ headerMessage }}
@@ -22,7 +22,7 @@
             <template v-slot:empty>
                 <loading-span v-if="loading" message="Loading workflow invocations" />
                 <b-alert v-else id="no-invocations" variant="info" show>
-                    {{ noInvocationsMessage }}
+                    {{ effectiveNoInvocationsMessage }}
                 </b-alert>
             </template>
             <template v-slot:row-details="row">
@@ -108,6 +108,8 @@ export default {
         headerMessage: { type: String, default: "" },
         ownerGrid: { type: Boolean, default: true },
         userId: { type: String, default: null },
+        storedWorkflowId: { type: String, default: null },
+        storedWorkflowName: { type: String, default: null },
     },
     data() {
         const fields = [
@@ -133,6 +135,20 @@ export default {
         apiUrl() {
             return `${getAppRoot()}api/invocations`;
         },
+        title() {
+            let title = `Workflow Invocations`;
+            if (this.storedWorkflowName) {
+                title += ` for ${this.storedWorkflowName}`;
+            }
+            return title;
+        },
+        effectiveNoInvocationsMessage() {
+            let message = this.noInvocationsMessage;
+            if (this.storedWorkflowName) {
+                message += ` for ${this.storedWorkflowName}`;
+            }
+            return message;
+        },
     },
     watch: {
         invocationItems: function (promise) {
@@ -157,6 +173,9 @@ export default {
         provider(ctx) {
             ctx.apiUrl = this.apiUrl;
             const extraParams = this.ownerGrid ? {} : { include_terminal: false };
+            if (this.storedWorkflowId) {
+                extraParams["workflow_id"] = this.storedWorkflowId;
+            }
             if (this.userId) {
                 extraParams["user_id"] = this.userId;
             }
diff --git a/client/src/components/Workflow/StoredWorkflowInvocations.vue b/client/src/components/Workflow/StoredWorkflowInvocations.vue
new file mode 100644
index 00000000000..208d9c273f1
--- /dev/null
+++ b/client/src/components/Workflow/StoredWorkflowInvocations.vue
@@ -0,0 +1,30 @@
+<template>
+    <CurrentUser v-slot="{ user }">
+        <StoredWorkflowDetailsProvider :storedWorkflowId="storedWorkflowId" v-slot="{ result: item, loading }">
+            <Invocations
+                v-if="!loading && user.id"
+                :user-id="user.id"
+                :stored-workflow-id="item.id"
+                :stored-workflow-name="item.name" />
+        </StoredWorkflowDetailsProvider>
+    </CurrentUser>
+</template>
+<script>
+import Invocations from "components/Workflow/Invocations";
+import CurrentUser from "components/providers/CurrentUser";
+import { StoredWorkflowDetailsProvider } from "components/providers/StoredWorkflowsProvider";
+
+export default {
+    props: {
+        storedWorkflowId: {
+            type: String,
+            required: true,
+        },
+    },
+    components: {
+        CurrentUser,
+        Invocations,
+        StoredWorkflowDetailsProvider,
+    },
+};
+</script>
diff --git a/client/src/components/Workflow/WorkflowDropdown.vue b/client/src/components/Workflow/WorkflowDropdown.vue
index 5fa496f04ad..b507c54a651 100644
--- a/client/src/components/Workflow/WorkflowDropdown.vue
+++ b/client/src/components/Workflow/WorkflowDropdown.vue
@@ -41,6 +41,10 @@
                 <span class="fa fa-copy fa-fw mr-1" />
                 <span>Copy</span>
             </a>
+            <a class="dropdown-item" :href="urlInvocations">
+                <span class="fa fa-list fa-fw mr-1" />
+                <span>Invocations</span>
+            </a>
             <a class="dropdown-item" :href="urlDownload">
                 <span class="fa fa-download fa-fw mr-1" />
                 <span>Download</span>
@@ -103,6 +107,9 @@ export default {
         urlView() {
             return `${getAppRoot()}workflow/display_by_id?id=${this.workflow.id}`;
         },
+        urlInvocations() {
+            return `${getAppRoot()}workflows/${this.workflow.id}/invocations`;
+        },
         urlViewShared() {
             return `${getAppRoot()}workflow/display_by_username_and_slug?username=${this.workflow.owner}&slug=${
                 this.workflow.slug
diff --git a/client/src/components/providers/StoredWorkflowsProvider.js b/client/src/components/providers/StoredWorkflowsProvider.js
index bdf568c043d..75dabb0c1ce 100644
--- a/client/src/components/providers/StoredWorkflowsProvider.js
+++ b/client/src/components/providers/StoredWorkflowsProvider.js
@@ -1,5 +1,8 @@
 import axios from "axios";
+import { getAppRoot } from "onload/loadConfig";
 import { cleanPaginationParameters } from "./utils";
+import { SingleQueryProvider } from "components/providers/SingleQueryProvider";
+import { rethrowSimple } from "utils/simple-error";
 
 export function storedWorkflowsProvider(ctx, callback, extraParams = {}) {
     const { apiUrl, ...requestParams } = ctx;
@@ -15,3 +18,15 @@ export function storedWorkflowsProvider(ctx, callback, extraParams = {}) {
         return items || [];
     });
 }
+
+async function storedWorkflowDetails({ storedWorkflowId }) {
+    const url = `${getAppRoot()}api/workflows/${storedWorkflowId}?instance=true`;
+    try {
+        const { data } = await axios.get(url);
+        return data;
+    } catch (e) {
+        rethrowSimple(e);
+    }
+}
+
+export const StoredWorkflowDetailsProvider = SingleQueryProvider(storedWorkflowDetails);
diff --git a/client/src/entry/analysis/AnalysisRouter.js b/client/src/entry/analysis/AnalysisRouter.js
index 4b1c8c82500..f5ba3e4648a 100644
--- a/client/src/entry/analysis/AnalysisRouter.js
+++ b/client/src/entry/analysis/AnalysisRouter.js
@@ -38,6 +38,7 @@ import HistoryView from "components/HistoryView";
 import WorkflowInvocationReport from "components/Workflow/InvocationReport";
 import WorkflowRun from "components/Workflow/Run/WorkflowRun";
 import UserInvocations from "components/Workflow/UserInvocations";
+import StoredWorkflowInvocations from "components/Workflow/StoredWorkflowInvocations";
 import ToolsView from "components/ToolsView/ToolsView";
 import ToolsJson from "components/ToolsView/ToolsSchemaJson/ToolsJson";
 import HistoryList from "mvc/history/history-list";
@@ -90,6 +91,7 @@ export const getAnalysisRouter = (Galaxy) => {
             "(/)workflows/invocations/report": "show_workflow_invocation_report",
             // "(/)workflows/invocations/view_bco": "show_invocation_bco",
             "(/)workflows/list_published(/)": "show_workflows_published",
+            "(/)workflows(/)(:stored_workflow_id)(/)/invocations": "show_invocations_for_stored_workflow",
             "(/)workflows/create(/)": "show_workflows_create",
             "(/)histories(/)citations(/)": "show_history_citations",
             "(/)histories(/)rename(/)": "show_histories_rename",
@@ -248,6 +250,10 @@ export const getAnalysisRouter = (Galaxy) => {
             this._display_vue_helper(UserInvocations, {});
         },
 
+        show_invocations_for_stored_workflow: function (stored_workflow_id) {
+            this._display_vue_helper(StoredWorkflowInvocations, { storedWorkflowId: stored_workflow_id });
+        },
+
         show_history_structure: function () {
             this._display_vue_helper(DisplayStructure, { id: QueryStringParsing.get(" id: ") });
         },
diff --git a/lib/galaxy/webapps/galaxy/buildapp.py b/lib/galaxy/webapps/galaxy/buildapp.py
index 06478501417..3a30be2d718 100644
--- a/lib/galaxy/webapps/galaxy/buildapp.py
+++ b/lib/galaxy/webapps/galaxy/buildapp.py
@@ -251,6 +251,7 @@ def app_pair(global_conf, load_app_kwds=None, wsgi_preflight=True, **kwargs):
     webapp.add_client_route("/workflows/trs_search")
     webapp.add_client_route("/workflows/invocations")
     webapp.add_client_route("/workflows/sharing")
+    webapp.add_client_route("/workflows/{stored_workflow_id}/invocations")
     webapp.add_client_route("/workflows/invocations/report")
     # webapp.add_client_route('/workflows/invocations/view_bco')
     webapp.add_client_route("/custom_builds")