Merge pull request #108 from fmotalleb/debuncer

feat: debouncer support (per-job)

Author: fmotalleb

config.local.yaml

@@ -4,8 +4,9 @@
 jobs:
   - name: echo
     concurrency: 3
+    debounce: 5s
     tasks:
-      - command: echo $env.t{{ .Vars.name }}
+      - command: echo {{ .Vars.name }}
         retry-delay: 1s
         retries: 0
         retry-jitter: 1s

config/config.go

@@ -23,13 +23,14 @@ type Config struct {
 
 // JobConfig represents the configuration for a specific job.
 type JobConfig struct {
-	Name        string     `mapstructure:"name" json:"name,omitempty"`
-	Description string     `mapstructure:"description" json:"description,omitempty"`
-	Disabled    bool       `mapstructure:"disabled" json:"disabled,omitempty"`
-	Concurrency uint       `mapstructure:"concurrency" json:"concurrency,omitempty"`
-	Tasks       []Task     `mapstructure:"tasks" json:"tasks,omitempty"`
-	Events      []JobEvent `mapstructure:"events" json:"events"`
-	Hooks       JobHooks   `mapstructure:"hooks" json:"hooks,omitempty"`
+	Name        string        `mapstructure:"name" json:"name,omitempty"`
+	Description string        `mapstructure:"description" json:"description,omitempty"`
+	Disabled    bool          `mapstructure:"disabled" json:"disabled,omitempty"`
+	Concurrency uint          `mapstructure:"concurrency" json:"concurrency,omitempty"`
+	Tasks       []Task        `mapstructure:"tasks" json:"tasks,omitempty"`
+	Events      []JobEvent    `mapstructure:"events" json:"events"`
+	Hooks       JobHooks      `mapstructure:"hooks" json:"hooks,omitempty"`
+	Debounce    time.Duration `mapstructure:"debounce" json:"debounce,omitempty"`
 }
 
 // JobEvent represents the scheduling configuration for a job.

core/jobs/runner.go

@@ -5,6 +5,8 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	"go.uber.org/zap"
 
+	"github.com/fmotalleb/go-tools/debouncer"
+
 	"github.com/fmotalleb/crontab-go/abstraction"
 	"github.com/fmotalleb/crontab-go/config"
 	"github.com/fmotalleb/crontab-go/core/concurrency"
@@ -34,7 +36,10 @@ func InitializeJobs(jobs []*config.JobConfig) {
 		if err := job.Validate(logger.Named("Validator")); err != nil {
 			log.Panic("failed to validate job", zap.String("job", job.Name), zap.Error(err))
 		}
-		signal := signals.NewSync[abstraction.Event]()
+		var signal abstraction.EventDispatcher = signals.NewSync[abstraction.Event]()
+		if job.Debounce > 0 {
+			signal = debouncer.NewDebouncedSignal(signal, job.Debounce)
+		}
 		global.CountSignals(signal,
 			"events",
 			"amount of events dispatched for this job",

go.mod

@@ -11,7 +11,7 @@ tool (
 require (
 	github.com/alecthomas/assert/v2 v2.11.0
 	github.com/docker/docker v28.5.2+incompatible
-	github.com/fmotalleb/go-tools v0.1.55
+	github.com/fmotalleb/go-tools v0.1.56
 	github.com/joho/godotenv v1.5.1
 	github.com/labstack/echo/v4 v4.13.4
 	github.com/maniartech/signals v1.3.1

go.sum

@@ -120,8 +120,8 @@ github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2
 github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/firefart/nonamedreturns v1.0.5 h1:tM+Me2ZaXs8tfdDw3X6DOX++wMCOqzYUho6tUTYIdRA=
 github.com/firefart/nonamedreturns v1.0.5/go.mod h1:gHJjDqhGM4WyPt639SOZs+G89Ko7QKH5R5BhnO6xJhw=
-github.com/fmotalleb/go-tools v0.1.55 h1:N+ixt/1HUG2QIzlAVDx8rNSi+rm4u6Ixxps2vIqlSlo=
-github.com/fmotalleb/go-tools v0.1.55/go.mod h1:r2cMGeVPNSHh491qpXo1gLnYQgrvIN8Wh5eak9nDV+A=
+github.com/fmotalleb/go-tools v0.1.56 h1:pDsl2YMdcy4IxSqE3NTFiHLvUyDNIOvVc4E8CFUCJOQ=
+github.com/fmotalleb/go-tools v0.1.56/go.mod h1:AT8piibVXbHZ4jMyx750eTKDOZd+W5aEDsntPeyIA+Y=
 github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
 github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
 github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k=

schema.json

@@ -38,6 +38,14 @@
           "type": "boolean",
           "description": "An optional boolean that indicates whether the job is disabled or not."
         },
+        "debounce": {
+          "type": "string",
+          "description": "Debounce duration. Every new event is dispatched immediately, and an event is guaranteed after the debounce interval elapses.",
+          "examples": [
+            "1s",
+            "10m"
+          ]
+        },
         "tasks": {
           "type": "array",
           "items": {