asynq/heartbeat.go

// Copyright 2020 Kentaro Hibino. All rights reserved.
// Use of this source code is governed by a MIT license
// that can be found in the LICENSE file.

package asynq

import (
	"sync"
	"time"

	"github.com/hibiken/asynq/internal/base"
	"github.com/hibiken/asynq/internal/rdb"
)

// heartbeater is responsible for writing process info to redis periodically to
// indicate that the background worker process is up.
type heartbeater struct {
	logger Logger
	rdb    *rdb.RDB

	ps *base.ProcessState

	// channel to communicate back to the long running "heartbeater" goroutine.
	done chan struct{}

	// interval between heartbeats.
	interval time.Duration
}

func newHeartbeater(l Logger, rdb *rdb.RDB, ps *base.ProcessState, interval time.Duration) *heartbeater {
	return &heartbeater{
		logger:   l,
		rdb:      rdb,
		ps:       ps,
		done:     make(chan struct{}),
		interval: interval,
	}
}

func (h *heartbeater) terminate() {
	h.logger.Info("Heartbeater shutting down...")
	// Signal the heartbeater goroutine to stop.
	h.done <- struct{}{}
}

func (h *heartbeater) start(wg *sync.WaitGroup) {
	h.ps.SetStarted(time.Now())
	h.ps.SetStatus(base.StatusRunning)
	wg.Add(1)
	go func() {
		defer wg.Done()
		h.beat()
		for {
			select {
			case <-h.done:
				h.rdb.ClearProcessState(h.ps)
				h.logger.Info("Heartbeater done")
				return
			case <-time.After(h.interval):
				h.beat()
			}
		}
	}()
}

func (h *heartbeater) beat() {
	// Note: Set TTL to be long enough so that it won't expire before we write again
	// and short enough to expire quickly once the process is shut down or killed.
	err := h.rdb.WriteProcessState(h.ps, h.interval*2)
	if err != nil {
		h.logger.Error("could not write heartbeat data: %v", err)
	}
}