Move every db.Prepare to sqlutil.Statementlist, remove trace driver (#3026)

Doesn't buy us much, but makes everything a bit more consistent.

Also removes the SQL trace driver, as it is unused and the output is
hard to read anyway.
This commit is contained in:
Till 2023-03-23 13:52:53 +01:00 committed by GitHub
parent cb18ba0230
commit 234ed603e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
33 changed files with 127 additions and 451 deletions

View File

@ -61,7 +61,6 @@ When debugging, the following Docker `run` options may also be useful:
* `-e "DENDRITE_TRACE_HTTP=1"`: Adds HTTP tracing to server logs. * `-e "DENDRITE_TRACE_HTTP=1"`: Adds HTTP tracing to server logs.
* `-e "DENDRITE_TRACE_INTERNAL=1"`: Adds roomserver internal API tracing to * `-e "DENDRITE_TRACE_INTERNAL=1"`: Adds roomserver internal API tracing to
server logs. server logs.
* `-e "DENDRITE_TRACE_SQL=1"`: Adds tracing to all SQL statements to server logs.
The docker command also supports a single positional argument for the test file to The docker command also supports a single positional argument for the test file to
run, so you can run a single `.pl` file rather than the whole test suite. For example: run, so you can run a single `.pl` file rather than the whole test suite. For example:

View File

@ -60,19 +60,12 @@ func NewPostgresBlacklistTable(db *sql.DB) (s *blacklistStatements, err error) {
return return
} }
if s.insertBlacklistStmt, err = db.Prepare(insertBlacklistSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertBlacklistStmt, insertBlacklistSQL},
} {&s.selectBlacklistStmt, selectBlacklistSQL},
if s.selectBlacklistStmt, err = db.Prepare(selectBlacklistSQL); err != nil { {&s.deleteBlacklistStmt, deleteBlacklistSQL},
return {&s.deleteAllBlacklistStmt, deleteAllBlacklistSQL},
} }.Prepare(db)
if s.deleteBlacklistStmt, err = db.Prepare(deleteBlacklistSQL); err != nil {
return
}
if s.deleteAllBlacklistStmt, err = db.Prepare(deleteAllBlacklistSQL); err != nil {
return
}
return
} }
func (s *blacklistStatements) InsertBlacklist( func (s *blacklistStatements) InsertBlacklist(

View File

@ -90,28 +90,15 @@ func NewPostgresJoinedHostsTable(db *sql.DB) (s *joinedHostsStatements, err erro
if err != nil { if err != nil {
return return
} }
if s.insertJoinedHostsStmt, err = s.db.Prepare(insertJoinedHostsSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertJoinedHostsStmt, insertJoinedHostsSQL},
} {&s.deleteJoinedHostsStmt, deleteJoinedHostsSQL},
if s.deleteJoinedHostsStmt, err = s.db.Prepare(deleteJoinedHostsSQL); err != nil { {&s.deleteJoinedHostsForRoomStmt, deleteJoinedHostsForRoomSQL},
return {&s.selectJoinedHostsStmt, selectJoinedHostsSQL},
} {&s.selectAllJoinedHostsStmt, selectAllJoinedHostsSQL},
if s.deleteJoinedHostsForRoomStmt, err = s.db.Prepare(deleteJoinedHostsForRoomSQL); err != nil { {&s.selectJoinedHostsForRoomsStmt, selectJoinedHostsForRoomsSQL},
return {&s.selectJoinedHostsForRoomsExcludingBlacklistedStmt, selectJoinedHostsForRoomsExcludingBlacklistedSQL},
} }.Prepare(db)
if s.selectJoinedHostsStmt, err = s.db.Prepare(selectJoinedHostsSQL); err != nil {
return
}
if s.selectAllJoinedHostsStmt, err = s.db.Prepare(selectAllJoinedHostsSQL); err != nil {
return
}
if s.selectJoinedHostsForRoomsStmt, err = s.db.Prepare(selectJoinedHostsForRoomsSQL); err != nil {
return
}
if s.selectJoinedHostsForRoomsExcludingBlacklistedStmt, err = s.db.Prepare(selectJoinedHostsForRoomsExcludingBlacklistedSQL); err != nil {
return
}
return
} }
func (s *joinedHostsStatements) InsertJoinedHosts( func (s *joinedHostsStatements) InsertJoinedHosts(

View File

@ -19,6 +19,7 @@ import (
"database/sql" "database/sql"
"github.com/matrix-org/dendrite/federationapi/storage/tables" "github.com/matrix-org/dendrite/federationapi/storage/tables"
"github.com/matrix-org/dendrite/internal/sqlutil"
"github.com/matrix-org/gomatrixserverlib" "github.com/matrix-org/gomatrixserverlib"
) )
@ -50,10 +51,9 @@ func NewPostgresNotaryServerKeysTable(db *sql.DB) (s *notaryServerKeysStatements
return return
} }
if s.insertServerKeysJSONStmt, err = db.Prepare(insertServerKeysJSONSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertServerKeysJSONStmt, insertServerKeysJSONSQL},
} }.Prepare(db)
return
} }
func (s *notaryServerKeysStatements) InsertJSONResponse( func (s *notaryServerKeysStatements) InsertJSONResponse(

View File

@ -22,6 +22,7 @@ import (
"github.com/lib/pq" "github.com/lib/pq"
"github.com/matrix-org/dendrite/federationapi/storage/tables" "github.com/matrix-org/dendrite/federationapi/storage/tables"
"github.com/matrix-org/dendrite/internal" "github.com/matrix-org/dendrite/internal"
"github.com/matrix-org/dendrite/internal/sqlutil"
"github.com/matrix-org/gomatrixserverlib" "github.com/matrix-org/gomatrixserverlib"
) )
@ -91,22 +92,13 @@ func NewPostgresNotaryServerKeysMetadataTable(db *sql.DB) (s *notaryServerKeysMe
return return
} }
if s.upsertServerKeysStmt, err = db.Prepare(upsertServerKeysSQL); err != nil { return s, sqlutil.StatementList{
return {&s.upsertServerKeysStmt, upsertServerKeysSQL},
} {&s.selectNotaryKeyResponsesStmt, selectNotaryKeyResponsesSQL},
if s.selectNotaryKeyResponsesStmt, err = db.Prepare(selectNotaryKeyResponsesSQL); err != nil { {&s.selectNotaryKeyResponsesWithKeyIDsStmt, selectNotaryKeyResponsesWithKeyIDsSQL},
return {&s.selectNotaryKeyMetadataStmt, selectNotaryKeyMetadataSQL},
} {&s.deleteUnusedServerKeysJSONStmt, deleteUnusedServerKeysJSONSQL},
if s.selectNotaryKeyResponsesWithKeyIDsStmt, err = db.Prepare(selectNotaryKeyResponsesWithKeyIDsSQL); err != nil { }.Prepare(db)
return
}
if s.selectNotaryKeyMetadataStmt, err = db.Prepare(selectNotaryKeyMetadataSQL); err != nil {
return
}
if s.deleteUnusedServerKeysJSONStmt, err = db.Prepare(deleteUnusedServerKeysJSONSQL); err != nil {
return
}
return
} }
func (s *notaryServerKeysMetadataStatements) UpsertKey( func (s *notaryServerKeysMetadataStatements) UpsertKey(

View File

@ -65,16 +65,11 @@ func NewPostgresQueueJSONTable(db *sql.DB) (s *queueJSONStatements, err error) {
if err != nil { if err != nil {
return return
} }
if s.insertJSONStmt, err = s.db.Prepare(insertJSONSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertJSONStmt, insertJSONSQL},
} {&s.deleteJSONStmt, deleteJSONSQL},
if s.deleteJSONStmt, err = s.db.Prepare(deleteJSONSQL); err != nil { {&s.selectJSONStmt, selectJSONSQL},
return }.Prepare(db)
}
if s.selectJSONStmt, err = s.db.Prepare(selectJSONSQL); err != nil {
return
}
return
} }
func (s *queueJSONStatements) InsertQueueJSON( func (s *queueJSONStatements) InsertQueueJSON(

View File

@ -78,22 +78,13 @@ func NewPostgresQueuePDUsTable(db *sql.DB) (s *queuePDUsStatements, err error) {
if err != nil { if err != nil {
return return
} }
if s.insertQueuePDUStmt, err = s.db.Prepare(insertQueuePDUSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertQueuePDUStmt, insertQueuePDUSQL},
} {&s.deleteQueuePDUsStmt, deleteQueuePDUSQL},
if s.deleteQueuePDUsStmt, err = s.db.Prepare(deleteQueuePDUSQL); err != nil { {&s.selectQueuePDUsStmt, selectQueuePDUsSQL},
return {&s.selectQueuePDUReferenceJSONCountStmt, selectQueuePDUReferenceJSONCountSQL},
} {&s.selectQueuePDUServerNamesStmt, selectQueuePDUServerNamesSQL},
if s.selectQueuePDUsStmt, err = s.db.Prepare(selectQueuePDUsSQL); err != nil { }.Prepare(db)
return
}
if s.selectQueuePDUReferenceJSONCountStmt, err = s.db.Prepare(selectQueuePDUReferenceJSONCountSQL); err != nil {
return
}
if s.selectQueuePDUServerNamesStmt, err = s.db.Prepare(selectQueuePDUServerNamesSQL); err != nil {
return
}
return
} }
func (s *queuePDUsStatements) InsertQueuePDU( func (s *queuePDUsStatements) InsertQueuePDU(

View File

@ -72,13 +72,10 @@ func NewPostgresServerSigningKeysTable(db *sql.DB) (s *serverSigningKeyStatement
if err != nil { if err != nil {
return return
} }
if s.bulkSelectServerKeysStmt, err = db.Prepare(bulkSelectServerSigningKeysSQL); err != nil { return s, sqlutil.StatementList{
return {&s.bulkSelectServerKeysStmt, bulkSelectServerSigningKeysSQL},
} {&s.upsertServerKeysStmt, upsertServerSigningKeysSQL},
if s.upsertServerKeysStmt, err = db.Prepare(upsertServerSigningKeysSQL); err != nil { }.Prepare(db)
return
}
return s, nil
} }
func (s *serverSigningKeyStatements) BulkSelectServerKeys( func (s *serverSigningKeyStatements) BulkSelectServerKeys(

View File

@ -60,19 +60,12 @@ func NewSQLiteBlacklistTable(db *sql.DB) (s *blacklistStatements, err error) {
return return
} }
if s.insertBlacklistStmt, err = db.Prepare(insertBlacklistSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertBlacklistStmt, insertBlacklistSQL},
} {&s.selectBlacklistStmt, selectBlacklistSQL},
if s.selectBlacklistStmt, err = db.Prepare(selectBlacklistSQL); err != nil { {&s.deleteBlacklistStmt, deleteBlacklistSQL},
return {&s.deleteAllBlacklistStmt, deleteAllBlacklistSQL},
} }.Prepare(db)
if s.deleteBlacklistStmt, err = db.Prepare(deleteBlacklistSQL); err != nil {
return
}
if s.deleteAllBlacklistStmt, err = db.Prepare(deleteAllBlacklistSQL); err != nil {
return
}
return
} }
func (s *blacklistStatements) InsertBlacklist( func (s *blacklistStatements) InsertBlacklist(

View File

@ -90,22 +90,14 @@ func NewSQLiteJoinedHostsTable(db *sql.DB) (s *joinedHostsStatements, err error)
if err != nil { if err != nil {
return return
} }
if s.insertJoinedHostsStmt, err = db.Prepare(insertJoinedHostsSQL); err != nil {
return return s, sqlutil.StatementList{
} {&s.insertJoinedHostsStmt, insertJoinedHostsSQL},
if s.deleteJoinedHostsStmt, err = db.Prepare(deleteJoinedHostsSQL); err != nil { {&s.deleteJoinedHostsStmt, deleteJoinedHostsSQL},
return {&s.deleteJoinedHostsForRoomStmt, deleteJoinedHostsForRoomSQL},
} {&s.selectJoinedHostsStmt, selectJoinedHostsSQL},
if s.deleteJoinedHostsForRoomStmt, err = s.db.Prepare(deleteJoinedHostsForRoomSQL); err != nil { {&s.selectAllJoinedHostsStmt, selectAllJoinedHostsSQL},
return }.Prepare(db)
}
if s.selectJoinedHostsStmt, err = db.Prepare(selectJoinedHostsSQL); err != nil {
return
}
if s.selectAllJoinedHostsStmt, err = db.Prepare(selectAllJoinedHostsSQL); err != nil {
return
}
return
} }
func (s *joinedHostsStatements) InsertJoinedHosts( func (s *joinedHostsStatements) InsertJoinedHosts(

View File

@ -19,6 +19,7 @@ import (
"database/sql" "database/sql"
"github.com/matrix-org/dendrite/federationapi/storage/tables" "github.com/matrix-org/dendrite/federationapi/storage/tables"
"github.com/matrix-org/dendrite/internal/sqlutil"
"github.com/matrix-org/gomatrixserverlib" "github.com/matrix-org/gomatrixserverlib"
) )
@ -49,10 +50,9 @@ func NewSQLiteNotaryServerKeysTable(db *sql.DB) (s *notaryServerKeysStatements,
return return
} }
if s.insertServerKeysJSONStmt, err = db.Prepare(insertServerKeysJSONSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertServerKeysJSONStmt, insertServerKeysJSONSQL},
} }.Prepare(db)
return
} }
func (s *notaryServerKeysStatements) InsertJSONResponse( func (s *notaryServerKeysStatements) InsertJSONResponse(

View File

@ -92,19 +92,12 @@ func NewSQLiteNotaryServerKeysMetadataTable(db *sql.DB) (s *notaryServerKeysMeta
return return
} }
if s.upsertServerKeysStmt, err = db.Prepare(upsertServerKeysSQL); err != nil { return s, sqlutil.StatementList{
return {&s.upsertServerKeysStmt, upsertServerKeysSQL},
} {&s.selectNotaryKeyResponsesStmt, selectNotaryKeyResponsesSQL},
if s.selectNotaryKeyResponsesStmt, err = db.Prepare(selectNotaryKeyResponsesSQL); err != nil { {&s.selectNotaryKeyMetadataStmt, selectNotaryKeyMetadataSQL},
return {&s.deleteUnusedServerKeysJSONStmt, deleteUnusedServerKeysJSONSQL},
} }.Prepare(db)
if s.selectNotaryKeyMetadataStmt, err = db.Prepare(selectNotaryKeyMetadataSQL); err != nil {
return
}
if s.deleteUnusedServerKeysJSONStmt, err = db.Prepare(deleteUnusedServerKeysJSONSQL); err != nil {
return
}
return
} }
func (s *notaryServerKeysMetadataStatements) UpsertKey( func (s *notaryServerKeysMetadataStatements) UpsertKey(

View File

@ -66,10 +66,10 @@ func NewSQLiteQueueJSONTable(db *sql.DB) (s *queueJSONStatements, err error) {
if err != nil { if err != nil {
return return
} }
if s.insertJSONStmt, err = db.Prepare(insertJSONSQL); err != nil {
return return s, sqlutil.StatementList{
} {&s.insertJSONStmt, insertJSONSQL},
return }.Prepare(db)
} }
func (s *queueJSONStatements) InsertQueueJSON( func (s *queueJSONStatements) InsertQueueJSON(

View File

@ -87,25 +87,13 @@ func NewSQLiteQueuePDUsTable(db *sql.DB) (s *queuePDUsStatements, err error) {
if err != nil { if err != nil {
return return
} }
if s.insertQueuePDUStmt, err = db.Prepare(insertQueuePDUSQL); err != nil { return s, sqlutil.StatementList{
return {&s.insertQueuePDUStmt, insertQueuePDUSQL},
} {&s.selectQueueNextTransactionIDStmt, selectQueueNextTransactionIDSQL},
//if s.deleteQueuePDUsStmt, err = db.Prepare(deleteQueuePDUsSQL); err != nil { {&s.selectQueuePDUsStmt, selectQueuePDUsSQL},
// return {&s.selectQueueReferenceJSONCountStmt, selectQueuePDUsReferenceJSONCountSQL},
//} {&s.selectQueueServerNamesStmt, selectQueuePDUsServerNamesSQL},
if s.selectQueueNextTransactionIDStmt, err = db.Prepare(selectQueueNextTransactionIDSQL); err != nil { }.Prepare(db)
return
}
if s.selectQueuePDUsStmt, err = db.Prepare(selectQueuePDUsSQL); err != nil {
return
}
if s.selectQueueReferenceJSONCountStmt, err = db.Prepare(selectQueuePDUsReferenceJSONCountSQL); err != nil {
return
}
if s.selectQueueServerNamesStmt, err = db.Prepare(selectQueuePDUsServerNamesSQL); err != nil {
return
}
return
} }
func (s *queuePDUsStatements) InsertQueuePDU( func (s *queuePDUsStatements) InsertQueuePDU(

View File

@ -74,13 +74,10 @@ func NewSQLiteServerSigningKeysTable(db *sql.DB) (s *serverSigningKeyStatements,
if err != nil { if err != nil {
return return
} }
if s.bulkSelectServerKeysStmt, err = db.Prepare(bulkSelectServerSigningKeysSQL); err != nil { return s, sqlutil.StatementList{
return {&s.bulkSelectServerKeysStmt, bulkSelectServerSigningKeysSQL},
} {&s.upsertServerKeysStmt, upsertServerSigningKeysSQL},
if s.upsertServerKeysStmt, err = db.Prepare(upsertServerSigningKeysSQL); err != nil { }.Prepare(db)
return
}
return s, nil
} }
func (s *serverSigningKeyStatements) BulkSelectServerKeys( func (s *serverSigningKeyStatements) BulkSelectServerKeys(

1
go.mod
View File

@ -30,7 +30,6 @@ require (
github.com/nats-io/nats.go v1.24.0 github.com/nats-io/nats.go v1.24.0
github.com/neilalexander/utp v0.1.1-0.20210727203401-54ae7b1cd5f9 github.com/neilalexander/utp v0.1.1-0.20210727203401-54ae7b1cd5f9
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646
github.com/ngrok/sqlmw v0.0.0-20220520173518-97c9c04efc79
github.com/opentracing/opentracing-go v1.2.0 github.com/opentracing/opentracing-go v1.2.0
github.com/patrickmn/go-cache v2.1.0+incompatible github.com/patrickmn/go-cache v2.1.0+incompatible
github.com/pkg/errors v0.9.1 github.com/pkg/errors v0.9.1

2
go.sum
View File

@ -368,8 +368,6 @@ github.com/neilalexander/utp v0.1.1-0.20210727203401-54ae7b1cd5f9 h1:lrVQzBtkeQE
github.com/neilalexander/utp v0.1.1-0.20210727203401-54ae7b1cd5f9/go.mod h1:NPHGhPc0/wudcaCqL/H5AOddkRf8GPRhzOujuUKGQu8= github.com/neilalexander/utp v0.1.1-0.20210727203401-54ae7b1cd5f9/go.mod h1:NPHGhPc0/wudcaCqL/H5AOddkRf8GPRhzOujuUKGQu8=
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 h1:zYyBkD/k9seD2A7fsi6Oo2LfFZAehjjQMERAvZLEDnQ= github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 h1:zYyBkD/k9seD2A7fsi6Oo2LfFZAehjjQMERAvZLEDnQ=
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646/go.mod h1:jpp1/29i3P1S/RLdc7JQKbRpFeM1dOBd8T9ki5s+AY8= github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646/go.mod h1:jpp1/29i3P1S/RLdc7JQKbRpFeM1dOBd8T9ki5s+AY8=
github.com/ngrok/sqlmw v0.0.0-20220520173518-97c9c04efc79 h1:Dmx8g2747UTVPzSkmohk84S3g/uWqd6+f4SSLPhLcfA=
github.com/ngrok/sqlmw v0.0.0-20220520173518-97c9c04efc79/go.mod h1:E26fwEtRNigBfFfHDWsklmo0T7Ixbg0XXgck+Hq4O9k=
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
github.com/onsi/ginkgo/v2 v2.3.0 h1:kUMoxMoQG3ogk/QWyKh3zibV7BKZ+xBpWil1cTylVqc= github.com/onsi/ginkgo/v2 v2.3.0 h1:kUMoxMoQG3ogk/QWyKh3zibV7BKZ+xBpWil1cTylVqc=
github.com/onsi/ginkgo/v2 v2.3.0/go.mod h1:Eew0uilEqZmIEZr8JrvYlvOM7Rr6xzTmMV8AyFNU9d0= github.com/onsi/ginkgo/v2 v2.3.0/go.mod h1:Eew0uilEqZmIEZr8JrvYlvOM7Rr6xzTmMV8AyFNU9d0=

View File

@ -4,7 +4,6 @@
package sqlutil package sqlutil
import ( import (
"github.com/mattn/go-sqlite3"
_ "github.com/mattn/go-sqlite3" _ "github.com/mattn/go-sqlite3"
) )
@ -13,7 +12,3 @@ const SQLITE_DRIVER_NAME = "sqlite3"
func sqliteDSNExtension(dsn string) string { func sqliteDSNExtension(dsn string) string {
return dsn return dsn
} }
func sqliteDriver() *sqlite3.SQLiteDriver {
return &sqlite3.SQLiteDriver{}
}

View File

@ -4,7 +4,6 @@
package sqlutil package sqlutil
import ( import (
"modernc.org/sqlite"
"strings" "strings"
) )
@ -23,7 +22,3 @@ func sqliteDSNExtension(dsn string) string {
dsn += "_pragma=busy_timeout%3d10000" dsn += "_pragma=busy_timeout%3d10000"
return dsn return dsn
} }
func sqliteDriver() *sqlite.Driver {
return &sqlite.Driver{}
}

View File

@ -13,8 +13,7 @@ import (
var skipSanityChecks = flag.Bool("skip-db-sanity", false, "Ignore sanity checks on the database connections (NOT RECOMMENDED!)") var skipSanityChecks = flag.Bool("skip-db-sanity", false, "Ignore sanity checks on the database connections (NOT RECOMMENDED!)")
// Open opens a database specified by its database driver name and a driver-specific data source name, // Open opens a database specified by its database driver name and a driver-specific data source name,
// usually consisting of at least a database name and connection information. Includes tracing driver // usually consisting of at least a database name and connection information.
// if DENDRITE_TRACE_SQL=1
func Open(dbProperties *config.DatabaseOptions, writer Writer) (*sql.DB, error) { func Open(dbProperties *config.DatabaseOptions, writer Writer) (*sql.DB, error) {
var err error var err error
var driverName, dsn string var driverName, dsn string
@ -32,10 +31,6 @@ func Open(dbProperties *config.DatabaseOptions, writer Writer) (*sql.DB, error)
default: default:
return nil, fmt.Errorf("invalid database connection string %q", dbProperties.ConnectionString) return nil, fmt.Errorf("invalid database connection string %q", dbProperties.ConnectionString)
} }
if tracingEnabled {
// install the wrapped driver
driverName += "-trace"
}
db, err := sql.Open(driverName, dsn) db, err := sql.Open(driverName, dsn)
if err != nil { if err != nil {
return nil, err return nil, err

View File

@ -1,109 +0,0 @@
// Copyright 2020 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package sqlutil
import (
"context"
"database/sql/driver"
"fmt"
"io"
"os"
"runtime"
"strconv"
"strings"
"sync"
"time"
"github.com/ngrok/sqlmw"
"github.com/sirupsen/logrus"
)
var tracingEnabled = os.Getenv("DENDRITE_TRACE_SQL") == "1"
var goidToWriter sync.Map
type traceInterceptor struct {
sqlmw.NullInterceptor
}
func (in *traceInterceptor) StmtQueryContext(ctx context.Context, stmt driver.StmtQueryContext, query string, args []driver.NamedValue) (context.Context, driver.Rows, error) {
startedAt := time.Now()
rows, err := stmt.QueryContext(ctx, args)
trackGoID(query)
logrus.WithField("duration", time.Since(startedAt)).WithField(logrus.ErrorKey, err).Debug("executed sql query ", query, " args: ", args)
return ctx, rows, err
}
func (in *traceInterceptor) StmtExecContext(ctx context.Context, stmt driver.StmtExecContext, query string, args []driver.NamedValue) (driver.Result, error) {
startedAt := time.Now()
result, err := stmt.ExecContext(ctx, args)
trackGoID(query)
logrus.WithField("duration", time.Since(startedAt)).WithField(logrus.ErrorKey, err).Debug("executed sql query ", query, " args: ", args)
return result, err
}
func (in *traceInterceptor) RowsNext(c context.Context, rows driver.Rows, dest []driver.Value) error {
err := rows.Next(dest)
if err == io.EOF {
// For all cases, we call Next() n+1 times, the first to populate the initial dest, then eventually
// it will io.EOF. If we log on each Next() call we log the last element twice, so don't.
return err
}
cols := rows.Columns()
logrus.Debug(strings.Join(cols, " | "))
b := strings.Builder{}
for i, val := range dest {
b.WriteString(fmt.Sprintf("%q", val))
if i+1 <= len(dest)-1 {
b.WriteString(" | ")
}
}
logrus.Debug(b.String())
return err
}
func trackGoID(query string) {
thisGoID := goid()
if _, ok := goidToWriter.Load(thisGoID); ok {
return // we're on a writer goroutine
}
q := strings.TrimSpace(query)
if strings.HasPrefix(q, "SELECT") {
return // SELECTs can go on other goroutines
}
logrus.Warnf("unsafe goid %d: SQL executed not on an ExclusiveWriter: %s", thisGoID, q)
}
func init() {
registerDrivers()
}
func goid() int {
var buf [64]byte
n := runtime.Stack(buf[:], false)
idField := strings.Fields(strings.TrimPrefix(string(buf[:n]), "goroutine "))[0]
id, err := strconv.Atoi(idField)
if err != nil {
panic(fmt.Sprintf("cannot get goroutine id: %v", err))
}
return id
}

View File

@ -1,35 +0,0 @@
// Copyright 2020 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//go:build !wasm
// +build !wasm
package sqlutil
import (
"database/sql"
"github.com/lib/pq"
"github.com/ngrok/sqlmw"
)
func registerDrivers() {
if !tracingEnabled {
return
}
// install the wrapped drivers
sql.Register("postgres-trace", sqlmw.Driver(&pq.Driver{}, new(traceInterceptor)))
sql.Register("sqlite3-trace", sqlmw.Driver(sqliteDriver(), new(traceInterceptor)))
}

View File

@ -1,34 +0,0 @@
// Copyright 2020 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//go:build wasm
// +build wasm
package sqlutil
import (
"database/sql"
sqlitejs "github.com/matrix-org/go-sqlite3-js"
"github.com/ngrok/sqlmw"
)
func registerDrivers() {
if !tracingEnabled {
return
}
// install the wrapped drivers
sql.Register("sqlite3_js-trace", sqlmw.Driver(&sqlitejs.SqliteJsDriver{}, new(traceInterceptor)))
}

View File

@ -60,11 +60,6 @@ func (w *ExclusiveWriter) run() {
if !w.running.CompareAndSwap(false, true) { if !w.running.CompareAndSwap(false, true) {
return return
} }
if tracingEnabled {
gid := goid()
goidToWriter.Store(gid, w)
defer goidToWriter.Delete(gid)
}
defer w.running.Store(false) defer w.running.Store(false)
for task := range w.todo { for task := range w.todo {

View File

@ -78,16 +78,11 @@ func NewPostgresAccountDataTable(db *sql.DB) (tables.AccountData, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
if s.insertAccountDataStmt, err = db.Prepare(insertAccountDataSQL); err != nil { return s, sqlutil.StatementList{
return nil, err {&s.insertAccountDataStmt, insertAccountDataSQL},
} {&s.selectAccountDataInRangeStmt, selectAccountDataInRangeSQL},
if s.selectAccountDataInRangeStmt, err = db.Prepare(selectAccountDataInRangeSQL); err != nil { {&s.selectMaxAccountDataIDStmt, selectMaxAccountDataIDSQL},
return nil, err }.Prepare(db)
}
if s.selectMaxAccountDataIDStmt, err = db.Prepare(selectMaxAccountDataIDSQL); err != nil {
return nil, err
}
return s, nil
} }
func (s *accountDataStatements) InsertAccountData( func (s *accountDataStatements) InsertAccountData(

View File

@ -61,16 +61,11 @@ func NewPostgresFilterTable(db *sql.DB) (tables.Filter, error) {
return nil, err return nil, err
} }
s := &filterStatements{} s := &filterStatements{}
if s.selectFilterStmt, err = db.Prepare(selectFilterSQL); err != nil { return s, sqlutil.StatementList{
return nil, err {&s.selectFilterStmt, selectFilterSQL},
} {&s.selectFilterIDByContentStmt, selectFilterIDByContentSQL},
if s.selectFilterIDByContentStmt, err = db.Prepare(selectFilterIDByContentSQL); err != nil { {&s.insertFilterStmt, insertFilterSQL},
return nil, err }.Prepare(db)
}
if s.insertFilterStmt, err = db.Prepare(insertFilterSQL); err != nil {
return nil, err
}
return s, nil
} }
func (s *filterStatements) SelectFilter( func (s *filterStatements) SelectFilter(

View File

@ -52,13 +52,11 @@ func NewPostgresIgnoresTable(db *sql.DB) (tables.Ignores, error) {
return nil, err return nil, err
} }
s := &ignoresStatements{} s := &ignoresStatements{}
if s.selectIgnoresStmt, err = db.Prepare(selectIgnoresSQL); err != nil {
return nil, err return s, sqlutil.StatementList{
} {&s.selectIgnoresStmt, selectIgnoresSQL},
if s.upsertIgnoresStmt, err = db.Prepare(upsertIgnoresSQL); err != nil { {&s.upsertIgnoresStmt, upsertIgnoresSQL},
return nil, err }.Prepare(db)
}
return s, nil
} }
func (s *ignoresStatements) SelectIgnores( func (s *ignoresStatements) SelectIgnores(

View File

@ -88,19 +88,12 @@ func NewPostgresSendToDeviceTable(db *sql.DB) (tables.SendToDevice, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
if s.insertSendToDeviceMessageStmt, err = db.Prepare(insertSendToDeviceMessageSQL); err != nil { return s, sqlutil.StatementList{
return nil, err {&s.insertSendToDeviceMessageStmt, insertSendToDeviceMessageSQL},
} {&s.selectSendToDeviceMessagesStmt, selectSendToDeviceMessagesSQL},
if s.selectSendToDeviceMessagesStmt, err = db.Prepare(selectSendToDeviceMessagesSQL); err != nil { {&s.deleteSendToDeviceMessagesStmt, deleteSendToDeviceMessagesSQL},
return nil, err {&s.selectMaxSendToDeviceIDStmt, selectMaxSendToDeviceIDSQL},
} }.Prepare(db)
if s.deleteSendToDeviceMessagesStmt, err = db.Prepare(deleteSendToDeviceMessagesSQL); err != nil {
return nil, err
}
if s.selectMaxSendToDeviceIDStmt, err = db.Prepare(selectMaxSendToDeviceIDSQL); err != nil {
return nil, err
}
return s, nil
} }
func (s *sendToDeviceStatements) InsertSendToDeviceMessage( func (s *sendToDeviceStatements) InsertSendToDeviceMessage(

View File

@ -66,16 +66,11 @@ func NewSqliteAccountDataTable(db *sql.DB, streamID *StreamIDStatements) (tables
if err != nil { if err != nil {
return nil, err return nil, err
} }
if s.insertAccountDataStmt, err = db.Prepare(insertAccountDataSQL); err != nil { return s, sqlutil.StatementList{
return nil, err {&s.insertAccountDataStmt, insertAccountDataSQL},
} {&s.selectMaxAccountDataIDStmt, selectMaxAccountDataIDSQL},
if s.selectMaxAccountDataIDStmt, err = db.Prepare(selectMaxAccountDataIDSQL); err != nil { {&s.selectAccountDataInRangeStmt, selectAccountDataInRangeSQL},
return nil, err }.Prepare(db)
}
if s.selectAccountDataInRangeStmt, err = db.Prepare(selectAccountDataInRangeSQL); err != nil {
return nil, err
}
return s, nil
} }
func (s *accountDataStatements) InsertAccountData( func (s *accountDataStatements) InsertAccountData(

View File

@ -65,16 +65,11 @@ func NewSqliteFilterTable(db *sql.DB) (tables.Filter, error) {
s := &filterStatements{ s := &filterStatements{
db: db, db: db,
} }
if s.selectFilterStmt, err = db.Prepare(selectFilterSQL); err != nil { return s, sqlutil.StatementList{
return nil, err {&s.selectFilterStmt, selectFilterSQL},
} {&s.selectFilterIDByContentStmt, selectFilterIDByContentSQL},
if s.selectFilterIDByContentStmt, err = db.Prepare(selectFilterIDByContentSQL); err != nil { {&s.insertFilterStmt, insertFilterSQL},
return nil, err }.Prepare(db)
}
if s.insertFilterStmt, err = db.Prepare(insertFilterSQL); err != nil {
return nil, err
}
return s, nil
} }
func (s *filterStatements) SelectFilter( func (s *filterStatements) SelectFilter(

View File

@ -52,13 +52,10 @@ func NewSqliteIgnoresTable(db *sql.DB) (tables.Ignores, error) {
return nil, err return nil, err
} }
s := &ignoresStatements{} s := &ignoresStatements{}
if s.selectIgnoresStmt, err = db.Prepare(selectIgnoresSQL); err != nil { return s, sqlutil.StatementList{
return nil, err {&s.selectIgnoresStmt, selectIgnoresSQL},
} {&s.upsertIgnoresStmt, upsertIgnoresSQL},
if s.upsertIgnoresStmt, err = db.Prepare(upsertIgnoresSQL); err != nil { }.Prepare(db)
return nil, err
}
return s, nil
} }
func (s *ignoresStatements) SelectIgnores( func (s *ignoresStatements) SelectIgnores(

View File

@ -88,19 +88,12 @@ func NewSqliteSendToDeviceTable(db *sql.DB) (tables.SendToDevice, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
if s.insertSendToDeviceMessageStmt, err = db.Prepare(insertSendToDeviceMessageSQL); err != nil { return s, sqlutil.StatementList{
return nil, err {&s.insertSendToDeviceMessageStmt, insertSendToDeviceMessageSQL},
} {&s.selectSendToDeviceMessagesStmt, selectSendToDeviceMessagesSQL},
if s.selectSendToDeviceMessagesStmt, err = db.Prepare(selectSendToDeviceMessagesSQL); err != nil { {&s.deleteSendToDeviceMessagesStmt, deleteSendToDeviceMessagesSQL},
return nil, err {&s.selectMaxSendToDeviceIDStmt, selectMaxSendToDeviceIDSQL},
} }.Prepare(db)
if s.deleteSendToDeviceMessagesStmt, err = db.Prepare(deleteSendToDeviceMessagesSQL); err != nil {
return nil, err
}
if s.selectMaxSendToDeviceIDStmt, err = db.Prepare(selectMaxSendToDeviceIDSQL); err != nil {
return nil, err
}
return s, nil
} }
func (s *sendToDeviceStatements) InsertSendToDeviceMessage( func (s *sendToDeviceStatements) InsertSendToDeviceMessage(

View File

@ -47,10 +47,9 @@ func (s *StreamIDStatements) Prepare(db *sql.DB) (err error) {
if err != nil { if err != nil {
return return
} }
if s.increaseStreamIDStmt, err = db.Prepare(increaseStreamIDStmt); err != nil { return sqlutil.StatementList{
return {&s.increaseStreamIDStmt, increaseStreamIDStmt},
} }.Prepare(db)
return
} }
func (s *StreamIDStatements) nextPDUID(ctx context.Context, txn *sql.Tx) (pos types.StreamPosition, err error) { func (s *StreamIDStatements) nextPDUID(ctx context.Context, txn *sql.Tx) (pos types.StreamPosition, err error) {