Add negativeFields to event metadata (#954)

adhityamamallan · Assem-Uber · web-flow · commit c2a53273ff85 · 2025-07-21T17:39:29.000+02:00
* Add negativeFields to event metadata

* Address copilot comment

---------

Co-authored-by: Assem Hafez &lt;137278762+Assem-Uber@users.noreply.github.com&gt;
diff --git a/src/views/workflow-history/helpers/__tests__/get-common-history-group-fields.test.ts b/src/views/workflow-history/helpers/__tests__/get-common-history-group-fields.test.ts
@@ -130,6 +130,57 @@ describe('getCommonHistoryGroupFields', () => {
       });
     }
   );
+
+  it('should include negativeFields when eventStatusToNegativeFieldsMap is provided', () => {
+    const eventStatusToNegativeFieldsMap = {
+      timerStartedEventAttributes: ['startReason', 'startDetails'],
+      timerFiredEventAttributes: ['fireReason', 'fireDetails'],
+    };
+
+    const group = setup({
+      eventStatusToNegativeFieldsMap,
+    });
+
+    expect(group.eventsMetadata[0].negativeFields).toEqual([
+      'startReason',
+      'startDetails',
+    ]);
+    expect(group.eventsMetadata[1].negativeFields).toEqual([
+      'fireReason',
+      'fireDetails',
+    ]);
+  });
+
+  it('should not include negativeFields when eventStatusToNegativeFieldsMap is not provided', () => {
+    const group = setup({});
+
+    group.eventsMetadata.forEach((metadata) => {
+      expect(metadata.negativeFields).toBeUndefined();
+    });
+  });
+
+  it('should not include negativeFields when eventStatusToNegativeFieldsMap is empty', () => {
+    const group = setup({
+      eventStatusToNegativeFieldsMap: {},
+    });
+
+    group.eventsMetadata.forEach((metadata) => {
+      expect(metadata.negativeFields).toBeUndefined();
+    });
+  });
+
+  it('should only include negativeFields for events that have mappings', () => {
+    const eventStatusToNegativeFieldsMap = {
+      timerStartedEventAttributes: ['startReason'],
+    };
+
+    const group = setup({
+      eventStatusToNegativeFieldsMap,
+    });
+
+    expect(group.eventsMetadata[0].negativeFields).toEqual(['startReason']);
+    expect(group.eventsMetadata[1].negativeFields).toBeUndefined();
+  });
 });
 
 // using timer events for testing
