From 208739708793e53af7c08948a898ffb21b4a18c7 Mon Sep 17 00:00:00 2001
From: mvdbeek <m.vandenbeek@gmail.com>
Date: Tue, 27 Aug 2024 17:32:57 +0200
Subject: [PATCH] Use canonical invocation message type from openapi schema

---
 client/src/api/invocations.ts                 |   1 +
 .../InvocationMessage.vue                     |   5 +-
 .../invocationMessageModel.ts                 | 250 ------------------
 3 files changed, 3 insertions(+), 253 deletions(-)
 delete mode 100644 client/src/components/WorkflowInvocationState/invocationMessageModel.ts

diff --git a/client/src/api/invocations.ts b/client/src/api/invocations.ts
index 2196f9a9254e..00817980ab40 100644
--- a/client/src/api/invocations.ts
+++ b/client/src/api/invocations.ts
@@ -8,6 +8,7 @@ export type WorkflowInvocationElementView = components["schemas"]["WorkflowInvoc
 export type WorkflowInvocationCollectionView = components["schemas"]["WorkflowInvocationCollectionView"];
 export type InvocationJobsSummary = components["schemas"]["InvocationJobsResponse"];
 export type InvocationStep = components["schemas"]["InvocationStep"];
+export type InvocationMessage = components["schemas"]["WorkflowInvocationElementView"]["messages"][0];
 
 export type StepJobSummary =
     | components["schemas"]["InvocationStepJobsResponseStepModel"]
diff --git a/client/src/components/WorkflowInvocationState/InvocationMessage.vue b/client/src/components/WorkflowInvocationState/InvocationMessage.vue
index 7c1561576f39..ffea05f86e19 100644
--- a/client/src/components/WorkflowInvocationState/InvocationMessage.vue
+++ b/client/src/components/WorkflowInvocationState/InvocationMessage.vue
@@ -1,10 +1,9 @@
 <script setup lang="ts">
 import { computed } from "vue";
 
+import type { InvocationMessage } from "@/api/invocations";
 import { useWorkflowInstance } from "@/composables/useWorkflowInstance";
 
-import type { InvocationMessageResponseModel } from "./invocationMessageModel";
-
 import GenericHistoryItem from "@/components/History/Content/GenericItem.vue";
 import JobInformation from "@/components/JobInformation/JobInformation.vue";
 import WorkflowInvocationStep from "@/components/WorkflowInvocationState/WorkflowInvocationStep.vue";
@@ -49,7 +48,7 @@ interface Invocation {
 }
 
 interface InvocationMessageProps {
-    invocationMessage: InvocationMessageResponseModel;
+    invocationMessage: InvocationMessage;
     invocation: Invocation;
 }
 
diff --git a/client/src/components/WorkflowInvocationState/invocationMessageModel.ts b/client/src/components/WorkflowInvocationState/invocationMessageModel.ts
deleted file mode 100644
index 29ab6a989847..000000000000
--- a/client/src/components/WorkflowInvocationState/invocationMessageModel.ts
+++ /dev/null
@@ -1,250 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
-/* This file was automatically generated from pydantic models by running pydantic2ts.
-/* Do not modify it by hand - just update the pydantic models and then re-run the script
-*/
-
-export type InvocationMessageResponseModel =
-    | GenericInvocationCancellationReviewFailedEncodedDatabaseIdField
-    | GenericInvocationCancellationHistoryDeletedEncodedDatabaseIdField
-    | GenericInvocationCancellationUserRequestEncodedDatabaseIdField
-    | GenericInvocationFailureDatasetFailedEncodedDatabaseIdField
-    | GenericInvocationFailureCollectionFailedEncodedDatabaseIdField
-    | GenericInvocationFailureJobFailedEncodedDatabaseIdField
-    | GenericInvocationFailureOutputNotFoundEncodedDatabaseIdField
-    | GenericInvocationFailureExpressionEvaluationFailedEncodedDatabaseIdField
-    | GenericInvocationFailureWhenNotBooleanEncodedDatabaseIdField
-    | GenericInvocationUnexpectedFailureEncodedDatabaseIdField
-    | GenericInvocationEvaluationWarningWorkflowOutputNotFoundEncodedDatabaseIdField;
-
-export interface GenericInvocationCancellationHistoryDeletedEncodedDatabaseIdField {
-    reason: "history_deleted";
-    /**
-     * History ID of history that was deleted.
-     */
-    history_id: string;
-}
-export interface GenericInvocationCancellationHistoryDeletedInt {
-    reason: "history_deleted";
-    /**
-     * History ID of history that was deleted.
-     */
-    history_id: number;
-}
-export interface GenericInvocationCancellationReviewFailedEncodedDatabaseIdField {
-    reason: "cancelled_on_review";
-    /**
-     * Workflow step id of paused step that did not pass review.
-     */
-    workflow_step_id: number;
-}
-export interface GenericInvocationCancellationReviewFailedInt {
-    reason: "cancelled_on_review";
-    /**
-     * Workflow step id of paused step that did not pass review.
-     */
-    workflow_step_id: number;
-}
-export interface GenericInvocationCancellationUserRequestEncodedDatabaseIdField {
-    reason: "user_request";
-}
-export interface GenericInvocationCancellationUserRequestInt {
-    reason: "user_request";
-}
-export interface GenericInvocationEvaluationWarningWorkflowOutputNotFoundEncodedDatabaseIdField {
-    reason: "workflow_output_not_found";
-    workflow_step_id: number;
-    /**
-     * Output that was designated as workflow output but that has not been found
-     */
-    output_name: string;
-}
-export interface GenericInvocationEvaluationWarningWorkflowOutputNotFoundInt {
-    reason: "workflow_output_not_found";
-    workflow_step_id: number;
-    /**
-     * Output that was designated as workflow output but that has not been found
-     */
-    output_name: string;
-}
-export interface GenericInvocationFailureCollectionFailedEncodedDatabaseIdField {
-    reason: "collection_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * HistoryDatasetCollectionAssociation ID that relates to failure.
-     */
-    hdca_id: string;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id: number;
-}
-export interface GenericInvocationFailureCollectionFailedInt {
-    reason: "collection_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * HistoryDatasetCollectionAssociation ID that relates to failure.
-     */
-    hdca_id: number;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id: number;
-}
-export interface GenericInvocationFailureDatasetFailedEncodedDatabaseIdField {
-    reason: "dataset_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * HistoryDatasetAssociation ID that relates to failure.
-     */
-    hda_id: string;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id?: number;
-}
-export interface GenericInvocationFailureDatasetFailedInt {
-    reason: "dataset_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * HistoryDatasetAssociation ID that relates to failure.
-     */
-    hda_id: number;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id?: number;
-}
-export interface GenericInvocationFailureExpressionEvaluationFailedEncodedDatabaseIdField {
-    reason: "expression_evaluation_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * May contain details to help troubleshoot this problem.
-     */
-    details?: string;
-}
-export interface GenericInvocationFailureExpressionEvaluationFailedInt {
-    reason: "expression_evaluation_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * May contain details to help troubleshoot this problem.
-     */
-    details?: string;
-}
-export interface GenericInvocationFailureJobFailedEncodedDatabaseIdField {
-    reason: "job_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * Job ID that relates to failure.
-     */
-    job_id: string;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id: number;
-}
-export interface GenericInvocationFailureJobFailedInt {
-    reason: "job_failed";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * Job ID that relates to failure.
-     */
-    job_id: number;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id: number;
-}
-export interface GenericInvocationFailureOutputNotFoundEncodedDatabaseIdField {
-    reason: "output_not_found";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    output_name: string;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id: number;
-}
-export interface GenericInvocationFailureOutputNotFoundInt {
-    reason: "output_not_found";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    output_name: string;
-    /**
-     * Workflow step id of step that caused failure.
-     */
-    dependent_workflow_step_id: number;
-}
-export interface GenericInvocationFailureWhenNotBooleanEncodedDatabaseIdField {
-    reason: "when_not_boolean";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * Contains details to help troubleshoot this problem.
-     */
-    details: string;
-}
-export interface GenericInvocationFailureWhenNotBooleanInt {
-    reason: "when_not_boolean";
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id: number;
-    /**
-     * Contains details to help troubleshoot this problem.
-     */
-    details: string;
-}
-export interface GenericInvocationUnexpectedFailureEncodedDatabaseIdField {
-    reason: "unexpected_failure";
-    /**
-     * May contains details to help troubleshoot this problem.
-     */
-    details?: string;
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id?: number;
-}
-export interface GenericInvocationUnexpectedFailureInt {
-    reason: "unexpected_failure";
-    /**
-     * May contains details to help troubleshoot this problem.
-     */
-    details?: string;
-    /**
-     * Workflow step id of step that failed.
-     */
-    workflow_step_id?: number;
-}