Extend Workflow Event Types filter functionality to filter Workflow Signaled events (cadence-workflow#1024)

* Extend Workflow Event Types filter to accept custom functions that run on a history events group
* Create workflowHistoryFilterTypesConfig that modifies the current filtering logic to show workflow signals under the "Signal" filter
* (unrelated) Show signal name and input in the event summary
* (unrelated) Fix typo: is-signle-event.test-ts -> is-single-event.test.ts

Author: adhityamamallan

src/views/workflow-history/config/workflow-history-filters-type.config.ts

@@ -0,0 +1,25 @@
+import {
+  type WorkflowHistoryEventFilteringConfig,
+  type WorkflowHistoryEventFilteringType,
+} from '../workflow-history-filters-type/workflow-history-filters-type.types';
+
+const workflowHistoryFiltersTypeConfig: Record<
+  WorkflowHistoryEventFilteringType,
+  WorkflowHistoryEventFilteringConfig
+> = {
+  ACTIVITY: 'Activity',
+  CHILDWORKFLOW: 'ChildWorkflowExecution',
+  DECISION: 'Decision',
+  TIMER: 'Timer',
+  SIGNAL: (g) =>
+    g.groupType === 'SignalExternalWorkflowExecution' ||
+    (g.events.length > 0 &&
+      g.events[0].attributes === 'workflowExecutionSignaledEventAttributes'),
+  WORKFLOW: (g) =>
+    g.groupType === 'RequestCancelExternalWorkflowExecution' ||
+    (g.groupType === 'Event' &&
+      g.events.length > 0 &&
+      g.events[0].attributes !== 'workflowExecutionSignaledEventAttributes'),
+};
+
+export default workflowHistoryFiltersTypeConfig;

…-group/__tests__/is-signle-event.test.ts …-group/__tests__/is-single-event.test.tssrc/views/workflow-history/helpers/check-history-event-group/__tests__/is-signle-event.test.ts renamed to src/views/workflow-history/helpers/check-history-event-group/__tests__/is-single-event.test.ts src/views/workflow-history/helpers/check-history-event-group/__tests__/is-signle-event.test.ts renamed to src/views/workflow-history/helpers/check-history-event-group/__tests__/is-single-event.test.ts

@@ -13,11 +13,11 @@ const validEvents: Pick<SingleHistoryEvent, 'attributes'>[] = [
   { attributes: 'cancelTimerFailedEventAttributes' },
   { attributes: 'markerRecordedEventAttributes' },
   { attributes: 'upsertWorkflowSearchAttributesEventAttributes' },
+  { attributes: 'workflowExecutionSignaledEventAttributes' },
   { attributes: 'workflowExecutionStartedEventAttributes' },
   { attributes: 'workflowExecutionCompletedEventAttributes' },
   { attributes: 'workflowExecutionFailedEventAttributes' },
   { attributes: 'workflowExecutionTimedOutEventAttributes' },
-  { attributes: 'workflowExecutionSignaledEventAttributes' },
   { attributes: 'workflowExecutionTerminatedEventAttributes' },
   { attributes: 'workflowExecutionCancelRequestedEventAttributes' },
   { attributes: 'workflowExecutionCanceledEventAttributes' },

src/views/workflow-history/helpers/check-history-event-group/is-single-event.ts

@@ -9,11 +9,11 @@ export default function isSingleEvent(event: {
     'cancelTimerFailedEventAttributes',
     'markerRecordedEventAttributes',
     'upsertWorkflowSearchAttributesEventAttributes',
+    'workflowExecutionSignaledEventAttributes',
     'workflowExecutionStartedEventAttributes',
     'workflowExecutionCompletedEventAttributes',
     'workflowExecutionFailedEventAttributes',
     'workflowExecutionTimedOutEventAttributes',
-    'workflowExecutionSignaledEventAttributes',
     'workflowExecutionTerminatedEventAttributes',
     'workflowExecutionCancelRequestedEventAttributes',
     'workflowExecutionCanceledEventAttributes',

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

@@ -170,6 +170,14 @@ describe('getSingleEventGroupFromEvents', () => {
     ]);
   });
 
+  it('should include summaryFields for workflow execution signaled events', () => {
+    const group = getSingleEventGroupFromEvents([signalWorkflowExecutionEvent]);
+    const eventMetadata = group.eventsMetadata[0];
+
+    expect(eventMetadata.status).toBe('COMPLETED');
+    expect(eventMetadata.summaryFields).toEqual(['signalName', 'input']);
+  });
+
   it('should include summaryFields for started workflow execution events', () => {
     const group = getSingleEventGroupFromEvents([startWorkflowExecutionEvent]);
     const eventMetadata = group.eventsMetadata[0];

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

@@ -93,6 +93,7 @@ export default function getSingleEventGroupFromEvents(
 
   const eventToSummaryFields: HistoryGroupEventToSummaryFieldsMap<SingleEventHistoryGroup> =
     {
+      workflowExecutionSignaledEventAttributes: ['signalName', 'input'],
       workflowExecutionStartedEventAttributes: [
         'input',
         'executionStartToCloseTimeoutSeconds',

src/views/workflow-history/workflow-history-filters-type/helpers/__tests__/filter-groups-by-group-type.test.ts

@@ -1,3 +1,5 @@
+import { signalWorkflowExecutionEvent } from '@/views/workflow-history/__fixtures__/workflow-history-single-events';
+
 import {
   mockActivityEventGroup,
   mockDecisionEventGroup,
@@ -10,7 +12,29 @@ import {
 import { type WorkflowHistoryFiltersTypeValue } from '../../workflow-history-filters-type.types';
 import filterGroupsByGroupType from '../filter-groups-by-group-type';
 
+jest.mock('../../../config/workflow-history-filters-type.config', () => ({
+  ACTIVITY: 'Activity',
+  CHILDWORKFLOW: 'ChildWorkflowExecution',
+  DECISION: 'Decision',
+  TIMER: 'Timer',
+  SIGNAL: jest.fn(
+    (g) =>
+      g.groupType === 'SignalExternalWorkflowExecution' ||
+      g.events[0].attributes === 'workflowExecutionSignaledEventAttributes'
+  ),
+  WORKFLOW: jest.fn(
+    (g) =>
+      g.groupType === 'RequestCancelExternalWorkflowExecution' ||
+      (g.groupType === 'Event' &&
+        g.events[0].attributes !== 'workflowExecutionSignaledEventAttributes')
+  ),
+}));
+
 describe(filterGroupsByGroupType.name, () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
   it('should return true if historyEventTypes is undefined', () => {
     const value: WorkflowHistoryFiltersTypeValue = {
       historyEventTypes: undefined,
@@ -81,6 +105,40 @@ describe(filterGroupsByGroupType.name, () => {
     ).toBe(true);
   });
 
+  it('should return true if WorkflowSignaled single event is included in history events and filter is SIGNAL', () => {
+    const value: WorkflowHistoryFiltersTypeValue = {
+      historyEventTypes: ['SIGNAL'],
+    };
+
+    expect(
+      filterGroupsByGroupType(
+        {
+          ...mockSingleEventGroup,
+          events: [signalWorkflowExecutionEvent],
+          firstEventId: signalWorkflowExecutionEvent.eventId,
+        },
+        value
+      )
+    ).toBe(true);
+  });
+
+  it('should return false if WorkflowSignaled single event is included in history events and filter is WORKFLOW', () => {
+    const value: WorkflowHistoryFiltersTypeValue = {
+      historyEventTypes: ['WORKFLOW'],
+    };
+
+    expect(
+      filterGroupsByGroupType(
+        {
+          ...mockSingleEventGroup,
+          events: [signalWorkflowExecutionEvent],
+          firstEventId: signalWorkflowExecutionEvent.eventId,
+        },
+        value
+      )
+    ).toBe(false);
+  });
+
   it('should return true if RequestCancelExternalWorkflowExecution group type maps to WORKFLOW and is included in historyEventTypes', () => {
     const value: WorkflowHistoryFiltersTypeValue = {
       historyEventTypes: ['WORKFLOW'],

src/views/workflow-history/workflow-history-filters-type/helpers/filter-groups-by-group-type.ts

@@ -1,5 +1,5 @@
+import workflowHistoryFiltersTypeConfig from '../../config/workflow-history-filters-type.config';
 import { type HistoryEventsGroup } from '../../workflow-history.types';
-import { WORKFLOW_HISTORY_GROUP_TYPE_TO_FILTERING_TYPE } from '../workflow-history-filters-type.constants';
 import { type WorkflowHistoryFiltersTypeValue } from '../workflow-history-filters-type.types';
 
 const filterGroupsByGroupType = function (
@@ -10,9 +10,17 @@ const filterGroupsByGroupType = function (
     return true;
   }
 
-  return value.historyEventTypes.includes(
-    WORKFLOW_HISTORY_GROUP_TYPE_TO_FILTERING_TYPE[group.groupType]
+  const filterConfigs = value.historyEventTypes.map(
+    (filteringType) => workflowHistoryFiltersTypeConfig[filteringType]
   );
+
+  return filterConfigs.some((filterConfig) => {
+    if (typeof filterConfig === 'function') {
+      return filterConfig(group);
+    }
+
+    return group.groupType === filterConfig;
+  });
 };
 
 export default filterGroupsByGroupType;

src/views/workflow-history/workflow-history-filters-type/workflow-history-filters-type.constants.ts

@@ -1,5 +1,3 @@
-import { type HistoryEventsGroup } from '../workflow-history.types';
-
 import { type WorkflowHistoryEventFilteringType } from './workflow-history-filters-type.types';
 
 export const WORKFLOW_HISTORY_EVENT_FILTERING_TYPES: WorkflowHistoryEventFilteringType[] =
@@ -13,16 +11,3 @@ export const WORKFLOW_HISTORY_EVENT_FILTERING_TYPES_LABEL_MAP = {
   WORKFLOW: 'Workflow',
   CHILDWORKFLOW: 'Child Workflow',
 } as const satisfies Record<WorkflowHistoryEventFilteringType, string>;
-
-export const WORKFLOW_HISTORY_GROUP_TYPE_TO_FILTERING_TYPE: Record<
-  HistoryEventsGroup['groupType'],
-  WorkflowHistoryEventFilteringType
-> = {
-  Activity: 'ACTIVITY',
-  ChildWorkflowExecution: 'CHILDWORKFLOW',
-  Decision: 'DECISION',
-  SignalExternalWorkflowExecution: 'SIGNAL',
-  Timer: 'TIMER',
-  RequestCancelExternalWorkflowExecution: 'WORKFLOW',
-  Event: 'WORKFLOW',
-} as const;

src/views/workflow-history/workflow-history-filters-type/workflow-history-filters-type.types.ts

@@ -1,12 +1,22 @@
+import {
+  type HistoryEventGroupType,
+  type HistoryEventsGroup,
+} from '../workflow-history.types';
+
+// TODO @adhitya.mamallan - rename these to WorkflowHistoryGroupFilteringType
+// These filters are for history event groups
 export type WorkflowHistoryEventFilteringType =
   | 'DECISION'
   | 'ACTIVITY'
   | 'SIGNAL'
   | 'TIMER'
-  | 'DECISION'
   | 'CHILDWORKFLOW'
   | 'WORKFLOW';
 
 export type WorkflowHistoryFiltersTypeValue = {
   historyEventTypes: WorkflowHistoryEventFilteringType[] | undefined;
 };
+
+export type WorkflowHistoryEventFilteringConfig =
+  | HistoryEventGroupType
+  | ((g: HistoryEventsGroup) => boolean);