Files
tasks/common/backoff/cron.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

74 lines
2.2 KiB
Go

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
}