Dashboards: Refactor service to make it injectable by wire (#44588)

* Add providers to folder and dashboard services * Refactor folder and dashboard services * Move store implementation to its own file due wire cannot allow us to cast to SQLStore * Add store in some places and more missing dependencies * Bad merge fix * Remove old functions from tests and few fixes * Fix provisioning * Remove store from http server and some test fixes * Test fixes * Fix dashboard and folder tests * Fix library tests * Fix provisioning tests * Fix plugins manager tests * Fix alert and org users tests * Refactor service package and more test fixes * Fix dashboard_test tets * Fix api tests * Some lint fixes * Fix lint * More lint :/ * Move dashboard integration tests to dashboards service and fix dependencies * Lint + tests * More integration tests fixes * Lint * Lint again * Fix tests again and again anda again * Update searchstore_test * Fix goimports * More go imports * More imports fixes * Fix lint * Move UnprovisionDashboard function into dashboard service and remove bus * Use search service instead of bus * Fix test * Fix go imports * Use nil in tests
2022-02-16 14:15:44 +01:00
parent 4393992775
commit d5b98772ed
66 changed files with 2377 additions and 1844 deletions
@@ -4,18 +4,14 @@ import (
 	"context"
 	"fmt"
 	"strings"
-	"time"
-
-	"github.com/prometheus/client_golang/prometheus"
-
-	"github.com/grafana/grafana/pkg/services/sqlstore/permissions"
-	"github.com/grafana/grafana/pkg/services/sqlstore/searchstore"

 	"github.com/grafana/grafana/pkg/bus"
-	"github.com/grafana/grafana/pkg/infra/metrics"
 	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/services/search"
+	"github.com/grafana/grafana/pkg/services/sqlstore/permissions"
+	"github.com/grafana/grafana/pkg/services/sqlstore/searchstore"
 	"github.com/grafana/grafana/pkg/util"
+	"github.com/prometheus/client_golang/prometheus"
 )

 var shadowSearchCounter = prometheus.NewCounterVec(
@@ -47,166 +43,6 @@ func (ss *SQLStore) addDashboardQueryAndCommandHandlers() {

 var generateNewUid func() string = util.GenerateShortUID

-func (ss *SQLStore) SaveDashboard(cmd models.SaveDashboardCommand) (*models.Dashboard, error) {
-	err := ss.WithTransactionalDbSession(context.Background(), func(sess *DBSession) error {
-		return saveDashboard(sess, &cmd)
-	})
-	return cmd.Result, err
-}
-
-func saveDashboard(sess *DBSession, cmd *models.SaveDashboardCommand) error {
-	dash := cmd.GetDashboardModel()
-
-	userId := cmd.UserId
-
-	if userId == 0 {
-		userId = -1
-	}
-
-	if dash.Id > 0 {
-		var existing models.Dashboard
-		dashWithIdExists, err := sess.Where("id=? AND org_id=?", dash.Id, dash.OrgId).Get(&existing)
-		if err != nil {
-			return err
-		}
-		if !dashWithIdExists {
-			return models.ErrDashboardNotFound
-		}
-
-		// check for is someone else has written in between
-		if dash.Version != existing.Version {
-			if cmd.Overwrite {
-				dash.SetVersion(existing.Version)
-			} else {
-				return models.ErrDashboardVersionMismatch
-			}
-		}
-
-		// do not allow plugin dashboard updates without overwrite flag
-		if existing.PluginId != "" && !cmd.Overwrite {
-			return models.UpdatePluginDashboardError{PluginId: existing.PluginId}
-		}
-	}
-
-	if dash.Uid == "" {
-		uid, err := generateNewDashboardUid(sess, dash.OrgId)
-		if err != nil {
-			return err
-		}
-		dash.SetUid(uid)
-	}
-
-	parentVersion := dash.Version
-	var affectedRows int64
-	var err error
-
-	if dash.Id == 0 {
-		dash.SetVersion(1)
-		dash.Created = time.Now()
-		dash.CreatedBy = userId
-		dash.Updated = time.Now()
-		dash.UpdatedBy = userId
-		metrics.MApiDashboardInsert.Inc()
-		affectedRows, err = sess.Insert(dash)
-	} else {
-		dash.SetVersion(dash.Version + 1)
-
-		if !cmd.UpdatedAt.IsZero() {
-			dash.Updated = cmd.UpdatedAt
-		} else {
-			dash.Updated = time.Now()
-		}
-
-		dash.UpdatedBy = userId
-
-		affectedRows, err = sess.MustCols("folder_id").ID(dash.Id).Update(dash)
-	}
-
-	if err != nil {
-		return err
-	}
-
-	if affectedRows == 0 {
-		return models.ErrDashboardNotFound
-	}
-
-	dashVersion := &models.DashboardVersion{
-		DashboardId:   dash.Id,
-		ParentVersion: parentVersion,
-		RestoredFrom:  cmd.RestoredFrom,
-		Version:       dash.Version,
-		Created:       time.Now(),
-		CreatedBy:     dash.UpdatedBy,
-		Message:       cmd.Message,
-		Data:          dash.Data,
-	}
-
-	// insert version entry
-	if affectedRows, err = sess.Insert(dashVersion); err != nil {
-		return err
-	} else if affectedRows == 0 {
-		return models.ErrDashboardNotFound
-	}
-
-	// delete existing tags
-	_, err = sess.Exec("DELETE FROM dashboard_tag WHERE dashboard_id=?", dash.Id)
-	if err != nil {
-		return err
-	}
-
-	// insert new tags
-	tags := dash.GetTags()
-	if len(tags) > 0 {
-		for _, tag := range tags {
-			if _, err := sess.Insert(&DashboardTag{DashboardId: dash.Id, Term: tag}); err != nil {
-				return err
-			}
-		}
-	}
-
-	cmd.Result = dash
-
-	return nil
-}
-
-func generateNewDashboardUid(sess *DBSession, orgId int64) (string, error) {
-	for i := 0; i < 3; i++ {
-		uid := generateNewUid()
-
-		exists, err := sess.Where("org_id=? AND uid=?", orgId, uid).Get(&models.Dashboard{})
-		if err != nil {
-			return "", err
-		}
-
-		if !exists {
-			return uid, nil
-		}
-	}
-
-	return "", models.ErrDashboardFailedGenerateUniqueUid
-}
-
-// GetDashboardByTitle gets a dashboard by its title.
-func (ss *SQLStore) GetFolderByTitle(orgID int64, title string) (*models.Dashboard, error) {
-	if title == "" {
-		return nil, models.ErrDashboardIdentifierNotSet
-	}
-
-	// there is a unique constraint on org_id, folder_id, title
-	// there are no nested folders so the parent folder id is always 0
-	dashboard := models.Dashboard{OrgId: orgID, FolderId: 0, Title: title}
-	has, err := ss.engine.Table(&models.Dashboard{}).Where("is_folder = " + dialect.BooleanStr(true)).Where("folder_id=0").Get(&dashboard)
-	if err != nil {
-		return nil, err
-	}
-	if !has {
-		return nil, models.ErrDashboardNotFound
-	}
-	dashboard.SetId(dashboard.Id)
-	dashboard.SetUid(dashboard.Uid)
-	return &dashboard, nil
-}
-
 func (ss *SQLStore) GetDashboard(ctx context.Context, query *models.GetDashboardQuery) error {
 	return withDbSession(ctx, x, func(dbSession *DBSession) error {
 		if query.Id == 0 && len(query.Slug) == 0 && len(query.Uid) == 0 {
@@ -243,7 +79,7 @@ type DashboardSearchProjection struct {
 	SortMeta    int64
 }

-func (ss *SQLStore) findDashboards(ctx context.Context, query *search.FindPersistedDashboardsQuery) ([]DashboardSearchProjection, error) {
+func (ss *SQLStore) FindDashboards(ctx context.Context, query *search.FindPersistedDashboardsQuery) ([]DashboardSearchProjection, error) {
 	filters := []interface{}{
 		permissions.DashboardPermissionFilter{
 			OrgRole:         query.SignedInUser.OrgRole,
@@ -315,7 +151,7 @@ func (ss *SQLStore) findDashboards(ctx context.Context, query *search.FindPersis
 }

 func (ss *SQLStore) SearchDashboards(ctx context.Context, query *search.FindPersistedDashboardsQuery) error {
-	res, err := ss.findDashboards(ctx, query)
+	res, err := ss.FindDashboards(ctx, query)
 	if err != nil {
 		return err
 	}
@@ -619,155 +455,6 @@ func (ss *SQLStore) GetDashboardUIDById(ctx context.Context, query *models.GetDa
 	})
 }

-func getExistingDashboardByIdOrUidForUpdate(sess *DBSession, dash *models.Dashboard, overwrite bool) (bool, error) {
-	dashWithIdExists := false
-	isParentFolderChanged := false
-	var existingById models.Dashboard
-
-	if dash.Id > 0 {
-		var err error
-		dashWithIdExists, err = sess.Where("id=? AND org_id=?", dash.Id, dash.OrgId).Get(&existingById)
-		if err != nil {
-			return isParentFolderChanged, fmt.Errorf("SQL query for existing dashboard by ID failed: %w", err)
-		}
-
-		if !dashWithIdExists {
-			return isParentFolderChanged, models.ErrDashboardNotFound
-		}
-
-		if dash.Uid == "" {
-			dash.SetUid(existingById.Uid)
-		}
-	}
-
-	dashWithUidExists := false
-	var existingByUid models.Dashboard
-
-	if dash.Uid != "" {
-		var err error
-		dashWithUidExists, err = sess.Where("org_id=? AND uid=?", dash.OrgId, dash.Uid).Get(&existingByUid)
-		if err != nil {
-			return isParentFolderChanged, fmt.Errorf("SQL query for existing dashboard by UID failed: %w", err)
-		}
-	}
-
-	if dash.FolderId > 0 {
-		var existingFolder models.Dashboard
-		folderExists, err := sess.Where("org_id=? AND id=? AND is_folder=?", dash.OrgId, dash.FolderId,
-			dialect.BooleanStr(true)).Get(&existingFolder)
-		if err != nil {
-			return isParentFolderChanged, fmt.Errorf("SQL query for folder failed: %w", err)
-		}
-
-		if !folderExists {
-			return isParentFolderChanged, models.ErrDashboardFolderNotFound
-		}
-	}
-
-	if !dashWithIdExists && !dashWithUidExists {
-		return isParentFolderChanged, nil
-	}
-
-	if dashWithIdExists && dashWithUidExists && existingById.Id != existingByUid.Id {
-		return isParentFolderChanged, models.ErrDashboardWithSameUIDExists
-	}
-
-	existing := existingById
-
-	if !dashWithIdExists && dashWithUidExists {
-		dash.SetId(existingByUid.Id)
-		dash.SetUid(existingByUid.Uid)
-		existing = existingByUid
-
-		if !dash.IsFolder {
-			isParentFolderChanged = true
-		}
-	}
-
-	if (existing.IsFolder && !dash.IsFolder) ||
-		(!existing.IsFolder && dash.IsFolder) {
-		return isParentFolderChanged, models.ErrDashboardTypeMismatch
-	}
-
-	if !dash.IsFolder && dash.FolderId != existing.FolderId {
-		isParentFolderChanged = true
-	}
-
-	// check for is someone else has written in between
-	if dash.Version != existing.Version {
-		if overwrite {
-			dash.SetVersion(existing.Version)
-		} else {
-			return isParentFolderChanged, models.ErrDashboardVersionMismatch
-		}
-	}
-
-	// do not allow plugin dashboard updates without overwrite flag
-	if existing.PluginId != "" && !overwrite {
-		return isParentFolderChanged, models.UpdatePluginDashboardError{PluginId: existing.PluginId}
-	}
-
-	return isParentFolderChanged, nil
-}
-
-func getExistingDashboardByTitleAndFolder(sess *DBSession, dash *models.Dashboard, overwrite,
-	isParentFolderChanged bool) (bool, error) {
-	var existing models.Dashboard
-	exists, err := sess.Where("org_id=? AND slug=? AND (is_folder=? OR folder_id=?)", dash.OrgId, dash.Slug,
-		dialect.BooleanStr(true), dash.FolderId).Get(&existing)
-	if err != nil {
-		return isParentFolderChanged, fmt.Errorf("SQL query for existing dashboard by org ID or folder ID failed: %w", err)
-	}
-
-	if exists && dash.Id != existing.Id {
-		if existing.IsFolder && !dash.IsFolder {
-			return isParentFolderChanged, models.ErrDashboardWithSameNameAsFolder
-		}
-
-		if !existing.IsFolder && dash.IsFolder {
-			return isParentFolderChanged, models.ErrDashboardFolderWithSameNameAsDashboard
-		}
-
-		if !dash.IsFolder && (dash.FolderId != existing.FolderId || dash.Id == 0) {
-			isParentFolderChanged = true
-		}
-
-		if overwrite {
-			dash.SetId(existing.Id)
-			dash.SetUid(existing.Uid)
-			dash.SetVersion(existing.Version)
-		} else {
-			return isParentFolderChanged, models.ErrDashboardWithSameNameInFolderExists
-		}
-	}
-
-	return isParentFolderChanged, nil
-}
-
-func (ss *SQLStore) ValidateDashboardBeforeSave(dashboard *models.Dashboard, overwrite bool) (bool, error) {
-	isParentFolderChanged := false
-	err := ss.WithTransactionalDbSession(context.Background(), func(sess *DBSession) error {
-		var err error
-		isParentFolderChanged, err = getExistingDashboardByIdOrUidForUpdate(sess, dashboard, overwrite)
-		if err != nil {
-			return err
-		}
-
-		isParentFolderChanged, err = getExistingDashboardByTitleAndFolder(sess, dashboard, overwrite,
-			isParentFolderChanged)
-		if err != nil {
-			return err
-		}
-
-		return nil
-	})
-	if err != nil {
-		return false, err
-	}
-
-	return isParentFolderChanged, nil
-}
-
 // HasEditPermissionInFolders validates that an user have access to a certain folder
 func (ss *SQLStore) HasEditPermissionInFolders(ctx context.Context, query *models.HasEditPermissionInFoldersQuery) error {
 	return withDbSession(ctx, x, func(dbSession *DBSession) error {