Rename Constant FailurePolicy delay to interval

Signed-off-by: joshvanl <[email protected]>
diagridio · Oct 14, 2024 · 4509ffa · 4509ffa
1 parent 2f44665
commit 4509ffa
Show file tree

Hide file tree

Showing 11 changed files with 80 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -73,9 +73,9 @@ A Job itself is made up of the following fields:
   Optional.
 - `FailurePolicy` Controls whether the Job should be retired if the trigger
   function returns false. `Drop` doesn't retry the job, `Constant `Constant` will
-  constantly retry the job trigger for a configurable delay, up to a configurable
+  constantly retry the job trigger for a configurable internal, up to a configurable
   maximum number of retries (which could be infinite). By default, Jobs have a
-  `Constant` policy, with a 1s delay and 3 maximum retries.
+  `Constant` policy, with a 1s interval and 3 maximum retries.
 
 A job must have *at least* either a `Schedule` or a `DueTime` set.
 

diff --git a/api/failurepolicy.pb.go b/api/failurepolicy.pb.go
diff --git a/api/job.pb.go b/api/job.pb.go
diff --git a/cron/cron_test.go b/cron/cron_test.go
@@ -538,7 +538,7 @@ func Test_jobWithSpace(t *testing.T) {
 func Test_FailurePolicy(t *testing.T) {
 	t.Parallel()
 
-	t.Run("default policy should retry 3 times with a 1sec delay", func(t *testing.T) {
+	t.Run("default policy should retry 3 times with a 1sec interval", func(t *testing.T) {
 		t.Parallel()
 
 		gotCh := make(chan *api.TriggerRequest, 1)
@@ -641,7 +641,7 @@ func Test_FailurePolicy(t *testing.T) {
 			FailurePolicy: &api.FailurePolicy{
 				Policy: &api.FailurePolicy_Constant{
 					Constant: &api.FailurePolicyConstant{
-						Delay: durationpb.New(time.Millisecond), MaxRetries: ptr.Of(uint32(1)),
+						Interval: durationpb.New(time.Millisecond), MaxRetries: ptr.Of(uint32(1)),
 					},
 				},
 			},
@@ -685,7 +685,7 @@ func Test_FailurePolicy(t *testing.T) {
 			FailurePolicy: &api.FailurePolicy{
 				Policy: &api.FailurePolicy_Constant{
 					Constant: &api.FailurePolicyConstant{
-						Delay: durationpb.New(time.Millisecond),
+						Interval: durationpb.New(time.Millisecond),
 					},
 				},
 			},

diff --git a/internal/api/api_test.go b/internal/api/api_test.go
@@ -48,7 +48,7 @@ func Test_CRUD(t *testing.T) {
 		DueTime: ptr.Of(now.Add(time.Hour).Format(time.RFC3339)),
 		FailurePolicy: &cronapi.FailurePolicy{Policy: &cronapi.FailurePolicy_Constant{
 			Constant: &cronapi.FailurePolicyConstant{
-				Delay: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
+				Interval: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
 			},
 		}},
 	}, resp)
@@ -58,7 +58,7 @@ func Test_CRUD(t *testing.T) {
 		DueTime: ptr.Of(newNow.Add(time.Hour).Format(time.RFC3339)),
 		FailurePolicy: &cronapi.FailurePolicy{Policy: &cronapi.FailurePolicy_Constant{
 			Constant: &cronapi.FailurePolicyConstant{
-				Delay: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
+				Interval: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
 			},
 		}},
 	}))
@@ -68,7 +68,7 @@ func Test_CRUD(t *testing.T) {
 		DueTime: ptr.Of(newNow.Add(time.Hour).Format(time.RFC3339)),
 		FailurePolicy: &cronapi.FailurePolicy{Policy: &cronapi.FailurePolicy_Constant{
 			Constant: &cronapi.FailurePolicyConstant{
-				Delay: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
+				Interval: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
 			},
 		}},
 	}, resp)
@@ -83,7 +83,7 @@ func Test_CRUD(t *testing.T) {
 		DueTime: ptr.Of(now.Add(time.Hour).Format(time.RFC3339)),
 		FailurePolicy: &cronapi.FailurePolicy{Policy: &cronapi.FailurePolicy_Constant{
 			Constant: &cronapi.FailurePolicyConstant{
-				Delay: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
+				Interval: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
 			},
 		}},
 	}))
@@ -94,7 +94,7 @@ func Test_CRUD(t *testing.T) {
 		DueTime: ptr.Of(now.Add(time.Hour).Format(time.RFC3339)),
 		FailurePolicy: &cronapi.FailurePolicy{Policy: &cronapi.FailurePolicy_Constant{
 			Constant: &cronapi.FailurePolicyConstant{
-				Delay: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
+				Interval: durationpb.New(time.Second), MaxRetries: ptr.Of(uint32(3)),
 			},
 		}},
 	}, resp)

diff --git a/internal/counter/counter.go b/internal/counter/counter.go
@@ -234,7 +234,7 @@ func (c *Counter) policyTryAgain() bool {
 		//nolint:protogetter
 		tryAgain := p.Constant.MaxRetries == nil || *p.Constant.MaxRetries >= c.count.Attempts
 		if tryAgain {
-			c.next = c.next.Add(p.Constant.GetDelay().AsDuration())
+			c.next = c.next.Add(p.Constant.GetInterval().AsDuration())
 		} else {
 			// We set the LastTrigger to the first attempt to ensure consistency of
 			// the Job schedule, regardless of the failure policy cadence and