V1 chained transaction

.golangci.yml

@@ -77,6 +77,14 @@ issues:
       linters:
         - wsl
       text: "only cuddled expressions if assigning variable or using from line above"
+    - path: _test\.go
+      linters:
+        - revive
+      text: "context-keys-type: should not use basic type string as key in context.WithValue"
+    - path: _test\.go
+      linters:
+        - staticcheck
+      text: "SA1029: should not use built-in type string as key for value; define your own type to avoid collisions"
     - &internal_text
       path: ^internal
       text: "var-naming: don't use an underscore in package name"

go.mod

@@ -3,6 +3,7 @@ module github.com/avito-tech/go-transaction-manager
 go 1.13
 
 require (
+	github.com/DATA-DOG/go-sqlmock v1.5.0
 	github.com/golang/mock v1.6.0
 	github.com/jinzhu/copier v0.3.5
 	github.com/jmoiron/sqlx v1.3.5

go.sum

@@ -1,3 +1,5 @@
+github.com/DATA-DOG/go-sqlmock v1.5.0 h1:Shsta01QNfFxHCfpW6YH2STWB0MudeXXEWMr20OEh60=
+github.com/DATA-DOG/go-sqlmock v1.5.0/go.mod h1:f/Ixk793poVmq4qj/V1dPUg2JEAKC73Q5eFN3EC/SaM=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

sql/context.go

@@ -7,26 +7,44 @@ import (
 	"database/sql"
 
 	"github.com/avito-tech/go-transaction-manager/transaction"
-	"github.com/avito-tech/go-transaction-manager/transaction/settings"
+	trmcontext "github.com/avito-tech/go-transaction-manager/transaction/context"
 )
 
-// TrOrDBFromCtx returns the opened Tr from the context.Context or sql.DB.
-// TODO add ability to set ctxKey.
-func TrOrDBFromCtx(ctx context.Context, db Tr) Tr {
-	if tr, ok := TrFromCtx(ctx); ok {
-		return tr
+// DefaultCtxGetter is the CtxGetter with settings.DefaultCtxKey.
+//
+//nolint:gochecknoglobals
+var DefaultCtxGetter = NewCtxGetter(trmcontext.DefaultManager)
+
+// CtxGetter gets Tr from transaction.СtxManager by casting transaction.Transaction to Tr.
+type CtxGetter struct {
+	ctxManager transaction.СtxManager
+}
+
+//revive:disable:exported
+func NewCtxGetter(c transaction.СtxManager) *CtxGetter {
+	return &CtxGetter{ctxManager: c}
+}
+
+func (c *CtxGetter) DefaultTrOrDB(ctx context.Context, db Tr) Tr {
+	if tr := c.ctxManager.Default(ctx); tr != nil {
+		return c.convert(tr)
 	}
 
 	return db
 }
 
-// TrFromCtx returns the opened Tr from the context.Context.
-func TrFromCtx(ctx context.Context) (Tr, bool) {
-	if tr := transaction.TrFromCtx(ctx, settings.DefaultCtxKey); tr != nil {
-		tx, ok := tr.Transaction().(*sql.Tx)
+func (c *CtxGetter) TrOrDB(ctx context.Context, key transaction.CtxKey, db Tr) Tr {
+	if tr := c.ctxManager.ByKey(ctx, key); tr != nil {
+		return c.convert(tr)
+	}
+
+	return db
+}
 
-		return tx, ok
+func (c *CtxGetter) convert(tr transaction.Transaction) Tr {
+	if tx, ok := tr.Transaction().(*sql.Tx); ok {
+		return tx
 	}
 
-	return nil, false
+	return nil
 }

sql/example_test.go

@@ -7,17 +7,19 @@ import (
 
 	_ "github.com/mattn/go-sqlite3"
 
-	trsql "github.com/avito-tech/go-transaction-manager/sql"
+	trmsql "github.com/avito-tech/go-transaction-manager/sql"
 	"github.com/avito-tech/go-transaction-manager/transaction/manager"
 )
 
 type repo struct {
-	db *sql.DB
+	db     *sql.DB
+	getter *trmsql.CtxGetter
 }
 
-func newRepo(db *sql.DB) *repo {
+func newRepo(db *sql.DB, c *trmsql.CtxGetter) *repo {
 	return &repo{
-		db: db,
+		db:     db,
+		getter: c,
 	}
 }
 
@@ -31,7 +33,7 @@ func (r *repo) GetByID(ctx context.Context, id int64) (*user, error) {
 
 	u := &user{}
 
-	err := trsql.TrOrDBFromCtx(ctx, r.db).QueryRowContext(ctx, query, id).Scan(&u.ID, &u.Username)
+	err := r.getter.DefaultTrOrDB(ctx, r.db).QueryRowContext(ctx, query, id).Scan(&u.ID, &u.Username)
 	if err != nil {
 		return nil, err
 	}
@@ -53,7 +55,7 @@ func (r *repo) Save(ctx context.Context, u *user) error {
 		args = append(args, sql.Named("user_id", u.ID))
 	}
 
-	res, err := trsql.TrOrDBFromCtx(ctx, r.db).ExecContext(ctx, query, args...)
+	res, err := r.getter.DefaultTrOrDB(ctx, r.db).ExecContext(ctx, query, args...)
 	if err != nil {
 		return err
 	} else if !isNew {
@@ -85,14 +87,14 @@ func Example() {
 	_, err = db.Exec(sqlStmt)
 	checkErr(err, sqlStmt)
 
-	r := newRepo(db)
+	r := newRepo(db, trmsql.DefaultCtxGetter)
 
 	u := &user{
 		Username: "username",
 	}
 
 	ctx := context.Background()
-	trManager := manager.New(trsql.NewFactory(db))
+	trManager := manager.New(trmsql.NewFactory(db))
 
 	err = trManager.Do(ctx, func(ctx context.Context) error {
 		if err := r.Save(ctx, u); err != nil {
@@ -107,17 +109,15 @@ func Example() {
 			return err
 		}
 
-		userFromDB, err := r.GetByID(ctx, u.ID)
-		if err != nil {
-			return err
-		}
-
-		fmt.Println(userFromDB)
-
 		return nil
 	})
 	checkErr(err)
 
+	userFromDB, err := r.GetByID(ctx, u.ID)
+	checkErr(err)
+
+	fmt.Println(userFromDB)
+
 	// Output: &{1 new_username}
 }
 

sql/transaction.go

@@ -41,7 +41,7 @@ func (t *Transaction) Transaction() interface{} {
 }
 
 // SavePoint creates nested transaction by save point.
-func (t *Transaction) SavePoint(ctx context.Context, _ transaction.Settings) (*Transaction, error) {
+func (t *Transaction) SavePoint(ctx context.Context, _ transaction.Settings) (transaction.Transaction, error) { //nolint:ireturn
 	// TODO check that is transaction.Settings necessary
 	_, err := t.tx.ExecContext(ctx, t.savePoint.Create(t.incrementID()))
 	if err != nil {
@@ -53,19 +53,17 @@ func (t *Transaction) SavePoint(ctx context.Context, _ transaction.Settings) (*T
 
 // Commit calls close for a database.
 func (t *Transaction) Commit() error {
-	t.isActive = false
-
 	if t.hasSavePoint() {
-		_, err := t.tx.Exec(t.savePoint.Release(t.id()))
-		t.decrementID()
-
+		_, err := t.tx.Exec(t.savePoint.Release(t.decrementID()))
 		if err != nil {
 			return multierr.Combine(transaction.ErrCommit, err)
 		}
 
 		return nil
 	}
 
+	t.isActive = false
+
 	if err := t.tx.Commit(); err != nil {
 		return multierr.Combine(transaction.ErrCommit, err)
 	}
@@ -76,7 +74,7 @@ func (t *Transaction) Commit() error {
 // Rollback calls close for a database.
 func (t *Transaction) Rollback() error {
 	if t.hasSavePoint() {
-		_, err := t.tx.Exec(t.savePoint.Rollback(t.id()))
+		_, err := t.tx.Exec(t.savePoint.Rollback(t.decrementID()))
 		if err != nil {
 			return multierr.Combine(transaction.ErrCommit, err)
 		}
@@ -109,7 +107,7 @@ func (t *Transaction) incrementID() string {
 }
 
 func (t *Transaction) decrementID() string {
-	atomic.AddInt64(&t.saves, -1)
+	defer atomic.AddInt64(&t.saves, -1)
 
 	return t.id()
 }