db.go

/*
Package txdb is a single transaction based database sql driver. When the connection
is opened, it starts a transaction and all operations performed on this *sql.DB
will be within that transaction. If concurrent actions are performed, the lock is
acquired and connection is always released the statements and rows are not holding the
connection.

Why is it useful. A very basic use case would be if you want to make functional tests
you can prepare a test database and within each test you do not have to reload a database.
All tests are isolated within transaction and though, performs fast. And you do not have
to interface your sql.DB reference in your code, txdb is like a standard sql.Driver.

This driver supports any sql.Driver connection to be opened. You can register txdb
for different sql drivers and have it under different driver names. Under the hood
whenever a txdb driver is opened, it attempts to open a real connection and starts
transaction. When close is called, it rollbacks transaction leaving your prepared
test database in the same state as before.

Given, you have a mysql database called txdb_test and a table users with a username
column.

Example:
	package main

	import (
		"database/sql"
		"log"

		"github.com/DATA-DOG/go-txdb"
		_ "github.com/go-sql-driver/mysql"
	)

	func init() {
		// we register an sql driver named "txdb"
		txdb.Register("txdb", "mysql", "root@/txdb_test")
	}

	func main() {
        // dsn serves as an unique identifier for connection pool
		db, err := sql.Open("txdb", "identifier")
		if err != nil {
			log.Fatal(err)
		}
		defer db.Close()

		if _, err := db.Exec(`INSERT INTO users(username) VALUES("gopher")`); err != nil {
			log.Fatal(err)
		}
	}

Every time you will run this application, it will remain in the same state as before.
*/
package txdb

import (
	"database/sql"
	"database/sql/driver"
	"fmt"
	"io"
	"sync"
)

// Register a txdb sql driver under the given sql driver name
// which can be used to open a single transaction based database
// connection.
//
// When Open is called any number of times it returns
// the same transaction connection.
//
// Any Begin, Commit calls will not start or close the transaction.
// Instead the savepoint will be created, released or rolled back.
// In case if your SQL driver does not support save points - use nil
// for the SavePointOption argument. If driver has non default
// save point logic, you can override the default with SavePointOption.
//
// When Close is called, the transaction is rolled back.
//
// Use drv (Driver) and dsn (DataSourceName) as the standard sql properties for
// your test database connection to be isolated within transaction.
//
// The drv and dsn are the same items passed into `sql.Open(drv, dsn)`.
//
// Note: if you open a secondary database, make sure to differianciate
// the dsn string when opening the sql.DB. The transaction will be
// isolated within that dsn
func Register(name, drv, dsn string, options ...func(*conn) error) {
	sql.Register(name, &txDriver{
		dsn:     dsn,
		drv:     drv,
		conns:   make(map[string]*conn),
		options: options,
	})
}

// txDriver is an sql driver which runs on single transaction
// when the Close is called, transaction is rolled back
type conn struct {
	sync.Mutex
	tx        *sql.Tx
	dsn       string
	opened    uint
	drv       *txDriver
	saves     uint
	savePoint SavePoint
}

type txDriver struct {
	sync.Mutex
	db       *sql.DB
	realConn driver.Conn // Meant to be used as NamedValueChecker
	conns    map[string]*conn
	options  []func(*conn) error

	drv string
	dsn string
}

func (d *txDriver) Open(dsn string) (driver.Conn, error) {
	d.Lock()
	defer d.Unlock()
	// first open a real database connection
	if d.db == nil {
		db, err := sql.Open(d.drv, d.dsn)
		if err != nil {
			return nil, err
		}
		d.db = db

		realConn, err := db.Driver().Open(d.dsn)
		if err != nil {
			return nil, err
		}
		d.realConn = realConn
	}
	c, ok := d.conns[dsn]
	if !ok {
		c = &conn{dsn: dsn, drv: d, savePoint: &defaultSavePoint{}}
		for _, opt := range d.options {
			if e := opt(c); e != nil {
				return c, e
			}
		}
		d.conns[dsn] = c
	}
	c.opened++
	return c, nil
}

func (d *txDriver) deleteConn(dsn string) error {
	d.Lock()
	defer d.Unlock()

	delete(d.conns, dsn)
	if len(d.conns) == 0 && d.db != nil {
		if err := d.db.Close(); err != nil {
			return err
		}
		d.db = nil
		if err := d.realConn.Close(); err != nil {
			return err
		}
	}
	return nil
}

func (c *conn) beginOnce() (*sql.Tx, error) {
	if c.tx == nil {
		tx, err := c.drv.db.Begin()
		if err != nil {
			return nil, err
		}
		c.tx = tx
	}
	return c.tx, nil
}

func (c *conn) Close() (err error) {
	c.Lock()
	defer c.Unlock()

	c.opened--
	if c.opened == 0 {
		if c.tx != nil {
			c.tx.Rollback()
			c.tx = nil
		}
		c.drv.deleteConn(c.dsn)
	}
	return
}

