forked from RichardKnop/machinery
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mongodb.go
409 lines (374 loc) · 10.4 KB
/
mongodb.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
package mongo
import (
"crypto/tls"
"encoding/json"
"net"
"reflect"
"strings"
"time"
"github.com/RichardKnop/machinery/v1/backends/iface"
"github.com/RichardKnop/machinery/v1/common"
"github.com/RichardKnop/machinery/v1/config"
"github.com/RichardKnop/machinery/v1/log"
"github.com/RichardKnop/machinery/v1/tasks"
"gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson"
)
// Backend represents a MongoDB result backend
type Backend struct {
common.Backend
session *mgo.Session
}
// New creates Backend instance
func New(cnf *config.Config) iface.Backend {
return &Backend{Backend: common.NewBackend(cnf)}
}
// Op represents a mongo operation using a copied session
type Op struct {
session *mgo.Session
tasksCollection *mgo.Collection
groupMetasCollection *mgo.Collection
}
// Do wraps a func using op & defers session close
func (op *Op) Do(f func() error) error {
defer op.session.Close()
return f()
}
// newOp returns an Op pointer w/ copied session
// and task & groupMetas collections
func (b *Backend) newOp() *Op {
session := b.session.Copy()
return &Op{
session: session,
tasksCollection: session.DB("").C("tasks"),
groupMetasCollection: session.DB("").C("group_metas"),
}
}
// InitGroup creates and saves a group meta data object
func (b *Backend) InitGroup(groupUUID string, taskUUIDs []string) error {
op, err := b.connect()
if err != nil {
return err
}
return op.Do(func() error {
groupMeta := &tasks.GroupMeta{
GroupUUID: groupUUID,
TaskUUIDs: taskUUIDs,
CreatedAt: time.Now().UTC(),
}
return op.groupMetasCollection.Insert(groupMeta)
})
}
// GroupCompleted returns true if all tasks in a group finished
func (b *Backend) GroupCompleted(groupUUID string, groupTaskCount int) (bool, error) {
groupMeta, err := b.getGroupMeta(groupUUID)
if err != nil {
return false, err
}
taskStates, err := b.getStates(groupMeta.TaskUUIDs...)
if err != nil {
return false, err
}
var countSuccessTasks = 0
for _, taskState := range taskStates {
if taskState.IsCompleted() {
countSuccessTasks++
}
}
return countSuccessTasks == groupTaskCount, nil
}
// GroupTaskStates returns states of all tasks in the group
func (b *Backend) GroupTaskStates(groupUUID string, groupTaskCount int) ([]*tasks.TaskState, error) {
groupMeta, err := b.getGroupMeta(groupUUID)
if err != nil {
return []*tasks.TaskState{}, err
}
return b.getStates(groupMeta.TaskUUIDs...)
}
// TriggerChord flags chord as triggered in the backend storage to make sure
// chord is never triggered multiple times. Returns a boolean flag to indicate
// whether the worker should trigger chord (true) or no if it has been triggered
// already (false)
func (b *Backend) TriggerChord(groupUUID string) (bool, error) {
op, err := b.connect()
if err != nil {
return false, err
}
err = op.Do(func() error {
query := bson.M{
"_id": groupUUID,
"chord_triggered": false,
}
change := mgo.Change{
Update: bson.M{
"$set": bson.M{
"chord_triggered": true,
},
},
ReturnNew: false,
}
_, err := op.groupMetasCollection.
Find(query).
Apply(change, nil)
return err
})
if err != nil {
if err == mgo.ErrNotFound {
log.WARNING.Printf("Chord already triggered for group %s", groupUUID)
return false, nil
}
return false, err
}
return true, nil
}
// SetStatePending updates task state to PENDING
func (b *Backend) SetStatePending(signature *tasks.Signature) error {
update := bson.M{
"state": tasks.StatePending,
"task_name": signature.Name,
"created_at": time.Now().UTC(),
}
return b.updateState(signature, update)
}
// SetStateReceived updates task state to RECEIVED
func (b *Backend) SetStateReceived(signature *tasks.Signature) error {
update := bson.M{"state": tasks.StateReceived}
return b.updateState(signature, update)
}
// SetStateStarted updates task state to STARTED
func (b *Backend) SetStateStarted(signature *tasks.Signature) error {
update := bson.M{"state": tasks.StateStarted}
return b.updateState(signature, update)
}
// SetStateRetry updates task state to RETRY
func (b *Backend) SetStateRetry(signature *tasks.Signature) error {
update := bson.M{"state": tasks.StateRetry}
return b.updateState(signature, update)
}
// SetStateSuccess updates task state to SUCCESS
func (b *Backend) SetStateSuccess(signature *tasks.Signature, results []*tasks.TaskResult) error {
decodedResults := b.decodeResults(results)
update := bson.M{
"state": tasks.StateSuccess,
"results": decodedResults,
}
return b.updateState(signature, update)
}
// decodeResults detects & decodes json strings in TaskResult.Value and returns a new slice
func (b *Backend) decodeResults(results []*tasks.TaskResult) []*tasks.TaskResult {
l := len(results)
jsonResults := make([]*tasks.TaskResult, l, l)
for i, result := range results {
jsonResult := new(bson.M)
resultType := reflect.TypeOf(result.Value).Kind()
if resultType == reflect.String {
err := json.NewDecoder(strings.NewReader(result.Value.(string))).Decode(&jsonResult)
if err == nil {
jsonResults[i] = &tasks.TaskResult{
Type: "json",
Value: jsonResult,
}
continue
}
}
jsonResults[i] = result
}
return jsonResults
}
// SetStateFailure updates task state to FAILURE
func (b *Backend) SetStateFailure(signature *tasks.Signature, err string) error {
update := bson.M{"state": tasks.StateFailure, "error": err}
return b.updateState(signature, update)
}
// GetState returns the latest task state
func (b *Backend) GetState(taskUUID string) (*tasks.TaskState, error) {
op, err := b.connect()
if err != nil {
return nil, err
}
state := new(tasks.TaskState)
err = op.Do(func() error {
return op.tasksCollection.FindId(taskUUID).One(state)
})
if err != nil {
return nil, err
}
return state, nil
}
// PurgeState deletes stored task state
func (b *Backend) PurgeState(taskUUID string) error {
op, err := b.connect()
if err != nil {
return err
}
return op.Do(func() error {
return op.tasksCollection.RemoveId(taskUUID)
})
}
// PurgeGroupMeta deletes stored group meta data
func (b *Backend) PurgeGroupMeta(groupUUID string) error {
op, err := b.connect()
if err != nil {
return err
}
return op.Do(func() error {
return op.groupMetasCollection.RemoveId(groupUUID)
})
}
// lockGroupMeta acquires lock on groupUUID document
func (b *Backend) lockGroupMeta(groupUUID string) error {
op, err := b.connect()
if err != nil {
return err
}
return op.Do(func() error {
query := bson.M{
"_id": groupUUID,
"lock": false,
}
change := mgo.Change{
Update: bson.M{
"$set": bson.M{
"lock": true,
},
},
Upsert: true,
ReturnNew: false,
}
_, err := op.groupMetasCollection.
Find(query).
Apply(change, nil)
return err
})
}
// unlockGroupMeta releases lock on groupUUID document
func (b *Backend) unlockGroupMeta(groupUUID string) error {
op, err := b.connect()
if err != nil {
return err
}
return op.Do(func() error {
update := bson.M{"$set": bson.M{"lock": false}}
_, err := op.groupMetasCollection.UpsertId(groupUUID, update)
return err
})
}
// getGroupMeta retrieves group meta data, convenience function to avoid repetition
func (b *Backend) getGroupMeta(groupUUID string) (*tasks.GroupMeta, error) {
op, err := b.connect()
if err != nil {
return nil, err
}
groupMeta := new(tasks.GroupMeta)
err = op.Do(func() error {
query := bson.M{"_id": groupUUID}
return op.groupMetasCollection.Find(query).One(groupMeta)
})
if err != nil {
return nil, err
}
return groupMeta, nil
}
// getStates returns multiple task states
func (b *Backend) getStates(taskUUIDs ...string) ([]*tasks.TaskState, error) {
op, err := b.connect()
if err != nil {
return nil, err
}
states := make([]*tasks.TaskState, 0, len(taskUUIDs))
op.Do(func() error {
iter := op.tasksCollection.Find(bson.M{"_id": bson.M{"$in": taskUUIDs}}).Iter()
state := new(tasks.TaskState)
for iter.Next(state) {
states = append(states, state)
// otherwise we would end up with the last task being every element of the slice
state = new(tasks.TaskState)
}
return nil
})
return states, nil
}
// updateState saves current task state
func (b *Backend) updateState(signature *tasks.Signature, update bson.M) error {
op, err := b.connect()
if err != nil {
return err
}
return op.Do(func() error {
update = bson.M{"$set": update}
_, err := op.tasksCollection.UpsertId(signature.UUID, update)
return err
})
}
// connect creates the underlying mgo session if it doesn't exist
// creates required indexes for our collections
// and returns a a new Op
func (b *Backend) connect() (*Op, error) {
if b.session != nil {
b.session.Refresh()
return b.newOp(), nil
}
session, err := b.dial()
if err != nil {
return nil, err
}
b.session = session
err = b.createMongoIndexes()
if err != nil {
return nil, err
}
return b.newOp(), nil
}
// dial connects to mongo with TLSConfig if provided
// else connects via ResultBackend uri
func (b *Backend) dial() (*mgo.Session, error) {
if b.GetConfig().TLSConfig == nil {
return mgo.Dial(b.GetConfig().ResultBackend)
}
dialInfo, err := mgo.ParseURL(b.GetConfig().ResultBackend)
if err != nil {
return nil, err
}
dialInfo.Timeout = 5 * time.Second
dialInfo.DialServer = func(addr *mgo.ServerAddr) (net.Conn, error) {
return tls.Dial("tcp", addr.String(), b.GetConfig().TLSConfig)
}
return mgo.DialWithInfo(dialInfo)
}
// createMongoIndexes ensures all indexes are in place
func (b *Backend) createMongoIndexes() error {
op, err := b.connect()
if err != nil {
return err
}
return op.Do(func() error {
indexes := []mgo.Index{
{
Key: []string{"state"},
Background: true, // can be used while index is being built
ExpireAfter: time.Duration(b.GetConfig().ResultsExpireIn) * time.Second,
},
{
Key: []string{"lock"},
Background: true, // can be used while index is being built
ExpireAfter: time.Duration(b.GetConfig().ResultsExpireIn) * time.Second,
},
}
for _, index := range indexes {
// Check if index already exists, if it does, skip
if err := op.tasksCollection.EnsureIndex(index); err == nil {
log.INFO.Printf("%s index already exist, skipping create step", index.Key[0])
continue
}
// Create index (keep in mind EnsureIndex is blocking operation)
log.INFO.Printf("Creating %s index", index.Key[0])
if err := op.tasksCollection.DropIndex(index.Key[0]); err != nil {
return err
}
if err := op.tasksCollection.EnsureIndex(index); err != nil {
return err
}
}
return nil
})
}