feat: database/sql integration

go.mod

@@ -9,8 +9,10 @@ require (
 	github.com/google/go-cmp v0.5.9
 	github.com/kataras/iris/v12 v12.2.0
 	github.com/labstack/echo/v4 v4.10.0
+	github.com/lib/pq v1.10.9
 	github.com/pingcap/errors v0.11.4
 	github.com/pkg/errors v0.9.1
+	github.com/proullon/ramsql v0.1.4
 	github.com/sirupsen/logrus v1.9.0
 	github.com/stretchr/testify v1.8.2
 	github.com/urfave/negroni/v3 v3.1.1
@@ -88,6 +90,7 @@ require (
 	github.com/yudai/gojsondiff v1.0.0 // indirect
 	github.com/yudai/golcs v0.0.0-20170316035057-ecda9a501e82 // indirect
 	golang.org/x/crypto v0.21.0 // indirect
+	golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1 // indirect
 	golang.org/x/net v0.23.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
 	google.golang.org/protobuf v1.33.0 // indirect

go.sum

@@ -39,6 +39,7 @@ github.com/gin-gonic/gin v1.8.1 h1:4+fr/el88TOO3ewCmQr8cx/CtZ/umlIRIs5M4NTNjf8=
 github.com/gin-gonic/gin v1.8.1/go.mod h1:ji8BvRH1azfM+SYow9zQ6SZMvR8qOMZHmsCuWR9tTTk=
 github.com/go-errors/errors v1.4.2 h1:J6MZopCL4uSllY1OfXM374weqZFFItUbrImctkmUxIA=
 github.com/go-errors/errors v1.4.2/go.mod h1:sIVyrIiJhuEF+Pj9Ebtd6P/rEYROXFi3BopGUQ5a5Og=
+github.com/go-gorp/gorp v2.2.0+incompatible h1:xAUh4QgEeqPPhK3vxZN+bzrim1z5Av6q837gtjUlshc=
 github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBYNjji3q3A=
 github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
 github.com/go-playground/locales v0.14.0 h1:u50s323jtVGugKlcYeyzC0etD1HifMjqmJqb8WugfUU=
@@ -71,6 +72,11 @@ github.com/iris-contrib/httpexpect/v2 v2.12.1 h1:3cTZSyBBen/kfjCtgNFoUKi1u0FVXNa
 github.com/iris-contrib/httpexpect/v2 v2.12.1/go.mod h1:7+RB6W5oNClX7PTwJgJnsQP3ZuUUYB3u61KCqeSgZ88=
 github.com/iris-contrib/schema v0.0.6 h1:CPSBLyx2e91H2yJzPuhGuifVRnZBBJ3pCOMbOvPZaTw=
 github.com/iris-contrib/schema v0.0.6/go.mod h1:iYszG0IOsuIsfzjymw1kMzTL8YQcCWlm65f3wX8J5iA=
+github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
+github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
+github.com/jackc/pgx/v5 v5.3.1 h1:Fcr8QJ1ZeLi5zsPZqQeUZhNhxfkkKBOgJuYkJHoBOtU=
+github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
+github.com/jinzhu/now v1.1.5 h1:/o9tlHleP7gOFmsnYNz3RGnqzefHA47wQpKrrdTIwXQ=
 github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
@@ -103,6 +109,8 @@ github.com/labstack/gommon v0.4.0 h1:y7cvthEAEbU0yHOf4axH8ZG2NH8knB9iNSoTO8dyIk8
 github.com/labstack/gommon v0.4.0/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM=
 github.com/leodido/go-urn v1.2.1 h1:BqpAaACuzVSgi/VLzGZIobT2z4v53pjosyNd9Yv6n/w=
 github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ictyFfxY=
+github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
+github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
 github.com/mailgun/raymond/v2 v2.0.48 h1:5dmlB680ZkFG2RN/0lvTAghrSxIESeu9/2aeDqACtjw=
 github.com/mailgun/raymond/v2 v2.0.48/go.mod h1:lsgvL50kgt1ylcFJYZiULi5fjPBkkhNfj4KA0W54Z18=
 github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
@@ -142,6 +150,8 @@ github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
 github.com/pmezard/go-difflib v0.0.0-20151028094244-d8ed2627bdf0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/proullon/ramsql v0.1.4 h1:yTFRTn46gFH/kPbzCx+mGjuFlyTBUeDr3h2ldwxddl0=
+github.com/proullon/ramsql v0.1.4/go.mod h1:CFGqeQHQpdRfWqYmWD3yXqPTEaHkF4zgXy1C6qDWc9E=
 github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc=
@@ -220,6 +230,8 @@ golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPh
 golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
 golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
+golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1 h1:MGwJjxBy0HJshjDNfLsYO8xppfqWlA5ZT9OhtUUhTNw=
+golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.5.1/go.mod h1:5OXOZSfqPIIbmVBIIKWRFfZjPR0E5r58TLhUjH0a2Ro=
@@ -289,5 +301,7 @@ gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gorm.io/driver/postgres v1.5.2 h1:ytTDxxEv+MplXOfFe3Lzm7SjG09fcdb3Z/c056DTBx0=
+gorm.io/gorm v1.25.2 h1:gs1o6Vsa+oVKG/a9ElL3XgyGfghFfkKA2SInQaCyMho=
 moul.io/http2curl/v2 v2.3.0 h1:9r3JfDzWPcbIklMOs2TnIFzDYvfAZvjeavG6EzP7jYs=
 moul.io/http2curl/v2 v2.3.0/go.mod h1:RW4hyBjTWSYDOxapodpNEtX0g5Eb16sxklBqmd2RHcE=

sentrysql/conn.go

@@ -0,0 +1,247 @@
+package sentrysql
+
+import (
+	"context"
+	"database/sql/driver"
+
+	"github.com/getsentry/sentry-go"
+)
+
+type sentryConn struct {
+	originalConn driver.Conn
+	ctx          context.Context
+	config       *sentrySQLConfig
+}
+
+func (s *sentryConn) Prepare(query string) (driver.Stmt, error) {
+	stmt, err := s.originalConn.Prepare(query)
+	if err != nil {
+		return nil, err
+	}
+
+	return &sentryStmt{
+		originalStmt: stmt,
+		query:        query,
+		ctx:          s.ctx,
+		config:       s.config,
+	}, nil
+}
+
+func (s *sentryConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) {
+	// should only be executed if the original driver implements ConnPrepareContext
+	connPrepareContext, ok := s.originalConn.(driver.ConnPrepareContext)
+	if !ok {
+		return nil, driver.ErrSkip
+	}
+
+	stmt, err := connPrepareContext.PrepareContext(ctx, query)
+	if err != nil {
+		return nil, err
+	}
+
+	return &sentryStmt{
+		originalStmt: stmt,
+		query:        query,
+		ctx:          ctx,
+		config:       s.config,
+	}, nil
+}
+
+func (s *sentryConn) Close() error {
+	return s.originalConn.Close()
+}
+
+func (s *sentryConn) Begin() (driver.Tx, error) {
+	tx, err := s.originalConn.Begin() //nolint:staticcheck We must support legacy clients
+	if err != nil {
+		return nil, err
+	}
+
+	return &sentryTx{originalTx: tx, ctx: s.ctx, config: s.config}, nil
+}
+
+func (s *sentryConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) {
+	// should only be executed if the original driver implements ConnBeginTx
+	connBeginTx, ok := s.originalConn.(driver.ConnBeginTx)
+	if !ok {
+		// fallback to the so-called deprecated "Begin" method
+		return s.Begin()
+	}
+
+	tx, err := connBeginTx.BeginTx(ctx, opts)
+	if err != nil {
+		return nil, err
+	}
+
+	return &sentryTx{originalTx: tx, ctx: s.ctx, config: s.config}, nil
+}
+
+//nolint:dupl
+func (s *sentryConn) Query(query string, args []driver.Value) (driver.Rows, error) {
+	// should only be executed if the original driver implements Queryer
+	queryer, ok := s.originalConn.(driver.Queryer) //nolint:staticcheck We must support legacy clients
+	if !ok {
+		return nil, driver.ErrSkip
+	}
+
+	parentSpan := sentry.SpanFromContext(s.ctx)
+	if parentSpan == nil {
+		return queryer.Query(query, args)
+	}
+
+	span := parentSpan.StartChild("db.sql.query", sentry.WithDescription(query))
+	if s.config.databaseSystem != "" {
+		span.SetData("db.system", s.config.databaseSystem)
+	}
+	if s.config.databaseName != "" {
+		span.SetData("db.name", s.config.databaseName)
+	}
+	if s.config.serverAddress != "" {
+		span.SetData("server.address", s.config.serverAddress)
+	}
+	if s.config.serverPort != "" {
+		span.SetData("server.port", s.config.serverPort)
+	}
+	defer span.Finish()
+
+	rows, err := queryer.Query(query, args)
+	if err != nil {
+		span.Status = sentry.SpanStatusInternalError
+		return nil, err
+	}
+
+	span.Status = sentry.SpanStatusOK
+	return rows, nil
+}
+
+//nolint:dupl
+func (s *sentryConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) {
+	// should only be executed if the original driver implements QueryerContext
+	queryerContext, ok := s.originalConn.(driver.QueryerContext)
+	if !ok {
+		return nil, driver.ErrSkip
+	}
+
+	parentSpan := sentry.SpanFromContext(ctx)
+	if parentSpan == nil {
+		return queryerContext.QueryContext(ctx, query, args)
+	}
+
+	span := parentSpan.StartChild("db.sql.query", sentry.WithDescription(query))
+	if s.config.databaseSystem != "" {
+		span.SetData("db.system", s.config.databaseSystem)
+	}
+	if s.config.databaseName != "" {
+		span.SetData("db.name", s.config.databaseName)
+	}
+	if s.config.serverAddress != "" {
+		span.SetData("server.address", s.config.serverAddress)
+	}
+	if s.config.serverPort != "" {
+		span.SetData("server.port", s.config.serverPort)
+	}
+	defer span.Finish()
+
+	rows, err := queryerContext.QueryContext(ctx, query, args)
+	if err != nil {
+		span.Status = sentry.SpanStatusInternalError
+		return nil, err
+	}
+
+	span.Status = sentry.SpanStatusOK
+	return rows, nil
+}
+
+//nolint:dupl
+func (s *sentryConn) Exec(query string, args []driver.Value) (driver.Result, error) {
+	// should only be executed if the original driver implements Execer
+	execer, ok := s.originalConn.(driver.Execer) //nolint:staticcheck We must support legacy clients
+	if !ok {
+		return nil, driver.ErrSkip
+	}
+
+	parentSpan := sentry.SpanFromContext(s.ctx)
+	if parentSpan == nil {
+		return execer.Exec(query, args)
+	}
+
+	span := parentSpan.StartChild("db.sql.exec", sentry.WithDescription(query))
+	if s.config.databaseSystem != "" {
+		span.SetData("db.system", s.config.databaseSystem)
+	}
+	if s.config.databaseName != "" {
+		span.SetData("db.name", s.config.databaseName)
+	}
+	if s.config.serverAddress != "" {
+		span.SetData("server.address", s.config.serverAddress)
+	}
+	if s.config.serverPort != "" {
+		span.SetData("server.port", s.config.serverPort)
+	}
+	defer span.Finish()
+
+	rows, err := execer.Exec(query, args)
+	if err != nil {
+		span.Status = sentry.SpanStatusInternalError
+		return nil, err
+	}
+
+	span.Status = sentry.SpanStatusOK
+	return rows, nil
+}
+
+//nolint:dupl
+func (s *sentryConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) {
+	// should only be executed if the original driver implements ExecerContext {
+	execerContext, ok := s.originalConn.(driver.ExecerContext)
+	if !ok {
+		return nil, driver.ErrSkip
+	}
+
+	parentSpan := sentry.SpanFromContext(ctx)
+	if parentSpan == nil {
+		return execerContext.ExecContext(ctx, query, args)
+	}
+
+	span := parentSpan.StartChild("db.sql.exec", sentry.WithDescription(query))
+	if s.config.databaseSystem != "" {
+		span.SetData("db.system", s.config.databaseSystem)
+	}
+	if s.config.databaseName != "" {
+		span.SetData("db.name", s.config.databaseName)
+	}
+	if s.config.serverAddress != "" {
+		span.SetData("server.address", s.config.serverAddress)
+	}
+	if s.config.serverPort != "" {
+		span.SetData("server.port", s.config.serverPort)
+	}
+	defer span.Finish()
+
+	rows, err := execerContext.ExecContext(ctx, query, args)
+	if err != nil {
+		span.Status = sentry.SpanStatusInternalError
+		return nil, err
+	}
+
+	span.Status = sentry.SpanStatusOK
+	return rows, nil
+}
+
+func (s *sentryConn) Ping(ctx context.Context) error {
+	pinger, ok := s.originalConn.(driver.Pinger)
+	if !ok {
+		return driver.ErrSkip
+	}
+
+	return pinger.Ping(ctx)
+}
+
+func (s *sentryConn) CheckNamedValue(namedValue *driver.NamedValue) error {
+	namedValueChecker, ok := s.originalConn.(driver.NamedValueChecker)
+	if !ok {
+		return driver.ErrSkip
+	}
+
+	return namedValueChecker.CheckNamedValue(namedValue)
+}

sentrysql/driver.go

@@ -0,0 +1,52 @@
+package sentrysql
+
+import (
+	"context"
+	"database/sql/driver"
+)
+
+type sentrySQLDriver struct {
+	originalDriver driver.Driver
+	config         *sentrySQLConfig
+}
+
+func (s *sentrySQLDriver) OpenConnector(name string) (driver.Connector, error) {
+	driverContext, ok := s.originalDriver.(driver.DriverContext)
+	if !ok {
+		return nil, driver.ErrSkip
+	}
+
+	connector, err := driverContext.OpenConnector(name)
+	if err != nil {
+		return nil, err
+	}
+
+	return &sentrySQLConnector{originalConnector: connector, config: s.config}, nil
+}
+
+func (s *sentrySQLDriver) Open(name string) (driver.Conn, error) {
+	conn, err := s.originalDriver.Open(name)
+	if err != nil {
+		return nil, err
+	}
+
+	return &sentryConn{originalConn: conn, config: s.config}, nil
+}
+
+type sentrySQLConnector struct {
+	originalConnector driver.Connector
+	config            *sentrySQLConfig
+}
+
+func (s *sentrySQLConnector) Connect(ctx context.Context) (driver.Conn, error) {
+	conn, err := s.originalConnector.Connect(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	return &sentryConn{originalConn: conn, ctx: ctx, config: s.config}, nil
+}
+
+func (s *sentrySQLConnector) Driver() driver.Driver {
+	return s.originalConnector.Driver()
+}