feat(Schedule): support query for listing schedules (#1535)

Author: nikhilbhatia08

packages/client/src/schedule-client.ts

@@ -162,6 +162,10 @@ export interface ListScheduleOptions {
    * @default 1000
    */
   pageSize?: number;
+  /**
+   * Filter schedules by a query string.
+   */
+  query?: string;
 }
 
 /**
@@ -368,6 +372,7 @@ export class ScheduleClient extends BaseClient {
           nextPageToken,
           namespace: this.options.namespace,
           maximumPageSize: options?.pageSize,
+          query: options?.query,
         });
       } catch (e) {
         this.rethrowGrpcError(e, 'Failed to list schedules', undefined);

packages/test/src/test-schedules.ts

@@ -10,6 +10,7 @@ import {
   ScheduleHandle,
   ScheduleSummary,
   ScheduleUpdateOptions,
+  SearchAttributes,
 } from '@temporalio/client';
 import { msToNumber } from '@temporalio/common/lib/time';
 import { registerDefaultCustomSearchAttributes, RUN_INTEGRATION_TESTS } from './helpers';
@@ -542,6 +543,70 @@ if (RUN_INTEGRATION_TESTS) {
     }
   });
 
+  test.serial('Can list Schedules with a query string', async (t) => {
+    const { client } = t.context;
+
+    const groupId = randomUUID();
+    const createdScheduleHandlesPromises = [];
+    const expectedIds: string[] = [];
+    for (let i = 0; i < 4; i++) {
+      const scheduleId = `test-query-${groupId}-${i + 1}`;
+      const searchAttributes: SearchAttributes = {};
+      if (i < 2) {
+        searchAttributes['CustomKeywordField'] = ['some-value'];
+        expectedIds.push(scheduleId);
+      }
+      createdScheduleHandlesPromises.push(
+        client.schedule.create({
+          scheduleId,
+          spec: {
+            calendars: [{ hour: { start: 2, end: 7, step: 1 } }],
+          },
+          action: {
+            type: 'startWorkflow',
+            workflowType: dummyWorkflow,
+            taskQueue,
+          },
+          searchAttributes,
+        })
+      );
+    }
+
+    const createdScheduleHandles: { [k: string]: ScheduleHandle } = Object.fromEntries(
+      (await Promise.all(createdScheduleHandlesPromises)).map((x) => [x.scheduleId, x])
+    );
+
+    try {
+      // Wait for visibility to stabilize
+      await asyncRetry(
+        async () => {
+          const listedScheduleHandlesFromQuery: ScheduleSummary[] = []; // to list all the schedule handles from the query string provided
+          const query = `CustomKeywordField="some-value"`;
+
+          for await (const schedule of client.schedule.list({ query })) {
+            listedScheduleHandlesFromQuery.push(schedule);
+          }
+
+          const listedScheduleIdsFromQuery = listedScheduleHandlesFromQuery.map((x) => x.scheduleId).sort();
+
+          if (listedScheduleIdsFromQuery.length !== expectedIds.length) throw new Error('Entries are missing');
+
+          t.deepEqual(listedScheduleIdsFromQuery, expectedIds);
+        },
+        {
+          retries: 60,
+          maxTimeout: 1000,
+        }
+      );
+
+      t.pass();
+    } finally {
+      for (const handle of Object.values(createdScheduleHandles)) {
+        await handle.delete();
+      }
+    }
+  });
+
   test.serial('Structured calendar specs are encoded and decoded properly', async (t) => {
     const checks: { input: CalendarSpec; expected: CalendarSpecDescription; comment?: string }[] = [
       {