/
transfer_queue_task_executor_base.go
275 lines (254 loc) · 10.1 KB
/
transfer_queue_task_executor_base.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
// 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 history
import (
"context"
"time"
commonpb "go.temporal.io/api/common/v1"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/api/serviceerror"
taskqueuepb "go.temporal.io/api/taskqueue/v1"
"google.golang.org/protobuf/types/known/durationpb"
"go.temporal.io/server/api/matchingservice/v1"
taskqueuespb "go.temporal.io/server/api/taskqueue/v1"
"go.temporal.io/server/common"
"go.temporal.io/server/common/debug"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/namespace"
"go.temporal.io/server/common/persistence/visibility/manager"
"go.temporal.io/server/common/resource"
"go.temporal.io/server/common/searchattribute"
"go.temporal.io/server/service/history/configs"
"go.temporal.io/server/service/history/consts"
"go.temporal.io/server/service/history/deletemanager"
"go.temporal.io/server/service/history/queues"
"go.temporal.io/server/service/history/shard"
"go.temporal.io/server/service/history/tasks"
"go.temporal.io/server/service/history/vclock"
"go.temporal.io/server/service/history/workflow"
wcache "go.temporal.io/server/service/history/workflow/cache"
)
const (
taskTimeout = time.Second * 3 * debug.TimeoutMultiplier
taskHistoryOpTimeout = 20 * time.Second
)
var (
errUnknownTransferTask = serviceerror.NewInternal("Unknown transfer task")
)
type (
transferQueueTaskExecutorBase struct {
currentClusterName string
shardContext shard.Context
registry namespace.Registry
cache wcache.Cache
logger log.Logger
metricHandler metrics.Handler
historyRawClient resource.HistoryRawClient
matchingRawClient resource.MatchingRawClient
config *configs.Config
searchAttributesProvider searchattribute.Provider
visibilityManager manager.VisibilityManager
workflowDeleteManager deletemanager.DeleteManager
}
)
func newTransferQueueTaskExecutorBase(
shardContext shard.Context,
workflowCache wcache.Cache,
logger log.Logger,
metricHandler metrics.Handler,
historyRawClient resource.HistoryRawClient,
matchingRawClient resource.MatchingRawClient,
visibilityManager manager.VisibilityManager,
) *transferQueueTaskExecutorBase {
return &transferQueueTaskExecutorBase{
currentClusterName: shardContext.GetClusterMetadata().GetCurrentClusterName(),
shardContext: shardContext,
registry: shardContext.GetNamespaceRegistry(),
cache: workflowCache,
logger: logger,
metricHandler: metricHandler,
historyRawClient: historyRawClient,
matchingRawClient: matchingRawClient,
config: shardContext.GetConfig(),
searchAttributesProvider: shardContext.GetSearchAttributesProvider(),
visibilityManager: visibilityManager,
workflowDeleteManager: deletemanager.NewDeleteManager(
shardContext,
workflowCache,
shardContext.GetConfig(),
shardContext.GetTimeSource(),
visibilityManager,
),
}
}
func (t *transferQueueTaskExecutorBase) pushActivity(
ctx context.Context,
task *tasks.ActivityTask,
activityScheduleToStartTimeout time.Duration,
directive *taskqueuespb.TaskVersionDirective,
) error {
_, err := t.matchingRawClient.AddActivityTask(ctx, &matchingservice.AddActivityTaskRequest{
NamespaceId: task.NamespaceID,
Execution: &commonpb.WorkflowExecution{
WorkflowId: task.WorkflowID,
RunId: task.RunID,
},
TaskQueue: &taskqueuepb.TaskQueue{
Name: task.TaskQueue,
Kind: enumspb.TASK_QUEUE_KIND_NORMAL,
},
ScheduledEventId: task.ScheduledEventID,
ScheduleToStartTimeout: durationpb.New(activityScheduleToStartTimeout),
Clock: vclock.NewVectorClock(t.shardContext.GetClusterMetadata().GetClusterID(), t.shardContext.GetShardID(), task.TaskID),
VersionDirective: directive,
})
if _, isNotFound := err.(*serviceerror.NotFound); isNotFound {
// NotFound error is not expected for AddTasks calls
// but will be ignored by task error handling logic, so log it here
tasks.InitializeLogger(task, t.logger).Error("Matching returned not found error for AddActivityTask", tag.Error(err))
}
return err
}
func (t *transferQueueTaskExecutorBase) pushWorkflowTask(
ctx context.Context,
task *tasks.WorkflowTask,
taskqueue *taskqueuepb.TaskQueue,
workflowTaskScheduleToStartTimeout time.Duration,
directive *taskqueuespb.TaskVersionDirective,
) error {
var sst *durationpb.Duration
if workflowTaskScheduleToStartTimeout > 0 {
sst = durationpb.New(workflowTaskScheduleToStartTimeout)
}
_, err := t.matchingRawClient.AddWorkflowTask(ctx, &matchingservice.AddWorkflowTaskRequest{
NamespaceId: task.NamespaceID,
Execution: &commonpb.WorkflowExecution{
WorkflowId: task.WorkflowID,
RunId: task.RunID,
},
TaskQueue: taskqueue,
ScheduledEventId: task.ScheduledEventID,
ScheduleToStartTimeout: sst,
Clock: vclock.NewVectorClock(t.shardContext.GetClusterMetadata().GetClusterID(), t.shardContext.GetShardID(), task.TaskID),
VersionDirective: directive,
})
if _, isNotFound := err.(*serviceerror.NotFound); isNotFound {
// NotFound error is not expected for AddTasks calls
// but will be ignored by task error handling logic, so log it here
tasks.InitializeLogger(task, t.logger).Error("Matching returned not found error for AddWorkflowTask", tag.Error(err))
}
return err
}
func (t *transferQueueTaskExecutorBase) processDeleteExecutionTask(
ctx context.Context,
task *tasks.DeleteExecutionTask,
ensureNoPendingCloseTask bool,
) error {
return t.deleteExecution(ctx, task, false, ensureNoPendingCloseTask, &task.ProcessStage)
}
func (t *transferQueueTaskExecutorBase) deleteExecution(
ctx context.Context,
task tasks.Task,
forceDeleteFromOpenVisibility bool,
ensureNoPendingCloseTask bool,
stage *tasks.DeleteWorkflowExecutionStage,
) (retError error) {
ctx, cancel := context.WithTimeout(ctx, taskTimeout)
defer cancel()
workflowExecution := commonpb.WorkflowExecution{
WorkflowId: task.GetWorkflowID(),
RunId: task.GetRunID(),
}
weCtx, release, err := t.cache.GetOrCreateWorkflowExecution(
ctx,
t.shardContext,
namespace.ID(task.GetNamespaceID()),
&workflowExecution,
workflow.LockPriorityLow,
)
if err != nil {
return err
}
defer func() { release(retError) }()
mutableState, err := loadMutableStateForTransferTask(ctx, t.shardContext, weCtx, task, t.metricHandler, t.logger)
if err != nil {
return err
}
// Here, we ensure that the workflow is closed successfully before deleting it. Otherwise, the mutable state
// might be deleted before the close task is executed, and so the close task will be dropped. In passive cluster,
// this check can be ignored.
//
// Additionally, this function itself could be called from within the close execution task, so we need to skip
// the check in that case because the close execution task would be waiting for itself to finish forever. So, the
// ensureNoPendingCloseTask flag is set iff we're running in the active cluster, and we aren't processing the
// CloseExecutionTask from within this same goroutine.
if ensureNoPendingCloseTask {
// Unfortunately, queue states/ack levels are updated with delay (default 30s), therefore this could fail if the
// workflow was closed before the queue state/ack levels were updated, so we return a retryable error.
if t.isCloseExecutionTaskPending(mutableState, weCtx) {
return consts.ErrDependencyTaskNotCompleted
}
}
// If task version is EmptyVersion it means "don't check task version".
// This can happen when task was created from explicit user API call.
// Or the namespace is a local namespace which will not have version conflict.
if task.GetVersion() != common.EmptyVersion {
lastWriteVersion, err := mutableState.GetLastWriteVersion()
if err != nil {
return err
}
err = CheckTaskVersion(t.shardContext, t.logger, mutableState.GetNamespaceEntry(), lastWriteVersion, task.GetVersion(), task)
if err != nil {
return err
}
}
return t.workflowDeleteManager.DeleteWorkflowExecution(
ctx,
namespace.ID(task.GetNamespaceID()),
&workflowExecution,
weCtx,
mutableState,
forceDeleteFromOpenVisibility,
stage,
)
}
func (t *transferQueueTaskExecutorBase) isCloseExecutionTaskPending(ms workflow.MutableState, weCtx workflow.Context) bool {
closeTransferTaskId := ms.GetExecutionInfo().CloseTransferTaskId
// taskID == 0 if workflow closed before this field was added (v1.17).
if closeTransferTaskId == 0 {
return false
}
// check if close execution transfer task is completed
transferQueueState, ok := t.shardContext.GetQueueState(tasks.CategoryTransfer)
if !ok {
return true
}
fakeCloseTransferTask := &tasks.CloseExecutionTask{
WorkflowKey: weCtx.GetWorkflowKey(),
TaskID: closeTransferTaskId,
}
return !queues.IsTaskAcked(fakeCloseTransferTask, transferQueueState)
}