@@ -139,6 +190,7 @@ function setup({
   eventToLabel,
   eventToStatus,
   closeEvent,
+  eventStatusToNegativeFieldsMap,
 }: {
   events?: TimerHistoryEvent[];
   eventToStatus?: HistoryGroupEventToStatusMap<TimerHistoryGroup>;
@@ -147,6 +199,7 @@ function setup({
     HistoryGroupEventToStringMap<TimerHistoryGroup>
   >;
   closeEvent?: TimerHistoryEvent;
+  eventStatusToNegativeFieldsMap?: any;
 }) {
   const mockEvents: TimerHistoryEvent[] = events || [
     startTimerTaskEvent,
@@ -170,6 +223,7 @@ function setup({
     mockedEventToStatus,
     mockedEventToLabel,
     eventToTimeLabelPrefixMap,
-    closeEvent
+    closeEvent,
+    eventStatusToNegativeFieldsMap
   );
 }
diff --git a/src/views/workflow-history/helpers/get-common-history-group-fields.ts b/src/views/workflow-history/helpers/get-common-history-group-fields.ts
@@ -3,6 +3,7 @@ import parseGrpcTimestamp from '@/utils/datetime/parse-grpc-timestamp';
 
 import { type WorkflowEventStatus } from '../workflow-history-event-status-badge/workflow-history-event-status-badge.types';
 import {
+  type HistoryGroupEventStatusToNegativeFieldsMap,
   type HistoryEventsGroup,
   type HistoryGroupEventToStatusMap,
   type HistoryGroupEventToStringMap,
@@ -12,10 +13,11 @@ export default function getCommonHistoryGroupFields<
   GroupT extends HistoryEventsGroup,
 >(
   events: GroupT['events'],
-  HistoryGroupEventToStatusMap: HistoryGroupEventToStatusMap<GroupT>,
+  historyGroupEventToStatusMap: HistoryGroupEventToStatusMap<GroupT>,
   eventToLabelMap: HistoryGroupEventToStringMap<GroupT>,
   eventToTimeLabelPrefixMap: Partial<HistoryGroupEventToStringMap<GroupT>>,
-  closeEvent: GroupT['events'][number] | null | undefined
+  closeEvent: GroupT['events'][number] | null | undefined,
+  eventStatusToNegativeFieldsMap?: HistoryGroupEventStatusToNegativeFieldsMap<GroupT>
 ): Pick<
   GroupT,
   | 'eventsMetadata'
@@ -28,7 +30,7 @@ export default function getCommonHistoryGroupFields<
 > {
   const eventsMetadata = events.map((event, index) => {
     const attrs = event.attributes as GroupT['events'][number]['attributes'];
-    const getEventStatus = HistoryGroupEventToStatusMap[attrs];
+    const getEventStatus = historyGroupEventToStatusMap[attrs];
     const eventStatus: WorkflowEventStatus =
       typeof getEventStatus === 'function'
         ? getEventStatus(event, events, index)
@@ -38,11 +40,14 @@ export default function getCommonHistoryGroupFields<
       ? eventToTimeLabelPrefixMap[attrs]
       : `${eventToLabelMap[attrs]} at`;
 
+    const negativeFields = eventStatusToNegativeFieldsMap?.[attrs];
+
     return {
       label: eventToLabelMap[attrs],
       status: eventStatus,
       timeMs,
       timeLabel: timeMs ? `${prefix} ${formatDate(timeMs)}` : '',
+      ...(negativeFields?.length ? { negativeFields } : {}),
     };
   });
 
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-activity-group-from-events.test.ts b/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-activity-group-from-events.test.ts
@@ -311,4 +311,53 @@ describe('getActivityGroupFromEvents', () => {
 
     expect(group.shortLabel).toBeUndefined();
   });
+
+  it('should include negativeFields for failed activity events', () => {
+    const events: ExtendedActivityHistoryEvent[] = [
+      scheduleActivityTaskEvent,
+      startActivityTaskEvent,
+      failedActivityTaskEvent,
+    ];
+    const group = getActivityGroupFromEvents(events);
+
+    // The failed event should have negativeFields
+    const failedEventMetadata = group.eventsMetadata.find(
+      (metadata) => metadata.status === 'FAILED'
+    );
+    expect(failedEventMetadata?.negativeFields).toEqual(['reason', 'details']);
+
+    // Other events should not have negativeFields
+    const otherEventsMetadata = group.eventsMetadata.filter(
+      (metadata) => metadata.status !== 'FAILED'
+    );
+    otherEventsMetadata.forEach((metadata) => {
+      expect(metadata.negativeFields).toBeUndefined();
+    });
+  });
+
+  it('should include negativeFields for timed out activity events', () => {
+    const events: ExtendedActivityHistoryEvent[] = [
+      scheduleActivityTaskEvent,
+      startActivityTaskEvent,
+      timeoutActivityTaskEvent,
+    ];
+    const group = getActivityGroupFromEvents(events);
+
+    // The timed out event should have negativeFields
+    const timedOutEventMetadata = group.eventsMetadata.find(
+      (metadata) => metadata.status === 'FAILED' // timeout events have FAILED status
+    );
+    expect(timedOutEventMetadata?.negativeFields).toEqual([
+      'reason',
+      'details',
+    ]);
+
+    // Other events should not have negativeFields
+    const otherEventsMetadata = group.eventsMetadata.filter(
+      (metadata) => metadata.status !== 'FAILED'
+    );
+    otherEventsMetadata.forEach((metadata) => {
+      expect(metadata.negativeFields).toBeUndefined();
+    });
+  });
 });
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-child-workflow-execution-group-from-events.test.ts b/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-child-workflow-execution-group-from-events.test.ts
@@ -228,4 +228,53 @@ describe('getChildWorkflowExecutionGroupFromEvents', () => {
     );
     expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
   });
+
+  it('should include negativeFields for failed child workflow events', () => {
+    const events: ChildWorkflowExecutionHistoryEvent[] = [
+      initiateChildWorkflowEvent,
+      startChildWorkflowEvent,
+      failChildWorkflowEvent,
+    ];
+    const group = getChildWorkflowExecutionGroupFromEvents(events);
+
+    // The failed event should have negativeFields
+    const failedEventMetadata = group.eventsMetadata.find(
+      (metadata) => metadata.status === 'FAILED'
+    );
+    expect(failedEventMetadata?.negativeFields).toEqual(['details', 'reason']);
+
+    // Other events should not have negativeFields
+    const otherEventsMetadata = group.eventsMetadata.filter(
+      (metadata) => metadata.status !== 'FAILED'
+    );
+    otherEventsMetadata.forEach((metadata) => {
+      expect(metadata.negativeFields).toBeUndefined();
+    });
+  });
+
+  it('should include negativeFields for timed out child workflow events', () => {
+    const events: ChildWorkflowExecutionHistoryEvent[] = [
+      initiateChildWorkflowEvent,
+      startChildWorkflowEvent,
+      timeoutChildWorkflowEvent,
+    ];
+    const group = getChildWorkflowExecutionGroupFromEvents(events);
+
+    // The timed out event should have negativeFields
+    const timedOutEventMetadata = group.eventsMetadata.find(
+      (metadata) => metadata.status === 'FAILED' // timeout events have FAILED status
+    );
+    expect(timedOutEventMetadata?.negativeFields).toEqual([
+      'details',
+      'reason',
+    ]);
+
+    // Other events should not have negativeFields
+    const otherEventsMetadata = group.eventsMetadata.filter(
+      (metadata) => metadata.status !== 'FAILED'
+    );
+    otherEventsMetadata.forEach((metadata) => {
+      expect(metadata.negativeFields).toBeUndefined();
+    });
+  });
 });
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-decision-group-from-events.test.ts b/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-decision-group-from-events.test.ts
@@ -310,4 +310,27 @@ describe('getDecisionGroupFromEvents', () => {
     ]);
     expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
   });
