Add closeTimeMs to history group events (#910)

Author: Assem-Uber

src/views/workflow-history/helpers/__tests__/get-common-history-group-fields.test.ts

@@ -80,6 +80,18 @@ describe('getCommonHistoryGroupFields', () => {
     );
   });
 
+  it('should return group with closeTimeMs equal to closeEvent timeMs', () => {
+    const group = setup({
+      closeEvent: fireTimerTaskEvent,
+    });
+    expect(group.closeTimeMs).toEqual(1725748470005.1672);
+  });
+
+  it('should return group with closeTimeMs equal to null if no closeEvent is passed', () => {
+    const group = setup({});
+    expect(group.closeTimeMs).toEqual(null);
+  });
+
   const groupFieldsExtractedFromEventsMetadaTests: {
     name: string;
     groupField: 'events' | 'eventsMetadata' | 'status' | 'timeMs' | 'timeLabel';
@@ -121,13 +133,15 @@ function setup({
   eventToTimeLabelPrefixMap = {},
   eventToLabel,
   eventToStatus,
+  closeEvent,
 }: {
   events?: TimerHistoryEvent[];
   eventToStatus?: HistoryGroupEventToStatusMap<TimerHistoryGroup>;
   eventToLabel?: HistoryGroupEventToStringMap<TimerHistoryGroup>;
   eventToTimeLabelPrefixMap?: Partial<
     HistoryGroupEventToStringMap<TimerHistoryGroup>
   >;
+  closeEvent?: TimerHistoryEvent;
 }) {
   const mockEvents: TimerHistoryEvent[] = events || [
     startTimerTaskEvent,
@@ -150,6 +164,7 @@ function setup({
     mockEvents,
     mockedEventToStatus,
     mockedEventToLabel,
-    eventToTimeLabelPrefixMap
+    eventToTimeLabelPrefixMap,
+    closeEvent
   );
 }

src/views/workflow-history/helpers/get-common-history-group-fields.ts

@@ -14,10 +14,16 @@ export default function getCommonHistoryGroupFields<
   events: GroupT['events'],
   HistoryGroupEventToStatusMap: HistoryGroupEventToStatusMap<GroupT>,
   eventToLabelMap: HistoryGroupEventToStringMap<GroupT>,
-  eventToTimeLabelPrefixMap: Partial<HistoryGroupEventToStringMap<GroupT>>
+  eventToTimeLabelPrefixMap: Partial<HistoryGroupEventToStringMap<GroupT>>,
+  closeEvent: GroupT['events'][number] | null | undefined
 ): Pick<
   GroupT,
-  'eventsMetadata' | 'events' | 'status' | 'timeMs' | 'timeLabel'
+  | 'eventsMetadata'
+  | 'events'
+  | 'status'
+  | 'timeMs'
+  | 'timeLabel'
+  | 'closeTimeMs'
 > {
   const eventsMetadata = events.map((event, index) => {
     const attrs = event.attributes as GroupT['events'][number]['attributes'];
@@ -30,6 +36,7 @@ export default function getCommonHistoryGroupFields<
     const prefix = eventToTimeLabelPrefixMap.hasOwnProperty(attrs)
       ? eventToTimeLabelPrefixMap[attrs]
       : `${eventToLabelMap[attrs]} at`;
+
     return {
       label: eventToLabelMap[attrs],
       status: eventStatus,
@@ -41,12 +48,16 @@ export default function getCommonHistoryGroupFields<
   const groupStatus = eventsMetadata[eventsMetadata.length - 1].status;
   const groupTimeMs = eventsMetadata[eventsMetadata.length - 1].timeMs;
   const groupTimeLabel = eventsMetadata[eventsMetadata.length - 1].timeLabel;
+  const groupCloseTimeMs = closeEvent?.eventTime
+    ? parseGrpcTimestamp(closeEvent.eventTime)
+    : null;
 
   return {
     eventsMetadata,
     events,
     status: groupStatus,
     timeMs: groupTimeMs,
+    closeTimeMs: groupCloseTimeMs,
     timeLabel: groupTimeLabel,
   };
 }

src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-activity-group-from-events.test.ts

@@ -232,4 +232,26 @@ describe('getActivityGroupFromEvents', () => {
       /^Last started at/
     );
   });
+
+  it('should return group with closeTimeMs equal to closeEvent or timeoutEvent timeMs', () => {
+    const group = getActivityGroupFromEvents([
+      scheduleActivityTaskEvent,
+      startActivityTaskEvent,
+      completeActivityTaskEvent,
+    ]);
+    expect(group.closeTimeMs).toEqual(1725747370632.0728);
+
+    const groupWithTimeoutEvent = getActivityGroupFromEvents([
+      scheduleActivityTaskEvent,
+      startActivityTaskEvent,
+      timeoutActivityTaskEvent,
+    ]);
+    expect(groupWithTimeoutEvent.closeTimeMs).toEqual(1725747370632.0728);
+
+    const groupWithMissingCloseEvent = getActivityGroupFromEvents([
+      scheduleActivityTaskEvent,
+      startActivityTaskEvent,
+    ]);
+    expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
+  });
 });

src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-child-workflow-execution-group-from-events.test.ts

@@ -208,4 +208,24 @@ describe('getChildWorkflowExecutionGroupFromEvents', () => {
       'Canceled at 08 Sep, 04:27:55 UTC',
     ]);
   });
