Updated used cron library to version 3

Author: Julius Bachnick

CHANGELOG.md

@@ -5,7 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- Nothing so far
+- Updated the used cron library to version 3
 
 ## [v1.0.0] - 2020-02-28
 - Use error wrapping of standard library instead of github.com/pkg/errors

README.md

@@ -45,6 +45,9 @@ func main() {
 		// emit your own custom event every day at 09:00
 		cron.ScheduleEvent("0 9 * * *", MyEvent{}), 
 
+		// emit your own custom event every day at 09:00:30
+		cron.ScheduleEvent("30 0 9 * * *", MyEvent{}),
+
 		// cron expressions can be hard to read and might be overkill
 		cron.ScheduleEventEvery(time.Hour, MyEvent{}), 
 

go.mod

@@ -5,6 +5,7 @@ go 1.14
 require (
 	github.com/go-joe/joe v0.6.0
 	github.com/robfig/cron v0.0.0-20180505203441-b41be1df6967
+	github.com/robfig/cron/v3 v3.0.0
 	github.com/stretchr/testify v1.3.0
 	go.uber.org/zap v1.9.1
 )

go.sum

@@ -8,6 +8,11 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/robfig/cron v0.0.0-20180505203441-b41be1df6967 h1:x7xEyJDP7Hv3LVgvWhzioQqbC/KtuUhTigKlH/8ehhE=
 github.com/robfig/cron v0.0.0-20180505203441-b41be1df6967/go.mod h1:JGuDeoQd7Z6yL4zQhZ3OPEVHB7fL6Ka6skscFHfmt2k=
+github.com/robfig/cron v1.2.0 h1:ZjScXvvxeQ63Dbyxy76Fj3AT3Ut0aKsyd2/tl3DTMuQ=
+github.com/robfig/cron/v3 v3.0.0 h1:kQ6Cb7aHOHTSzNVNEhmp8EcWKLb4CbiMW9h9VyIhO4E=
+github.com/robfig/cron/v3 v3.0.0/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
+github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
+github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=

module.go

@@ -9,10 +9,15 @@ import (
 	"time"
 
 	"github.com/go-joe/joe"
-	"github.com/robfig/cron"
+	"github.com/robfig/cron/v3"
 	"go.uber.org/zap"
 )
 
+// defaultParser accepts standard cron schedules with optional seconds.
+var defaultParser = cron.NewParser(
+	cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
+)
+
 // A Job is a joe.Module that runs a single cron job on a given interval.
 type Job struct {
 	cron     *cron.Cron
@@ -42,7 +47,7 @@ func ScheduleEvent(schedule string, events ...interface{}) *Job {
 		events = []interface{}{Event{}}
 	}
 
-	s, err := cron.Parse(schedule)
+	s, err := defaultParser.Parse(schedule)
 	if err != nil {
 		err = fmt.Errorf("invalid cron schedule: %w", err)
 	}
@@ -63,11 +68,13 @@ func ScheduleEvent(schedule string, events ...interface{}) *Job {
 }
 
 // ScheduleFunc creates a joe.Module that runs the given function on a given
-// cron schedule (e.g. "0 0 * * *"). If the passed schedule is not a valid cron
+// cron schedule (e.g. "0 0 * * *"). Optionally, the cron schedule can also
+// contain seconds, i.e. "30 0 0 * * *".
+// If the passed schedule is not a valid cron
 // schedule as accepted by https://godoc.org/github.com/robfig/cron the error
 // will be returned when the bot is started.
 func ScheduleFunc(schedule string, fun func()) *Job {
-	s, err := cron.Parse(schedule)
+	s, err := defaultParser.Parse(schedule)
 	if err != nil {
 		err = fmt.Errorf("invalid cron schedule: %w", err)
 	}
@@ -162,8 +169,13 @@ func (j *Job) Start(logger *zap.Logger, events joe.EventEmitter) error {
 	)
 
 	job := j.fun(events)
-	j.cron = cron.New()
-	j.cron.ErrorLog, _ = zap.NewStdLogAt(logger, zap.ErrorLevel)
+	cronLogger, _ := zap.NewStdLogAt(logger, zap.ErrorLevel)
+	j.cron = cron.New(
+		cron.WithParser(defaultParser),
+		cron.WithLogger(
+			cron.PrintfLogger(cronLogger),
+		),
+	)
 	j.cron.Schedule(j.schedule, job)
 	j.cron.Start()
 

module_test.go

@@ -214,7 +214,7 @@ func TestJob_InvalidSchedule(t *testing.T) {
 	job := cron.ScheduleEvent("foobar")
 
 	err := job.Start(logger, brain)
-	require.EqualError(t, err, "invalid cron schedule: Expected 5 to 6 fields, found 1: foobar")
+	require.EqualError(t, err, "invalid cron schedule: expected 5 to 6 fields, found 1: [foobar]")
 }
 
 func TestExampleSchedule(t *testing.T) {
@@ -284,7 +284,7 @@ func TestScheduleEvent_Error(t *testing.T) {
 	job := cron.ScheduleEvent("foobar")
 
 	err := job.Start(logger, brain)
-	require.EqualError(t, err, "invalid cron schedule: Expected 5 to 6 fields, found 1: foobar")
+	require.EqualError(t, err, "invalid cron schedule: expected 5 to 6 fields, found 1: [foobar]")
 
 	assert.NoError(t, job.Close())
 	brain.Finish()
@@ -299,7 +299,7 @@ func TestScheduleFunc_Error(t *testing.T) {
 	})
 
 	err := job.Start(logger, brain)
-	require.EqualError(t, err, "invalid cron schedule: Expected 5 to 6 fields, found 1: foobar")
+	require.EqualError(t, err, "invalid cron schedule: expected 5 to 6 fields, found 1: [foobar]")
 
 	assert.NoError(t, job.Close())
 	brain.Finish()