-
Notifications
You must be signed in to change notification settings - Fork 137
/
mem_scheduler.go
313 lines (283 loc) · 8.2 KB
/
mem_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
package job
import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
"strings"
"sync"
"time"
"github.com/cozy/cozy-stack/model/instance"
"github.com/cozy/cozy-stack/pkg/consts"
"github.com/cozy/cozy-stack/pkg/couchdb"
"github.com/cozy/cozy-stack/pkg/logger"
"github.com/cozy/cozy-stack/pkg/prefixer"
)
// memScheduler is a centralized scheduler of many triggers. It starts all of
// them and schedules jobs accordingly.
type memScheduler struct {
broker Broker
ts map[string]Trigger
thumb *ThumbnailTrigger
share *ShareGroupTrigger
mu sync.RWMutex
log *logger.Entry
}
// NewMemScheduler creates a new in-memory scheduler that will load all
// registered triggers and schedule their work.
func NewMemScheduler() Scheduler {
return newMemScheduler()
}
func newMemScheduler() *memScheduler {
return &memScheduler{
ts: make(map[string]Trigger),
log: logger.WithNamespace("mem-scheduler"),
}
}
// StartScheduler will start the scheduler by actually loading all triggers
// from the scheduler's storage and associate for each of them a go routine in
// which they wait for the trigger send job requests.
func (s *memScheduler) StartScheduler(b Broker) error {
s.mu.Lock()
defer s.mu.Unlock()
s.broker = b
s.thumb = NewThumbnailTrigger(s.broker)
go s.thumb.Schedule()
s.share = NewShareGroupTrigger(s.broker)
go s.share.Schedule()
// XXX The memory scheduler loads the triggers from CouchDB when the stack
// is started. This can cause some stability issues when running system
// tests in parallel. To avoid that, an env variable
// COZY_SKIP_LOADING_TRIGGERS can be set to skip loading the triggers from
// CouchDB. It is correct for system tests, as instances are created and
// destroyed by the same process. But, it should not be used elsewhere.
for _, env := range os.Environ() {
if strings.HasPrefix(env, "COZY_SKIP_LOADING_TRIGGERS=") {
return nil
}
}
var ts []*TriggerInfos
err := couchdb.ForeachDocs(prefixer.GlobalPrefixer, consts.Instances, func(_ string, data json.RawMessage) error {
db := &instance.Instance{}
if err := json.Unmarshal(data, db); err != nil {
return err
}
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
}
// Remove the legacy @event trigger for thumbnail, it is now hardcoded
if t.WorkerType == "thumbnail" {
_ = couchdb.DeleteDoc(db, t)
return nil
}
ts = append(ts, t)
return nil
})
if err != nil && !couchdb.IsNoDatabaseError(err) {
return err
}
return nil
})
if err != nil && !couchdb.IsNoDatabaseError(err) {
return err
}
for _, infos := range ts {
t, err := fromTriggerInfos(infos)
if err != nil {
joblog.Errorf("Could not start trigger with ID %s: %s",
infos.ID(), err.Error())
continue
}
s.ts[t.DBPrefix()+"/"+infos.TID] = t
go s.schedule(t)
}
return nil
}
// ShutdownScheduler shuts down the scheduling of triggers
func (s *memScheduler) ShutdownScheduler(ctx context.Context) error {
s.mu.Lock()
defer s.mu.Unlock()
fmt.Print(" shutting down in-memory scheduler...")
for _, t := range s.ts {
t.Unschedule()
}
s.thumb.Unschedule()
s.share.Unschedule()
fmt.Println("ok.")
return nil
}
// AddTrigger will add a new trigger to the scheduler. The trigger is persisted
// in storage.
func (s *memScheduler) AddTrigger(t Trigger) error {
s.mu.Lock()
defer s.mu.Unlock()
if err := createTrigger(t); err != nil {
return err
}
s.ts[t.DBPrefix()+"/"+t.Infos().TID] = t
go s.schedule(t)
return nil
}
// GetTrigger returns the trigger with the specified ID.
func (s *memScheduler) GetTrigger(db prefixer.Prefixer, id string) (Trigger, error) {
s.mu.RLock()
defer s.mu.RUnlock()
t, ok := s.ts[db.DBPrefix()+"/"+id]
if !ok {
return nil, ErrNotFoundTrigger
}
return t, nil
}
// UpdateMessage changes the message for the given trigger.
func (s *memScheduler) UpdateMessage(db prefixer.Prefixer, trigger Trigger, message json.RawMessage) error {
s.mu.RLock()
defer s.mu.RUnlock()
infos := trigger.Infos()
infos.Message = Message(message)
return couchdb.UpdateDoc(db, infos)
}
// UpdateCron will change the frequency of execution for the given trigger.
func (s *memScheduler) UpdateCron(db prefixer.Prefixer, trigger Trigger, arguments string) error {
s.mu.RLock()
defer s.mu.RUnlock()
if trigger.Type() != "@cron" {
return ErrNotCronTrigger
}
infos := trigger.Infos()
infos.Arguments = arguments
updated, err := NewCronTrigger(infos)
if err != nil {
return err
}
trigger.Unschedule()
s.ts[updated.DBPrefix()+"/"+infos.TID] = updated
go s.schedule(updated)
return couchdb.UpdateDoc(db, infos)
}
// DeleteTrigger removes the trigger with the specified ID. The trigger is unscheduled
// and remove from the storage.
func (s *memScheduler) DeleteTrigger(db prefixer.Prefixer, id string) error {
s.mu.Lock()
defer s.mu.Unlock()
t, ok := s.ts[db.DBPrefix()+"/"+id]
if !ok {
return ErrNotFoundTrigger
}
delete(s.ts, db.DBPrefix()+"/"+id)
t.Unschedule()
return couchdb.DeleteDoc(db, t.Infos())
}
// GetAllTriggers returns all the running in-memory triggers.
func (s *memScheduler) GetAllTriggers(db prefixer.Prefixer) ([]Trigger, error) {
s.mu.RLock()
defer s.mu.RUnlock()
prefix := db.DBPrefix() + "/"
v := make([]Trigger, 0)
for n, t := range s.ts {
if strings.HasPrefix(n, prefix) {
v = append(v, t)
}
}
return v, nil
}
// HasEventTrigger returns true if the given trigger already exists. Only the
// type (@event, @cron...), worker, and arguments (if not empty) are looked at.
func (s *memScheduler) HasTrigger(db prefixer.Prefixer, infos TriggerInfos) bool {
prefix := db.DBPrefix() + "/"
for n, t := range s.ts {
if !strings.HasPrefix(n, prefix) {
continue
}
i := t.Infos()
if infos.Type == i.Type && infos.WorkerType == i.WorkerType {
if infos.Arguments == "" || infos.Arguments == i.Arguments {
return true
}
}
}
return false
}
func (s *memScheduler) schedule(t Trigger) {
s.log.Debugf("trigger %s(%s): Starting trigger",
t.Type(), t.Infos().TID)
ch := t.Schedule()
if ch == nil {
return
}
var debounced <-chan time.Time
var combinedReq *JobRequest
var d time.Duration
infos := t.Infos()
if infos.Debounce != "" {
var err error
if d, err = time.ParseDuration(infos.Debounce); err != nil {
s.log.Errorf("trigger %s has an invalid debounce: %s",
infos.TID, infos.Debounce)
}
}
for {
select {
case req, ok := <-ch:
if !ok {
return
}
if d == 0 {
s.pushJob(t, req)
} else if debounced == nil {
debounced = time.After(d)
combinedReq = combineRequests(t, req, nil)
} else {
combinedReq = combineRequests(t, combinedReq, req)
}
case <-debounced:
s.pushJob(t, combinedReq)
debounced = nil
combinedReq = nil
}
}
}
func combineRequests(t Trigger, req1, req2 *JobRequest) *JobRequest {
switch t.CombineRequest() {
case appendPayload:
if req2 == nil {
req1.Payload = Payload(`{"payloads":[` + string(req1.Payload) + "]}")
} else {
was := string(req1.Payload)
cut := was[:len(was)-2] // Remove the final ]}
req1.Payload = Payload(cut + "," + string(req2.Payload) + "]}")
}
return req1
case suppressPayload:
return t.Infos().JobRequest()
default: // keepOriginalRequest
return req1
}
}
func (s *memScheduler) pushJob(t Trigger, req *JobRequest) {
s.mu.Lock()
defer s.mu.Unlock()
log := s.log.WithField("domain", t.DomainName())
log.Infof("trigger %s(%s): Pushing new job %s",
t.Type(), t.Infos().TID, req.WorkerType)
if _, err := s.broker.PushJob(t, req); err != nil {
log.Errorf("trigger %s(%s): Could not schedule a new job: %s",
t.Type(), t.Infos().TID, err.Error())
}
}
func (s *memScheduler) PollScheduler(now int64) error {
return errors.New("memScheduler cannot be polled")
}
// CleanRedis does nothing for the in memory scheduler. It's just
// here to implement the Scheduler interface.
func (s *memScheduler) CleanRedis() error {
return errors.New("memScheduler does not use redis")
}
// RebuildRedis does nothing for the in memory scheduler. It's just
// here to implement the Scheduler interface.
func (s *memScheduler) RebuildRedis(db prefixer.Prefixer) error {
return errors.New("memScheduler does not use redis")
}
var _ Scheduler = &memScheduler{}