Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added DB query trace option #61

Merged
merged 1 commit into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Upcoming changes...

## [0.5.0] - 2024-06-24
### Added
- Added DB query tracing option

## [0.4.0] - 2024-06-20
### Added
- Upgraded to goland 1.20
- Added optional OTEL parameter initialisation

## [0.3.0] - 2023-11-27
### Added
- Added SQL query tracing support
Expand All @@ -29,3 +38,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
[0.1.0]: https://github.com/scanoss/go-grpc-helper/compare/v0.0.0...v0.1.0
[0.2.0]: https://github.com/scanoss/go-grpc-helper/compare/v0.1.0...v0.2.0
[0.3.0]: https://github.com/scanoss/go-grpc-helper/compare/v0.2.0...v0.3.0
[0.4.0]: https://github.com/scanoss/go-grpc-helper/compare/v0.3.0...v0.4.0
[0.5.0]: https://github.com/scanoss/go-grpc-helper/compare/v0.4.0...v0.5.0
12 changes: 9 additions & 3 deletions pkg/grpc/database/queries.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,28 @@ import (
var sqlRegex = regexp.MustCompile(`\$\d+`) // regex to check for SQL parameters

type DBQueryContext struct {
db *sqlx.DB
conn *sqlx.Conn
s *zap.SugaredLogger
trace bool
}

// NewDBSelectContext creates a new instance of the DBQueryContext service.
func NewDBSelectContext(s *zap.SugaredLogger, conn *sqlx.Conn, trace bool) *DBQueryContext {
return &DBQueryContext{s: s, conn: conn, trace: trace}
func NewDBSelectContext(s *zap.SugaredLogger, db *sqlx.DB, conn *sqlx.Conn, trace bool) *DBQueryContext {
return &DBQueryContext{s: s, db: db, conn: conn, trace: trace}
}

// SelectContext logs the give query before executing it and the result afterward, if tracing is enabled?
func (q *DBQueryContext) SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error {
if q.trace {
q.SQLQueryTrace(query, args...)
}
err := q.conn.SelectContext(ctx, dest, query, args...)
var err error
if q.conn != nil {
err = q.conn.SelectContext(ctx, dest, query, args...)
} else {
err = q.db.SelectContext(ctx, dest, query, args...)
}
if err == nil && q.trace {
q.SQLResultsTrace(dest)
}
Expand Down
17 changes: 13 additions & 4 deletions pkg/grpc/database/queries_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,24 @@ func TestQuerySQLite(t *testing.T) {
db.MustExec("CREATE TABLE person (firstname text, lastname text)")
db.MustExec("INSERT INTO person (firstname, lastname) VALUES ('harry', 'potter')")
ctx := context.Background()

q1 := NewDBSelectContext(zlog.S, db, nil, true)
var results1 []Persons
err = q1.SelectContext(ctx, &results1, "SELECT * FROM person where firstname = $1", "harry")
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
fmt.Printf("Results1: %v\n", results1)

conn, err := db.Connx(ctx)
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
q := NewDBSelectContext(zlog.S, conn, true)
var results []Persons
err = q.SelectContext(ctx, &results, "SELECT * FROM person where firstname = $1", "harry")
q2 := NewDBSelectContext(zlog.S, db, conn, true)
var results2 []Persons
err = q2.SelectContext(ctx, &results2, "SELECT * FROM person where firstname = $1", "harry")
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
fmt.Printf("Results: %v\n", results)
fmt.Printf("Results2: %v\n", results2)
}
Loading