/
factory.go
189 lines (168 loc) · 5.25 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
// Copyright (c) 2017 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 sql
import (
"fmt"
"sync"
"github.com/uber/cadence/common/persistence/serialization"
"github.com/uber/cadence/common/config"
"github.com/uber/cadence/common/log"
p "github.com/uber/cadence/common/persistence"
"github.com/uber/cadence/common/persistence/sql/sqlplugin"
)
type (
// Factory vends store objects backed by MySQL
Factory struct {
cfg config.SQL
dbConn dbConn
clusterName string
logger log.Logger
parser serialization.Parser
}
// dbConn represents a logical mysql connection - its a
// wrapper around the standard sql connection pool with
// additional reference counting
dbConn struct {
sync.Mutex
sqlplugin.DB
refCnt int
cfg *config.SQL
}
)
// NewFactory returns an instance of a factory object which can be used to create
// datastores backed by any kind of SQL store
func NewFactory(
cfg config.SQL,
clusterName string,
logger log.Logger,
parser serialization.Parser,
) *Factory {
return &Factory{
cfg: cfg,
clusterName: clusterName,
logger: logger,
dbConn: newRefCountedDBConn(&cfg),
parser: parser,
}
}
// NewTaskStore returns a new task store
func (f *Factory) NewTaskStore() (p.TaskStore, error) {
conn, err := f.dbConn.get()
if err != nil {
return nil, err
}
return newTaskPersistence(conn, f.cfg.NumShards, f.logger, f.parser)
}
// NewShardStore returns a new shard store
func (f *Factory) NewShardStore() (p.ShardStore, error) {
conn, err := f.dbConn.get()
if err != nil {
return nil, err
}
return NewShardPersistence(conn, f.clusterName, f.logger, f.parser)
}
// NewHistoryV2Store returns a new history store
func (f *Factory) NewHistoryV2Store() (p.HistoryStore, error) {
conn, err := f.dbConn.get()
if err != nil {
return nil, err
}
return NewHistoryV2Persistence(conn, f.logger, f.parser)
}
// NewMetadataStore returns a new metadata store
func (f *Factory) NewMetadataStore() (p.MetadataStore, error) {
conn, err := f.dbConn.get()
if err != nil {
return nil, err
}
return newMetadataPersistenceV2(conn, f.clusterName, f.logger, f.parser)
}
// NewExecutionStore returns an ExecutionStore for a given shardID
func (f *Factory) NewExecutionStore(shardID int) (p.ExecutionStore, error) {
conn, err := f.dbConn.get()
if err != nil {
return nil, err
}
return NewSQLExecutionStore(conn, f.logger, shardID, f.parser)
}
// NewVisibilityStore returns a visibility store
// TODO sortByCloseTime will be removed and implemented for https://github.com/uber/cadence/issues/3621
func (f *Factory) NewVisibilityStore(sortByCloseTime bool) (p.VisibilityStore, error) {
return NewSQLVisibilityStore(f.cfg, f.logger)
}
// NewQueue returns a new queue backed by sql
func (f *Factory) NewQueue(queueType p.QueueType) (p.Queue, error) {
conn, err := f.dbConn.get()
if err != nil {
return nil, err
}
return newQueueStore(conn, f.logger, queueType)
}
// Close closes the factory
func (f *Factory) Close() {
f.dbConn.forceClose()
}
// newRefCountedDBConn returns a logical mysql connection that
// uses reference counting to decide when to close the
// underlying connection object. The reference count gets incremented
// everytime get() is called and decremented everytime Close() is called
func newRefCountedDBConn(cfg *config.SQL) dbConn {
return dbConn{cfg: cfg}
}
// get returns a mysql db connection and increments a reference count
// this method will create a new connection, if an existing connection
// does not exist
func (c *dbConn) get() (sqlplugin.DB, error) {
c.Lock()
defer c.Unlock()
if c.refCnt == 0 {
conn, err := NewSQLDB(c.cfg)
if err != nil {
return nil, err
}
c.DB = conn
}
c.refCnt++
return c, nil
}
// forceClose ignores reference counts and shutsdown the underlying connection pool
func (c *dbConn) forceClose() {
c.Lock()
defer c.Unlock()
if c.DB != nil {
err := c.DB.Close()
if err != nil {
fmt.Println("failed to close database connection, may leak some connection", err)
}
}
c.refCnt = 0
}
// Close closes the underlying connection if the reference count becomes zero
func (c *dbConn) Close() error {
c.Lock()
defer c.Unlock()
c.refCnt--
if c.refCnt == 0 {
err := c.DB.Close()
c.DB = nil
return err
}
return nil
}