forked from RichardKnop/machinery
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sqs.go
368 lines (313 loc) · 11 KB
/
sqs.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
package sqs
import (
"context"
"encoding/json"
"errors"
"fmt"
"strings"
"sync"
"time"
"github.com/YaoJunZhao/machinery/v1/brokers/errs"
"github.com/YaoJunZhao/machinery/v1/brokers/iface"
"github.com/YaoJunZhao/machinery/v1/common"
"github.com/YaoJunZhao/machinery/v1/config"
"github.com/YaoJunZhao/machinery/v1/log"
"github.com/YaoJunZhao/machinery/v1/tasks"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/sqs/sqsiface"
awssqs "github.com/aws/aws-sdk-go/service/sqs"
)
const (
maxAWSSQSDelay = time.Minute * 15 // Max supported SQS delay is 15 min: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html
)
// Broker represents a AWS SQS broker
// There are examples on: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/sqs-example-create-queue.html
type Broker struct {
common.Broker
processingWG sync.WaitGroup // use wait group to make sure task processing completes on interrupt signal
receivingWG sync.WaitGroup
stopReceivingChan chan int
sess *session.Session
service sqsiface.SQSAPI
queueUrl *string
}
// New creates new Broker instance
func New(cnf *config.Config) iface.Broker {
b := &Broker{Broker: common.NewBroker(cnf)}
if cnf.SQS != nil && cnf.SQS.Client != nil {
// Use provided *SQS client
b.service = cnf.SQS.Client
} else {
// Initialize a session that the SDK will use to load credentials from the shared credentials file, ~/.aws/credentials.
// See details on: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html
// Also, env AWS_REGION is also required
b.sess = session.Must(session.NewSessionWithOptions(session.Options{
SharedConfigState: session.SharedConfigEnable,
}))
b.service = awssqs.New(b.sess)
}
return b
}
// StartConsuming enters a loop and waits for incoming messages
func (b *Broker) StartConsuming(consumerTag string, concurrency int, taskProcessor iface.TaskProcessor) (bool, error) {
b.Broker.StartConsuming(consumerTag, concurrency, taskProcessor)
qURL := b.getQueueURL(taskProcessor)
//save it so that it can be used later when attempting to delete task
b.queueUrl = qURL
deliveries := make(chan *awssqs.ReceiveMessageOutput, concurrency)
pool := make(chan struct{}, concurrency)
// initialize worker pool with maxWorkers workers
for i := 0; i < concurrency; i++ {
pool <- struct{}{}
}
b.stopReceivingChan = make(chan int)
b.receivingWG.Add(1)
go func() {
defer b.receivingWG.Done()
log.INFO.Printf("[*] Waiting for messages on queue: %s. To exit press CTRL+C\n", *qURL)
for {
select {
// A way to stop this goroutine from b.StopConsuming
case <-b.stopReceivingChan:
close(deliveries)
return
case <-pool:
output, err := b.receiveMessage(qURL)
if err == nil && len(output.Messages) > 0 {
deliveries <- output
} else {
//return back to pool right away
pool <- struct{}{}
if err != nil {
log.ERROR.Printf("Queue consume error: %s", err)
}
}
}
}
}()
if err := b.consume(deliveries, concurrency, taskProcessor, pool); err != nil {
return b.GetRetry(), err
}
return b.GetRetry(), nil
}
// StopConsuming quits the loop
func (b *Broker) StopConsuming() {
b.Broker.StopConsuming()
b.stopReceiving()
// Waiting for any tasks being processed to finish
b.processingWG.Wait()
// Waiting for the receiving goroutine to have stopped
b.receivingWG.Wait()
}
// Publish places a new message on the default queue
func (b *Broker) Publish(ctx context.Context, signature *tasks.Signature) error {
msg, err := json.Marshal(signature)
if err != nil {
return fmt.Errorf("JSON marshal error: %s", err)
}
// Check that signature.RoutingKey is set, if not switch to DefaultQueue
b.AdjustRoutingKey(signature)
MsgInput := &awssqs.SendMessageInput{
MessageBody: aws.String(string(msg)),
QueueUrl: aws.String(b.GetConfig().Broker + "/" + signature.RoutingKey),
}
// if this is a fifo queue, there needs to be some additional parameters.
if strings.HasSuffix(signature.RoutingKey, ".fifo") {
// Use Machinery's signature Task UUID as SQS Message Group ID.
MsgDedupID := signature.UUID
MsgInput.MessageDeduplicationId = aws.String(MsgDedupID)
// Do not Use Machinery's signature Group UUID as SQS Message Group ID, instead use BrokerMessageGroupId
MsgGroupID := signature.BrokerMessageGroupId
if MsgGroupID == "" {
return fmt.Errorf("please specify BrokerMessageGroupId attribute for task Signature when submitting a task to FIFO queue")
}
MsgInput.MessageGroupId = aws.String(MsgGroupID)
}
// Check the ETA signature field, if it is set and it is in the future,
// and is not a fifo queue, set a delay in seconds for the task.
if signature.ETA != nil && !strings.HasSuffix(signature.RoutingKey, ".fifo") {
now := time.Now().UTC()
delay := signature.ETA.Sub(now)
if delay > 0 {
if delay > maxAWSSQSDelay {
return errors.New("Max AWS SQS delay exceeded")
}
MsgInput.DelaySeconds = aws.Int64(int64(delay.Seconds()))
}
}
result, err := b.service.SendMessageWithContext(ctx, MsgInput)
if err != nil {
log.ERROR.Printf("Error when sending a message: %v", err)
return err
}
log.INFO.Printf("Sending a message successfully, the messageId is %v", *result.MessageId)
return nil
}
// consume is a method which keeps consuming deliveries from a channel, until there is an error or a stop signal
func (b *Broker) consume(deliveries <-chan *awssqs.ReceiveMessageOutput, concurrency int, taskProcessor iface.TaskProcessor, pool chan struct{}) error {
errorsChan := make(chan error)
for {
whetherContinue, err := b.consumeDeliveries(deliveries, concurrency, taskProcessor, pool, errorsChan)
if err != nil {
return err
}
if whetherContinue == false {
return nil
}
}
}
// consumeOne is a method consumes a delivery. If a delivery was consumed successfully, it will be deleted from AWS SQS
func (b *Broker) consumeOne(delivery *awssqs.ReceiveMessageOutput, taskProcessor iface.TaskProcessor) error {
if len(delivery.Messages) == 0 {
log.ERROR.Printf("received an empty message, the delivery was %v", delivery)
return errors.New("received empty message, the delivery is " + delivery.GoString())
}
sig := new(tasks.Signature)
decoder := json.NewDecoder(strings.NewReader(*delivery.Messages[0].Body))
decoder.UseNumber()
if err := decoder.Decode(sig); err != nil {
log.ERROR.Printf("unmarshal error. the delivery is %v", delivery)
// if the unmarshal fails, remove the delivery from the queue
if delErr := b.deleteOne(delivery); delErr != nil {
log.ERROR.Printf("error when deleting the delivery. delivery is %v, Error=%s", delivery, delErr)
}
return err
}
if delivery.Messages[0].ReceiptHandle != nil {
sig.SQSReceiptHandle = *delivery.Messages[0].ReceiptHandle
}
// If the task is not registered return an error
// and leave the message in the queue
if !b.IsTaskRegistered(sig.Name) {
if sig.IgnoreWhenTaskNotRegistered {
b.deleteOne(delivery)
}
return fmt.Errorf("task %s is not registered", sig.Name)
}
err := taskProcessor.Process(sig)
if err != nil {
// stop task deletion in case we want to send messages to dlq in sqs
if err == errs.ErrStopTaskDeletion {
return nil
}
return err
}
// Delete message after successfully consuming and processing the message
if err = b.deleteOne(delivery); err != nil {
log.ERROR.Printf("error when deleting the delivery. delivery is %v, Error=%s", delivery, err)
}
return err
}
// deleteOne is a method delete a delivery from AWS SQS
func (b *Broker) deleteOne(delivery *awssqs.ReceiveMessageOutput) error {
qURL := b.defaultQueueURL()
_, err := b.service.DeleteMessage(&awssqs.DeleteMessageInput{
QueueUrl: qURL,
ReceiptHandle: delivery.Messages[0].ReceiptHandle,
})
if err != nil {
return err
}
return nil
}
// defaultQueueURL is a method returns the default queue url
func (b *Broker) defaultQueueURL() *string {
if b.queueUrl != nil {
return b.queueUrl
} else {
return aws.String(b.GetConfig().Broker + "/" + b.GetConfig().DefaultQueue)
}
}
// receiveMessage is a method receives a message from specified queue url
func (b *Broker) receiveMessage(qURL *string) (*awssqs.ReceiveMessageOutput, error) {
var waitTimeSeconds int
var visibilityTimeout *int
if b.GetConfig().SQS != nil {
waitTimeSeconds = b.GetConfig().SQS.WaitTimeSeconds
visibilityTimeout = b.GetConfig().SQS.VisibilityTimeout
} else {
waitTimeSeconds = 0
}
input := &awssqs.ReceiveMessageInput{
AttributeNames: []*string{
aws.String(awssqs.MessageSystemAttributeNameSentTimestamp),
},
MessageAttributeNames: []*string{
aws.String(awssqs.QueueAttributeNameAll),
},
QueueUrl: qURL,
MaxNumberOfMessages: aws.Int64(1),
WaitTimeSeconds: aws.Int64(int64(waitTimeSeconds)),
}
if visibilityTimeout != nil {
input.VisibilityTimeout = aws.Int64(int64(*visibilityTimeout))
}
result, err := b.service.ReceiveMessage(input)
if err != nil {
return nil, err
}
return result, err
}
// initializePool is a method which initializes concurrency pool
func (b *Broker) initializePool(pool chan struct{}, concurrency int) {
for i := 0; i < concurrency; i++ {
pool <- struct{}{}
}
}
// consumeDeliveries is a method consuming deliveries from deliveries channel
func (b *Broker) consumeDeliveries(deliveries <-chan *awssqs.ReceiveMessageOutput, concurrency int, taskProcessor iface.TaskProcessor, pool chan struct{}, errorsChan chan error) (bool, error) {
select {
case err := <-errorsChan:
return false, err
case d := <-deliveries:
b.processingWG.Add(1)
// Consume the task inside a goroutine so multiple tasks
// can be processed concurrently
go func() {
if err := b.consumeOne(d, taskProcessor); err != nil {
errorsChan <- err
}
b.processingWG.Done()
if concurrency > 0 {
// give worker back to pool
pool <- struct{}{}
}
}()
case <-b.GetStopChan():
return false, nil
}
return true, nil
}
// continueReceivingMessages is a method returns a continue signal
func (b *Broker) continueReceivingMessages(qURL *string, deliveries chan *awssqs.ReceiveMessageOutput) (bool, error) {
select {
// A way to stop this goroutine from b.StopConsuming
case <-b.stopReceivingChan:
return false, nil
default:
output, err := b.receiveMessage(qURL)
if err != nil {
return true, err
}
if len(output.Messages) == 0 {
return true, nil
}
go func() { deliveries <- output }()
}
return true, nil
}
// stopReceiving is a method sending a signal to stopReceivingChan
func (b *Broker) stopReceiving() {
// Stop the receiving goroutine
b.stopReceivingChan <- 1
}
// getQueueURL is a method returns that returns queueURL first by checking if custom queue was set and usign it
// otherwise using default queueName from config
func (b *Broker) getQueueURL(taskProcessor iface.TaskProcessor) *string {
queueName := b.GetConfig().DefaultQueue
if taskProcessor.CustomQueue() != "" {
queueName = taskProcessor.CustomQueue()
}
return aws.String(b.GetConfig().Broker + "/" + queueName)
}