-
Notifications
You must be signed in to change notification settings - Fork 137
/
redis_scheduler.go
542 lines (510 loc) · 14.4 KB
/
redis_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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
package job
import (
"context"
"encoding/json"
"errors"
"fmt"
"strconv"
"strings"
"time"
"github.com/cozy/cozy-stack/model/permission"
"github.com/cozy/cozy-stack/pkg/consts"
"github.com/cozy/cozy-stack/pkg/couchdb"
"github.com/cozy/cozy-stack/pkg/limits"
"github.com/cozy/cozy-stack/pkg/logger"
"github.com/cozy/cozy-stack/pkg/prefixer"
"github.com/cozy/cozy-stack/pkg/realtime"
"github.com/go-redis/redis/v8"
"github.com/sirupsen/logrus"
)
// TriggersKey is the the key of the sorted set in redis used for triggers
// waiting to be activated
const TriggersKey = "triggers"
// SchedKey is the the key of the sorted set in redis used for triggers
// currently being executed
const SchedKey = "scheduling"
// pollInterval is the time interval between 2 redis polling
const pollInterval = 1 * time.Second
// eventLoopSize is the number of goroutines handling @events and triggering
// jobs.
const eventLoopSize = 50
// luaPoll returns the lua script used for polling triggers in redis.
// If a trigger is in the scheduling key for more than 10 seconds, it is
// an error and we can try again to schedule it.
const luaPoll = `
local w = KEYS[1] - 10
local s = redis.call("ZRANGEBYSCORE", "` + SchedKey + `", 0, w, "WITHSCORES", "LIMIT", 0, 1)
if #s > 0 then
redis.call("ZADD", "` + SchedKey + `", KEYS[1], s[1])
return s
end
local t = redis.call("ZRANGEBYSCORE", "` + TriggersKey + `", 0, KEYS[1], "WITHSCORES", "LIMIT", 0, 1)
if #t > 0 then
redis.call("ZREM", "` + TriggersKey + `", t[1])
redis.call("ZADD", "` + SchedKey + `", t[2], t[1])
end
return t`
// redisScheduler is a centralized scheduler of many triggers. It starts all of
// them and schedules jobs accordingly.
type redisScheduler struct {
broker Broker
client redis.UniversalClient
ctx context.Context
closed chan struct{}
stopped chan struct{}
log *logrus.Entry
}
// NewRedisScheduler creates a new scheduler that use redis to synchronize with
// other cozy-stack processes to schedule jobs.
func NewRedisScheduler(client redis.UniversalClient) Scheduler {
return &redisScheduler{
client: client,
ctx: context.Background(),
log: logger.WithNamespace("scheduler-redis"),
stopped: make(chan struct{}),
}
}
func redisKey(t Trigger) string {
return t.DBPrefix() + "/" + t.Infos().TID
}
func payloadKey(t Trigger) string {
return "payload-" + t.DBPrefix() + "/" + t.Infos().TID
}
func eventsKey(db prefixer.Prefixer) string {
return "events-" + db.DBPrefix()
}
// StartScheduler a goroutine that will fetch triggers in redis to schedule
// their jobs.
func (s *redisScheduler) StartScheduler(b Broker) error {
s.broker = b
s.closed = make(chan struct{})
s.startEventDispatcher()
go s.pollLoop()
return nil
}
func (s *redisScheduler) pollLoop() {
ticker := time.NewTicker(pollInterval)
for {
select {
case <-s.closed:
ticker.Stop()
s.stopped <- struct{}{}
return
case <-ticker.C:
now := time.Now().UTC().Unix()
if err := s.PollScheduler(now); err != nil {
s.log.Warnf("Failed to poll redis: %s", err)
}
}
}
}
func (s *redisScheduler) startEventDispatcher() {
eventsCh := make(chan *realtime.Event, 100)
go func() {
c := realtime.GetHub().SubscribeLocalAll()
defer func() {
c.Close()
close(eventsCh)
}()
for {
select {
case <-s.closed:
return
case event := <-c.Channel:
eventsCh <- event
}
}
}()
for i := 0; i < eventLoopSize; i++ {
go s.eventLoop(eventsCh)
}
}
func (s *redisScheduler) eventLoop(eventsCh <-chan *realtime.Event) {
for event := range eventsCh {
key := eventsKey(event)
m, err := s.client.HGetAll(s.ctx, key).Result()
if err != nil {
s.log.Errorf("Could not fetch redis set %s: %s",
key, err.Error())
continue
}
for triggerID, arguments := range m {
found := false
for _, args := range strings.Split(arguments, " ") {
rule, err := permission.UnmarshalRuleString(args)
if err != nil {
s.log.Warnf("Coud not unmarshal rule %s: %s",
key, err.Error())
continue
}
if eventMatchRule(event, &rule) {
found = true
break
}
}
if !found {
continue
}
t, err := s.GetTrigger(event, triggerID)
if err != nil {
s.log.Warnf("Could not fetch @event trigger %s %s: %s",
event.Domain, triggerID, err.Error())
continue
}
et := t.(*EventTrigger)
if et.Infos().Debounce != "" {
var d time.Duration
if d, err = time.ParseDuration(et.Infos().Debounce); err == nil {
timestamp := time.Now().Add(d)
s.client.ZAddNX(s.ctx, TriggersKey, &redis.Z{
Score: float64(timestamp.UTC().Unix()),
Member: redisKey(t),
})
continue
} else {
s.log.Warnf("Trigger %s %s has an invalid debounce: %s",
et.Infos().Domain, et.Infos().TID, et.Infos().Debounce)
continue
}
}
jobRequest, err := et.Infos().JobRequestWithEvent(event)
if err != nil {
s.log.Warnf("Could not encode realtime event %s %s: %s",
event.Domain, triggerID, err.Error())
continue
}
_, err = s.broker.PushJob(t, jobRequest)
if err != nil {
s.log.Warnf("Could not push job trigger by event %s %s: %s",
event.Domain, triggerID, err.Error())
continue
}
}
}
}
// fire is called when a webhook is fired.
func (s *redisScheduler) fire(trigger Trigger, request *JobRequest) {
infos := trigger.Infos()
if infos.Debounce == "" {
if _, err := s.broker.PushJob(trigger, request); err != nil {
s.log.Warnf("Could not push job trigger by webhook %s %s: %s",
infos.Domain, infos.TID, err.Error())
}
return
}
d, err := time.ParseDuration(infos.Debounce)
if err != nil {
s.log.Warnf("Trigger %s %s has an invalid debounce: %s",
infos.Domain, infos.TID, infos.Debounce)
}
timestamp := time.Now().Add(d)
pipe := s.client.Pipeline()
switch trigger.CombineRequest() {
case appendPayload:
pipe.RPush(s.ctx, payloadKey(trigger), string(request.Payload))
case keepOriginalRequest:
pipe.SetNX(s.ctx, payloadKey(trigger), string(request.Payload), 30*24*time.Hour)
}
pipe.ZAddNX(s.ctx, TriggersKey, &redis.Z{
Score: float64(timestamp.UTC().Unix()),
Member: redisKey(trigger),
})
if _, err := pipe.Exec(s.ctx); err != nil {
s.log.Warnf("Cannot fire trigger because of redis error: %s", err)
}
}
// ShutdownScheduler shuts down the the scheduling of triggers
func (s *redisScheduler) ShutdownScheduler(ctx context.Context) error {
if s.closed == nil {
return nil
}
fmt.Print(" shutting down redis scheduler...")
close(s.closed)
select {
case <-ctx.Done():
fmt.Println("failed: ", ctx.Err())
return ctx.Err()
case <-s.stopped:
fmt.Println("ok.")
}
return nil
}
// PollScheduler polls redis to see if there are some triggers ready.
func (s *redisScheduler) PollScheduler(now int64) error {
keys := []string{strconv.FormatInt(now, 10)}
for {
res, err := s.client.Eval(s.ctx, luaPoll, keys).Result()
if err != nil || res == nil {
return err
}
results, ok := res.([]interface{})
if !ok {
return errors.New("Unexpected response from redis")
}
if len(results) < 2 {
return nil
}
parts := strings.SplitN(results[0].(string), "/", 2)
if len(parts) != 2 {
s.client.ZRem(s.ctx, SchedKey, results[0])
return fmt.Errorf("Invalid key %s", res)
}
prefix := parts[0]
t, err := s.GetTrigger(prefixer.NewPrefixer("", prefix), parts[1])
if err != nil {
if err == ErrNotFoundTrigger || err == ErrMalformedTrigger {
s.client.ZRem(s.ctx, SchedKey, results[0])
}
return err
}
switch t := t.(type) {
case *EventTrigger, *WebhookTrigger: // Debounced
job := t.Infos().JobRequest()
job.Debounced = true
if err = s.client.ZRem(s.ctx, SchedKey, results[0]).Err(); err != nil {
return err
}
switch t.CombineRequest() {
case appendPayload:
pipe := s.client.Pipeline()
lrange := pipe.LRange(s.ctx, payloadKey(t), 0, -1)
pipe.Del(s.ctx, payloadKey(t))
if _, err := pipe.Exec(s.ctx); err == nil {
payloads := strings.Join(lrange.Val(), ",")
job.Payload = Payload(`{"payloads":[` + payloads + "]}")
}
case keepOriginalRequest:
pipe := s.client.Pipeline()
get := pipe.Get(s.ctx, payloadKey(t))
pipe.Del(s.ctx, payloadKey(t))
if _, err := pipe.Exec(s.ctx); err == nil {
job.Payload = Payload(get.Val())
}
}
if _, err = s.broker.PushJob(t, job); err != nil {
return err
}
case *AtTrigger:
job := t.Infos().JobRequest()
if _, err = s.broker.PushJob(t, job); err != nil {
if limits.IsLimitReachedOrExceeded(err) {
s.client.ZRem(s.ctx, SchedKey, results[0])
}
return err
}
if err = s.deleteTrigger(t); err != nil {
return err
}
case *CronTrigger:
job := t.Infos().JobRequest()
if _, err = s.broker.PushJob(t, job); err != nil {
// Remove the cron trigger from redis if it is invalid, as it
// may block other cron triggers
if err == ErrUnknownWorker || limits.IsLimitReachedOrExceeded(err) {
s.client.ZRem(s.ctx, SchedKey, results[0])
continue
}
return err
}
score, err := strconv.ParseInt(results[1].(string), 10, 64)
var prev time.Time
if err != nil {
prev = time.Now()
} else {
prev = time.Unix(score, 0)
}
if err := s.addToRedis(t, prev); err != nil {
return err
}
default:
return errors.New("Not implemented yet")
}
}
}
// AddTrigger a trigger to the system, by persisting it and using redis for
// scheduling its jobs
func (s *redisScheduler) AddTrigger(t Trigger) error {
if err := createTrigger(t); err != nil {
return err
}
return s.addToRedis(t, time.Now())
}
func (s *redisScheduler) addToRedis(t Trigger, prev time.Time) error {
var timestamp time.Time
switch t := t.(type) {
case *EventTrigger:
hKey := eventsKey(t)
return s.client.HSet(s.ctx, hKey, t.ID(), t.Infos().Arguments).Err()
case *AtTrigger:
timestamp = t.at
case *CronTrigger:
timestamp = t.NextExecution(prev)
now := time.Now()
if timestamp.Before(now) {
timestamp = t.NextExecution(now)
}
case *WebhookTrigger, *ClientTrigger:
return nil
default:
return errors.New("Not implemented yet")
}
pipe := s.client.Pipeline()
err := pipe.ZAdd(s.ctx, TriggersKey, &redis.Z{
Score: float64(timestamp.UTC().Unix()),
Member: redisKey(t),
}).Err()
if err != nil {
return err
}
err = pipe.ZRem(s.ctx, SchedKey, redisKey(t)).Err()
if err != nil {
return err
}
_, err = pipe.Exec(s.ctx)
return err
}
// GetTrigger returns the trigger with the specified ID.
func (s *redisScheduler) GetTrigger(db prefixer.Prefixer, id string) (Trigger, error) {
var infos TriggerInfos
if err := couchdb.GetDoc(db, consts.Triggers, id, &infos); err != nil {
if couchdb.IsNotFoundError(err) {
return nil, ErrNotFoundTrigger
}
return nil, err
}
t, err := fromTriggerInfos(&infos)
if err != nil {
return nil, err
}
if webhook, ok := t.(*WebhookTrigger); ok {
webhook.SetCallback(s)
}
return t, nil
}
// UpdateCron will change the frequency of execution for the given trigger.
func (s *redisScheduler) UpdateCron(db prefixer.Prefixer, trigger Trigger, arguments string) error {
if trigger.Type() != "@cron" {
return ErrNotCronTrigger
}
infos := trigger.Infos()
infos.Arguments = arguments
updated, err := NewCronTrigger(infos)
if err != nil {
return err
}
if err := couchdb.UpdateDoc(db, infos); err != nil {
return err
}
timestamp := updated.NextExecution(time.Now())
pipe := s.client.Pipeline()
pipe.ZRem(s.ctx, TriggersKey, redisKey(updated))
pipe.ZRem(s.ctx, SchedKey, redisKey(updated))
pipe.ZAdd(s.ctx, TriggersKey, &redis.Z{
Score: float64(timestamp.UTC().Unix()),
Member: redisKey(updated),
})
_, err = pipe.Exec(s.ctx)
return err
}
// DeleteTrigger removes the trigger with the specified ID. The trigger is
// unscheduled and remove from the storage.
func (s *redisScheduler) DeleteTrigger(db prefixer.Prefixer, id string) error {
t, err := s.GetTrigger(db, id)
if err != nil {
return err
}
return s.deleteTrigger(t)
}
func (s *redisScheduler) deleteTrigger(t Trigger) error {
if err := couchdb.DeleteDoc(t, t.Infos()); err != nil {
return err
}
switch t.(type) {
case *EventTrigger:
return s.client.HDel(s.ctx, eventsKey(t), t.ID()).Err()
case *AtTrigger, *CronTrigger:
pipe := s.client.Pipeline()
pipe.ZRem(s.ctx, TriggersKey, redisKey(t))
pipe.ZRem(s.ctx, SchedKey, redisKey(t))
_, err := pipe.Exec(s.ctx)
return err
}
return nil
}
// GetAllTriggers returns all the triggers for a domain, from couch.
func (s *redisScheduler) GetAllTriggers(db prefixer.Prefixer) ([]Trigger, error) {
var infos []*TriggerInfos
err := couchdb.ForeachDocs(db, consts.Triggers, func(_ string, data json.RawMessage) error {
var t *TriggerInfos
if err := json.Unmarshal(data, &t); err != nil {
return err
}
infos = append(infos, t)
return nil
})
if err != nil {
if couchdb.IsNoDatabaseError(err) {
return nil, nil
}
return nil, err
}
v := make([]Trigger, 0, len(infos))
for _, info := range infos {
t, err := fromTriggerInfos(info)
if err != nil {
return nil, err
}
v = append(v, t)
}
return v, nil
}
// HasEventTrigger returns true if the given @event trigger already exists.
func (s *redisScheduler) HasEventTrigger(trigger Trigger) bool {
infos := trigger.Infos()
key := eventsKey(trigger)
m, err := s.client.HGetAll(s.ctx, key).Result()
if err != nil {
s.log.Errorf("Could not fetch redis set %s: %s", key, err)
return false
}
for triggerID, args := range m {
if args != infos.Arguments {
continue
}
t, err := s.GetTrigger(trigger, triggerID)
if err != nil {
s.log.Warnf("Could not fetch @event trigger %s %s: %s",
trigger.DomainName(), triggerID, err.Error())
continue
}
if t.Infos().WorkerType == infos.WorkerType {
return true
}
}
return false
}
// CleanRedis removes clean redis by removing the two sets holding the triggers
// states.
func (s *redisScheduler) CleanRedis() error {
return s.client.Del(s.ctx, TriggersKey, SchedKey).Err()
}
// RebuildRedis puts all the triggers in redis (idempotent)
func (s *redisScheduler) RebuildRedis(db prefixer.Prefixer) error {
triggers, err := s.GetAllTriggers(db)
if err != nil {
joblog.Errorf("Error when rebuilding redis for domain %q: %s",
db.DomainName(), err)
return err
}
for _, t := range triggers {
if err = s.addToRedis(t, time.Now()); err != nil {
joblog.Errorf("Error when rebuilding redis for domain %q: %s (%v)",
db.DomainName(), err, t)
return err
}
}
joblog.Infof("Redis rebuilt for domain %q with %d triggers created",
db.DomainName(), len(triggers))
return nil
}
var _ Scheduler = &redisScheduler{}