Add GetUnhandledSignalNames (#1203)

* Add GetUnhandledSignalNames

* sync comment from temporal sdk

Author: longquanzheng

internal/internal_workflow.go

@@ -549,7 +549,7 @@ func executeDispatcher(ctx Context, dispatcher dispatcher) {
 		return
 	}
 
-	us := getWorkflowEnvOptions(ctx).getUnhandledSignals()
+	us := getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
 	if len(us) > 0 {
 		env.GetLogger().Info("Workflow has unhandled signals", zap.Strings("SignalNames", us))
 		env.GetMetricsScope().Counter(metrics.UnhandledSignalsCounter).Inc(1)
@@ -1264,8 +1264,13 @@ func (w *workflowOptions) getSignalChannel(ctx Context, signalName string) Chann
 	return ch
 }
 
-// getUnhandledSignals checks if there are any signal channels that have data to be consumed.
-func (w *workflowOptions) getUnhandledSignals() []string {
+// GetUnhandledSignalNames returns signal names that have  unconsumed signals.
+func GetUnhandledSignalNames(ctx Context) []string {
+	return getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
+}
+
+// getUnhandledSignalNames returns signal names that have  unconsumed signals.
+func (w *workflowOptions) getUnhandledSignalNames() []string {
 	unhandledSignals := []string{}
 	for k, c := range w.signalChannels {
 		ch := c.(*channelImpl)

internal/internal_workflow_test.go

@@ -510,14 +510,14 @@ func signalWorkflowTest(ctx Context) ([]byte, error) {
 	s.Select(ctx)
 
 	// Check un handled signals.
-	list := getWorkflowEnvOptions(ctx).getUnhandledSignals()
+	list := getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
 	if len(list) != 1 || list[0] != "testSig3" {
 		panic("expecting one unhandled signal")
 	}
 	ch3 := GetSignalChannel(ctx, "testSig3")
 	ch3.Receive(ctx, &v)
 	result += v
-	list = getWorkflowEnvOptions(ctx).getUnhandledSignals()
+	list = getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
 	if len(list) != 0 {
 		panic("expecting no unhandled signals")
 	}

workflow/workflow.go

@@ -192,6 +192,11 @@ func GetLogger(ctx Context) *zap.Logger {
 	return internal.GetLogger(ctx)
 }
 
+// GetUnhandledSignalNames returns signal names that have  unconsumed signals.
+func GetUnhandledSignalNames(ctx Context) []string {
+	return internal.GetUnhandledSignalNames(ctx)
+}
+
 // GetMetricsScope returns a metrics scope to be used in workflow's context
 func GetMetricsScope(ctx Context) tally.Scope {
 	return internal.GetMetricsScope(ctx)