-
Notifications
You must be signed in to change notification settings - Fork 6
/
scheduler.go
480 lines (411 loc) · 15.5 KB
/
scheduler.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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
package worker
import (
"context"
"errors"
"fmt"
"log/slog"
"sort"
"time"
"github.com/calvinmclean/automated-garden/garden-app/pkg"
"github.com/calvinmclean/automated-garden/garden-app/pkg/action"
"github.com/go-co-op/gocron"
)
const (
lightInterval = 24 * time.Hour
adhocTag = "ADHOC"
)
// sortableJobs is a type that makes a slice of gocron Jobs sortable
type sortableJobs []*gocron.Job
func (jobs sortableJobs) Len() int {
return len(jobs)
}
func (jobs sortableJobs) Less(i, j int) bool {
return jobs[i].NextRun().Before(jobs[j].NextRun())
}
// Swap swaps the elements with indexes i and j.
func (jobs sortableJobs) Swap(i, j int) {
jobs[i], jobs[j] = jobs[j], jobs[i]
}
// ScheduleWaterAction will schedule water actions for the Zone based off the CreatedAt date,
// WaterSchedule time, and Interval. The scheduled Job is tagged with the Zone's ID so it can
// easily be removed
func (w *Worker) ScheduleWaterAction(waterSchedule *pkg.WaterSchedule) error {
logger := w.contextLogger(nil, nil, waterSchedule)
logger.Info("creating scheduled Job for WaterSchedule")
// Schedule the WaterAction execution
scheduleJobsGauge.WithLabelValues(waterScheduleLabels(waterSchedule)...).Inc()
_, err := waterSchedule.Interval.SchedulerFunc(w.scheduler).
StartAt(*waterSchedule.StartTime).
Tag("water_schedule").
Tag(waterSchedule.ID.String()).
Do(func(jobLogger *slog.Logger) {
// Get WaterSchedule from storage in case the ActivePeriod or WeatherControl are changed
ws, err := w.storageClient.WaterSchedules.Get(context.Background(), waterSchedule.ID.String())
if err != nil {
jobLogger.Error("error getting WaterSchedule when executing scheduled Job", "error", err)
schedulerErrors.WithLabelValues(waterScheduleLabels(waterSchedule)...).Inc()
return
}
if ws == nil {
jobLogger.Error("WaterSchedule not found")
schedulerErrors.WithLabelValues(waterScheduleLabels(waterSchedule)...).Inc()
return
}
if !ws.IsActive(time.Now()) {
jobLogger.Info("skipping WaterSchedule because current time is outside of ActivePeriod", "active_period", *ws.ActivePeriod)
return
}
zonesAndGardens, err := w.storageClient.GetZonesUsingWaterSchedule(ws.ID.String())
if err != nil {
jobLogger.Error("error getting Zones for WaterSchedule when executing scheduled Job", "error", err)
schedulerErrors.WithLabelValues(waterScheduleLabels(ws)...).Inc()
return
}
for _, zg := range zonesAndGardens {
err = w.ExecuteScheduledWaterAction(zg.Garden, zg.Zone, ws)
if err != nil {
jobLogger.Error("error executing scheduled water action", "error", err, "zone_id", zg.Zone.ID.String())
schedulerErrors.WithLabelValues(zoneLabels(zg.Zone)...).Inc()
}
}
}, logger.With("source", "scheduled_job"))
return err
}
// ResetWaterSchedule will simply remove the existing Job and create a new one
func (w *Worker) ResetWaterSchedule(ws *pkg.WaterSchedule) error {
logger := w.contextLogger(nil, nil, ws)
logger.Debug("resetting WaterSchedule")
if err := w.RemoveJobsByID(ws.ID.String()); err != nil {
return err
}
return w.ScheduleWaterAction(ws)
}
// GetNextActiveWaterSchedule determines the WaterSchedule that is going to be used for the next watering time
func (w *Worker) GetNextActiveWaterSchedule(waterSchedules []*pkg.WaterSchedule) *pkg.WaterSchedule {
w.logger.Debug("getting next water schedule for water_schedules", "water_schedules", waterSchedules)
type nextRunData struct {
ws *pkg.WaterSchedule
nextRun *time.Time
}
nextRuns := []nextRunData{}
for _, ws := range waterSchedules {
nextWaterTime := w.GetNextWaterTime(ws)
if nextWaterTime == nil {
continue
}
if !ws.IsActive(*nextWaterTime) {
continue
}
nextRuns = append(nextRuns, nextRunData{
ws: ws,
nextRun: nextWaterTime,
})
}
if len(nextRuns) == 0 {
return nil
}
nextRun := nextRuns[0]
for i := 1; i < len(nextRuns); i++ {
if nextRuns[i].nextRun.Before(*nextRun.nextRun) {
nextRun = nextRuns[i]
}
}
return nextRun.ws
}
// GetNextWaterTime determines the next scheduled watering time for a given Zone using tags
func (w *Worker) GetNextWaterTime(ws *pkg.WaterSchedule) *time.Time {
if ws == nil {
return nil
}
logger := w.contextLogger(nil, nil, ws)
logger.Debug("getting next water time for water_schedule")
for _, job := range w.scheduler.Jobs() {
for _, tag := range job.Tags() {
if tag == ws.ID.String() {
result := job.NextRun()
return &result
}
}
}
return nil
}
// ScheduleLightActions will schedule LightActions to turn the light on and off based off the CreatedAt date,
// LightSchedule time, and Interval. The scheduled Jobs are tagged with the Garden's ID so they can
// easily be removed
func (w *Worker) ScheduleLightActions(g *pkg.Garden) error {
logger := w.contextLogger(g, nil, nil)
logger.Info("creating scheduled Jobs for lighting Garden", "light_schedule", *g.LightSchedule)
// Parse Gardens's LightSchedule.Time (has no "date")
lightTime, err := time.Parse(pkg.LightTimeFormat, g.LightSchedule.StartTime)
if err != nil {
return err
}
now := time.Now().In(lightTime.Location())
// Create onStartDate using the CreatedAt date with the WaterSchedule's timestamp
onStartDate := time.Date(
now.Year(),
now.Month(),
now.Day(),
lightTime.Hour(),
lightTime.Minute(),
lightTime.Second(),
0,
lightTime.Location(),
)
offStartDate := onStartDate.Add(g.LightSchedule.Duration.Duration)
// Schedule the LightAction execution for ON and OFF
scheduleJobsGauge.WithLabelValues(gardenLabels(g)...).Add(2)
onAction := &action.LightAction{State: pkg.LightStateOn}
offAction := &action.LightAction{State: pkg.LightStateOff}
_, err = w.scheduler.
Every(lightInterval).
StartAt(onStartDate).
Tag("garden").
Tag(g.ID.String()).
Tag(pkg.LightStateOn.String()).
Do(w.executeLightActionInScheduledJob, g, onAction, logger.With("source", "scheduled_job"))
if err != nil {
return err
}
_, err = w.scheduler.
Every(lightInterval).
StartAt(offStartDate).
Tag("garden").
Tag(g.ID.String()).
Tag(pkg.LightStateOff.String()).
Do(w.executeLightActionInScheduledJob, g, offAction, logger.With("source", "scheduled_job"))
if err != nil {
return err
}
// If AdhocOnTime is defined (and is in the future), schedule it
if g.LightSchedule.AdhocOnTime != nil {
logger.Debug("garden has adhoc ON time", "adhoc_on_time", g.LightSchedule.AdhocOnTime)
// If AdhocOnTime is in the past, reset it and return
if g.LightSchedule.AdhocOnTime.Before(time.Now()) {
logger.Debug("adhoc ON time is in the past and is being removed")
g.LightSchedule.AdhocOnTime = nil
return w.storageClient.Gardens.Set(context.Background(), g)
}
nextOnJob, err := w.getNextLightJob(g, pkg.LightStateOn, false)
if err != nil {
return err
}
// If nextOnTime is before AdhocOnTime, delay it by 24 hours
nextOnTime := nextOnJob.NextRun()
logger.Debug("garden's next ON time", "next_on_time", nextOnTime)
if nextOnTime.Before(*g.LightSchedule.AdhocOnTime) {
logger.Debug("next ON time is before the adhoc time, so delaying it by 24 hours")
_, err = w.scheduler.Job(nextOnJob).StartAt(nextOnTime.Add(lightInterval)).Update()
if err != nil {
return fmt.Errorf("error rescheduling next on job: %w", err)
}
}
// Schedule one-time watering
if err = w.scheduleAdhocLightAction(g); err != nil {
return fmt.Errorf("error scheduling ad-hoc light action: %w", err)
}
logger.Debug("successfully scheduled adhoc ON time")
}
return nil
}
// ResetLightSchedule will simply remove the existing Job and create a new one
func (w *Worker) ResetLightSchedule(g *pkg.Garden) error {
logger := w.contextLogger(g, nil, nil)
logger.Debug("resetting LightSchedule")
if err := w.RemoveJobsByID(g.ID.String()); err != nil {
return err
}
return w.ScheduleLightActions(g)
}
// GetNextLightTime returns the next time that the Garden's light will be turned to the specified state
func (w *Worker) GetNextLightTime(g *pkg.Garden, state pkg.LightState) *time.Time {
logger := w.contextLogger(g, nil, nil)
logger.Debug("getting next light time for state", "state", state.String())
nextJob, err := w.getNextLightJob(g, state, true)
if err != nil {
return nil
}
nextRun := nextJob.NextRun()
return &nextRun
}
// ScheduleLightDelay handles a LightAction that requests delaying turning a light on
func (w *Worker) ScheduleLightDelay(g *pkg.Garden, input *action.LightAction) error {
logger := w.contextLogger(g, nil, nil)
logger.Info("scheduling light delay", "input", *input)
// Only allow when action state is OFF
if input.State != pkg.LightStateOff {
return errors.New("unable to use delay when state is not OFF")
}
// Don't allow delaying longer than LightSchedule.Duration
if input.ForDuration.Duration > g.LightSchedule.Duration.Duration {
return errors.New("unable to execute delay that lasts longer than light_schedule")
}
nextOnTime := w.GetNextLightTime(g, pkg.LightStateOn)
if nextOnTime == nil {
return errors.New("unable to get next light-on time")
}
logger.Debug("found next ON time", "next_on_time", *nextOnTime)
nextOffTime := w.GetNextLightTime(g, pkg.LightStateOff)
if nextOffTime == nil {
return errors.New("unable to get next light-off time")
}
logger.Debug("found next OFF time", "next_off_time", *nextOffTime)
var adhocTime time.Time
// If nextOffTime is before nextOnTime, then the light was probably ON and we need to schedule now + delay to turn back on.
// No need to change any schedules
if nextOffTime.Before(*nextOnTime) {
logger.Debug("next OFF time is before next ON time; setting schedule to turn light back on", "duration", input.ForDuration.Duration)
now := time.Now()
// Don't allow a delayDuration that will occur after nextOffTime
if nextOffTime.Before(now.Add(input.ForDuration.Duration)) {
return errors.New("unable to schedule delay that extends past the light turning back on")
}
adhocTime = now.Add(input.ForDuration.Duration)
} else {
// If nextOffTime is after nextOnTime, then light was not ON yet and we need to reschedule the regular ON time
// and schedule nextOnTime + delay
logger.Debug("next OFF time is after next ON time; delaying next ON time", "duration", input.ForDuration.Duration)
nextOnJob, err := w.getNextLightJob(g, pkg.LightStateOn, false)
if err != nil {
return err
}
logger.Debug("found next ON Job and rescheduling in 24 hours")
_, err = w.scheduler.Job(nextOnJob).StartAt(nextOnJob.NextRun().Add(lightInterval)).Update()
if err != nil {
return fmt.Errorf("error rescheduling next on job: %w", err)
}
// Add new ON schedule with action.Light.ForDuration that executes once
adhocTime = nextOnTime.Add(input.ForDuration.Duration)
}
logger.Debug("saving adhoc on time to Garden: %v", "adhoc_on_time", adhocTime)
// Add new lightSchedule with AdhocTime and Save Garden
g.LightSchedule.AdhocOnTime = &adhocTime
err := w.scheduleAdhocLightAction(g)
if err != nil {
return fmt.Errorf("error scheduling ad-hoc light action: %w", err)
}
return w.storageClient.Gardens.Set(context.Background(), g)
}
// RemoveJobsByID will remove Jobs tagged with the specific xid
func (w *Worker) RemoveJobsByID(id string) error {
jobs, err := w.scheduler.FindJobsByTag(id)
if err != nil && !errors.Is(err, gocron.ErrJobNotFoundWithTag) {
return err
}
// Remove Jobs from metric
for _, j := range jobs {
scheduleJobsGauge.WithLabelValues(j.Tags()[0:2]...).Dec()
}
if err := w.scheduler.RemoveByTags(id); err != nil && !errors.Is(err, gocron.ErrJobNotFoundWithTag) {
return err
}
return nil
}
// getNextLightJob returns the next Job tagged with the gardenID and state. If allowAdhoc is true, return whichever job is soonest,
// otherwise return the first non-adhoc Job
func (w *Worker) getNextLightJob(g *pkg.Garden, state pkg.LightState, allowAdhoc bool) (*gocron.Job, error) {
logger := w.contextLogger(g, nil, nil)
logger.Debug("getting next light Job for state", "state", state, "allow_ad_hoc", allowAdhoc)
jobs, err := w.scheduler.FindJobsByTag(g.ID.String(), state.String())
if err != nil {
return nil, err
}
sort.Sort(sortableJobs(jobs))
if allowAdhoc {
logger.Debug("found light jobs, returning the first one", "count", len(jobs))
return jobs[0], nil
}
logger.Debug("found light jobs and now checking to remove any adhoc jobs", "count", len(jobs))
for _, j := range jobs {
isAdhoc := false
for _, tag := range j.Tags() {
if tag == adhocTag {
isAdhoc = true
break
}
}
if !isAdhoc {
return j, nil
}
}
return nil, fmt.Errorf("unable to find next %s Job for Garden %s", state.String(), g.ID.String())
}
// scheduleAdhocLightAction schedules a one-time action to turn a light on based on the LightSchedule.AdhocOnTime
func (w *Worker) scheduleAdhocLightAction(g *pkg.Garden) error {
logger := w.contextLogger(g, nil, nil)
logger.Info("creating one-time scheduled Job for lighting Garden")
if g.LightSchedule.AdhocOnTime == nil {
return errors.New("unable to schedule adhoc light schedule without LightSchedule.AdhocOnTime")
}
// Remove existing adhoc Jobs for this Garden
if err := w.scheduler.RemoveByTags(g.ID.String(), adhocTag); err != nil && !errors.Is(err, gocron.ErrJobNotFoundWithTag) {
return err
}
logger.Debug("removed existing adhoc light Jobs")
executeLightAction := func(a *action.LightAction, actionLogger *slog.Logger) {
scheduleJobsGauge.WithLabelValues(gardenLabels(g)...).Dec()
actionLogger = actionLogger.With(
"state", a.State.String(),
"adhoc", "true",
)
actionLogger.Info("executing adhoc LightAction with state")
err := w.ExecuteLightAction(g, a)
if err != nil {
actionLogger.Error("error executing scheduled adhoc LightAction", "error", err)
}
actionLogger.Debug("removing AdhocOnTime")
// Now set AdhocOnTime to nil and save
g.LightSchedule.AdhocOnTime = nil
err = w.storageClient.Gardens.Set(context.Background(), g)
if err != nil {
actionLogger.Error("error saving Garden after removing AdhocOnTime", "error", err)
schedulerErrors.WithLabelValues(gardenLabels(g)...).Inc()
}
}
// Schedule the LightAction execution for ON and OFF
scheduleJobsGauge.WithLabelValues(gardenLabels(g)...).Inc()
onAction := &action.LightAction{State: pkg.LightStateOn}
_, err := w.scheduler.
Every(1).Day(). // Every is required even though it's not needed for this Job
At(*g.LightSchedule.AdhocOnTime).
LimitRunsTo(1).
StartAt(*g.LightSchedule.AdhocOnTime).
WaitForSchedule().
Tag("garden").
Tag(g.ID.String()).
Tag(pkg.LightStateOn.String()).
Tag(adhocTag).
Do(executeLightAction, onAction, logger.With("source", "scheduled_job"))
return err
}
func (w *Worker) contextLogger(g *pkg.Garden, z *pkg.Zone, ws *pkg.WaterSchedule) *slog.Logger {
logger := w.logger.With()
if g != nil {
logger = logger.With("garden_id", g.ID.String())
}
if z != nil {
logger = logger.With("zone_id", z.ID.String())
}
if ws != nil {
logger = logger.With("water_schedule_id", ws.ID.String())
}
return logger
}
func zoneLabels(z *pkg.Zone) []string {
return []string{"zone", z.ID.String()}
}
func gardenLabels(g *pkg.Garden) []string {
return []string{"garden", g.ID.String()}
}
func waterScheduleLabels(ws *pkg.WaterSchedule) []string {
return []string{"water_schedule", ws.ID.String()}
}
func (w *Worker) executeLightActionInScheduledJob(g *pkg.Garden, input *action.LightAction, actionLogger *slog.Logger) {
actionLogger = actionLogger.With("state", input.State.String())
actionLogger.Info("executing LightAction")
err := w.ExecuteLightAction(g, input)
if err != nil {
actionLogger.Error("error executing scheduled LightAction", "error", err)
schedulerErrors.WithLabelValues(gardenLabels(g)...).Inc()
}
}