/
snssqs.go
523 lines (445 loc) · 11.9 KB
/
snssqs.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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
package snssqs
import (
"context"
"fmt"
"regexp"
"sync"
"time"
"unicode"
"unicode/utf8"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/arn"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/sns"
"github.com/aws/aws-sdk-go/service/sqs"
"github.com/aws/aws-sdk-go/service/sts"
"go-micro.dev/v4/broker"
"go-micro.dev/v4/logger"
"go-micro.dev/v4/util/cmd"
)
type sessClientKey struct{}
const (
defaultMaxMessages = 1
defaultVisibilityTimeout = 3
defaultWaitSeconds = 10
defaultValidateOnPublish = false
defaultValidateHeaderOnPublish = false
)
// Amazon Services.
type awsServices struct {
svcSqs *sqs.SQS
svcSns *sns.SNS
sess *session.Session
accountID string
options broker.Options
}
// A subscriber (poller) to an SQS queue.
type subscriber struct {
options broker.SubscribeOptions
queueName string
svc *sqs.SQS
URL string
exit chan bool
}
// A wrapper around an SQS message published on an SQS queue and delivered via subscriber.
type sqsEvent struct {
sMessage *sqs.Message
svc *sqs.SQS
m *broker.Message
URL string
queueName string
err error
}
func init() {
cmd.DefaultBrokers["snssqs"] = NewBroker
}
// run is designed to run as a goroutine and poll SQS for new messages. Note that it's possible to receive
// more than one message from a single poll depending on the options configured for the plugin.
func (s *subscriber) run(hdlr broker.Handler) {
logger.Debugf("SQS subscription started. Queue:%s, URL: %s", s.queueName, s.URL)
for {
select {
case <-s.exit:
return
default:
result, err := s.svc.ReceiveMessage(&sqs.ReceiveMessageInput{
QueueUrl: &s.URL,
MaxNumberOfMessages: s.getMaxMessages(),
VisibilityTimeout: s.getVisibilityTimeout(),
WaitTimeSeconds: s.getWaitSeconds(),
AttributeNames: aws.StringSlice([]string{
"SentTimestamp", // TODO: not currently exposing this to plugin users
}),
MessageAttributeNames: aws.StringSlice([]string{
"All",
}),
})
if err != nil {
time.Sleep(time.Second)
logger.Errorf("Error receiving SQS message: %s", err.Error())
continue
}
if len(result.Messages) == 0 {
time.Sleep(time.Second)
continue
}
for _, sm := range result.Messages {
s.handleMessage(sm, hdlr)
}
}
}
}
func (s *subscriber) getMaxMessages() *int64 {
if v := s.options.Context.Value(maxMessagesKey{}); v != nil {
v2 := v.(int64)
return aws.Int64(v2)
}
return aws.Int64(defaultMaxMessages)
}
func (s *subscriber) getVisibilityTimeout() *int64 {
if v := s.options.Context.Value(visibilityTimeoutKey{}); v != nil {
v2 := v.(int64)
return aws.Int64(v2)
}
return aws.Int64(defaultVisibilityTimeout)
}
func (s *subscriber) getWaitSeconds() *int64 {
if v := s.options.Context.Value(waitTimeSecondsKey{}); v != nil {
v2 := v.(int64)
return aws.Int64(v2)
}
return aws.Int64(defaultWaitSeconds)
}
func (s *subscriber) handleMessage(msg *sqs.Message, hdlr broker.Handler) {
logger.Debugf("Received SQS message: %d bytes", len(*msg.Body))
m := &broker.Message{
Header: buildMessageHeader(msg.MessageAttributes),
Body: []byte(*msg.Body),
}
p := &sqsEvent{
sMessage: msg,
m: m,
URL: s.URL,
queueName: s.queueName,
svc: s.svc,
}
if p.err = hdlr(p); p.err != nil {
fmt.Println(p.err)
}
if s.options.AutoAck {
err := p.Ack()
if err != nil {
logger.Errorf("Failed auto-acknowledge of message: %s", err.Error())
}
}
}
func (s *subscriber) Options() broker.SubscribeOptions {
return s.options
}
func (s *subscriber) Topic() string {
return s.queueName
}
func (s *subscriber) Unsubscribe() error {
select {
case <-s.exit:
return nil
default:
close(s.exit)
return nil
}
}
func (p *sqsEvent) Error() error {
return p.err
}
func (p *sqsEvent) Ack() error {
_, err := p.svc.DeleteMessage(&sqs.DeleteMessageInput{
QueueUrl: &p.URL,
ReceiptHandle: p.sMessage.ReceiptHandle,
})
return err
}
func (p *sqsEvent) Topic() string {
return p.queueName
}
func (p *sqsEvent) Message() *broker.Message {
return p.m
}
func (b *awsServices) Options() broker.Options {
return b.options
}
// AWS SDK manages the server address internally.
func (b *awsServices) Address() string {
return ""
}
func (b *awsServices) Connect() error {
if svc := b.getAwsClient(); svc != nil {
b.sess = svc
return nil
}
b.sess = session.Must(session.NewSessionWithOptions(session.Options{
SharedConfigState: session.SharedConfigEnable,
Config: aws.Config{},
}))
sqsConfig := b.getSQSConfig()
b.svcSqs = sqs.New(b.sess, sqsConfig)
snsConfig := b.getSNSConfig()
b.svcSns = sns.New(b.sess, snsConfig)
stsConfig := b.getSTSConfig()
svcSts := sts.New(b.sess, stsConfig)
input := &sts.GetCallerIdentityInput{}
result, err := svcSts.GetCallerIdentity(input)
if err != nil {
return fmt.Errorf("unable to determine AWS AccountId: %s", err.Error())
}
b.accountID = *result.Account
return nil
}
// Disconnect does nothing as there's no live connection to terminate.
func (b *awsServices) Disconnect() error {
return nil
}
// Init initializes a broker and configures an AWS session and SNSSQS struct.
func (b *awsServices) Init(opts ...broker.Option) error {
for _, o := range opts {
o(&b.options)
}
return nil
}
// Publish publishes a message via SNS.
func (b *awsServices) Publish(topic string, msg *broker.Message, opts ...broker.PublishOption) error {
options := broker.PublishOptions{}
for _, o := range opts {
o(&options)
}
if getValidateOnPublish(options.Context) {
if err := ValidateBody(msg); err != nil {
return err
}
}
if getValidateHeaderOnPublish(options.Context) {
if err := ValidateHeader(msg, getHeaderWhitelistOnPublish(options.Context)); err != nil {
return err
}
}
topicArn := arn.ARN{
Partition: "aws",
Service: "sns",
Region: *b.sess.Config.Region,
AccountID: b.accountID,
Resource: topic,
}.String()
input := &sns.PublishInput{
Message: aws.String(string(msg.Body)),
TopicArn: &topicArn,
}
input.MessageAttributes = copyMessageHeader(options.Context, msg)
logger.Debugf("Publishing SNS message to %s, %d bytes", topic, len(msg.Body))
if _, err := b.svcSns.Publish(input); err != nil {
return err
}
// Broker interfaces don't let us do anything with message ID or sequence number
return nil
}
// Subscribe subscribes to an SQS queue, starting a goroutine to poll for messages.
func (b *awsServices) Subscribe(queueName string, h broker.Handler, opts ...broker.SubscribeOption) (broker.Subscriber, error) {
queueURL, err := b.urlFromQueueName(queueName)
if err != nil {
return nil, err
}
options := broker.SubscribeOptions{
AutoAck: true,
Queue: queueName,
Context: context.Background(),
}
for _, o := range opts {
o(&options)
}
subscriber := &subscriber{
options: options,
URL: queueURL,
queueName: queueName,
svc: b.svcSqs,
exit: make(chan bool),
}
go subscriber.run(h)
return subscriber, nil
}
func (b *awsServices) urlFromQueueName(queueName string) (string, error) {
resultURL, err := b.svcSqs.GetQueueUrl(&sqs.GetQueueUrlInput{
QueueName: aws.String(queueName),
})
if err != nil {
if aerr, ok := err.(awserr.Error); ok && aerr.Code() == sqs.ErrCodeQueueDoesNotExist {
return "", fmt.Errorf("unable to find queue %s: %s", queueName, err.Error())
}
return "", fmt.Errorf("unable to determine URL for queue %s: %s", queueName, err.Error())
}
return *resultURL.QueueUrl, nil
}
// String returns the name of the broker plugin.
func (b *awsServices) String() string {
return "snssqs"
}
func (b *awsServices) getAwsClient() *session.Session {
raw := b.options.Context.Value(sessClientKey{})
if raw != nil {
s := raw.(*session.Session)
return s
}
return nil
}
func (b *awsServices) getSNSConfig() *aws.Config {
raw := b.options.Context.Value(snsConfigKey{})
if raw != nil {
return raw.(*aws.Config)
}
return nil
}
func (b *awsServices) getSQSConfig() *aws.Config {
raw := b.options.Context.Value(sqsConfigKey{})
if raw != nil {
return raw.(*aws.Config)
}
return nil
}
func (b *awsServices) getSTSConfig() *aws.Config {
raw := b.options.Context.Value(stsConfigKey{})
if raw != nil {
return raw.(*aws.Config)
}
return nil
}
// NewBroker creates a new broker with options.
func NewBroker(opts ...broker.Option) broker.Broker {
options := broker.Options{
Context: context.Background(),
}
for _, o := range opts {
o(&options)
}
return &awsServices{
options: options,
}
}
func copyMessageHeader(ctx context.Context, m *broker.Message) (attribs map[string]*sns.MessageAttributeValue) {
headerWhitelistOnPublish := getHeaderWhitelistOnPublish(ctx)
attribs = make(map[string]*sns.MessageAttributeValue)
for k, v := range m.Header {
if headerWhitelistOnPublish != nil {
if _, ok := headerWhitelistOnPublish[k]; !ok {
logger.Debugf("header not whitelisted, removing: %s", k)
continue
}
}
attribs[k] = &sns.MessageAttributeValue{
DataType: aws.String("String"),
StringValue: aws.String(v),
}
}
return attribs
}
func buildMessageHeader(attribs map[string]*sqs.MessageAttributeValue) map[string]string {
res := make(map[string]string)
for k, v := range attribs {
res[k] = *v.StringValue
}
return res
}
// ValidateBody Validate message for the lowest requirements of both SNS and SQS.
func ValidateBody(msg *broker.Message) error {
// SNS requirements
if len(msg.Body) > 256*1024 {
return fmt.Errorf("message body over 256kB bytes")
}
if !utf8.Valid(msg.Body) {
return fmt.Errorf("message body does not consist solely of UTF-8 characters")
}
// SQS Requirements
// Only accept the following unicode ranges:
// #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
numWorkers := 8
runeCh := make(chan rune)
var err error
waitGroup := sync.WaitGroup{}
for i := 0; i < numWorkers; i++ {
waitGroup.Add(1)
go func(wg *sync.WaitGroup, rCh <-chan rune, err *error) {
defer wg.Done()
for r := range rCh {
if !unicode.In(r, validSqsRunes) {
*err = fmt.Errorf("message body contains invalid UTF-8 characters for SQS messages")
}
}
}(&waitGroup, runeCh, &err)
}
for _, r := range string(msg.Body) {
if err != nil {
close(runeCh)
return err
}
runeCh <- r
}
close(runeCh)
waitGroup.Wait()
return err
}
func ValidateHeader(msg *broker.Message, whitelist map[string]struct{}) error {
// SNS Requirement
// can only have a max of 10 headers (converted to attributes) or silently fails
if len(msg.Header) > 10 && (whitelist == nil || len(whitelist) > 10) {
totalHeaders := len(msg.Header)
if whitelist != nil {
totalHeaders = 0
for k := range msg.Header {
if _, ok := whitelist[k]; ok {
totalHeaders++
}
}
}
return fmt.Errorf("too many headers %d (max 10)", totalHeaders)
}
// SNS Requirement
// check for allowable characters in header name (A-Z, a-z, 0-9, -, _, .)
validSNSAttrName := regexp.MustCompile(`(?i)^[A-Z0-9\-_\.]+$`)
for k := range msg.Header {
if whitelist != nil {
if _, ok := whitelist[k]; !ok {
continue
}
}
if !validSNSAttrName.MatchString(k) {
return fmt.Errorf("invlaid characters in header key %s", k)
}
}
return nil
}
func getValidateOnPublish(ctx context.Context) bool {
if ctx == nil {
return defaultValidateOnPublish
}
if v, ok := ctx.Value(validateOnPublishKey{}).(bool); ok && v {
return true
}
// false by default
return defaultValidateOnPublish
}
func getValidateHeaderOnPublish(ctx context.Context) bool {
if ctx == nil {
return defaultValidateHeaderOnPublish
}
if v, ok := ctx.Value(validateHeaderOnPublishKey{}).(bool); ok && v {
return true
}
// false by default
return defaultValidateHeaderOnPublish
}
func getHeaderWhitelistOnPublish(ctx context.Context) map[string]struct{} {
if ctx == nil {
return nil
}
if v, ok := ctx.Value(headerWhitelistOnPublishKey{}).(map[string]struct{}); ok {
return v
}
return nil
}