/
factory.go
241 lines (218 loc) · 8.58 KB
/
factory.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
// 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 client
import (
"go.temporal.io/api/serviceerror"
"go.temporal.io/server/common"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
p "go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/persistence/serialization"
"go.temporal.io/server/common/quotas"
)
var (
retryPolicy = common.CreatePersistenceClientRetryPolicy()
)
type (
// Factory defines the interface for any implementation that can vend
// persistence layer objects backed by a datastore. The actual datastore
// is implementation detail hidden behind this interface
Factory interface {
// Close the factory
Close()
// NewTaskManager returns a new task manager
NewTaskManager() (p.TaskManager, error)
// NewShardManager returns a new shard manager
NewShardManager() (p.ShardManager, error)
// NewMetadataManager returns a new metadata manager
NewMetadataManager() (p.MetadataManager, error)
// NewExecutionManager returns a new execution manager
NewExecutionManager() (p.ExecutionManager, error)
// NewNamespaceReplicationQueue returns a new queue for namespace replication
NewNamespaceReplicationQueue() (p.NamespaceReplicationQueue, error)
// NewClusterMetadataManager returns a new manager for cluster specific metadata
NewClusterMetadataManager() (p.ClusterMetadataManager, error)
}
factoryImpl struct {
dataStoreFactory DataStoreFactory
config *config.Persistence
serializer serialization.Serializer
metricsHandler metrics.Handler
logger log.Logger
clusterName string
ratelimiter quotas.RequestRateLimiter
healthSignals p.HealthSignalAggregator
}
)
// NewFactory returns an implementation of factory that vends persistence objects based on
// specified configuration. This factory takes as input a config.Persistence object
// which specifies the datastore to be used for a given type of object. This config
// also contains config for individual datastores themselves.
//
// The objects returned by this factory enforce ratelimit and maxconns according to
// given configuration. In addition, all objects will emit metrics automatically
func NewFactory(
dataStoreFactory DataStoreFactory,
cfg *config.Persistence,
ratelimiter quotas.RequestRateLimiter,
serializer serialization.Serializer,
clusterName string,
metricsHandler metrics.Handler,
logger log.Logger,
healthSignals p.HealthSignalAggregator,
) Factory {
factory := &factoryImpl{
dataStoreFactory: dataStoreFactory,
config: cfg,
serializer: serializer,
metricsHandler: metricsHandler,
logger: logger,
clusterName: clusterName,
ratelimiter: ratelimiter,
healthSignals: healthSignals,
}
factory.initDependencies()
return factory
}
// NewTaskManager returns a new task manager
func (f *factoryImpl) NewTaskManager() (p.TaskManager, error) {
taskStore, err := f.dataStoreFactory.NewTaskStore()
if err != nil {
return nil, err
}
result := p.NewTaskManager(taskStore, f.serializer)
if f.ratelimiter != nil {
result = p.NewTaskPersistenceRateLimitedClient(result, f.ratelimiter, f.logger)
}
if f.metricsHandler != nil && f.healthSignals != nil {
result = p.NewTaskPersistenceMetricsClient(result, f.metricsHandler, f.healthSignals, f.logger)
}
result = p.NewTaskPersistenceRetryableClient(result, retryPolicy, IsPersistenceTransientError)
return result, nil
}
// NewShardManager returns a new shard manager
func (f *factoryImpl) NewShardManager() (p.ShardManager, error) {
shardStore, err := f.dataStoreFactory.NewShardStore()
if err != nil {
return nil, err
}
result := p.NewShardManager(shardStore, f.serializer)
if f.ratelimiter != nil {
result = p.NewShardPersistenceRateLimitedClient(result, f.ratelimiter, f.logger)
}
if f.metricsHandler != nil && f.healthSignals != nil {
result = p.NewShardPersistenceMetricsClient(result, f.metricsHandler, f.healthSignals, f.logger)
}
result = p.NewShardPersistenceRetryableClient(result, retryPolicy, IsPersistenceTransientError)
return result, nil
}
// NewMetadataManager returns a new metadata manager
func (f *factoryImpl) NewMetadataManager() (p.MetadataManager, error) {
store, err := f.dataStoreFactory.NewMetadataStore()
if err != nil {
return nil, err
}
result := p.NewMetadataManagerImpl(store, f.serializer, f.logger, f.clusterName)
if f.ratelimiter != nil {
result = p.NewMetadataPersistenceRateLimitedClient(result, f.ratelimiter, f.logger)
}
if f.metricsHandler != nil && f.healthSignals != nil {
result = p.NewMetadataPersistenceMetricsClient(result, f.metricsHandler, f.healthSignals, f.logger)
}
result = p.NewMetadataPersistenceRetryableClient(result, retryPolicy, IsPersistenceTransientError)
return result, nil
}
// NewClusterMetadataManager returns a new cluster metadata manager
func (f *factoryImpl) NewClusterMetadataManager() (p.ClusterMetadataManager, error) {
store, err := f.dataStoreFactory.NewClusterMetadataStore()
if err != nil {
return nil, err
}
result := p.NewClusterMetadataManagerImpl(store, f.serializer, f.clusterName, f.logger)
if f.ratelimiter != nil {
result = p.NewClusterMetadataPersistenceRateLimitedClient(result, f.ratelimiter, f.logger)
}
if f.metricsHandler != nil && f.healthSignals != nil {
result = p.NewClusterMetadataPersistenceMetricsClient(result, f.metricsHandler, f.healthSignals, f.logger)
}
result = p.NewClusterMetadataPersistenceRetryableClient(result, retryPolicy, IsPersistenceTransientError)
return result, nil
}
// NewExecutionManager returns a new execution manager
func (f *factoryImpl) NewExecutionManager() (p.ExecutionManager, error) {
store, err := f.dataStoreFactory.NewExecutionStore()
if err != nil {
return nil, err
}
result := p.NewExecutionManager(store, f.serializer, f.logger, f.config.TransactionSizeLimit)
if f.ratelimiter != nil {
result = p.NewExecutionPersistenceRateLimitedClient(result, f.ratelimiter, f.logger)
}
if f.metricsHandler != nil && f.healthSignals != nil {
result = p.NewExecutionPersistenceMetricsClient(result, f.metricsHandler, f.healthSignals, f.logger)
}
result = p.NewExecutionPersistenceRetryableClient(result, retryPolicy, IsPersistenceTransientError)
return result, nil
}
func (f *factoryImpl) NewNamespaceReplicationQueue() (p.NamespaceReplicationQueue, error) {
result, err := f.dataStoreFactory.NewQueue(p.NamespaceReplicationQueueType)
if err != nil {
return nil, err
}
if f.ratelimiter != nil {
result = p.NewQueuePersistenceRateLimitedClient(result, f.ratelimiter, f.logger)
}
if f.metricsHandler != nil && f.healthSignals != nil {
result = p.NewQueuePersistenceMetricsClient(result, f.metricsHandler, f.healthSignals, f.logger)
}
result = p.NewQueuePersistenceRetryableClient(result, retryPolicy, IsPersistenceTransientError)
return p.NewNamespaceReplicationQueue(result, f.serializer, f.clusterName, f.metricsHandler, f.logger)
}
// Close closes this factory
func (f *factoryImpl) Close() {
f.dataStoreFactory.Close()
if f.healthSignals != nil {
f.healthSignals.Stop()
}
}
func IsPersistenceTransientError(err error) bool {
switch err.(type) {
case *serviceerror.Unavailable:
return true
}
return false
}
func (f *factoryImpl) initDependencies() {
if f.metricsHandler == nil && f.healthSignals == nil {
return
}
if f.metricsHandler == nil {
f.metricsHandler = metrics.NoopMetricsHandler
}
if f.healthSignals == nil {
f.healthSignals = p.NoopHealthSignalAggregator
}
f.healthSignals.Start()
}