Add support for multiple statuses to ListWorkflows route handler (#842)

* Use queryString to parse query params (Object.fromEntries() does not work with array query params)
* Modify query params schema to support multiple statuses (and also transform the input in case there is only one query param)
* Modify the ListWorkflowExecutions query to support multiple workflow statuses
* Temporary: Pass an array of single status in useListWorkflows hook

Author: adhityamamallan

src/route-handlers/list-workflows/helpers/__tests__/get-list-workflow-executions-query.test.ts

@@ -1,29 +1,24 @@
 import getListWorkflowExecutionsQuery from '../get-list-workflow-executions-query';
 
 describe('getListWorkflowExecutionsQuery', () => {
-  it('should return query', () => {
+  it('should return query to show various open and closed workflows', () => {
     const query = getListWorkflowExecutionsQuery({
       search: 'mocksearchterm',
-      workflowStatus: 'WORKFLOW_EXECUTION_CLOSE_STATUS_TERMINATED',
+      workflowStatuses: [
+        'WORKFLOW_EXECUTION_CLOSE_STATUS_TERMINATED',
+        'WORKFLOW_EXECUTION_CLOSE_STATUS_CANCELED',
+        'WORKFLOW_EXECUTION_CLOSE_STATUS_INVALID',
+      ],
       sortColumn: 'CloseTime',
       sortOrder: 'ASC',
       timeColumn: 'StartTime',
       timeRangeStart: '1712066100000000',
       timeRangeEnd: '1712096100000000',
     });
     expect(query).toEqual(
-      '(WorkflowType = "mocksearchterm" OR WorkflowID = "mocksearchterm" OR RunID = "mocksearchterm") AND CloseStatus = 3 AND StartTime > "1712066100000000" AND StartTime <= "1712096100000000" ORDER BY CloseTime ASC'
-    );
-  });
-
-  it('should return query for running status', () => {
-    const query = getListWorkflowExecutionsQuery({
-      search: 'mocksearchterm',
-      timeColumn: 'StartTime',
-      workflowStatus: 'WORKFLOW_EXECUTION_CLOSE_STATUS_INVALID',
-    });
-    expect(query).toEqual(
-      '(WorkflowType = "mocksearchterm" OR WorkflowID = "mocksearchterm" OR RunID = "mocksearchterm") AND CloseTime = missing ORDER BY StartTime DESC'
+      '(WorkflowType = "mocksearchterm" OR WorkflowID = "mocksearchterm" OR RunID = "mocksearchterm") AND ' +
+        '(CloseStatus = 3 OR CloseStatus = 2 OR CloseTime = missing) AND ' +
+        'StartTime > "1712066100000000" AND StartTime <= "1712096100000000" ORDER BY CloseTime ASC'
     );
   });
 

src/route-handlers/list-workflows/helpers/get-list-workflow-executions-query.ts

@@ -6,15 +6,15 @@ import { type TimeColumn } from '../list-workflows.types';
 
 export default function getListWorkflowExecutionsQuery({
   search,
-  workflowStatus,
+  workflowStatuses,
   sortColumn,
   sortOrder,
   timeColumn,
   timeRangeStart,
   timeRangeEnd,
 }: {
   search?: string;
-  workflowStatus?: WorkflowStatus;
+  workflowStatuses?: Array<WorkflowStatus>;
   sortColumn?: string;
   sortOrder?: SortOrder;
   timeColumn: TimeColumn;
@@ -28,16 +28,21 @@ export default function getListWorkflowExecutionsQuery({
     );
   }
 
-  if (workflowStatus) {
-    if (workflowStatus === WORKFLOW_STATUSES.running) {
-      searchQueries.push('CloseTime = missing');
+  const workflowStatusQueries: Array<string> = [];
+  workflowStatuses?.forEach((status) => {
+    if (status === WORKFLOW_STATUSES.running) {
+      workflowStatusQueries.push('CloseTime = missing');
     } else {
-      searchQueries.push(
-        // Query CloseStatus is 0-indexed (and excludes INVALID)
+      workflowStatusQueries.push(
+        // Numerical query CloseStatus is 0-indexed (and excludes INVALID)
         // https://cadenceworkflow.io/docs/concepts/search-workflows/#query-capabilities
-        `CloseStatus = ${Object.values(WORKFLOW_STATUSES).indexOf(workflowStatus) - 1}`
+        `CloseStatus = ${Object.values(WORKFLOW_STATUSES).indexOf(status) - 1}`
       );
     }
+  });
+
+  if (workflowStatusQueries.length > 0) {
+    searchQueries.push(`(${workflowStatusQueries.join(' OR ')})`);
   }
 
   if (timeRangeStart) {

src/route-handlers/list-workflows/list-workflows.ts

@@ -1,4 +1,5 @@
 import { type NextRequest, NextResponse } from 'next/server';
+import queryString from 'query-string';
 
 import decodeUrlParams from '@/utils/decode-url-params';
 import { getHTTPStatusCode, GRPCError } from '@/utils/grpc/grpc-error';
@@ -22,7 +23,7 @@ export async function listWorkflows(
   const decodedParams = decodeUrlParams(requestParams.params) as RouteParams;
 
   const { data: queryParams, error } = listWorkflowsQueryParamSchema.safeParse(
-    Object.fromEntries(request.nextUrl.searchParams)
+    queryString.parse(request.nextUrl.searchParams.toString())
   );
   if (error) {
     return NextResponse.json(
@@ -45,7 +46,7 @@ export async function listWorkflows(
         ? queryParams.query
         : getListWorkflowExecutionsQuery({
             search: queryParams.search,
-            workflowStatus: queryParams.status,
+            workflowStatuses: queryParams.statuses,
             sortColumn: queryParams.sortColumn,
             sortOrder: queryParams.sortOrder,
             timeColumn: queryParams.timeColumn,

src/route-handlers/list-workflows/schemas/list-workflows-query-params-schema.ts

@@ -4,6 +4,11 @@ import { SORT_ORDERS } from '@/utils/sort-by';
 import isWorkflowStatus from '@/views/shared/workflow-status-tag/helpers/is-workflow-status';
 import { type WorkflowStatus } from '@/views/shared/workflow-status-tag/workflow-status-tag.types';
 
+// TODO: this should go in a shared location
+const workflowStatusSchema = z.custom<WorkflowStatus>(isWorkflowStatus, {
+  message: 'Invalid workflow status',
+});
+
 const listWorkflowsQueryParamSchema = z
   .object({
     pageSize: z
@@ -16,10 +21,11 @@ const listWorkflowsQueryParamSchema = z
     inputType: z.enum(['search', 'query']),
     search: z.string().trim().optional(),
     query: z.string().optional(),
-    status: z
-      .custom<WorkflowStatus>(isWorkflowStatus, {
-        message: 'Invalid workflow status',
-      })
+    statuses: z
+      .union([
+        workflowStatusSchema.transform((status) => [status]),
+        z.array(workflowStatusSchema),
+      ])
       .optional(),
     timeColumn: z
       .enum(['StartTime', 'CloseTime'])

src/views/shared/hooks/use-list-workflows.ts

@@ -39,7 +39,8 @@ export default function useListWorkflows({
         }
       : {
           search,
-          status,
+          // Temporary change, this will be removed in a follow-up
+          statuses: status ? [status] : [],
           sortColumn,
           sortOrder,
           timeRangeStart: timeRangeStart?.toISOString(),