scheduler

Install

togo install togo-framework/scheduler

scheduler is the togo answer to Laravel's Scheduler / Celery Beat / Rails recurring jobs. Register a job once, schedule it with a cron expression or a fluent helper, and the scheduler dispatches it over the kernel Queue on time — with overlap prevention and run history built in.

How it works

• Register a named job handler (scheduler.Register).
• Schedule it with a cron expression or a helper (Service.Schedule).
• On each tick the job is dispatched onto the togo Queue so the work runs on a worker, not the cron goroutine. With no queue configured it runs inline.
• A job whose previous run is still in flight is skipped (overlap prevention) and recorded as skipped.
• Every run is recorded (done / failed / skipped) and panics are recovered into errors.

Usage

package jobs

import (
	"context"

	"github.com/togo-framework/scheduler"
	"github.com/togo-framework/togo"
)

func init() {
	// 1. Register handlers (from any plugin's init() or Boot).
	scheduler.Register("cleanup", func(ctx context.Context) error {
		return purgeExpired(ctx)
	})
	scheduler.Register("digest", func(ctx context.Context) error {
		return sendDailyDigest(ctx)
	})
}

// 2. Schedule them once the kernel is booted.
func Schedule(k *togo.Kernel) {
	s, ok := scheduler.FromKernel(k)
	if !ok {
		return
	}
	s.Schedule("cleanup", scheduler.EveryFiveMinutes) // "*/5 * * * *"
	s.Schedule("digest", scheduler.DailyAt(9, 0))     // 09:00 every day
}

Cadence helpers

Any standard 5-field cron expression or robfig macro (@hourly, @every 1h30m, …) works too.

Managing schedules

s.Pause("digest")                       // stop firing (keeps the schedule)
s.Resume("digest")
s.Trigger(ctx, "cleanup")               // run now, ad-hoc
s.Unschedule("cleanup")                 // remove the schedule
jobs := s.Jobs()                        // []ScheduledJob{name, spec, paused}
runs := s.Runs()                        // recent run history (done/failed/skipped)

Configuration

No required env. The scheduler uses the kernel Queue when present (install togo install togo-framework/queue + a worker) so jobs run off-request; otherwise jobs run inline on the cron goroutine.