IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Chore: Move tempuser model to tempuser package (#61024)

Browse Source 
* Move tempuser model to tempuser package

* Add xorm tags for ID
This commit is contained in:
idafurjes
2023-01-06 09:02:05 +01:00
committed by GitHub
parent 8e8f498674
commit d1c9b308bc
10 changed files with 156 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
pkg/services/temp_user/model.go Normal file
View File

@@ -0,0 +1,99 @@
package tempuser
import (
"errors"
"time"
"github.com/grafana/grafana/pkg/services/org"
)
// Typed errors
var (
ErrTempUserNotFound = errors.New("user not found")
)
type TempUserStatus string
const (
TmpUserSignUpStarted TempUserStatus = "SignUpStarted"
TmpUserInvitePending TempUserStatus = "InvitePending"
TmpUserCompleted TempUserStatus = "Completed"
TmpUserRevoked TempUserStatus = "Revoked"
TmpUserExpired TempUserStatus = "Expired"
)
// TempUser holds data for org invites and unconfirmed sign ups
type TempUser struct {
ID int64 `xorm:"id"`
OrgID int64 `xorm:"org_id"`
Version int
Email string
Name string
Role org.RoleType
InvitedByUserID int64 `xorm:"invited_by_user_id"`
Status TempUserStatus
EmailSent bool
EmailSentOn time.Time
Code string
RemoteAddr string
Created int64
Updated int64
}
// ---------------------
// COMMANDS
type CreateTempUserCommand struct {
Email string
Name string
OrgID int64 `xorm:"org_id"`
InvitedByUserID int64 `xorm:"invited_by_user_id"`
Status TempUserStatus
Code string
Role org.RoleType
RemoteAddr string
}
type UpdateTempUserStatusCommand struct {
Code string
Status TempUserStatus
}
type ExpireTempUsersCommand struct {
OlderThan time.Time
NumExpired int64
}
type UpdateTempUserWithEmailSentCommand struct {
Code string
}
type GetTempUsersQuery struct {
OrgID int64 `xorm:"org_id"`
Email string
Status TempUserStatus
}
type GetTempUserByCodeQuery struct {
Code string
}
type TempUserDTO struct {
ID int64 `json:"id" xorm:"id"`
OrgID int64 `json:"orgId" xorm:"org_id"`
Name string `json:"name"`
Email string `json:"email"`
Role org.RoleType `json:"role"`
InvitedByLogin string `json:"invitedByLogin"`
InvitedByEmail string `json:"invitedByEmail"`
InvitedByName string `json:"invitedByName"`
Code string `json:"code"`
Status TempUserStatus `json:"status"`
URL string `json:"url"`
EmailSent bool `json:"emailSent"`
EmailSentOn time.Time `json:"emailSentOn"`
Created time.Time `json:"createdOn"`
}

14
pkg/services/temp_user/temp_user.go
View File

@@ -2,15 +2,13 @@ package tempuser
import (
"context"
"github.com/grafana/grafana/pkg/models"
)
type Service interface {
UpdateTempUserStatus(ctx context.Context, cmd *models.UpdateTempUserStatusCommand) error
CreateTempUser(ctx context.Context, cmd *models.CreateTempUserCommand) error
UpdateTempUserWithEmailSent(ctx context.Context, cmd *models.UpdateTempUserWithEmailSentCommand) error
GetTempUsersQuery(ctx context.Context, query *models.GetTempUsersQuery) error
GetTempUserByCode(ctx context.Context, query *models.GetTempUserByCodeQuery) error
ExpireOldUserInvites(ctx context.Context, cmd *models.ExpireTempUsersCommand) error
UpdateTempUserStatus(ctx context.Context, cmd *UpdateTempUserStatusCommand) error
CreateTempUser(ctx context.Context, cmd *CreateTempUserCommand) (*TempUser, error)
UpdateTempUserWithEmailSent(ctx context.Context, cmd *UpdateTempUserWithEmailSentCommand) error
GetTempUsersQuery(ctx context.Context, query *GetTempUsersQuery) ([]*TempUserDTO, error)
GetTempUserByCode(ctx context.Context, query *GetTempUserByCodeQuery) (*TempUserDTO, error)
ExpireOldUserInvites(ctx context.Context, cmd *ExpireTempUsersCommand) error
}

72
pkg/services/temp_user/tempuserimpl/store.go
View File

@@ -5,23 +5,23 @@ import (
"time"
"github.com/grafana/grafana/pkg/infra/db"
"github.com/grafana/grafana/pkg/models"
tempuser "github.com/grafana/grafana/pkg/services/temp_user"
)
type store interface {
UpdateTempUserStatus(ctx context.Context, cmd *models.UpdateTempUserStatusCommand) error
CreateTempUser(ctx context.Context, cmd *models.CreateTempUserCommand) error
UpdateTempUserWithEmailSent(ctx context.Context, cmd *models.UpdateTempUserWithEmailSentCommand) error
GetTempUsersQuery(ctx context.Context, query *models.GetTempUsersQuery) error
GetTempUserByCode(ctx context.Context, query *models.GetTempUserByCodeQuery) error
ExpireOldUserInvites(ctx context.Context, cmd *models.ExpireTempUsersCommand) error
UpdateTempUserStatus(ctx context.Context, cmd *tempuser.UpdateTempUserStatusCommand) error
CreateTempUser(ctx context.Context, cmd *tempuser.CreateTempUserCommand) (*tempuser.TempUser, error)
UpdateTempUserWithEmailSent(ctx context.Context, cmd *tempuser.UpdateTempUserWithEmailSentCommand) error
GetTempUsersQuery(ctx context.Context, query *tempuser.GetTempUsersQuery) ([]*tempuser.TempUserDTO, error)
GetTempUserByCode(ctx context.Context, query *tempuser.GetTempUserByCodeQuery) (*tempuser.TempUserDTO, error)
ExpireOldUserInvites(ctx context.Context, cmd *tempuser.ExpireTempUsersCommand) error
}
type xormStore struct {
db db.DB
}
func (ss *xormStore) UpdateTempUserStatus(ctx context.Context, cmd *models.UpdateTempUserStatusCommand) error {
func (ss *xormStore) UpdateTempUserStatus(ctx context.Context, cmd *tempuser.UpdateTempUserStatusCommand) error {
return ss.db.WithTransactionalDbSession(ctx, func(sess *db.Session) error {
var rawSQL = "UPDATE temp_user SET status=? WHERE code=?"
_, err := sess.Exec(rawSQL, string(cmd.Status), cmd.Code)
@@ -29,18 +29,19 @@ func (ss *xormStore) UpdateTempUserStatus(ctx context.Context, cmd *models.Updat
})
}
func (ss *xormStore) CreateTempUser(ctx context.Context, cmd *models.CreateTempUserCommand) error {
return ss.db.WithTransactionalDbSession(ctx, func(sess *db.Session) error {
func (ss *xormStore) CreateTempUser(ctx context.Context, cmd *tempuser.CreateTempUserCommand) (*tempuser.TempUser, error) {
var queryResult *tempuser.TempUser
err := ss.db.WithTransactionalDbSession(ctx, func(sess *db.Session) error {
// create user
user := &models.TempUser{
user := &tempuser.TempUser{
Email: cmd.Email,
Name: cmd.Name,
OrgId: cmd.OrgId,
OrgID: cmd.OrgID,
Code: cmd.Code,
Role: cmd.Role,
Status: cmd.Status,
RemoteAddr: cmd.RemoteAddr,
InvitedByUserId: cmd.InvitedByUserId,
InvitedByUserID: cmd.InvitedByUserID,
EmailSentOn: time.Now(),
Created: time.Now().Unix(),
Updated: time.Now().Unix(),
@@ -50,15 +51,19 @@ func (ss *xormStore) CreateTempUser(ctx context.Context, cmd *models.CreateTempU
return err
}
cmd.Result = user
queryResult = user
return nil
})
if err != nil {
return nil, err
}
return queryResult, nil
}
func (ss *xormStore) UpdateTempUserWithEmailSent(ctx context.Context, cmd *models.UpdateTempUserWithEmailSentCommand) error {
func (ss *xormStore) UpdateTempUserWithEmailSent(ctx context.Context, cmd *tempuser.UpdateTempUserWithEmailSentCommand) error {
return ss.db.WithTransactionalDbSession(ctx, func(sess *db.Session) error {
user := &models.TempUser{
user := &tempuser.TempUser{
EmailSent: true,
EmailSentOn: time.Now(),
}
@@ -69,8 +74,9 @@ func (ss *xormStore) UpdateTempUserWithEmailSent(ctx context.Context, cmd *model
})
}
func (ss *xormStore) GetTempUsersQuery(ctx context.Context, query *models.GetTempUsersQuery) error {
return ss.db.WithDbSession(ctx, func(dbSess *db.Session) error {
func (ss *xormStore) GetTempUsersQuery(ctx context.Context, query *tempuser.GetTempUsersQuery) ([]*tempuser.TempUserDTO, error) {
queryResult := make([]*tempuser.TempUserDTO, 0)
err := ss.db.WithDbSession(ctx, func(dbSess *db.Session) error {
rawSQL := `SELECT
tu.id as id,
tu.org_id as org_id,
@@ -90,9 +96,9 @@ func (ss *xormStore) GetTempUsersQuery(ctx context.Context, query *models.GetTem
WHERE tu.status=?`
params := []interface{}{string(query.Status)}
if query.OrgId > 0 {
if query.OrgID > 0 {
rawSQL += ` AND tu.org_id=?`
params = append(params, query.OrgId)
params = append(params, query.OrgID)
}
if query.Email != "" {
@@ -102,15 +108,19 @@ func (ss *xormStore) GetTempUsersQuery(ctx context.Context, query *models.GetTem
rawSQL += " ORDER BY tu.created desc"
query.Result = make([]*models.TempUserDTO, 0)
sess := dbSess.SQL(rawSQL, params...)
err := sess.Find(&query.Result)
err := sess.Find(&queryResult)
return err
})
if err != nil {
return nil, err
}
return queryResult, nil
}
func (ss *xormStore) GetTempUserByCode(ctx context.Context, query *models.GetTempUserByCodeQuery) error {
return ss.db.WithDbSession(ctx, func(dbSess *db.Session) error {
func (ss *xormStore) GetTempUserByCode(ctx context.Context, query *tempuser.GetTempUserByCodeQuery) (*tempuser.TempUserDTO, error) {
var queryResult *tempuser.TempUserDTO
err := ss.db.WithDbSession(ctx, func(dbSess *db.Session) error {
var rawSQL = `SELECT
tu.id as id,
tu.org_id as org_id,
@@ -129,25 +139,29 @@ func (ss *xormStore) GetTempUserByCode(ctx context.Context, query *models.GetTem
LEFT OUTER JOIN ` + ss.db.GetDialect().Quote("user") + ` as u on u.id = tu.invited_by_user_id
WHERE tu.code=?`
var tempUser models.TempUserDTO
var tempUser tempuser.TempUserDTO
sess := dbSess.SQL(rawSQL, query.Code)
has, err := sess.Get(&tempUser)
if err != nil {
return err
} else if !has {
return models.ErrTempUserNotFound
return tempuser.ErrTempUserNotFound
}
query.Result = &tempUser
queryResult = &tempUser
return err
})
if err != nil {
return nil, err
}
return queryResult, nil
}
func (ss *xormStore) ExpireOldUserInvites(ctx context.Context, cmd *models.ExpireTempUsersCommand) error {
func (ss *xormStore) ExpireOldUserInvites(ctx context.Context, cmd *tempuser.ExpireTempUsersCommand) error {
return ss.db.WithTransactionalDbSession(ctx, func(sess *db.Session) error {
var rawSQL = "UPDATE temp_user SET status = ?, updated = ? WHERE created <= ? AND status in (?, ?)"
if result, err := sess.Exec(rawSQL, string(models.TmpUserExpired), time.Now().Unix(), cmd.OlderThan.Unix(), string(models.TmpUserSignUpStarted), string(models.TmpUserInvitePending)); err != nil {
if result, err := sess.Exec(rawSQL, string(tempuser.TmpUserExpired), time.Now().Unix(), cmd.OlderThan.Unix(), string(tempuser.TmpUserSignUpStarted), string(tempuser.TmpUserInvitePending)); err != nil {
return err
} else if cmd.NumExpired, err = result.RowsAffected(); err != nil {
return err

50
pkg/services/temp_user/tempuserimpl/store_test.go
View File

@@ -8,7 +8,7 @@ import (
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/infra/db"
"github.com/grafana/grafana/pkg/models"
tempuser "github.com/grafana/grafana/pkg/services/temp_user"
)
func TestIntegrationTempUserCommandsAndQueries(t *testing.T) {
@@ -16,79 +16,81 @@ func TestIntegrationTempUserCommandsAndQueries(t *testing.T) {
t.Skip("skipping integration test")
}
var store store
cmd := models.CreateTempUserCommand{
OrgId: 2256,
var tempUser *tempuser.TempUser
var err error
cmd := tempuser.CreateTempUserCommand{
OrgID: 2256,
Name: "hello",
Code: "asd",
Email: "e@as.co",
Status: models.TmpUserInvitePending,
Status: tempuser.TmpUserInvitePending,
}
setup := func(t *testing.T) {
db := db.InitTestDB(t)
store = &xormStore{db: db}
err := store.CreateTempUser(context.Background(), &cmd)
tempUser, err = store.CreateTempUser(context.Background(), &cmd)
require.Nil(t, err)
}
t.Run("Should be able to get temp users by org id", func(t *testing.T) {
setup(t)
query := models.GetTempUsersQuery{OrgId: 2256, Status: models.TmpUserInvitePending}
err := store.GetTempUsersQuery(context.Background(), &query)
query := tempuser.GetTempUsersQuery{OrgID: 2256, Status: tempuser.TmpUserInvitePending}
queryResult, err := store.GetTempUsersQuery(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 1, len(query.Result))
require.Equal(t, 1, len(queryResult))
})
t.Run("Should be able to get temp users by email", func(t *testing.T) {
setup(t)
query := models.GetTempUsersQuery{Email: "e@as.co", Status: models.TmpUserInvitePending}
err := store.GetTempUsersQuery(context.Background(), &query)
query := tempuser.GetTempUsersQuery{Email: "e@as.co", Status: tempuser.TmpUserInvitePending}
queryResult, err := store.GetTempUsersQuery(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, 1, len(query.Result))
require.Equal(t, 1, len(queryResult))
})
t.Run("Should be able to get temp users by code", func(t *testing.T) {
setup(t)
query := models.GetTempUserByCodeQuery{Code: "asd"}
err := store.GetTempUserByCode(context.Background(), &query)
query := tempuser.GetTempUserByCodeQuery{Code: "asd"}
queryResult, err := store.GetTempUserByCode(context.Background(), &query)
require.Nil(t, err)
require.Equal(t, "hello", query.Result.Name)
require.Equal(t, "hello", queryResult.Name)
})
t.Run("Should be able update status", func(t *testing.T) {
setup(t)
cmd2 := models.UpdateTempUserStatusCommand{Code: "asd", Status: models.TmpUserRevoked}
cmd2 := tempuser.UpdateTempUserStatusCommand{Code: "asd", Status: tempuser.TmpUserRevoked}
err := store.UpdateTempUserStatus(context.Background(), &cmd2)
require.Nil(t, err)
})
t.Run("Should be able update email sent and email sent on", func(t *testing.T) {
setup(t)
cmd2 := models.UpdateTempUserWithEmailSentCommand{Code: cmd.Result.Code}
cmd2 := tempuser.UpdateTempUserWithEmailSentCommand{Code: tempUser.Code}
err := store.UpdateTempUserWithEmailSent(context.Background(), &cmd2)
require.Nil(t, err)
query := models.GetTempUsersQuery{OrgId: 2256, Status: models.TmpUserInvitePending}
err = store.GetTempUsersQuery(context.Background(), &query)
query := tempuser.GetTempUsersQuery{OrgID: 2256, Status: tempuser.TmpUserInvitePending}
queryResult, err := store.GetTempUsersQuery(context.Background(), &query)
require.Nil(t, err)
require.True(t, query.Result[0].EmailSent)
require.False(t, query.Result[0].EmailSentOn.UTC().Before(query.Result[0].Created.UTC()))
require.True(t, queryResult[0].EmailSent)
require.False(t, queryResult[0].EmailSentOn.UTC().Before(queryResult[0].Created.UTC()))
})
t.Run("Should be able expire temp user", func(t *testing.T) {
setup(t)
createdAt := time.Unix(cmd.Result.Created, 0)
cmd2 := models.ExpireTempUsersCommand{OlderThan: createdAt.Add(1 * time.Second)}
createdAt := time.Unix(tempUser.Created, 0)
cmd2 := tempuser.ExpireTempUsersCommand{OlderThan: createdAt.Add(1 * time.Second)}
err := store.ExpireOldUserInvites(context.Background(), &cmd2)
require.Nil(t, err)
require.Equal(t, int64(1), cmd2.NumExpired)
t.Run("Should do nothing when no temp users to expire", func(t *testing.T) {
createdAt := time.Unix(cmd.Result.Created, 0)
cmd2 := models.ExpireTempUsersCommand{OlderThan: createdAt.Add(1 * time.Second)}
createdAt := time.Unix(tempUser.Created, 0)
cmd2 := tempuser.ExpireTempUsersCommand{OlderThan: createdAt.Add(1 * time.Second)}
err := store.ExpireOldUserInvites(context.Background(), &cmd2)
require.Nil(t, err)
require.Equal(t, int64(0), cmd2.NumExpired)

31
pkg/services/temp_user/tempuserimpl/temp_user.go
View File

@@ -4,7 +4,6 @@ import (
"context"
"github.com/grafana/grafana/pkg/infra/db"
"github.com/grafana/grafana/pkg/models"
tempuser "github.com/grafana/grafana/pkg/services/temp_user"
)
@@ -20,7 +19,7 @@ func ProvideService(
}
}
func (s *Service) UpdateTempUserStatus(ctx context.Context, cmd *models.UpdateTempUserStatusCommand) error {
func (s *Service) UpdateTempUserStatus(ctx context.Context, cmd *tempuser.UpdateTempUserStatusCommand) error {
err := s.store.UpdateTempUserStatus(ctx, cmd)
if err != nil {
return err
@@ -28,15 +27,15 @@ func (s *Service) UpdateTempUserStatus(ctx context.Context, cmd *models.UpdateTe
return nil
}
func (s *Service) CreateTempUser(ctx context.Context, cmd *models.CreateTempUserCommand) error {
err := s.store.CreateTempUser(ctx, cmd)
func (s *Service) CreateTempUser(ctx context.Context, cmd *tempuser.CreateTempUserCommand) (*tempuser.TempUser, error) {
res, err := s.store.CreateTempUser(ctx, cmd)
if err != nil {
return err
return nil, err
}
return nil
return res, nil
}
func (s *Service) UpdateTempUserWithEmailSent(ctx context.Context, cmd *models.UpdateTempUserWithEmailSentCommand) error {
func (s *Service) UpdateTempUserWithEmailSent(ctx context.Context, cmd *tempuser.UpdateTempUserWithEmailSentCommand) error {
err := s.store.UpdateTempUserWithEmailSent(ctx, cmd)
if err != nil {
return err
@@ -44,23 +43,23 @@ func (s *Service) UpdateTempUserWithEmailSent(ctx context.Context, cmd *models.U
return nil
}
func (s *Service) GetTempUsersQuery(ctx context.Context, cmd *models.GetTempUsersQuery) error {
err := s.store.GetTempUsersQuery(ctx, cmd)
func (s *Service) GetTempUsersQuery(ctx context.Context, cmd *tempuser.GetTempUsersQuery) ([]*tempuser.TempUserDTO, error) {
res, err := s.store.GetTempUsersQuery(ctx, cmd)
if err != nil {
return err
return nil, err
}
return nil
return res, nil
}
func (s *Service) GetTempUserByCode(ctx context.Context, cmd *models.GetTempUserByCodeQuery) error {
err := s.store.GetTempUserByCode(ctx, cmd)
func (s *Service) GetTempUserByCode(ctx context.Context, cmd *tempuser.GetTempUserByCodeQuery) (*tempuser.TempUserDTO, error) {
res, err := s.store.GetTempUserByCode(ctx, cmd)
if err != nil {
return err
return nil, err
}
return nil
return res, nil
}
func (s *Service) ExpireOldUserInvites(ctx context.Context, cmd *models.ExpireTempUsersCommand) error {
func (s *Service) ExpireOldUserInvites(ctx context.Context, cmd *tempuser.ExpireTempUsersCommand) error {
err := s.store.ExpireOldUserInvites(ctx, cmd)
if err != nil {
return err