added QueryTypeQueryTypes and unit tests (#1295)

Author: arzonus

client/client.go

@@ -43,6 +43,10 @@ const (
 	// QueryTypeOpenSessions is the build in query type for Client.QueryWorkflow() call. Use this query type to get all open
 	// sessions in the workflow. The result will be a list of SessionInfo encoded in the encoded.Value.
 	QueryTypeOpenSessions string = internal.QueryTypeOpenSessions
+
+	// QueryTypeQueryTypes is the build in query type for Client.QueryWorkflow() call. Use this query type to list
+	// all query types of the workflow. The result will be a string encoded in the EncodedValue.
+	QueryTypeQueryTypes string = internal.QueryTypeQueryTypes
 )
 
 type (

internal/client.go

@@ -45,8 +45,21 @@ const (
 	// QueryTypeOpenSessions is the build in query type for Client.QueryWorkflow() call. Use this query type to get all open
 	// sessions in the workflow. The result will be a list of SessionInfo encoded in the EncodedValue.
 	QueryTypeOpenSessions string = "__open_sessions"
+
+	// QueryTypeQueryTypes is the build in query type for Client.QueryWorkflow() call. Use this query type to list
+	// all query types of the workflow. The result will be a string encoded in the EncodedValue.
+	QueryTypeQueryTypes string = "__query_types"
 )
 
+// BuiltinQueryTypes returns a list of built-in query types
+func BuiltinQueryTypes() []string {
+	return []string{
+		QueryTypeOpenSessions,
+		QueryTypeStackTrace,
+		QueryTypeQueryTypes,
+	}
+}
+
 type Option interface{ private() }
 
 type CancelReason string

internal/internal_event_handlers.go

@@ -961,6 +961,8 @@ func (weh *workflowExecutionEventHandlerImpl) ProcessQuery(queryType string, que
 		return weh.encodeArg(weh.StackTrace())
 	case QueryTypeOpenSessions:
 		return weh.encodeArg(weh.getOpenSessions())
+	case QueryTypeQueryTypes:
+		return weh.encodeArg(weh.KnownQueryTypes())
 	default:
 		result, err := weh.queryHandler(queryType, queryArgs)
 		if err != nil {
@@ -980,6 +982,10 @@ func (weh *workflowExecutionEventHandlerImpl) ProcessQuery(queryType string, que
 	}
 }
 
+func (weh *workflowExecutionEventHandlerImpl) KnownQueryTypes() []string {
+	return weh.workflowDefinition.KnownQueryTypes()
+}
+
 func (weh *workflowExecutionEventHandlerImpl) StackTrace() string {
 	return weh.workflowDefinition.StackTrace()
 }

internal/internal_event_handlers_test.go

@@ -382,3 +382,22 @@ func TestHistoryEstimationforPackedEvents(t *testing.T) {
 	trueSize := len(testEvents)*historySizeEstimationBuffer + len(byteArray)*2*len(testEvents)
 	assert.Equal(t, trueSize, historySizeSum)
 }
+
+func TestProcessQuery_KnownQueryTypes(t *testing.T) {
+	rootCtx := setWorkflowEnvOptionsIfNotExist(Background())
+	eo := getWorkflowEnvOptions(rootCtx)
+	eo.queryHandlers["a"] = nil
+
+	weh := &workflowExecutionEventHandlerImpl{
+		workflowEnvironmentImpl: &workflowEnvironmentImpl{
+			dataConverter: DefaultDataConverter,
+		},
+		workflowDefinition: &syncWorkflowDefinition{
+			rootCtx: rootCtx,
+		},
+	}
+
+	result, err := weh.ProcessQuery(QueryTypeQueryTypes, nil)
+	assert.NoError(t, err)
+	assert.Equal(t, "[\"__open_sessions\",\"__query_types\",\"__stack_trace\",\"a\"]\n", string(result))
+}

internal/internal_worker_base.go

@@ -108,6 +108,9 @@ type (
 		// Executed after all history events since the previous decision are applied to workflowDefinition
 		OnDecisionTaskStarted()
 		StackTrace() string // Stack trace of all coroutines owned by the Dispatcher instance
+
+		// KnownQueryTypes returns a list of known query types of the workflowOptions with BuiltinQueryTypes
+		KnownQueryTypes() []string
 		Close()
 	}
 

internal/internal_workflow.go

@@ -28,6 +28,7 @@ import (
 	"fmt"
 	"reflect"
 	"runtime"
+	"sort"
 	"strings"
 	"sync"
 	"time"
@@ -501,11 +502,7 @@ func (d *syncWorkflowDefinition) Execute(env workflowEnvironment, header *shared
 		eo := getWorkflowEnvOptions(d.rootCtx)
 		handler, ok := eo.queryHandlers[queryType]
 		if !ok {
-			keys := []string{QueryTypeStackTrace, QueryTypeOpenSessions}
-			for k := range eo.queryHandlers {
-				keys = append(keys, k)
-			}
-			return nil, fmt.Errorf("unknown queryType %v. KnownQueryTypes=%v", queryType, keys)
+			return nil, fmt.Errorf("unknown queryType %v. KnownQueryTypes=%v", queryType, eo.KnownQueryTypes())
 		}
 		return handler(queryArgs)
 	})
@@ -519,6 +516,10 @@ func (d *syncWorkflowDefinition) StackTrace() string {
 	return d.dispatcher.StackTrace()
 }
 
+func (d *syncWorkflowDefinition) KnownQueryTypes() []string {
+	return getWorkflowEnvOptions(d.rootCtx).KnownQueryTypes()
+}
+
 func (d *syncWorkflowDefinition) Close() {
 	if d.dispatcher != nil {
 		d.dispatcher.Close()
@@ -1284,6 +1285,18 @@ func (w *workflowOptions) getUnhandledSignalNames() []string {
 	return unhandledSignals
 }
 
+// KnownQueryTypes returns a list of known query types of the workflowOptions with BuiltinQueryTypes
+func (w *workflowOptions) KnownQueryTypes() []string {
+	keys := BuiltinQueryTypes()
+
+	for k := range w.queryHandlers {
+		keys = append(keys, k)
+	}
+
+	sort.Strings(keys)
+	return keys
+}
+
 func (d *decodeFutureImpl) Get(ctx Context, value interface{}) error {
 	more := d.futureImpl.channel.Receive(ctx, nil)
 	if more {

internal/internal_workflow_test.go

@@ -1308,3 +1308,39 @@ func (t *tracingInterceptor) ExecuteWorkflow(ctx Context, workflowType string, a
 	t.trace = append(t.trace, "ExecuteWorkflow "+workflowType+" end")
 	return result
 }
+
+type WorkflowOptionTest struct {
+	suite.Suite
+}
+
+func TestWorkflowOption(t *testing.T) {
+	suite.Run(t, new(WorkflowOptionTest))
+}
+
+func (t *WorkflowOptionTest) TestKnowQueryType_NoHandlers() {
+	wo := workflowOptions{queryHandlers: make(map[string]func([]byte) ([]byte, error))}
+	t.ElementsMatch(
+		[]string{
+			QueryTypeStackTrace,
+			QueryTypeOpenSessions,
+			QueryTypeQueryTypes,
+		},
+		wo.KnownQueryTypes())
+}
+
+func (t *WorkflowOptionTest) TestKnowQueryType_WithHandlers() {
+	wo := workflowOptions{queryHandlers: map[string]func([]byte) ([]byte, error){
+		"a": nil,
+		"b": nil,
+	}}
+
+	t.ElementsMatch(
+		[]string{
+			QueryTypeStackTrace,
+			QueryTypeOpenSessions,
+			QueryTypeQueryTypes,
+			"a",
+			"b",
+		},
+		wo.KnownQueryTypes())
+}