Cloud Migration: Remove ID migration in favor of UID (#86550)

* - Added migration to add a new collumn UID to both migration and migration_run tables.
- Added migration to set UID for records already existent in the database before adding a new column.
- Added UID field to CloudMigration and CloudMigrationRun dtos (model.go)

* Fix db migration

* Updating store and model

* Updating API to use UID

* fix typo

* update openapi specs and generated endpoints

* fix spec

* update openapi specs and generated endpoints

* Fixing db mapping

* Fix frontend

* fix migration

* remove migration uid from run fetch endpoint

* Revert "merge"

This reverts commit d654e4c530, reversing
changes made to 5fe0b483eb.

* manual merge

* rename some funcs for consistency

* make interfaces consistent

* validate uids

* update generated frontend api

* fix enterprise spec

* manually resolve api

* try again

* try yet again

* once more

---------

Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Co-authored-by: Michael Mandrus <michael.mandrus@grafana.com>
Co-authored-by: joshhunt <josh@trtr.co>

pkg/services/cloudmigration/api/api.go

@@ -1,9 +1,7 @@
 package api
 
 import (
-	"fmt"
 	"net/http"
-	"strconv"
 
 	"github.com/grafana/grafana/pkg/api/response"
 	"github.com/grafana/grafana/pkg/api/routing"
@@ -12,6 +10,7 @@ import (
 	"github.com/grafana/grafana/pkg/middleware"
 	"github.com/grafana/grafana/pkg/services/cloudmigration"
 	contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
+	"github.com/grafana/grafana/pkg/util"
 	"github.com/grafana/grafana/pkg/web"
 )
 
@@ -37,17 +36,17 @@ func RegisterApi(
 	return api
 }
 
-// RegisterAPIEndpoints Registers Endpoints on Grafana Router
+// registerEndpoints Registers Endpoints on Grafana Router
 func (cma *CloudMigrationAPI) registerEndpoints() {
 	cma.routeRegister.Group("/api/cloudmigration", func(cloudMigrationRoute routing.RouteRegister) {
 		// migration
 		cloudMigrationRoute.Get("/migration", routing.Wrap(cma.GetMigrationList))
 		cloudMigrationRoute.Post("/migration", routing.Wrap(cma.CreateMigration))
-		cloudMigrationRoute.Get("/migration/:id", routing.Wrap(cma.GetMigration))
-		cloudMigrationRoute.Delete("/migration/:id", routing.Wrap(cma.DeleteMigration))
-		cloudMigrationRoute.Post("/migration/:id/run", routing.Wrap(cma.RunMigration))
-		cloudMigrationRoute.Get("/migration/:id/run", routing.Wrap(cma.GetMigrationRunList))
-		cloudMigrationRoute.Get("/migration/:id/run/:runID", routing.Wrap(cma.GetMigrationRun))
+		cloudMigrationRoute.Get("/migration/:uid", routing.Wrap(cma.GetMigration))
+		cloudMigrationRoute.Delete("/migration/:uid", routing.Wrap(cma.DeleteMigration))
+		cloudMigrationRoute.Post("/migration/:uid/run", routing.Wrap(cma.RunMigration))
+		cloudMigrationRoute.Get("/migration/:uid/run", routing.Wrap(cma.GetMigrationRunList))
+		cloudMigrationRoute.Get("/migration/run/:runUID", routing.Wrap(cma.GetMigrationRun))
 		cloudMigrationRoute.Post("/token", routing.Wrap(cma.CreateToken))
 	}, middleware.ReqOrgAdmin)
 }
@@ -97,7 +96,7 @@ func (cma *CloudMigrationAPI) GetMigrationList(c *contextmodel.ReqContext) respo
 	return response.JSON(http.StatusOK, cloudMigrations)
 }
 
-// swagger:route GET /cloudmigration/migration/{id} migrations getCloudMigration
+// swagger:route GET /cloudmigration/migration/{uid} migrations getCloudMigration
 //
 // Get a cloud migration.
 //
@@ -112,11 +111,12 @@ func (cma *CloudMigrationAPI) GetMigration(c *contextmodel.ReqContext) response.
 	ctx, span := cma.tracer.Start(c.Req.Context(), "MigrationAPI.GetMigration")
 	defer span.End()
 
-	id, err := strconv.ParseInt(web.Params(c.Req)[":id"], 10, 64)
-	if err != nil {
-		return response.Error(http.StatusBadRequest, "id is invalid", err)
+	uid := web.Params(c.Req)[":uid"]
+	if err := util.ValidateUID(uid); err != nil {
+		return response.Error(http.StatusBadRequest, "invalid migration uid", err)
 	}
-	cloudMigration, err := cma.cloudMigrationService.GetMigration(ctx, id)
+
+	cloudMigration, err := cma.cloudMigrationService.GetMigration(ctx, uid)
 	if err != nil {
 		return response.Error(http.StatusNotFound, "migration not found", err)
 	}
@@ -125,10 +125,10 @@ func (cma *CloudMigrationAPI) GetMigration(c *contextmodel.ReqContext) response.
 
 // swagger:parameters getCloudMigration
 type GetCloudMigrationRequest struct {
-	// ID of an migration
+	// UID of a migration
 	//
 	// in: path
-	ID int64 `json:"id"`
+	UID string `json:"uid"`
 }
 
 // swagger:route POST /cloudmigration/migration migrations createMigration
@@ -155,7 +155,7 @@ func (cma *CloudMigrationAPI) CreateMigration(c *contextmodel.ReqContext) respon
 	return response.JSON(http.StatusOK, cloudMigration)
 }
 
-// swagger:route POST /cloudmigration/migration/{id}/run migrations runCloudMigration
+// swagger:route POST /cloudmigration/migration/{uid}/run migrations runCloudMigration
 //
 // Trigger the run of a migration to the Grafana Cloud.
 //
@@ -170,13 +170,12 @@ func (cma *CloudMigrationAPI) RunMigration(c *contextmodel.ReqContext) response.
 	ctx, span := cma.tracer.Start(c.Req.Context(), "MigrationAPI.RunMigration")
 	defer span.End()
 
-	stringID := web.Params(c.Req)[":id"]
-	id, err := strconv.ParseInt(stringID, 10, 64)
-	if err != nil {
-		return response.Error(http.StatusBadRequest, "id is invalid", err)
+	uid := web.Params(c.Req)[":uid"]
+	if err := util.ValidateUID(uid); err != nil {
+		return response.Error(http.StatusBadRequest, "invalid migration uid", err)
 	}
 
-	result, err := cma.cloudMigrationService.RunMigration(ctx, id)
+	result, err := cma.cloudMigrationService.RunMigration(ctx, uid)
 	if err != nil {
 		return response.Error(http.StatusInternalServerError, "migration run error", err)
 	}
@@ -186,13 +185,13 @@ func (cma *CloudMigrationAPI) RunMigration(c *contextmodel.ReqContext) response.
 
 // swagger:parameters runCloudMigration
 type RunCloudMigrationRequest struct {
-	// ID of an migration
+	// UID of a migration
 	//
 	// in: path
-	ID int64 `json:"id"`
+	UID string `json:"uid"`
 }
 
-// swagger:route GET /cloudmigration/migration/{id}/run/{runID} migrations getCloudMigrationRun
+// swagger:route GET /cloudmigration/migration/run/{runUID} migrations getCloudMigrationRun
 //
 // Get the result of a single migration run.
 //
@@ -205,7 +204,12 @@ func (cma *CloudMigrationAPI) GetMigrationRun(c *contextmodel.ReqContext) respon
 	ctx, span := cma.tracer.Start(c.Req.Context(), "MigrationAPI.GetMigrationRun")
 	defer span.End()
 
-	migrationStatus, err := cma.cloudMigrationService.GetMigrationStatus(ctx, web.Params(c.Req)[":id"], web.Params(c.Req)[":runID"])
+	runUid := web.Params(c.Req)[":runUID"]
+	if err := util.ValidateUID(runUid); err != nil {
+		return response.Error(http.StatusBadRequest, "invalid runUID", err)
+	}
+
+	migrationStatus, err := cma.cloudMigrationService.GetMigrationStatus(ctx, runUid)
 	if err != nil {
 		return response.Error(http.StatusInternalServerError, "migration status error", err)
 	}
@@ -221,18 +225,13 @@ func (cma *CloudMigrationAPI) GetMigrationRun(c *contextmodel.ReqContext) respon
 
 // swagger:parameters getCloudMigrationRun
 type GetMigrationRunParams struct {
-	// ID of an migration
+	// RunUID of a migration run
 	//
 	// in: path
-	ID int64 `json:"id"`
-
-	// Run ID of a migration run
-	//
-	// in: path
-	RunID int64 `json:"runID"`
+	RunUID string `json:"runUID"`
 }
 
-// swagger:route GET /cloudmigration/migration/{id}/run migrations getCloudMigrationRunList
+// swagger:route GET /cloudmigration/migration/{uid}/run migrations getCloudMigrationRunList
 //
 // Get a list of migration runs for a migration.
 //
@@ -245,7 +244,12 @@ func (cma *CloudMigrationAPI) GetMigrationRunList(c *contextmodel.ReqContext) re
 	ctx, span := cma.tracer.Start(c.Req.Context(), "MigrationAPI.GetMigrationRunList")
 	defer span.End()
 
-	runList, err := cma.cloudMigrationService.GetMigrationRunList(ctx, web.Params(c.Req)[":id"])
+	uid := web.Params(c.Req)[":uid"]
+	if err := util.ValidateUID(uid); err != nil {
+		return response.Error(http.StatusBadRequest, "invalid migration uid", err)
+	}
+
+	runList, err := cma.cloudMigrationService.GetMigrationRunList(ctx, uid)
 	if err != nil {
 		return response.Error(http.StatusInternalServerError, "list migration status error", err)
 	}
@@ -255,13 +259,13 @@ func (cma *CloudMigrationAPI) GetMigrationRunList(c *contextmodel.ReqContext) re
 
 // swagger:parameters getCloudMigrationRunList
 type GetCloudMigrationRunList struct {
-	// ID of an migration
+	// UID of a migration
 	//
 	// in: path
-	ID int64 `json:"id"`
+	UID string `json:"uid"`
 }
 
-// swagger:route DELETE /cloudmigration/migration/{id} migrations deleteCloudMigration
+// swagger:route DELETE /cloudmigration/migration/{uid} migrations deleteCloudMigration
 //
 // Delete a migration.
 //
@@ -274,15 +278,12 @@ func (cma *CloudMigrationAPI) DeleteMigration(c *contextmodel.ReqContext) respon
 	ctx, span := cma.tracer.Start(c.Req.Context(), "MigrationAPI.DeleteMigration")
 	defer span.End()
 
-	idStr := web.Params(c.Req)[":id"]
-	if idStr == "" {
-		return response.Error(http.StatusBadRequest, "missing migration id", fmt.Errorf("missing migration id"))
+	uid := web.Params(c.Req)[":uid"]
+	if err := util.ValidateUID(uid); err != nil {
+		return response.Error(http.StatusBadRequest, "invalid migration uid", err)
 	}
-	id, err := strconv.ParseInt(idStr, 10, 64)
-	if err != nil {
-		return response.Error(http.StatusBadRequest, "migration id should be numeric", fmt.Errorf("migration id should be numeric"))
-	}
-	_, err = cma.cloudMigrationService.DeleteMigration(ctx, id)
+
+	_, err := cma.cloudMigrationService.DeleteMigration(ctx, uid)
 	if err != nil {
 		return response.Error(http.StatusInternalServerError, "migration delete error", err)
 	}
@@ -291,10 +292,10 @@ func (cma *CloudMigrationAPI) DeleteMigration(c *contextmodel.ReqContext) respon
 
 // swagger:parameters deleteCloudMigration
 type DeleteMigrationRequest struct {
-	// ID of an migration
+	// UID of a migration
 	//
 	// in: path
-	ID int64 `json:"id"`
+	UID string `json:"uid"`
 }
 
 // swagger:response cloudMigrationRunResponse

pkg/services/cloudmigration/cloudmigration.go

@@ -9,13 +9,13 @@ type Service interface {
 	ValidateToken(context.Context, CloudMigration) error
 
 	CreateMigration(context.Context, CloudMigrationRequest) (*CloudMigrationResponse, error)
-	GetMigration(context.Context, int64) (*CloudMigration, error)
-	DeleteMigration(context.Context, int64) (*CloudMigration, error)
-	UpdateMigration(context.Context, int64, CloudMigrationRequest) (*CloudMigrationResponse, error)
+	GetMigration(ctx context.Context, uid string) (*CloudMigration, error)
+	DeleteMigration(ctx context.Context, uid string) (*CloudMigration, error)
+	UpdateMigration(ctx context.Context, uid string, request CloudMigrationRequest) (*CloudMigrationResponse, error)
 	GetMigrationList(context.Context) (*CloudMigrationListResponse, error)
 
-	RunMigration(context.Context, int64) (*MigrateDataResponseDTO, error)
-	SaveMigrationRun(context.Context, *CloudMigrationRun) (int64, error)
-	GetMigrationStatus(context.Context, string, string) (*CloudMigrationRun, error)
+	RunMigration(ctx context.Context, uid string) (*MigrateDataResponseDTO, error)
+	CreateMigrationRun(context.Context, CloudMigrationRun) (string, error)
+	GetMigrationStatus(ctx context.Context, runUID string) (*CloudMigrationRun, error)
 	GetMigrationRunList(context.Context, string) (*CloudMigrationRunList, error)
 }

pkg/services/cloudmigration/cloudmigrationimpl/cloudmigration.go

@@ -6,7 +6,6 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
-	"strconv"
 	"time"
 
 	"github.com/grafana/grafana/pkg/api/response"
@@ -238,10 +237,10 @@ func (s *Service) ValidateToken(ctx context.Context, cm cloudmigration.CloudMigr
 	return nil
 }
 
-func (s *Service) GetMigration(ctx context.Context, id int64) (*cloudmigration.CloudMigration, error) {
+func (s *Service) GetMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
 	ctx, span := s.tracer.Start(ctx, "CloudMigrationService.GetMigration")
 	defer span.End()
-	migration, err := s.store.GetMigration(ctx, id)
+	migration, err := s.store.GetMigrationByUID(ctx, uid)
 	if err != nil {
 		return nil, err
 	}
@@ -258,7 +257,7 @@ func (s *Service) GetMigrationList(ctx context.Context) (*cloudmigration.CloudMi
 	migrations := make([]cloudmigration.CloudMigrationResponse, 0)
 	for _, v := range values {
 		migrations = append(migrations, cloudmigration.CloudMigrationResponse{
-			ID:      v.ID,
+			UID:     v.UID,
 			Stack:   v.Stack,
 			Created: v.Created,
 			Updated: v.Updated,
@@ -293,21 +292,21 @@ func (s *Service) CreateMigration(ctx context.Context, cmd cloudmigration.CloudM
 	}
 
 	return &cloudmigration.CloudMigrationResponse{
-		ID:      cm.ID,
+		UID:     cm.UID,
 		Stack:   token.Instance.Slug,
 		Created: cm.Created,
 		Updated: cm.Updated,
 	}, nil
 }
 
-func (s *Service) UpdateMigration(ctx context.Context, id int64, cm cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
+func (s *Service) UpdateMigration(ctx context.Context, uid string, request cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
 	// TODO: Implement method
 	return nil, nil
 }
 
-func (s *Service) RunMigration(ctx context.Context, id int64) (*cloudmigration.MigrateDataResponseDTO, error) {
+func (s *Service) RunMigration(ctx context.Context, uid string) (*cloudmigration.MigrateDataResponseDTO, error) {
 	// Get migration to read the auth token
-	migration, err := s.GetMigration(ctx, id)
+	migration, err := s.GetMigration(ctx, uid)
 	if err != nil {
 		return nil, fmt.Errorf("migration get error: %w", err)
 	}
@@ -334,15 +333,15 @@ func (s *Service) RunMigration(ctx context.Context, id int64) (*cloudmigration.M
 	}
 
 	// save the result of the migration
-	runID, err := s.SaveMigrationRun(ctx, &cloudmigration.CloudMigrationRun{
-		CloudMigrationUID: strconv.Itoa(int(id)),
+	runUID, err := s.CreateMigrationRun(ctx, cloudmigration.CloudMigrationRun{
+		CloudMigrationUID: migration.UID,
 		Result:            respData,
 	})
 	if err != nil {
 		response.Error(http.StatusInternalServerError, "migration run save error", err)
 	}
 
-	resp.RunID = runID
+	resp.RunUID = runUID
 
 	return resp, nil
 }
@@ -470,29 +469,25 @@ func (s *Service) getDashboards(ctx context.Context) ([]dashboards.Dashboard, er
 	return result, nil
 }
 
-func (s *Service) SaveMigrationRun(ctx context.Context, cmr *cloudmigration.CloudMigrationRun) (int64, error) {
-	cmr.Created = time.Now()
-	cmr.Updated = time.Now()
-	cmr.Finished = time.Now()
-	err := s.store.SaveMigrationRun(ctx, cmr)
+func (s *Service) CreateMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationRun) (string, error) {
+	uid, err := s.store.CreateMigrationRun(ctx, cmr)
 	if err != nil {
 		s.log.Error("Failed to save migration run", "err", err)
-		return -1, err
+		return "", err
 	}
-	return cmr.ID, nil
+	return uid, nil
 }
 
-func (s *Service) GetMigrationStatus(ctx context.Context, id string, runID string) (*cloudmigration.CloudMigrationRun, error) {
-	cmr, err := s.store.GetMigrationStatus(ctx, id, runID)
+func (s *Service) GetMigrationStatus(ctx context.Context, runUID string) (*cloudmigration.CloudMigrationRun, error) {
+	cmr, err := s.store.GetMigrationStatus(ctx, runUID)
 	if err != nil {
 		return nil, fmt.Errorf("retrieving migration status from db: %w", err)
 	}
-
 	return cmr, nil
 }
 
-func (s *Service) GetMigrationRunList(ctx context.Context, migrationID string) (*cloudmigration.CloudMigrationRunList, error) {
-	runs, err := s.store.GetMigrationStatusList(ctx, migrationID)
+func (s *Service) GetMigrationRunList(ctx context.Context, migUID string) (*cloudmigration.CloudMigrationRunList, error) {
+	runs, err := s.store.GetMigrationStatusList(ctx, migUID)
 	if err != nil {
 		return nil, fmt.Errorf("retrieving migration statuses from db: %w", err)
 	}
@@ -500,15 +495,15 @@ func (s *Service) GetMigrationRunList(ctx context.Context, migrationID string) (
 	runList := &cloudmigration.CloudMigrationRunList{Runs: []cloudmigration.MigrateDataResponseListDTO{}}
 	for _, s := range runs {
 		runList.Runs = append(runList.Runs, cloudmigration.MigrateDataResponseListDTO{
-			RunID: s.ID,
+			RunUID: s.UID,
 		})
 	}
 
 	return runList, nil
 }
 
-func (s *Service) DeleteMigration(ctx context.Context, id int64) (*cloudmigration.CloudMigration, error) {
-	c, err := s.store.DeleteMigration(ctx, id)
+func (s *Service) DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
+	c, err := s.store.DeleteMigration(ctx, uid)
 	if err != nil {
 		return c, fmt.Errorf("deleting migration from db: %w", err)
 	}

pkg/services/cloudmigration/cloudmigrationimpl/cloudmigration_noop.go

@@ -6,7 +6,7 @@ import (
 	"github.com/grafana/grafana/pkg/services/cloudmigration"
 )
 
-// CloudMigrationsServiceImpl Define the Service Implementation.
+// NoopServiceImpl Define the Service Implementation.
 type NoopServiceImpl struct{}
 
 var _ cloudmigration.Service = (*NoopServiceImpl)(nil)
@@ -22,7 +22,7 @@ func (s *NoopServiceImpl) ValidateToken(ctx context.Context, cm cloudmigration.C
 	return cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) GetMigration(ctx context.Context, id int64) (*cloudmigration.CloudMigration, error) {
+func (s *NoopServiceImpl) GetMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
@@ -34,26 +34,26 @@ func (s *NoopServiceImpl) CreateMigration(ctx context.Context, cm cloudmigration
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) UpdateMigration(ctx context.Context, id int64, cm cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
+func (s *NoopServiceImpl) UpdateMigration(ctx context.Context, uid string, cm cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) GetMigrationStatus(ctx context.Context, id string, runID string) (*cloudmigration.CloudMigrationRun, error) {
+func (s *NoopServiceImpl) GetMigrationStatus(ctx context.Context, runUID string) (*cloudmigration.CloudMigrationRun, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) GetMigrationRunList(ctx context.Context, id string) (*cloudmigration.CloudMigrationRunList, error) {
+func (s *NoopServiceImpl) GetMigrationRunList(ctx context.Context, uid string) (*cloudmigration.CloudMigrationRunList, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) DeleteMigration(ctx context.Context, id int64) (*cloudmigration.CloudMigration, error) {
+func (s *NoopServiceImpl) DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) SaveMigrationRun(ctx context.Context, cmr *cloudmigration.CloudMigrationRun) (int64, error) {
-	return -1, cloudmigration.ErrInternalNotImplementedError
+func (s *NoopServiceImpl) CreateMigrationRun(context.Context, cloudmigration.CloudMigrationRun) (string, error) {
+	return "", cloudmigration.ErrInternalNotImplementedError
 }
 
-func (s *NoopServiceImpl) RunMigration(context.Context, int64) (*cloudmigration.MigrateDataResponseDTO, error) {
+func (s *NoopServiceImpl) RunMigration(context.Context, string) (*cloudmigration.MigrateDataResponseDTO, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }

pkg/services/cloudmigration/cloudmigrationimpl/store.go

@@ -8,11 +8,11 @@ import (
 
 type store interface {
 	CreateMigration(ctx context.Context, token cloudmigration.CloudMigration) (*cloudmigration.CloudMigration, error)
-	GetMigration(context.Context, int64) (*cloudmigration.CloudMigration, error)
+	GetMigrationByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error)
 	GetAllCloudMigrations(ctx context.Context) ([]*cloudmigration.CloudMigration, error)
-	DeleteMigration(ctx context.Context, id int64) (*cloudmigration.CloudMigration, error)
+	DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error)
 
-	SaveMigrationRun(ctx context.Context, cmr *cloudmigration.CloudMigrationRun) error
-	GetMigrationStatus(ctx context.Context, id string, runID string) (*cloudmigration.CloudMigrationRun, error)
-	GetMigrationStatusList(ctx context.Context, migrationID string) ([]*cloudmigration.CloudMigrationRun, error)
+	CreateMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationRun) (string, error)
+	GetMigrationStatus(ctx context.Context, cmrUID string) (*cloudmigration.CloudMigrationRun, error)
+	GetMigrationStatusList(ctx context.Context, migrationUID string) ([]*cloudmigration.CloudMigrationRun, error)
 }

pkg/services/cloudmigration/cloudmigrationimpl/xorm_store.go

@@ -4,25 +4,26 @@ import (
 	"context"
 	"encoding/base64"
 	"fmt"
-	"strconv"
 	"time"
 
-	"github.com/grafana/grafana/pkg/services/secrets"
-	"github.com/grafana/grafana/pkg/services/sqlstore"
-
 	"github.com/grafana/grafana/pkg/infra/db"
 	"github.com/grafana/grafana/pkg/services/cloudmigration"
+	"github.com/grafana/grafana/pkg/services/secrets"
+	"github.com/grafana/grafana/pkg/services/sqlstore"
+	"github.com/grafana/grafana/pkg/util"
 )
 
+var _ store = (*sqlStore)(nil)
+
 type sqlStore struct {
 	db             db.DB
 	secretsService secrets.Service
 }
 
-func (ss *sqlStore) GetMigration(ctx context.Context, id int64) (*cloudmigration.CloudMigration, error) {
+func (ss *sqlStore) GetMigrationByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
 	var cm cloudmigration.CloudMigration
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
-		exist, err := sess.ID(id).Get(&cm)
+		exist, err := sess.Where("uid=?", uid).Get(&cm)
 		if err != nil {
 			return err
 		}
@@ -39,11 +40,20 @@ func (ss *sqlStore) GetMigration(ctx context.Context, id int64) (*cloudmigration
 	return &cm, err
 }
 
-func (ss *sqlStore) SaveMigrationRun(ctx context.Context, cmr *cloudmigration.CloudMigrationRun) error {
-	return ss.db.WithDbSession(ctx, func(sess *db.Session) error {
-		_, err := sess.Insert(cmr)
+func (ss *sqlStore) CreateMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationRun) (string, error) {
+	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
+		cmr.Created = time.Now()
+		cmr.Updated = time.Now()
+		cmr.Finished = time.Now()
+		cmr.UID = util.GenerateShortUID()
+
+		_, err := sess.Insert(&cmr)
 		return err
 	})
+	if err != nil {
+		return "", err
+	}
+	return cmr.UID, nil
 }
 
 func (ss *sqlStore) CreateMigration(ctx context.Context, migration cloudmigration.CloudMigration) (*cloudmigration.CloudMigration, error) {
@@ -54,6 +64,8 @@ func (ss *sqlStore) CreateMigration(ctx context.Context, migration cloudmigratio
 	err := ss.db.WithDbSession(ctx, func(sess *sqlstore.DBSession) error {
 		migration.Created = time.Now()
 		migration.Updated = time.Now()
+		migration.UID = util.GenerateShortUID()
+
 		_, err := sess.Insert(&migration)
 		if err != nil {
 			return err
@@ -83,16 +95,17 @@ func (ss *sqlStore) GetAllCloudMigrations(ctx context.Context) ([]*cloudmigratio
 	return migrations, nil
 }
 
-func (ss *sqlStore) DeleteMigration(ctx context.Context, id int64) (*cloudmigration.CloudMigration, error) {
+func (ss *sqlStore) DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
 	var c cloudmigration.CloudMigration
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
-		exist, err := sess.ID(id).Get(&c)
+		exist, err := sess.Where("uid=?", uid).Get(&c)
 		if err != nil {
 			return err
 		}
 		if !exist {
 			return cloudmigration.ErrMigrationNotFound
 		}
+		id := c.ID
 		affected, err := sess.Delete(&cloudmigration.CloudMigration{
 			ID: id,
 		})
@@ -105,17 +118,10 @@ func (ss *sqlStore) DeleteMigration(ctx context.Context, id int64) (*cloudmigrat
 	return &c, err
 }
 
-func (ss *sqlStore) GetMigrationStatus(ctx context.Context, migrationID string, runID string) (*cloudmigration.CloudMigrationRun, error) {
-	id, err := strconv.ParseInt(runID, 10, 64)
-	if err != nil {
-		return nil, fmt.Errorf("invalid runID: %s", runID)
-	}
-	cm := cloudmigration.CloudMigrationRun{
-		ID:                id,
-		CloudMigrationUID: migrationID,
-	}
-	err = ss.db.WithDbSession(ctx, func(sess *db.Session) error {
-		exist, err := sess.Get(&cm)
+func (ss *sqlStore) GetMigrationStatus(ctx context.Context, cmrUID string) (*cloudmigration.CloudMigrationRun, error) {
+	var c cloudmigration.CloudMigrationRun
+	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
+		exist, err := sess.Where("uid=?", cmrUID).Get(&c)
 		if err != nil {
 			return err
 		}
@@ -124,21 +130,19 @@ func (ss *sqlStore) GetMigrationStatus(ctx context.Context, migrationID string,
 		}
 		return nil
 	})
-
-	return &cm, err
+	return &c, err
 }
 
-func (ss *sqlStore) GetMigrationStatusList(ctx context.Context, migrationID string) ([]*cloudmigration.CloudMigrationRun, error) {
+func (ss *sqlStore) GetMigrationStatusList(ctx context.Context, migrationUID string) ([]*cloudmigration.CloudMigrationRun, error) {
 	var runs = make([]*cloudmigration.CloudMigrationRun, 0)
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
 		return sess.Find(&runs, &cloudmigration.CloudMigrationRun{
-			CloudMigrationUID: migrationID,
+			CloudMigrationUID: migrationUID,
 		})
 	})
 	if err != nil {
 		return nil, err
 	}
-
 	return runs, nil
 }
 

pkg/services/cloudmigration/model.go

@@ -16,9 +16,10 @@ var (
 	ErrMigrationNotDeleted         = errutil.Internal("cloudmigrations.migrationNotDeleted", errutil.WithPublicMessage("Migration not deleted"))
 )
 
-// cloud migration api dtos
+// CloudMigration api dtos
 type CloudMigration struct {
 	ID          int64     `json:"id" xorm:"pk autoincr 'id'"`
+	UID         string    `json:"uid" xorm:"uid"`
 	AuthToken   string    `json:"-"`
 	Stack       string    `json:"stack"`
 	StackID     int       `json:"stackID" xorm:"stack_id"`
@@ -48,7 +49,8 @@ type MigratedResource struct {
 
 type CloudMigrationRun struct {
 	ID                int64     `json:"id" xorm:"pk autoincr 'id'"`
-	CloudMigrationUID string    `json:"uid" xorm:"cloud_migration_uid"`
+	UID               string    `json:"uid" xorm:"uid"`
+	CloudMigrationUID string    `json:"migrationUid" xorm:"cloud_migration_uid"`
 	Result            []byte    `json:"result"` //store raw cms response body
 	Created           time.Time `json:"created"`
 	Updated           time.Time `json:"updated"`
@@ -61,7 +63,7 @@ func (r CloudMigrationRun) ToResponse() (*MigrateDataResponseDTO, error) {
 	if err != nil {
 		return nil, errors.New("could not parse result of run")
 	}
-	result.RunID = r.ID
+	result.RunUID = r.UID
 	return &result, nil
 }
 
@@ -81,7 +83,7 @@ type CloudMigrationRequest struct {
 }
 
 type CloudMigrationResponse struct {
-	ID      int64     `json:"id"`
+	UID     string    `json:"uid"`
 	Stack   string    `json:"stack"`
 	Created time.Time `json:"created"`
 	Updated time.Time `json:"updated"`
@@ -172,12 +174,12 @@ const (
 )
 
 type MigrateDataResponseDTO struct {
-	RunID int64                        `json:"id"`
-	Items []MigrateDataResponseItemDTO `json:"items"`
+	RunUID string                       `json:"uid"`
+	Items  []MigrateDataResponseItemDTO `json:"items"`
 }
 
 type MigrateDataResponseListDTO struct {
-	RunID int64 `json:"id"`
+	RunUID string `json:"uid"`
 }
 
 type MigrateDataResponseItemDTO struct {