Skip to content

Commit f50f452

Browse files
Add GetUnhandledSignalNames (#1203)
* Add GetUnhandledSignalNames * sync comment from temporal sdk
1 parent 6cd0267 commit f50f452

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

internal/internal_workflow.go

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ func executeDispatcher(ctx Context, dispatcher dispatcher) {
549549
return
550550
}
551551

552-
us := getWorkflowEnvOptions(ctx).getUnhandledSignals()
552+
us := getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
553553
if len(us) > 0 {
554554
env.GetLogger().Info("Workflow has unhandled signals", zap.Strings("SignalNames", us))
555555
env.GetMetricsScope().Counter(metrics.UnhandledSignalsCounter).Inc(1)
@@ -1264,8 +1264,13 @@ func (w *workflowOptions) getSignalChannel(ctx Context, signalName string) Chann
12641264
return ch
12651265
}
12661266

1267-
// getUnhandledSignals checks if there are any signal channels that have data to be consumed.
1268-
func (w *workflowOptions) getUnhandledSignals() []string {
1267+
// GetUnhandledSignalNames returns signal names that have unconsumed signals.
1268+
func GetUnhandledSignalNames(ctx Context) []string {
1269+
return getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
1270+
}
1271+
1272+
// getUnhandledSignalNames returns signal names that have unconsumed signals.
1273+
func (w *workflowOptions) getUnhandledSignalNames() []string {
12691274
unhandledSignals := []string{}
12701275
for k, c := range w.signalChannels {
12711276
ch := c.(*channelImpl)

internal/internal_workflow_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -510,14 +510,14 @@ func signalWorkflowTest(ctx Context) ([]byte, error) {
510510
s.Select(ctx)
511511

512512
// Check un handled signals.
513-
list := getWorkflowEnvOptions(ctx).getUnhandledSignals()
513+
list := getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
514514
if len(list) != 1 || list[0] != "testSig3" {
515515
panic("expecting one unhandled signal")
516516
}
517517
ch3 := GetSignalChannel(ctx, "testSig3")
518518
ch3.Receive(ctx, &v)
519519
result += v
520-
list = getWorkflowEnvOptions(ctx).getUnhandledSignals()
520+
list = getWorkflowEnvOptions(ctx).getUnhandledSignalNames()
521521
if len(list) != 0 {
522522
panic("expecting no unhandled signals")
523523
}

workflow/workflow.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,11 @@ func GetLogger(ctx Context) *zap.Logger {
192192
return internal.GetLogger(ctx)
193193
}
194194

195+
// GetUnhandledSignalNames returns signal names that have unconsumed signals.
196+
func GetUnhandledSignalNames(ctx Context) []string {
197+
return internal.GetUnhandledSignalNames(ctx)
198+
}
199+
195200
// GetMetricsScope returns a metrics scope to be used in workflow's context
196201
func GetMetricsScope(ctx Context) tally.Scope {
197202
return internal.GetMetricsScope(ctx)

0 commit comments

Comments
 (0)