Add Driver() API to wrap driver.Driver

Author: prashanthpai

README.md

@@ -35,7 +35,7 @@ import (
 	"database/sql"
 
 	redis "github.com/go-redis/redis/v7"
-	"github.com/ngrok/sqlmw"
+	"github.com/jackc/pgx/v4/stdlib"
 	"github.com/prashanthpai/sqlcache"
 )
 
@@ -51,8 +51,8 @@ func main() {
 	})
 	...
 
-	// wrap pgx driver with the interceptor and register it
-	sql.Register("pgx-with-cache", sqlmw.Driver(stdlib.GetDefaultDriver(), interceptor))
+	// wrap pgx driver with cache interceptor and register it
+	sql.Register("pgx-sqlcache", interceptor.Driver(stdlib.GetDefaultDriver()))
 
 	// open the database using the wrapped driver
 	db, err := sql.Open("pgx-with-cache", dsn)

doc.go

@@ -11,7 +11,7 @@ Usage:
 
 		redis "github.com/go-redis/redis/v7"
 		"github.com/prashanthpai/sqlcache"
-		"github.com/ngrok/sqlmw"
+		"github.com/jackc/pgx/v4/stdlib"
 	)
 
 	func main() {
@@ -27,7 +27,7 @@ Usage:
 		...
 
 		// wrap pgx driver with the interceptor and register it
-		sql.Register("pgx-with-cache", sqlmw.Driver(stdlib.GetDefaultDriver(), interceptor))
+		sql.Register("pgx-sqlcache", interceptor.Driver(stdlib.GetDefaultDriver()))
 
 		// open the database using the wrapped driver
 		db, err := sql.Open("pgx-with-cache", dsn)

example/main.go

@@ -13,7 +13,6 @@ import (
 	"github.com/dgraph-io/ristretto"
 	redis "github.com/go-redis/redis/v7"
 	"github.com/jackc/pgx/v4/stdlib"
-	"github.com/ngrok/sqlmw"
 )
 
 const (
@@ -71,7 +70,7 @@ func main() {
 	}()
 
 	// install the wrapper which wraps pgx driver
-	sql.Register("pgx-sqlcache", sqlmw.Driver(stdlib.GetDefaultDriver(), interceptor))
+	sql.Register("pgx-sqlcache", interceptor.Driver(stdlib.GetDefaultDriver()))
 
 	if err := run(); err != nil {
 		log.Fatalf("run() failed: %v", err)

interceptor.go

@@ -64,6 +64,13 @@ func NewInterceptor(config *Config) (*Interceptor, error) {
 	}, nil
 }
 
+// Driver returns the supplied driver.Driver with a new object that has
+// all of its calls intercepted by the sqlcache.Interceptor. Any DB call
+// without a context passed will not be intercepted.
+func (i *Interceptor) Driver(d driver.Driver) driver.Driver {
+	return sqlmw.Driver(d, i)
+}
+
 // Enable enables the interceptor. Interceptor instance is enabled by default
 // on creation.
 func (i *Interceptor) Enable() {

interceptor_test.go

@@ -13,7 +13,6 @@ import (
 	"github.com/prashanthpai/sqlcache/mocks"
 
 	sqlmock "github.com/DATA-DOG/go-sqlmock"
-	"github.com/ngrok/sqlmw"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 )
@@ -131,7 +130,7 @@ func TestAttrs(t *testing.T) {
 	})
 
 	driverName := fmt.Sprintf("mockdriver:%s", t.Name())
-	sql.Register(driverName, sqlmw.Driver(mockDB.Driver(), ic))
+	sql.Register(driverName, ic.Driver(mockDB.Driver()))
 
 	db, err := sql.Open(driverName, dsn)
 	assert.Nil(err)
@@ -159,7 +158,7 @@ func TestCacheMiss(t *testing.T) {
 	})
 
 	driverName := fmt.Sprintf("mockdriver:%s", t.Name())
-	sql.Register(driverName, sqlmw.Driver(mockDB.Driver(), ic))
+	sql.Register(driverName, ic.Driver(mockDB.Driver()))
 
 	db, err := sql.Open(driverName, dsn)
 	assert.Nil(err)
@@ -219,7 +218,7 @@ func TestCacheHit(t *testing.T) {
 	})
 
 	driverName := fmt.Sprintf("mockdriver:%s", t.Name())
-	sql.Register(driverName, sqlmw.Driver(mockDB.Driver(), ic))
+	sql.Register(driverName, ic.Driver(mockDB.Driver()))
 
 	db, err := sql.Open(driverName, dsn)
 	assert.Nil(err)
@@ -263,7 +262,7 @@ func TestDisabled(t *testing.T) {
 	})
 
 	driverName := fmt.Sprintf("mockdriver:%s", t.Name())
-	sql.Register(driverName, sqlmw.Driver(mockDB.Driver(), ic))
+	sql.Register(driverName, ic.Driver(mockDB.Driver()))
 
 	db, err := sql.Open(driverName, dsn)
 	assert.Nil(err)
@@ -314,7 +313,7 @@ func TestMaxRows(t *testing.T) {
 	})
 
 	driverName := fmt.Sprintf("mockdriver:%s", t.Name())
-	sql.Register(driverName, sqlmw.Driver(mockDB.Driver(), ic))
+	sql.Register(driverName, ic.Driver(mockDB.Driver()))
 
 	db, err := sql.Open(driverName, dsn)
 	assert.Nil(err)
@@ -363,7 +362,7 @@ func TestHashFuncErr(t *testing.T) {
 	})
 
 	driverName := fmt.Sprintf("mockdriver:%s", t.Name())
-	sql.Register(driverName, sqlmw.Driver(mockDB.Driver(), ic))
+	sql.Register(driverName, ic.Driver(mockDB.Driver()))
 
 	db, err := sql.Open(driverName, dsn)
 	assert.Nil(err)
@@ -412,7 +411,7 @@ func TestCacheSetErr(t *testing.T) {
 	})
 
 	driverName := fmt.Sprintf("mockdriver:%s", t.Name())
-	sql.Register(driverName, sqlmw.Driver(mockDB.Driver(), ic))
+	sql.Register(driverName, ic.Driver(mockDB.Driver()))
 
 	db, err := sql.Open(driverName, dsn)
 	assert.Nil(err)