Working on refactoring jobs service (#19205)

* Working on refactoring jobs service

* Making more consistent with the previous existing code

* Remove no longer needed functions

* Making a base PeridicScheduler to use it in most of the schedulers implementations

* Removing accidental complexity from on of the jobs

* Removing accidental complexity from expirynotify

* Fixing compilation from previous commit

* Remove accidental complexity from the export_delete job

* Simplifying the workers by making a reusable worker

* Using simple worker for export_delete job

* Simpliying export process job

* Simpliying extract content job

* Simpliying import delete job

* Simpliying import process job

* Simpliying product noticies job

* Simpliying fix crt channel unreads job (only removing the uneeded register function)

* Simpliying migrations job (only removing the uneeded register function)

* fixup

* Simpliying plugins job (only removing the uneeded register function)

* Simpliying bleve indexing job (only removing the uneeded register function)

* Simpliying resend invitation email job (only removing the uneeded register function)

* Fixing tests

* Simplifying migration tests infrastructure

* Adding missed license to files

* Adding an empty file to imports package to ensure this package exist even without enterprise repo

* Regenerating einterfaces mocks

* Adding missed license to files

* Updating i18n/en.json file

* help fixing enterprise tests compilation

* Adding new DailyScheduler

* Fixing typo and changing the waitTime type for periodic sechduler

* Making the daily scheduler more generic

* Adding comments to clarify not used parameters in interface scheduler interface implementations

* Using merror to handle multiple errors in jobs workers

* Fixing linter errors

* Addressing PR review comments

* Reverting go.tools.mod changes

* Removing the static check for worker type in the model (moving it to the insertion of new jobs

* Moving migrations job to the jobs directory

* Fixing (and improving a bit) tests

* Apply suggestions from code review

Co-authored-by: Doug Lauder <wiggin77@warpmail.net>

* Fixing enterprise tests

* Removing unneeded InitWorkers/InitSchedulers calls

* Fix expirenotify job when error happens

* Fixing govet errors

Co-authored-by: Mattermod <mattermod@users.noreply.github.com>
Co-authored-by: Doug Lauder <wiggin77@warpmail.net>

plugin/scheduler/plugin.go

@@ -1,20 +0,0 @@
-// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
-// See LICENSE.txt for license information.
-
-package scheduler
-
-import (
-	"github.com/mattermost/mattermost-server/v6/app"
-	tjobs "github.com/mattermost/mattermost-server/v6/jobs/interfaces"
-)
-
-type PluginsJobInterfaceImpl struct {
-	App *app.App
-}
-
-func init() {
-	app.RegisterJobsPluginsJobInterface(func(s *app.Server) tjobs.PluginsJobInterface {
-		a := app.New(app.ServerConnector(s.Channels()))
-		return &PluginsJobInterfaceImpl{a}
-	})
-}

plugin/scheduler/scheduler.go

@@ -6,45 +6,15 @@ package scheduler
 import (
 	"time"
 
-	"github.com/mattermost/mattermost-server/v6/app"
+	"github.com/mattermost/mattermost-server/v6/jobs"
 	"github.com/mattermost/mattermost-server/v6/model"
-	"github.com/mattermost/mattermost-server/v6/shared/mlog"
 )
 
-const pluginsJobInterval = 24 * 60 * 60 * time.Second
+const schedFreq = 24 * time.Hour
 
-type Scheduler struct {
-	App *app.App
-}
-
-func (m *PluginsJobInterfaceImpl) MakeScheduler() model.Scheduler {
-	return &Scheduler{m.App}
-}
-
-func (scheduler *Scheduler) Name() string {
-	return "PluginsScheduler"
-}
-
-func (scheduler *Scheduler) JobType() string {
-	return model.JobTypePlugins
-}
-
-func (scheduler *Scheduler) Enabled(cfg *model.Config) bool {
-	return true
-}
-
-func (scheduler *Scheduler) NextScheduleTime(cfg *model.Config, now time.Time, pendingJobs bool, lastSuccessfulJob *model.Job) *time.Time {
-	nextTime := time.Now().Add(pluginsJobInterval)
-	return &nextTime
-}
-
-func (scheduler *Scheduler) ScheduleJob(cfg *model.Config, pendingJobs bool, lastSuccessfulJob *model.Job) (*model.Job, *model.AppError) {
-	mlog.Debug("Scheduling Job", mlog.String("scheduler", scheduler.Name()))
-
-	job, err := scheduler.App.Srv().Jobs.CreateJob(model.JobTypePlugins, nil)
-	if err != nil {
-		return nil, err
+func MakeScheduler(jobServer *jobs.JobServer) model.Scheduler {
+	isEnabled := func(cfg *model.Config) bool {
+		return true
 	}
-
-	return job, nil
+	return jobs.NewPeriodicScheduler(jobServer, model.JobTypePlugins, schedFreq, isEnabled)
 }

plugin/scheduler/worker.go

@@ -4,29 +4,32 @@
 package scheduler
 
 import (
-	"github.com/mattermost/mattermost-server/v6/app"
 	"github.com/mattermost/mattermost-server/v6/jobs"
 	"github.com/mattermost/mattermost-server/v6/model"
 	"github.com/mattermost/mattermost-server/v6/shared/mlog"
 )
 
+type AppIface interface {
+	DeleteAllExpiredPluginKeys() *model.AppError
+}
+
 type Worker struct {
 	name      string
 	stop      chan bool
 	stopped   chan bool
 	jobs      chan model.Job
 	jobServer *jobs.JobServer
-	app       *app.App
+	app       AppIface
 }
 
-func (m *PluginsJobInterfaceImpl) MakeWorker() model.Worker {
+func MakeWorker(jobServer *jobs.JobServer, app AppIface) model.Worker {
 	worker := Worker{
 		name:      "Plugins",
 		stop:      make(chan bool, 1),
 		stopped:   make(chan bool, 1),
 		jobs:      make(chan model.Job),
-		jobServer: m.App.Srv().Jobs,
-		app:       m.App,
+		jobServer: jobServer,
+		app:       app,
 	}
 
 	return &worker
@@ -62,6 +65,10 @@ func (worker *Worker) JobChannel() chan<- model.Job {
 	return worker.jobs
 }
 
+func (worker *Worker) IsEnabled(cfg *model.Config) bool {
+	return true
+}
+
 func (worker *Worker) DoJob(job *model.Job) {
 	if claimed, err := worker.jobServer.ClaimJob(job); err != nil {
 		mlog.Info("Worker experienced an error while trying to claim job",
@@ -84,14 +91,14 @@ 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.jobServer.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.jobServer.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()))
 	}
 }