Add support for query parameter when listing schedules (#1556)

* Add support for query parameter when listing schedules * Add support for query parameter when listing schedules Guard for eventual consistency
temporalio · Jul 22, 2024 · 1350fb4 · 1350fb4
1 parent 73bd320
commit 1350fb4
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 2 deletions.
diff --git a/internal/internal_schedule_client.go b/internal/internal_schedule_client.go
@@ -199,6 +199,7 @@ func (sc *scheduleClient) List(ctx context.Context, options ScheduleListOptions)
 			Namespace:       sc.workflowClient.namespace,
 			MaximumPageSize: int32(options.PageSize),
 			NextPageToken:   nextToken,
+			Query:           options.Query,
 		}
 
 		return sc.workflowClient.workflowService.ListSchedules(grpcCtx, request)

diff --git a/internal/schedule_client.go b/internal/schedule_client.go
@@ -607,6 +607,10 @@ type (
 		// PageSize - How many results to fetch from the Server at a time.
 		// Optional: defaulted to 1000
 		PageSize int
+
+		// Query - Filter results using a SQL-like query.
+		// Optional
+		Query string
 	}
 
 	// ScheduleListIterator represents the interface for

diff --git a/test/integration_test.go b/test/integration_test.go
@@ -4896,13 +4896,19 @@ func (ts *IntegrationTestSuite) TestScheduleBackfill() {
 func (ts *IntegrationTestSuite) TestScheduleList() {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
+
+	stringKey := temporal.NewSearchAttributeKeyKeyword("CustomKeywordField")
+
 	for i := 0; i < 5; i++ {
 		scheduleID := fmt.Sprintf("test-schedule-list-schedule-%d", i)
 		workflowID := fmt.Sprintf("test-schedule-list-workflow-%d", i)
+		attrId := stringKey.ValueSet(fmt.Sprintf("TestScheduleList-%d", i))
+
 		// Create a paused workflow
 		handle, err := ts.client.ScheduleClient().Create(ctx, client.ScheduleOptions{
-			ID:   scheduleID,
-			Spec: client.ScheduleSpec{},
+			ID:                    scheduleID,
+			Spec:                  client.ScheduleSpec{},
+			TypedSearchAttributes: temporal.NewSearchAttributes(attrId),
 			Action: &client.ScheduleWorkflowAction{
 				Workflow:                 ts.workflows.SimplestWorkflow,
 				ID:                       workflowID,
@@ -4928,6 +4934,30 @@ func (ts *IntegrationTestSuite) TestScheduleList() {
 	}
 	ts.GreaterOrEqual(5, len(events))
 	ts.NoError(err)
+
+	// query -- match
+	ts.Eventually(func() bool {
+		iter, err = ts.client.ScheduleClient().List(ctx, client.ScheduleListOptions{
+			PageSize: 1,
+			Query:    "CustomKeywordField = 'TestScheduleList-1'",
+		})
+		ts.NoError(err)
+		count := 0
+		for iter.HasNext() {
+			_, err = iter.Next()
+			ts.Nil(err)
+			count++
+		}
+		return count == 1
+	}, 10*time.Second, 100*time.Millisecond)
+
+	// query -- no match
+	iter, err = ts.client.ScheduleClient().List(ctx, client.ScheduleListOptions{
+		PageSize: 1,
+		Query:    "CustomKeywordField = 'TestScheduleList-DOES_NOT_EXIST'",
+	})
+	ts.NoError(err)
+	ts.False(iter.HasNext())
 }
 
 func (ts *IntegrationTestSuite) TestScheduleUpdate() {