-
Notifications
You must be signed in to change notification settings - Fork 769
/
cron.go
98 lines (86 loc) · 3.44 KB
/
cron.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package backoff
import (
"time"
"github.com/robfig/cron/v3"
"go.temporal.io/api/serviceerror"
"go.temporal.io/server/common/convert"
)
// NoBackoff is used to represent backoff when no cron backoff is needed
const NoBackoff = time.Duration(-1)
// ValidateSchedule validates a cron schedule spec
func ValidateSchedule(cronSchedule string) error {
if cronSchedule == "" {
return nil
}
schedule, err := cron.ParseStandard(cronSchedule)
if err != nil {
return serviceerror.NewInvalidArgument("invalid CronSchedule.")
}
nextTime := schedule.Next(time.Now().UTC())
if nextTime.IsZero() {
// no time can be found to satisfy the schedule
return serviceerror.NewInvalidArgument("invalid CronSchedule, no time can be found to satisfy the schedule")
}
return nil
}
// GetBackoffForNextSchedule calculates the backoff time for the next run given
// a cronSchedule, current scheduled time, and now.
func GetBackoffForNextSchedule(cronSchedule string, scheduledTime time.Time, now time.Time) time.Duration {
if len(cronSchedule) == 0 {
return NoBackoff
}
schedule, err := cron.ParseStandard(cronSchedule)
if err != nil {
return NoBackoff
}
scheduledUTCTime := scheduledTime.UTC()
nowUTC := now.UTC()
var nextScheduleTime time.Time
if nowUTC.Before(scheduledUTCTime) {
nextScheduleTime = scheduledUTCTime
} else {
nextScheduleTime = schedule.Next(scheduledUTCTime)
// Calculate the next schedule start time which is nearest to now (right after now).
for !nextScheduleTime.IsZero() && nextScheduleTime.Before(nowUTC) {
nextScheduleTime = schedule.Next(nextScheduleTime)
}
}
if nextScheduleTime.IsZero() {
// no time can be found to satisfy the schedule
return NoBackoff
}
backoffInterval := nextScheduleTime.Sub(nowUTC)
roundedInterval := time.Second * time.Duration(convert.Int64Ceil(backoffInterval.Seconds()))
return roundedInterval
}
// GetBackoffForNextScheduleNonNegative calculates the backoff time and ensures a non-negative duration.
func GetBackoffForNextScheduleNonNegative(cronSchedule string, scheduledTime time.Time, now time.Time) *time.Duration {
backoffDuration := GetBackoffForNextSchedule(cronSchedule, scheduledTime, now)
if backoffDuration == NoBackoff || backoffDuration < 0 {
backoffDuration = 0
}
return &backoffDuration
}