Add missing fields to results (#820)

* add missing fields to results

* add unit tests

* fix typecheck and add identity

* lint fix

* fix test case

Author: Assem-Uber

src/components/pretty-json/pretty-json.types.tsx

@@ -7,6 +7,7 @@ export type PrettyJsonValue =
   | number
   | boolean
   | null
+  | undefined
   | JsonObject
   | JsonArray
   | bigint;

src/views/workflow-summary-tab/helpers/__tests__/get-workflow-result-json.test.ts

@@ -4,6 +4,8 @@ import {
   type FormattedWorkflowExecutionFailedEvent,
   type FormattedWorkflowExecutionTerminatedEvent,
   type FormattedWorkflowExecutionTimedOutEvent,
+  type FormattedWorkflowExecutionContinuedAsNewEvent,
+  type FormattedTimerFiredEvent,
 } from '@/utils/data-formatters/schema/format-history-event-schema';
 
 import getWorkflowResultJson from '../get-workflow-result-json';
@@ -20,7 +22,7 @@ describe('getWorkflowResultJson', () => {
     expect(getWorkflowResultJson(formattedEvent)).toBe('canceled details');
   });
 
-  it('should return details for WorkflowExecutionFailed event', () => {
+  it('should return details and reason for WorkflowExecutionFailed event', () => {
     const formattedEvent: FormattedWorkflowExecutionFailedEvent = {
       eventType: 'WorkflowExecutionFailed',
       reason: 'cadenceInternal:Generic',
@@ -29,7 +31,10 @@ describe('getWorkflowResultJson', () => {
       timestamp: null,
       decisionTaskCompletedEventId: '1',
     };
-    expect(getWorkflowResultJson(formattedEvent)).toBe('failed details');
+    expect(getWorkflowResultJson(formattedEvent)).toEqual({
+      reason: 'cadenceInternal:Generic',
+      details: 'failed details',
+    });
   });
 
   it('should return details for WorkflowExecutionTerminated event', () => {
@@ -41,7 +46,11 @@ describe('getWorkflowResultJson', () => {
       timestamp: null,
       identity: '1111',
     };
-    expect(getWorkflowResultJson(formattedEvent)).toBe('terminated details');
+    expect(getWorkflowResultJson(formattedEvent)).toEqual({
+      reason: 'cadenceInternal:Generic',
+      details: 'terminated details',
+      identity: '1111',
+    });
   });
 
   it('should return result for WorkflowExecutionCompleted event', () => {
@@ -55,13 +64,55 @@ describe('getWorkflowResultJson', () => {
     expect(getWorkflowResultJson(formattedEvent)).toBe('completed result');
   });
 
-  it('should return undefined for other eventType', () => {
+  it('should return timeoutType for WorkflowExecutionTimedOut event', () => {
     const formattedEvent: FormattedWorkflowExecutionTimedOutEvent = {
       eventType: 'WorkflowExecutionTimedOut',
       eventId: 1,
       timeoutType: 'TIMEOUT_TYPE_HEARTBEAT',
       timestamp: null,
     };
+    expect(getWorkflowResultJson(formattedEvent)).toEqual({
+      timeoutType: 'TIMEOUT_TYPE_HEARTBEAT',
+    });
+  });
+
+  it('should return correct fields for WorkflowExecutionContinuedAsNew event', () => {
+    const formattedEvent: FormattedWorkflowExecutionContinuedAsNewEvent = {
+      backoffStartIntervalInSeconds: 0,
+      decisionTaskCompletedEventId: '',
+      eventId: 1,
+      eventType: 'WorkflowExecutionContinuedAsNew',
+      executionStartToCloseTimeoutSeconds: 0,
+      workflowType: null,
+      timestamp: null,
+      header: { fields: {} },
+      input: [],
+      memo: { fields: {} },
+      searchAttributes: { indexedFields: '' },
+      taskList: { kind: 'NORMAL', name: '' },
+      taskStartToCloseTimeoutSeconds: 0,
+      newExecutionRunId: '',
+      initiator: 'CRON_SCHEDULE',
+      failureDetails: 'Failure Details',
+      failureReason: 'Failure Reason',
+      lastCompletionResult: null,
+    };
+    expect(getWorkflowResultJson(formattedEvent)).toEqual({
+      initiator: 'CRON_SCHEDULE',
+      failureDetails: 'Failure Details',
+      failureReason: 'Failure Reason',
+      lastCompletionResult: null,
+    });
+  });
+
+  it('should return undefined for other eventType', () => {
+    const formattedEvent: FormattedTimerFiredEvent = {
+      eventType: 'TimerFired',
+      eventId: 3,
+      timestamp: null,
+      startedEventId: 2,
+      timerId: '1',
+    };
     expect(getWorkflowResultJson(formattedEvent)).toBeUndefined();
   });
 

src/views/workflow-summary-tab/helpers/get-workflow-result-json.ts

@@ -1,15 +1,52 @@
-import { type FormattedHistoryEvent } from '@/utils/data-formatters/schema/format-history-event-schema';
+import {
+  type FormattedHistoryEventForType,
+  type FormattedHistoryEvent,
+} from '@/utils/data-formatters/schema/format-history-event-schema';
 
 export default function getWorkflowResultJson(
   formattedEvent: FormattedHistoryEvent
 ) {
   const eventType = formattedEvent.eventType;
-  if (
-    eventType === 'WorkflowExecutionCanceled' ||
-    eventType === 'WorkflowExecutionFailed' ||
-    eventType === 'WorkflowExecutionTerminated'
-  )
+  if (eventType === 'WorkflowExecutionFailed') {
+    const { reason, details } = formattedEvent;
+    return { reason, details };
+  }
+  if (eventType === 'WorkflowExecutionTerminated') {
+    const { details, reason, identity } = formattedEvent;
+    return { reason, details, identity };
+  }
+
+  if (eventType === 'WorkflowExecutionContinuedAsNew') {
+    const { initiator, failureDetails, failureReason, lastCompletionResult } =
+      formattedEvent;
+    const result: Partial<
+      Pick<
+        FormattedHistoryEventForType<'WorkflowExecutionContinuedAsNew'>,
+        | 'initiator'
+        | 'lastCompletionResult'
+        | 'failureDetails'
+        | 'failureReason'
+      >
+    > = {
+      initiator,
+      lastCompletionResult,
+    };
+    // only add failure fields if it was failed not to confuse user
+    if (failureDetails || failureReason) {
+      result.failureDetails = failureDetails;
+      result.failureReason = failureReason;
+    }
+    return result;
+  }
+
+  if (eventType === 'WorkflowExecutionTimedOut') {
+    const { timeoutType } = formattedEvent;
+    return { timeoutType };
+  }
+
+  if (eventType === 'WorkflowExecutionCanceled') {
     return formattedEvent.details;
+  }
 
   if (eventType === 'WorkflowExecutionCompleted') return formattedEvent.result;
 

src/views/workflow-summary-tab/workflow-summary-tab.tsx

@@ -60,9 +60,9 @@ export default function WorkflowSummaryTab({
     ? formatWorkflowHistoryEvent(closeEvent)
     : null;
 
-  const resultJson = formattedCloseEvent
-    ? getWorkflowResultJson(formattedCloseEvent)
-    : undefined;
+  const resultJson = (
+    formattedCloseEvent ? getWorkflowResultJson(formattedCloseEvent) : undefined
+  ) as PrettyJsonValue;
 
   const isWorkflowRunning =
     !closeEvent ||