This repository has been archived by the owner on Oct 20, 2021. It is now read-only.
forked from Azure/azure-service-bus-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
receiver.go
466 lines (394 loc) · 12 KB
/
receiver.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
package servicebus
// MIT License
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE
import (
"context"
"sync"
"time"
common "github.com/Azure/azure-amqp-common-go/v3"
"github.com/Azure/go-amqp"
"github.com/devigned/tab"
)
type (
// Receiver provides connection, session and link handling for a receiving to an entity path
Receiver struct {
namespace *Namespace
client *amqp.Client
clientMu sync.RWMutex
session *session
receiver *amqp.Receiver
entityPath string
doneListening func()
Name string
useSessions bool
sessionID *string
lastError error
lastErrorMu sync.RWMutex
mode ReceiveMode
prefetch uint32
DefaultDisposition DispositionAction
Closed bool
cancelAuthRefresh func() <-chan struct{}
}
// ReceiverOption provides a structure for configuring receivers
ReceiverOption func(receiver *Receiver) error
// ListenerHandle provides the ability to close or listen to the close of a Receiver
ListenerHandle struct {
r *Receiver
ctx context.Context
}
)
// ReceiverWithSession configures a Receiver to use a session
func ReceiverWithSession(sessionID *string) ReceiverOption {
return func(r *Receiver) error {
r.sessionID = sessionID
r.useSessions = true
return nil
}
}
// ReceiverWithReceiveMode configures a Receiver to use the specified receive mode
func ReceiverWithReceiveMode(mode ReceiveMode) ReceiverOption {
return func(r *Receiver) error {
r.mode = mode
return nil
}
}
// ReceiverWithPrefetchCount configures the receiver to attempt to fetch the number of messages specified by the prefect
// at one time.
//
// The default is 1 message at a time.
//
// Caution: Using PeekLock, messages have a set lock timeout, which can be renewed. By setting a high prefetch count, a
// local queue of messages could build up and cause message locks to expire before the message lands in the handler. If
// this happens, the message disposition will fail and will be re-queued and processed again.
func ReceiverWithPrefetchCount(prefetch uint32) ReceiverOption {
return func(receiver *Receiver) error {
receiver.prefetch = prefetch
return nil
}
}
// NewReceiver creates a new Service Bus message listener given an AMQP client and an entity path
func (ns *Namespace) NewReceiver(ctx context.Context, entityPath string, opts ...ReceiverOption) (*Receiver, error) {
ctx, span := ns.startSpanFromContext(ctx, "sb.Namespace.NewReceiver")
defer span.End()
r := &Receiver{
namespace: ns,
entityPath: entityPath,
mode: PeekLockMode,
prefetch: 1,
}
for _, opt := range opts {
if err := opt(r); err != nil {
return nil, err
}
}
err := r.newSessionAndLink(ctx)
if err != nil {
_ = r.Close(ctx)
return nil, err
}
return r, nil
}
// Close will close the AMQP session and link of the Receiver
func (r *Receiver) Close(ctx context.Context) error {
ctx, span := r.startConsumerSpanFromContext(ctx, "sb.Receiver.Close")
defer span.End()
r.clientMu.Lock()
defer r.clientMu.Unlock()
return r.close(ctx)
}
// closes the session. callers *must* hold the client write lock before calling!
func (r *Receiver) close(ctx context.Context) error {
if r.doneListening != nil {
r.doneListening()
}
if r.cancelAuthRefresh != nil {
<-r.cancelAuthRefresh()
}
r.Closed = true
var lastErr error
if r.receiver != nil {
lastErr = r.receiver.Close(ctx)
if lastErr != nil {
tab.For(ctx).Error(lastErr)
}
}
if r.session != nil {
if err := r.session.Close(ctx); err != nil {
tab.For(ctx).Error(err)
lastErr = err
}
}
if r.client != nil {
if err := r.client.Close(); err != nil {
tab.For(ctx).Error(err)
lastErr = err
}
}
r.receiver = nil
r.session = nil
r.client = nil
return lastErr
}
// Recover will attempt to close the current session and link, then rebuild them
func (r *Receiver) Recover(ctx context.Context) error {
ctx, span := r.startConsumerSpanFromContext(ctx, "sb.Receiver.Recover")
defer span.End()
// we expect the Sender, session or client is in an error state, ignore errors
closeCtx, cancel := context.WithTimeout(ctx, 10*time.Second)
closeCtx = tab.NewContext(closeCtx, span)
defer cancel()
// we must close then rebuild the session/link atomically
r.clientMu.Lock()
defer r.clientMu.Unlock()
_ = r.close(closeCtx)
return r.newSessionAndLink(ctx)
}
// ReceiveOne will receive one message from the link
func (r *Receiver) ReceiveOne(ctx context.Context, handler Handler) error {
ctx, span := r.startConsumerSpanFromContext(ctx, "sb.Receiver.ReceiveOne")
defer span.End()
err := r.listenForMessage(ctx, newAmqpAdapterHandler(r, handler))
if err != nil {
tab.For(ctx).Error(err)
return err
}
return nil
}
// Listen start a listener for messages sent to the entity path
func (r *Receiver) Listen(ctx context.Context, handler Handler) *ListenerHandle {
ctx, done := context.WithCancel(ctx)
r.doneListening = done
ctx, span := r.startConsumerSpanFromContext(ctx, "sb.Receiver.Listen")
defer span.End()
go r.listenForMessages(ctx, newAmqpAdapterHandler(r, handler))
return &ListenerHandle{
r: r,
ctx: ctx,
}
}
func (r *Receiver) handleMessage(ctx context.Context, msg *amqp.Message, handler Handler) {
const optName = "sb.Receiver.handleMessage"
event, err := messageFromAMQPMessage(msg)
if err != nil {
_, span := r.startConsumerSpanFromContext(ctx, optName)
span.Logger().Error(err)
r.setLastError(err)
if r.doneListening != nil {
r.doneListening()
}
return
}
ctx, span := tab.StartSpanWithRemoteParent(ctx, optName, event)
defer span.End()
id := messageID(msg)
if idStr, ok := id.(string); ok {
span.AddAttributes(tab.StringAttribute("amqp.message.id", idStr))
}
if err := handler.Handle(ctx, event); err != nil {
// stop handling messages since the message consumer ran into an unexpected error
r.setLastError(err)
if r.doneListening != nil {
r.doneListening()
}
return
}
// nothing more to be done. The message was settled when it was accepted by the Receiver
if r.mode == ReceiveAndDeleteMode {
return
}
// nothing more to be done. The Receiver has no default disposition, so the handler is solely responsible for
// disposition
if r.DefaultDisposition == nil {
return
}
// default disposition is set, so try to send the disposition. If the message disposition has already been set, the
// underlying AMQP library will ignore the second disposition respecting the disposition of the handler func.
if err := r.DefaultDisposition(ctx); err != nil {
// if an error is returned by the default disposition, then we must alert the message consumer as we can't
// be sure the final message disposition.
tab.For(ctx).Error(err)
r.setLastError(err)
if r.doneListening != nil {
r.doneListening()
}
return
}
}
func (r *Receiver) listenForMessages(ctx context.Context, handler amqpHandler) {
ctx, span := r.startConsumerSpanFromContext(ctx, "sb.Receiver.listenForMessages")
defer span.End()
for {
err := r.listenForMessage(ctx, handler)
if err == nil {
continue
}
select {
case <-ctx.Done():
tab.For(ctx).Debug("context done")
return
default:
_, retryErr := common.Retry(10, 10*time.Second, func() (interface{}, error) {
ctx, sp := r.startConsumerSpanFromContext(ctx, "sb.Receiver.listenForMessages.tryRecover")
defer sp.End()
tab.For(ctx).Debug("recovering connection")
err := r.Recover(ctx)
if err == nil {
tab.For(ctx).Debug("recovered connection")
return nil, nil
}
select {
case <-ctx.Done():
return nil, ctx.Err()
default:
return nil, common.Retryable(err.Error())
}
})
if retryErr != nil {
tab.For(ctx).Debug("retried, but error was unrecoverable")
r.setLastError(retryErr)
if err := r.Close(ctx); err != nil {
tab.For(ctx).Error(err)
}
return
}
}
}
}
func (r *Receiver) setLastError(err error) {
r.lastErrorMu.Lock()
r.lastError = err
r.lastErrorMu.Unlock()
}
func (r *Receiver) listenForMessage(ctx context.Context, handler amqpHandler) error {
ctx, span := r.startConsumerSpanFromContext(ctx, "sb.Receiver.listenForMessage")
defer span.End()
var receiver *amqp.Receiver
r.clientMu.RLock()
if r.receiver == nil {
r.clientMu.RUnlock()
return r.connClosedError(ctx)
}
receiver = r.receiver
r.clientMu.RUnlock()
err := receiver.HandleMessage(ctx, func(message *amqp.Message) error {
return handler.Handle(ctx, message)
})
if err != nil {
tab.For(ctx).Debug(err.Error())
return err
}
return nil
}
func (r *Receiver) connClosedError(ctx context.Context) error {
name := "Receiver"
if r.Name != "" {
name = r.Name
}
err := ErrConnectionClosed(name)
tab.For(ctx).Error(err)
return err
}
// newSessionAndLink will replace the session and link on the Receiver
// NOTE: this does *not* take the write lock, callers must hold it as required!
func (r *Receiver) newSessionAndLink(ctx context.Context) error {
ctx, span := r.startConsumerSpanFromContext(ctx, "sb.Receiver.newSessionAndLink")
defer span.End()
client, err := r.namespace.newClient(ctx)
if err != nil {
tab.For(ctx).Error(err)
return err
}
r.client = client
r.cancelAuthRefresh, err = r.namespace.negotiateClaim(ctx, client, r.entityPath)
if err != nil {
tab.For(ctx).Error(err)
return err
}
amqpSession, err := client.NewSession()
if err != nil {
tab.For(ctx).Error(err)
return err
}
r.session, err = newSession(amqpSession)
if err != nil {
tab.For(ctx).Error(err)
return err
}
receiveMode := amqp.ModeSecond
if r.mode == ReceiveAndDeleteMode {
receiveMode = amqp.ModeFirst
}
opts := []amqp.LinkOption{
amqp.LinkSourceAddress(r.entityPath),
amqp.LinkReceiverSettle(receiveMode),
amqp.LinkCredit(r.prefetch),
}
if r.mode == ReceiveAndDeleteMode {
opts = append(opts, amqp.LinkSenderSettle(amqp.ModeSettled))
}
if opt, ok := r.getSessionFilterLinkOption(); ok {
opts = append(opts, opt)
}
amqpReceiver, err := amqpSession.NewReceiver(opts...)
if err != nil {
tab.For(ctx).Error(err)
return err
}
r.receiver = amqpReceiver
return nil
}
func (r *Receiver) getSessionFilterLinkOption() (amqp.LinkOption, bool) {
const name = "com.microsoft:session-filter"
const code = uint64(0x00000137000000C)
if !r.useSessions {
return nil, false
}
if r.sessionID == nil {
return amqp.LinkSourceFilter(name, code, nil), true
}
return amqp.LinkSourceFilter(name, code, r.sessionID), true
}
func messageID(msg *amqp.Message) interface{} {
var id interface{} = "null"
if msg.Properties != nil {
id = msg.Properties.MessageID
}
return id
}
// Close will close the listener
func (lc *ListenerHandle) Close(ctx context.Context) error {
return lc.r.Close(ctx)
}
// Done will close the channel when the listener has stopped
func (lc *ListenerHandle) Done() <-chan struct{} {
return lc.ctx.Done()
}
// Err will return the last error encountered
func (lc *ListenerHandle) Err() error {
lc.r.lastErrorMu.RLock()
defer lc.r.lastErrorMu.RUnlock()
if lc.r.lastError != nil {
return lc.r.lastError
}
return lc.ctx.Err()
}