Secrets: Convert secret migration to a background service (#54676)

* Convert secret migration to a background service

* Fix merge conflicts

* Return concrete type for secret migration provider

pkg/server/backgroundsvcs/background_services.go

@@ -23,6 +23,7 @@ import (
 	"github.com/grafana/grafana/pkg/services/provisioning"
 	"github.com/grafana/grafana/pkg/services/rendering"
 	"github.com/grafana/grafana/pkg/services/searchV2"
+	secretsMigrations "github.com/grafana/grafana/pkg/services/secrets/kvstore/migrations"
 	secretsManager "github.com/grafana/grafana/pkg/services/secrets/manager"
 	"github.com/grafana/grafana/pkg/services/serviceaccounts"
 	samanager "github.com/grafana/grafana/pkg/services/serviceaccounts/manager"
@@ -42,6 +43,7 @@ func ProvideBackgroundServiceRegistry(
 	secretsService *secretsManager.SecretsService, remoteCache *remotecache.RemoteCache,
 	thumbnailsService thumbs.Service, StorageService store.StorageService, searchService searchV2.SearchService, entityEventsService store.EntityEventsService,
 	saService *samanager.ServiceAccountsService, authInfoService *authinfoservice.Implementation,
+	secretMigrationProvider secretsMigrations.SecretMigrationProvider,
 	// Need to make sure these are initialized, is there a better place to put them?
 	_ dashboardsnapshots.Service, _ *alerting.AlertNotificationService,
 	_ serviceaccounts.Service, _ *guardian.Provider,
@@ -73,6 +75,7 @@ func ProvideBackgroundServiceRegistry(
 		saService,
 		authInfoService,
 		processManager,
+		secretMigrationProvider,
 	)
 }
 

pkg/server/server.go

@@ -23,7 +23,6 @@ import (
 	"github.com/grafana/grafana/pkg/login/social"
 	"github.com/grafana/grafana/pkg/registry"
 	"github.com/grafana/grafana/pkg/services/provisioning"
-	secretsMigrations "github.com/grafana/grafana/pkg/services/secrets/kvstore/migrations"
 	"github.com/grafana/grafana/pkg/services/user"
 
 	"github.com/grafana/grafana/pkg/setting"
@@ -44,10 +43,10 @@ type Options struct {
 func New(opts Options, cfg *setting.Cfg, httpServer *api.HTTPServer, roleRegistry accesscontrol.RoleRegistry,
 	provisioningService provisioning.ProvisioningService, backgroundServiceProvider registry.BackgroundServiceRegistry,
 	usageStatsProvidersRegistry registry.UsageStatsProvidersRegistry, statsCollectorService *statscollector.Service,
-	secretMigrationService secretsMigrations.SecretMigrationService, userService user.Service, loginAttemptService loginattempt.Service,
+	userService user.Service, loginAttemptService loginattempt.Service,
 ) (*Server, error) {
 	statsCollectorService.RegisterProviders(usageStatsProvidersRegistry.GetServices())
-	s, err := newServer(opts, cfg, httpServer, roleRegistry, provisioningService, backgroundServiceProvider, secretMigrationService, userService, loginAttemptService)
+	s, err := newServer(opts, cfg, httpServer, roleRegistry, provisioningService, backgroundServiceProvider, userService, loginAttemptService)
 	if err != nil {
 		return nil, err
 	}
@@ -60,30 +59,28 @@ func New(opts Options, cfg *setting.Cfg, httpServer *api.HTTPServer, roleRegistr
 }
 
 func newServer(opts Options, cfg *setting.Cfg, httpServer *api.HTTPServer, roleRegistry accesscontrol.RoleRegistry,
-	provisioningService provisioning.ProvisioningService, backgroundServiceProvider registry.BackgroundServiceRegistry,
-	secretMigrationService secretsMigrations.SecretMigrationService, userService user.Service, loginAttemptService loginattempt.Service,
+	provisioningService provisioning.ProvisioningService, backgroundServiceProvider registry.BackgroundServiceRegistry, userService user.Service, loginAttemptService loginattempt.Service,
 ) (*Server, error) {
 	rootCtx, shutdownFn := context.WithCancel(context.Background())
 	childRoutines, childCtx := errgroup.WithContext(rootCtx)
 
 	s := &Server{
-		context:                childCtx,
-		childRoutines:          childRoutines,
-		HTTPServer:             httpServer,
-		provisioningService:    provisioningService,
-		roleRegistry:           roleRegistry,
-		shutdownFn:             shutdownFn,
-		shutdownFinished:       make(chan struct{}),
-		log:                    log.New("server"),
-		cfg:                    cfg,
-		pidFile:                opts.PidFile,
-		version:                opts.Version,
-		commit:                 opts.Commit,
-		buildBranch:            opts.BuildBranch,
-		backgroundServices:     backgroundServiceProvider.GetServices(),
-		secretMigrationService: secretMigrationService,
-		userService:            userService,
-		loginAttemptService:    loginAttemptService,
+		context:             childCtx,
+		childRoutines:       childRoutines,
+		HTTPServer:          httpServer,
+		provisioningService: provisioningService,
+		roleRegistry:        roleRegistry,
+		shutdownFn:          shutdownFn,
+		shutdownFinished:    make(chan struct{}),
+		log:                 log.New("server"),
+		cfg:                 cfg,
+		pidFile:             opts.PidFile,
+		version:             opts.Version,
+		commit:              opts.Commit,
+		buildBranch:         opts.BuildBranch,
+		backgroundServices:  backgroundServiceProvider.GetServices(),
+		userService:         userService,
+		loginAttemptService: loginAttemptService,
 	}
 
 	return s, nil
@@ -107,12 +104,11 @@ type Server struct {
 	buildBranch        string
 	backgroundServices []registry.BackgroundService
 
-	HTTPServer             *api.HTTPServer
-	roleRegistry           accesscontrol.RoleRegistry
-	provisioningService    provisioning.ProvisioningService
-	secretMigrationService secretsMigrations.SecretMigrationService
-	userService            user.Service
-	loginAttemptService    loginattempt.Service
+	HTTPServer          *api.HTTPServer
+	roleRegistry        accesscontrol.RoleRegistry
+	provisioningService provisioning.ProvisioningService
+	userService         user.Service
+	loginAttemptService loginattempt.Service
 }
 
 // init initializes the server and its services.
@@ -137,10 +133,6 @@ func (s *Server) init() error {
 		return err
 	}
 
-	if err := s.secretMigrationService.Migrate(s.context); err != nil {
-		return err
-	}
-
 	return s.provisioningService.RunInitProvisioners(s.context)
 }
 

pkg/server/server_test.go

@@ -7,12 +7,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/grafana/grafana/pkg/infra/serverlock"
 	"github.com/grafana/grafana/pkg/registry"
 	"github.com/grafana/grafana/pkg/server/backgroundsvcs"
 	"github.com/grafana/grafana/pkg/services/accesscontrol/acimpl"
-	"github.com/grafana/grafana/pkg/services/secrets/kvstore/migrations"
-	"github.com/grafana/grafana/pkg/services/sqlstore"
 	"github.com/grafana/grafana/pkg/services/user/usertest"
 	"github.com/grafana/grafana/pkg/setting"
 	"github.com/stretchr/testify/require"
@@ -51,11 +48,7 @@ func (s *testService) IsDisabled() bool {
 
 func testServer(t *testing.T, services ...registry.BackgroundService) *Server {
 	t.Helper()
-	serverLockService := serverlock.ProvideService(sqlstore.InitTestDB(t))
-	secretMigrationService := &migrations.SecretMigrationServiceImpl{
-		ServerLockService: serverLockService,
-	}
-	s, err := newServer(Options{}, setting.NewCfg(), nil, &acimpl.Service{}, nil, backgroundsvcs.NewBackgroundServiceRegistry(services...), secretMigrationService, usertest.NewUserServiceFake(), nil)
+	s, err := newServer(Options{}, setting.NewCfg(), nil, &acimpl.Service{}, nil, backgroundsvcs.NewBackgroundServiceRegistry(services...), usertest.NewUserServiceFake(), nil)
 	require.NoError(t, err)
 	// Required to skip configuration initialization that causes
 	// DI errors in this test.

pkg/server/wire.go

@@ -334,8 +334,8 @@ var wireBasicSet = wire.NewSet(
 	secretsMigrations.ProvideDataSourceMigrationService,
 	secretsMigrations.ProvideMigrateToPluginService,
 	secretsMigrations.ProvideMigrateFromPluginService,
-	secretsMigrations.ProvideSecretMigrationService,
-	wire.Bind(new(secretsMigrations.SecretMigrationService), new(*secretsMigrations.SecretMigrationServiceImpl)),
+	secretsMigrations.ProvideSecretMigrationProvider,
+	wire.Bind(new(secretsMigrations.SecretMigrationProvider), new(*secretsMigrations.SecretMigrationProviderImpl)),
 	userauthimpl.ProvideService,
 	acimpl.ProvideAccessControl,
 	wire.Bind(new(accesscontrol.AccessControl), new(*acimpl.AccessControl)),