Repository navigation
Expand file tree
/
Copy pathtest_app.py
More file actions
582 lines (469 loc) · 28.2 KB
/
Copy pathtest_app.py
File metadata and controls
582 lines (469 loc) · 28.2 KB
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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
"""The runtime: publish, @handler routing, retry and dead-lettering.
All tests use the in-memory transport — no broker required.
"""
from __future__ import annotations
import json
import unittest
from babelqueue import BabelQueue, EnvelopeCodec, UnknownUrnStrategy
from babelqueue.transport import InMemoryTransport, ReceivedMessage
class AppTest(unittest.TestCase):
def test_publish_then_consume_invokes_handler_and_acks(self) -> None:
app = BabelQueue("memory://", queue="orders")
seen = {}
@app.handler("urn:babel:orders:created")
def handle(data, meta): # noqa: ANN001
seen["data"] = data
seen["meta"] = meta
msg_id = app.publish("urn:babel:orders:created", {"order_id": 7})
processed = app.consume(max_messages=1)
self.assertEqual(processed, 1)
self.assertEqual(seen["data"], {"order_id": 7})
self.assertEqual(seen["meta"]["lang"], "python")
self.assertEqual(seen["meta"]["id"], msg_id)
self.assertEqual(app.transport.size("orders"), 0) # acked / drained
def test_three_arg_handler_receives_full_envelope(self) -> None:
app = BabelQueue("memory://")
seen = {}
@app.handler("urn:babel:orders:created")
def handle(data, meta, message): # noqa: ANN001
seen["trace"] = message["trace_id"]
seen["job"] = message["job"]
app.publish("urn:babel:orders:created", {}, trace_id="trace-1")
app.consume(max_messages=1)
self.assertEqual(seen["trace"], "trace-1")
self.assertEqual(seen["job"], "urn:babel:orders:created")
def test_round_trips_with_the_canonical_codec(self) -> None:
app = BabelQueue("memory://", queue="orders")
captured = {}
@app.handler("urn:babel:orders:created")
def handle(data, meta): # noqa: ANN001
captured.update(data)
app.publish("urn:babel:orders:created", {"order_id": 9, "amount": "9.90"})
# the raw body on the queue is a canonical envelope decodable by any SDK
raw = app.transport._queues["orders"][0] # noqa: SLF001 - test introspection
env = EnvelopeCodec.decode(raw)
self.assertEqual(list(env.keys()), ["job", "trace_id", "data", "meta", "attempts"])
app.consume(max_messages=1)
self.assertEqual(captured, {"order_id": 9, "amount": "9.90"})
def test_route_urn_overrides_the_body_urn_without_rewriting_the_body(self) -> None:
app = BabelQueue("memory://", queue="orders")
seen = []
@app.handler("urn:babel:orders:created")
def handle(data, meta, message): # noqa: ANN001
seen.append(message["job"])
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:billing:invoiced", {}, queue="orders"))
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn="urn:babel:orders:created"))
self.assertEqual(seen, ["urn:babel:billing:invoiced"]) # handler sees the original body
def test_route_urn_never_rescues_an_undecodable_body(self) -> None:
app = BabelQueue("memory://", queue="orders")
seen = []
@app.handler("urn:babel:orders:created")
def handle(data, meta): # noqa: ANN001
seen.append(data)
app.dispatch(ReceivedMessage(body="not-json", queue="orders", route_urn="urn:babel:orders:created"))
self.assertEqual(seen, []) # poison path (unknown URN / retry), never the handler
def test_retry_and_release_republish_carry_the_route_urn(self) -> None:
class RoutedMemory(InMemoryTransport):
def __init__(self) -> None:
super().__init__()
self.routed = []
def publish_routed(self, queue, body, route_urn): # noqa: ANN001
self.routed.append((queue, body, route_urn))
route = "urn:babel:orders:created"
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:billing:invoiced", {}, queue="orders"))
tr = RoutedMemory()
app = BabelQueue(transport=tr, queue="orders", max_attempts=3)
@app.handler(route)
def boom(data, meta): # noqa: ANN001
raise RuntimeError("boom")
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn=route))
self.assertEqual([r[2] for r in tr.routed], [route])
self.assertEqual(EnvelopeCodec.decode(tr.routed[0][1])["attempts"], 1)
tr2 = RoutedMemory()
app2 = BabelQueue(transport=tr2, queue="orders", on_unknown_urn=UnknownUrnStrategy.RELEASE)
app2.dispatch(ReceivedMessage(body=body, queue="orders", route_urn="urn:babel:orders:nope"))
self.assertEqual([(r[1], r[2]) for r in tr2.routed], [(body, "urn:babel:orders:nope")])
tr3 = RoutedMemory() # no route_urn -> plain publish, not publish_routed
app3 = BabelQueue(transport=tr3, queue="orders", max_attempts=3)
app3.handler("urn:babel:billing:invoiced")(boom)
app3.dispatch(ReceivedMessage(body=body, queue="orders"))
self.assertEqual(tr3.routed, [])
self.assertEqual(tr3.size("orders"), 1)
def test_dead_letter_write_carries_the_route_urn(self) -> None:
class RoutedMemory(InMemoryTransport):
def __init__(self) -> None:
super().__init__()
self.routed = []
def publish_routed(self, queue, body, route_urn): # noqa: ANN001
self.routed.append((queue, body, route_urn))
route = "urn:babel:orders:created"
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:billing:invoiced", {}, queue="orders"))
tr = RoutedMemory()
app = BabelQueue(transport=tr, queue="orders", max_attempts=1, dead_letter=True)
@app.handler(route)
def boom(data, meta): # noqa: ANN001
raise RuntimeError("boom")
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn=route))
self.assertEqual([(r[0], r[2]) for r in tr.routed], [("orders.dlq", route)])
self.assertEqual(EnvelopeCodec.decode(tr.routed[0][1])["dead_letter"]["original_queue"], "orders")
tr2 = RoutedMemory() # no route_urn -> plain publish into the DLQ
app2 = BabelQueue(transport=tr2, queue="orders", max_attempts=1, dead_letter=True)
app2.handler("urn:babel:billing:invoiced")(boom)
app2.dispatch(ReceivedMessage(body=body, queue="orders"))
self.assertEqual(tr2.routed, [])
self.assertEqual(tr2.size("orders.dlq"), 1)
def test_empty_route_urn_routes_on_the_body_urn(self) -> None:
app = BabelQueue("memory://", queue="orders")
seen = []
@app.handler("urn:babel:orders:created")
def handle(data, meta): # noqa: ANN001
seen.append(data)
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {"a": 1}, queue="orders"))
app.dispatch(ReceivedMessage(body=body, queue="orders"))
self.assertEqual(seen, [{"a": 1}])
def test_unknown_urn_delete_drops_message(self) -> None:
app = BabelQueue("memory://", queue="q", on_unknown_urn=UnknownUrnStrategy.DELETE)
app.publish("urn:babel:nobody", {})
app.consume(max_messages=1)
self.assertEqual(app.transport.size("q"), 0)
def test_unknown_urn_dead_letter_quarantines(self) -> None:
app = BabelQueue(
"memory://", queue="q",
on_unknown_urn=UnknownUrnStrategy.DEAD_LETTER, dead_letter=True,
)
app.publish("urn:babel:nobody", {"x": 1})
app.consume(max_messages=1)
self.assertEqual(app.transport.size("q"), 0)
dlq_raw = app.transport._queues["q.dlq"][0] # noqa: SLF001
env = EnvelopeCodec.decode(dlq_raw)
self.assertEqual(env["dead_letter"]["reason"], "unknown_urn")
self.assertEqual(env["dead_letter"]["original_queue"], "q")
def test_handler_failure_retries_then_dead_letters(self) -> None:
app = BabelQueue("memory://", queue="orders", max_attempts=2, dead_letter=True)
calls = {"n": 0}
@app.handler("urn:babel:orders:created")
def handle(data, meta): # noqa: ANN001
calls["n"] += 1
raise RuntimeError("boom")
app.publish("urn:babel:orders:created", {"order_id": 1})
# attempt 1 -> requeue, attempt 2 -> dead-letter
app.consume(max_messages=5)
self.assertEqual(calls["n"], 2)
self.assertEqual(app.transport.size("orders"), 0)
dlq_raw = app.transport._queues["orders.dlq"][0] # noqa: SLF001
env = EnvelopeCodec.decode(dlq_raw)
self.assertEqual(env["dead_letter"]["reason"], "failed")
self.assertEqual(env["dead_letter"]["error"], "boom")
self.assertEqual(env["dead_letter"]["attempts"], 2)
def test_failure_without_dlq_drops_after_max_attempts(self) -> None:
app = BabelQueue("memory://", queue="orders", max_attempts=1, dead_letter=False)
@app.handler("urn:babel:orders:created")
def handle(data, meta): # noqa: ANN001
raise RuntimeError("nope")
app.publish("urn:babel:orders:created", {})
app.consume(max_messages=3)
self.assertEqual(app.transport.size("orders"), 0)
self.assertEqual(app.transport.size("orders.dlq"), 0)
def _redeliver_until_settled(self, app, queue, route_urn, first_body, limit=6):
"""Feed ``first_body`` through ``dispatch`` and keep redelivering whatever the runtime
re-publishes to ``queue`` (as a broker would); returns the number of deliveries."""
tr = app.transport
body = first_body
deliveries = 0
while body is not None and deliveries < limit:
deliveries += 1
app.dispatch(ReceivedMessage(body=body, queue=queue, route_urn=route_urn))
body = tr._queues[queue].popleft() if tr._queues.get(queue) else None # noqa: SLF001
return deliveries
def test_version_gated_prefix_is_the_same_in_every_gating_transport(self) -> None:
from babelqueue import (
artemis_transport, asb_transport, kafka_transport, pulsar_transport, sqs_transport,
)
from babelqueue.app import _UNSUPPORTED_SCHEMA_ROUTE_PREFIX
for module in (
artemis_transport, asb_transport, kafka_transport, pulsar_transport, sqs_transport,
):
with self.subTest(module=module.__name__):
self.assertEqual(
_UNSUPPORTED_SCHEMA_ROUTE_PREFIX, module.UNSUPPORTED_SCHEMA_ROUTE_PREFIX
)
def test_version_gated_message_is_dead_lettered_directly_without_retry(self) -> None:
from babelqueue.app import _UNSUPPORTED_SCHEMA_ROUTE_PREFIX
route = _UNSUPPORTED_SCHEMA_ROUTE_PREFIX + "2"
decodable = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
for strategy in (UnknownUrnStrategy.RELEASE, UnknownUrnStrategy.FAIL, UnknownUrnStrategy.DEAD_LETTER):
for name, body in (("decodable", decodable), ("undecodable", "{not json")):
with self.subTest(strategy=strategy, body=name):
app = BabelQueue(
"memory://", queue="orders", max_attempts=5, dead_letter=True,
on_unknown_urn=strategy,
)
seen = []
app.handler("urn:babel:orders:created")(lambda d, m: seen.append(d))
deliveries = self._redeliver_until_settled(app, "orders", route, body)
self.assertEqual(deliveries, 1) # one delivery, max_attempts notwithstanding
self.assertEqual(seen, []) # never reaches the handler
self.assertEqual(app.transport.size("orders"), 0)
self.assertEqual(app.transport.size("orders.dlq"), 1)
# The gate rejects without decoding: the DLQ record is the incoming raw body,
# byte-identical, with no dead_letter block (even for an undecodable body).
dead = app.transport._queues["orders.dlq"][0] # noqa: SLF001
self.assertEqual(dead, body)
self.assertNotIn("dead_letter", dead)
def test_version_gated_message_whose_dead_letter_write_fails_is_not_retried(self) -> None:
from babelqueue.app import _UNSUPPORTED_SCHEMA_ROUTE_PREFIX
class FailingDlq(InMemoryTransport):
def __init__(self) -> None:
super().__init__()
self.acked = 0
def publish(self, queue, body) -> None: # noqa: ANN001
if queue.endswith(".dlq"):
raise RuntimeError("dlq write refused")
super().publish(queue, body)
def ack(self, received) -> None: # noqa: ANN001
self.acked += 1
route = _UNSUPPORTED_SCHEMA_ROUTE_PREFIX + "2"
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
for strategy in (UnknownUrnStrategy.RELEASE, UnknownUrnStrategy.FAIL, UnknownUrnStrategy.DEAD_LETTER):
with self.subTest(strategy=strategy):
tr = FailingDlq()
app = BabelQueue(
transport=tr, queue="orders", max_attempts=5, dead_letter=True,
on_unknown_urn=strategy,
)
seen = []
app.handler("urn:babel:orders:created")(lambda d, m: seen.append(d))
for _ in range(3): # the broker keeps redelivering it
with self.assertLogs("babelqueue.app", level="ERROR"):
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn=route))
self.assertEqual(seen, [])
self.assertEqual(tr.size("orders"), 0) # no retry re-publish
self.assertEqual(tr.acked, 0) # left for redelivery
def test_failed_gate_dead_letter_write_rewinds_a_rewinder_transport(self) -> None:
from babelqueue.app import _UNSUPPORTED_SCHEMA_ROUTE_PREFIX
class RewindingDlq(InMemoryTransport):
def __init__(self, fail_rewind: bool = False) -> None:
super().__init__()
self.rewound = []
self.fail_rewind = fail_rewind
def publish(self, queue, body) -> None: # noqa: ANN001
if queue.endswith(".dlq"):
raise RuntimeError("dlq write refused")
super().publish(queue, body)
def rewind(self, message) -> None: # noqa: ANN001
self.rewound.append(message)
if self.fail_rewind:
raise RuntimeError("seek refused")
route = _UNSUPPORTED_SCHEMA_ROUTE_PREFIX + "2"
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
for fail_rewind in (False, True):
with self.subTest(fail_rewind=fail_rewind):
tr = RewindingDlq(fail_rewind=fail_rewind)
app = BabelQueue(transport=tr, queue="orders", max_attempts=5, dead_letter=True)
app._rewind_pause = 0.0 # noqa: SLF001
received = ReceivedMessage(body=body, queue="orders", route_urn=route)
with self.assertLogs("babelqueue.app", level="ERROR"):
app.dispatch(received)
self.assertEqual(tr.rewound, [received])
self.assertEqual(tr.size("orders"), 0)
def test_a_failed_retry_release_on_a_non_rewinder_transport_is_left_unacknowledged(self) -> None:
# A failing ``redeliver`` (SQS ChangeMessageVisibility / Redis republish error) must neither
# ack the delivery (it would be lost) nor kill the loop; the broker redelivers it on its own.
class FailingRedeliver(InMemoryTransport):
def __init__(self) -> None:
super().__init__()
self.acked = 0
self.redeliveries = 0
def redeliver(self, message, body, delay) -> None: # noqa: ANN001
self.redeliveries += 1
raise RuntimeError("release refused")
def ack(self, received) -> None: # noqa: ANN001
self.acked += 1
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
tr = FailingRedeliver()
app = BabelQueue(transport=tr, queue="orders", max_attempts=5, dead_letter=True)
app._rewind_pause = 0.0 # noqa: SLF001
@app.handler("urn:babel:orders:created")
def _boom(data, meta): # noqa: ANN001
raise RuntimeError("handler failure")
with self.assertLogs("babelqueue.app", level="ERROR"):
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn="")) # must not raise
self.assertEqual(tr.redeliveries, 1)
self.assertEqual(tr.acked, 0)
self.assertEqual(tr.size("orders"), 0)
def test_a_failed_unknown_urn_release_is_left_unacknowledged(self) -> None:
class FailingRedeliver(InMemoryTransport):
def __init__(self) -> None:
super().__init__()
self.acked = 0
def redeliver(self, message, body, delay) -> None: # noqa: ANN001
raise RuntimeError("release refused")
def ack(self, received) -> None: # noqa: ANN001
self.acked += 1
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:unknown:thing", {}, queue="orders"))
tr = FailingRedeliver()
app = BabelQueue(
transport=tr, queue="orders", max_attempts=1, dead_letter=False,
on_unknown_urn=UnknownUrnStrategy.RELEASE,
)
app._rewind_pause = 0.0 # noqa: SLF001
with self.assertLogs("babelqueue.app", level="ERROR"):
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn="")) # must not raise
self.assertEqual(tr.acked, 0) # not dropped through the exhausted-retry path
def test_version_gated_message_without_dead_letter_is_dropped_without_retry(self) -> None:
route = "babelqueue:unsupported-schema-version:x"
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
for strategy in (UnknownUrnStrategy.RELEASE, UnknownUrnStrategy.FAIL):
with self.subTest(strategy=strategy):
app = BabelQueue("memory://", queue="orders", max_attempts=5, on_unknown_urn=strategy)
self.assertEqual(self._redeliver_until_settled(app, "orders", route, body), 1)
self.assertEqual(app.transport.size("orders"), 0)
def test_dropping_a_version_gated_message_without_a_dead_letter_queue_is_logged(self) -> None:
route = "babelqueue:unsupported-schema-version:x"
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
app = BabelQueue("memory://", queue="orders", max_attempts=5)
with self.assertLogs("babelqueue.app", level="WARNING") as logs:
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn=route))
self.assertIn("Dropping", logs.output[0])
self.assertIn("orders", logs.output[0])
def test_unknown_urn_release_still_releases_verbatim(self) -> None:
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:nope", {}, queue="orders"))
app = BabelQueue(
"memory://", queue="orders", max_attempts=2, dead_letter=True,
on_unknown_urn=UnknownUrnStrategy.RELEASE,
)
for route_urn in ("", "urn:babel:orders:nope"):
with self.subTest(route_urn=route_urn):
app.dispatch(ReceivedMessage(body=body, queue="orders", route_urn=route_urn))
self.assertEqual(app.transport.size("orders.dlq"), 0)
self.assertEqual(app.transport._queues["orders"].popleft(), body) # noqa: SLF001
def test_poison_is_dead_lettered_at_once_under_release_when_the_dlq_is_on(self) -> None:
# ADR-0036 decisions 2/4/6: a body that does not decode, or names no identity, is poison.
# With the DLQ on it is written as the ADR-0035 record (reason ``poison``) on its first
# delivery, with no retry, whatever the unknown-URN strategy says.
no_urn = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
no_urn = no_urn.replace('"urn:babel:orders:created"', '""')
for name, body in (("undecodable", "{not json"), ("no-urn", no_urn)):
with self.subTest(body=name):
app = BabelQueue(
"memory://", queue="orders", max_attempts=3, dead_letter=True,
on_unknown_urn=UnknownUrnStrategy.RELEASE,
)
self.assertEqual(self._redeliver_until_settled(app, "orders", "", body), 1)
self.assertEqual(app.transport.size("orders"), 0)
self.assertEqual(app.transport.size("orders.dlq"), 1)
record = json.loads(app.transport._queues["orders.dlq"][0]) # noqa: SLF001
self.assertEqual(record["dead_letter"]["reason"], "poison")
def test_poison_is_bounded_under_release_when_the_dlq_is_off(self) -> None:
# Dead-lettering off: RELEASE is replaced by the bounded FAIL path (a poison body would
# otherwise be released forever): max_attempts deliveries, then a logged drop.
no_urn = EnvelopeCodec.encode(EnvelopeCodec.make("urn:babel:orders:created", {}, queue="orders"))
no_urn = no_urn.replace('"urn:babel:orders:created"', '""')
for name, body in (("undecodable", "{not json"), ("no-urn", no_urn)):
with self.subTest(body=name):
app = BabelQueue(
"memory://", queue="orders", max_attempts=3, on_unknown_urn=UnknownUrnStrategy.RELEASE,
)
with self.assertLogs("babelqueue.app", level="WARNING"):
self.assertEqual(self._redeliver_until_settled(app, "orders", "", body), 3)
self.assertEqual(app.transport.size("orders"), 0)
self.assertEqual(app.transport.size("orders.dlq"), 0)
def test_unsupported_broker_scheme_raises(self) -> None:
from babelqueue import BabelQueueError
with self.assertRaises(BabelQueueError):
BabelQueue("frobnicate://localhost:9092")
if __name__ == "__main__":
unittest.main()
class _AckRecordingTransport(InMemoryTransport):
"""In-memory transport that records every ack; ``settle_native`` is added by a subclass."""
def __init__(self) -> None:
super().__init__()
self.acks = 0
def ack(self, message: ReceivedMessage) -> None:
self.acks += 1
class _NativeTransport(_AckRecordingTransport):
"""The optional :class:`~babelqueue.transport.NativeSettler` capability (SQS, Azure Service Bus)."""
def __init__(self, fail: bool = False) -> None:
super().__init__()
self.natives: list = []
self._fail = fail
def settle_native(self, message: ReceivedMessage, reason: str, description: str) -> None:
self.natives.append(reason)
if self._fail:
raise RuntimeError("broker unavailable")
class NativeSettleTest(unittest.TestCase):
"""ADR-0037 decisions 1 and 2: with the DLQ off, a transport with a native mechanism gets
``settle_native`` instead of an ack (version-gated) or the bounded retry (poison)."""
GATE = "babelqueue:unsupported-schema-version:2"
RAW = '{"job":"urn:babel:orders:created","data":{},"meta":{"schema_version":2}}'
def _app(self, transport, **kwargs) -> BabelQueue:
app = BabelQueue(transport=transport, queue="orders", max_attempts=5, **kwargs)
app.register("urn:babel:orders:created", lambda data, meta: None)
return app
def test_a_version_gated_delivery_is_left_to_the_native_mechanism(self) -> None:
for kwargs in ({}, {"on_unknown_urn": UnknownUrnStrategy.RELEASE}, {"on_unknown_urn": UnknownUrnStrategy.FAIL}):
with self.subTest(**kwargs):
transport = _NativeTransport()
app = self._app(transport, **kwargs)
with self.assertLogs("babelqueue.app", level="WARNING"):
app.dispatch(ReceivedMessage(body=self.RAW, queue="orders", route_urn=self.GATE))
self.assertEqual(["unsupported schema version"], transport.natives)
self.assertEqual(0, transport.acks)
self.assertEqual(0, transport.size("orders"))
self.assertEqual(0, transport.size("orders.dlq"))
def test_delete_and_dead_lettering_keep_their_settle_for_a_gated_delivery(self) -> None:
transport = _NativeTransport()
app = self._app(transport, on_unknown_urn=UnknownUrnStrategy.DELETE)
app.dispatch(ReceivedMessage(body=self.RAW, queue="orders", route_urn=self.GATE))
self.assertEqual((0, 1), (len(transport.natives), transport.acks))
for kwargs in ({"dead_letter": True}, {"on_unknown_urn": UnknownUrnStrategy.DEAD_LETTER}):
with self.subTest(**kwargs):
transport = _NativeTransport()
app = self._app(transport, **kwargs)
app.dispatch(ReceivedMessage(body=self.RAW, queue="orders", route_urn=self.GATE))
self.assertEqual((0, 1), (len(transport.natives), transport.acks))
self.assertEqual(self.RAW, transport._queues["orders.dlq"][0]) # noqa: SLF001
def test_a_transport_without_the_capability_still_acks_and_drops_a_gated_delivery(self) -> None:
transport = _AckRecordingTransport()
app = self._app(transport)
with self.assertLogs("babelqueue.app", level="WARNING"):
app.dispatch(ReceivedMessage(body=self.RAW, queue="orders", route_urn=self.GATE))
self.assertEqual(1, transport.acks)
def test_a_poison_body_is_settled_natively_on_the_first_delivery(self) -> None:
for body in ("not json", '{"foo":1}', '{"job":" ","attempts":0}', "[1]"):
for strategy in (UnknownUrnStrategy.FAIL, UnknownUrnStrategy.RELEASE):
with self.subTest(body=body, strategy=strategy):
transport = _NativeTransport()
app = self._app(transport, on_unknown_urn=strategy)
with self.assertLogs("babelqueue.app", level="WARNING"):
app.dispatch(ReceivedMessage(body=body, queue="orders"))
self.assertEqual(["poison"], transport.natives)
self.assertEqual(0, transport.acks)
self.assertEqual(0, transport.size("orders")) # nothing re-published
self.assertEqual(0, transport.size("orders.dlq"))
def test_delete_and_dead_lettering_keep_their_settle_for_a_poison_body(self) -> None:
transport = _NativeTransport()
app = self._app(transport, on_unknown_urn=UnknownUrnStrategy.DELETE)
with self.assertLogs("babelqueue.app", level="WARNING"):
app.dispatch(ReceivedMessage(body="not json", queue="orders"))
self.assertEqual((0, 1), (len(transport.natives), transport.acks))
for kwargs in ({"dead_letter": True}, {"on_unknown_urn": UnknownUrnStrategy.DEAD_LETTER}):
with self.subTest(**kwargs):
transport = _NativeTransport()
app = self._app(transport, **kwargs)
app.dispatch(ReceivedMessage(body="not json", queue="orders"))
self.assertEqual((0, 1), (len(transport.natives), transport.acks))
self.assertEqual(1, transport.size("orders.dlq"))
self.assertEqual("poison", json.loads(transport._queues["orders.dlq"][0])["dead_letter"]["reason"]) # noqa: SLF001
def test_a_transport_without_the_capability_keeps_the_bounded_poison_retry(self) -> None:
transport = _AckRecordingTransport()
app = self._app(transport)
app.dispatch(ReceivedMessage(body="not json", queue="orders"))
self.assertEqual(1, transport.acks) # the original is acknowledged ...
self.assertEqual(1, transport.size("orders")) # ... and an empty envelope is re-published
def test_a_failing_native_settle_neither_acks_nor_retries(self) -> None:
transport = _NativeTransport(fail=True)
app = self._app(transport)
with self.assertLogs("babelqueue.app", level="ERROR"):
app.dispatch(ReceivedMessage(body="not json", queue="orders"))
self.assertEqual((["poison"], 0, 0), (transport.natives, transport.acks, transport.size("orders")))