forked from Azure/azure-sdk-for-go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
messageSettler_test.go
377 lines (295 loc) · 12 KB
/
messageSettler_test.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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package azservicebus
import (
"context"
"testing"
"time"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus/internal"
"github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus/internal/test"
"github.com/stretchr/testify/require"
)
func TestMessageSettlementUsingReceiver(t *testing.T) {
testStuff := newTestStuff(t)
defer testStuff.Close()
receiver, deadLetterReceiver := testStuff.Receiver, testStuff.DeadLetterReceiver
ctx := context.TODO()
err := testStuff.Sender.SendMessage(context.Background(), &Message{
Body: []byte("hello"),
}, nil)
require.NoError(t, err)
messages, err := receiver.ReceiveMessages(ctx, 1, nil)
require.NoError(t, err)
require.EqualValues(t, 1, messages[0].DeliveryCount)
// message from queue -> Abandon -> back to the queue
err = receiver.AbandonMessage(context.Background(), messages[0], &AbandonMessageOptions{
PropertiesToModify: map[string]any{
"hello": "world",
},
})
require.NoError(t, err)
messages, err = receiver.ReceiveMessages(ctx, 1, nil)
require.NoError(t, err)
require.EqualValues(t, 2, messages[0].DeliveryCount)
require.EqualValues(t, "world", messages[0].ApplicationProperties["hello"].(string))
// message from queue -> DeadLetter -> to the dead letter queue
err = receiver.DeadLetterMessage(ctx, messages[0], &DeadLetterOptions{
ErrorDescription: to.Ptr("the error description"),
Reason: to.Ptr("the error reason"),
})
require.NoError(t, err)
messages, err = deadLetterReceiver.ReceiveMessages(ctx, 1, nil)
require.NoError(t, err)
require.EqualValues(t, 2, messages[0].DeliveryCount)
require.EqualValues(t, "the error description", *messages[0].DeadLetterErrorDescription)
require.EqualValues(t, "the error reason", *messages[0].DeadLetterReason)
require.EqualValues(t, *messages[0].ExpiresAt, messages[0].EnqueuedTime.Add(*messages[0].TimeToLive))
// TODO: introducing deferred messages into the chain seems to have broken something.
// // message from dead letter queue -> Defer -> to the dead letter queue's deferred messages
// err = deadLetterReceiver.DeferMessage(ctx, msg)
// require.NoError(t, err)
// msg, err = deadLetterReceiver.receiveDeferredMessage(ctx, *msg.SequenceNumber)
// require.NoError(t, err)
// deferred message from dead letter queue -> Abandon -> dead letter queue
err = deadLetterReceiver.AbandonMessage(ctx, messages[0], &AbandonMessageOptions{
PropertiesToModify: map[string]any{
"hello": "world",
},
})
require.NoError(t, err)
messages, err = deadLetterReceiver.ReceiveMessages(ctx, 1, nil)
require.NoError(t, err)
require.EqualValues(t, 2, messages[0].DeliveryCount)
require.EqualValues(t, "world", messages[0].ApplicationProperties["hello"].(string))
// message from dead letter queue -> Complete -> (deleted from queue)
err = deadLetterReceiver.CompleteMessage(ctx, messages[0], nil)
require.NoError(t, err)
}
// TestMessageSettlementUsingReceiverWithReceiveAndDelete checks that we don't do anything
// bad if you attempt to settle a message received in ReceiveModeReceiveAndDelete. It should give
// back an error message, but otherwise cause no harm.
func TestMessageSettlementUsingReceiverWithReceiveAndDelete(t *testing.T) {
client, cleanup, queueName := setupLiveTest(t, nil)
defer cleanup()
sender, err := client.NewSender(queueName, nil)
require.NoError(t, err)
ctx := context.Background()
err = sender.SendMessage(context.Background(), &Message{
Body: []byte("hello"),
}, nil)
require.NoError(t, err)
receiver, err := client.NewReceiverForQueue(queueName, &ReceiverOptions{
ReceiveMode: ReceiveModeReceiveAndDelete,
})
require.NoError(t, err)
messages, err := receiver.ReceiveMessages(ctx, 1, nil)
require.NoError(t, err)
require.NotEmpty(t, messages)
require.EqualValues(t, internal.RecoveryKindFatal, internal.GetRecoveryKind(receiver.AbandonMessage(ctx, messages[0], nil)))
require.EqualValues(t, internal.RecoveryKindFatal, internal.GetRecoveryKind(receiver.CompleteMessage(ctx, messages[0], nil)))
require.EqualValues(t, internal.RecoveryKindFatal, internal.GetRecoveryKind(receiver.DeferMessage(ctx, messages[0], nil)))
require.EqualValues(t, internal.RecoveryKindFatal, internal.GetRecoveryKind(receiver.DeadLetterMessage(ctx, messages[0], nil)))
require.EqualError(t, receiver.DeadLetterMessage(ctx, messages[0], nil), "messages that are received in `ReceiveModeReceiveAndDelete` mode are not settleable")
}
func TestDeferredMessages(t *testing.T) {
ctx := context.TODO()
testStuff := newTestStuff(t)
defer testStuff.Close()
receiver := testStuff.Receiver
t.Run("Abandon", func(t *testing.T) {
originalDeferredMessage := testStuff.deferMessageForTest(t)
// abandoning the deferred message will increment its delivery count
err := receiver.AbandonMessage(ctx, originalDeferredMessage, &AbandonMessageOptions{
PropertiesToModify: map[string]any{
"hello": "world",
},
})
require.NoError(t, err)
// we can peek it without altering anything here.
peekedMessage := peekSingleMessageForTest(t, receiver, nil)
require.Equal(t, originalDeferredMessage.DeliveryCount+1, peekedMessage.DeliveryCount, "Delivery count is incremented")
})
t.Run("Complete", func(t *testing.T) {
msg := testStuff.deferMessageForTest(t)
err := receiver.CompleteMessage(ctx, msg, nil)
require.NoError(t, err)
assertEntityEmpty(t, receiver)
})
t.Run("Defer", func(t *testing.T) {
msg := testStuff.deferMessageForTest(t)
require.EqualValues(t, MessageStateDeferred, msg.State)
peekedMsg := peekSingleMessageForTest(t, receiver, nil)
require.EqualValues(t, MessageStateDeferred, peekedMsg.State)
// double defer!
err := receiver.DeferMessage(ctx, msg, &DeferMessageOptions{
PropertiesToModify: map[string]any{
"hello": "world",
},
})
require.NoError(t, err)
deferredMessages, err := receiver.ReceiveDeferredMessages(ctx, []int64{*msg.SequenceNumber}, nil)
require.NoError(t, err)
require.EqualValues(t, "world", deferredMessages[0].ApplicationProperties["hello"].(string))
err = receiver.CompleteMessage(ctx, deferredMessages[0], nil)
require.NoError(t, err)
assertEntityEmpty(t, receiver)
})
}
func TestDeferredMessage_DeadLettering(t *testing.T) {
testStuff := newTestStuff(t)
defer testStuff.Close()
receiver, deadLetterReceiver := testStuff.Receiver, testStuff.DeadLetterReceiver
msg := testStuff.deferMessageForTest(t)
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
err := receiver.DeadLetterMessage(ctx, msg, nil)
require.NoError(t, err)
// check that the message made it to the dead letter queue
messages, err := deadLetterReceiver.ReceiveMessages(context.Background(), 1, nil)
require.NoError(t, err)
// remove it from the DLQ
require.NoError(t, deadLetterReceiver.CompleteMessage(context.Background(), messages[0], nil))
// and...everything should be clean
assertEntityEmpty(t, deadLetterReceiver)
}
func TestMessageSettlementUsingOnlyBackupSettlement(t *testing.T) {
newConn, cleanup, queueName := setupLiveTest(t, nil)
t.Cleanup(cleanup)
sender, err := newConn.NewSender(queueName, nil)
require.NoError(t, err)
runTest := func(t *testing.T, whichToClose string, settlementFn func(*Receiver, *ReceivedMessage) error) {
err = sender.SendMessage(context.Background(), &Message{
Body: []byte("hello"),
}, nil)
require.NoError(t, err)
oldConn, err := NewClientFromConnectionString(test.GetConnectionString(t), nil)
require.NoError(t, err)
defer test.RequireClose(t, oldConn)
oldReceiver, err := oldConn.NewReceiverForQueue(queueName, nil)
require.NoError(t, err)
defer test.RequireClose(t, oldReceiver)
messages, err := oldReceiver.ReceiveMessages(context.Background(), 1, nil)
require.NoError(t, err)
switch whichToClose {
case "connection":
test.RequireClose(t, oldConn)
case "receiver":
test.RequireClose(t, oldReceiver)
case "":
// don't close anything.
default:
panic("Invalid `whichToClose` value " + whichToClose)
}
newReceiver, err := newConn.NewReceiverForQueue(queueName, nil)
require.NoError(t, err)
defer test.RequireClose(t, newReceiver)
onLink := false
onMgmt := false
newReceiver.settler.notifySettleOnLink = func(message *ReceivedMessage) { onLink = true }
newReceiver.settler.notifySettleOnManagement = func(message *ReceivedMessage) { onMgmt = true }
// old receiver is still open, so the settlement will occur there.
err = settlementFn(newReceiver, messages[0])
require.NoError(t, err)
switch whichToClose {
case "connection":
// we try to settle on the original link (and the entire connection is dead) so we fallback to the management link
require.True(t, onLink)
require.True(t, onMgmt)
case "receiver":
// we try to settle on the original link (which is dead) so we fallback to the management link
require.True(t, onLink)
require.True(t, onMgmt)
case "":
// original link was still alive so we can settle against it. No backup settlement required.
require.True(t, onLink)
require.False(t, onMgmt)
default:
panic("Invalid `whichToClose` value " + whichToClose)
}
}
tests := []struct {
Name string
F func(*Receiver, *ReceivedMessage) error
}{
{"Abandon", func(r *Receiver, rm *ReceivedMessage) error {
return r.AbandonMessage(context.Background(), rm, nil)
}},
{"Complete", func(r *Receiver, rm *ReceivedMessage) error {
return r.CompleteMessage(context.Background(), rm, nil)
}},
{"DeadLetter", func(r *Receiver, rm *ReceivedMessage) error {
return r.DeadLetterMessage(context.Background(), rm, nil)
}},
{"Defer", func(r *Receiver, rm *ReceivedMessage) error {
return r.DeferMessage(context.Background(), rm, nil)
}},
}
for _, test := range tests {
t.Run(test.Name+"_OriginalReceiverAlive", func(t *testing.T) {
runTest(t, "", test.F)
})
t.Run(test.Name+"_OriginalReceiverDead", func(t *testing.T) {
runTest(t, "receiver", test.F)
})
t.Run(test.Name+"_OriginalConnDead", func(t *testing.T) {
runTest(t, "connection", test.F)
})
}
}
type testStuff struct {
DeadLetterReceiver *Receiver
Receiver *Receiver
Sender *Sender
Require *require.Assertions
Client *Client
QueueName string
cleanup func()
}
func (t *testStuff) Close() {
t.cleanup()
}
func (t *testStuff) First(messages []*ReceivedMessage, err error) *ReceivedMessage {
t.Require.NoError(err)
t.Require.EqualValues([]string{"hello"}, getSortedBodies(messages))
return messages[0]
}
func newTestStuff(t *testing.T) *testStuff {
client, cleanup, queueName := setupLiveTest(t, nil)
testStuff := &testStuff{
cleanup: cleanup,
Require: require.New(t),
Client: client,
QueueName: queueName,
}
var err error
testStuff.Receiver, err = client.NewReceiverForQueue(queueName, nil)
require.NoError(t, err)
testStuff.Sender, err = client.NewSender(queueName, nil)
require.NoError(t, err)
testStuff.DeadLetterReceiver, err = client.NewReceiverForQueue(
queueName, &ReceiverOptions{SubQueue: SubQueueDeadLetter})
require.NoError(t, err)
return testStuff
}
func assertEntityEmpty(t *testing.T, receiver *Receiver) {
messages, err := receiver.PeekMessages(context.TODO(), 1, nil)
require.NoError(t, err)
require.Empty(t, messages)
}
// deferMessageForTest defers a message with a message body of 'hello'.
func (testStuff *testStuff) deferMessageForTest(t *testing.T) *ReceivedMessage {
err := testStuff.Sender.SendMessage(context.Background(), &Message{
Body: []byte("hello"),
}, nil)
require.NoError(t, err)
messages, err := testStuff.Receiver.ReceiveMessages(context.Background(), 1, nil)
require.NoError(t, err)
require.NotEmpty(t, messages)
require.EqualValues(t, 1, messages[0].DeliveryCount)
err = testStuff.Receiver.DeferMessage(context.Background(), messages[0], nil)
require.NoError(t, err)
messages, err = testStuff.Receiver.ReceiveDeferredMessages(context.Background(), []int64{*messages[0].SequenceNumber}, nil)
require.NoError(t, err)
return messages[0]
}