/
mq.go
429 lines (359 loc) · 10.9 KB
/
mq.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
// IronMQ (elastic message queue) client library
package mq
import (
"errors"
"time"
"github.com/iron-io/iron_go/api"
"github.com/iron-io/iron_go/config"
)
type Queue struct {
Settings config.Settings
Name string
}
type QueueSubscriber struct {
URL string `json:"url"`
Headers map[string]string `json:"headers,omitempty"`
}
type QueueInfo struct {
Id string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
PushType string `json:"push_type,omitempty"`
Reserved int `json:"reserved,omitempty"`
RetriesDelay int `json:"retries_delay,omitempty"`
Retries int `json:"retries,omitempty"`
Size int `json:"size,omitempty"`
Subscribers []QueueSubscriber `json:"subscribers,omitempty"`
Alerts []Alert `json:"alerts,omitempty"`
TotalMessages int `json:"total_messages,omitempty"`
ErrorQueue string `json:"error_queue,omitempty"`
}
type Message struct {
Id string `json:"id,omitempty"`
Body string `json:"body"`
// Timeout is the amount of time in seconds allowed for processing the
// message.
Timeout int64 `json:"timeout,omitempty"`
// Delay is the amount of time in seconds to wait before adding the message
// to the queue.
Delay int64 `json:"delay,omitempty"`
ReservedCount int64 `json:"reserved_count,omitempty"`
q Queue
}
type PushStatus struct {
Retried int `json:"retried"`
StatusCode int `json:"status_code"`
Status string `json:"status"`
}
type Subscriber struct {
Retried int `json:"retried"`
StatusCode int `json:"status_code"`
Status string `json:"status"`
URL string `json:"url"`
}
type Alert struct {
Type string `json:"type"`
Direction string `json:direction`
Trigger int `json:trigger`
Queue string `queue`
}
func New(queueName string) *Queue {
return &Queue{Settings: config.Config("iron_mq"), Name: queueName}
}
// ConfigNew uses the specified settings over configuration specified in an iron.json file or
// environment variables to return a Queue object capable of acquiring information about or
// modifying the queue specified by queueName.
func ConfigNew(queueName string, settings *config.Settings) Queue {
return Queue{Settings: config.ManualConfig("iron_mq", settings), Name: queueName}
}
func ListSettingsQueues(settings config.Settings, page int, perPage int) (queues []Queue, err error) {
out := []struct {
Id string
Project_id string
Name string
}{}
q := New("")
q.Settings = settings
err = q.queues().
QueryAdd("page", "%d", page).
QueryAdd("per_page", "%d", perPage).
Req("GET", nil, &out)
if err != nil {
return
}
queues = make([]Queue, 0, len(out))
for _, item := range out {
queues = append(queues, Queue{
Settings: q.Settings,
Name: item.Name,
})
}
return
}
func ListProjectQueues(projectId string, token string, page int, perPage int) (queues []Queue, err error) {
settings := config.Config("iron_mq")
settings.ProjectId = projectId
settings.Token = token
return ListSettingsQueues(settings, page, perPage)
}
func ListQueues(page, perPage int) (queues []Queue, err error) {
settings := config.Config("iron_mq")
return ListProjectQueues(settings.ProjectId, settings.Token, page, perPage)
}
func (q Queue) queues(s ...string) *api.URL { return api.Action(q.Settings, "queues", s...) }
// This method is left to support backward compatibility.
// This method is replaced by func ListQueues(page, perPage int) (queues []Queue, err error)
func (q Queue) ListQueues(page, perPage int) (queues []Queue, err error) {
return ListQueues(page, perPage)
}
func (q Queue) Info() (QueueInfo, error) {
qi := QueueInfo{}
err := q.queues(q.Name).Req("GET", nil, &qi)
return qi, err
}
func (q Queue) Update(qi QueueInfo) (QueueInfo, error) {
out := QueueInfo{}
err := q.queues(q.Name).Req("POST", qi, &out)
return out, err
}
func (q Queue) Delete() (bool, error) {
err := q.queues(q.Name).Req("DELETE", nil, nil)
success := err == nil
return success, err
}
type Subscription struct {
PushType string
Retries int
RetriesDelay int
}
// RemoveSubscribers removes subscribers.
func (q Queue) RemoveSubscribers(subscribers ...string) (err error) {
qi := QueueInfo{Subscribers: make([]QueueSubscriber, len(subscribers))}
for i, subscriber := range subscribers {
qi.Subscribers[i].URL = subscriber
}
return q.queues(q.Name, "subscribers").Req("DELETE", &qi, nil)
}
// AddSubscribers adds subscribers.
func (q Queue) AddSubscribers(subscribers ...string) (err error) {
qi := QueueInfo{Subscribers: make([]QueueSubscriber, len(subscribers))}
for i, subscriber := range subscribers {
qi.Subscribers[i].URL = subscriber
}
return q.queues(q.Name, "subscribers").Req("POST", &qi, nil)
}
func (q Queue) PushString(body string) (id string, err error) {
ids, err := q.PushStrings(body)
if err != nil {
return
}
return ids[0], nil
}
// Push adds one or more messages to the end of the queue using IronMQ's defaults:
// timeout - 60 seconds
// delay - none
//
// Identical to PushMessages with Message{Timeout: 60, Delay: 0}
func (q Queue) PushStrings(bodies ...string) (ids []string, err error) {
msgs := make([]*Message, 0, len(bodies))
for _, body := range bodies {
msgs = append(msgs, &Message{Body: body})
}
return q.PushMessages(msgs...)
}
func (q Queue) PushMessage(msg *Message) (id string, err error) {
ids, err := q.PushMessages(msg)
if err != nil {
return
}
return ids[0], nil
}
func (q Queue) PushMessages(msgs ...*Message) (ids []string, err error) {
in := struct {
Messages []*Message `json:"messages"`
}{Messages: msgs}
out := struct {
IDs []string `json:"ids"`
Msg string `json:"msg"`
}{}
err = q.queues(q.Name, "messages").Req("POST", &in, &out)
return out.IDs, err
}
// Get reserves a message from the queue.
// The message will not be deleted, but will be reserved until the timeout
// expires. If the timeout expires before the message is deleted, the message
// will be placed back onto the queue.
// As a result, be sure to Delete a message after you're done with it.
func (q Queue) Get() (msg *Message, err error) {
msgs, err := q.GetN(1)
if err != nil {
return
}
if len(msgs) > 0 {
msg = msgs[0]
} else {
err = errors.New("Couldn't get a single message")
}
return
}
// get N messages
func (q Queue) GetN(n int) (msgs []*Message, err error) {
return q.GetNWithTimeoutAndWait(n, 0, 0)
}
func (q Queue) GetNWithTimeout(n, timeout int) (msgs []*Message, err error) {
return q.GetNWithTimeoutAndWait(n, timeout, 0)
}
func (q Queue) GetNWithTimeoutAndWait(n, timeout, wait int) (msgs []*Message, err error) {
out := struct {
Messages []*Message `json:"messages"`
}{}
err = q.queues(q.Name, "messages").
QueryAdd("n", "%d", n).
QueryAdd("timeout", "%d", timeout).
QueryAdd("wait", "%d", wait).
Req("GET", nil, &out)
if err != nil {
return
}
for _, msg := range out.Messages {
msg.q = q
}
return out.Messages, nil
}
func (q Queue) Peek() (msg *Message, err error) {
msgs, err := q.PeekN(1)
if err != nil {
return
}
if len(msgs) > 0 {
msg = msgs[0]
} else {
err = errors.New("Couldn't get a single message")
}
return
}
// peek N messages
func (q Queue) PeekN(n int) (msgs []*Message, err error) {
msgs, err = q.PeekNWithTimeout(n, 0)
return
}
func (q Queue) PeekNWithTimeout(n, timeout int) (msgs []*Message, err error) {
out := struct {
Messages []*Message `json:"messages"`
}{}
err = q.queues(q.Name, "messages", "peek").
QueryAdd("n", "%d", n).
QueryAdd("timeout", "%d", timeout).
Req("GET", nil, &out)
if err != nil {
return
}
for _, msg := range out.Messages {
msg.q = q
}
return out.Messages, nil
}
// Delete all messages in the queue
func (q Queue) Clear() (err error) {
return q.queues(q.Name, "clear").Req("POST", nil, nil)
}
// Delete message from queue
func (q Queue) DeleteMessage(msgId string) (err error) {
return q.queues(q.Name, "messages", msgId).Req("DELETE", nil, nil)
}
func (q Queue) DeleteMessages(messages []*Message) error {
values := make([]string, len(messages))
for i, val := range messages {
values[i] = val.Id
}
in := struct {
Ids []string `json:"ids"`
}{
Ids: values,
}
return q.queues(q.Name, "messages").Req("DELETE", in, nil)
}
// Reset timeout of message to keep it reserved
func (q Queue) TouchMessage(msgId string) (err error) {
return q.queues(q.Name, "messages", msgId, "touch").Req("POST", nil, nil)
}
// Put message back in the queue, message will be available after +delay+ seconds.
func (q Queue) ReleaseMessage(msgId string, delay int64) (err error) {
in := struct {
Delay int64 `json:"delay"`
}{Delay: delay}
return q.queues(q.Name, "messages", msgId, "release").Req("POST", &in, nil)
}
func (q Queue) MessageSubscribers(msgId string) ([]*Subscriber, error) {
out := struct {
Subscribers []*Subscriber `json:"subscribers"`
}{}
err := q.queues(q.Name, "messages", msgId, "subscribers").Req("GET", nil, &out)
return out.Subscribers, err
}
func (q Queue) MessageSubscribersPollN(msgId string, n int) ([]*Subscriber, error) {
subs, err := q.MessageSubscribers(msgId)
for {
time.Sleep(100 * time.Millisecond)
subs, err = q.MessageSubscribers(msgId)
if err != nil {
return subs, err
}
if len(subs) >= n && actualPushStatus(subs) {
return subs, nil
}
}
return subs, err
}
func actualPushStatus(subs []*Subscriber) bool {
for _, sub := range subs {
if sub.Status == "queued" {
return false
}
}
return true
}
func (q Queue) AddAlerts(alerts ...*Alert) (err error) {
in := struct {
Alerts []*Alert `json:"alerts"`
}{Alerts: alerts}
return q.queues(q.Name, "alerts").Req("POST", &in, nil)
}
func (q Queue) UpdateAlerts(alerts ...*Alert) (err error) {
in := struct {
Alerts []*Alert `json:"alerts"`
}{Alerts: alerts}
return q.queues(q.Name, "alerts").Req("PUT", &in, nil)
}
func (q Queue) RemoveAllAlerts() (err error) {
return q.queues(q.Name, "alerts").Req("DELETE", nil, nil)
}
type AlertInfo struct {
Id string `json:"id"`
}
func (q Queue) RemoveAlerts(alertIds ...string) (err error) {
in := struct {
Alerts []AlertInfo `json:"alerts"`
}{Alerts: make([]AlertInfo, len(alertIds))}
for i, alertId := range alertIds {
(in.Alerts[i]).Id = alertId
}
return q.queues(q.Name, "alerts").Req("DELETE", &in, nil)
}
func (q Queue) RemoveAlert(alertId string) (err error) {
return q.queues(q.Name, "alerts", alertId).Req("DELETE", nil, nil)
}
// Delete message from queue
func (m Message) Delete() (err error) {
return m.q.DeleteMessage(m.Id)
}
// Reset timeout of message to keep it reserved
func (m Message) Touch() (err error) {
return m.q.TouchMessage(m.Id)
}
// Put message back in the queue, message will be available after +delay+ seconds.
func (m Message) Release(delay int64) (err error) {
return m.q.ReleaseMessage(m.Id, delay)
}
func (m Message) Subscribers() (interface{}, error) {
return m.q.MessageSubscribers(m.Id)
}