forked from apache/incubator-seata-go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
conn_xa.go
395 lines (339 loc) · 10.2 KB
/
conn_xa.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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package sql
import (
"context"
gosql "database/sql"
"database/sql/driver"
"errors"
"fmt"
"time"
"github.com/seata/seata-go/pkg/datasource/sql/types"
"github.com/seata/seata-go/pkg/datasource/sql/xa"
"github.com/seata/seata-go/pkg/tm"
"github.com/seata/seata-go/pkg/util/log"
)
var xaConnTimeout time.Duration
// XAConn Database connection proxy object under XA transaction model
// Conn is assumed to be stateful.
type XAConn struct {
*Conn
tx driver.Tx
xaResource xa.XAResource
xaBranchXid *XABranchXid
xaActive bool
rollBacked bool
branchRegisterTime time.Time
prepareTime time.Time
isConnKept bool
}
func (c *XAConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) {
if c.createOnceTxContext(ctx) {
defer func() {
c.txCtx = types.NewTxCtx()
}()
}
//ret, err := c.createNewTxOnExecIfNeed(ctx, func() (types, error) {
// ret, err := c.Conn.PrepareContext(ctx, query)
// if err != nil {
// return nil, err
// }
// return types.NewResult(types.WithRows(ret)), nil
//})
return c.Conn.PrepareContext(ctx, query)
}
// QueryContext exec xa sql
func (c *XAConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) {
if c.createOnceTxContext(ctx) {
defer func() {
c.txCtx = types.NewTxCtx()
}()
}
ret, err := c.createNewTxOnExecIfNeed(ctx, func() (types.ExecResult, error) {
ret, err := c.Conn.QueryContext(ctx, query, args)
if err != nil {
return nil, err
}
return types.NewResult(types.WithRows(ret)), nil
})
if err != nil {
return nil, err
}
return ret.GetRows(), nil
}
func (c *XAConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) {
if c.createOnceTxContext(ctx) {
defer func() {
c.txCtx = types.NewTxCtx()
}()
}
ret, err := c.createNewTxOnExecIfNeed(ctx, func() (types.ExecResult, error) {
ret, err := c.Conn.ExecContext(ctx, query, args)
if err != nil {
return nil, err
}
return types.NewResult(types.WithResult(ret)), nil
})
return ret.GetResult(), err
}
// BeginTx like common transaction. but it just exec XA START
func (c *XAConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) {
c.autoCommit = false
c.txCtx = types.NewTxCtx()
c.txCtx.DBType = c.res.dbType
c.txCtx.TxOpt = opts
c.txCtx.ResourceID = c.res.resourceID
if tm.IsGlobalTx(ctx) {
c.txCtx.XID = tm.GetXID(ctx)
c.txCtx.TransactionMode = types.XAMode
}
tx, err := c.Conn.BeginTx(ctx, opts)
if err != nil {
return nil, err
}
c.tx = tx
if !c.autoCommit {
if c.xaActive {
return nil, errors.New("should NEVER happen: setAutoCommit from true to false while xa branch is active")
}
baseTx, ok := tx.(*Tx)
if !ok {
return nil, fmt.Errorf("start xa %s transaction failure for the tx is a wrong type", c.txCtx.XID)
}
c.branchRegisterTime = time.Now()
if err := baseTx.register(c.txCtx); err != nil {
c.cleanXABranchContext()
return nil, fmt.Errorf("failed to register xa branch %s, err:%w", c.txCtx.XID, err)
}
c.xaBranchXid = XaIdBuild(c.txCtx.XID, c.txCtx.BranchID)
c.keepIfNecessary()
if err = c.start(ctx); err != nil {
c.cleanXABranchContext()
return nil, fmt.Errorf("failed to start xa branch xid:%s err:%w", c.txCtx.XID, err)
}
c.xaActive = true
}
return &XATx{tx: tx.(*Tx)}, nil
}
func (c *XAConn) createOnceTxContext(ctx context.Context) bool {
onceTx := tm.IsGlobalTx(ctx) && c.autoCommit
if onceTx {
c.txCtx = types.NewTxCtx()
c.txCtx.DBType = c.res.dbType
c.txCtx.ResourceID = c.res.resourceID
c.txCtx.XID = tm.GetXID(ctx)
c.txCtx.TransactionMode = types.XAMode
c.txCtx.GlobalLockRequire = true
}
return onceTx
}
func (c *XAConn) createNewTxOnExecIfNeed(ctx context.Context, f func() (types.ExecResult, error)) (types.ExecResult, error) {
var err error
currentAutoCommit := c.autoCommit
if c.txCtx.TransactionMode != types.Local && c.autoCommit {
_, err = c.BeginTx(ctx, driver.TxOptions{Isolation: driver.IsolationLevel(gosql.LevelDefault)})
if err != nil {
return nil, err
}
}
defer func() {
recoverErr := recover()
if err != nil || recoverErr != nil {
log.Errorf("conn at rollback error:%v or recoverErr:%v", err, recoverErr)
if c.tx != nil {
rollbackErr := c.tx.Rollback()
if rollbackErr != nil {
log.Errorf("conn at rollback error:%v", rollbackErr)
}
}
}
}()
// execute SQL
ret, err := f()
if err != nil {
// XA End & Rollback
if rollbackErr := c.Rollback(ctx); rollbackErr != nil {
log.Errorf("failed to rollback xa branch of :%s, err:%w", c.txCtx.XID, rollbackErr)
}
return nil, err
}
if currentAutoCommit {
if err := c.Commit(ctx); err != nil {
log.Errorf("xa connection proxy commit failure xid:%s, err:%v", c.txCtx.XID, err)
// XA End & Rollback
if err := c.Rollback(ctx); err != nil {
log.Errorf("xa connection proxy rollback failure xid:%s, err:%v", c.txCtx.XID, err)
}
}
}
return ret, nil
}
func (c *XAConn) keepIfNecessary() {
if c.ShouldBeHeld() {
if err := c.res.Hold(c.xaBranchXid.String(), c); err == nil {
c.isConnKept = true
}
}
}
func (c *XAConn) releaseIfNecessary() {
if c.ShouldBeHeld() && c.xaBranchXid.String() != "" {
if c.isConnKept {
c.res.Release(c.xaBranchXid.String())
c.isConnKept = false
}
}
}
func (c *XAConn) start(ctx context.Context) error {
xaResource, err := xa.CreateXAResource(c.Conn.targetConn, c.dbType)
if err != nil {
return fmt.Errorf("create xa xid:%s resoruce err:%w", c.txCtx.XID, err)
}
c.xaResource = xaResource
if err := c.xaResource.Start(ctx, c.xaBranchXid.String(), xa.TMNoFlags); err != nil {
return fmt.Errorf("xa xid %s resource connection start err:%w", c.txCtx.XID, err)
}
if err := c.termination(c.xaBranchXid.String()); err != nil {
c.xaResource.End(ctx, c.xaBranchXid.String(), xa.TMFail)
c.XaRollback(ctx, c.xaBranchXid)
return err
}
return err
}
func (c *XAConn) end(ctx context.Context, flags int) error {
err := c.termination(c.xaBranchXid.String())
if err != nil {
return err
}
err = c.xaResource.End(ctx, c.xaBranchXid.String(), flags)
if err != nil {
return err
}
return nil
}
func (c *XAConn) termination(xaBranchXid string) error {
branchStatus, err := branchStatus(xaBranchXid)
if err != nil {
c.releaseIfNecessary()
return fmt.Errorf("failed xa branch [%v] the global transaction has finish, branch status: [%v]", c.txCtx.XID, branchStatus)
}
return nil
}
func (c *XAConn) cleanXABranchContext() {
h, _ := time.ParseDuration("-1000h")
c.branchRegisterTime = time.Now().Add(h)
c.prepareTime = time.Now().Add(h)
c.xaActive = false
if !c.isConnKept {
c.xaBranchXid = nil
}
}
func (c *XAConn) Rollback(ctx context.Context) error {
if c.autoCommit {
return nil
}
if !c.xaActive || c.xaBranchXid == nil {
return fmt.Errorf("should NOT rollback on an inactive session")
}
if !c.rollBacked {
if c.xaResource.End(ctx, c.xaBranchXid.String(), xa.TMFail) != nil {
return c.rollbackErrorHandle()
}
if c.XaRollback(ctx, c.xaBranchXid) != nil {
c.cleanXABranchContext()
return c.rollbackErrorHandle()
}
if err := c.tx.Rollback(); err != nil {
c.cleanXABranchContext()
return fmt.Errorf("failed to report XA branch commit-failure on xid:%s err:%w", c.txCtx.XID, err)
}
}
c.cleanXABranchContext()
return nil
}
func (c *XAConn) rollbackErrorHandle() error {
return fmt.Errorf("failed to end(TMFAIL) xa branch on [%v] - [%v]", c.txCtx.XID, c.xaBranchXid.GetBranchId())
}
func (c *XAConn) Commit(ctx context.Context) error {
if c.autoCommit {
return nil
}
if !c.xaActive || c.xaBranchXid == nil {
return fmt.Errorf("should NOT commit on an inactive session")
}
now := time.Now()
if c.end(ctx, xa.TMSuccess) != nil {
return c.commitErrorHandle(ctx)
}
if c.checkTimeout(ctx, now) != nil {
return c.commitErrorHandle(ctx)
}
if c.xaResource.XAPrepare(ctx, c.xaBranchXid.String()) != nil {
return c.commitErrorHandle(ctx)
}
return nil
}
func (c *XAConn) commitErrorHandle(ctx context.Context) error {
var err error
if err = c.XaRollback(ctx, c.xaBranchXid); err != nil {
err = fmt.Errorf("failed to report XA branch commit-failure xid:%s, err:%w", c.txCtx.XID, err)
}
c.cleanXABranchContext()
return err
}
func (c *XAConn) ShouldBeHeld() bool {
return c.res.IsShouldBeHeld() || (c.res.GetDbType().String() != "" && c.res.GetDbType() != types.DBTypeUnknown)
}
func (c *XAConn) checkTimeout(ctx context.Context, now time.Time) error {
if now.Sub(c.branchRegisterTime) > xaConnTimeout {
c.XaRollback(ctx, c.xaBranchXid)
return fmt.Errorf("XA branch timeout error xid:%s", c.txCtx.XID)
}
return nil
}
func (c *XAConn) Close() error {
c.rollBacked = false
if c.isConnKept && c.ShouldBeHeld() {
return nil
}
c.cleanXABranchContext()
if err := c.Conn.Close(); err != nil {
return err
}
return nil
}
func (c *XAConn) CloseForce() error {
if err := c.Conn.Close(); err != nil {
return err
}
c.rollBacked = false
c.cleanXABranchContext()
c.releaseIfNecessary()
return nil
}
func (c *XAConn) XaCommit(ctx context.Context, xaXid XAXid) error {
err := c.xaResource.Commit(ctx, xaXid.String(), false)
c.releaseIfNecessary()
return err
}
func (c *XAConn) XaRollbackByBranchId(ctx context.Context, xaXid XAXid) error {
return c.XaRollback(ctx, xaXid)
}
func (c *XAConn) XaRollback(ctx context.Context, xaXid XAXid) error {
err := c.xaResource.Rollback(ctx, xaXid.String())
c.releaseIfNecessary()
return err
}