+
+  it('should include negativeFields for failed decision events', () => {
+    const events: ExtendedDecisionHistoryEvent[] = [
+      scheduleDecisionTaskEvent,
+      startDecisionTaskEvent,
+      failedDecisionTaskEvent,
+    ];
+    const group = getDecisionGroupFromEvents(events);
+
+    // The failed event should have negativeFields
+    const failedEventMetadata = group.eventsMetadata.find(
+      (metadata) => metadata.status === 'FAILED'
+    );
+    expect(failedEventMetadata?.negativeFields).toEqual(['reason', 'details']);
+
+    // Other events should not have negativeFields
+    const otherEventsMetadata = group.eventsMetadata.filter(
+      (metadata) => metadata.status !== 'FAILED'
+    );
+    otherEventsMetadata.forEach((metadata) => {
+      expect(metadata.negativeFields).toBeUndefined();
+    });
+  });
 });
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-single-event-group-from-events.test.ts b/src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-single-event-group-from-events.test.ts
@@ -138,4 +138,35 @@ describe('getSingleEventGroupFromEvents', () => {
       expect(group.closeTimeMs).toEqual(null);
     }
   });
+
+  it('should include negativeFields for failed workflow execution events', () => {
+    const group = getSingleEventGroupFromEvents([failWorkflowExecutionEvent]);
+    const eventMetadata = group.eventsMetadata[0];
+
+    expect(eventMetadata.status).toBe('FAILED');
+    expect(eventMetadata.negativeFields).toEqual(['details', 'reason']);
+  });
+
+  it('should include negativeFields for terminated workflow execution events', () => {
+    const group = getSingleEventGroupFromEvents([
+      terminateWorkflowExecutionEvent,
+    ]);
+    const eventMetadata = group.eventsMetadata[0];
+
+    expect(eventMetadata.status).toBe('FAILED');
+    expect(eventMetadata.negativeFields).toEqual(['details', 'reason']);
+  });
+
+  it('should include negativeFields for continued as new workflow execution events', () => {
+    const group = getSingleEventGroupFromEvents([
+      continueAsNewWorkflowExecutionEvent,
+    ]);
+    const eventMetadata = group.eventsMetadata[0];
+
+    expect(eventMetadata.status).toBe('COMPLETED');
+    expect(eventMetadata.negativeFields).toEqual([
+      'failureDetails',
+      'failureReason',
+    ]);
+  });
 });
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/get-activity-group-from-events.ts b/src/views/workflow-history/helpers/get-history-group-from-events/get-activity-group-from-events.ts
@@ -2,6 +2,7 @@ import WORKFLOW_HISTORY_SHOULD_SHORTEN_GROUP_LABELS_CONFIG from '../../config/wo
 import type {
   ActivityHistoryGroup,
   ExtendedActivityHistoryEvent,
+  HistoryGroupEventStatusToNegativeFieldsMap,
   HistoryGroupEventToStatusMap,
   HistoryGroupEventToStringMap,
   PendingActivityTaskStartEvent,
@@ -103,6 +104,12 @@ export default function getActivityGroupFromEvents(
     activityTaskTimedOutEventAttributes: 'FAILED',
   };
 
+  const eventStatusToNegativeFields: HistoryGroupEventStatusToNegativeFieldsMap<ActivityHistoryGroup> =
+    {
+      activityTaskFailedEventAttributes: ['reason', 'details'],
+      activityTaskTimedOutEventAttributes: ['reason', 'details'],
+    };
+
   const pendingStartEventTimePrefix = pendingStartEvent?.[pendingStartAttr]
     .lastStartedTime
     ? 'Last started at'
@@ -119,7 +126,8 @@ export default function getActivityGroupFromEvents(
       eventToStatus,
       eventToLabel,
       { pendingActivityTaskStartEventAttributes: pendingStartEventTimePrefix },
-      closeEvent || timeoutEvent
+      closeEvent || timeoutEvent,
+      eventStatusToNegativeFields
     ),
   };
 }
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/get-child-workflow-execution-group-from-events.ts b/src/views/workflow-history/helpers/get-history-group-from-events/get-child-workflow-execution-group-from-events.ts
@@ -1,6 +1,7 @@
 import type {
   ChildWorkflowExecutionHistoryEvent,
   ChildWorkflowExecutionHistoryGroup,
+  HistoryGroupEventStatusToNegativeFieldsMap,
   HistoryGroupEventToStatusMap,
   HistoryGroupEventToStringMap,
 } from '../../workflow-history.types';
