Change the App dependency with Server in migrations package (mattermost#14804)

jespino · mattermod · web-flow · commit e2e352e22385 · 2020-06-29T18:00:16.000+02:00
Co-authored-by: Mattermod &lt;mattermod@users.noreply.github.com&gt;
diff --git a/app/app.go b/app/app.go
@@ -129,9 +129,6 @@ func (a *App) initJobs() {
 	if jobsLdapSyncInterface != nil {
 		a.srv.Jobs.LdapSync = jobsLdapSyncInterface(a)
 	}
-	if jobsMigrationsInterface != nil {
-		a.srv.Jobs.Migrations = jobsMigrationsInterface(a)
-	}
 	if jobsPluginsInterface != nil {
 		a.srv.Jobs.Plugins = jobsPluginsInterface(a)
 	}
diff --git a/app/enterprise.go b/app/enterprise.go
@@ -72,9 +72,9 @@ func RegisterJobsLdapSyncInterface(f func(*App) ejobs.LdapSyncInterface) {
 	jobsLdapSyncInterface = f
 }
 
-var jobsMigrationsInterface func(*App) tjobs.MigrationsJobInterface
+var jobsMigrationsInterface func(*Server) tjobs.MigrationsJobInterface
 
-func RegisterJobsMigrationsJobInterface(f func(*App) tjobs.MigrationsJobInterface) {
+func RegisterJobsMigrationsJobInterface(f func(*Server) tjobs.MigrationsJobInterface) {
 	jobsMigrationsInterface = f
 }
 
diff --git a/app/server.go b/app/server.go
@@ -1290,4 +1290,7 @@ func (s *Server) initJobs() {
 	if jobsBleveIndexerInterface != nil {
 		s.Jobs.BleveIndexer = jobsBleveIndexerInterface(s)
 	}
+	if jobsMigrationsInterface != nil {
+		s.Jobs.Migrations = jobsMigrationsInterface(s)
+	}
 }
diff --git a/migrations/advanced_permissions_phase_2.go b/migrations/advanced_permissions_phase_2.go
@@ -71,7 +71,7 @@ func (worker *Worker) runAdvancedPermissionsPhase2Migration(lastDone string) (bo
 
 	if progress.CurrentTable == "TeamMembers" {
 		// Run a TeamMembers migration batch.
-		if result, err := worker.app.Srv().Store.Team().MigrateTeamMembers(progress.LastTeamId, progress.LastUserId); err != nil {
+		if result, err := worker.srv.Store.Team().MigrateTeamMembers(progress.LastTeamId, progress.LastUserId); err != nil {
 			return false, progress.ToJson(), err
 		} else {
 			if result == nil {
@@ -86,7 +86,7 @@ func (worker *Worker) runAdvancedPermissionsPhase2Migration(lastDone string) (bo
 		}
 	} else if progress.CurrentTable == "ChannelMembers" {
 		// Run a ChannelMembers migration batch.
-		if data, err := worker.app.Srv().Store.Channel().MigrateChannelMembers(progress.LastChannelId, progress.LastUserId); err != nil {
+		if data, err := worker.srv.Store.Channel().MigrateChannelMembers(progress.LastChannelId, progress.LastUserId); err != nil {
 			return false, progress.ToJson(), err
 		} else {
 			if data == nil {
diff --git a/migrations/migrations.go b/migrations/migrations.go
@@ -20,12 +20,12 @@ const (
 )
 
 type MigrationsJobInterfaceImpl struct {
-	App *app.App
+	srv *app.Server
 }
 
 func init() {
-	app.RegisterJobsMigrationsJobInterface(func(a *app.App) tjobs.MigrationsJobInterface {
-		return &MigrationsJobInterfaceImpl{a}
+	app.RegisterJobsMigrationsJobInterface(func(s *app.Server) tjobs.MigrationsJobInterface {
+		return &MigrationsJobInterfaceImpl{s}
 	})
 }
 
diff --git a/migrations/scheduler.go b/migrations/scheduler.go
@@ -17,12 +17,12 @@ const (
 )
 
 type Scheduler struct {
-	App                    *app.App
+	srv                    *app.Server
 	allMigrationsCompleted bool
 }
 
 func (m *MigrationsJobInterfaceImpl) MakeScheduler() model.Scheduler {
-	return &Scheduler{m.App, false}
+	return &Scheduler{m.srv, false}
 }
 
 func (scheduler *Scheduler) Name() string {
@@ -51,7 +51,7 @@ func (scheduler *Scheduler) ScheduleJob(cfg *model.Config, pendingJobs bool, las
 
 	// Work through the list of migrations in order. Schedule the first one that isn't done (assuming it isn't in progress already).
 	for _, key := range MakeMigrationsList() {
-		state, job, err := GetMigrationState(key, scheduler.App.Srv().Store)
+		state, job, err := GetMigrationState(key, scheduler.srv.Store)
 		if err != nil {
 			mlog.Error("Failed to determine status of migration: ", mlog.String("scheduler", scheduler.Name()), mlog.String("migration_key", key), mlog.String("error", err.Error()))
 			return nil, nil
@@ -61,10 +61,10 @@ func (scheduler *Scheduler) ScheduleJob(cfg *model.Config, pendingJobs bool, las
 			// Check the migration job isn't wedged.
 			if job != nil && job.LastActivityAt < model.GetMillis()-MIGRATION_JOB_WEDGED_TIMEOUT_MILLISECONDS && job.CreateAt < model.GetMillis()-MIGRATION_JOB_WEDGED_TIMEOUT_MILLISECONDS {
 				mlog.Warn("Job appears to be wedged. Rescheduling another instance.", mlog.String("scheduler", scheduler.Name()), mlog.String("wedged_job_id", job.Id), mlog.String("migration_key", key))
-				if err := scheduler.App.Srv().Jobs.SetJobError(job, nil); err != nil {
+				if err := scheduler.srv.Jobs.SetJobError(job, nil); err != nil {
 					mlog.Error("Worker: Failed to set job error", mlog.String("scheduler", scheduler.Name()), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
 				}
-				return scheduler.createJob(key, job, scheduler.App.Srv().Store)
+				return scheduler.createJob(key, job, scheduler.srv.Store)
 			}
 
 			return nil, nil
@@ -77,7 +77,7 @@ func (scheduler *Scheduler) ScheduleJob(cfg *model.Config, pendingJobs bool, las
 
 		if state == MIGRATION_STATE_UNSCHEDULED {
 			mlog.Debug("Scheduling a new job for migration.", mlog.String("scheduler", scheduler.Name()), mlog.String("migration_key", key))
-			return scheduler.createJob(key, job, scheduler.App.Srv().Store)
+			return scheduler.createJob(key, job, scheduler.srv.Store)
 		}
 
 		mlog.Error("Unknown migration state. Not doing anything.", mlog.String("migration_state", state))
@@ -102,7 +102,7 @@ func (scheduler *Scheduler) createJob(migrationKey string, lastJob *model.Job, s
 		JOB_DATA_KEY_MIGRATION_LAST_DONE: lastDone,
 	}
 
-	if job, err := scheduler.App.Srv().Jobs.CreateJob(model.JOB_TYPE_MIGRATIONS, data); err != nil {
+	if job, err := scheduler.srv.Jobs.CreateJob(model.JOB_TYPE_MIGRATIONS, data); err != nil {
 		return nil, err
 	} else {
 		return job, nil
diff --git a/migrations/worker.go b/migrations/worker.go
@@ -24,7 +24,7 @@ type Worker struct {
 	stopped   chan bool
 	jobs      chan model.Job
 	jobServer *jobs.JobServer
-	app       *app.App
+	srv       *app.Server
 }
 
 func (m *MigrationsJobInterfaceImpl) MakeWorker() model.Worker {
@@ -33,8 +33,8 @@ func (m *MigrationsJobInterfaceImpl) MakeWorker() model.Worker {
 		stop:      make(chan bool, 1),
 		stopped:   make(chan bool, 1),
 		jobs:      make(chan model.Job),
-		jobServer: m.App.Srv().Jobs,
-		app:       m.App,
+		jobServer: m.srv.Jobs,
+		srv:       m.srv,
 	}
 
 	return &worker
@@ -83,7 +83,7 @@ func (worker *Worker) DoJob(job *model.Job) {
 
 	cancelCtx, cancelCancelWatcher := context.WithCancel(context.Background())
 	cancelWatcherChan := make(chan interface{}, 1)
-	go worker.app.Srv().Jobs.CancellationWatcher(cancelCtx, job.Id, cancelWatcherChan)
+	go worker.srv.Jobs.CancellationWatcher(cancelCtx, job.Id, cancelWatcherChan)
 
 	defer cancelCancelWatcher()
 
@@ -111,7 +111,7 @@ func (worker *Worker) DoJob(job *model.Job) {
 				return
 			} else {
 				job.Data[JOB_DATA_KEY_MIGRATION_LAST_DONE] = progress
-				if err := worker.app.Srv().Jobs.UpdateInProgressJobData(job); err != nil {
+				if err := worker.srv.Jobs.UpdateInProgressJobData(job); err != nil {
 					mlog.Error("Worker: Failed to update migration status data for job", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
 					worker.setJobError(job, err)
 					return
@@ -122,20 +122,20 @@ func (worker *Worker) DoJob(job *model.Job) {
 }
 
 func (worker *Worker) setJobSuccess(job *model.Job) {
-	if err := worker.app.Srv().Jobs.SetJobSuccess(job); err != nil {
+	if err := worker.srv.Jobs.SetJobSuccess(job); err != nil {
 		mlog.Error("Worker: Failed to set success for job", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
 		worker.setJobError(job, err)
 	}
 }
 
 func (worker *Worker) setJobError(job *model.Job, appError *model.AppError) {
-	if err := worker.app.Srv().Jobs.SetJobError(job, appError); err != nil {
+	if err := worker.srv.Jobs.SetJobError(job, appError); err != nil {
 		mlog.Error("Worker: Failed to set job error", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
 	}
 }
 
 func (worker *Worker) setJobCanceled(job *model.Job) {
-	if err := worker.app.Srv().Jobs.SetJobCanceled(job); err != nil {
+	if err := worker.srv.Jobs.SetJobCanceled(job); err != nil {
 		mlog.Error("Worker: Failed to mark job as canceled", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))
 	}
 }
@@ -157,7 +157,7 @@ func (worker *Worker) runMigration(key string, lastDone string) (bool, string, *
 	}
 
 	if done {
-		if saveErr := worker.app.Srv().Store.System().Save(&model.System{Name: key, Value: "true"}); saveErr != nil {
+		if saveErr := worker.srv.Store.System().Save(&model.System{Name: key, Value: "true"}); saveErr != nil {
 			return false, "", saveErr
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -129,9 +129,6 @@ func (a *App) initJobs() {`
`129`	`129`	`if jobsLdapSyncInterface != nil {`
`130`	`130`	`a.srv.Jobs.LdapSync = jobsLdapSyncInterface(a)`
`131`	`131`	`}`
`132`		`- if jobsMigrationsInterface != nil {`
`133`		`- a.srv.Jobs.Migrations = jobsMigrationsInterface(a)`
`134`		`- }`
`135`	`132`	`if jobsPluginsInterface != nil {`
`136`	`133`	`a.srv.Jobs.Plugins = jobsPluginsInterface(a)`
`137`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,9 +72,9 @@ func RegisterJobsLdapSyncInterface(f func(*App) ejobs.LdapSyncInterface) {`
`72`	`72`	`jobsLdapSyncInterface = f`
`73`	`73`	`}`
`74`	`74`
`75`		`-var jobsMigrationsInterface func(*App) tjobs.MigrationsJobInterface`
	`75`	`+var jobsMigrationsInterface func(*Server) tjobs.MigrationsJobInterface`
`76`	`76`
`77`		`-func RegisterJobsMigrationsJobInterface(f func(*App) tjobs.MigrationsJobInterface) {`
	`77`	`+func RegisterJobsMigrationsJobInterface(f func(*Server) tjobs.MigrationsJobInterface) {`
`78`	`78`	`jobsMigrationsInterface = f`
`79`	`79`	`}`
`80`	`80`
Original file line number	Diff line number	Diff line change
`@@ -1290,4 +1290,7 @@ func (s *Server) initJobs() {`
`1290`	`1290`	`if jobsBleveIndexerInterface != nil {`
`1291`	`1291`	`s.Jobs.BleveIndexer = jobsBleveIndexerInterface(s)`
`1292`	`1292`	`}`
	`1293`	`+ if jobsMigrationsInterface != nil {`
	`1294`	`+ s.Jobs.Migrations = jobsMigrationsInterface(s)`
	`1295`	`+ }`
`1293`	`1296`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,12 +20,12 @@ const (`
`20`	`20`	`)`
`21`	`21`
`22`	`22`	`type MigrationsJobInterfaceImpl struct {`
`23`		`- App *app.App`
	`23`	`+ srv *app.Server`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`func init() {`
`27`		`- app.RegisterJobsMigrationsJobInterface(func(a *app.App) tjobs.MigrationsJobInterface {`
`28`		`- return &MigrationsJobInterfaceImpl{a}`
	`27`	`+ app.RegisterJobsMigrationsJobInterface(func(s *app.Server) tjobs.MigrationsJobInterface {`
	`28`	`+ return &MigrationsJobInterfaceImpl{s}`
`29`	`29`	`})`
`30`	`30`	`}`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ type Worker struct {`
`24`	`24`	`stopped chan bool`
`25`	`25`	`jobs chan model.Job`
`26`	`26`	`jobServer *jobs.JobServer`
`27`		`- app *app.App`
	`27`	`+ srv *app.Server`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`func (m *MigrationsJobInterfaceImpl) MakeWorker() model.Worker {`
`@@ -33,8 +33,8 @@ func (m *MigrationsJobInterfaceImpl) MakeWorker() model.Worker {`
`33`	`33`	`stop: make(chan bool, 1),`
`34`	`34`	`stopped: make(chan bool, 1),`
`35`	`35`	`jobs: make(chan model.Job),`
`36`		`- jobServer: m.App.Srv().Jobs,`
`37`		`- app: m.App,`
	`36`	`+ jobServer: m.srv.Jobs,`
	`37`	`+ srv: m.srv,`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`return &worker`
`@@ -83,7 +83,7 @@ func (worker Worker) DoJob(job model.Job) {`
`83`	`83`
`84`	`84`	`cancelCtx, cancelCancelWatcher := context.WithCancel(context.Background())`
`85`	`85`	`cancelWatcherChan := make(chan interface{}, 1)`
`86`		`- go worker.app.Srv().Jobs.CancellationWatcher(cancelCtx, job.Id, cancelWatcherChan)`
	`86`	`+ go worker.srv.Jobs.CancellationWatcher(cancelCtx, job.Id, cancelWatcherChan)`
`87`	`87`
`88`	`88`	`defer cancelCancelWatcher()`
`89`	`89`
`@@ -111,7 +111,7 @@ func (worker Worker) DoJob(job model.Job) {`
`111`	`111`	`return`
`112`	`112`	`} else {`
`113`	`113`	`job.Data[JOB_DATA_KEY_MIGRATION_LAST_DONE] = progress`
`114`		`- if err := worker.app.Srv().Jobs.UpdateInProgressJobData(job); err != nil {`
	`114`	`+ if err := worker.srv.Jobs.UpdateInProgressJobData(job); err != nil {`
`115`	`115`	`mlog.Error("Worker: Failed to update migration status data for job", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))`
`116`	`116`	`worker.setJobError(job, err)`
`117`	`117`	`return`
`@@ -122,20 +122,20 @@ func (worker Worker) DoJob(job model.Job) {`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`func (worker Worker) setJobSuccess(job model.Job) {`
`125`		`- if err := worker.app.Srv().Jobs.SetJobSuccess(job); err != nil {`
	`125`	`+ if err := worker.srv.Jobs.SetJobSuccess(job); err != nil {`
`126`	`126`	`mlog.Error("Worker: Failed to set success for job", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))`
`127`	`127`	`worker.setJobError(job, err)`
`128`	`128`	`}`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`func (worker Worker) setJobError(job model.Job, appError *model.AppError) {`
`132`		`- if err := worker.app.Srv().Jobs.SetJobError(job, appError); err != nil {`
	`132`	`+ if err := worker.srv.Jobs.SetJobError(job, appError); err != nil {`
`133`	`133`	`mlog.Error("Worker: Failed to set job error", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))`
`134`	`134`	`}`
`135`	`135`	`}`
`136`	`136`
`137`	`137`	`func (worker Worker) setJobCanceled(job model.Job) {`
`138`		`- if err := worker.app.Srv().Jobs.SetJobCanceled(job); err != nil {`
	`138`	`+ if err := worker.srv.Jobs.SetJobCanceled(job); err != nil {`
`139`	`139`	`mlog.Error("Worker: Failed to mark job as canceled", mlog.String("worker", worker.name), mlog.String("job_id", job.Id), mlog.String("error", err.Error()))`
`140`	`140`	`}`
`141`	`141`	`}`
`@@ -157,7 +157,7 @@ func (worker Worker) runMigration(key string, lastDone string) (bool, string, `
`157`	`157`	`}`
`158`	`158`
`159`	`159`	`if done {`
`160`		`- if saveErr := worker.app.Srv().Store.System().Save(&model.System{Name: key, Value: "true"}); saveErr != nil {`
	`160`	`+ if saveErr := worker.srv.Store.System().Save(&model.System{Name: key, Value: "true"}); saveErr != nil {`
`161`	`161`	`return false, "", saveErr`
`162`	`162`	`}`
`163`	`163`	`}`