Add rerun option for invocations

ahmedhamidawan · ahmedhamidawan · commit 5276f8feda10 · 2025-04-16T20:23:05.000-05:00
Fixes galaxyproject#11340
diff --git a/client/src/api/invocations.ts b/client/src/api/invocations.ts
@@ -7,6 +7,8 @@ export type InvocationInputParameter = components["schemas"]["InvocationInputPar
 export type InvocationJobsSummary = components["schemas"]["InvocationJobsResponse"];
 export type InvocationStep = components["schemas"]["InvocationStep"];
 export type InvocationMessage = components["schemas"]["InvocationMessageResponseUnion"];
+export type WorkflowInvocationRequest = components["schemas"]["WorkflowInvocationRequestModel"];
+export type WorkflowInvocationRequestInputs = components["schemas"]["WorkflowInvocationRequestModel"]["inputs"];
 
 export type StepJobSummary =
     | components["schemas"]["InvocationStepJobsResponseStepModel"]
diff --git a/client/src/components/Workflow/Run/WorkflowRerun.vue b/client/src/components/Workflow/Run/WorkflowRerun.vue
@@ -0,0 +1,48 @@
+<script setup lang="ts">
+import { computed, ref, watch } from "vue";
+
+import { Toast } from "@/composables/toast";
+import { useHistoryStore } from "@/stores/historyStore";
+import { useInvocationStore } from "@/stores/invocationStore";
+
+import WorkflowRun from "./WorkflowRun.vue";
+
+const props = defineProps<{
+    invocationId: string;
+}>();
+
+const historyStore = useHistoryStore();
+const invocationStore = useInvocationStore();
+
+const ready = ref(false);
+
+const requestData = computed(() => invocationStore.getInvocationRequestById(props.invocationId));
+
+watch(
+    requestData,
+    async (rerunData) => {
+        if (rerunData && !ready.value) {
+            // switch to the history with the original workflow inputs first, then render `WorkflowRun`
+            await historyStore.setCurrentHistory(rerunData.history_id);
+
+            // if we were unable to set the history, we need to show an error
+            if (historyStore.currentHistoryId !== rerunData.history_id) {
+                Toast.error("Unable to switch to the history with the original workflow inputs.");
+            }
+            ready.value = true;
+        }
+    },
+    { immediate: true }
+);
+</script>
+
+<template>
+    <WorkflowRun
+        v-if="ready && requestData"
+        :workflow-id="requestData.workflow_id"
+        :instance="requestData.instance"
+        :request-state="requestData.inputs"
+        :append-step-labels-for-request="false"
+        prefer-simple-form
+        :simple-form-use-job-cache="requestData.use_cached_job" />
+</template>
diff --git a/client/src/components/Workflow/Run/WorkflowRun.vue b/client/src/components/Workflow/Run/WorkflowRun.vue
@@ -5,6 +5,7 @@ import { RouterLink } from "vue-router";
 import { useRouter } from "vue-router/composables";
 
 import { canMutateHistory } from "@/api";
+import type { WorkflowInvocationRequestInputs } from "@/api/invocations";
 import { getWorkflowInfo } from "@/api/workflows";
 import { copyWorkflow } from "@/components/Workflow/workflows.services";
 import { useWorkflowInstance } from "@/composables/useWorkflowInstance";
@@ -32,8 +33,9 @@ interface Props {
     preferSimpleForm?: boolean;
     simpleFormTargetHistory?: string;
     simpleFormUseJobCache?: boolean;
-    requestState?: { [key: string]: unknown };
+    requestState?: WorkflowInvocationRequestInputs;
     instance?: boolean;
+    appendStepLabelsForRequest?: boolean;
 }
 
 const props = withDefaults(defineProps<Props>(), {
@@ -43,6 +45,7 @@ const props = withDefaults(defineProps<Props>(), {
     simpleFormUseJobCache: false,
     requestState: undefined,
     instance: false,
+    appendStepLabelsForRequest: true,
 });
 
 const loading = ref(true);
@@ -248,6 +251,7 @@ defineExpose({
                         :use-job-cache="simpleFormUseJobCache"
                         :can-mutate-current-history="canRunOnHistory"
                         :request-state="requestState"
+                        :append-step-labels-for-request="appendStepLabelsForRequest"
                         @submissionSuccess="handleInvocations"
                         @submissionError="handleSubmissionError"
                         @showAdvanced="showAdvanced" />
diff --git a/client/src/components/Workflow/Run/WorkflowRunFormSimple.vue b/client/src/components/Workflow/Run/WorkflowRunFormSimple.vue
@@ -5,6 +5,7 @@ import { BAlert, BButton, BButtonGroup, BCard, BFormCheckbox, BOverlay } from "b
 import { storeToRefs } from "pinia";
 import { computed, ref, watch } from "vue";
 
+import type { WorkflowInvocationRequestInputs } from "@/api/invocations";
 import { isWorkflowInput } from "@/components/Workflow/constants";
 import { useConfig } from "@/composables/config";
 import { useMarkdown } from "@/composables/markdown";
@@ -29,13 +30,15 @@ interface Props {
     targetHistory?: string;
     useJobCache?: boolean;
     canMutateCurrentHistory: boolean;
-    requestState?: Record<string, any>;
+    requestState?: WorkflowInvocationRequestInputs;
+    appendStepLabelsForRequest?: boolean;
 }
 
 const props = withDefaults(defineProps<Props>(), {
     targetHistory: "current",
     useJobCache: false,
     requestState: undefined,
+    appendStepLabelsForRequest: true,
 });
 
 const emit = defineEmits<{
@@ -107,6 +110,12 @@ const formInputs = computed(() => {
         if (isWorkflowInput(step.step_type)) {
             const stepName = new String(step.step_index) as any;
             const stepLabel = step.step_label || new String(step.step_index + 1);
+
+            // For the `WorkflowInvocationRequestModel`, (used in `WorkflowRerun`) if there is no step_label, it does not have
+            // `step.step_index + 1` as a label, and has `step.step_index` instead.
+            const requestStateIndex =
+                !props.appendStepLabelsForRequest && !step.step_label ? new String(step.step_index) : stepLabel;
+
             const stepType = step.step_type;
             const help = step.annotation;
             const longFormInput = step.inputs[0];
@@ -115,9 +124,17 @@ const formInputs = computed(() => {
                 help: help,
                 label: stepLabel,
             });
-            if (props.requestState && props.requestState[stepLabel]) {
-                const value = props.requestState[stepLabel];
-                stepAsInput.value = value;
+            if (props.requestState && props.requestState[requestStateIndex]) {
+                const value = props.requestState[requestStateIndex];
+                // TODO: Will this break workflow landings? Done for `WorkflowRereun` since
+                //       `WorkflowInvocationRequestModel` does not provide an object with `values` property.
+                if (stepType === "data_input" || stepType === "data_collection_input") {
+                    stepAsInput.value = {
+                        values: !Array.isArray(value) ? [value] : value,
+                    };
+                } else {
+                    stepAsInput.value = value;
+                }
             }
             // disable collection mapping...
             stepAsInput.flavor = "module";
diff --git a/client/src/components/Workflow/WorkflowNavigationTitle.vue b/client/src/components/Workflow/WorkflowNavigationTitle.vue
@@ -143,12 +143,12 @@ const workflowImportTitle = computed(() => {
                         variant="primary"
                         :title="
                             !workflow.deleted
-                                ? `<b>Rerun</b><br>${getWorkflowName()}`
+                                ? `<b>Rerun</b><br>${getWorkflowName()}<br><b>with same inputs</b>`
                                 : 'This workflow has been deleted.'
                         "
                         :disabled="workflow.deleted"
-                        force
                         full
+                        :invocation-id="props.invocation.id"
                         :version="workflow.version" />
                 </div>
             </div>
diff --git a/client/src/components/Workflow/WorkflowRunButton.vue b/client/src/components/Workflow/WorkflowRunButton.vue
@@ -13,19 +13,23 @@ interface Props {
     version?: number;
     force?: boolean;
     variant?: string;
+    invocationId?: string;
 }
 
 const props = withDefaults(defineProps<Props>(), {
     title: undefined,
     version: undefined,
     variant: "primary",
+    invocationId: undefined,
 });
 
 const route = useRoute();
 const router = useRouter();
 
-const runPath = computed(
-    () => `/workflows/run?id=${props.id}${props.version !== undefined ? `&version=${props.version}` : ""}`
+const runPath = computed(() =>
+    !props.invocationId
+        ? `/workflows/run?id=${props.id}${props.version !== undefined ? `&version=${props.version}` : ""}`
+        : `/workflows/rerun?invocation_id=${props.invocationId}`
 );
 
 function routeToPath() {
@@ -45,7 +49,7 @@ function routeToPath() {
     <BButton
         id="workflow-run-button"
         v-b-tooltip.hover.top.html.noninteractive
-        :title="title ?? 'Run workflow'"
+        :title="title ?? `${props.invocationId ? 'Rerun' : 'Run'} Workflow`"
         :data-workflow-run="id"
         :variant="variant"
         size="sm"
@@ -55,6 +59,6 @@ function routeToPath() {
         @click="routeToPath">
         <FontAwesomeIcon :icon="faPlay" fixed-width />
 
-        <span v-if="full" v-localize>Run Workflow</span>
+        <span v-if="full" v-localize> {{ props.invocationId ? "Rerun" : "Run" }} Workflow </span>
     </BButton>
 </template>
diff --git a/client/src/entry/analysis/router.js b/client/src/entry/analysis/router.js
@@ -86,6 +86,7 @@ import Sharing from "@/components/Sharing/SharingPage.vue";
 import HistoryStorageOverview from "@/components/User/DiskUsage/Visualizations/HistoryStorageOverview.vue";
 import UserDatasetPermissions from "@/components/User/UserDatasetPermissions.vue";
 import WorkflowPublished from "@/components/Workflow/Published/WorkflowPublished.vue";
+import WorkflowRerun from "@/components/Workflow/Run/WorkflowRerun.vue";
 import WorkflowRun from "@/components/Workflow/Run/WorkflowRun.vue";
 import WorkflowInvocationState from "@/components/WorkflowInvocationState/WorkflowInvocationState.vue";
 
@@ -696,6 +697,14 @@ export function getRouter(Galaxy) {
                             simpleFormUseJobCache: Galaxy.config.simplified_workflow_run_ui_job_cache === "on",
                         }),
                     },
+                    {
+                        path: "workflows/rerun",
+                        component: WorkflowRerun,
+                        redirect: redirectAnon(),
+                        props: (route) => ({
+                            invocationId: route.query.invocation_id,
+                        }),
+                    },
                     {
                         path: "workflows/sharing",
                         component: Sharing,
diff --git a/client/src/stores/invocationStore.ts b/client/src/stores/invocationStore.ts
@@ -2,7 +2,12 @@ import { defineStore } from "pinia";
 import { ref } from "vue";
 
 import { GalaxyApi } from "@/api";
-import { type InvocationJobsSummary, type InvocationStep, type WorkflowInvocation } from "@/api/invocations";
+import {
+    type InvocationJobsSummary,
+    type InvocationStep,
+    type WorkflowInvocation,
+    type WorkflowInvocationRequest,
+} from "@/api/invocations";
 import { type FetchParams, useKeyedCache } from "@/composables/keyedCache";
 import type { GraphStep } from "@/composables/useInvocationGraph";
 import { rethrowSimple } from "@/utils/simple-error";
@@ -42,6 +47,20 @@ export const useInvocationStore = defineStore("invocationStore", () => {
         return data;
     }
 
+    async function fetchInvocationRequest(params: FetchParams): Promise<WorkflowInvocationRequest> {
+        const { data, error } = await GalaxyApi().GET("/api/invocations/{invocation_id}/request", {
+            params: {
+                path: {
+                    invocation_id: params.id,
+                },
+            },
+        });
+        if (error) {
+            rethrowSimple(error);
+        }
+        return data;
+    }
+
     async function cancelWorkflowScheduling(invocationId: string) {
         const { data, error } = await GalaxyApi().DELETE("/api/invocations/{invocation_id}", {
             params: {
@@ -69,6 +88,8 @@ export const useInvocationStore = defineStore("invocationStore", () => {
     const { getItemById: getInvocationStepById, fetchItemById: fetchInvocationStepById } =
         useKeyedCache<InvocationStep>(fetchInvocationStep);
 
+    const { getItemById: getInvocationRequestById } = useKeyedCache<WorkflowInvocationRequest>(fetchInvocationRequest);
+
     return {
         cancelWorkflowScheduling,
         fetchInvocationById,
@@ -78,6 +99,7 @@ export const useInvocationStore = defineStore("invocationStore", () => {
         getInvocationJobsSummaryById,
         getInvocationLoadError,
         getInvocationStepById,
+        getInvocationRequestById,
         graphStepsByStoreId,
         isLoadingInvocation,
     };
diff --git a/lib/galaxy/webapps/galaxy/buildapp.py b/lib/galaxy/webapps/galaxy/buildapp.py
@@ -290,6 +290,7 @@ def app_pair(global_conf, load_app_kwds=None, wsgi_preflight=True, **kwargs):
     webapp.add_client_route("/workflows/edit")
     webapp.add_client_route("/workflows/export")
     webapp.add_client_route("/workflows/create")
+    webapp.add_client_route("/workflows/rerun")
     webapp.add_client_route("/workflows/run")
     webapp.add_client_route("/workflows/import")
     webapp.add_client_route("/workflows/trs_import")