@@ -73,6 +74,12 @@ export default function getChildWorkflowExecutionGroupFromEvents(
       childWorkflowExecutionTerminatedEventAttributes: 'FAILED',
     };
 
+  const eventStatusToNegativeFields: HistoryGroupEventStatusToNegativeFieldsMap<ChildWorkflowExecutionHistoryGroup> =
+    {
+      childWorkflowExecutionFailedEventAttributes: ['details', 'reason'],
+      childWorkflowExecutionTimedOutEventAttributes: ['details', 'reason'],
+    };
+
   return {
     label,
     hasMissingEvents,
@@ -82,7 +89,8 @@ export default function getChildWorkflowExecutionGroupFromEvents(
       eventToStatus,
       eventToLabel,
       {},
-      closeEvent || startFailedEvent
+      closeEvent || startFailedEvent,
+      eventStatusToNegativeFields
     ),
   };
 }
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/get-decision-group-from-events.ts b/src/views/workflow-history/helpers/get-history-group-from-events/get-decision-group-from-events.ts
@@ -1,6 +1,7 @@
 import type {
   DecisionHistoryGroup,
   ExtendedDecisionHistoryEvent,
+  HistoryGroupEventStatusToNegativeFieldsMap,
   HistoryGroupEventToStatusMap,
   HistoryGroupEventToStringMap,
   PendingDecisionTaskStartEvent,
@@ -101,6 +102,11 @@ export default function getDecisionGroupFromEvents(
     ? 'Started at'
     : 'Scheduled at';
 
+  const eventStatusToNegativeFields: HistoryGroupEventStatusToNegativeFieldsMap<DecisionHistoryGroup> =
+    {
+      decisionTaskFailedEventAttributes: ['reason', 'details'],
+    };
+
   return {
     label,
     hasMissingEvents,
@@ -114,7 +120,8 @@ export default function getDecisionGroupFromEvents(
       {
         pendingDecisionTaskStartEventAttributes: pendingStartEventTimePrefix,
       },
-      closeEvent || timeoutEvent
+      closeEvent || timeoutEvent,
+      eventStatusToNegativeFields
     ),
   };
 }
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/get-signal-external-workflow-execution-group-from-events.ts b/src/views/workflow-history/helpers/get-history-group-from-events/get-signal-external-workflow-execution-group-from-events.ts
diff --git a/src/views/workflow-history/helpers/get-history-group-from-events/get-single-event-group-from-events.ts b/src/views/workflow-history/helpers/get-history-group-from-events/get-single-event-group-from-events.ts
diff --git a/src/views/workflow-history/workflow-history.types.ts b/src/views/workflow-history/workflow-history.types.ts
