-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
spawner.go
401 lines (340 loc) · 12 KB
/
spawner.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
package job
import (
"context"
"fmt"
"math"
"reflect"
"sync"
pkgerrors "github.com/pkg/errors"
"github.com/jmoiron/sqlx"
"github.com/smartcontractkit/chainlink-common/pkg/services"
"github.com/smartcontractkit/chainlink-common/pkg/utils"
"github.com/smartcontractkit/chainlink/v2/core/logger"
"github.com/smartcontractkit/chainlink/v2/core/services/pg"
)
//go:generate mockery --quiet --name Spawner --output ./mocks/ --case=underscore
type (
// Spawner manages the spinning up and down of the long-running
// services that perform the work described by job specs. Each active job spec
// has 1 or more of these services associated with it.
Spawner interface {
services.Service
// CreateJob creates a new job and starts services.
// All services must start without errors for the job to be active.
CreateJob(jb *Job, qopts ...pg.QOpt) (err error)
// DeleteJob deletes a job and stops any active services.
DeleteJob(jobID int32, qopts ...pg.QOpt) error
// ActiveJobs returns a map of jobs with active services (started without error).
ActiveJobs() map[int32]Job
// StartService starts services for the given job spec.
// NOTE: Prefer to use CreateJob, this is only publicly exposed for use in tests
// to start a job that was previously manually inserted into DB
StartService(ctx context.Context, spec Job, qopts ...pg.QOpt) error
}
Checker interface {
Register(service services.HealthReporter) error
Unregister(name string) error
}
spawner struct {
services.StateMachine
orm ORM
config Config
checker Checker
jobTypeDelegates map[Type]Delegate
activeJobs map[int32]activeJob
activeJobsMu sync.RWMutex
q pg.Q
lggr logger.Logger
chStop services.StopChan
lbDependentAwaiters []utils.DependentAwaiter
}
// TODO(spook): I can't wait for Go generics
Delegate interface {
JobType() Type
// BeforeJobCreated is only called once on first time job create.
BeforeJobCreated(Job)
// ServicesForSpec returns services to be started and stopped for this
// job. In case a given job type relies upon well-defined startup/shutdown
// ordering for services, they are started in the order they are given
// and stopped in reverse order.
ServicesForSpec(context.Context, Job) ([]ServiceCtx, error)
AfterJobCreated(Job)
BeforeJobDeleted(Job)
// OnDeleteJob will be called from within DELETE db transaction. Any db
// commands issued within OnDeleteJob() should be performed first, before any
// non-db side effects. This is required in order to guarantee mutual atomicity between
// all tasks intended to happen during job deletion. For the same reason, the job will
// not show up in the db within OnDeleteJob(), even though it is still actively running.
OnDeleteJob(jb Job, q pg.Queryer) error
}
activeJob struct {
delegate Delegate
spec Job
services []ServiceCtx
}
)
var _ Spawner = (*spawner)(nil)
func NewSpawner(orm ORM, config Config, checker Checker, jobTypeDelegates map[Type]Delegate, db *sqlx.DB, lggr logger.Logger, lbDependentAwaiters []utils.DependentAwaiter) *spawner {
namedLogger := lggr.Named("JobSpawner")
s := &spawner{
orm: orm,
config: config,
checker: checker,
jobTypeDelegates: jobTypeDelegates,
q: pg.NewQ(db, namedLogger, config),
lggr: namedLogger,
activeJobs: make(map[int32]activeJob),
chStop: make(services.StopChan),
lbDependentAwaiters: lbDependentAwaiters,
}
return s
}
// Start starts Spawner.
func (js *spawner) Start(ctx context.Context) error {
return js.StartOnce("JobSpawner", func() error {
js.startAllServices(ctx)
return nil
})
}
func (js *spawner) Close() error {
return js.StopOnce("JobSpawner", func() error {
close(js.chStop)
js.stopAllServices()
return nil
})
}
func (js *spawner) Name() string {
return js.lggr.Name()
}
func (js *spawner) HealthReport() map[string]error {
return map[string]error{js.Name(): js.Healthy()}
}
func (js *spawner) startAllServices(ctx context.Context) {
// TODO: rename to find AllJobs
specs, _, err := js.orm.FindJobs(0, math.MaxUint32)
if err != nil {
werr := fmt.Errorf("couldn't fetch unclaimed jobs: %v", err)
js.lggr.Critical(werr.Error())
js.SvcErrBuffer.Append(werr)
return
}
for _, spec := range specs {
if err = js.StartService(ctx, spec); err != nil {
js.lggr.Errorf("Couldn't start service %q: %v", spec.Name.ValueOrZero(), err)
}
}
// Log Broadcaster fully starts after all initial Register calls are done from other starting services
// to make sure the initial backfill covers those subscribers.
for _, lbd := range js.lbDependentAwaiters {
lbd.DependentReady()
}
}
func (js *spawner) stopAllServices() {
jobIDs := js.activeJobIDs()
for _, jobID := range jobIDs {
js.stopService(jobID)
}
}
// stopService removes the job from memory and stop the services.
// It will always delete the job from memory even if closing the services fail.
func (js *spawner) stopService(jobID int32) {
lggr := js.lggr.With("jobID", jobID)
lggr.Debug("Stopping services for job")
js.activeJobsMu.Lock()
defer js.activeJobsMu.Unlock()
aj := js.activeJobs[jobID]
for i := len(aj.services) - 1; i >= 0; i-- {
service := aj.services[i]
sLggr := lggr.With("subservice", i, "serviceType", reflect.TypeOf(service))
if c, ok := service.(services.HealthReporter); ok {
if err := js.checker.Unregister(c.Name()); err != nil {
sLggr.Warnw("Failed to unregister service from health checker", "err", err)
}
}
if err := service.Close(); err != nil {
sLggr.Criticalw("Error stopping job service", "err", err)
js.SvcErrBuffer.Append(pkgerrors.Wrap(err, "error stopping job service"))
} else {
sLggr.Debug("Stopped job service")
}
}
lggr.Debug("Stopped all services for job")
delete(js.activeJobs, jobID)
}
func (js *spawner) StartService(ctx context.Context, jb Job, qopts ...pg.QOpt) error {
lggr := js.lggr.With("jobID", jb.ID)
js.activeJobsMu.Lock()
defer js.activeJobsMu.Unlock()
delegate, exists := js.jobTypeDelegates[jb.Type]
if !exists {
lggr.Errorw("Job type has not been registered with job.Spawner", "type", jb.Type)
return pkgerrors.Errorf("unregistered type %q for job: %d", jb.Type, jb.ID)
}
// We always add the active job in the activeJob map, even in the case
// that it fails to start. That way we have access to the delegate to call
// OnJobDeleted before deleting. However, the activeJob will only have services
// that it was able to start without an error.
aj := activeJob{delegate: delegate, spec: jb}
jb.PipelineSpec.JobName = jb.Name.ValueOrZero()
jb.PipelineSpec.JobID = jb.ID
jb.PipelineSpec.JobType = string(jb.Type)
jb.PipelineSpec.ForwardingAllowed = jb.ForwardingAllowed
if jb.GasLimit.Valid {
jb.PipelineSpec.GasLimit = &jb.GasLimit.Uint32
}
srvs, err := delegate.ServicesForSpec(ctx, jb)
if err != nil {
lggr.Errorw("Error creating services for job", "err", err)
cctx, cancel := js.chStop.NewCtx()
defer cancel()
js.orm.TryRecordError(jb.ID, err.Error(), pg.WithParentCtx(cctx))
js.activeJobs[jb.ID] = aj
return pkgerrors.Wrapf(err, "failed to create services for job: %d", jb.ID)
}
lggr.Debugw("JobSpawner: Starting services for job", "count", len(srvs))
var ms services.MultiStart
for _, srv := range srvs {
err = ms.Start(ctx, srv)
if err != nil {
lggr.Criticalw("Error starting service for job", "err", err)
return err
}
if c, ok := srv.(services.HealthReporter); ok {
err = js.checker.Register(c)
if err != nil {
lggr.Errorw("Error registering service with health checker", "err", err)
return err
}
}
aj.services = append(aj.services, srv)
}
lggr.Debugw("JobSpawner: Finished starting services for job", "count", len(srvs))
js.activeJobs[jb.ID] = aj
return nil
}
// Should not get called before Start()
func (js *spawner) CreateJob(jb *Job, qopts ...pg.QOpt) (err error) {
delegate, exists := js.jobTypeDelegates[jb.Type]
if !exists {
js.lggr.Errorf("job type '%s' has not been registered with the job.Spawner", jb.Type)
err = pkgerrors.Errorf("job type '%s' has not been registered with the job.Spawner", jb.Type)
return
}
q := js.q.WithOpts(qopts...)
pctx, cancel := js.chStop.Ctx(q.ParentCtx)
defer cancel()
q.ParentCtx = pctx
ctx, cancel := q.Context()
defer cancel()
err = js.orm.CreateJob(jb, pg.WithQueryer(q.Queryer), pg.WithParentCtx(ctx))
if err != nil {
js.lggr.Errorw("Error creating job", "type", jb.Type, "err", err)
return
}
js.lggr.Infow("Created job", "type", jb.Type, "jobID", jb.ID)
delegate.BeforeJobCreated(*jb)
err = js.StartService(pctx, *jb, pg.WithQueryer(q.Queryer))
if err != nil {
js.lggr.Errorw("Error starting job services", "type", jb.Type, "jobID", jb.ID, "err", err)
} else {
js.lggr.Infow("Started job services", "type", jb.Type, "jobID", jb.ID)
}
delegate.AfterJobCreated(*jb)
return err
}
// Should not get called before Start()
func (js *spawner) DeleteJob(jobID int32, qopts ...pg.QOpt) error {
if jobID == 0 {
return pkgerrors.New("will not delete job with 0 ID")
}
lggr := js.lggr.With("jobID", jobID)
lggr.Debugw("Deleting job")
var aj activeJob
var exists bool
func() {
js.activeJobsMu.RLock()
defer js.activeJobsMu.RUnlock()
aj, exists = js.activeJobs[jobID]
}()
q := js.q.WithOpts(qopts...)
pctx, cancel := js.chStop.Ctx(q.ParentCtx)
defer cancel()
q.ParentCtx = pctx
ctx, cancel := q.Context()
defer cancel()
if !exists { // inactive, so look up the spec and delegate
jb, err := js.orm.FindJob(ctx, jobID)
if err != nil {
return pkgerrors.Wrapf(err, "job %d not found", jobID)
}
aj.spec = jb
if !func() (ok bool) {
js.activeJobsMu.RLock()
defer js.activeJobsMu.RUnlock()
aj.delegate, ok = js.jobTypeDelegates[jb.Type]
return ok
}() {
js.lggr.Errorw("Job type has not been registered with job.Spawner", "type", jb.Type, "jobID", jb.ID)
return pkgerrors.Errorf("unregistered type %q for job: %d", jb.Type, jb.ID)
}
}
lggr.Debugw("Callback: BeforeDeleteJob")
aj.delegate.BeforeJobDeleted(aj.spec)
lggr.Debugw("Callback: BeforeDeleteJob done")
err := q.Transaction(func(tx pg.Queryer) error {
err := js.orm.DeleteJob(jobID, pg.WithQueryer(tx))
if err != nil {
js.lggr.Errorw("Error deleting job", "jobID", jobID, "err", err)
return err
}
// This comes after calling orm.DeleteJob(), so that any non-db side effects inside it only get executed if
// we know the DELETE will succeed. The DELETE will be finalized only if all db transactions in OnDeleteJob()
// succeed. If either of those fails, the job will not be stopped and everything will be rolled back.
lggr.Debugw("Callback: OnDeleteJob")
err = aj.delegate.OnDeleteJob(aj.spec, tx)
if err != nil {
return err
}
lggr.Debugw("Callback: OnDeleteJob done")
return nil
})
if exists {
// Stop the service and remove the job from memory, which will always happen even if closing the services fail.
js.stopService(jobID)
}
lggr.Infow("Stopped and deleted job")
return err
}
func (js *spawner) ActiveJobs() map[int32]Job {
js.activeJobsMu.RLock()
defer js.activeJobsMu.RUnlock()
m := make(map[int32]Job, len(js.activeJobs))
for jobID := range js.activeJobs {
m[jobID] = js.activeJobs[jobID].spec
}
return m
}
func (js *spawner) activeJobIDs() []int32 {
js.activeJobsMu.RLock()
defer js.activeJobsMu.RUnlock()
ids := make([]int32, 0, len(js.activeJobs))
for jobID := range js.activeJobs {
ids = append(ids, jobID)
}
return ids
}
var _ Delegate = &NullDelegate{}
type NullDelegate struct {
Type Type
}
func (n *NullDelegate) JobType() Type {
return n.Type
}
// ServicesForSpec does no-op.
func (n *NullDelegate) ServicesForSpec(ctx context.Context, spec Job) (s []ServiceCtx, err error) {
return
}
func (n *NullDelegate) BeforeJobCreated(spec Job) {}
func (n *NullDelegate) AfterJobCreated(spec Job) {}
func (n *NullDelegate) BeforeJobDeleted(spec Job) {}
func (n *NullDelegate) OnDeleteJob(spec Job, q pg.Queryer) error { return nil }