cacert-boardvoting/cmd/boardvoting/jobs.go

/*
Copyright 2017-2022 CAcert Inc.
SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package main

import (
	"log"
	"time"

	"git.cacert.org/cacert-boardvoting/internal/models"
)

func (app *application) SetupJobs() {
	quitChannel := make(chan struct{})

	go app.jobScheduler.Schedule(quitChannel)

	go func() {
		for range app.ctx.Done() {
			quitChannel <- struct{}{}
		}
	}()
}

type Job interface {
	Schedule()
	Run()
	Stop()
}

type RemindVotersJob struct {
	infoLog, errorLog *log.Logger
	timer             *time.Timer
	voters            *models.VoterModel
	decisions         *models.DecisionModel
	notify            chan NotificationMail
	reschedule        chan Job
}

func (r *RemindVotersJob) Schedule() {
	const reminderDays = 3

	year, month, day := time.Now().UTC().Date()

	nextExecution := time.Date(
		year, month, day, 0, 0, 0, 0, time.UTC,
	).AddDate(0, 0, reminderDays)

	r.infoLog.Printf("scheduling RemindVotersJob for %s", nextExecution)

	when := time.Until(nextExecution)

	if r.timer != nil {
		r.timer.Reset(when)

		return
	}

	r.timer = time.AfterFunc(when, r.Run)
}

func (r *RemindVotersJob) Run() {
	r.infoLog.Print("running RemindVotersJob")

	defer func(r *RemindVotersJob) { r.reschedule <- r }(r)

	var (
		voters    []models.Voter
		decisions []models.Decision
		err       error
	)

	voters, err = r.voters.GetReminderVoters()
	if err != nil {
		r.errorLog.Printf("problem getting voters: %v", err)

		return
	}

	for _, voter := range voters {
		decisions, err = r.decisions.FindUnVotedDecisionsForVoter(&voter)
		if err != nil {
			r.errorLog.Printf("problem getting unvoted decisions: %v", err)

			return
		}

		if len(decisions) > 0 {
			r.notify <- &RemindVoterNotification{voter: voter, decisions: decisions}
		}
	}
}

func (r *RemindVotersJob) Stop() {
	if r.timer != nil {
		r.timer.Stop()

		r.timer = nil
	}
}

func (app *application) NewRemindVotersJob(
	rescheduleChannel chan Job,
) Job {
	return &RemindVotersJob{
		infoLog:    app.infoLog,
		errorLog:   app.errorLog,
		voters:     app.voters,
		decisions:  app.decisions,
		reschedule: rescheduleChannel,
		notify:     app.mailNotifier.notifyChannel,
	}
}

type closeDecisionsJob struct {
	timer      *time.Timer
	infoLog    *log.Logger
	errorLog   *log.Logger
	decisions  *models.DecisionModel
	reschedule chan Job
	notify     chan NotificationMail
}

func (c *closeDecisionsJob) Schedule() {
	var (
		nextDue *time.Time
		err     error
	)

	nextDue, err = c.decisions.GetNextPendingDecisionDue()
	if err != nil {
		c.errorLog.Printf("could not get next pending due date")

		c.Stop()

		return
	}

	if nextDue == nil {
		c.infoLog.Printf("no next planned execution of CloseDecisionsJob")
		c.Stop()

		return
	}

	c.infoLog.Printf("scheduling CloseDecisionsJob for %s", nextDue)
	when := time.Until(nextDue.Add(time.Second))

	if c.timer == nil {
		c.timer = time.AfterFunc(when, c.Run)

		return
	}

	c.timer.Reset(when)
}

func (c *closeDecisionsJob) Run() {
	c.infoLog.Printf("running CloseDecisionsJob")

	results, err := c.decisions.CloseDecisions()
	if err != nil {
		c.errorLog.Printf("closing decisions failed: %v", err)
	}

	for _, res := range results {
		c.notify <- &ClosedDecisionNotification{decision: res}
	}

	c.reschedule <- c
}

func (c *closeDecisionsJob) Stop() {
	if c.timer != nil {
		c.timer.Stop()
		c.timer = nil
	}
}

func (app *application) NewCloseDecisionsJob(
	rescheduleChannel chan Job,
) Job {
	return &closeDecisionsJob{
		infoLog:    app.infoLog,
		errorLog:   app.errorLog,
		decisions:  app.decisions,
		reschedule: rescheduleChannel,
		notify:     app.mailNotifier.notifyChannel,
	}
}

type JobScheduler struct {
	infoLogger        *log.Logger
	errorLogger       *log.Logger
	jobs              []Job
	rescheduleChannel chan Job
}

func (app *application) NewJobScheduler() {
	rescheduleChannel := make(chan Job, 1)

	app.jobScheduler = &JobScheduler{
		infoLogger:        app.infoLog,
		errorLogger:       app.errorLog,
		jobs:              make([]Job, 0, 2),
		rescheduleChannel: rescheduleChannel,
	}

	app.jobScheduler.addJob(app.NewCloseDecisionsJob(rescheduleChannel))
	app.jobScheduler.addJob(app.NewRemindVotersJob(rescheduleChannel))
}

func (js *JobScheduler) Schedule(quitChannel chan struct{}) {
	for _, job := range js.jobs {
		js.infoLogger.Printf("schedule job %v", job)

		job.Schedule()
	}

	for {
		select {
		case job := <-js.rescheduleChannel:
			js.infoLogger.Printf("reschedule job %v", job)

			job.Schedule()
		case <-quitChannel:
			for _, job := range js.jobs {
				job.Stop()
			}

			js.infoLogger.Print("stop job scheduler")

			return
		}
	}
}

func (js *JobScheduler) addJob(job Job) {
	js.jobs = append(js.jobs, job)
}