public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Chore: Add context to user (#39649)

Browse Source 
* Add context to user

* Add context for enterprise

* Add context for UpdateUserLastSeenAtCommand

* Remove xorm
This commit is contained in:
idafurjes
2021-10-04 15:46:09 +02:00
committed by GitHub
parent 42d7c32759
commit f4f0d74838
11 changed files with 152 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/sqlstore/dashboard_test.go
+1 -1
View File
@@ -595,7 +595,7 @@ func createUser(t *testing.T, sqlStore *SQLStore, name string, role string, isAd
require.NoError(t, err)
q1 := models.GetUserOrgListQuery{UserId: currentUser.Id}
err = GetUserOrgList(&q1)
err = GetUserOrgList(context.Background(), &q1)
require.NoError(t, err)
require.Equal(t, models.RoleType(role), q1.Result[0].Role)
pkg/services/sqlstore/org_test.go
+6 -6
View File
@@ -87,9 +87,9 @@ func TestAccountDataAccess(t *testing.T) {
q1 := models.GetUserOrgListQuery{UserId: ac1.Id}
q2 := models.GetUserOrgListQuery{UserId: ac2.Id}
err = GetUserOrgList(&q1)
err = GetUserOrgList(context.Background(), &q1)
require.NoError(t, err)
err = GetUserOrgList(&q2)
err = GetUserOrgList(context.Background(), &q2)
require.NoError(t, err)
require.Equal(t, q1.Result[0].OrgId, q2.Result[0].OrgId)
@@ -149,7 +149,7 @@ func TestAccountDataAccess(t *testing.T) {
t.Run("Should be able to read user info projection", func(t *testing.T) {
query := models.GetUserProfileQuery{UserId: ac1.Id}
err = GetUserProfile(&query)
err = sqlStore.GetUserProfile(context.Background(), &query)
require.NoError(t, err)
require.Equal(t, query.Result.Email, "ac1@test.com")
@@ -158,7 +158,7 @@ func TestAccountDataAccess(t *testing.T) {
t.Run("Can search users", func(t *testing.T) {
query := models.SearchUsersQuery{Query: ""}
err := SearchUsers(&query)
err := SearchUsers(context.Background(), &query)
require.NoError(t, err)
require.Equal(t, query.Result.Users[0].Email, "ac1@test.com")
@@ -205,7 +205,7 @@ func TestAccountDataAccess(t *testing.T) {
t.Run("Can get user organizations", func(t *testing.T) {
query := models.GetUserOrgListQuery{UserId: ac2.Id}
err := GetUserOrgList(&query)
err := GetUserOrgList(context.Background(), &query)
require.NoError(t, err)
require.Equal(t, len(query.Result), 2)
@@ -247,7 +247,7 @@ func TestAccountDataAccess(t *testing.T) {
t.Run("Can set using org", func(t *testing.T) {
cmd := models.SetUsingOrgCommand{UserId: ac2.Id, OrgId: ac1.OrgId}
err := SetUsingOrg(&cmd)
err := SetUsingOrg(context.Background(), &cmd)
require.NoError(t, err)
t.Run("SignedInUserQuery with a different org", func(t *testing.T) {
pkg/services/sqlstore/stats_test.go
+1 -1
View File
@@ -119,7 +119,7 @@ func populateDB(t *testing.T, sqlStore *SQLStore) {
updateUserLastSeenAtCmd := &models.UpdateUserLastSeenAtCommand{
UserId: users[0].Id,
}
err = UpdateUserLastSeenAt(updateUserLastSeenAtCmd)
err = UpdateUserLastSeenAt(context.Background(), updateUserLastSeenAtCmd)
require.NoError(t, err)
// force renewal of user stats
pkg/services/sqlstore/user.go
+89 -83
View File
@@ -19,19 +19,19 @@ func (ss *SQLStore) addUserQueryAndCommandHandlers() {
ss.Bus.AddHandlerCtx(ss.GetSignedInUserWithCacheCtx)
bus.AddHandlerCtx("sql", GetUserById)
bus.AddHandler("sql", UpdateUser)
bus.AddHandler("sql", ChangeUserPassword)
bus.AddHandler("sql", GetUserByLogin)
bus.AddHandler("sql", GetUserByEmail)
bus.AddHandler("sql", SetUsingOrg)
bus.AddHandler("sql", UpdateUserLastSeenAt)
bus.AddHandler("sql", GetUserProfile)
bus.AddHandler("sql", SearchUsers)
bus.AddHandler("sql", GetUserOrgList)
bus.AddHandler("sql", DisableUser)
bus.AddHandler("sql", BatchDisableUsers)
bus.AddHandler("sql", DeleteUser)
bus.AddHandler("sql", SetUserHelpFlag)
bus.AddHandlerCtx("sql", UpdateUser)
bus.AddHandlerCtx("sql", ChangeUserPassword)
bus.AddHandlerCtx("sql", ss.GetUserByLogin)
bus.AddHandlerCtx("sql", ss.GetUserByEmail)
bus.AddHandlerCtx("sql", SetUsingOrg)
bus.AddHandlerCtx("sql", UpdateUserLastSeenAt)
bus.AddHandlerCtx("sql", ss.GetUserProfile)
bus.AddHandlerCtx("sql", SearchUsers)
bus.AddHandlerCtx("sql", GetUserOrgList)
bus.AddHandlerCtx("sql", DisableUser)
bus.AddHandlerCtx("sql", BatchDisableUsers)
bus.AddHandlerCtx("sql", DeleteUser)
bus.AddHandlerCtx("sql", SetUserHelpFlag)
}
func getOrgIdForNewUser(sess *DBSession, cmd models.CreateUserCommand) (int64, error) {
@@ -297,58 +297,62 @@ func GetUserById(ctx context.Context, query *models.GetUserByIdQuery) error {
})
}
func GetUserByLogin(query *models.GetUserByLoginQuery) error {
if query.LoginOrEmail == "" {
return models.ErrUserNotFound
}
func (ss *SQLStore) GetUserByLogin(ctx context.Context, query *models.GetUserByLoginQuery) error {
return ss.WithDbSession(ctx, func(sess *DBSession) error {
if query.LoginOrEmail == "" {
return models.ErrUserNotFound
}
// Try and find the user by login first.
// It's not sufficient to assume that a LoginOrEmail with an "@" is an email.
user := &models.User{Login: query.LoginOrEmail}
has, err := x.Get(user)
// Try and find the user by login first.
// It's not sufficient to assume that a LoginOrEmail with an "@" is an email.
user := &models.User{Login: query.LoginOrEmail}
has, err := sess.Get(user)
if err != nil {
return err
}
if err != nil {
return err
}
if !has && strings.Contains(query.LoginOrEmail, "@") {
// If the user wasn't found, and it contains an "@" fallback to finding the
// user by email.
user = &models.User{Email: query.LoginOrEmail}
has, err = x.Get(user)
}
if !has && strings.Contains(query.LoginOrEmail, "@") {
// If the user wasn't found, and it contains an "@" fallback to finding the
// user by email.
user = &models.User{Email: query.LoginOrEmail}
has, err = sess.Get(user)
}
if err != nil {
return err
} else if !has {
return models.ErrUserNotFound
}
if err != nil {
return err
} else if !has {
return models.ErrUserNotFound
}
query.Result = user
query.Result = user
return nil
return nil
})
}
func GetUserByEmail(query *models.GetUserByEmailQuery) error {
if query.Email == "" {
return models.ErrUserNotFound
}
func (ss *SQLStore) GetUserByEmail(ctx context.Context, query *models.GetUserByEmailQuery) error {
return ss.WithDbSession(ctx, func(sess *DBSession) error {
if query.Email == "" {
return models.ErrUserNotFound
}
user := &models.User{Email: query.Email}
has, err := x.Get(user)
user := &models.User{Email: query.Email}
has, err := sess.Get(user)
if err != nil {
return err
} else if !has {
return models.ErrUserNotFound
}
if err != nil {
return err
} else if !has {
return models.ErrUserNotFound
}
query.Result = user
query.Result = user
return nil
return nil
})
}
func UpdateUser(cmd *models.UpdateUserCommand) error {
func UpdateUser(ctx context.Context, cmd *models.UpdateUserCommand) error {
return inTransaction(func(sess *DBSession) error {
user := models.User{
Name: cmd.Name,
@@ -374,7 +378,7 @@ func UpdateUser(cmd *models.UpdateUserCommand) error {
})
}
func ChangeUserPassword(cmd *models.ChangeUserPasswordCommand) error {
func ChangeUserPassword(ctx context.Context, cmd *models.ChangeUserPasswordCommand) error {
return inTransaction(func(sess *DBSession) error {
user := models.User{
Password: cmd.NewPassword,
@@ -386,7 +390,7 @@ func ChangeUserPassword(cmd *models.ChangeUserPasswordCommand) error {
})
}
func UpdateUserLastSeenAt(cmd *models.UpdateUserLastSeenAtCommand) error {
func UpdateUserLastSeenAt(ctx context.Context, cmd *models.UpdateUserLastSeenAtCommand) error {
return inTransaction(func(sess *DBSession) error {
user := models.User{
Id: cmd.UserId,
@@ -398,9 +402,9 @@ func UpdateUserLastSeenAt(cmd *models.UpdateUserLastSeenAtCommand) error {
})
}
func SetUsingOrg(cmd *models.SetUsingOrgCommand) error {
func SetUsingOrg(ctx context.Context, cmd *models.SetUsingOrgCommand) error {
getOrgsForUserCmd := &models.GetUserOrgListQuery{UserId: cmd.UserId}
if err := GetUserOrgList(getOrgsForUserCmd); err != nil {
if err := GetUserOrgList(ctx, getOrgsForUserCmd); err != nil {
return err
}
@@ -429,30 +433,32 @@ func setUsingOrgInTransaction(sess *DBSession, userID int64, orgID int64) error
return err
}
func GetUserProfile(query *models.GetUserProfileQuery) error {
var user models.User
has, err := x.Id(query.UserId).Get(&user)
func (ss *SQLStore) GetUserProfile(ctx context.Context, query *models.GetUserProfileQuery) error {
return ss.WithDbSession(ctx, func(sess *DBSession) error {
var user models.User
has, err := sess.ID(query.UserId).Get(&user)
if err != nil {
return err
} else if !has {
return models.ErrUserNotFound
}
query.Result = models.UserProfileDTO{
Id: user.Id,
Name: user.Name,
Email: user.Email,
Login: user.Login,
Theme: user.Theme,
IsGrafanaAdmin: user.IsAdmin,
IsDisabled: user.IsDisabled,
OrgId: user.OrgId,
UpdatedAt: user.Updated,
CreatedAt: user.Created,
}
if err != nil {
return err
} else if !has {
return models.ErrUserNotFound
}
query.Result = models.UserProfileDTO{
Id: user.Id,
Name: user.Name,
Email: user.Email,
Login: user.Login,
Theme: user.Theme,
IsGrafanaAdmin: user.IsAdmin,
IsDisabled: user.IsDisabled,
OrgId: user.OrgId,
UpdatedAt: user.Updated,
CreatedAt: user.Created,
}
return err
})
}
type byOrgName []*models.UserOrgDTO
@@ -476,7 +482,7 @@ func (o byOrgName) Less(i, j int) bool {
return o[i].Name < o[j].Name
}
func GetUserOrgList(query *models.GetUserOrgListQuery) error {
func GetUserOrgList(ctx context.Context, query *models.GetUserOrgListQuery) error {
query.Result = make([]*models.UserOrgDTO, 0)
sess := x.Table("org_user")
sess.Join("INNER", "org", "org_user.org_id=org.id")
@@ -570,7 +576,7 @@ func GetSignedInUser(ctx context.Context, query *models.GetSignedInUserQuery) er
return err
}
func SearchUsers(query *models.SearchUsersQuery) error {
func SearchUsers(ctx context.Context, query *models.SearchUsersQuery) error {
query.Result = models.SearchUserQueryResult{
Users: make([]*models.UserSearchHitDTO, 0),
}
@@ -652,7 +658,7 @@ func SearchUsers(query *models.SearchUsersQuery) error {
return err
}
func DisableUser(cmd *models.DisableUserCommand) error {
func DisableUser(ctx context.Context, cmd *models.DisableUserCommand) error {
user := models.User{}
sess := x.Table("user")
@@ -669,7 +675,7 @@ func DisableUser(cmd *models.DisableUserCommand) error {
return err
}
func BatchDisableUsers(cmd *models.BatchDisableUsersCommand) error {
func BatchDisableUsers(ctx context.Context, cmd *models.BatchDisableUsersCommand) error {
return inTransaction(func(sess *DBSession) error {
userIds := cmd.UserIds
@@ -694,7 +700,7 @@ func BatchDisableUsers(cmd *models.BatchDisableUsersCommand) error {
})
}
func DeleteUser(cmd *models.DeleteUserCommand) error {
func DeleteUser(ctx context.Context, cmd *models.DeleteUserCommand) error {
return inTransaction(func(sess *DBSession) error {
return deleteUserInTransaction(sess, cmd)
})
@@ -757,7 +763,7 @@ func (ss *SQLStore) UpdateUserPermissions(userID int64, isAdmin bool) error {
})
}
func SetUserHelpFlag(cmd *models.SetUserHelpFlagCommand) error {
func SetUserHelpFlag(ctx context.Context, cmd *models.SetUserHelpFlagCommand) error {
return inTransaction(func(sess *DBSession) error {
user := models.User{
Id: cmd.UserId,
pkg/services/sqlstore/user_test.go
+18 -18
View File
@@ -130,7 +130,7 @@ func TestUserDataAccess(t *testing.T) {
// Return the first page of users and a total count
query := models.SearchUsersQuery{Query: "", Page: 1, Limit: 3}
err := SearchUsers(&query)
err := SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 3)
@@ -138,7 +138,7 @@ func TestUserDataAccess(t *testing.T) {
// Return the second page of users and a total count
query = models.SearchUsersQuery{Query: "", Page: 2, Limit: 3}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 2)
@@ -146,28 +146,28 @@ func TestUserDataAccess(t *testing.T) {
// Return list of users matching query on user name
query = models.SearchUsersQuery{Query: "use", Page: 1, Limit: 3}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 3)
require.EqualValues(t, query.Result.TotalCount, 5)
query = models.SearchUsersQuery{Query: "ser1", Page: 1, Limit: 3}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 1)
require.EqualValues(t, query.Result.TotalCount, 1)
query = models.SearchUsersQuery{Query: "USER1", Page: 1, Limit: 3}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 1)
require.EqualValues(t, query.Result.TotalCount, 1)
query = models.SearchUsersQuery{Query: "idontexist", Page: 1, Limit: 3}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 0)
@@ -175,7 +175,7 @@ func TestUserDataAccess(t *testing.T) {
// Return list of users matching query on email
query = models.SearchUsersQuery{Query: "ser1@test.com", Page: 1, Limit: 3}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 1)
@@ -183,7 +183,7 @@ func TestUserDataAccess(t *testing.T) {
// Return list of users matching query on login name
query = models.SearchUsersQuery{Query: "loginuser1", Page: 1, Limit: 3}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 1)
@@ -203,7 +203,7 @@ func TestUserDataAccess(t *testing.T) {
isDisabled := false
query := models.SearchUsersQuery{IsDisabled: &isDisabled}
err := SearchUsers(&query)
err := SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.Len(t, query.Result.Users, 2)
@@ -251,7 +251,7 @@ func TestUserDataAccess(t *testing.T) {
require.Nil(t, err)
// When the user is deleted
err = DeleteUser(&models.DeleteUserCommand{UserId: users[1].Id})
err = DeleteUser(context.Background(), &models.DeleteUserCommand{UserId: users[1].Id})
require.Nil(t, err)
query1 := &models.GetOrgUsersQuery{OrgId: users[0].OrgId}
@@ -308,7 +308,7 @@ func TestUserDataAccess(t *testing.T) {
require.Nil(t, err)
require.NotNil(t, query3.Result)
require.Equal(t, query3.OrgId, users[1].OrgId)
err = SetUsingOrg(&models.SetUsingOrgCommand{UserId: users[1].Id, OrgId: users[0].OrgId})
err = SetUsingOrg(context.Background(), &models.SetUsingOrgCommand{UserId: users[1].Id, OrgId: users[0].OrgId})
require.Nil(t, err)
query4 := &models.GetSignedInUserQuery{OrgId: 0, UserId: users[1].Id}
err = ss.GetSignedInUserWithCacheCtx(context.Background(), query4)
@@ -325,18 +325,18 @@ func TestUserDataAccess(t *testing.T) {
IsDisabled: true,
}
err = BatchDisableUsers(&disableCmd)
err = BatchDisableUsers(context.Background(), &disableCmd)
require.Nil(t, err)
isDisabled = true
query5 := &models.SearchUsersQuery{IsDisabled: &isDisabled}
err = SearchUsers(query5)
err = SearchUsers(context.Background(), query5)
require.Nil(t, err)
require.EqualValues(t, query5.Result.TotalCount, 5)
// the user is deleted
err = DeleteUser(&models.DeleteUserCommand{UserId: users[1].Id})
err = DeleteUser(context.Background(), &models.DeleteUserCommand{UserId: users[1].Id})
require.Nil(t, err)
// delete connected org users and permissions
@@ -378,12 +378,12 @@ func TestUserDataAccess(t *testing.T) {
IsDisabled: false,
}
err := BatchDisableUsers(&disableCmd)
err := BatchDisableUsers(context.Background(), &disableCmd)
require.Nil(t, err)
isDisabled := false
query := &models.SearchUsersQuery{IsDisabled: &isDisabled}
err = SearchUsers(query)
err = SearchUsers(context.Background(), query)
require.Nil(t, err)
require.EqualValues(t, query.Result.TotalCount, 5)
@@ -410,11 +410,11 @@ func TestUserDataAccess(t *testing.T) {
IsDisabled: true,
}
err := BatchDisableUsers(&disableCmd)
err := BatchDisableUsers(context.Background(), &disableCmd)
require.Nil(t, err)
query := models.SearchUsersQuery{}
err = SearchUsers(&query)
err = SearchUsers(context.Background(), &query)
require.Nil(t, err)
require.EqualValues(t, query.Result.TotalCount, 5)