[MM-39639] - Migrate from gorp to sqlx in store/sqlstore/user_access_token_store.go (#18888)

Automatic Merge
Этот коммит содержится в:
Penthaa Patel
2021-11-11 10:10:13 +05:30
коммит произвёл GitHub
родитель e3051b0df8
Коммит df3ed307df

Просмотреть файл

@@ -7,7 +7,6 @@ import (
"database/sql" "database/sql"
"fmt" "fmt"
"github.com/mattermost/gorp"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/mattermost/mattermost-server/v6/model" "github.com/mattermost/mattermost-server/v6/model"
@@ -43,19 +42,26 @@ func (s SqlUserAccessTokenStore) Save(token *model.UserAccessToken) (*model.User
return nil, err return nil, err
} }
if err := s.GetMaster().Insert(token); err != nil { query, args, err := s.getQueryBuilder().Insert("UserAccessTokens").
Columns("Id", "Token", "UserId", "Description", "IsActive").
Values(token.Id, token.Token, token.UserId, token.Description, token.IsActive).
ToSql()
if err != nil {
return nil, errors.Wrap(err, "UserAccessToken_tosql")
}
if _, err := s.GetMasterX().Exec(query, args...); err != nil {
return nil, errors.Wrap(err, "failed to save UserAccessToken") return nil, errors.Wrap(err, "failed to save UserAccessToken")
} }
return token, nil return token, nil
} }
func (s SqlUserAccessTokenStore) Delete(tokenId string) error { func (s SqlUserAccessTokenStore) Delete(tokenId string) error {
transaction, err := s.GetMaster().Begin() transaction, err := s.GetMasterX().Beginx()
if err != nil { if err != nil {
return errors.Wrap(err, "begin_transaction") return errors.Wrap(err, "begin_transaction")
} }
defer finalizeTransaction(transaction) defer finalizeTransactionX(transaction)
if err := s.deleteSessionsAndTokensById(transaction, tokenId); err == nil { if err := s.deleteSessionsAndTokensById(transaction, tokenId); err == nil {
if err := transaction.Commit(); err != nil { if err := transaction.Commit(); err != nil {
@@ -68,25 +74,25 @@ func (s SqlUserAccessTokenStore) Delete(tokenId string) error {
} }
func (s SqlUserAccessTokenStore) deleteSessionsAndTokensById(transaction *gorp.Transaction, tokenId string) error { func (s SqlUserAccessTokenStore) deleteSessionsAndTokensById(transaction *sqlxTxWrapper, tokenId string) error {
query := "" query := ""
if s.DriverName() == model.DatabaseDriverPostgres { if s.DriverName() == model.DatabaseDriverPostgres {
query = "DELETE FROM Sessions s USING UserAccessTokens o WHERE o.Token = s.Token AND o.Id = :Id" query = "DELETE FROM Sessions s USING UserAccessTokens o WHERE o.Token = s.Token AND o.Id = ?"
} else if s.DriverName() == model.DatabaseDriverMysql { } else if s.DriverName() == model.DatabaseDriverMysql {
query = "DELETE s.* FROM Sessions s INNER JOIN UserAccessTokens o ON o.Token = s.Token WHERE o.Id = :Id" query = "DELETE s.* FROM Sessions s INNER JOIN UserAccessTokens o ON o.Token = s.Token WHERE o.Id = ?"
} }
if _, err := transaction.Exec(query, map[string]interface{}{"Id": tokenId}); err != nil { if _, err := transaction.Exec(query, tokenId); err != nil {
return errors.Wrapf(err, "failed to delete Sessions with UserAccessToken id=%s", tokenId) return errors.Wrapf(err, "failed to delete Sessions with UserAccessToken id=%s", tokenId)
} }
return s.deleteTokensById(transaction, tokenId) return s.deleteTokensById(transaction, tokenId)
} }
func (s SqlUserAccessTokenStore) deleteTokensById(transaction *gorp.Transaction, tokenId string) error { func (s SqlUserAccessTokenStore) deleteTokensById(transaction *sqlxTxWrapper, tokenId string) error {
if _, err := transaction.Exec("DELETE FROM UserAccessTokens WHERE Id = :Id", map[string]interface{}{"Id": tokenId}); err != nil { if _, err := transaction.Exec("DELETE FROM UserAccessTokens WHERE Id = ?", tokenId); err != nil {
return errors.Wrapf(err, "failed to delete UserAccessToken id=%s", tokenId) return errors.Wrapf(err, "failed to delete UserAccessToken id=%s", tokenId)
} }
@@ -94,11 +100,11 @@ func (s SqlUserAccessTokenStore) deleteTokensById(transaction *gorp.Transaction,
} }
func (s SqlUserAccessTokenStore) DeleteAllForUser(userId string) error { func (s SqlUserAccessTokenStore) DeleteAllForUser(userId string) error {
transaction, err := s.GetMaster().Begin() transaction, err := s.GetMasterX().Beginx()
if err != nil { if err != nil {
return errors.Wrap(err, "begin_transaction") return errors.Wrap(err, "begin_transaction")
} }
defer finalizeTransaction(transaction) defer finalizeTransactionX(transaction)
if err := s.deleteSessionsandTokensByUser(transaction, userId); err != nil { if err := s.deleteSessionsandTokensByUser(transaction, userId); err != nil {
return err return err
} }
@@ -110,23 +116,23 @@ func (s SqlUserAccessTokenStore) DeleteAllForUser(userId string) error {
return nil return nil
} }
func (s SqlUserAccessTokenStore) deleteSessionsandTokensByUser(transaction *gorp.Transaction, userId string) error { func (s SqlUserAccessTokenStore) deleteSessionsandTokensByUser(transaction *sqlxTxWrapper, userId string) error {
query := "" query := ""
if s.DriverName() == model.DatabaseDriverPostgres { if s.DriverName() == model.DatabaseDriverPostgres {
query = "DELETE FROM Sessions s USING UserAccessTokens o WHERE o.Token = s.Token AND o.UserId = :UserId" query = "DELETE FROM Sessions s USING UserAccessTokens o WHERE o.Token = s.Token AND o.UserId = ?"
} else if s.DriverName() == model.DatabaseDriverMysql { } else if s.DriverName() == model.DatabaseDriverMysql {
query = "DELETE s.* FROM Sessions s INNER JOIN UserAccessTokens o ON o.Token = s.Token WHERE o.UserId = :UserId" query = "DELETE s.* FROM Sessions s INNER JOIN UserAccessTokens o ON o.Token = s.Token WHERE o.UserId = ?"
} }
if _, err := transaction.Exec(query, map[string]interface{}{"UserId": userId}); err != nil { if _, err := transaction.Exec(query, userId); err != nil {
return errors.Wrapf(err, "failed to delete Sessions with UserAccessToken userId=%s", userId) return errors.Wrapf(err, "failed to delete Sessions with UserAccessToken userId=%s", userId)
} }
return s.deleteTokensByUser(transaction, userId) return s.deleteTokensByUser(transaction, userId)
} }
func (s SqlUserAccessTokenStore) deleteTokensByUser(transaction *gorp.Transaction, userId string) error { func (s SqlUserAccessTokenStore) deleteTokensByUser(transaction *sqlxTxWrapper, userId string) error {
if _, err := transaction.Exec("DELETE FROM UserAccessTokens WHERE UserId = :UserId", map[string]interface{}{"UserId": userId}); err != nil { if _, err := transaction.Exec("DELETE FROM UserAccessTokens WHERE UserId = ?", userId); err != nil {
return errors.Wrapf(err, "failed to delete UserAccessToken userId=%s", userId) return errors.Wrapf(err, "failed to delete UserAccessToken userId=%s", userId)
} }
@@ -134,9 +140,9 @@ func (s SqlUserAccessTokenStore) deleteTokensByUser(transaction *gorp.Transactio
} }
func (s SqlUserAccessTokenStore) Get(tokenId string) (*model.UserAccessToken, error) { func (s SqlUserAccessTokenStore) Get(tokenId string) (*model.UserAccessToken, error) {
token := model.UserAccessToken{} var token model.UserAccessToken
if err := s.GetReplica().SelectOne(&token, "SELECT * FROM UserAccessTokens WHERE Id = :Id", map[string]interface{}{"Id": tokenId}); err != nil { if err := s.GetReplicaX().Get(&token, "SELECT * FROM UserAccessTokens WHERE Id = ?", tokenId); err != nil {
if err == sql.ErrNoRows { if err == sql.ErrNoRows {
return nil, store.NewErrNotFound("UserAccessToken", tokenId) return nil, store.NewErrNotFound("UserAccessToken", tokenId)
} }
@@ -149,7 +155,7 @@ func (s SqlUserAccessTokenStore) Get(tokenId string) (*model.UserAccessToken, er
func (s SqlUserAccessTokenStore) GetAll(offset, limit int) ([]*model.UserAccessToken, error) { func (s SqlUserAccessTokenStore) GetAll(offset, limit int) ([]*model.UserAccessToken, error) {
tokens := []*model.UserAccessToken{} tokens := []*model.UserAccessToken{}
if _, err := s.GetReplica().Select(&tokens, "SELECT * FROM UserAccessTokens LIMIT :Limit OFFSET :Offset", map[string]interface{}{"Offset": offset, "Limit": limit}); err != nil { if err := s.GetReplicaX().Select(&tokens, "SELECT * FROM UserAccessTokens LIMIT ? OFFSET ?", limit, offset); err != nil {
return nil, errors.Wrap(err, "failed to find UserAccessTokens") return nil, errors.Wrap(err, "failed to find UserAccessTokens")
} }
@@ -157,9 +163,9 @@ func (s SqlUserAccessTokenStore) GetAll(offset, limit int) ([]*model.UserAccessT
} }
func (s SqlUserAccessTokenStore) GetByToken(tokenString string) (*model.UserAccessToken, error) { func (s SqlUserAccessTokenStore) GetByToken(tokenString string) (*model.UserAccessToken, error) {
token := model.UserAccessToken{} var token model.UserAccessToken
if err := s.GetReplica().SelectOne(&token, "SELECT * FROM UserAccessTokens WHERE Token = :Token", map[string]interface{}{"Token": tokenString}); err != nil { if err := s.GetReplicaX().Get(&token, "SELECT * FROM UserAccessTokens WHERE Token = ?", tokenString); err != nil {
if err == sql.ErrNoRows { if err == sql.ErrNoRows {
return nil, store.NewErrNotFound("UserAccessToken", fmt.Sprintf("token=%s", tokenString)) return nil, store.NewErrNotFound("UserAccessToken", fmt.Sprintf("token=%s", tokenString))
} }
@@ -172,7 +178,7 @@ func (s SqlUserAccessTokenStore) GetByToken(tokenString string) (*model.UserAcce
func (s SqlUserAccessTokenStore) GetByUser(userId string, offset, limit int) ([]*model.UserAccessToken, error) { func (s SqlUserAccessTokenStore) GetByUser(userId string, offset, limit int) ([]*model.UserAccessToken, error) {
tokens := []*model.UserAccessToken{} tokens := []*model.UserAccessToken{}
if _, err := s.GetReplica().Select(&tokens, "SELECT * FROM UserAccessTokens WHERE UserId = :UserId LIMIT :Limit OFFSET :Offset", map[string]interface{}{"UserId": userId, "Offset": offset, "Limit": limit}); err != nil { if err := s.GetReplicaX().Select(&tokens, "SELECT * FROM UserAccessTokens WHERE UserId = ? LIMIT ? OFFSET ?", userId, limit, offset); err != nil {
return nil, errors.Wrapf(err, "failed to find UserAccessTokens with userId=%s", userId) return nil, errors.Wrapf(err, "failed to find UserAccessTokens with userId=%s", userId)
} }
@@ -182,16 +188,16 @@ func (s SqlUserAccessTokenStore) GetByUser(userId string, offset, limit int) ([]
func (s SqlUserAccessTokenStore) Search(term string) ([]*model.UserAccessToken, error) { func (s SqlUserAccessTokenStore) Search(term string) ([]*model.UserAccessToken, error) {
term = sanitizeSearchTerm(term, "\\") term = sanitizeSearchTerm(term, "\\")
tokens := []*model.UserAccessToken{} tokens := []*model.UserAccessToken{}
params := map[string]interface{}{"Term": term + "%"} params := []interface{}{term, term, term}
query := ` query := `
SELECT SELECT
uat.* uat.*
FROM UserAccessTokens uat FROM UserAccessTokens uat
INNER JOIN Users u INNER JOIN Users u
ON uat.UserId = u.Id ON uat.UserId = u.Id
WHERE uat.Id LIKE :Term OR uat.UserId LIKE :Term OR u.Username LIKE :Term` WHERE uat.Id LIKE ? OR uat.UserId LIKE ? OR u.Username LIKE ?`
if _, err := s.GetReplica().Select(&tokens, query, params); err != nil { if err := s.GetReplicaX().Select(&tokens, query, params...); err != nil {
return nil, errors.Wrapf(err, "failed to find UserAccessTokens by term with value '%s'", term) return nil, errors.Wrapf(err, "failed to find UserAccessTokens by term with value '%s'", term)
} }
@@ -199,18 +205,18 @@ func (s SqlUserAccessTokenStore) Search(term string) ([]*model.UserAccessToken,
} }
func (s SqlUserAccessTokenStore) UpdateTokenEnable(tokenId string) error { func (s SqlUserAccessTokenStore) UpdateTokenEnable(tokenId string) error {
if _, err := s.GetMaster().Exec("UPDATE UserAccessTokens SET IsActive = TRUE WHERE Id = :Id", map[string]interface{}{"Id": tokenId}); err != nil { if _, err := s.GetMasterX().Exec("UPDATE UserAccessTokens SET IsActive = TRUE WHERE Id = ?", tokenId); err != nil {
return errors.Wrapf(err, "failed to update UserAccessTokens with id=%s", tokenId) return errors.Wrapf(err, "failed to update UserAccessTokens with id=%s", tokenId)
} }
return nil return nil
} }
func (s SqlUserAccessTokenStore) UpdateTokenDisable(tokenId string) error { func (s SqlUserAccessTokenStore) UpdateTokenDisable(tokenId string) error {
transaction, err := s.GetMaster().Begin() transaction, err := s.GetMasterX().Beginx()
if err != nil { if err != nil {
return errors.Wrap(err, "begin_transaction") return errors.Wrap(err, "begin_transaction")
} }
defer finalizeTransaction(transaction) defer finalizeTransactionX(transaction)
if err := s.deleteSessionsAndDisableToken(transaction, tokenId); err != nil { if err := s.deleteSessionsAndDisableToken(transaction, tokenId); err != nil {
return err return err
@@ -222,23 +228,23 @@ func (s SqlUserAccessTokenStore) UpdateTokenDisable(tokenId string) error {
return nil return nil
} }
func (s SqlUserAccessTokenStore) deleteSessionsAndDisableToken(transaction *gorp.Transaction, tokenId string) error { func (s SqlUserAccessTokenStore) deleteSessionsAndDisableToken(transaction *sqlxTxWrapper, tokenId string) error {
query := "" query := ""
if s.DriverName() == model.DatabaseDriverPostgres { if s.DriverName() == model.DatabaseDriverPostgres {
query = "DELETE FROM Sessions s USING UserAccessTokens o WHERE o.Token = s.Token AND o.Id = :Id" query = "DELETE FROM Sessions s USING UserAccessTokens o WHERE o.Token = s.Token AND o.Id = ?"
} else if s.DriverName() == model.DatabaseDriverMysql { } else if s.DriverName() == model.DatabaseDriverMysql {
query = "DELETE s.* FROM Sessions s INNER JOIN UserAccessTokens o ON o.Token = s.Token WHERE o.Id = :Id" query = "DELETE s.* FROM Sessions s INNER JOIN UserAccessTokens o ON o.Token = s.Token WHERE o.Id = ?"
} }
if _, err := transaction.Exec(query, map[string]interface{}{"Id": tokenId}); err != nil { if _, err := transaction.Exec(query, tokenId); err != nil {
return errors.Wrapf(err, "failed to delete Sessions with UserAccessToken id=%s", tokenId) return errors.Wrapf(err, "failed to delete Sessions with UserAccessToken id=%s", tokenId)
} }
return s.updateTokenDisable(transaction, tokenId) return s.updateTokenDisable(transaction, tokenId)
} }
func (s SqlUserAccessTokenStore) updateTokenDisable(transaction *gorp.Transaction, tokenId string) error { func (s SqlUserAccessTokenStore) updateTokenDisable(transaction *sqlxTxWrapper, tokenId string) error {
if _, err := transaction.Exec("UPDATE UserAccessTokens SET IsActive = FALSE WHERE Id = :Id", map[string]interface{}{"Id": tokenId}); err != nil { if _, err := transaction.Exec("UPDATE UserAccessTokens SET IsActive = FALSE WHERE Id = ?", tokenId); err != nil {
return errors.Wrapf(err, "failed to update UserAccessToken with id=%s", tokenId) return errors.Wrapf(err, "failed to update UserAccessToken with id=%s", tokenId)
} }