mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
8b77ee2734
* SQLStore: Ensure that sessions are always closed Delete `NewSession()` in favour of `WithDbSession()` * Add WithDbSessionForceNewSession to the interface * Apply suggestions from code review
104 lines
2.7 KiB
Go
104 lines
2.7 KiB
Go
package sqlstore
|
|
|
|
import (
|
|
"context"
|
|
"reflect"
|
|
|
|
"xorm.io/xorm"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
|
)
|
|
|
|
var sessionLogger = log.New("sqlstore.session")
|
|
|
|
type DBSession struct {
|
|
*xorm.Session
|
|
transactionOpen bool
|
|
events []interface{}
|
|
}
|
|
|
|
type DBTransactionFunc func(sess *DBSession) error
|
|
|
|
func (sess *DBSession) publishAfterCommit(msg interface{}) {
|
|
sess.events = append(sess.events, msg)
|
|
}
|
|
|
|
func (sess *DBSession) PublishAfterCommit(msg interface{}) {
|
|
sess.events = append(sess.events, msg)
|
|
}
|
|
|
|
func startSessionOrUseExisting(ctx context.Context, engine *xorm.Engine, beginTran bool) (*DBSession, bool, error) {
|
|
value := ctx.Value(ContextSessionKey{})
|
|
var sess *DBSession
|
|
sess, ok := value.(*DBSession)
|
|
|
|
if ok {
|
|
ctxLogger := sessionLogger.FromContext(ctx)
|
|
ctxLogger.Debug("reusing existing session", "transaction", sess.transactionOpen)
|
|
sess.Session = sess.Session.Context(ctx)
|
|
return sess, false, nil
|
|
}
|
|
|
|
newSess := &DBSession{Session: engine.NewSession(), transactionOpen: beginTran}
|
|
if beginTran {
|
|
err := newSess.Begin()
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
}
|
|
|
|
newSess.Session = newSess.Session.Context(ctx)
|
|
|
|
return newSess, true, nil
|
|
}
|
|
|
|
// WithDbSession calls the callback with the session in the context (if exists).
|
|
// Otherwise it creates a new one that is closed upon completion.
|
|
// A session is stored in the context if sqlstore.InTransaction() has been been previously called with the same context (and it's not committed/rolledback yet).
|
|
func (ss *SQLStore) WithDbSession(ctx context.Context, callback DBTransactionFunc) error {
|
|
return withDbSession(ctx, ss.engine, callback)
|
|
}
|
|
|
|
// WithNewDbSession calls the callback with a new session that is closed upon completion.
|
|
func (ss *SQLStore) WithNewDbSession(ctx context.Context, callback DBTransactionFunc) error {
|
|
sess := &DBSession{Session: ss.engine.NewSession(), transactionOpen: false}
|
|
defer sess.Close()
|
|
return callback(sess)
|
|
}
|
|
|
|
func withDbSession(ctx context.Context, engine *xorm.Engine, callback DBTransactionFunc) error {
|
|
sess, isNew, err := startSessionOrUseExisting(ctx, engine, false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if isNew {
|
|
defer sess.Close()
|
|
}
|
|
return callback(sess)
|
|
}
|
|
|
|
func (sess *DBSession) InsertId(bean interface{}) (int64, error) {
|
|
table := sess.DB().Mapper.Obj2Table(getTypeName(bean))
|
|
|
|
if err := dialect.PreInsertId(table, sess.Session); err != nil {
|
|
return 0, err
|
|
}
|
|
id, err := sess.Session.InsertOne(bean)
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
if err := dialect.PostInsertId(table, sess.Session); err != nil {
|
|
return 0, err
|
|
}
|
|
|
|
return id, nil
|
|
}
|
|
|
|
func getTypeName(bean interface{}) (res string) {
|
|
t := reflect.TypeOf(bean)
|
|
for t.Kind() == reflect.Ptr {
|
|
t = t.Elem()
|
|
}
|
|
return t.Name()
|
|
}
|