mirror of https://github.com/grafana/grafana
CloudMigrations: Refactor API for async work (#89084)
* rename some stuff * more renaming * clean up api * rename more functions * rename cms -> gms * update comment * update swagger gen * update endpoints * overzealous * final touches * dont modify existing migrations * break structs into domain and dtos * add some conversion funcs * fix build * update frontend * try to make swagger happypull/89140/head
Michael Mandrus
1 year ago
committed by
GitHub
parent
06c0ce4325
commit
9d3a4e236d
@ -0,0 +1,209 @@ |
||||
package api |
||||
|
||||
import ( |
||||
"time" |
||||
|
||||
"github.com/grafana/grafana/pkg/services/cloudmigration" |
||||
) |
||||
|
||||
// swagger:parameters getCloudMigrationToken
|
||||
type GetCloudMigrationToken struct { |
||||
} |
||||
|
||||
// swagger:response cloudMigrationGetTokenResponse
|
||||
type CloudMigrationGetTokenResponse struct { |
||||
// in: body
|
||||
Body GetAccessTokenResponseDTO |
||||
} |
||||
|
||||
type GetAccessTokenResponseDTO struct { |
||||
ID string `json:"id"` |
||||
DisplayName string `json:"displayName"` |
||||
ExpiresAt string `json:"expiresAt"` |
||||
FirstUsedAt string `json:"firstUsedAt"` |
||||
LastUsedAt string `json:"lastUsedAt"` |
||||
CreatedAt string `json:"createdAt"` |
||||
} |
||||
|
||||
// swagger:response cloudMigrationCreateTokenResponse
|
||||
type CloudMigrationCreateTokenResponse struct { |
||||
// in: body
|
||||
Body CreateAccessTokenResponseDTO |
||||
} |
||||
|
||||
type CreateAccessTokenResponseDTO struct { |
||||
Token string `json:"token"` |
||||
} |
||||
|
||||
// swagger:parameters deleteCloudMigrationToken
|
||||
type DeleteCloudMigrationToken struct { |
||||
// UID of a cloud migration token
|
||||
//
|
||||
// in: path
|
||||
UID string `json:"uid"` |
||||
} |
||||
|
||||
// swagger:response cloudMigrationDeleteTokenResponse
|
||||
type CloudMigrationDeleteTokenResponse struct { |
||||
} |
||||
|
||||
// swagger:response cloudMigrationSessionListResponse
|
||||
type CloudMigrationSessionListResponse struct { |
||||
// in: body
|
||||
Body CloudMigrationSessionListResponseDTO |
||||
} |
||||
|
||||
type CloudMigrationSessionResponseDTO struct { |
||||
UID string `json:"uid"` |
||||
Slug string `json:"slug"` |
||||
Created time.Time `json:"created"` |
||||
Updated time.Time `json:"updated"` |
||||
} |
||||
|
||||
type CloudMigrationSessionListResponseDTO struct { |
||||
Sessions []CloudMigrationSessionResponseDTO `json:"sessions"` |
||||
} |
||||
|
||||
// swagger:parameters getSession
|
||||
type GetCloudMigrationSessionRequest struct { |
||||
// UID of a migration session
|
||||
//
|
||||
// in: path
|
||||
UID string `json:"uid"` |
||||
} |
||||
|
||||
// swagger:response cloudMigrationSessionResponse
|
||||
type CloudMigrationSessionResponse struct { |
||||
// in: body
|
||||
Body CloudMigrationSessionResponseDTO |
||||
} |
||||
|
||||
// swagger:parameters createSession
|
||||
type CreateSession struct { |
||||
// in:body
|
||||
// required:true
|
||||
Body CloudMigrationSessionRequestDTO |
||||
} |
||||
|
||||
type CloudMigrationSessionRequestDTO struct { |
||||
AuthToken string `json:"authToken"` |
||||
} |
||||
|
||||
// swagger:parameters runCloudMigration
|
||||
type RunCloudMigrationRequest struct { |
||||
// UID of a migration
|
||||
//
|
||||
// in: path
|
||||
UID string `json:"uid"` |
||||
} |
||||
|
||||
// swagger:response cloudMigrationRunResponse
|
||||
type CloudMigrationRunResponse struct { |
||||
// in: body
|
||||
Body MigrateDataResponseDTO |
||||
} |
||||
|
||||
type MigrateDataResponseDTO struct { |
||||
RunUID string `json:"uid"` |
||||
Items []MigrateDataResponseItemDTO `json:"items"` |
||||
} |
||||
|
||||
type MigrateDataResponseItemDTO struct { |
||||
// required:true
|
||||
Type MigrateDataType `json:"type"` |
||||
// required:true
|
||||
RefID string `json:"refId"` |
||||
// required:true
|
||||
Status ItemStatus `json:"status"` |
||||
Error string `json:"error,omitempty"` |
||||
} |
||||
|
||||
// swagger:enum MigrateDataType
|
||||
type MigrateDataType string |
||||
|
||||
const ( |
||||
DashboardDataType MigrateDataType = "DASHBOARD" |
||||
DatasourceDataType MigrateDataType = "DATASOURCE" |
||||
FolderDataType MigrateDataType = "FOLDER" |
||||
) |
||||
|
||||
// swagger:enum ItemStatus
|
||||
type ItemStatus string |
||||
|
||||
const ( |
||||
ItemStatusOK ItemStatus = "OK" |
||||
ItemStatusError ItemStatus = "ERROR" |
||||
) |
||||
|
||||
// swagger:parameters getCloudMigrationRun
|
||||
type GetMigrationRunParams struct { |
||||
// RunUID of a migration run
|
||||
//
|
||||
// in: path
|
||||
RunUID string `json:"runUID"` |
||||
} |
||||
|
||||
// swagger:parameters getCloudMigrationRunList
|
||||
type GetCloudMigrationRunList struct { |
||||
// UID of a migration
|
||||
//
|
||||
// in: path
|
||||
UID string `json:"uid"` |
||||
} |
||||
|
||||
// swagger:response cloudMigrationRunListResponse
|
||||
type CloudMigrationRunListResponse struct { |
||||
// in: body
|
||||
Body SnapshotListDTO |
||||
} |
||||
|
||||
type SnapshotListDTO struct { |
||||
Runs []MigrateDataResponseListDTO `json:"runs"` |
||||
} |
||||
|
||||
type MigrateDataResponseListDTO struct { |
||||
RunUID string `json:"uid"` |
||||
} |
||||
|
||||
// swagger:parameters deleteSession
|
||||
type DeleteMigrationSessionRequest struct { |
||||
// UID of a migration session
|
||||
//
|
||||
// in: path
|
||||
UID string `json:"uid"` |
||||
} |
||||
|
||||
// utility funcs for converting to/from DTO
|
||||
|
||||
func convertSessionListToDTO(sl cloudmigration.CloudMigrationSessionListResponse) CloudMigrationSessionListResponseDTO { |
||||
slDTOs := make([]CloudMigrationSessionResponseDTO, len(sl.Sessions)) |
||||
for i := 0; i < len(slDTOs); i++ { |
||||
s := sl.Sessions[i] |
||||
slDTOs[i] = CloudMigrationSessionResponseDTO{ |
||||
UID: s.UID, |
||||
Slug: s.Slug, |
||||
Created: s.Created, |
||||
Updated: s.Updated, |
||||
} |
||||
} |
||||
return CloudMigrationSessionListResponseDTO{ |
||||
Sessions: slDTOs, |
||||
} |
||||
} |
||||
|
||||
func convertMigrateDataResponseToDTO(r cloudmigration.MigrateDataResponse) MigrateDataResponseDTO { |
||||
items := make([]MigrateDataResponseItemDTO, len(r.Items)) |
||||
for i := 0; i < len(r.Items); i++ { |
||||
item := r.Items[i] |
||||
items[i] = MigrateDataResponseItemDTO{ |
||||
Type: MigrateDataType(item.Type), |
||||
RefID: item.RefID, |
||||
Status: ItemStatus(item.Status), |
||||
Error: item.Error, |
||||
} |
||||
} |
||||
return MigrateDataResponseDTO{ |
||||
RunUID: r.RunUID, |
||||
Items: items, |
||||
} |
||||
} |
||||
@ -1,17 +0,0 @@ |
||||
package cmsclient |
||||
|
||||
import ( |
||||
"context" |
||||
|
||||
"github.com/grafana/grafana/pkg/apimachinery/errutil" |
||||
"github.com/grafana/grafana/pkg/services/cloudmigration" |
||||
) |
||||
|
||||
type Client interface { |
||||
ValidateKey(context.Context, cloudmigration.CloudMigration) error |
||||
MigrateData(context.Context, cloudmigration.CloudMigration, cloudmigration.MigrateDataRequestDTO) (*cloudmigration.MigrateDataResponseDTO, error) |
||||
} |
||||
|
||||
const logPrefix = "cloudmigration.cmsclient" |
||||
|
||||
var ErrMigrationNotDeleted = errutil.Internal("cloudmigrations.developerModeEnabled", errutil.WithPublicMessage("Developer mode enabled")) |
||||
@ -0,0 +1,14 @@ |
||||
package gmsclient |
||||
|
||||
import ( |
||||
"context" |
||||
|
||||
"github.com/grafana/grafana/pkg/services/cloudmigration" |
||||
) |
||||
|
||||
type Client interface { |
||||
ValidateKey(context.Context, cloudmigration.CloudMigrationSession) error |
||||
MigrateData(context.Context, cloudmigration.CloudMigrationSession, cloudmigration.MigrateDataRequest) (*cloudmigration.MigrateDataResponse, error) |
||||
} |
||||
|
||||
const logPrefix = "cloudmigration.gmsclient" |
||||
@ -0,0 +1,47 @@ |
||||
// TODO: Move these to a shared library in common with GMS
|
||||
package gmsclient |
||||
|
||||
type MigrateDataType string |
||||
|
||||
const ( |
||||
DashboardDataType MigrateDataType = "DASHBOARD" |
||||
DatasourceDataType MigrateDataType = "DATASOURCE" |
||||
FolderDataType MigrateDataType = "FOLDER" |
||||
) |
||||
|
||||
type MigrateDataRequestDTO struct { |
||||
Items []MigrateDataRequestItemDTO `json:"items"` |
||||
} |
||||
|
||||
type MigrateDataRequestItemDTO struct { |
||||
Type MigrateDataType `json:"type"` |
||||
RefID string `json:"refId"` |
||||
Name string `json:"name"` |
||||
Data interface{} `json:"data"` |
||||
} |
||||
|
||||
type ItemStatus string |
||||
|
||||
const ( |
||||
ItemStatusOK ItemStatus = "OK" |
||||
ItemStatusError ItemStatus = "ERROR" |
||||
) |
||||
|
||||
type MigrateDataResponseDTO struct { |
||||
RunUID string `json:"uid"` |
||||
Items []MigrateDataResponseItemDTO `json:"items"` |
||||
} |
||||
|
||||
type MigrateDataResponseListDTO struct { |
||||
RunUID string `json:"uid"` |
||||
} |
||||
|
||||
type MigrateDataResponseItemDTO struct { |
||||
// required:true
|
||||
Type MigrateDataType `json:"type"` |
||||
// required:true
|
||||
RefID string `json:"refId"` |
||||
// required:true
|
||||
Status ItemStatus `json:"status"` |
||||
Error string `json:"error,omitempty"` |
||||
} |
||||
Loading…
Reference in new issue