-
Notifications
You must be signed in to change notification settings - Fork 25
/
job-group.go
232 lines (197 loc) · 5.7 KB
/
job-group.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
package jobs
import (
"context"
"errors"
"fmt"
"time"
"github.com/reugn/go-quartz/quartz"
"go.uber.org/fx"
statusv1 "github.com/fluxninja/aperture/v2/api/gen/proto/go/aperture/status/v1"
"github.com/fluxninja/aperture/v2/pkg/config"
jobsconfig "github.com/fluxninja/aperture/v2/pkg/jobs/config"
"github.com/fluxninja/aperture/v2/pkg/log"
"github.com/fluxninja/aperture/v2/pkg/status"
)
const (
schedulerConfigKey = "scheduler"
)
// JobGroupConfig is reexported as it is commonly used when importing jobs package.
type JobGroupConfig = jobsconfig.JobGroupConfig
// JobGroupConstructor holds fields to create annotated instances of JobGroup.
type JobGroupConstructor struct {
// Name of the job group - config key is <name> and statuses are updated under <name>.<job>
Name string
// Config key -- if it is empty then it is <name>.scheduler
Key string
GW GroupWatchers
DefaultConfig jobsconfig.JobGroupConfig
}
// Annotate provides annotated instances of JobGroup.
func (jgc JobGroupConstructor) Annotate() fx.Option {
groupTag := config.GroupTag(jgc.Name)
nameTag := config.NameTag(jgc.Name)
return fx.Options(
fx.Provide(
fx.Annotate(
jgc.provideJobGroup,
fx.ParamTags(groupTag),
fx.ResultTags(nameTag),
),
),
)
}
func (jgc JobGroupConstructor) provideJobGroup(
gw GroupWatchers,
registry status.Registry,
unmarshaller config.Unmarshaller,
lifecycle fx.Lifecycle,
) (*JobGroup, error) {
schedulerConfig := jgc.DefaultConfig
key := jgc.Key
if key == "" {
key = jgc.Name + "." + schedulerConfigKey
}
if err := unmarshaller.UnmarshalKey(key, &schedulerConfig); err != nil {
log.Panic().Err(err).Msg("Unable to deserialize JobGroup configuration!")
}
gwAll := GroupWatchers{}
if len(jgc.GW) > 0 || len(gw) > 0 {
gwAll = append(gwAll, jgc.GW...)
gwAll = append(gwAll, gw...)
}
reg := registry.Child("job-group", jgc.Name)
jg, err := NewJobGroup(reg, schedulerConfig, gwAll)
if err != nil {
return nil, err
}
lifecycle.Append(fx.Hook{
OnStart: func(_ context.Context) error {
return jg.Start()
},
OnStop: func(_ context.Context) error {
defer reg.Detach()
return jg.Stop()
},
})
return jg, nil
}
var errInitialResult = errors.New("job hasn't been scheduled yet")
// JobGroup tracks a group of jobs.
// It is responsible for scheduling jobs and keeping track of their statuses.
type JobGroup struct {
scheduler *quartz.StdScheduler
gt *groupTracker
livenessRegistry status.Registry
}
// NewJobGroup creates a new JobGroup.
func NewJobGroup(
statusRegistry status.Registry,
config jobsconfig.JobGroupConfig,
gws GroupWatchers,
) (*JobGroup, error) {
scheduler := quartz.NewStdSchedulerWithOptions(quartz.StdSchedulerOptions{
BlockingExecution: config.BlockingExecution,
WorkerLimit: config.WorkerLimit,
})
jg := &JobGroup{
scheduler: scheduler,
gt: newGroupTracker(gws, statusRegistry),
}
return jg, nil
}
// Start starts the JobGroup.
func (jg *JobGroup) Start() error {
jg.livenessRegistry = jg.gt.statusRegistry.Root().
Child("system", "liveness").
Child("job-group", "job_groups").
Child(jg.gt.statusRegistry.Key(), jg.gt.statusRegistry.Value())
jg.scheduler.Start(context.Background())
return nil
}
// Stop stops the JobGroup.
func (jg *JobGroup) Stop() error {
jg.DeregisterAll()
jg.scheduler.Stop()
jg.scheduler.Wait(context.Background())
jg.livenessRegistry.Detach()
return nil
}
// RegisterJob registers a new Job in a JobGroup.
// It returns an error if the job is already registered.
// It also starts the job's executor.
func (jg *JobGroup) RegisterJob(job Job, config jobsconfig.JobConfig) error {
var initialErr error
if !config.InitiallyHealthy {
initialErr = errInitialResult
}
executor := newJobExecutor(job, jg, config, jg.livenessRegistry)
// add to the tracker
err := jg.gt.registerJob(executor)
if err != nil {
return err
}
// set initial status
err = jg.gt.updateStatus(executor, status.NewStatus(nil, initialErr))
if err != nil {
jg.gt.statusRegistry.GetLogger().Error().Err(err).Str("job", job.Name()).Msg("Unable to update status of job")
return err
}
// start the executor
executor.start()
return nil
}
// DeregisterJob deregisters a Job from the JobGroup.
// It returns an error if the job is not registered.
// It also stops the job's executor.
func (jg *JobGroup) DeregisterJob(name string) error {
job, err := jg.gt.deregisterJob(name)
if err != nil {
return err
}
if executor, ok := job.(*jobExecutor); ok {
executor.stop()
}
return nil
}
// DeregisterAll deregisters all Jobs from the JobGroup.
func (jg *JobGroup) DeregisterAll() {
jobs := jg.gt.reset()
for _, job := range jobs {
if executor, ok := job.(*jobExecutor); ok {
executor.stop()
}
}
}
// TriggerJob triggers a Job in the JobGroup.
func (jg *JobGroup) TriggerJob(name string, delay time.Duration) {
jg.gt.mu.Lock()
defer jg.gt.mu.Unlock()
tracker, ok := jg.gt.trackers[name]
if ok {
if executor, ok := tracker.job.(*jobExecutor); ok {
executor.trigger(delay)
}
}
}
// JobInfo returns the information related to a job with given name.
func (jg *JobGroup) JobInfo(name string) (JobInfo, error) {
jg.gt.mu.Lock()
defer jg.gt.mu.Unlock()
tracker, ok := jg.gt.trackers[name]
if ok {
return tracker.jobInfo, nil
}
return JobInfo{}, fmt.Errorf("job %s not found", name)
}
// IsHealthy returns true if the job is healthy.
func (jg *JobGroup) IsHealthy() bool {
return jg.gt.isHealthy()
}
// Results returns the results of all jobs in the JobGroup.
func (jg *JobGroup) Results() (*statusv1.GroupStatus, bool) {
return jg.gt.results()
}
// GetStatusRegistry returns the registry of the JobGroup.
func (jg *JobGroup) GetStatusRegistry() status.Registry {
return jg.gt.statusRegistry
}