/
query_workflow_test.go
327 lines (275 loc) · 9.74 KB
/
query_workflow_test.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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber 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 tests
import (
"context"
"sync"
"sync/atomic"
"time"
commonpb "go.temporal.io/api/common/v1"
sdkclient "go.temporal.io/sdk/client"
"go.temporal.io/sdk/temporal"
"go.temporal.io/sdk/worker"
"go.temporal.io/sdk/workflow"
"go.temporal.io/server/service/history/consts"
"go.temporal.io/api/serviceerror"
"go.temporal.io/server/common/log/tag"
)
func (s *clientFunctionalSuite) TestQueryWorkflow_Sticky() {
var replayCount int32
workflowFn := func(ctx workflow.Context) (string, error) {
// every replay will start from here
atomic.AddInt32(&replayCount, 1)
workflow.SetQueryHandler(ctx, "test", func() (string, error) {
return "query works", nil
})
signalCh := workflow.GetSignalChannel(ctx, "test")
var msg string
signalCh.Receive(ctx, &msg)
return msg, nil
}
s.worker.RegisterWorkflow(workflowFn)
id := "test-query-sticky"
workflowOptions := sdkclient.StartWorkflowOptions{
ID: id,
TaskQueue: s.taskQueue,
WorkflowRunTimeout: 20 * time.Second,
}
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
workflowRun, err := s.sdkClient.ExecuteWorkflow(ctx, workflowOptions, workflowFn)
if err != nil {
s.Logger.Fatal("Start workflow failed with err", tag.Error(err))
}
s.NotNil(workflowRun)
s.True(workflowRun.GetRunID() != "")
queryResult, err := s.sdkClient.QueryWorkflow(ctx, id, "", "test", "test")
s.NoError(err)
var queryResultStr string
err = queryResult.Get(&queryResultStr)
s.NoError(err)
s.Equal("query works", queryResultStr)
// verify query is handed by sticky worker (no replay)
s.Equal(int32(1), replayCount)
}
func (s *clientFunctionalSuite) TestQueryWorkflow_Consistent_PiggybackQuery() {
workflowFn := func(ctx workflow.Context) (string, error) {
var receivedMsgs string
workflow.SetQueryHandler(ctx, "test", func() (string, error) {
return receivedMsgs, nil
})
signalCh := workflow.GetSignalChannel(ctx, "test")
for {
var msg string
signalCh.Receive(ctx, &msg)
receivedMsgs += msg
if msg == "pause" {
// block workflow task for 3s.
workflow.ExecuteLocalActivity(ctx, func() {
time.Sleep(time.Second * 3)
}).Get(ctx, nil)
}
}
}
s.worker.RegisterWorkflow(workflowFn)
id := "test-query-consistent"
workflowOptions := sdkclient.StartWorkflowOptions{
ID: id,
TaskQueue: s.taskQueue,
WorkflowRunTimeout: 20 * time.Second,
}
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
workflowRun, err := s.sdkClient.ExecuteWorkflow(ctx, workflowOptions, workflowFn)
if err != nil {
s.Logger.Fatal("Start workflow failed with err", tag.Error(err))
}
s.NotNil(workflowRun)
s.True(workflowRun.GetRunID() != "")
err = s.sdkClient.SignalWorkflow(ctx, id, "", "test", "pause")
s.NoError(err)
err = s.sdkClient.SignalWorkflow(ctx, id, "", "test", "abc")
s.NoError(err)
queryResult, err := s.sdkClient.QueryWorkflow(ctx, id, "", "test")
s.NoError(err)
var queryResultStr string
err = queryResult.Get(&queryResultStr)
s.NoError(err)
// verify query sees all signals before it
s.Equal("pauseabc", queryResultStr)
}
func (s *clientFunctionalSuite) TestQueryWorkflow_QueryWhileBackoff() {
workflowFn := func(ctx workflow.Context) (string, error) {
workflow.SetQueryHandler(ctx, "test", func() (string, error) {
return "should-reach-here", nil
})
return "", temporal.NewApplicationError("retry-me", "test-error")
}
s.worker.RegisterWorkflow(workflowFn)
id := "test-query-before-backoff"
workflowOptions := sdkclient.StartWorkflowOptions{
ID: id,
TaskQueue: s.taskQueue,
WorkflowRunTimeout: 20 * time.Second,
RetryPolicy: &temporal.RetryPolicy{
InitialInterval: 10 * time.Second,
},
}
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
workflowRun, err := s.sdkClient.ExecuteWorkflow(ctx, workflowOptions, workflowFn)
if err != nil {
s.Logger.Fatal("Start workflow failed with err", tag.Error(err))
}
s.NotNil(workflowRun)
s.True(workflowRun.GetRunID() != "")
// wait until retry with backoff is scheduled
findBackoffWorkflow := false
for i := 0; i < 5; i++ {
historyEvents := s.getHistory(s.namespace, &commonpb.WorkflowExecution{
WorkflowId: id,
})
s.True(len(historyEvents) > 0)
startEvent := historyEvents[0]
startAttributes := startEvent.GetWorkflowExecutionStartedEventAttributes()
s.NotNil(startAttributes)
if startAttributes.FirstWorkflowTaskBackoff != nil && *startAttributes.FirstWorkflowTaskBackoff > 0 {
findBackoffWorkflow = true
break
}
// wait for the retry, which will have backoff
time.Sleep(time.Second)
}
s.True(findBackoffWorkflow)
_, err = s.sdkClient.QueryWorkflow(ctx, id, "", "test")
s.Error(err)
s.ErrorContains(err, consts.ErrWorkflowTaskNotScheduled.Error())
}
func (s *clientFunctionalSuite) TestQueryWorkflow_QueryBeforeStart() {
// stop the worker, so the workflow won't be started before query
s.worker.Stop()
workflowFn := func(ctx workflow.Context) (string, error) {
status := "initialized"
workflow.SetQueryHandler(ctx, "test", func() (string, error) {
return status, nil
})
status = "started"
workflow.Sleep(ctx, time.Hour)
return "", nil
}
id := "test-query-before-start"
workflowOptions := sdkclient.StartWorkflowOptions{
ID: id,
TaskQueue: s.taskQueue,
WorkflowRunTimeout: 20 * time.Second,
}
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
workflowRun, err := s.sdkClient.ExecuteWorkflow(ctx, workflowOptions, workflowFn)
if err != nil {
s.Logger.Fatal("Start workflow failed with err", tag.Error(err))
}
s.NotNil(workflowRun)
s.True(workflowRun.GetRunID() != "")
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
defer wg.Done()
startTime := time.Now()
queryResult, err := s.sdkClient.QueryWorkflow(ctx, id, "", "test")
endTime := time.Now()
s.NoError(err)
var queryResultStr string
err = queryResult.Get(&queryResultStr)
s.NoError(err)
// verify query sees all signals before it
s.Equal("started", queryResultStr)
s.True(endTime.Sub(startTime) > time.Second)
}()
// delay 2s to start worker, this will block query for 2s
time.Sleep(time.Second * 2)
s.worker = worker.New(s.sdkClient, s.taskQueue, worker.Options{})
s.worker.RegisterWorkflow(workflowFn)
if err := s.worker.Start(); err != nil {
s.Logger.Fatal("Error when start worker", tag.Error(err))
}
// wait query
wg.Wait()
}
func (s *clientFunctionalSuite) TestQueryWorkflow_QueryFailedWorkflowTask() {
workflowFn := func(ctx workflow.Context) (string, error) {
err := workflow.SetQueryHandler(ctx, "test", func() (string, error) {
return "", nil
})
if err != nil {
s.T().Fatalf("SetQueryHandler failed: %s", err.Error())
}
// force workflow task to fail
panic("Workflow failed")
}
s.worker.RegisterWorkflow(workflowFn)
id := "test-query-failed-workflow-task"
workflowOptions := sdkclient.StartWorkflowOptions{
ID: id,
TaskQueue: s.taskQueue,
WorkflowTaskTimeout: time.Second * 1, // use shorter wft timeout to make this test faster
WorkflowRunTimeout: 20 * time.Second,
}
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
workflowRun, err := s.sdkClient.ExecuteWorkflow(ctx, workflowOptions, workflowFn)
if err != nil {
s.Logger.Fatal("Start workflow failed with err", tag.Error(err))
}
s.NotNil(workflowRun)
s.True(workflowRun.GetRunID() != "")
// wait for workflow task to fail 3 times
time.Sleep(time.Second * 3) // 1st_attempt, 0_delay, 2nd_attempt, 1s_delay, 3rd_attempt
_, err = s.sdkClient.QueryWorkflow(ctx, id, "", "test")
s.Error(err)
s.IsType(&serviceerror.WorkflowNotReady{}, err)
}
func (s *clientFunctionalSuite) TestQueryWorkflow_ClosedWithoutWorkflowTaskStarted() {
workflowFn := func(ctx workflow.Context) (string, error) {
return "", nil
}
id := "test-query-after-terminate"
workflowOptions := sdkclient.StartWorkflowOptions{
ID: id,
TaskQueue: s.taskQueue,
}
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
workflowRun, err := s.sdkClient.ExecuteWorkflow(ctx, workflowOptions, workflowFn)
if err != nil {
s.Logger.Fatal("Start workflow failed with err", tag.Error(err))
}
s.NotNil(workflowRun)
s.True(workflowRun.GetRunID() != "")
err = s.sdkClient.TerminateWorkflow(ctx, id, "", "terminating to make sure query fails")
s.NoError(err)
_, err = s.sdkClient.QueryWorkflow(ctx, id, "", "test")
s.Error(err)
s.ErrorContains(err, consts.ErrWorkflowClosedBeforeWorkflowTaskStarted.Error())
}