Chore: Add user service method GetByLogin (#53204)

* Add wrapper around sqlstore method GetUserByLogin

* Use new method from user service

* Fix lint

* Fix lint 2

* fix middleware basic auth test

* Fix grafana login returning a user by login

* Remove GetUserByLogin from store interface

* Merge commit

pkg/services/login/authinfoservice/database/database.go

@@ -34,23 +34,23 @@ func ProvideAuthInfoStore(sqlStore sqlstore.Store, secretsService secrets.Servic
 }
 
 func (s *AuthInfoStore) GetExternalUserInfoByLogin(ctx context.Context, query *models.GetExternalUserInfoByLoginQuery) error {
-	userQuery := models.GetUserByLoginQuery{LoginOrEmail: query.LoginOrEmail}
-	err := s.sqlStore.GetUserByLogin(ctx, &userQuery)
+	userQuery := user.GetUserByLoginQuery{LoginOrEmail: query.LoginOrEmail}
+	usr, err := s.userService.GetByLogin(ctx, &userQuery)
 	if err != nil {
 		return err
 	}
 
-	authInfoQuery := &models.GetAuthInfoQuery{UserId: userQuery.Result.ID}
+	authInfoQuery := &models.GetAuthInfoQuery{UserId: usr.ID}
 	if err := s.GetAuthInfo(ctx, authInfoQuery); err != nil {
 		return err
 	}
 
 	query.Result = &models.ExternalUserInfo{
-		UserId:     userQuery.Result.ID,
-		Login:      userQuery.Result.Login,
-		Email:      userQuery.Result.Email,
-		Name:       userQuery.Result.Name,
-		IsDisabled: userQuery.Result.IsDisabled,
+		UserId:     usr.ID,
+		Login:      usr.Login,
+		Email:      usr.Email,
+		Name:       usr.Name,
+		IsDisabled: usr.IsDisabled,
 		AuthModule: authInfoQuery.Result.AuthModule,
 		AuthId:     authInfoQuery.Result.AuthId,
 	}
@@ -234,12 +234,13 @@ func (s *AuthInfoStore) GetUserById(ctx context.Context, id int64) (*user.User,
 }
 
 func (s *AuthInfoStore) GetUserByLogin(ctx context.Context, login string) (*user.User, error) {
-	query := models.GetUserByLoginQuery{LoginOrEmail: login}
-	if err := s.sqlStore.GetUserByLogin(ctx, &query); err != nil {
+	query := user.GetUserByLoginQuery{LoginOrEmail: login}
+	usr, err := s.userService.GetByLogin(ctx, &query)
+	if err != nil {
 		return nil, err
 	}
 
-	return query.Result, nil
+	return usr, nil
 }
 
 func (s *AuthInfoStore) GetUserByEmail(ctx context.Context, email string) (*user.User, error) {

pkg/services/sqlstore/mockstore/mockstore.go

@@ -137,11 +137,6 @@ func (m *SQLStoreMock) CreateUser(ctx context.Context, cmd user.CreateUserComman
 	return nil, m.ExpectedError
 }
 
-func (m *SQLStoreMock) GetUserByLogin(ctx context.Context, query *models.GetUserByLoginQuery) error {
-	query.Result = m.ExpectedUser
-	return m.ExpectedError
-}
-
 func (m *SQLStoreMock) GetUserByEmail(ctx context.Context, query *models.GetUserByEmailQuery) error {
 	return m.ExpectedError
 }

pkg/services/sqlstore/store.go

@@ -31,7 +31,6 @@ type Store interface {
 	GetUserLoginAttemptCount(ctx context.Context, query *models.GetUserLoginAttemptCountQuery) error
 	DeleteOldLoginAttempts(ctx context.Context, cmd *models.DeleteOldLoginAttemptsCommand) error
 	CreateUser(ctx context.Context, cmd user.CreateUserCommand) (*user.User, error)
-	GetUserByLogin(ctx context.Context, query *models.GetUserByLoginQuery) error
 	GetUserByEmail(ctx context.Context, query *models.GetUserByEmailQuery) error
 	UpdateUser(ctx context.Context, cmd *models.UpdateUserCommand) error
 	ChangeUserPassword(ctx context.Context, cmd *models.ChangeUserPasswordCommand) error

pkg/services/user/model.go

@@ -58,6 +58,10 @@ type CreateUserCommand struct {
 	IsServiceAccount bool
 }
 
+type GetUserByLoginQuery struct {
+	LoginOrEmail string
+}
+
 func (u *User) NameOrFallback() string {
 	if u.Name != "" {
 		return u.Name

pkg/services/user/user.go

@@ -8,4 +8,5 @@ type Service interface {
 	Create(context.Context, *CreateUserCommand) (*User, error)
 	Delete(context.Context, *DeleteUserCommand) error
 	GetByID(context.Context, *GetUserByIDQuery) (*User, error)
+	GetByLogin(context.Context, *GetUserByLoginQuery) (*User, error)
 }

pkg/services/user/userimpl/user.go

@@ -5,11 +5,13 @@ import (
 	"errors"
 	"time"
 
+	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/services/accesscontrol"
 	"github.com/grafana/grafana/pkg/services/dashboards"
 	"github.com/grafana/grafana/pkg/services/org"
 	pref "github.com/grafana/grafana/pkg/services/preference"
 	"github.com/grafana/grafana/pkg/services/quota"
+	"github.com/grafana/grafana/pkg/services/sqlstore"
 	"github.com/grafana/grafana/pkg/services/sqlstore/db"
 	"github.com/grafana/grafana/pkg/services/star"
 	"github.com/grafana/grafana/pkg/services/teamguardian"
@@ -31,6 +33,8 @@ type Service struct {
 	userAuthService    userauth.Service
 	quotaService       quota.Service
 	accessControlStore accesscontrol.AccessControl
+	// TODO remove sqlstore
+	sqlStore *sqlstore.SQLStore
 
 	cfg *setting.Cfg
 }
@@ -46,6 +50,7 @@ func ProvideService(
 	quotaService quota.Service,
 	accessControlStore accesscontrol.AccessControl,
 	cfg *setting.Cfg,
+	ss *sqlstore.SQLStore,
 ) user.Service {
 	return &Service{
 		store: &sqlStore{
@@ -61,6 +66,7 @@ func ProvideService(
 		quotaService:       quotaService,
 		accessControlStore: accessControlStore,
 		cfg:                cfg,
+		sqlStore:           ss,
 	}
 }
 
@@ -241,3 +247,13 @@ func (s *Service) GetByID(ctx context.Context, query *user.GetUserByIDQuery) (*u
 	}
 	return user, nil
 }
+
+//  TODO: remove wrapper around sqlstore
+func (s *Service) GetByLogin(ctx context.Context, query *user.GetUserByLoginQuery) (*user.User, error) {
+	q := models.GetUserByLoginQuery{LoginOrEmail: query.LoginOrEmail}
+	err := s.sqlStore.GetUserByLogin(ctx, &q)
+	if err != nil {
+		return nil, err
+	}
+	return q.Result, nil
+}

pkg/services/user/usertest/fake.go

@@ -26,3 +26,7 @@ func (f *FakeUserService) Delete(ctx context.Context, cmd *user.DeleteUserComman
 func (f *FakeUserService) GetByID(ctx context.Context, query *user.GetUserByIDQuery) (*user.User, error) {
 	return f.ExpectedUser, f.ExpectedError
 }
+
+func (f *FakeUserService) GetByLogin(ctx context.Context, query *user.GetUserByLoginQuery) (*user.User, error) {
+	return f.ExpectedUser, f.ExpectedError
+}