-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathtest_request_queue.py
More file actions
1431 lines (1114 loc) · 56.6 KB
/
test_request_queue.py
File metadata and controls
1431 lines (1114 loc) · 56.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
from __future__ import annotations
import asyncio
import logging
from datetime import datetime, timezone
from typing import TYPE_CHECKING, Any, Literal, cast
from unittest import mock
import pytest
from apify_shared.consts import ApifyEnvVars
from crawlee import service_locator
from crawlee.crawlers import BasicCrawler
from ._utils import call_with_exp_backoff, generate_unique_resource_name
from apify import Actor, Request
from apify.storage_clients import ApifyStorageClient
from apify.storage_clients._apify import ApifyRequestQueueClient
from apify.storage_clients._apify._utils import unique_key_to_request_id
from apify.storages import RequestQueue
if TYPE_CHECKING:
from apify_client import ApifyClientAsync
from crawlee._types import BasicCrawlingContext
from apify.storage_clients._apify._models import ApifyRequestQueueMetadata
async def test_add_and_fetch_requests(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test basic functionality of adding and fetching requests."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
desired_request_count = 100
Actor.log.info('Opening request queue...')
rq = request_queue_apify
# Add some requests
for i in range(desired_request_count):
Actor.log.info(f'Adding request {i}...')
await rq.add_request(f'https://example.com/{i}')
handled_request_count = 0
while next_request := await rq.fetch_next_request():
Actor.log.info('Fetching next request...')
queue_operation_info = await rq.mark_request_as_handled(next_request)
assert queue_operation_info is not None, f'queue_operation_info={queue_operation_info}'
assert queue_operation_info.was_already_handled is False, (
f'queue_operation_info.was_already_handled={queue_operation_info.was_already_handled}'
)
handled_request_count += 1
assert handled_request_count == desired_request_count, (
f'handled_request_count={handled_request_count}',
f'desired_request_count={desired_request_count}',
)
Actor.log.info('Waiting for queue to be finished...')
if rq_access_mode == 'shared':
is_finished = await call_with_exp_backoff(rq.is_finished)
else:
is_finished = await rq.is_finished()
assert is_finished is True, f'is_finished={is_finished}'
async def test_add_requests_in_batches(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test adding multiple requests in a single batch operation."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
desired_request_count = 100
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add some requests
await rq.add_requests([f'https://example.com/{i}' for i in range(desired_request_count)])
total_count = await rq.get_total_count()
Actor.log.info(f'Added {desired_request_count} requests in batch, total in queue: {total_count}')
handled_request_count = 0
while next_request := await rq.fetch_next_request():
if handled_request_count % 20 == 0:
Actor.log.info(f'Processing request {handled_request_count + 1}...')
queue_operation_info = await rq.mark_request_as_handled(next_request)
assert queue_operation_info is not None, f'queue_operation_info={queue_operation_info}'
assert queue_operation_info.was_already_handled is False, (
f'queue_operation_info.was_already_handled={queue_operation_info.was_already_handled}'
)
handled_request_count += 1
assert handled_request_count == desired_request_count, (
f'handled_request_count={handled_request_count}',
f'desired_request_count={desired_request_count}',
)
if rq_access_mode == 'shared':
is_finished = await call_with_exp_backoff(rq.is_finished)
else:
is_finished = await rq.is_finished()
assert is_finished is True, f'is_finished={is_finished}'
async def test_add_non_unique_requests_in_batch(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test adding requests with duplicate unique keys in batch."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
desired_request_count = 100
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add some requests
requests_to_add = [
Request.from_url(f'https://example.com/{i}', unique_key=str(i - 1 if i % 4 == 1 else i))
for i in range(desired_request_count)
]
await rq.add_requests(requests_to_add)
total_count = await rq.get_total_count()
Actor.log.info(f'Added {desired_request_count} requests with duplicate unique keys, total in queue: {total_count}')
handled_request_count = 0
while next_request := await rq.fetch_next_request():
if handled_request_count % 20 == 0:
Actor.log.info(f'Processing request {handled_request_count + 1}: {next_request.url}')
queue_operation_info = await rq.mark_request_as_handled(next_request)
assert queue_operation_info is not None, f'queue_operation_info={queue_operation_info}'
assert queue_operation_info.was_already_handled is False, (
f'queue_operation_info.was_already_handled={queue_operation_info.was_already_handled}'
)
handled_request_count += 1
expected_count = int(desired_request_count * 3 / 4)
assert handled_request_count == expected_count, (
f'handled_request_count={handled_request_count}',
f'expected_count={expected_count}',
)
if rq_access_mode == 'shared':
is_finished = await call_with_exp_backoff(rq.is_finished)
else:
is_finished = await rq.is_finished()
Actor.log.info(f'Processed {handled_request_count}/{expected_count} requests, finished: {is_finished}')
assert is_finished is True, f'is_finished={is_finished}'
async def test_forefront_requests_ordering(request_queue_apify: RequestQueue) -> None:
"""Test that forefront requests are processed before regular requests."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add regular requests
await rq.add_request('https://example.com/1')
await rq.add_request('https://example.com/2')
await rq.add_request('https://example.com/3')
Actor.log.info('Added 3 regular requests')
# Add forefront requests
await rq.add_request('https://example.com/priority1', forefront=True)
await rq.add_request('https://example.com/priority2', forefront=True)
total_count = await rq.get_total_count()
Actor.log.info(f'Added 2 forefront requests, total in queue: {total_count}')
# Fetch requests and verify order
fetched_urls = []
while next_request := await rq.fetch_next_request():
Actor.log.info(f'Fetched request: {next_request.url}')
fetched_urls.append(next_request.url)
await rq.mark_request_as_handled(next_request)
# Forefront requests should come first (in reverse order of addition)
expected_order = [
'https://example.com/priority2',
'https://example.com/priority1',
'https://example.com/1',
'https://example.com/2',
'https://example.com/3',
]
assert fetched_urls == expected_order, (
f'fetched_urls={fetched_urls}',
f'expected_order={expected_order}',
)
async def test_request_unique_key_behavior(request_queue_apify: RequestQueue) -> None:
"""Test behavior of custom unique keys."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add requests with custom unique keys
req1 = Request.from_url('https://example.com/page1', unique_key='custom-key-1')
req2 = Request.from_url('https://example.com/page2', unique_key='custom-key-1') # Same key
req3 = Request.from_url('https://example.com/page3', unique_key='custom-key-2') # Different key
result1 = await rq.add_request(req1)
result2 = await rq.add_request(req2)
result3 = await rq.add_request(req3)
Actor.log.info(
f'Added requests - was_already_present: [{result1.was_already_present}, '
f'{result2.was_already_present}, {result3.was_already_present}]'
)
# Second request should be marked as already present
assert result1.was_already_present is False, f'result1.was_already_present={result1.was_already_present}'
assert result2.was_already_present is True, f'result2.was_already_present={result2.was_already_present}'
assert result3.was_already_present is False, f'result3.was_already_present={result3.was_already_present}'
# Only 2 requests should be fetchable
fetched_count = 0
fetched_requests = []
while next_request := await rq.fetch_next_request():
fetched_count += 1
fetched_requests.append(next_request)
await rq.mark_request_as_handled(next_request)
assert fetched_count == 2, f'fetched_count={fetched_count}'
# Verify the fetched requests have the correct unique keys
unique_keys = {req.unique_key for req in fetched_requests}
expected_keys = {'custom-key-1', 'custom-key-2'}
assert unique_keys == expected_keys, (
f'unique_keys={unique_keys}',
f'expected_keys={expected_keys}',
)
async def test_request_reclaim_functionality(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test request reclaiming for failed processing."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add a test request
await rq.add_request('https://example.com/test')
Actor.log.info('Added test request')
# Fetch and reclaim the request
fetched_request = await rq.fetch_next_request()
assert fetched_request is not None
Actor.log.info(f'Fetched request: {fetched_request.url}')
# Reclaim the request (simulate failed processing)
reclaim_result = await rq.reclaim_request(fetched_request)
assert reclaim_result is not None
assert reclaim_result.was_already_handled is False
Actor.log.info('Request reclaimed successfully')
# Should be able to fetch the same request again.
# In shared mode, there is a propagation delay before the reclaimed request becomes visible
# (see https://github.com/apify/apify-sdk-python/issues/808).
if rq_access_mode == 'shared':
request2 = await call_with_exp_backoff(rq.fetch_next_request)
else:
request2 = await rq.fetch_next_request()
assert request2 is not None
assert request2.url == fetched_request.url
Actor.log.info(f'Successfully fetched reclaimed request: {request2.url}')
# Mark as handled this time
await rq.mark_request_as_handled(request2)
if rq_access_mode == 'shared':
is_finished = await call_with_exp_backoff(rq.is_finished)
else:
is_finished = await rq.is_finished()
assert is_finished is True
async def test_request_reclaim_with_forefront(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test reclaiming requests to the front of the queue."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add multiple requests
await rq.add_request('https://example.com/1')
await rq.add_request('https://example.com/2')
await rq.add_request('https://example.com/3')
Actor.log.info('Added 3 requests')
# Fetch first request
first_request = await rq.fetch_next_request()
assert first_request is not None
Actor.log.info(f'Fetched first request: {first_request.url}')
# Reclaim to forefront
await rq.reclaim_request(first_request, forefront=True)
Actor.log.info('Request reclaimed to forefront')
# The reclaimed request should be fetched first again.
# In shared mode, there is a propagation delay before the reclaimed request becomes visible
# (see https://github.com/apify/apify-sdk-python/issues/808).
if rq_access_mode == 'shared':
next_request = await call_with_exp_backoff(rq.fetch_next_request)
else:
next_request = await rq.fetch_next_request()
assert next_request is not None
assert next_request.url == first_request.url
Actor.log.info(f'Confirmed reclaimed request came first: {next_request.url}')
# Clean up
await rq.mark_request_as_handled(next_request)
remaining_count = 0
while next_request := await rq.fetch_next_request():
remaining_count += 1
await rq.mark_request_as_handled(next_request)
Actor.log.info(f'Test completed - processed {remaining_count} additional requests')
async def test_complex_request_objects(request_queue_apify: RequestQueue) -> None:
"""Test handling complex Request objects with various properties."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Create request with various properties
request = Request.from_url(
'https://example.com/api/data',
method='POST',
headers={'Authorization': 'Bearer token123', 'Content-Type': 'application/json'},
user_data={'category': 'api', 'priority': 'high'},
unique_key='api-request-1',
)
await rq.add_request(request)
Actor.log.info(f'Added complex request: {request.url} with method {request.method}')
# Fetch and verify all properties are preserved
fetched_request = await rq.fetch_next_request()
assert fetched_request is not None, f'fetched_request={fetched_request}'
Actor.log.info(f'Fetched request: {fetched_request.url}')
assert fetched_request.url == 'https://example.com/api/data', f'fetched_request.url={fetched_request.url}'
assert fetched_request.method == 'POST', f'fetched_request.method={fetched_request.method}'
assert fetched_request.headers['Authorization'] == 'Bearer token123', (
f'fetched_request.headers["Authorization"]={fetched_request.headers["Authorization"]}'
)
assert fetched_request.headers['Content-Type'] == 'application/json', (
f'fetched_request.headers["Content-Type"]={fetched_request.headers["Content-Type"]}'
)
assert fetched_request.user_data['category'] == 'api', (
f'fetched_request.user_data["category"]={fetched_request.user_data["category"]}'
)
assert fetched_request.user_data['priority'] == 'high', (
f'fetched_request.user_data["priority"]={fetched_request.user_data["priority"]}'
)
assert fetched_request.unique_key == 'api-request-1', f'fetched_request.unique_key={fetched_request.unique_key}'
Actor.log.info('All properties verified successfully')
await rq.mark_request_as_handled(fetched_request)
Actor.log.info('Complex request test completed')
async def test_get_request_by_unique_key(request_queue_apify: RequestQueue) -> None:
"""Test retrieving specific requests by their unique_key."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add a request and get its unique_key
add_result = await rq.add_request('https://example.com/test')
request_unique_key = add_result.unique_key
Actor.log.info(f'Request added with unique_key: {request_unique_key}')
# Retrieve the request by unique_key
retrieved_request = await rq.get_request(request_unique_key)
assert retrieved_request is not None, f'retrieved_request={retrieved_request}'
assert retrieved_request.url == 'https://example.com/test', f'retrieved_request.url={retrieved_request.url}'
assert retrieved_request.unique_key == request_unique_key, (f'{request_unique_key=}',)
Actor.log.info('Request retrieved successfully by unique_key')
# Test with non-existent unique_key
non_existent_request = await rq.get_request('non-existent-unique_key')
assert non_existent_request is None, f'non_existent_request={non_existent_request}'
Actor.log.info('Non-existent unique_key correctly returned None')
async def test_metadata_tracking(request_queue_apify: RequestQueue) -> None:
"""Test request queue metadata and counts."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Check initial state
initial_total = await rq.get_total_count()
initial_handled = await rq.get_handled_count()
Actor.log.info(f'Initial state - Total: {initial_total}, Handled: {initial_handled}')
assert initial_total == 0, f'initial_total={initial_total}'
assert initial_handled == 0, f'initial_handled={initial_handled}'
# Add requests
await rq.add_requests([f'https://example.com/{i}' for i in range(5)])
Actor.log.info('Added 5 requests in batch')
# Check counts after adding
total_after_add = await rq.get_total_count()
handled_after_add = await rq.get_handled_count()
Actor.log.info(f'After adding - Total: {total_after_add}, Handled: {handled_after_add}')
assert total_after_add == 5, f'total_after_add={total_after_add}'
assert handled_after_add == 0, f'handled_after_add={handled_after_add}'
# Process some requests
for _ in range(3):
request = await rq.fetch_next_request()
if request:
await rq.mark_request_as_handled(request)
Actor.log.info('Processed 3 requests')
# Check counts after processing
final_total = await rq.get_total_count()
final_handled = await rq.get_handled_count()
Actor.log.info(f'Final state - Total: {final_total}, Handled: {final_handled}')
assert final_total == 5, f'final_total={final_total}'
assert final_handled == 3, f'final_handled={final_handled}'
async def test_batch_operations_performance(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test batch operations vs individual operations."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Test batch add vs individual adds
batch_requests = [f'https://example.com/batch/{i}' for i in range(50)]
Actor.log.info(f'Prepared {len(batch_requests)} requests for batch add')
# Add in batch
await rq.add_requests(batch_requests)
Actor.log.info('Batch add completed')
# Verify all requests were added
total_count = await rq.get_total_count()
handled_count = await rq.get_handled_count()
Actor.log.info(f'After batch add - Total: {total_count}, Handled: {handled_count}')
assert total_count == 50, f'total_count={total_count}'
assert handled_count == 0, f'handled_count={handled_count}'
# Process all requests
processed_count = 0
while next_request := await rq.fetch_next_request():
processed_count += 1
await rq.mark_request_as_handled(next_request)
if processed_count >= 50: # Safety break
break
Actor.log.info(f'Processing completed. Total processed: {processed_count}')
assert processed_count == 50, f'processed_count={processed_count}'
if rq_access_mode == 'shared':
is_finished = await call_with_exp_backoff(rq.is_finished)
else:
is_finished = await rq.is_finished()
assert is_finished is True, f'is_finished={is_finished}'
async def test_state_consistency(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test queue state consistency during concurrent operations."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add initial requests
for i in range(10):
await rq.add_request(f'https://example.com/{i}')
Actor.log.info('Added 10 initial requests')
initial_total = await rq.get_total_count()
Actor.log.info(f'Initial total count: {initial_total}')
# Simulate some requests being processed and others being reclaimed
processed_requests = []
reclaimed_requests = []
for i in range(5):
next_request = await rq.fetch_next_request()
if next_request:
if i % 2 == 0: # Process even indices
await rq.mark_request_as_handled(next_request)
processed_requests.append(next_request)
else: # Reclaim odd indices
await rq.reclaim_request(next_request)
reclaimed_requests.append(next_request)
Actor.log.info(f'Processed {len(processed_requests)} requests, reclaimed {len(reclaimed_requests)}')
# Verify queue state
expected_handled = len(processed_requests)
current_handled = await rq.get_handled_count()
current_total = await rq.get_total_count()
Actor.log.info(f'Expected handled: {expected_handled}, Actual handled: {current_handled}')
Actor.log.info(f'Current total: {current_total}')
assert current_handled == expected_handled, (
f'current_handled={current_handled}',
f'expected_handled={expected_handled}',
)
assert current_total == 10, f'current_total={current_total}'
# Process remaining requests
remaining_count = 0
while next_request := await rq.fetch_next_request():
remaining_count += 1
await rq.mark_request_as_handled(next_request)
Actor.log.info(f'Processed {remaining_count} remaining requests')
if rq_access_mode == 'shared':
is_finished = await call_with_exp_backoff(rq.is_finished)
else:
is_finished = await rq.is_finished()
assert is_finished is True, f'is_finished={is_finished}'
async def test_empty_rq_behavior(request_queue_apify: RequestQueue) -> None:
"""Test behavior with empty queues."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Test empty queue operations
is_empty = await rq.is_empty()
is_finished = await rq.is_finished()
Actor.log.info(f'Empty queue - is_empty: {is_empty}, is_finished: {is_finished}')
assert is_empty is True, f'is_empty={is_empty}'
assert is_finished is True, f'is_finished={is_finished}'
# Fetch from empty queue
request = await rq.fetch_next_request()
Actor.log.info(f'Fetch result from empty queue: {request}')
assert request is None, f'request={request}'
# Check metadata for empty queue
metadata = await rq.get_metadata()
assert metadata is not None, f'metadata={metadata}'
Actor.log.info(
f'Empty queue metadata - Total: {metadata.total_request_count}, '
f'Handled: {metadata.handled_request_count}, '
f'Pending: {metadata.pending_request_count}'
)
assert metadata.total_request_count == 0, f'metadata.total_request_count={metadata.total_request_count}'
assert metadata.handled_request_count == 0, f'metadata.handled_request_count={metadata.handled_request_count}'
assert metadata.pending_request_count == 0, f'metadata.pending_request_count={metadata.pending_request_count}'
async def test_large_batch_operations(
request_queue_apify: RequestQueue,
request: pytest.FixtureRequest,
) -> None:
"""Test handling large batches of requests."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Create a large batch of requests
large_batch = [f'https://example.com/large/{i}' for i in range(500)]
Actor.log.info(f'Created batch of {len(large_batch)} requests')
# Add in batch
await rq.add_requests(large_batch, batch_size=100, wait_for_all_requests_to_be_added=True)
Actor.log.info('Large batch add completed')
# Verify all requests were added
total_count = await rq.get_total_count()
assert total_count == 500, f'total_count={total_count}'
# Process all in chunks to test performance
processed_count = 0
while not await rq.is_empty():
next_request = await rq.fetch_next_request()
# The RQ is_empty should ensure we don't get None
assert next_request is not None, f'next_request={next_request}'
await rq.mark_request_as_handled(next_request)
processed_count += 1
Actor.log.info(f'Processing completed. Total processed: {processed_count}')
assert processed_count == 500, f'processed_count={processed_count}'
if rq_access_mode == 'shared':
is_finished = await call_with_exp_backoff(rq.is_finished)
else:
is_finished = await rq.is_finished()
assert is_finished is True, f'is_finished={is_finished}'
async def test_mixed_string_and_request_objects(request_queue_apify: RequestQueue) -> None:
"""Test adding both string URLs and Request objects."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add string URLs
await rq.add_request('https://example.com/string1')
await rq.add_request('https://example.com/string2')
Actor.log.info('Added string URL requests')
# Add Request objects
request_obj = Request.from_url('https://example.com/object1', user_data={'type': 'request_object'})
await rq.add_request(request_obj)
Actor.log.info('Added Request object with user_data')
# Add mixed batch
mixed_batch: list[str | Request] = [
'https://example.com/mixed1',
Request.from_url('https://example.com/mixed2', method='POST'),
'https://example.com/mixed3',
]
await rq.add_requests(mixed_batch)
Actor.log.info('Added mixed batch of strings and Request objects')
total_count = await rq.get_total_count()
Actor.log.info(f'Total requests in queue: {total_count}')
# Fetch and verify all types work
fetched_requests = []
while next_request := await rq.fetch_next_request():
fetched_requests.append(next_request)
await rq.mark_request_as_handled(next_request)
assert len(fetched_requests) == 6, f'len(fetched_requests)={len(fetched_requests)}'
# Find the request object we added
request_obj_found = None
for req in fetched_requests:
if req.user_data and req.user_data.get('type') == 'request_object':
request_obj_found = req
break
assert request_obj_found is not None, f'request_obj_found={request_obj_found}'
assert request_obj_found.url == 'https://example.com/object1', f'request_obj_found.url={request_obj_found.url}'
Actor.log.info('Mixed types verified - found request object with user_data')
async def test_persistence_across_operations(request_queue_apify: RequestQueue) -> None:
"""Test that queue state persists across different operations."""
# Open queue and add some requests
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add initial batch
initial_requests = [f'https://example.com/persist/{i}' for i in range(10)]
await rq.add_requests(initial_requests, wait_for_all_requests_to_be_added=True)
Actor.log.info(f'Added initial batch of {len(initial_requests)} requests')
initial_total = await rq.get_total_count()
Actor.log.info(f'Total count after initial batch: {initial_total}')
# Process some requests
processed_count = 0
for _ in range(5):
request = await rq.fetch_next_request()
if request:
await rq.mark_request_as_handled(request)
processed_count += 1
Actor.log.info(f'Processed {processed_count} requests from initial batch')
handled_after_first_batch = await rq.get_handled_count()
Actor.log.info(f'Handled count after processing: {handled_after_first_batch}')
# Add more requests
additional_requests = [f'https://example.com/additional/{i}' for i in range(5)]
await rq.add_requests(additional_requests, wait_for_all_requests_to_be_added=True)
Actor.log.info(f'Added additional batch of {len(additional_requests)} requests')
# Check final state
total_after_additional = await rq.get_total_count()
handled_after_additional = await rq.get_handled_count()
Actor.log.info(
f'After adding additional batch - Total: {total_after_additional}, Handled: {handled_after_additional}'
)
assert total_after_additional == 15, f'total_after_additional={total_after_additional}'
assert handled_after_additional == 5, f'handled_after_additional={handled_after_additional}'
# Process remaining
remaining_processed = 0
while not await rq.is_finished():
request = await rq.fetch_next_request()
if request:
remaining_processed += 1
await rq.mark_request_as_handled(request)
else:
break
Actor.log.info(f'Processed {remaining_processed} remaining requests')
is_finished = await rq.is_finished()
final_total = await rq.get_total_count()
final_handled = await rq.get_handled_count()
Actor.log.info(f'Final state - Finished: {is_finished}, Total: {final_total}, Handled: {final_handled}')
assert is_finished is True, f'is_finished={is_finished}'
assert final_total == 15, f'final_total={final_total}'
assert final_handled == 15, f'final_handled={final_handled}'
async def test_request_deduplication_edge_cases(
request_queue_apify: RequestQueue, request: pytest.FixtureRequest
) -> None:
"""Test edge cases in request deduplication."""
rq_access_mode = request.node.callspec.params.get('request_queue_apify')
if rq_access_mode == 'shared':
pytest.skip(reason='Test is flaky, see https://github.com/apify/apify-sdk-python/issues/786') # ty: ignore[invalid-argument-type, parameter-already-assigned]
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Test URL normalization and deduplication with expected results
urls_and_deduplication_expectations: list[tuple[str | Request, bool]] = [
('https://example.com/page', False),
('https://example.com/page/', True), # Should be deduplicated (same as first)
('https://example.com/page?', True), # Should be deduplicated (same as first)
(
Request.from_url('https://example.com/page#fragment', use_extended_unique_key=True),
False,
), # Different extended unique key
('https://example.com/page?param=1', False), # Different unique key
]
Actor.log.info(f'Testing deduplication with {len(urls_and_deduplication_expectations)} URLs')
results = list[bool]()
for url, expected_duplicate in urls_and_deduplication_expectations:
result = await rq.add_request(url)
results.append(result.was_already_present)
assert result.was_already_present == expected_duplicate, (
f'url={url}',
f'expected_duplicate={expected_duplicate}',
f'actual_was_already_present={result.was_already_present}',
)
Actor.log.info(f'was_already_present results: {results}')
# Calculate expected unique count
expected_unique_count = sum(1 for _, is_duplicate in urls_and_deduplication_expectations if not is_duplicate)
Actor.log.info(f'Expected {expected_unique_count} unique requests')
# Fetch all unique requests
fetched_urls = list[str]()
while next_request := await rq.fetch_next_request():
fetched_urls.append(next_request.url)
await rq.mark_request_as_handled(next_request)
# Assert exact expected count
assert len(fetched_urls) == expected_unique_count, (
f'len(fetched_urls)={len(fetched_urls)}',
f'expected_unique_count={expected_unique_count}',
)
Actor.log.info(
f'Added {len(urls_and_deduplication_expectations)} URLs, got {len(fetched_urls)} unique requests as expected'
)
async def test_request_ordering_with_mixed_operations(request_queue_apify: RequestQueue) -> None:
"""Test request ordering with mixed add/reclaim operations."""
rq = request_queue_apify
Actor.log.info('Request queue opened')
# Add initial requests
await rq.add_request('https://example.com/1')
await rq.add_request('https://example.com/2')
Actor.log.info('Added initial requests')
# Fetch one and reclaim to forefront
request1 = await rq.fetch_next_request()
assert request1 is not None, f'request1={request1}'
assert request1.url == 'https://example.com/1', f'request1.url={request1.url}'
Actor.log.info(f'Fetched request: {request1.url}')
await rq.reclaim_request(request1, forefront=True)
Actor.log.info('Reclaimed request to forefront')
# Add forefront request
await rq.add_request('https://example.com/priority', forefront=True)
Actor.log.info('Added new forefront request')
# Fetch all requests and verify forefront behavior
urls_ordered = list[str]()
while next_request := await rq.fetch_next_request():
urls_ordered.append(next_request.url)
await rq.mark_request_as_handled(next_request)
Actor.log.info(f'Final order of fetched URLs: {urls_ordered}')
# Verify that we got all 3 requests
assert len(urls_ordered) == 3, f'len(urls_ordered)={len(urls_ordered)}'
assert urls_ordered[0] == 'https://example.com/priority', f'urls_ordered[0]={urls_ordered[0]}'
assert urls_ordered[1] == request1.url, (
f'urls_ordered[1]={urls_ordered[1]}',
f'request1.url={request1.url}',
)
assert urls_ordered[2] == 'https://example.com/2', f'urls_ordered[2]={urls_ordered[2]}'
Actor.log.info('Request ordering verified successfully')
async def test_request_queue_enhanced_metadata(
request_queue_apify: RequestQueue,
apify_client_async: ApifyClientAsync,
) -> None:
"""Test metadata tracking.
Multiple clients scenarios are not guaranteed to give correct results without delay. But at least multiple clients,
single producer, should be reliable on the producer side."""
rq = request_queue_apify
for i in range(1, 10):
await rq.add_request(Request.from_url(f'http://example.com/{i}'))
# Reliable information as the API response is enhanced with local metadata estimation.
assert (await rq.get_metadata()).total_request_count == i
# Accessed with client created explicitly with `client_key=None` should appear as distinct client
api_client = apify_client_async.request_queue(request_queue_id=rq.id, client_key=None)
await api_client.list_head()
# The presence of another non-producing client should not affect the metadata
for i in range(10, 20):
await rq.add_request(Request.from_url(f'http://example.com/{i}'))
# Reliable information as the API response is enhanced with local metadata estimation.
assert (await rq.get_metadata()).total_request_count == i
async def test_request_queue_metadata_another_client(
request_queue_apify: RequestQueue,
apify_client_async: ApifyClientAsync,
) -> None:
"""Test metadata tracking. The delayed metadata should be reliable even when changed by another client."""
rq = request_queue_apify
api_client = apify_client_async.request_queue(request_queue_id=rq.id, client_key=None)
await api_client.add_request(Request.from_url('http://example.com/1').model_dump(by_alias=True, exclude={'id'}))
# Wait to be sure that the API has updated the global metadata
await asyncio.sleep(10)
assert (await rq.get_metadata()).total_request_count == 1
async def test_request_queue_had_multiple_clients(
request_queue_apify: RequestQueue,
apify_client_async: ApifyClientAsync,
) -> None:
"""Test that `RequestQueue` correctly detects multiple clients.
Clients created with different `client_key` should appear as distinct clients."""
rq = request_queue_apify
await rq.fetch_next_request()
# Accessed with client created explicitly with `client_key=None` should appear as distinct client
api_client = apify_client_async.request_queue(request_queue_id=request_queue_apify.id, client_key=None)
await api_client.list_head()
# Check that it is correctly in the RequestQueueClient metadata
assert (await rq.get_metadata()).had_multiple_clients is True
# Check that it is correctly in the API
api_response = await api_client.get()
assert api_response
assert api_response['hadMultipleClients'] is True
async def test_request_queue_not_had_multiple_clients(
request_queue_apify: RequestQueue, apify_client_async: ApifyClientAsync
) -> None:
"""Test that same `RequestQueue` created from Actor does not act as multiple clients."""
rq = request_queue_apify
# Two calls to API to create situation where different `client_key` can set `had_multiple_clients` to True
await rq.fetch_next_request()
await rq.fetch_next_request()
# Check that it is correctly in the RequestQueueClient metadata
assert (await rq.get_metadata()).had_multiple_clients is False
# Check that it is correctly in the API
api_client = apify_client_async.request_queue(request_queue_id=rq.id)
api_response = await api_client.get()
assert api_response
assert api_response['hadMultipleClients'] is False
async def test_request_queue_simple_and_full_at_the_same_time(
apify_token: str, monkeypatch: pytest.MonkeyPatch
) -> None:
"""Test using two variants of the ApifyStorageClient on the same queue resolves to the first client used."""
monkeypatch.setenv(ApifyEnvVars.TOKEN, apify_token)
async with Actor:
rq_simple = await RequestQueue.open(storage_client=ApifyStorageClient(request_queue_access='single'))
rq_full = await RequestQueue.open(storage_client=ApifyStorageClient(request_queue_access='shared'))
# Opening same queue again with different ApifyStorageClient will resolve to the first client used.
assert rq_simple is rq_full
await rq_simple.drop()
@pytest.mark.parametrize(
('access', 'expected_write_count_per_request'),
[pytest.param('single', 2, id='Simple rq client'), pytest.param('shared', 3, id='Full rq client')],
)
async def test_crawler_run_request_queue_variant_stats(
*,
apify_token: str,
monkeypatch: pytest.MonkeyPatch,
access: Literal['single', 'shared'],
expected_write_count_per_request: int,
) -> None:
"""Check the main difference in the simple vs full request queue client - writeCount per request.
The simple client also has lower readCount, but the costs of read are order of magnitude cheaper than writes, so we
do test that.
"""
monkeypatch.setenv(ApifyEnvVars.TOKEN, apify_token)
async with Actor:
requests = 5
rq = await RequestQueue.open(storage_client=ApifyStorageClient(request_queue_access=access))
crawler = BasicCrawler(request_manager=rq)
@crawler.router.default_handler
async def default_handler(context: BasicCrawlingContext) -> None:
context.log.info(f'Processing {context.request.url} ...')
await crawler.run([Request.from_url(f'https://example.com/{i}') for i in range(requests)])
# Make sure all requests were handled.
assert crawler.statistics.state.requests_finished == requests
try:
# Check the request queue stats
await asyncio.sleep(10) # Wait to be sure that metadata are updated
metadata = cast('ApifyRequestQueueMetadata', await rq.get_metadata())
Actor.log.info(f'{metadata.stats=}')
assert metadata.stats.write_count == requests * expected_write_count_per_request
finally:
await rq.drop()
async def test_cache_initialization(apify_token: str, monkeypatch: pytest.MonkeyPatch) -> None:
"""Test that Apify based simple `RequestQueue` initializes cache correctly to reduce unnecessary API calls."""
# Create an instance of the Apify request queue on the platform and drop it when the test is finished.
request_queue_name = generate_unique_resource_name('request_queue')
monkeypatch.setenv(ApifyEnvVars.TOKEN, apify_token)
requests = [Request.from_url(f'http://example.com/{i}', handled_at=datetime.now(timezone.utc)) for i in range(10)]
async with Actor:
rq = await Actor.open_request_queue(name=request_queue_name, force_cloud=True)
try:
await rq.add_requests(requests)
# Check that it is correctly in the API
await asyncio.sleep(10) # Wait to be sure that metadata are updated
metadata = cast('ApifyRequestQueueMetadata', await rq.get_metadata())
stats_before = metadata.stats
Actor.log.info(stats_before)
# Clear service locator cache to simulate creating RQ instance from scratch
service_locator.storage_instance_manager.clear_cache()
# Try to enqueue same requests again. It should be deduplicated from local cache created on initialization
rq = await Actor.open_request_queue(name=request_queue_name, force_cloud=True)
await rq.add_requests(requests)
await asyncio.sleep(10) # Wait to be sure that metadata are updated
metadata = cast('ApifyRequestQueueMetadata', await rq.get_metadata())
stats_after = metadata.stats
Actor.log.info(stats_after)
# Cache was actually initialized, readCount increased
assert (stats_after.read_count - stats_before.read_count) == len(requests)