Set default shadow workflow status to OPEN (#1070)

Author: yycptt

internal/query_builder.go

@@ -39,6 +39,8 @@ const (
 	WorkflowStatusOpen WorkflowStatus = "OPEN"
 	// WorkflowStatusClosed is the WorkflowStatus for closed workflows
 	WorkflowStatusClosed WorkflowStatus = "CLOSED"
+	// WorkflowStatusALL is the WorkflowStatus for all workflows
+	WorkflowStatusALL WorkflowStatus = "ALL"
 )
 
 var (
@@ -104,6 +106,9 @@ func (q *queryBuilderImpl) WorkflowStatus(statuses []WorkflowStatus) QueryBuilde
 			statusQuery = keyCloseTime + " = missing"
 		case WorkflowStatusClosed:
 			statusQuery = keyCloseTime + " != missing"
+		case WorkflowStatusALL:
+			// no query needed
+			return q
 		default:
 			statusQuery = keyCloseStatus + ` = "` + string(status) + `"`
 		}

internal/query_builder_test.go

@@ -101,6 +101,11 @@ func (s *queryBuilderSuite) TestWorkflowStatusQuery() {
 			workflowStatuses: []WorkflowStatus{WorkflowStatusFailed, WorkflowStatusTimedOut},
 			expectedQuery:    `(CloseStatus = "FAILED" or CloseStatus = "TIMED_OUT")`,
 		},
+		{
+			msg:              "all workflows",
+			workflowStatuses: []WorkflowStatus{WorkflowStatusTerminated, WorkflowStatusALL},
+			expectedQuery:    "",
+		},
 	}
 
 	for _, test := range testCases {
@@ -189,7 +194,6 @@ func (s *queryBuilderSuite) TestToWorkflowStatus() {
 			expectedStatus: WorkflowStatusTimedOut,
 		},
 		{
-
 			msg:            "upper case status string",
 			statusString:   "TERMINATED",
 			expectErr:      false,

internal/workflow_shadower.go

@@ -63,8 +63,8 @@ type (
 
 		// Optional: A list of workflow status.
 		// The list will be used to construct WorkflowQuery. Only workflows with status listed will be replayed.
-		// accepted values (case-insensitive): OPEN, CLOSED, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
-		// default: empty list, which matches all workflow status
+		// accepted values (case-insensitive): OPEN, CLOSED, ALL, COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
+		// default: OPEN, which matches only open workflows
 		WorkflowStatus []string
 
 		// Optional: Min and Max workflow start timestamp.
@@ -312,6 +312,9 @@ func (o *ShadowOptions) validateAndPopulateFields() error {
 			}
 			statuses = append(statuses, status)
 		}
+		if len(statuses) == 0 {
+			statuses = []WorkflowStatus{WorkflowStatusOpen}
+		}
 		queryBuilder.WorkflowStatus(statuses)
 
 		if !o.WorkflowStartTimeFilter.isEmpty() {

internal/workflow_shadower_test.go

@@ -194,11 +194,11 @@ func (s *workflowShadowerSuite) TestShadowOptionsValidation() {
 			expectErr: true,
 		},
 		{
-			msg:       "populate sampling rate and concurrency",
+			msg:       "populate sampling rate, concurrency and status",
 			options:   ShadowOptions{},
 			expectErr: false,
 			validationFn: func(options *ShadowOptions) {
-				s.Empty(options.WorkflowQuery)
+				s.Equal("(CloseTime = missing)", options.WorkflowQuery)
 				s.Equal(1.0, options.SamplingRate)
 				s.Equal(1, options.Concurrency)
 			},