-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcron.go
More file actions
390 lines (308 loc) · 8.38 KB
/
cron.go
File metadata and controls
390 lines (308 loc) · 8.38 KB
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
package worker
import (
"context"
"errors"
"log/slog"
"strings"
"time"
"github.com/google/uuid"
"github.com/hyp3rd/cron/v4"
"github.com/hyp3rd/ewrap"
)
const errParseCronSchedule = "parse cron schedule"
// CronTaskFactory builds a task when a cron schedule fires.
type CronTaskFactory func(ctx context.Context) (*Task, error)
// CronDurableFactory builds a durable task when a cron schedule fires.
type CronDurableFactory func(ctx context.Context) (DurableTask, error)
type cronSpec struct {
Spec string
Durable bool
Paused bool
}
type cronFactory struct {
Durable bool
TaskFactory CronTaskFactory
DurableFactory CronDurableFactory
Origin string
}
const (
cronFactoryOriginUser = "user"
cronFactoryOriginJob = "job"
)
// RegisterCronTask registers a cron job that enqueues a task on each tick.
func (tm *TaskManager) RegisterCronTask(
ctx context.Context,
name string,
spec string,
factory CronTaskFactory,
) error {
if tm.durableEnabled {
return ewrap.New("durable backend enabled; use RegisterDurableCronTask")
}
normalized, schedule, err := tm.prepareCronRegistration(ctx, name, spec, factory != nil)
if err != nil {
return err
}
tm.cronMu.Lock()
defer tm.cronMu.Unlock()
if _, exists := tm.cronEntries[normalized]; exists {
return ewrap.New("cron task already registered")
}
tm.cronFactories[normalized] = cronFactory{
Durable: false,
TaskFactory: factory,
Origin: cronFactoryOriginUser,
}
entryID := tm.scheduleCronEntry(normalized, schedule)
tm.cronEntries[normalized] = entryID
tm.cronSpecs[normalized] = cronSpec{Spec: strings.TrimSpace(spec), Durable: false}
return nil
}
// RegisterDurableCronTask registers a cron job that enqueues a durable task on each tick.
func (tm *TaskManager) RegisterDurableCronTask(
ctx context.Context,
name string,
spec string,
factory CronDurableFactory,
) error {
if !tm.durableEnabled {
return ewrap.New("durable backend not configured")
}
normalized, schedule, err := tm.prepareCronRegistration(ctx, name, spec, factory != nil)
if err != nil {
return err
}
tm.cronMu.Lock()
defer tm.cronMu.Unlock()
if _, exists := tm.cronEntries[normalized]; exists {
return ewrap.New("cron task already registered")
}
tm.cronFactories[normalized] = cronFactory{
Durable: true,
DurableFactory: factory,
Origin: cronFactoryOriginUser,
}
entryID := tm.scheduleCronEntry(normalized, schedule)
tm.cronEntries[normalized] = entryID
tm.cronSpecs[normalized] = cronSpec{Spec: strings.TrimSpace(spec), Durable: true}
return nil
}
func (tm *TaskManager) cronJob(name string) func(context.Context) error {
return func(ctx context.Context) error {
if tm.skipCronTick(ctx) {
return nil
}
spec, factory, ok := tm.cronSpecAndFactory(name)
if !ok {
return nil
}
if factory.Durable {
tm.runDurableCron(ctx, name, spec, factory)
return nil
}
tm.runInMemoryCron(ctx, name, spec, factory)
return nil
}
}
func (tm *TaskManager) cronSpecAndFactory(name string) (cronSpec, cronFactory, bool) {
tm.cronMu.RLock()
spec, specOk := tm.cronSpecs[name]
factory, factoryOk := tm.cronFactories[name]
tm.cronMu.RUnlock()
if !specOk || !factoryOk || spec.Paused {
return cronSpec{}, cronFactory{}, false
}
return spec, factory, true
}
func (tm *TaskManager) runDurableCron(ctx context.Context, name string, spec cronSpec, factory cronFactory) {
task, err := factory.DurableFactory(ctx)
if err != nil {
cronLogError("cron durable task factory", name, err)
return
}
if task.ID == uuid.Nil {
task.ID = uuid.New()
}
ensureCronMetadata(&task, name, spec, tm.defaultQueue)
queueName := task.Queue
if queueName == "" {
queueName = tm.defaultQueue
}
metadata := copyStringMap(task.Metadata)
if metadata == nil {
metadata = map[string]string{}
}
if task.Handler != "" {
if _, ok := metadata["handler"]; !ok {
metadata["handler"] = task.Handler
}
}
runInfo := cronRunInfo{
id: task.ID,
name: name,
spec: spec.Spec,
durable: true,
queue: queueName,
enqueuedAt: time.Now(),
metadata: metadata,
}
tm.noteCronRun(runInfo)
err = tm.RegisterDurableTask(ctx, task)
if err != nil {
tm.dropCronRun(task.ID)
if IsDurableTaskAlreadyExists(err) {
return
}
cronLogError("cron register durable task", name, err)
}
}
func (tm *TaskManager) runInMemoryCron(ctx context.Context, name string, spec cronSpec, factory cronFactory) {
task, err := factory.TaskFactory(ctx)
if err != nil {
cronLogError("cron task factory", name, err)
return
}
if task == nil {
cronLogError("cron task factory", name, ewrap.New("cron task is nil"))
return
}
if task.ID == uuid.Nil {
task.ID = uuid.New()
}
runInfo := cronRunInfoFromTask(name, spec, task, tm.defaultQueue)
tm.noteCronRun(runInfo)
err = tm.RegisterTask(ctx, task)
if err != nil {
tm.dropCronRun(task.ID)
cronLogError("cron register task", name, err)
}
}
func (tm *TaskManager) prepareCronRegistration(
ctx context.Context,
name string,
spec string,
hasFactory bool,
) (string, cron.Schedule, error) {
if tm == nil {
return "", nil, ewrap.New("task manager is nil")
}
if ctx == nil {
return "", nil, ErrInvalidTaskContext
}
if !hasFactory {
return "", nil, ewrap.New("cron task factory is nil")
}
name = strings.TrimSpace(name)
if name == "" {
return "", nil, ewrap.New("cron task name is required")
}
spec = strings.TrimSpace(spec)
if spec == "" {
return "", nil, ewrap.New("cron schedule is required")
}
schedule, err := parseCronSpec(spec, tm.cronLoc)
if err != nil {
return "", nil, err
}
return name, schedule, nil
}
func (tm *TaskManager) scheduleCronEntry(name string, schedule cron.Schedule) cron.EntryID {
return tm.cron.ScheduleNamed(name, schedule, cron.FuncJob(tm.cronJob(name)))
}
func (tm *TaskManager) skipCronTick(ctx context.Context) bool {
return ctx.Err() != nil || tm.ctx.Err() != nil || !tm.accepting.Load()
}
// UnregisterCronTask removes a cron job by name.
func (tm *TaskManager) UnregisterCronTask(name string) bool {
if tm == nil {
return false
}
name = strings.TrimSpace(name)
if name == "" {
return false
}
tm.cronMu.Lock()
defer tm.cronMu.Unlock()
entryID, ok := tm.cronEntries[name]
if !ok {
return false
}
tm.cron.Remove(entryID)
delete(tm.cronEntries, name)
delete(tm.cronSpecs, name)
return true
}
func (tm *TaskManager) initCron() {
location := tm.cronLoc
if location == nil {
location = time.UTC
tm.cronLoc = location
}
parser := cron.NewSpecParser(
cron.Second | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
)
tm.cron = cron.New(cron.WithLocation(location), cron.WithParser(parser))
}
func (tm *TaskManager) startCron() {
tm.cronMu.Lock()
defer tm.cronMu.Unlock()
if tm.cron != nil {
tm.cron.Start(tm.ctx)
}
}
func (tm *TaskManager) stopCron() {
tm.cronMu.Lock()
defer tm.cronMu.Unlock()
if tm.cron != nil {
err := tm.cron.Stop(tm.ctx)
if err != nil && !errors.Is(err, context.Canceled) && !errors.Is(err, context.DeadlineExceeded) {
cronLogError("cron stop", "scheduler", err)
}
}
}
func parseCronSpec(spec string, location *time.Location) (cron.Schedule, error) {
spec = strings.TrimSpace(spec)
if spec == "" {
return nil, ewrap.New("cron schedule is required")
}
fields := strings.Fields(spec)
//nolint:revive,mnd
switch len(fields) {
case 5:
schedule, err := cronParserStandard(location).Parse(spec)
if err != nil {
return nil, ewrap.Wrap(err, errParseCronSchedule)
}
return schedule, nil
case 6:
schedule, err := cronParserSeconds(location).Parse(spec)
if err != nil {
return nil, ewrap.Wrap(err, errParseCronSchedule)
}
return schedule, nil
default:
schedule, err := cronParserSeconds(location).Parse(spec)
if err == nil {
return schedule, nil
}
schedule, errStandard := cronParserStandard(location).Parse(spec)
if errStandard == nil {
return schedule, nil
}
return nil, ewrap.Wrap(err, errParseCronSchedule)
}
}
func cronParserStandard(_ *time.Location) cron.Parser {
return cron.NewSpecParser(
cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
)
}
func cronParserSeconds(_ *time.Location) cron.Parser {
return cron.NewSpecParser(
cron.Second | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
)
}
func cronLogError(action, name string, err error) {
logger := slog.Default()
logger.Error(action, "name", name, "error", err)
}