forked from RichardKnop/machinery
-
Notifications
You must be signed in to change notification settings - Fork 0
/
redis.go
318 lines (258 loc) · 7.61 KB
/
redis.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
package backends
import (
"encoding/json"
"fmt"
"time"
"github.com/RichardKnop/machinery/v1/common"
"github.com/RichardKnop/machinery/v1/config"
"github.com/RichardKnop/machinery/v1/log"
"github.com/RichardKnop/machinery/v1/tasks"
"github.com/garyburd/redigo/redis"
"gopkg.in/redsync.v1"
)
// RedisBackend represents a Memcache result backend
type RedisBackend struct {
cnf *config.Config
host string
password string
db int
pool *redis.Pool
// If set, path to a socket file overrides hostname
socketPath string
redsync *redsync.Redsync
common.RedisConnector
}
// NewRedisBackend creates RedisBackend instance
func NewRedisBackend(cnf *config.Config, host, password, socketPath string, db int) Interface {
return &RedisBackend{
cnf: cnf,
host: host,
db: db,
password: password,
socketPath: socketPath,
}
}
// InitGroup creates and saves a group meta data object
func (b *RedisBackend) InitGroup(groupUUID string, taskUUIDs []string) error {
groupMeta := &tasks.GroupMeta{
GroupUUID: groupUUID,
TaskUUIDs: taskUUIDs,
}
encoded, err := json.Marshal(groupMeta)
if err != nil {
return err
}
conn := b.open()
defer conn.Close()
_, err = conn.Do("SET", groupUUID, encoded)
if err != nil {
return err
}
return b.setExpirationTime(groupUUID)
}
// GroupCompleted returns true if all tasks in a group finished
func (b *RedisBackend) 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 *RedisBackend) 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 trigerred 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 *RedisBackend) TriggerChord(groupUUID string) (bool, error) {
conn := b.open()
defer conn.Close()
m := b.redsync.NewMutex("TriggerChordMutex")
if err := m.Lock(); err != nil {
return false, err
}
defer m.Unlock()
groupMeta, err := b.getGroupMeta(groupUUID)
if err != nil {
return false, err
}
// Chord has already been triggered, return false (should not trigger again)
if groupMeta.ChordTriggered {
return false, nil
}
// Set flag to true
groupMeta.ChordTriggered = true
// Update the group meta
encoded, err := json.Marshal(&groupMeta)
if err != nil {
return false, err
}
_, err = conn.Do("SET", groupUUID, encoded)
if err != nil {
return false, err
}
return true, nil
}
// SetStatePending updates task state to PENDING
func (b *RedisBackend) SetStatePending(signature *tasks.Signature) error {
taskState := tasks.NewPendingTaskState(signature)
return b.updateState(taskState)
}
// SetStateReceived updates task state to RECEIVED
func (b *RedisBackend) SetStateReceived(signature *tasks.Signature) error {
taskState := tasks.NewReceivedTaskState(signature)
return b.updateState(taskState)
}
// SetStateStarted updates task state to STARTED
func (b *RedisBackend) SetStateStarted(signature *tasks.Signature) error {
taskState := tasks.NewStartedTaskState(signature)
return b.updateState(taskState)
}
// SetStateRetry updates task state to RETRY
func (b *RedisBackend) SetStateRetry(signature *tasks.Signature) error {
state := tasks.NewRetryTaskState(signature)
return b.updateState(state)
}
// SetStateSuccess updates task state to SUCCESS
func (b *RedisBackend) SetStateSuccess(signature *tasks.Signature, results []*tasks.TaskResult) error {
taskState := tasks.NewSuccessTaskState(signature, results)
return b.updateState(taskState)
}
// SetStateFailure updates task state to FAILURE
func (b *RedisBackend) SetStateFailure(signature *tasks.Signature, err string) error {
taskState := tasks.NewFailureTaskState(signature, err)
return b.updateState(taskState)
}
// GetState returns the latest task state
func (b *RedisBackend) GetState(taskUUID string) (*tasks.TaskState, error) {
conn := b.open()
defer conn.Close()
item, err := redis.Bytes(conn.Do("GET", taskUUID))
if err != nil {
return nil, err
}
state := new(tasks.TaskState)
if err := json.Unmarshal(item, state); err != nil {
return nil, err
}
return state, nil
}
// PurgeState deletes stored task state
func (b *RedisBackend) PurgeState(taskUUID string) error {
conn := b.open()
defer conn.Close()
_, err := conn.Do("DEL", taskUUID)
if err != nil {
return err
}
return nil
}
// PurgeGroupMeta deletes stored group meta data
func (b *RedisBackend) PurgeGroupMeta(groupUUID string) error {
conn := b.open()
defer conn.Close()
_, err := conn.Do("DEL", groupUUID)
if err != nil {
return err
}
return nil
}
// getGroupMeta retrieves group meta data, convenience function to avoid repetition
func (b *RedisBackend) getGroupMeta(groupUUID string) (*tasks.GroupMeta, error) {
conn := b.open()
defer conn.Close()
item, err := redis.Bytes(conn.Do("GET", groupUUID))
if err != nil {
return nil, err
}
groupMeta := new(tasks.GroupMeta)
if err := json.Unmarshal(item, groupMeta); err != nil {
return nil, err
}
return groupMeta, nil
}
// getStates returns multiple task states
func (b *RedisBackend) getStates(taskUUIDs ...string) ([]*tasks.TaskState, error) {
taskStates := make([]*tasks.TaskState, len(taskUUIDs))
conn := b.open()
defer conn.Close()
// conn.Do requires []interface{}... can't pass []string unfortunately
taskUUIDInterfaces := make([]interface{}, len(taskUUIDs))
for i, taskUUID := range taskUUIDs {
taskUUIDInterfaces[i] = interface{}(taskUUID)
}
reply, err := redis.Values(conn.Do("MGET", taskUUIDInterfaces...))
if err != nil {
return taskStates, err
}
for i, value := range reply {
bytes, ok := value.([]byte)
if !ok {
return taskStates, fmt.Errorf("Expected byte array, instead got: %v", value)
}
taskState := new(tasks.TaskState)
if err := json.Unmarshal(bytes, taskState); err != nil {
log.ERROR.Print(err)
return taskStates, err
}
taskStates[i] = taskState
}
return taskStates, nil
}
// updateState saves current task state
func (b *RedisBackend) updateState(taskState *tasks.TaskState) error {
conn := b.open()
defer conn.Close()
encoded, err := json.Marshal(taskState)
if err != nil {
return err
}
_, err = conn.Do("SET", taskState.TaskUUID, encoded)
if err != nil {
return err
}
return b.setExpirationTime(taskState.TaskUUID)
}
// setExpirationTime sets expiration timestamp on a stored task state
func (b *RedisBackend) setExpirationTime(key string) error {
expiresIn := b.cnf.ResultsExpireIn
if expiresIn == 0 {
// // expire results after 1 hour by default
expiresIn = 3600
}
expirationTimestamp := int32(time.Now().Unix() + int64(expiresIn))
conn := b.open()
defer conn.Close()
_, err := conn.Do("EXPIREAT", key, expirationTimestamp)
if err != nil {
return err
}
return nil
}
// open returns or creates instance of Redis connection
func (b *RedisBackend) open() redis.Conn {
if b.pool == nil {
b.pool = b.NewPool(b.socketPath, b.host, b.password, b.db)
}
if b.redsync == nil {
var pools = []redsync.Pool{b.pool}
b.redsync = redsync.New(pools)
}
return b.pool.Get()
}