type tx struct {
	id   string
	conn *conn
}

func (c *conn) Begin() (driver.Tx, error) {
	if c.savePoint == nil {
		return &tx{"_", c}, nil // save point is not supported
	}

	c.Lock()
	defer c.Unlock()

	connTx, err := c.beginOnce()
	if err != nil {
		return nil, err
	}

	c.saves++
	id := fmt.Sprintf("tx_%d", c.saves)
	_, err = connTx.Exec(c.savePoint.Create(id))
	if err != nil {
		return nil, err
	}
	return &tx{id, c}, nil
}

func (tx *tx) Commit() error {
	if tx.conn.savePoint == nil {
		return nil // save point is not supported
	}

	tx.conn.Lock()
	defer tx.conn.Unlock()

	connTx, err := tx.conn.beginOnce()
	if err != nil {
		return err
	}

	_, err = connTx.Exec(tx.conn.savePoint.Release(tx.id))
	return err
}

func (tx *tx) Rollback() error {
	if tx.conn.savePoint == nil {
		return nil // save point is not supported
	}

	tx.conn.Lock()
	defer tx.conn.Unlock()

	connTx, err := tx.conn.beginOnce()
	if err != nil {
		return err
	}

	_, err = connTx.Exec(tx.conn.savePoint.Rollback(tx.id))
	return err
}

func (c *conn) Prepare(query string) (driver.Stmt, error) {
	c.Lock()
	defer c.Unlock()

	tx, err := c.beginOnce()
	if err != nil {
		return nil, err
	}

	st, err := tx.Prepare(query)
	if err != nil {
		return nil, err
	}
	return &stmt{st: st}, nil
}

func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) {
	c.Lock()
	defer c.Unlock()

	tx, err := c.beginOnce()
	if err != nil {
		return nil, err
	}

	return tx.Exec(query, mapArgs(args)...)
}

func mapArgs(args []driver.Value) (res []interface{}) {
	res = make([]interface{}, len(args))
	for i := range args {
		res[i] = args[i]
	}
	return
}

func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) {
	c.Lock()
	defer c.Unlock()

	tx, err := c.beginOnce()
	if err != nil {
		return nil, err
	}

	// query rows
	rs, err := tx.Query(query, mapArgs(args)...)
	if err != nil {
		return nil, err
	}
	defer rs.Close()

	return buildRows(rs)
}

type stmt struct {
	st *sql.Stmt
}

func (s *stmt) Exec(args []driver.Value) (driver.Result, error) {
	return s.st.Exec(mapArgs(args)...)
}

func (s *stmt) NumInput() int {
	return -1
}

func (s *stmt) Close() error {
	return s.st.Close()
}

func (s *stmt) Query(args []driver.Value) (driver.Rows, error) {
	rows, err := s.st.Query(mapArgs(args)...)
	if err != nil {
		return nil, err
	}
	return buildRows(rows)
}

type rows struct {
	rows     [][]driver.Value
	pos      int
	cols     []string
	colTypes []*sql.ColumnType
}

func (r *rows) Columns() []string {
	return r.cols
}

func (r *rows) ColumnTypeDatabaseTypeName(index int) string {
	return r.colTypes[index].DatabaseTypeName()
}

func (r *rows) Next(dest []driver.Value) error {
	r.pos++
	if r.pos > len(r.rows) {
		return io.EOF
	}

	for i, val := range r.rows[r.pos-1] {
		dest[i] = *(val.(*interface{}))
	}

	return nil
}

func (r *rows) Close() error {
	return nil
}

func (r *rows) read(rs *sql.Rows) error {
	var err error
	r.cols, err = rs.Columns()
	if err != nil {
		return err
	}

	r.colTypes, err = rs.ColumnTypes()
	if err != nil {
		return err
	}

	for rs.Next() {
		values := make([]interface{}, len(r.cols))
		for i := range values {
			values[i] = new(interface{})
		}
		if err := rs.Scan(values...); err != nil {
			return err
		}
		row := make([]driver.Value, len(r.cols))
		for i, v := range values {
			row[i] = driver.Value(v)
		}
		r.rows = append(r.rows, row)
	}
	return rs.Err()
}

type rowSets struct {
	sets []*rows
	pos  int
}

func (rs *rowSets) Columns() []string {
	return rs.sets[rs.pos].cols
}

func (rs *rowSets) ColumnTypeDatabaseTypeName(index int) string {
	return rs.sets[rs.pos].ColumnTypeDatabaseTypeName(index)
}

func (rs *rowSets) Close() error {
	return nil
}

// advances to next row
func (rs *rowSets) Next(dest []driver.Value) error {
	return rs.sets[rs.pos].Next(dest)
}