-
Notifications
You must be signed in to change notification settings - Fork 131
/
interceptors.go
183 lines (154 loc) · 8.04 KB
/
interceptors.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
// Modifications Copyright (c) 2020 Uber Technologies Inc.
// Copyright (c) 2020 Temporal Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package internal
import (
"time"
"github.com/uber-go/tally"
"go.uber.org/zap"
)
// WorkflowInterceptorFactory is used to create a single link in the interceptor chain
type WorkflowInterceptorFactory interface {
// NewInterceptor creates an interceptor instance. The created instance must delegate every call to
// the next parameter for workflow code function correctly.
NewInterceptor(info *WorkflowInfo, next WorkflowInterceptor) WorkflowInterceptor
}
// WorkflowInterceptor is an interface that can be implemented to intercept calls to the workflow function
// as well calls done by the workflow code.
// Use worker.WorkflowInterceptorBase as a base struct for implementations that do not want to implement every method.
// Interceptor implementation must forward calls to the next in the interceptor chain.
// All code in the interceptor is executed in the context of a workflow. So all the rules and restrictions
// that apply to the workflow code should be obeyed by the interceptor implementation.
// Use workflow.IsReplaying(ctx) to filter out duplicated calls.
type WorkflowInterceptor interface {
// Intercepts workflow function invocation. As calls to other intercepted functions are done from a workflow
// function this function is the first to be called and completes workflow as soon as it returns.
// workflowType argument is for information purposes only and should not be mutated.
ExecuteWorkflow(ctx Context, workflowType string, args ...interface{}) []interface{}
ExecuteActivity(ctx Context, activityType string, args ...interface{}) Future
ExecuteLocalActivity(ctx Context, activityType string, args ...interface{}) Future
ExecuteChildWorkflow(ctx Context, childWorkflowType string, args ...interface{}) ChildWorkflowFuture
GetWorkflowInfo(ctx Context) *WorkflowInfo
GetLogger(ctx Context) *zap.Logger
GetMetricsScope(ctx Context) tally.Scope
Now(ctx Context) time.Time
NewTimer(ctx Context, d time.Duration) Future
Sleep(ctx Context, d time.Duration) (err error)
RequestCancelExternalWorkflow(ctx Context, workflowID, runID string) Future
SignalExternalWorkflow(ctx Context, workflowID, runID, signalName string, arg interface{}) Future
UpsertSearchAttributes(ctx Context, attributes map[string]interface{}) error
GetSignalChannel(ctx Context, signalName string) Channel
SideEffect(ctx Context, f func(ctx Context) interface{}) Value
MutableSideEffect(ctx Context, id string, f func(ctx Context) interface{}, equals func(a, b interface{}) bool) Value
GetVersion(ctx Context, changeID string, minSupported, maxSupported Version) Version
SetQueryHandler(ctx Context, queryType string, handler interface{}) error
IsReplaying(ctx Context) bool
HasLastCompletionResult(ctx Context) bool
GetLastCompletionResult(ctx Context, d ...interface{}) error
}
var _ WorkflowInterceptor = (*WorkflowInterceptorBase)(nil)
// WorkflowInterceptorBase is a helper type that can simplify creation of WorkflowInterceptors
type WorkflowInterceptorBase struct {
Next WorkflowInterceptor
}
// ExecuteWorkflow forwards to t.Next
func (t *WorkflowInterceptorBase) ExecuteWorkflow(ctx Context, workflowType string, args ...interface{}) []interface{} {
return t.Next.ExecuteWorkflow(ctx, workflowType, args...)
}
// ExecuteActivity forwards to t.Next
func (t *WorkflowInterceptorBase) ExecuteActivity(ctx Context, activityType string, args ...interface{}) Future {
return t.Next.ExecuteActivity(ctx, activityType, args...)
}
// ExecuteLocalActivity forwards to t.Next
func (t *WorkflowInterceptorBase) ExecuteLocalActivity(ctx Context, activityType string, args ...interface{}) Future {
return t.Next.ExecuteLocalActivity(ctx, activityType, args...)
}
// ExecuteChildWorkflow forwards to t.Next
func (t *WorkflowInterceptorBase) ExecuteChildWorkflow(ctx Context, childWorkflowType string, args ...interface{}) ChildWorkflowFuture {
return t.Next.ExecuteChildWorkflow(ctx, childWorkflowType, args...)
}
// GetWorkflowInfo forwards to t.Next
func (t *WorkflowInterceptorBase) GetWorkflowInfo(ctx Context) *WorkflowInfo {
return t.Next.GetWorkflowInfo(ctx)
}
// GetLogger forwards to t.Next
func (t *WorkflowInterceptorBase) GetLogger(ctx Context) *zap.Logger {
return t.Next.GetLogger(ctx)
}
// GetMetricsScope forwards to t.Next
func (t *WorkflowInterceptorBase) GetMetricsScope(ctx Context) tally.Scope {
return t.Next.GetMetricsScope(ctx)
}
// Now forwards to t.Next
func (t *WorkflowInterceptorBase) Now(ctx Context) time.Time {
return t.Next.Now(ctx)
}
// NewTimer forwards to t.Next
func (t *WorkflowInterceptorBase) NewTimer(ctx Context, d time.Duration) Future {
return t.Next.NewTimer(ctx, d)
}
// Sleep forwards to t.Next
func (t *WorkflowInterceptorBase) Sleep(ctx Context, d time.Duration) (err error) {
return t.Next.Sleep(ctx, d)
}
// RequestCancelExternalWorkflow forwards to t.Next
func (t *WorkflowInterceptorBase) RequestCancelExternalWorkflow(ctx Context, workflowID, runID string) Future {
return t.Next.RequestCancelExternalWorkflow(ctx, workflowID, runID)
}
// SignalExternalWorkflow forwards to t.Next
func (t *WorkflowInterceptorBase) SignalExternalWorkflow(ctx Context, workflowID, runID, signalName string, arg interface{}) Future {
return t.Next.SignalExternalWorkflow(ctx, workflowID, runID, signalName, arg)
}
// UpsertSearchAttributes forwards to t.Next
func (t *WorkflowInterceptorBase) UpsertSearchAttributes(ctx Context, attributes map[string]interface{}) error {
return t.Next.UpsertSearchAttributes(ctx, attributes)
}
// GetSignalChannel forwards to t.Next
func (t *WorkflowInterceptorBase) GetSignalChannel(ctx Context, signalName string) Channel {
return t.Next.GetSignalChannel(ctx, signalName)
}
// SideEffect forwards to t.Next
func (t *WorkflowInterceptorBase) SideEffect(ctx Context, f func(ctx Context) interface{}) Value {
return t.Next.SideEffect(ctx, f)
}
// MutableSideEffect forwards to t.Next
func (t *WorkflowInterceptorBase) MutableSideEffect(ctx Context, id string, f func(ctx Context) interface{}, equals func(a, b interface{}) bool) Value {
return t.Next.MutableSideEffect(ctx, id, f, equals)
}
// GetVersion forwards to t.Next
func (t *WorkflowInterceptorBase) GetVersion(ctx Context, changeID string, minSupported, maxSupported Version) Version {
return t.Next.GetVersion(ctx, changeID, minSupported, maxSupported)
}
// SetQueryHandler forwards to t.Next
func (t *WorkflowInterceptorBase) SetQueryHandler(ctx Context, queryType string, handler interface{}) error {
return t.Next.SetQueryHandler(ctx, queryType, handler)
}
// IsReplaying forwards to t.Next
func (t *WorkflowInterceptorBase) IsReplaying(ctx Context) bool {
return t.Next.IsReplaying(ctx)
}
// HasLastCompletionResult forwards to t.Next
func (t *WorkflowInterceptorBase) HasLastCompletionResult(ctx Context) bool {
return t.Next.HasLastCompletionResult(ctx)
}
// GetLastCompletionResult forwards to t.Next
func (t *WorkflowInterceptorBase) GetLastCompletionResult(ctx Context, d ...interface{}) error {
return t.Next.GetLastCompletionResult(ctx, d...)
}