-
Notifications
You must be signed in to change notification settings - Fork 44
Expand file tree
/
Copy pathtest_http_client.py
More file actions
1024 lines (849 loc) · 34.6 KB
/
test_http_client.py
File metadata and controls
1024 lines (849 loc) · 34.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
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
import logging
import os
from datetime import timedelta
from unittest.mock import MagicMock, patch
import pytest
import requests
from pympler import asizeof
from requests_cache import CachedRequest
from airbyte_cdk.models import FailureType
from airbyte_cdk.sources.streams.call_rate import CachedLimiterSession, LimiterSession
from airbyte_cdk.sources.streams.http import HttpClient
from airbyte_cdk.sources.streams.http.error_handlers import (
BackoffStrategy,
ErrorResolution,
HttpStatusErrorHandler,
ResponseAction,
)
from airbyte_cdk.sources.streams.http.exceptions import (
DefaultBackoffException,
RateLimitBackoffException,
RequestBodyException,
UserDefinedBackoffException,
)
from airbyte_cdk.sources.streams.http.requests_native_auth import TokenAuthenticator
from airbyte_cdk.utils.traced_exception import AirbyteTracedException
def test_http_client():
return HttpClient(name="StubHttpClient", logger=MagicMock())
def test_cache_http_client():
return HttpClient(name="StubCacheHttpClient", logger=MagicMock(), use_cache=True)
def test_cache_filename():
http_client = test_http_client()
http_client.cache_filename == f"{http_client._name}.sqlite"
@pytest.mark.parametrize(
"use_cache, expected_session",
[
(True, CachedLimiterSession),
(False, LimiterSession),
],
)
def test_request_session_returns_valid_session(use_cache, expected_session):
http_client = HttpClient(name="test", logger=MagicMock(), use_cache=use_cache)
assert isinstance(http_client._request_session(), expected_session)
@pytest.mark.parametrize(
"deduplicate_query_params, url, params, expected_url",
[
pytest.param(
True,
"https://test_base_url.com/v1/endpoint?param1=value1",
{},
"https://test_base_url.com/v1/endpoint?param1=value1",
id="test_params_only_in_path",
),
pytest.param(
True,
"https://test_base_url.com/v1/endpoint",
{"param1": "value1"},
"https://test_base_url.com/v1/endpoint?param1=value1",
id="test_params_only_in_path",
),
pytest.param(
True,
"https://test_base_url.com/v1/endpoint",
None,
"https://test_base_url.com/v1/endpoint",
id="test_params_is_none_and_no_params_in_path",
),
pytest.param(
True,
"https://test_base_url.com/v1/endpoint?param1=value1",
None,
"https://test_base_url.com/v1/endpoint?param1=value1",
id="test_params_is_none_and_no_params_in_path",
),
pytest.param(
True,
"https://test_base_url.com/v1/endpoint?param1=value1",
{"param2": "value2"},
"https://test_base_url.com/v1/endpoint?param1=value1¶m2=value2",
id="test_no_duplicate_params",
),
pytest.param(
True,
"https://test_base_url.com/v1/endpoint?param1=value1",
{"param1": "value1"},
"https://test_base_url.com/v1/endpoint?param1=value1",
id="test_duplicate_params_same_value",
),
pytest.param(
True,
"https://test_base_url.com/v1/endpoint?param1=1",
{"param1": 1},
"https://test_base_url.com/v1/endpoint?param1=1",
id="test_duplicate_params_same_value_not_string",
),
pytest.param(
True,
"https://test_base_url.com/v1/endpoint?param1=value1",
{"param1": "value2"},
"https://test_base_url.com/v1/endpoint?param1=value1¶m1=value2",
id="test_duplicate_params_different_value",
),
pytest.param(
False,
"https://test_base_url.com/v1/endpoint?param1=value1",
{"param1": "value2"},
"https://test_base_url.com/v1/endpoint?param1=value1¶m1=value2",
id="test_same_params_different_value_no_deduplication",
),
pytest.param(
False,
"https://test_base_url.com/v1/endpoint?param1=value1",
{"param1": "value1"},
"https://test_base_url.com/v1/endpoint?param1=value1¶m1=value1",
id="test_same_params_same_value_no_deduplication",
),
],
)
def test_duplicate_request_params_are_deduped(deduplicate_query_params, url, params, expected_url):
http_client = test_http_client()
if expected_url is None:
with pytest.raises(ValueError):
http_client._create_prepared_request(
http_method="get",
url=url,
dedupe_query_params=deduplicate_query_params,
params=params,
)
else:
prepared_request = http_client._create_prepared_request(
http_method="get", url=url, dedupe_query_params=deduplicate_query_params, params=params
)
assert prepared_request.url == expected_url
def test_create_prepared_response_given_given_both_json_and_data_raises_request_body_exception():
http_client = test_http_client()
with pytest.raises(RequestBodyException):
http_client._create_prepared_request(
http_method="get",
url="https://test_base_url.com/v1/endpoint",
json={"test": "json"},
data={"test": "data"},
)
@pytest.mark.parametrize(
"json, data",
[
({"test": "json"}, None),
(None, {"test": "data"}),
],
)
def test_create_prepared_response_given_either_json_or_data_returns_valid_request(json, data):
http_client = test_http_client()
prepared_request = http_client._create_prepared_request(
http_method="get", url="https://test_base_url.com/v1/endpoint", json=json, data=data
)
assert prepared_request
assert isinstance(prepared_request, requests.PreparedRequest)
def test_connection_pool():
http_client = HttpClient(
name="test", logger=MagicMock(), authenticator=TokenAuthenticator("test-token")
)
assert http_client._session.adapters["https://"]._pool_connections == 20
def test_valid_basic_send_request(mocker):
http_client = test_http_client()
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 200
mocked_response.headers = {}
mocker.patch.object(requests.Session, "send", return_value=mocked_response)
returned_request, returned_response = http_client.send_request(
http_method="get", url="https://test_base_url.com/v1/endpoint", request_kwargs={}
)
assert isinstance(returned_request, requests.PreparedRequest)
assert returned_response == mocked_response
def test_send_raises_airbyte_traced_exception_with_fail_response_action():
mocked_session = MagicMock(spec=requests.Session)
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
400: ErrorResolution(
ResponseAction.FAIL, FailureType.system_error, "test error message"
)
},
),
session=mocked_session,
)
prepared_request = requests.PreparedRequest()
mocked_response = requests.Response()
mocked_response.status_code = 400
mocked_session.send.return_value = mocked_response
with pytest.raises(AirbyteTracedException):
http_client._send(prepared_request, {})
assert http_client._session.send.call_count == 1
def test_send_ignores_with_ignore_reponse_action_and_returns_response():
mocked_session = MagicMock(spec=requests.Session)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 300
mocked_response.headers = {}
mocked_session.send.return_value = mocked_response
mocked_logger = MagicMock(spec=logging.Logger)
http_client = HttpClient(
name="test",
logger=mocked_logger,
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
300: ErrorResolution(
ResponseAction.IGNORE, FailureType.system_error, "test ignore message"
)
},
),
session=mocked_session,
)
prepared_request = http_client._create_prepared_request(
http_method="get", url="https://test_base_url.com/v1/endpoint"
)
returned_response = http_client._send(prepared_request, {})
mocked_logger.info.call_count == 1
assert isinstance(returned_response, requests.Response)
assert returned_response == mocked_response
class CustomBackoffStrategy(BackoffStrategy):
def __init__(self, backoff_time_value: float) -> None:
self._backoff_time_value = backoff_time_value
def backoff_time(self, *args, **kwargs) -> float:
return self._backoff_time_value
@pytest.mark.parametrize(
"backoff_time_value, exception_type",
[(0.1, UserDefinedBackoffException), (None, DefaultBackoffException)],
)
def test_raises_backoff_exception_with_retry_response_action(
mocker, backoff_time_value, exception_type
):
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
408: ErrorResolution(
ResponseAction.FAIL, FailureType.system_error, "test retry message"
)
},
),
backoff_strategy=CustomBackoffStrategy(backoff_time_value=backoff_time_value),
)
prepared_request = http_client._create_prepared_request(
http_method="get", url="https://test_base_url.com/v1/endpoint"
)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 408
mocked_response.headers = {}
http_client._logger.info = MagicMock()
mocker.patch.object(requests.Session, "send", return_value=mocked_response)
mocker.patch.object(
http_client._error_handler,
"interpret_response",
return_value=ErrorResolution(
ResponseAction.RETRY, FailureType.system_error, "test retry message"
),
)
with pytest.raises(exception_type):
http_client._send(prepared_request, {})
@pytest.mark.parametrize(
"backoff_time_value, exception_type",
[(0.1, UserDefinedBackoffException), (None, DefaultBackoffException)],
)
def test_raises_backoff_exception_with_response_with_unmapped_error(
mocker, backoff_time_value, exception_type
):
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
408: ErrorResolution(
ResponseAction.FAIL, FailureType.system_error, "test retry message"
)
},
),
backoff_strategy=CustomBackoffStrategy(backoff_time_value=backoff_time_value),
)
prepared_request = requests.PreparedRequest()
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 508
mocked_response.headers = {}
mocked_response.ok = False
mocker.patch.object(requests.Session, "send", return_value=mocked_response)
with pytest.raises(exception_type):
http_client._send(prepared_request, {})
@pytest.mark.usefixtures("mock_sleep")
def test_send_request_given_retry_response_action_retries_and_returns_valid_response():
mocked_session = MagicMock(spec=requests.Session)
valid_response = MagicMock(spec=requests.Response)
valid_response.status_code = 200
valid_response.ok = True
valid_response.headers = {}
call_count = 2
def update_response(*args, **kwargs):
if http_client._session.send.call_count == call_count:
return valid_response
else:
retry_response = MagicMock(spec=requests.Response)
retry_response.ok = False
retry_response.status_code = 408
retry_response.headers = {}
return retry_response
mocked_session.send.side_effect = update_response
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
408: ErrorResolution(
ResponseAction.RETRY, FailureType.system_error, "test retry message"
)
},
),
session=mocked_session,
)
prepared_request = requests.PreparedRequest()
returned_response = http_client._send_with_retry(prepared_request, request_kwargs={})
assert http_client._session.send.call_count == call_count
assert returned_response == valid_response
@pytest.mark.usefixtures("mock_sleep")
def test_evicting_requests_for_request_count():
mocked_session = MagicMock(spec=requests.Session)
valid_response = MagicMock(spec=requests.Response)
valid_response.status_code = 200
valid_response.ok = True
valid_response.headers = {}
call_count = 3
def update_response(*args, **kwargs):
nonlocal call_count
if http_client._session.send.call_count == call_count:
call_count += 3
return valid_response
else:
retry_response = MagicMock(spec=requests.Response)
retry_response.ok = False
retry_response.status_code = 408
retry_response.headers = {}
return retry_response
mocked_session.send.side_effect = update_response
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
408: ErrorResolution(
ResponseAction.RETRY, FailureType.system_error, "test retry message"
)
},
max_retries=call_count,
),
session=mocked_session,
)
requests_to_make = 1000
for requests_count in range(requests_to_make):
prepared_request = requests.PreparedRequest()
returned_response = http_client._send_with_retry(prepared_request, request_kwargs={})
assert returned_response == valid_response
# for the number of requests_to_make if we didn't evict the requests we could see increase the value ~0.5 MB
size_of_request_count_store = asizeof.asizeof(http_client._request_attempt_count)
assert size_of_request_count_store < 250
def test_session_request_exception_raises_backoff_exception():
error_handler = HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
requests.exceptions.RequestException: ErrorResolution(
ResponseAction.RETRY, FailureType.system_error, "test retry message"
)
},
)
mocked_session = MagicMock(spec=requests.Session)
mocked_session.send.side_effect = requests.RequestException
http_client = HttpClient(
name="test", logger=MagicMock(), error_handler=error_handler, session=mocked_session
)
prepared_request = requests.PreparedRequest()
with pytest.raises(DefaultBackoffException):
http_client._send(prepared_request, {})
def test_that_response_was_cached(requests_mock):
cached_http_client = test_cache_http_client()
assert isinstance(cached_http_client._session, CachedLimiterSession)
cached_http_client._session.cache.clear()
prepared_request = cached_http_client._create_prepared_request(
http_method="GET", url="https://google.com/"
)
requests_mock.register_uri("GET", "https://google.com/", json='{"test": "response"}')
cached_http_client._send(prepared_request, {})
assert requests_mock.called
requests_mock.reset_mock()
second_response = cached_http_client._send(prepared_request, {})
assert isinstance(second_response.request, CachedRequest)
assert not requests_mock.called
def test_send_handles_response_action_given_session_send_raises_request_exception():
error_resolution = ErrorResolution(
ResponseAction.FAIL, FailureType.system_error, "test fail message"
)
custom_error_handler = HttpStatusErrorHandler(
logger=MagicMock(), error_mapping={requests.RequestException: error_resolution}
)
mocked_session = MagicMock(spec=requests.Session)
mocked_session.send.side_effect = requests.RequestException
http_client = HttpClient(
name="test", logger=MagicMock(), error_handler=custom_error_handler, session=mocked_session
)
prepared_request = requests.PreparedRequest()
with pytest.raises(AirbyteTracedException) as e:
http_client._send(prepared_request, {})
assert e.internal_message == error_resolution.error_message
assert e.message == error_resolution.error_message
assert e.failure_type == error_resolution.failure_type
@pytest.mark.usefixtures("mock_sleep")
def test_send_request_given_request_exception_and_retry_response_action_retries_and_returns_valid_response():
mocked_session = MagicMock(spec=requests.Session)
def update_response(*args, **kwargs):
if mocked_session.send.call_count == call_count:
return valid_response
else:
raise requests.RequestException()
mocked_session.send.side_effect = update_response
valid_response = MagicMock(spec=requests.Response)
valid_response.status_code = 200
valid_response.ok = True
valid_response.headers = {}
call_count = 2
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
408: ErrorResolution(
ResponseAction.RETRY, FailureType.system_error, "test retry message"
)
},
),
session=mocked_session,
)
prepared_request = requests.PreparedRequest()
returned_response = http_client._send_with_retry(prepared_request, request_kwargs={})
assert http_client._session.send.call_count == call_count
assert returned_response == valid_response
def test_disable_retries():
class BackoffStrategy:
def backoff_time(self, *args, **kwargs):
return 0.001
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(logger=MagicMock()),
backoff_strategy=BackoffStrategy(),
disable_retries=True,
)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 429
mocked_response.headers = {}
mocked_response.ok = False
session_send = MagicMock(spec=requests.Session.send)
session_send.return_value = mocked_response
with patch.object(requests.Session, "send", return_value=mocked_response) as mocked_send:
with pytest.raises(AirbyteTracedException) as e:
http_client.send_request(
http_method="get", url="https://test_base_url.com/v1/endpoint", request_kwargs={}
)
assert mocked_send.call_count == 1
@pytest.mark.usefixtures("mock_sleep")
def test_default_max_retries():
class BackoffStrategy:
def backoff_time(self, *args, **kwargs):
return 0.001
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(logger=MagicMock()),
backoff_strategy=BackoffStrategy(),
)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 429
mocked_response.headers = {}
mocked_response.ok = False
session_send = MagicMock(spec=requests.Session.send)
session_send.return_value = mocked_response
with patch.object(requests.Session, "send", return_value=mocked_response) as mocked_send:
with pytest.raises(AirbyteTracedException) as e:
http_client.send_request(
http_method="get", url="https://test_base_url.com/v1/endpoint", request_kwargs={}
)
assert mocked_send.call_count == 6
@pytest.mark.usefixtures("mock_sleep")
def test_backoff_strategy_max_retries():
class BackoffStrategy:
def backoff_time(self, *args, **kwargs):
return 0.001
retries = 3
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(logger=MagicMock(), max_retries=retries),
backoff_strategy=BackoffStrategy(),
)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 429
mocked_response.headers = {}
mocked_response.ok = False
session_send = MagicMock(spec=requests.Session.send)
session_send.return_value = mocked_response
with patch.object(requests.Session, "send", return_value=mocked_response) as mocked_send:
with pytest.raises(AirbyteTracedException) as e:
http_client.send_request(
http_method="get", url="https://test_base_url.com/v1/endpoint", request_kwargs={}
)
assert mocked_send.call_count == retries + 1
@pytest.mark.usefixtures("mock_sleep")
def test_backoff_strategy_max_time():
error_handler = HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
requests.RequestException: ErrorResolution(
ResponseAction.RETRY, FailureType.system_error, "test retry message"
)
},
max_retries=10,
max_time=timedelta(seconds=2),
)
class BackoffStrategy:
def backoff_time(self, *args, **kwargs):
return 1
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=error_handler,
backoff_strategy=BackoffStrategy(),
)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 429
mocked_response.headers = {}
mocked_response.ok = False
session_send = MagicMock(spec=requests.Session.send)
session_send.return_value = mocked_response
with patch.object(requests.Session, "send", return_value=mocked_response) as mocked_send:
with pytest.raises(AirbyteTracedException) as e:
http_client.send_request(
http_method="get", url="https://test_base_url.com/v1/endpoint", request_kwargs={}
)
assert mocked_send.call_count == 2
@pytest.mark.usefixtures("mock_sleep")
def test_send_emit_stream_status_with_rate_limit_reason(capsys):
class BackoffStrategy:
def backoff_time(self, *args, **kwargs):
return 0.001
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(logger=MagicMock()),
backoff_strategy=BackoffStrategy(),
)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 429
mocked_response.headers = {}
mocked_response.ok = False
session_send = MagicMock(spec=requests.Session.send)
session_send.return_value = mocked_response
with patch.object(requests.Session, "send", return_value=mocked_response) as mocked_send:
with pytest.raises(AirbyteTracedException) as e:
http_client.send_request(
http_method="get", url="https://test_base_url.com/v1/endpoint", request_kwargs={}
)
trace_messages = capsys.readouterr().out.split()
assert len(trace_messages) == mocked_send.call_count
@pytest.mark.parametrize(
"exit_on_rate_limit, expected_call_count, expected_error",
[[True, 6, DefaultBackoffException], [False, 6, RateLimitBackoffException]],
)
@pytest.mark.usefixtures("mock_sleep")
def test_backoff_strategy_endless(
exit_on_rate_limit: bool, expected_call_count: int, expected_error: Exception
):
http_client = HttpClient(
name="test", logger=MagicMock(), error_handler=HttpStatusErrorHandler(logger=MagicMock())
)
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 429
mocked_response.headers = {}
mocked_response.ok = False
session_send = MagicMock(spec=requests.Session.send)
session_send.return_value = mocked_response
with patch.object(requests.Session, "send", return_value=mocked_response) as mocked_send:
with pytest.raises(AirbyteTracedException) as e:
http_client.send_request(
http_method="get",
url="https://test_base_url.com/v1/endpoint",
request_kwargs={},
exit_on_rate_limit=exit_on_rate_limit,
)
assert mocked_send.call_count == expected_call_count
def test_given_different_headers_then_response_is_not_cached(requests_mock):
http_client = HttpClient(name="test", logger=MagicMock(), use_cache=True)
first_request_headers = {"header_key": "first"}
second_request_headers = {"header_key": "second"}
requests_mock.register_uri(
"GET",
"https://google.com/",
request_headers=first_request_headers,
json={"test": "first response"},
)
requests_mock.register_uri(
"GET",
"https://google.com/",
request_headers=second_request_headers,
json={"test": "second response"},
)
http_client.send_request(
"GET", "https://google.com/", headers=first_request_headers, request_kwargs={}
)
_, second_response = http_client.send_request(
"GET", "https://google.com/", headers=second_request_headers, request_kwargs={}
)
assert second_response.json()["test"] == "second response"
def test_given_noproxy_for_another_url_when_send_request_then_do_not_break(requests_mock):
http_client = HttpClient(name="test", logger=MagicMock(), use_cache=True)
os.environ["no_proxy"] = "another.com"
requests_mock.register_uri(
"GET",
"https://google.com/",
json={"test": "a response"},
)
x = http_client.send_request("GET", "https://google.com/", request_kwargs={})
assert x
@patch.dict("os.environ", {"REQUESTS_CA_BUNDLE": "/path/to/ca-bundle.crt"})
def test_send_request_respects_environment_variables():
"""Test that send_request respects REQUESTS_CA_BUNDLE environment variable."""
http_client = HttpClient(
name="test",
logger=MagicMock(),
)
with patch.object(http_client, "_send_with_retry") as mock_send_with_retry:
http_client.send_request(
http_method="GET", url="https://api.example.com", request_kwargs={"timeout": 10}
)
passed_kwargs = mock_send_with_retry.call_args[1]["request_kwargs"]
assert "verify" in passed_kwargs
assert passed_kwargs["verify"] == "/path/to/ca-bundle.crt"
@pytest.mark.usefixtures("mock_sleep")
@pytest.mark.parametrize(
"response_code, expected_failure_type, error_message, exception_class",
[
(400, FailureType.system_error, "test error message", UserDefinedBackoffException),
(401, FailureType.config_error, "test error message", UserDefinedBackoffException),
(403, FailureType.transient_error, "test error message", UserDefinedBackoffException),
(400, FailureType.system_error, "test error message", DefaultBackoffException),
(401, FailureType.config_error, "test error message", DefaultBackoffException),
(403, FailureType.transient_error, "test error message", DefaultBackoffException),
(400, FailureType.system_error, "test error message", RateLimitBackoffException),
(401, FailureType.config_error, "test error message", RateLimitBackoffException),
(403, FailureType.transient_error, "test error message", RateLimitBackoffException),
],
)
def test_send_with_retry_raises_airbyte_traced_exception_with_failure_type(
response_code, expected_failure_type, error_message, exception_class, requests_mock
):
if exception_class == UserDefinedBackoffException:
class CustomBackoffStrategy:
def backoff_time(self, response_or_exception, attempt_count):
return 0.1
backoff_strategy = CustomBackoffStrategy()
response_action = ResponseAction.RETRY
elif exception_class == RateLimitBackoffException:
backoff_strategy = None
response_action = ResponseAction.RATE_LIMITED
else:
backoff_strategy = None
response_action = ResponseAction.RETRY
error_mapping = {
response_code: ErrorResolution(response_action, expected_failure_type, error_message),
}
http_client = HttpClient(
name="test",
logger=MagicMock(spec=logging.Logger),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(), error_mapping=error_mapping, max_retries=1
),
backoff_strategy=backoff_strategy,
)
requests_mock.register_uri(
"GET",
"https://airbyte.io/",
status_code=response_code,
json={"error": error_message},
headers={},
)
with pytest.raises(AirbyteTracedException) as e:
http_client.send_request(http_method="get", url="https://airbyte.io/", request_kwargs={})
assert e.value.failure_type == expected_failure_type
class MockOAuthAuthenticator:
def __init__(self):
self.access_token = "old_token"
self._token_expiry_date = None
self.refresh_called = False
def refresh_access_token(self):
self.refresh_called = True
return ("new_refreshed_token", "2099-01-01T00:00:00Z")
def set_token_expiry_date(self, value):
self._token_expiry_date = value
def __call__(self, request):
request.headers["Authorization"] = f"Bearer {self.access_token}"
return request
def test_refresh_token_then_retry_action_refreshes_oauth_token(mocker):
mock_authenticator = MockOAuthAuthenticator()
mocked_session = MagicMock(spec=requests.Session)
mocked_session.auth = mock_authenticator
http_client = HttpClient(
name="test",
logger=MagicMock(),
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
401: ErrorResolution(
ResponseAction.REFRESH_TOKEN_THEN_RETRY,
FailureType.transient_error,
"Token expired, refreshing",
)
},
),
session=mocked_session,
)
prepared_request = requests.PreparedRequest()
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 401
mocked_response.headers = {}
mocked_response.ok = False
mocked_session.send.return_value = mocked_response
with pytest.raises(DefaultBackoffException):
http_client._send(prepared_request, {})
assert mock_authenticator.refresh_called
assert mock_authenticator.access_token == "new_refreshed_token"
assert mock_authenticator._token_expiry_date == "2099-01-01T00:00:00Z"
def test_refresh_token_then_retry_action_without_oauth_authenticator_proceeds_with_retry(mocker):
mocked_session = MagicMock(spec=requests.Session)
mocked_session.auth = None
mocked_logger = MagicMock()
http_client = HttpClient(
name="test",
logger=mocked_logger,
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
401: ErrorResolution(
ResponseAction.REFRESH_TOKEN_THEN_RETRY,
FailureType.transient_error,
"Token expired, refreshing",
)
},
),
session=mocked_session,
)
prepared_request = requests.PreparedRequest()
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 401
mocked_response.headers = {}
mocked_response.ok = False
mocked_session.send.return_value = mocked_response
with pytest.raises(DefaultBackoffException):
http_client._send(prepared_request, {})
mocked_logger.warning.assert_called()
def test_refresh_token_then_retry_action_handles_refresh_failure_gracefully(mocker):
class FailingOAuthAuthenticator:
def __init__(self):
self.access_token = "old_token"
def refresh_access_token(self):
raise Exception("Token refresh failed")
def __call__(self, request):
return request
mock_authenticator = FailingOAuthAuthenticator()
mocked_session = MagicMock(spec=requests.Session)
mocked_session.auth = mock_authenticator
mocked_logger = MagicMock()
http_client = HttpClient(
name="test",
logger=mocked_logger,
error_handler=HttpStatusErrorHandler(
logger=MagicMock(),
error_mapping={
401: ErrorResolution(
ResponseAction.REFRESH_TOKEN_THEN_RETRY,
FailureType.transient_error,
"Token expired, refreshing",
)
},
),
session=mocked_session,
)
prepared_request = requests.PreparedRequest()
mocked_response = MagicMock(spec=requests.Response)
mocked_response.status_code = 401
mocked_response.headers = {}
mocked_response.ok = False
mocked_session.send.return_value = mocked_response
with pytest.raises(DefaultBackoffException):
http_client._send(prepared_request, {})
mocked_logger.warning.assert_called()
@pytest.mark.usefixtures("mock_sleep")
def test_refresh_token_then_retry_action_retries_and_succeeds_after_token_refresh():
mock_authenticator = MockOAuthAuthenticator()
mocked_session = MagicMock(spec=requests.Session)
mocked_session.auth = mock_authenticator
valid_response = MagicMock(spec=requests.Response)
valid_response.status_code = 200
valid_response.ok = True
valid_response.headers = {}
call_count = 0
def update_response(*args, **kwargs):
nonlocal call_count
call_count += 1
if call_count == 1:
retry_response = MagicMock(spec=requests.Response)
retry_response.ok = False
retry_response.status_code = 401
retry_response.headers = {}
return retry_response
else:
return valid_response
mocked_session.send.side_effect = update_response