use newly updated PUT /api/workflows/{workflow_id} in client

Author: ahmedhamidawan

client/src/api/schema/schema.ts

@@ -5,6 +5,7 @@ import { GalaxyApi } from "./client";
 
 export type Creator = components["schemas"]["Person"] | components["schemas"]["galaxy__schema__schema__Organization"];
 export type StoredWorkflowDetailed = components["schemas"]["StoredWorkflowDetailed"];
+export type UpdateWorkflowPayload = components["schemas"]["UpdateWorkflowPayload"];
 
 //TODO: replace with generated schema model when available
 export type WorkflowSummary = {
@@ -118,6 +119,23 @@ export async function undeleteWorkflow(id: string): Promise<WorkflowSummary> {
     return data as WorkflowSummary;
 }
 
+export async function updateWorkflow(id: string, payload: UpdateWorkflowPayload): Promise<WorkflowSummary> {
+    const { data, error } = await GalaxyApi().PUT("/api/workflows/{workflow_id}", {
+        params: {
+            path: {
+                workflow_id: id,
+            },
+        },
+        body: payload,
+    });
+
+    if (error) {
+        rethrowSimple(error);
+    }
+
+    return data as WorkflowSummary;
+}
+
 export function hasCreator(entry?: AnyWorkflow): entry is StoredWorkflowDetailed {
     return entry !== undefined && "creator" in entry && !!entry.creator;
 }

client/src/api/workflows.ts

@@ -1,3 +1,4 @@
+import type { UpdateWorkflowPayload } from "@/api/workflows";
 import reportDefault from "@/components/Workflow/Editor/reportDefault";
 import { useWorkflowCommentStore, type WorkflowComment } from "@/stores/workflowEditorCommentStore";
 import { useWorkflowStateStore } from "@/stores/workflowEditorStateStore";
@@ -134,8 +135,9 @@ export async function fromSimple(
     toolbarStore.currentTool = "pointer";
 }
 
-export function toSimple(id: string, workflow: Workflow): Omit<Workflow, "version"> {
-    const steps = workflow.steps;
+export function toSimple(id: string, workflow: Workflow): UpdateWorkflowPayload {
+    // TODO: This is a temporary workaround; we need to use the backend types for `Steps` in the stores.
+    const steps = workflow.steps as any;
     const report = workflow.report;
     const license = workflow.license;
     const creator = workflow.creator;
@@ -146,12 +148,29 @@ export function toSimple(id: string, workflow: Workflow): Omit<Workflow, "versio
     const readme = workflow.readme;
     const help = workflow.help;
     const doi = workflow.doi;
+    const update_stored_workflow_attributes = true;
+    const exact_tools = true;
 
     const commentStore = useWorkflowCommentStore(id);
     commentStore.resolveCommentsInFrames();
     commentStore.resolveStepsInFrames();
 
     const comments = workflow.comments.filter((comment) => !(comment.type === "text" && comment.data.text === ""));
 
-    return { steps, report, license, creator, annotation, name, comments, tags, readme, help, logo_url, doi };
+    return {
+        steps,
+        report,
+        license,
+        creator,
+        annotation,
+        name,
+        comments,
+        tags,
+        readme,
+        help,
+        logo_url,
+        doi,
+        update_stored_workflow_attributes,
+        exact_tools,
+    };
 }

client/src/components/Workflow/Editor/modules/model.ts

@@ -1,11 +1,13 @@
 import axios from "axios";
-import { getAppRoot } from "onload/loadConfig";
-import { errorMessageAsString, rethrowSimple } from "utils/simple-error";
 
-import { toSimple } from "./model";
+import { updateWorkflow, type WorkflowSummary } from "@/api/workflows";
+import { getAppRoot } from "@/onload/loadConfig";
+import { errorMessageAsString, rethrowSimple } from "@/utils/simple-error";
+
+import { toSimple, type Workflow } from "./model";
 
 /** Workflow data request helper **/
-export async function getVersions(id) {
+export async function getVersions(id: string) {
     try {
         const { data } = await axios.get(`${getAppRoot()}api/workflows/${id}/versions`);
         return data;
@@ -14,7 +16,11 @@ export async function getVersions(id) {
     }
 }
 
-export async function getModule(request_data, stepId, setLoadingState) {
+export async function getModule(
+    request_data: Record<string, any>,
+    stepId: number,
+    setLoadingState: (stepId: number, loading: boolean, error?: string) => void
+) {
     setLoadingState(stepId, true);
     try {
         const { data } = await axios.post(`${getAppRoot()}api/workflows/build_module`, request_data);
@@ -26,7 +32,7 @@ export async function getModule(request_data, stepId, setLoadingState) {
     }
 }
 
-export async function refactor(id, actions, dryRun = false) {
+export async function refactor(id: string, actions: Record<string, any>, dryRun = false) {
     try {
         const requestData = {
             actions: actions,
@@ -40,7 +46,7 @@ export async function refactor(id, actions, dryRun = false) {
     }
 }
 
-export async function loadWorkflow({ id, version = null }) {
+export async function loadWorkflow({ id, version = null }: { id: string; version?: number | null }) {
     try {
         const versionQuery = Number.isInteger(version) ? `version=${version}` : "";
         const { data } = await axios.get(`${getAppRoot()}workflow/load_workflow?_=true&id=${id}&${versionQuery}`);
@@ -51,11 +57,16 @@ export async function loadWorkflow({ id, version = null }) {
     }
 }
 
-export async function saveWorkflow(workflow) {
+// TODO: The backend return will be typed as the update response
+type WorkflowSummaryExtended = WorkflowSummary & {
+    version: number;
+    annotation: string;
+};
+export async function saveWorkflow(workflow: Record<string, any>) {
     if (workflow.hasChanges) {
         try {
-            const requestData = { workflow: toSimple(workflow.id, workflow), from_tool_form: true };
-            const { data } = await axios.put(`${getAppRoot()}api/workflows/${workflow.id}`, requestData);
+            const requestData = { ...toSimple(workflow.id, workflow as Workflow), from_tool_form: true };
+            const data = (await updateWorkflow(workflow.id, requestData)) as WorkflowSummaryExtended;
             workflow.name = data.name;
             workflow.hasChanges = false;
             workflow.stored = true;
@@ -71,7 +82,7 @@ export async function saveWorkflow(workflow) {
     return {};
 }
 
-export async function getToolPredictions(requestData) {
+export async function getToolPredictions(requestData: Record<string, any>) {
     try {
         const { data } = await axios.post(`${getAppRoot()}api/workflows/get_tool_predictions`, requestData);
         return data;

…ents/Workflow/Editor/modules/services.js …ents/Workflow/Editor/modules/services.tsclient/src/components/Workflow/Editor/modules/services.js renamed to client/src/components/Workflow/Editor/modules/services.ts client/src/components/Workflow/Editor/modules/services.js renamed to client/src/components/Workflow/Editor/modules/services.ts

@@ -3,10 +3,10 @@ import { storeToRefs } from "pinia";
 import { computed } from "vue";
 
 import type { WorkflowSummary } from "@/api/workflows";
+import { updateWorkflow } from "@/api/workflows";
 import { useWorkflowCardActions } from "@/components/Workflow/List/useWorkflowCardActions";
 import { useWorkflowCardBadges } from "@/components/Workflow/List/useWorkflowCardBadges";
 import { useWorkflowCardIndicators } from "@/components/Workflow/List/useWorkflowCardIndicators";
-import { updateWorkflow } from "@/components/Workflow/workflows.services";
 import { useUserStore } from "@/stores/userStore";
 
 import GCard from "@/components/Common/GCard.vue";
@@ -65,7 +65,7 @@ const description = computed(() => {
 
 async function onTagsUpdate(tags: string[]) {
     workflow.value.tags = tags;
-    await updateWorkflow(workflow.value.id, { tags });
+    await updateWorkflow(workflow.value.id, { tags, update_stored_workflow_attributes: true, exact_tools: true });
     emit("refreshList", true, true);
 }
 

client/src/components/Workflow/List/WorkflowCard.vue

@@ -7,9 +7,9 @@ import { filter } from "underscore";
 import { computed, onMounted, ref, watch } from "vue";
 import { useRouter } from "vue-router/composables";
 
-import { loadWorkflows, undeleteWorkflow, type WorkflowSummary } from "@/api/workflows";
+import { loadWorkflows, undeleteWorkflow, updateWorkflow, type WorkflowSummary } from "@/api/workflows";
 import { getWorkflowFilters, helpHtml } from "@/components/Workflow/List/workflowFilters";
-import { deleteWorkflow, updateWorkflow } from "@/components/Workflow/workflows.services";
+import { deleteWorkflow } from "@/components/Workflow/workflows.services";
 import { useConfirmDialog } from "@/composables/confirmDialog";
 import { Toast } from "@/composables/toast";
 import { useUserStore } from "@/stores/userStore";
@@ -306,7 +306,11 @@ async function onBulkTagsAdd(tags: string[]) {
         for (const w of selectedWorkflowIds.value) {
             const prevTags = workflowsLoaded.value.find((workflow) => workflow.id === w.id)?.tags || [];
 
-            await updateWorkflow(w.id, { tags: [...new Set([...prevTags, ...tags])] });
+            await updateWorkflow(w.id, {
+                tags: [...new Set([...prevTags, ...tags])],
+                update_stored_workflow_attributes: true,
+                exact_tools: true,
+            });
 
             tmpSelected.splice(
                 tmpSelected.findIndex((s) => s.id === w.id),

client/src/components/Workflow/List/WorkflowList.vue

@@ -2,7 +2,7 @@
 import { BForm, BFormInput, BModal } from "bootstrap-vue";
 import { ref } from "vue";
 
-import { updateWorkflow } from "@/components/Workflow/workflows.services";
+import { updateWorkflow } from "@/api/workflows";
 import { Toast } from "@/composables/toast";
 import localize from "@/utils/localization";
 
@@ -26,7 +26,7 @@ const workflowNameInput = ref<HTMLInputElement | null>(null);
 
 async function onRename(newName: string) {
     try {
-        await updateWorkflow(props.id, { name: newName });
+        await updateWorkflow(props.id, { name: newName, update_stored_workflow_attributes: true, exact_tools: true });
         Toast.success("Workflow renamed");
     } catch (e) {
         Toast.error("Failed to rename workflow");

client/src/components/Workflow/List/WorkflowRename.vue

@@ -16,13 +16,12 @@ import { storeToRefs } from "pinia";
 import { computed, type Ref } from "vue";
 
 import type { WorkflowSummary } from "@/api/workflows";
-import { undeleteWorkflow } from "@/api/workflows";
+import { undeleteWorkflow, updateWorkflow as updateWorkflowService } from "@/api/workflows";
 import { getFullAppUrl } from "@/app/utils";
 import type { CardAttributes } from "@/components/Common/GCard.types";
 import {
     copyWorkflow as copyWorkflowService,
     deleteWorkflow as deleteWorkflowService,
-    updateWorkflow as updateWorkflowService,
 } from "@/components/Workflow/workflows.services";
 import { useConfirmDialog } from "@/composables/confirmDialog";
 import { useToast } from "@/composables/toast";
@@ -109,6 +108,8 @@ export function useWorkflowCardActions(
         try {
             await updateWorkflowService(workflow.value.id, {
                 show_in_tool_panel: checked,
+                update_stored_workflow_attributes: true,
+                exact_tools: true,
             });
 
             toast.info(`Workflow ${checked ? "added to" : "removed from"} bookmarks`);

client/src/components/Workflow/List/useWorkflowCardActions.ts

@@ -4,11 +4,6 @@ import type { WorkflowSummary } from "@/api/workflows";
 import { useUserStore } from "@/stores/userStore";
 import { withPrefix } from "@/utils/redirect";
 
-export async function updateWorkflow(id: string, changes: object): Promise<WorkflowSummary> {
-    const { data } = await axios.put(withPrefix(`/api/workflows/${id}`), changes);
-    return data;
-}
-
 export async function copyWorkflow(id: string, currentOwner?: string, version?: string): Promise<WorkflowSummary> {
     let path = `/api/workflows/${id}/download`;
     if (version) {