+
+  it('should return group with closeTimeMs equal to closeEvent or startFailedEvent timeMs', () => {
+    const group = getChildWorkflowExecutionGroupFromEvents([
+      initiateChildWorkflowEvent,
+      startChildWorkflowEvent,
+      completeChildWorkflowEvent,
+    ]);
+    expect(group.closeTimeMs).toEqual(1725769674218.1462);
+
+    const groupWithStartFailedEvent = getChildWorkflowExecutionGroupFromEvents([
+      initiateChildWorkflowEvent,
+      initiateFailureChildWorkflowEvent,
+    ]);
+    expect(groupWithStartFailedEvent.closeTimeMs).toEqual(1725769672830.1233);
+
+    const groupWithMissingCloseEvent = getChildWorkflowExecutionGroupFromEvents(
+      [initiateChildWorkflowEvent, startChildWorkflowEvent]
+    );
+    expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
+  });
 });

src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-decision-group-from-events.test.ts

@@ -289,4 +289,25 @@ describe('getDecisionGroupFromEvents', () => {
     const group = getDecisionGroupFromEvents(events);
     expect(group.resetToDecisionEventId).toBe(timeoutDecisionTaskEvent.eventId);
   });
+
+  it('should return group with closeTimeMs equal to closeEvent or timeoutEvent timeMs', () => {
+    const group = getDecisionGroupFromEvents([
+      scheduleDecisionTaskEvent,
+      startDecisionTaskEvent,
+      completeDecisionTaskEvent,
+    ]);
+    expect(group.closeTimeMs).toEqual(1725747370599.273);
+
+    const groupWithTimeoutEvent = getDecisionGroupFromEvents([
+      scheduleDecisionTaskEvent,
+      timeoutDecisionTaskEvent,
+    ]);
+    expect(groupWithTimeoutEvent.closeTimeMs).toEqual(1725747370599.273);
+
+    const groupWithMissingCloseEvent = getDecisionGroupFromEvents([
+      scheduleDecisionTaskEvent,
+      startDecisionTaskEvent,
+    ]);
+    expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
+  });
 });

src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-request-cancel-external-workflow-execution-group-from-events.test.ts

@@ -114,4 +114,18 @@ describe('getRequestCancelExternalWorkflowExecutionGroupFromEvents', () => {
       'Requested at 07 Sep, 22:52:50 UTC',
     ]);
   });
+
+  it('should return group with closeTimeMs equal to closeEvent timeMs', () => {
+    const group = getRequestCancelExternalWorkflowExecutionGroupFromEvents([
+      initiateRequestCancelExternalWorkflowEvent,
+      requestCancelExternalWorkflowEvent,
+    ]);
+    expect(group.closeTimeMs).toEqual(1725749570927.7693);
+
+    const groupWithMissingCloseEvent =
+      getRequestCancelExternalWorkflowExecutionGroupFromEvents([
+        initiateRequestCancelExternalWorkflowEvent,
+      ]);
+    expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
+  });
 });

src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-signal-external-workflow-execution-group-from-events.test.ts

@@ -124,4 +124,17 @@ describe('getSignalExternalWorkflowExecutionGroupFromEvents', () => {
       'Signaled at 08 Sep, 04:26:10 UTC',
     ]);
   });
+
+  it('should return group with closeTimeMs equal to closeEvent timeMs', () => {
+    const group = getSignalExternalWorkflowExecutionGroupFromEvents([
+      initiateSignalExternalWorkflowEvent,
+      signalExternalWorkflowEvent,
+    ]);
+    expect(group.closeTimeMs).toEqual(1725769570375.7908);
+    const groupWithMissingCloseEvent =
+      getSignalExternalWorkflowExecutionGroupFromEvents([
+        initiateSignalExternalWorkflowEvent,
+      ]);
+    expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
+  });
 });

src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-single-event-group-from-events.test.ts

@@ -131,4 +131,11 @@ describe('getSingleEventGroupFromEvents', () => {
       );
     }
   });
+
+  it('should return group with closeTimeMs equal to null', () => {
+    for (const event of events) {
+      const group = getSingleEventGroupFromEvents([event]);
+      expect(group.closeTimeMs).toEqual(null);
+    }
+  });
 });

src/views/workflow-history/helpers/get-history-group-from-events/__tests__/get-timer-group-from-events.test.ts

@@ -114,4 +114,17 @@ describe('getTimerGroupFromEvents', () => {
       'Fired at 07 Sep, 22:34:30 UTC',
     ]);
   });
+
+  it('should return group with closeTimeMs equal to closeEvent timeMs', () => {
+    const group = getTimerGroupFromEvents([
+      startTimerTaskEvent,
+      fireTimerTaskEvent,
+    ]);
+    expect(group.closeTimeMs).toEqual(1725748470005.1672);
+
+    const groupWithMissingCloseEvent = getTimerGroupFromEvents([
+      startTimerTaskEvent,
+    ]);
+    expect(groupWithMissingCloseEvent.closeTimeMs).toEqual(null);
+  });
 });

src/views/workflow-history/helpers/get-history-group-from-events/get-activity-group-from-events.ts

@@ -104,7 +104,8 @@ export default function getActivityGroupFromEvents(
       events,
       eventToStatus,
       eventToLabel,
-      { pendingActivityTaskStartEventAttributes: pendingStartEventTimePrefix }
+      { pendingActivityTaskStartEventAttributes: pendingStartEventTimePrefix },
+      closeEvent || timeoutEvent
     ),
   };
 }