Repository navigation
Expand file tree
/
Copy pathtest_request_queue.py
More file actions
892 lines (715 loc) · 36.5 KB
/
Copy pathtest_request_queue.py
File metadata and controls
892 lines (715 loc) · 36.5 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
"""Unified tests for request queue (sync + async)."""
from __future__ import annotations
from collections.abc import AsyncIterator, Iterator
from datetime import UTC, datetime, timedelta
from typing import TYPE_CHECKING, Any
import pytest
from .._utils import (
collect_iterate_until_present,
get_random_resource_name,
get_random_string,
maybe_await,
poll_until_condition,
)
from apify_client._models import (
BatchAddResult,
BatchDeleteResult,
ListOfRequestQueues,
ListOfRequests,
LockedRequestQueueHead,
Request,
RequestLockInfo,
RequestQueue,
RequestQueueHead,
RequestQueueShort,
RequestRegistration,
RequestWithoutId,
UnlockRequestsResult,
)
from apify_client.errors import ApifyApiError
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
from apify_client._resource_clients.request_queue import RequestQueueClient, RequestQueueClientAsync
from apify_client._typeddicts import (
RequestDict,
RequestDraftDeleteDict,
RequestWithoutIdCamelDict,
RequestWithoutIdDict,
)
# The wire format the API declares for `handled_at`, and the instant it denotes. The client validates the string
# into a datetime, so it only sends ISO 8601 back out while it serializes in JSON mode.
HANDLED_AT_ISO = '2019-06-16T10:23:31.607Z'
HANDLED_AT = datetime(2019, 6, 16, 10, 23, 31, 607000, tzinfo=UTC)
# Every request field beyond `id`/`unique_key`/`url`, snake_cased. The API declares its write bodies with
# `additionalProperties: false`, so each of these has to reach it camelCased to be stored at all. A fragment, not
# a full `RequestDict`: every use spreads it alongside `unique_key`/`url` supplied separately.
ALL_REQUEST_FIELDS: dict[str, Any] = {
'method': 'POST',
'user_data': {'label': 'DETAIL', 'depth': 2},
'no_retry': True,
'retry_count': 3,
'headers': {'X-Test': 'yes'},
'payload': '{"a": 1}',
'loaded_url': 'https://example.com/loaded',
'error_messages': ['boom'],
'handled_at': HANDLED_AT_ISO,
}
async def fetch_stored_request(
rq_client: RequestQueueClient | RequestQueueClientAsync,
request_id: str,
) -> Request:
"""Poll until `request_id` is readable back from the queue, then return it."""
async def get_request() -> Request | None:
return await maybe_await(rq_client.get_request(request_id))
stored = await poll_until_condition(get_request, lambda request: request is not None)
assert isinstance(stored, Request)
return stored
def non_identity_fields(request: Request) -> dict[str, Any]:
"""Return a stored request's fields without the ones identifying it, so two write paths can be compared."""
dumped = request.model_dump(by_alias=True)
for key in ('id', 'uniqueKey', 'url'):
dumped.pop(key, None)
return dumped
def assert_all_fields_stored(request: Request) -> None:
"""Assert the stored request carries every value of `ALL_REQUEST_FIELDS`."""
assert request.method == 'POST'
assert request.user_data is not None
assert request.user_data.model_dump() == {'label': 'DETAIL', 'depth': 2}
assert request.no_retry is True
assert request.retry_count == 3
assert request.headers == {'X-Test': 'yes'}
assert request.payload == '{"a": 1}'
assert str(request.loaded_url) == 'https://example.com/loaded'
assert request.error_messages == ['boom']
assert request.handled_at == HANDLED_AT
async def ensure_queue_is_populated(
rq_client: RequestQueueClient | RequestQueueClientAsync,
*,
expected_count: int,
) -> None:
"""Poll the queue until `expected_count` requests are visible.
Uses `list_head` (without side effects) so polling does not lock items, which would otherwise
lead to an ambiguous count of actually-locked requests in tests that exercise locking.
"""
async def get_head() -> RequestQueueHead:
head = await maybe_await(rq_client.list_head(limit=expected_count))
assert isinstance(head, RequestQueueHead)
return head
head_response = await poll_until_condition(get_head, lambda head: len(head.items) == expected_count)
assert len(head_response.items) == expected_count
async def test_request_queue_collection_list(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing request queues."""
rq_page = await maybe_await(client.request_queues().list(limit=10))
assert isinstance(rq_page, ListOfRequestQueues)
assert rq_page.items is not None
assert isinstance(rq_page.items, list)
async def test_request_queue_collection_list_pagination(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing request queues with pagination."""
rq_page = await maybe_await(client.request_queues().list(limit=5, offset=0))
assert isinstance(rq_page, ListOfRequestQueues)
assert rq_page.items is not None
assert isinstance(rq_page.items, list)
async def test_request_queue_collection_get_or_create(client: ApifyClient | ApifyClientAsync) -> None:
"""Test get_or_create for request queues."""
unique_name = get_random_resource_name('rq')
# Create new RQ
rq = await maybe_await(client.request_queues().get_or_create(name=unique_name))
assert isinstance(rq, RequestQueue)
try:
assert rq.name == unique_name
# Get same RQ again (should return existing)
same_rq = await maybe_await(client.request_queues().get_or_create(name=unique_name))
assert isinstance(same_rq, RequestQueue)
assert same_rq.id == rq.id
finally:
await maybe_await(client.request_queue(rq.id).delete())
async def test_request_queue_lock(client: ApifyClient | ApifyClientAsync) -> None:
created_rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('queue')))
assert isinstance(created_rq, RequestQueue)
rq = client.request_queue(created_rq.id, client_key=get_random_string(10))
try:
# Add requests and check if correct number of requests was locked
for i in range(15):
await maybe_await(
rq.add_request({'url': f'http://test-lock.com/{i}', 'unique_key': f'http://test-lock.com/{i}'})
)
# Poll until all requests are available for locking (eventual consistency)
async def lock_head() -> LockedRequestQueueHead:
head = await maybe_await(rq.list_and_lock_head(limit=10, lock_duration=timedelta(seconds=10)))
assert isinstance(head, LockedRequestQueueHead)
return head
get_head_and_lock_response = await poll_until_condition(lock_head, lambda head: len(head.items) == 10)
assert len(get_head_and_lock_response.items) == 10
for locked_request in get_head_and_lock_response.items:
assert locked_request.lock_expires_at is not None
# Check if the delete request works
await maybe_await(rq.delete_request_lock(get_head_and_lock_response.items[1].id))
"""This is probably not working:
delete_lock_request = await maybe_await(rq.get_request(get_head_and_lock_response.items[1].id))
assert delete_lock_request is not None
assert delete_lock_request.lock_expires_at is None
"""
await maybe_await(rq.delete_request_lock(get_head_and_lock_response.items[2].id, forefront=True))
"""This is probably not working:
delete_lock_request2 = await maybe_await(rq.get_request(get_head_and_lock_response.items[2].id))
assert delete_lock_request2 is not None
assert delete_lock_request2.lock_expires_at is None
"""
# Check if the prolong request works
prolong_request_lock_response = await maybe_await(
rq.prolong_request_lock(
get_head_and_lock_response.items[3].id,
lock_duration=timedelta(seconds=15),
)
)
assert isinstance(prolong_request_lock_response, RequestLockInfo)
assert prolong_request_lock_response.lock_expires_at is not None
finally:
await maybe_await(rq.delete())
async def test_request_queue_get_or_create_and_get(client: ApifyClient | ApifyClientAsync) -> None:
"""Test creating a request queue and retrieving it."""
rq_name = get_random_resource_name('queue')
# Create queue
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
assert created_rq.id is not None
assert created_rq.name == rq_name
# Get the same queue
retrieved_rq = await maybe_await(rq_client.get())
assert isinstance(retrieved_rq, RequestQueue)
assert retrieved_rq.id == created_rq.id
assert retrieved_rq.name == rq_name
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_update(client: ApifyClient | ApifyClientAsync) -> None:
"""Test updating request queue properties."""
rq_name = get_random_resource_name('queue')
new_name = get_random_resource_name('queue-updated')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Update the name
updated_rq = await maybe_await(rq_client.update(name=new_name))
assert isinstance(updated_rq, RequestQueue)
assert updated_rq.name == new_name
assert updated_rq.id == created_rq.id
# Verify the update persisted
retrieved_rq = await maybe_await(rq_client.get())
assert isinstance(retrieved_rq, RequestQueue)
assert retrieved_rq.name == new_name
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_add_and_get_request(client: ApifyClient | ApifyClientAsync) -> None:
"""Test adding and getting a request from the queue."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Add a request
request_data: RequestWithoutIdDict = {
'url': 'https://example.com/test',
'unique_key': 'test-key-1',
'method': 'GET',
}
add_result = await maybe_await(rq_client.add_request(request_data))
assert isinstance(add_result, RequestRegistration)
assert add_result.request_id is not None
assert add_result.was_already_present is False
# Poll until the request is visible (eventual consistency)
async def get_added_request() -> Request | None:
return await maybe_await(rq_client.get_request(add_result.request_id))
request = await poll_until_condition(get_added_request, lambda request: request is not None)
assert isinstance(request, Request)
assert str(request.url) == 'https://example.com/test'
assert request.unique_key == 'test-key-1'
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_list_head(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing requests from the head of the queue."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Add multiple requests
for i in range(5):
await maybe_await(
rq_client.add_request({'url': f'https://example.com/page-{i}', 'unique_key': f'page-{i}'})
)
# Poll until requests are available (eventual consistency)
async def get_head() -> RequestQueueHead:
head = await maybe_await(rq_client.list_head(limit=3))
assert isinstance(head, RequestQueueHead)
return head
head_response = await poll_until_condition(get_head, lambda head: len(head.items) == 3)
assert len(head_response.items) == 3
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_list_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing all requests in the queue."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Add multiple requests
for i in range(5):
await maybe_await(
rq_client.add_request({'url': f'https://example.com/item-{i}', 'unique_key': f'item-{i}'})
)
# Poll until all requests are available (eventual consistency)
async def get_requests() -> ListOfRequests:
response = await maybe_await(rq_client.list_requests())
assert isinstance(response, ListOfRequests)
return response
list_response = await poll_until_condition(get_requests, lambda response: len(response.items) == 5)
assert len(list_response.items) == 5
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_delete_request(client: ApifyClient | ApifyClientAsync) -> None:
"""Test deleting a request from the queue."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Add a request
add_result = await maybe_await(
rq_client.add_request({'url': 'https://example.com/to-delete', 'unique_key': 'delete-me'})
)
assert isinstance(add_result, RequestRegistration)
# Poll until the request is visible (eventual consistency)
async def get_added_request() -> Request | None:
return await maybe_await(rq_client.get_request(add_result.request_id))
request = await poll_until_condition(get_added_request, lambda request: request is not None)
assert request is not None
# Delete the request
await maybe_await(rq_client.delete_request(add_result.request_id))
# Poll until the deletion is reflected (eventual consistency)
deleted_request = await poll_until_condition(get_added_request, lambda request: request is None)
assert deleted_request is None
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_batch_add_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test adding multiple requests in batch."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Batch add requests
requests_to_add: list[RequestWithoutIdDict] = [
{'url': f'https://example.com/batch-{i}', 'unique_key': f'batch-{i}'} for i in range(10)
]
batch_response = await maybe_await(rq_client.batch_add_requests(requests_to_add))
assert isinstance(batch_response, BatchAddResult)
assert len(batch_response.processed_requests) == 10
assert len(batch_response.unprocessed_requests) == 0
# Poll until all requests are available (eventual consistency)
async def get_requests() -> ListOfRequests:
response = await maybe_await(rq_client.list_requests())
assert isinstance(response, ListOfRequests)
return response
list_response = await poll_until_condition(get_requests, lambda response: len(response.items) == 10)
assert len(list_response.items) == 10
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_batch_delete_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test deleting multiple requests in batch."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Add requests
for i in range(10):
await maybe_await(
rq_client.add_request({'url': f'https://example.com/delete-{i}', 'unique_key': f'delete-{i}'})
)
# Poll until all requests are available (eventual consistency)
async def get_requests() -> ListOfRequests:
response = await maybe_await(rq_client.list_requests())
assert isinstance(response, ListOfRequests)
return response
list_response = await poll_until_condition(get_requests, lambda response: len(response.items) == 10)
assert len(list_response.items) == 10
requests_to_delete: list[RequestDraftDeleteDict] = []
for item in list_response.items[:5]:
assert item.unique_key is not None
requests_to_delete.append({'unique_key': item.unique_key})
# Batch delete
delete_response = await maybe_await(rq_client.batch_delete_requests(requests_to_delete))
assert isinstance(delete_response, BatchDeleteResult)
assert len(delete_response.processed_requests) == 5
# Poll until deletions are reflected (eventual consistency)
remaining = await poll_until_condition(get_requests, lambda response: len(response.items) == 5)
assert len(remaining.items) == 5
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_delete_nonexistent(client: ApifyClient | ApifyClientAsync) -> None:
"""Test that getting a deleted queue returns None."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
# Delete queue
await maybe_await(rq_client.delete())
# Verify it's gone
retrieved_rq = await maybe_await(rq_client.get())
assert retrieved_rq is None
async def test_request_queue_list_and_lock_head(client: ApifyClient | ApifyClientAsync) -> None:
"""Test locking requests from the head of the queue."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id, client_key=get_random_string(10))
try:
# Add multiple requests
for i in range(5):
await maybe_await(
rq_client.add_request({'url': f'https://example.com/lock-{i}', 'unique_key': f'lock-{i}'})
)
await ensure_queue_is_populated(rq_client, expected_count=5)
result = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
assert isinstance(result, LockedRequestQueueHead)
lock_response = result
assert len(lock_response.items) == 3
# Verify requests are locked
for locked_request in lock_response.items:
assert locked_request.id is not None
assert locked_request.lock_expires_at is not None
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_prolong_request_lock(client: ApifyClient | ApifyClientAsync) -> None:
"""Test prolonging a request lock."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id, client_key=get_random_string(10))
try:
# Add a request
await maybe_await(rq_client.add_request({'url': 'https://example.com/prolong', 'unique_key': 'prolong-test'}))
# Poll until the request is available for locking (eventual consistency)
async def lock_head() -> LockedRequestQueueHead:
head = await maybe_await(rq_client.list_and_lock_head(limit=1, lock_duration=timedelta(seconds=60)))
assert isinstance(head, LockedRequestQueueHead)
return head
lock_response = await poll_until_condition(lock_head, lambda head: len(head.items) == 1)
assert len(lock_response.items) == 1
locked_request = lock_response.items[0]
original_lock_expires = locked_request.lock_expires_at
# Prolong the lock
prolong_response = await maybe_await(
rq_client.prolong_request_lock(locked_request.id, lock_duration=timedelta(seconds=120))
)
assert isinstance(prolong_response, RequestLockInfo)
assert prolong_response.lock_expires_at is not None
assert prolong_response.lock_expires_at > original_lock_expires
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_delete_request_lock(client: ApifyClient | ApifyClientAsync) -> None:
"""Test deleting a request lock."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id, client_key=get_random_string(10))
try:
# Add a request
await maybe_await(rq_client.add_request({'url': 'https://example.com/unlock', 'unique_key': 'unlock-test'}))
# Poll until the request is available for locking (eventual consistency)
async def lock_head() -> LockedRequestQueueHead:
head = await maybe_await(rq_client.list_and_lock_head(limit=1, lock_duration=timedelta(seconds=60)))
assert isinstance(head, LockedRequestQueueHead)
return head
lock_response = await poll_until_condition(lock_head, lambda head: len(head.items) == 1)
assert len(lock_response.items) == 1
locked_request = lock_response.items[0]
# Delete the lock
await maybe_await(rq_client.delete_request_lock(locked_request.id))
# Verify the operation succeeded (no exception thrown)
# The request should still exist but be unlocked
request = await maybe_await(rq_client.get_request(locked_request.id))
assert request is not None
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_unlock_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test unlocking all requests locked by the client."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id, client_key=get_random_string(10))
try:
# Add multiple requests
for i in range(5):
await maybe_await(
rq_client.add_request({'url': f'https://example.com/unlock-{i}', 'unique_key': f'unlock-{i}'})
)
await ensure_queue_is_populated(rq_client, expected_count=5)
lock_response = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
assert isinstance(lock_response, LockedRequestQueueHead)
assert len(lock_response.items) == 3
# Locks are acknowledged before they are all visible to `unlock_requests`, so a single call can report
# fewer locks than were just acquired. Each call unlocks whatever is visible to it, so the counts are
# accumulated until every lock is accounted for.
unlocked_counts: list[int] = []
async def unlocked_so_far() -> int:
unlock_response = await maybe_await(rq_client.unlock_requests())
assert isinstance(unlock_response, UnlockRequestsResult)
unlocked_counts.append(unlock_response.unlocked_count)
return sum(unlocked_counts)
unlocked_total = await poll_until_condition(unlocked_so_far, lambda total: total == 3)
assert unlocked_total == 3
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_update_request(client: ApifyClient | ApifyClientAsync) -> None:
"""Test updating a request in the queue."""
rq_name = get_random_resource_name('queue')
created_rq = await maybe_await(client.request_queues().get_or_create(name=rq_name))
assert isinstance(created_rq, RequestQueue)
rq_client = client.request_queue(created_rq.id)
try:
# Add a request
request_data: RequestWithoutIdDict = {
'url': 'https://example.com/original',
'unique_key': 'update-test',
'method': 'GET',
}
add_result = await maybe_await(rq_client.add_request(request_data))
assert isinstance(add_result, RequestRegistration)
assert add_result.request_id is not None
# Poll until the request is visible (eventual consistency), then use its full data
async def get_added_request() -> Request | None:
return await maybe_await(rq_client.get_request(add_result.request_id))
original_request = await poll_until_condition(get_added_request, lambda request: request is not None)
assert isinstance(original_request, Request)
assert original_request.unique_key is not None
# Update the request (change method and add user data)
updated_request_data: RequestDict = {
'id': add_result.request_id,
'url': str(original_request.url),
'unique_key': original_request.unique_key,
'method': 'POST',
'user_data': {'updated': True},
}
update_result = await maybe_await(rq_client.update_request(updated_request_data))
assert isinstance(update_result, RequestRegistration)
assert update_result.request_id == add_result.request_id
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_add_request_round_trips_all_fields(client: ApifyClient | ApifyClientAsync) -> None:
"""Every field of a snake_cased request survives `add_request` and comes back from `get_request`."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
request_data: RequestWithoutIdDict = {
'unique_key': 'round-trip',
'url': 'https://example.com/round-trip',
**ALL_REQUEST_FIELDS,
}
add_result = await maybe_await(rq_client.add_request(request_data))
assert isinstance(add_result, RequestRegistration)
stored = await fetch_stored_request(rq_client, add_result.request_id)
assert_all_fields_stored(stored)
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_batch_add_requests_round_trips_all_fields(
client: ApifyClient | ApifyClientAsync,
) -> None:
"""Every field of a snake_cased request survives `batch_add_requests` and comes back from `get_request`."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
requests_to_add: list[RequestWithoutIdDict] = [
{
'unique_key': 'batch-round-trip',
'url': 'https://example.com/batch-round-trip',
**ALL_REQUEST_FIELDS,
}
]
batch_result = await maybe_await(rq_client.batch_add_requests(requests_to_add))
assert isinstance(batch_result, BatchAddResult)
assert len(batch_result.unprocessed_requests) == 0
assert len(batch_result.processed_requests) == 1
stored = await fetch_stored_request(rq_client, batch_result.processed_requests[0].request_id)
assert_all_fields_stored(stored)
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_add_and_update_request_store_identical_fields(
client: ApifyClient | ApifyClientAsync,
) -> None:
"""The same field dict stored through `add_request` and through `update_request` lands identically."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
added = await maybe_await(
rq_client.add_request(
{'unique_key': 'parity-add', 'url': 'https://example.com/parity-add', **ALL_REQUEST_FIELDS}
)
)
assert isinstance(added, RequestRegistration)
seeded = await maybe_await(
rq_client.add_request({'unique_key': 'parity-update', 'url': 'https://example.com/parity-update'})
)
assert isinstance(seeded, RequestRegistration)
updated = await maybe_await(
rq_client.update_request(
{
'id': seeded.request_id,
'unique_key': 'parity-update',
'url': 'https://example.com/parity-update',
**ALL_REQUEST_FIELDS,
}
)
)
assert isinstance(updated, RequestRegistration)
from_add = await fetch_stored_request(rq_client, added.request_id)
from_update = await fetch_stored_request(rq_client, seeded.request_id)
assert non_identity_fields(from_add) == non_identity_fields(from_update)
assert_all_fields_stored(from_add)
assert_all_fields_stored(from_update)
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_add_request_accepts_camel_cased_fields(client: ApifyClient | ApifyClientAsync) -> None:
"""A camelCased request dict stores the same fields as its snake_cased equivalent."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
camel_request: RequestWithoutIdCamelDict = {
'uniqueKey': 'camel',
'url': 'https://example.com/camel',
'method': 'POST',
'userData': {'label': 'DETAIL', 'depth': 2},
'noRetry': True,
'retryCount': 3,
'headers': {'X-Test': 'yes'},
'payload': '{"a": 1}',
'loadedUrl': 'https://example.com/loaded',
'errorMessages': ['boom'],
'handledAt': HANDLED_AT_ISO,
}
add_result = await maybe_await(rq_client.add_request(camel_request))
assert isinstance(add_result, RequestRegistration)
stored = await fetch_stored_request(rq_client, add_result.request_id)
assert_all_fields_stored(stored)
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_add_request_rejects_undeclared_fields(client: ApifyClient | ApifyClientAsync) -> None:
"""The API refuses a body key its schema does not declare, so a snake_cased field takes the whole write down."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
# `model_validate` keeps the undeclared key as a model extra, which is serialized verbatim.
draft = RequestWithoutId.model_validate(
{'unique_key': 'undeclared', 'url': 'https://example.com/undeclared', 'undeclared_field': 'value'}
)
with pytest.raises(ApifyApiError, match='not allowed by the schema'):
await maybe_await(rq_client.add_request(draft))
with pytest.raises(ApifyApiError, match='not allowed by the schema'):
await maybe_await(rq_client.batch_add_requests([draft]))
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test paginated iteration over user request queues."""
created_ids: list[str] = []
for _ in range(3):
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
created_ids.append(rq.id)
try:
collected = await collect_iterate_until_present(
lambda: client.request_queues().iterate(desc=True),
set(created_ids),
item_type=RequestQueueShort,
is_async=is_async,
)
collected_ids = {rq.id for rq in collected}
for rq_id in created_ids:
assert rq_id in collected_ids
finally:
for rq_id in created_ids:
await maybe_await(client.request_queue(rq_id).delete())
async def test_request_queue_iterate_requests(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test paginated iteration over requests within a queue."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
# Add several requests
added_urls: list[str] = []
for i in range(7):
request_draft = RequestWithoutId(url=f'https://example.com/page-{i}', unique_key=f'unique-{i}')
await maybe_await(rq_client.add_request(request_draft))
added_urls.append(request_draft.url)
# Wait until all 7 requests are indexed (eventual consistency)
await ensure_queue_is_populated(rq_client, expected_count=7)
# Iterate with a small chunk so multiple pages are fetched
iterator = rq_client.iterate_requests(chunk_size=3)
collected: list[Request] = []
if is_async:
assert isinstance(iterator, AsyncIterator)
async for req in iterator:
assert isinstance(req, Request)
collected.append(req)
else:
assert isinstance(iterator, Iterator)
for req in iterator:
assert isinstance(req, Request)
collected.append(req)
assert len(collected) == 7
collected_urls = {r.url for r in collected if r.url is not None}
for url in added_urls:
assert url in collected_urls
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_list_requests_with_cursor(client: ApifyClient | ApifyClientAsync) -> None:
"""Test list_requests pagination via limit and the opaque cursor token."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
for i in range(5):
await maybe_await(
rq_client.add_request(RequestWithoutId(url=f'https://example.com/p-{i}', unique_key=f'u-{i}'))
)
# Wait for all 5 requests to be indexed so pagination is exercised, not truncated
await ensure_queue_is_populated(rq_client, expected_count=5)
# First page
first_page = await maybe_await(rq_client.list_requests(limit=2))
assert isinstance(first_page, ListOfRequests)
assert len(first_page.items) == 2
# The API must return a continuation token when more pages exist (5 items, limit=2)
assert first_page.next_cursor is not None
second_page = await maybe_await(rq_client.list_requests(limit=10, cursor=first_page.next_cursor))
assert isinstance(second_page, ListOfRequests)
first_ids = {r.id for r in first_page.items}
second_ids = {r.id for r in second_page.items}
assert first_ids.isdisjoint(second_ids)
finally:
await maybe_await(rq_client.delete())
async def test_request_queue_list_requests_with_filter(client: ApifyClient | ApifyClientAsync) -> None:
"""Test list_requests with the `filter` parameter (pending only)."""
rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
assert isinstance(rq, RequestQueue)
rq_client = client.request_queue(rq.id)
try:
for i in range(3):
await maybe_await(
rq_client.add_request(RequestWithoutId(url=f'https://example.com/f-{i}', unique_key=f'f-{i}'))
)
# Wait for all 3 requests to be indexed before filtering
await ensure_queue_is_populated(rq_client, expected_count=3)
# All three requests are pending - filter=['pending'] should return all of them.
pending_page = await maybe_await(rq_client.list_requests(filter=['pending']))
assert isinstance(pending_page, ListOfRequests)
assert len(pending_page.items) == 3
finally:
await maybe_await(rq_client.delete())