forked from microsoft/durabletask-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_worker_resiliency.py
More file actions
864 lines (660 loc) · 27.6 KB
/
Copy pathtest_worker_resiliency.py
File metadata and controls
864 lines (660 loc) · 27.6 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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
import asyncio
import grpc
from threading import Event, Timer
from unittest.mock import MagicMock
import pytest
from durabletask.grpc_options import GrpcWorkerResiliencyOptions
from durabletask.internal import orchestrator_service_pb2 as pb
from durabletask.worker import (
_AsyncWorkerManager,
ConcurrencyOptions,
TaskHubGrpcWorker,
_WorkItemStreamOutcome,
)
class FakeRpcError(grpc.RpcError):
def __init__(self, status_code: grpc.StatusCode, details: str):
super().__init__()
self._status_code = status_code
self._details = details
def code(self):
return self._status_code
def details(self):
return self._details
def __str__(self):
return self._details
class FakeResponseStream:
def __init__(self, items=(), error: grpc.RpcError | None = None):
self._items = list(items)
self._error = error
self.cancelled = False
def __iter__(self):
yield from self._items
if self._error is not None:
raise self._error
def cancel(self):
self.cancelled = True
class BlockingResponseStream:
def __init__(self):
self._cancel_event = Event()
self.cancelled = False
def __iter__(self):
if not self._cancel_event.wait(timeout=0.5):
raise AssertionError("response stream was not cancelled")
return
yield
def cancel(self):
self.cancelled = True
self._cancel_event.set()
class DummyWorkerManager:
def __init__(self):
self._shutdown_event = asyncio.Event()
self.submissions: list[tuple[str, tuple]] = []
def prepare_for_run(self):
self._shutdown_event = asyncio.Event()
async def run(self):
await self._shutdown_event.wait()
def submit_orchestration(self, *args):
self.submissions.append(("orchestrator", args))
def submit_activity(self, *args):
self.submissions.append(("activity", args))
def submit_entity_batch(self, *args):
self.submissions.append(("entity", args))
def shutdown(self):
self._shutdown_event.set()
def _complete_activity_request(req, stub, completion_token):
stub.CompleteActivityTask(
pb.ActivityResponse(
instanceId=req.orchestrationInstance.instanceId,
taskId=req.taskId,
completionToken=completion_token,
)
)
def _make_activity_work_item(
task_id: int = 1,
completion_token: str = "token",
instance_id: str = "instance-id",
) -> pb.WorkItem:
return pb.WorkItem(
activityRequest=pb.ActivityRequest(
name="test_activity",
taskId=task_id,
orchestrationInstance=pb.OrchestrationInstance(instanceId=instance_id),
),
completionToken=completion_token,
)
async def _wait_for_condition(predicate, *, timeout: float = 2.0):
loop = asyncio.get_running_loop()
deadline = loop.time() + timeout
while not predicate():
if loop.time() >= deadline:
raise AssertionError("condition was not met before timeout")
await asyncio.sleep(0.01)
@pytest.mark.asyncio
async def test_async_worker_manager_honors_shutdown_requested_before_run():
manager = _AsyncWorkerManager(
ConcurrencyOptions(maximum_thread_pool_workers=1),
MagicMock(),
)
manager.shutdown()
await asyncio.wait_for(manager.run(), timeout=1.0)
@pytest.mark.asyncio
async def test_async_worker_manager_recreates_thread_pool_after_run():
manager = _AsyncWorkerManager(
ConcurrencyOptions(maximum_thread_pool_workers=1),
MagicMock(),
)
original_pool = manager.thread_pool
manager.shutdown()
await asyncio.wait_for(manager.run(), timeout=1.0)
assert manager._pool_is_shutdown is True
manager.prepare_for_run()
assert manager._pool_is_shutdown is False
assert manager.thread_pool is not original_pool
def test_worker_start_clears_prior_shutdown_request():
worker = TaskHubGrpcWorker()
worker._shutdown.set()
run_started = Event()
async def fake_run_loop():
run_started.set()
worker._async_run_loop = fake_run_loop
worker.start()
worker._runLoop.join(timeout=1.0)
assert run_started.is_set() is True
assert worker._shutdown.is_set() is False
worker.stop()
def test_worker_classifies_graceful_close_before_first_message():
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(silent_disconnect_timeout_seconds=5.0)
)
outcome = worker._classify_stream_outcome(
saw_message=False,
timed_out=False,
)
assert outcome is _WorkItemStreamOutcome.GRACEFUL_CLOSE_BEFORE_FIRST_MESSAGE
def test_worker_classifies_graceful_close_after_message():
worker = TaskHubGrpcWorker()
outcome = worker._classify_stream_outcome(
saw_message=True,
timed_out=False,
)
assert outcome is _WorkItemStreamOutcome.GRACEFUL_CLOSE_AFTER_MESSAGE
def test_worker_classifies_silent_disconnect():
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(silent_disconnect_timeout_seconds=5.0)
)
outcome = worker._classify_stream_outcome(
saw_message=False,
timed_out=True,
)
assert outcome is _WorkItemStreamOutcome.SILENT_DISCONNECT
def test_worker_counts_only_transport_failures_for_recreation():
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(channel_recreate_failure_threshold=2)
)
assert worker._should_count_worker_failure(grpc.StatusCode.UNAVAILABLE) is True
assert worker._should_count_worker_failure(grpc.StatusCode.UNAUTHENTICATED) is False
def test_worker_does_not_recreate_caller_owned_channel():
worker = TaskHubGrpcWorker(channel=MagicMock())
assert worker._owns_channel is False
@pytest.mark.asyncio
async def test_worker_applies_configured_hello_timeout(monkeypatch):
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(hello_timeout_seconds=12.5)
)
worker._async_worker_manager = DummyWorkerManager()
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
stub = MagicMock()
stub.GetWorkItems.side_effect = FakeRpcError(grpc.StatusCode.CANCELLED, "stop")
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", lambda *args, **kwargs: MagicMock())
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", lambda channel: stub)
await worker._async_run_loop()
assert stub.Hello.call_args.kwargs["timeout"] == 12.5
@pytest.mark.asyncio
async def test_worker_does_not_recreate_sdk_owned_channel_for_non_transport_setup_errors(monkeypatch):
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(channel_recreate_failure_threshold=2)
)
worker._async_worker_manager = DummyWorkerManager()
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
first_stub = MagicMock()
first_stub.Hello.side_effect = RuntimeError("boom")
second_stub = MagicMock()
second_stub.GetWorkItems.side_effect = FakeRpcError(grpc.StatusCode.CANCELLED, "stop")
stubs = [first_stub, second_stub]
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr(
"durabletask.worker.stubs.TaskHubSidecarServiceStub",
lambda channel: stubs.pop(0),
)
await worker._async_run_loop()
assert len(created_channels) == 1
@pytest.mark.asyncio
async def test_worker_recreates_sdk_owned_channel_after_transport_failure_threshold(monkeypatch):
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(channel_recreate_failure_threshold=2)
)
worker._async_worker_manager = DummyWorkerManager()
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
stubs = [
MagicMock(GetWorkItems=MagicMock(return_value=FakeResponseStream(error=FakeRpcError(
grpc.StatusCode.UNAVAILABLE,
"first transport failure",
)))),
MagicMock(GetWorkItems=MagicMock(return_value=FakeResponseStream(error=FakeRpcError(
grpc.StatusCode.UNAVAILABLE,
"second transport failure",
)))),
MagicMock(GetWorkItems=MagicMock(side_effect=FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
))),
]
stub_channels = []
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert len(created_channels) == 2
assert stub_channels[0] is created_channels[0]
assert stub_channels[1] is created_channels[0]
assert stub_channels[2] is created_channels[1]
created_channels[0].close.assert_called_once()
created_channels[1].close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_recreates_sdk_owned_channel_after_silent_disconnect(monkeypatch):
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(
channel_recreate_failure_threshold=1,
silent_disconnect_timeout_seconds=0.01,
)
)
worker._async_worker_manager = DummyWorkerManager()
wait_calls = []
def shutdown_wait(timeout):
wait_calls.append(timeout)
return False
monkeypatch.setattr(worker._shutdown, "wait", shutdown_wait)
delay_calls = []
def fake_delay(attempt, *, base_seconds, cap_seconds):
delay_calls.append((attempt, base_seconds, cap_seconds))
return 0.25
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
blocking_stream = BlockingResponseStream()
stub_channels = []
stubs = [
MagicMock(GetWorkItems=MagicMock(return_value=blocking_stream)),
MagicMock(GetWorkItems=MagicMock(side_effect=FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
))),
]
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.get_full_jitter_delay_seconds", fake_delay)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert blocking_stream.cancelled is True
assert delay_calls == [(1, 1.0, 30.0)]
assert wait_calls == [0.25]
assert len(created_channels) == 2
assert stub_channels == created_channels
created_channels[0].close.assert_called_once()
created_channels[1].close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_closes_sdk_owned_channel_on_graceful_stream_reset(monkeypatch):
worker = TaskHubGrpcWorker()
worker._async_worker_manager = DummyWorkerManager()
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
stub_channels = []
stubs = [
MagicMock(GetWorkItems=MagicMock(return_value=FakeResponseStream())),
MagicMock(GetWorkItems=MagicMock(side_effect=FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
))),
]
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert len(created_channels) == 2
assert stub_channels == created_channels
created_channels[0].close.assert_called_once()
created_channels[1].close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_defers_sdk_owned_channel_close_until_inflight_completion_finishes(monkeypatch):
worker = TaskHubGrpcWorker()
worker_manager = DummyWorkerManager()
worker._async_worker_manager = worker_manager
worker._execute_activity = _complete_activity_request
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
completed_responses = []
first_stub = MagicMock()
first_stub.GetWorkItems.return_value = FakeResponseStream(items=[_make_activity_work_item()])
def complete_activity(response):
assert created_channels[0].close.call_count == 0
completed_responses.append(response)
first_stub.CompleteActivityTask.side_effect = complete_activity
second_stub = MagicMock()
second_stub.GetWorkItems.side_effect = FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
)
stubs = [first_stub, second_stub]
stub_channels = []
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert len(worker_manager.submissions) == 1
assert len(created_channels) == 2
assert stub_channels == created_channels
created_channels[0].close.assert_not_called()
created_channels[1].close.assert_called_once()
_, submission = worker_manager.submissions[0]
func, _, req, stub, completion_token = submission
func(req, stub, completion_token)
assert len(completed_responses) == 1
assert completed_responses[0].completionToken == "token"
created_channels[0].close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_releases_inflight_channel_when_activity_handler_raises(monkeypatch):
worker = TaskHubGrpcWorker()
worker_manager = DummyWorkerManager()
worker._async_worker_manager = worker_manager
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
def fail_activity(req, stub, completion_token):
raise RuntimeError("boom")
worker._execute_activity = fail_activity
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
first_stub = MagicMock()
first_stub.GetWorkItems.return_value = FakeResponseStream(items=[_make_activity_work_item()])
second_stub = MagicMock()
second_stub.GetWorkItems.side_effect = FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
)
stubs = [first_stub, second_stub]
def create_stub(channel):
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert len(worker_manager.submissions) == 1
created_channels[0].close.assert_not_called()
_, submission = worker_manager.submissions[0]
func, _, req, stub, completion_token = submission
with pytest.raises(RuntimeError, match="boom"):
func(req, stub, completion_token)
created_channels[0].close.assert_called_once()
created_channels[1].close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_shutdown_drains_real_manager_work_before_closing_retired_sdk_channel(monkeypatch):
worker = TaskHubGrpcWorker(
concurrency_options=ConcurrencyOptions(
maximum_concurrent_activity_work_items=1,
maximum_thread_pool_workers=1,
)
)
worker._execute_activity = _complete_activity_request
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
allow_first_completion = Event()
first_completion_started = Event()
completed_task_ids = []
first_stub = MagicMock()
first_stub.GetWorkItems.return_value = FakeResponseStream(items=[
_make_activity_work_item(task_id=1, completion_token="token-1"),
_make_activity_work_item(task_id=2, completion_token="token-2"),
])
def complete_activity(response):
completed_task_ids.append(response.taskId)
if response.taskId == 1:
first_completion_started.set()
Timer(0.2, allow_first_completion.set).start()
assert allow_first_completion.wait(timeout=5.0)
elif response.taskId == 2:
assert created_channels[0].close.call_count == 0
first_stub.CompleteActivityTask.side_effect = complete_activity
second_stub = MagicMock()
second_stub.GetWorkItems.side_effect = FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
)
stubs = [first_stub, second_stub]
stub_channels = []
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
run_task = asyncio.create_task(worker._async_run_loop())
await asyncio.wait_for(run_task, timeout=2.0)
assert first_completion_started.is_set() is True
assert len(created_channels) == 2
assert stub_channels == created_channels
assert completed_task_ids == [1, 2]
created_channels[0].close.assert_called_once()
created_channels[1].close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_shutdown_runs_real_manager_cancellation_wrapper_before_closing_retired_sdk_channel(monkeypatch):
worker = TaskHubGrpcWorker(
concurrency_options=ConcurrencyOptions(
maximum_concurrent_activity_work_items=1,
maximum_thread_pool_workers=1,
)
)
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
allow_first_completion = Event()
first_completion_started = Event()
completed_task_ids = []
cancelled_task_ids = []
def execute_activity(req, stub, completion_token):
if req.taskId == 1:
_complete_activity_request(req, stub, completion_token)
else:
raise RuntimeError("boom")
def cancel_activity(req, stub, completion_token):
cancelled_task_ids.append(req.taskId)
assert created_channels[0].close.call_count == 0
worker._execute_activity = execute_activity
worker._cancel_activity = cancel_activity
first_stub = MagicMock()
first_stub.GetWorkItems.return_value = FakeResponseStream(items=[
_make_activity_work_item(task_id=1, completion_token="token-1"),
_make_activity_work_item(task_id=2, completion_token="token-2"),
])
def complete_activity(response):
completed_task_ids.append(response.taskId)
Timer(0.2, allow_first_completion.set).start()
first_completion_started.set()
assert allow_first_completion.wait(timeout=5.0)
first_stub.CompleteActivityTask.side_effect = complete_activity
second_stub = MagicMock()
second_stub.GetWorkItems.side_effect = FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
)
stubs = [first_stub, second_stub]
stub_channels = []
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
run_task = asyncio.create_task(worker._async_run_loop())
await asyncio.wait_for(run_task, timeout=2.0)
assert first_completion_started.is_set() is True
assert len(created_channels) == 2
assert stub_channels == created_channels
assert completed_task_ids == [1]
assert cancelled_task_ids == [2]
created_channels[0].close.assert_called_once()
created_channels[1].close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_never_closes_caller_owned_channel_after_graceful_reset(monkeypatch):
provided_channel = MagicMock(name="provided-channel")
worker = TaskHubGrpcWorker(channel=provided_channel)
worker_manager = DummyWorkerManager()
worker._async_worker_manager = worker_manager
worker._execute_activity = _complete_activity_request
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
completed_responses = []
first_stub = MagicMock()
first_stub.GetWorkItems.return_value = FakeResponseStream(items=[_make_activity_work_item()])
def complete_activity(response):
assert provided_channel.close.call_count == 0
completed_responses.append(response)
first_stub.CompleteActivityTask.side_effect = complete_activity
second_stub = MagicMock()
second_stub.GetWorkItems.side_effect = FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
)
stubs = [first_stub, second_stub]
stub_channels = []
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr(
"durabletask.worker.shared.get_grpc_channel",
lambda *args, **kwargs: pytest.fail(
"SDK channel factory should not run for caller-owned channels"
),
)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert len(worker_manager.submissions) == 1
assert stub_channels == [provided_channel, provided_channel]
provided_channel.close.assert_not_called()
_, submission = worker_manager.submissions[0]
func, _, req, stub, completion_token = submission
func(req, stub, completion_token)
assert len(completed_responses) == 1
assert completed_responses[0].completionToken == "token"
provided_channel.close.assert_not_called()
@pytest.mark.asyncio
async def test_worker_uses_reconnect_backoff_helper_after_connection_failure(monkeypatch):
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(
reconnect_backoff_base_seconds=1.5,
reconnect_backoff_cap_seconds=9.0,
)
)
worker._async_worker_manager = DummyWorkerManager()
wait_calls = []
def shutdown_wait(timeout):
wait_calls.append(timeout)
return False
monkeypatch.setattr(worker._shutdown, "wait", shutdown_wait)
delay_calls = []
def fake_delay(attempt, *, base_seconds, cap_seconds):
delay_calls.append((attempt, base_seconds, cap_seconds))
return 0.75
channel = MagicMock(name="channel-1")
stub_channels = []
first_stub = MagicMock()
first_stub.Hello.side_effect = FakeRpcError(
grpc.StatusCode.UNAVAILABLE,
"connect failed",
)
second_stub = MagicMock()
second_stub.GetWorkItems.side_effect = FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
)
stubs = [first_stub, second_stub]
def create_stub(current_channel):
stub_channels.append(current_channel)
return stubs.pop(0)
monkeypatch.setattr("durabletask.worker.get_full_jitter_delay_seconds", fake_delay)
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", lambda *args, **kwargs: channel)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert delay_calls == [(1, 1.5, 9.0)]
assert wait_calls == [0.75]
assert stub_channels == [channel, channel]
channel.close.assert_called_once()
@pytest.mark.asyncio
async def test_worker_never_replaces_caller_owned_channel_during_transport_failures(monkeypatch):
provided_channel = MagicMock(name="provided-channel")
worker = TaskHubGrpcWorker(
channel=provided_channel,
resiliency_options=GrpcWorkerResiliencyOptions(channel_recreate_failure_threshold=1),
)
worker._async_worker_manager = DummyWorkerManager()
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
stub_channels = []
stubs = [
MagicMock(GetWorkItems=MagicMock(return_value=FakeResponseStream(error=FakeRpcError(
grpc.StatusCode.UNAVAILABLE,
"transport failure",
)))),
MagicMock(GetWorkItems=MagicMock(side_effect=FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
))),
]
def create_stub(channel):
stub_channels.append(channel)
return stubs.pop(0)
monkeypatch.setattr(
"durabletask.worker.shared.get_grpc_channel",
lambda *args, **kwargs: pytest.fail("SDK channel factory should not run for caller-owned channels"),
)
monkeypatch.setattr("durabletask.worker.stubs.TaskHubSidecarServiceStub", create_stub)
await worker._async_run_loop()
assert stub_channels == [provided_channel, provided_channel]
provided_channel.close.assert_not_called()
@pytest.mark.asyncio
@pytest.mark.parametrize(
("work_item", "expected_submissions"),
[
(pb.WorkItem(healthPing=pb.HealthPing()), 0),
(_make_activity_work_item(), 1),
],
)
async def test_worker_received_messages_reset_failure_tracker(monkeypatch, work_item, expected_submissions):
worker = TaskHubGrpcWorker(
resiliency_options=GrpcWorkerResiliencyOptions(
channel_recreate_failure_threshold=2,
silent_disconnect_timeout_seconds=5.0,
)
)
worker_manager = DummyWorkerManager()
worker._async_worker_manager = worker_manager
monkeypatch.setattr(worker._shutdown, "wait", lambda timeout: False)
created_channels = []
def get_grpc_channel(*args, **kwargs):
channel = MagicMock(name=f"channel-{len(created_channels) + 1}")
created_channels.append(channel)
return channel
stubs = [
MagicMock(GetWorkItems=MagicMock(return_value=FakeResponseStream(error=FakeRpcError(
grpc.StatusCode.UNAVAILABLE,
"first transport failure",
)))),
MagicMock(GetWorkItems=MagicMock(return_value=FakeResponseStream(
items=[work_item],
error=FakeRpcError(grpc.StatusCode.UNAVAILABLE, "second transport failure"),
))),
MagicMock(GetWorkItems=MagicMock(side_effect=FakeRpcError(
grpc.StatusCode.CANCELLED,
"stop",
))),
]
monkeypatch.setattr("durabletask.worker.shared.get_grpc_channel", get_grpc_channel)
monkeypatch.setattr(
"durabletask.worker.stubs.TaskHubSidecarServiceStub",
lambda channel: stubs.pop(0),
)
await worker._async_run_loop()
assert len(created_channels) == 1
assert len(worker_manager.submissions) == expected_submissions