Skip to content

Commit d1bd5a3

Browse files
authored
test: fix flaky test_request_queue_unlock_requests (#786)
## Summary Fix [this flaky CI run](https://github.com/apify/apify-client-python/actions/runs/25495772865/job/74814967391?pr=742) of `test_request_queue_unlock_requests[sync]`, which failed with `assert 2 == 3` on `unlock_response.unlocked_count`. **Root cause:** the polling loop called `list_and_lock_head` repeatedly, which has the side effect of locking items. Across multiple iterations (due to eventual consistency on `add_request`) the total set of actually-locked requests no longer matched the last response's `items` count, so `unlock_requests` could report a different count than the test expected. **Fix:** separate the two concerns — poll the read-only `list_head` until all 5 added requests are visible, then call `list_and_lock_head(limit=3)` exactly once. This removes the cross-iteration locking ambiguity. Applied the same treatment to `test_request_queue_list_and_lock_head`, which shared the same racy polling pattern.
1 parent a2fed29 commit d1bd5a3

1 file changed

Lines changed: 33 additions & 20 deletions

File tree

‎tests/integration/test_request_queue.py‎

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,34 @@
2222

2323
if TYPE_CHECKING:
2424
from apify_client import ApifyClient, ApifyClientAsync
25+
from apify_client._resource_clients.request_queue import RequestQueueClient, RequestQueueClientAsync
2526
from apify_client._typeddicts import RequestDict, RequestDraftDeleteDict, RequestDraftDict
2627

2728

29+
async def ensure_queue_is_populated(
30+
rq_client: RequestQueueClient | RequestQueueClientAsync,
31+
*,
32+
expected_count: int,
33+
is_async: bool,
34+
) -> None:
35+
"""Poll the queue until `expected_count` requests are visible.
36+
37+
Uses `list_head` (without side effects) so polling does not lock items, which would otherwise
38+
lead to an ambiguous count of actually-locked requests in tests that exercise locking.
39+
"""
40+
head_response: RequestQueueHead | None = None
41+
for _ in range(5):
42+
await maybe_sleep(1, is_async=is_async)
43+
result = await maybe_await(rq_client.list_head(limit=expected_count))
44+
assert isinstance(result, RequestQueueHead)
45+
head_response = result
46+
if len(head_response.items) == expected_count:
47+
break
48+
49+
assert head_response is not None
50+
assert len(head_response.items) == expected_count
51+
52+
2853
async def test_request_queue_collection_list(client: ApifyClient | ApifyClientAsync) -> None:
2954
"""Test listing request queues."""
3055
rq_page = await maybe_await(client.request_queues().list(limit=10))
@@ -411,17 +436,11 @@ async def test_request_queue_list_and_lock_head(client: ApifyClient | ApifyClien
411436
rq_client.add_request({'url': f'https://example.com/lock-{i}', 'unique_key': f'lock-{i}'})
412437
)
413438

414-
# Poll until requests are available for locking (eventual consistency)
415-
lock_response: LockedRequestQueueHead | None = None
416-
for _ in range(5):
417-
await maybe_sleep(1, is_async=is_async)
418-
result = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
419-
assert isinstance(result, LockedRequestQueueHead)
420-
lock_response = result
421-
if len(lock_response.items) == 3:
422-
break
439+
await ensure_queue_is_populated(rq_client, expected_count=5, is_async=is_async)
423440

424-
assert lock_response is not None
441+
result = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
442+
assert isinstance(result, LockedRequestQueueHead)
443+
lock_response = result
425444
assert len(lock_response.items) == 3
426445

427446
# Verify requests are locked
@@ -522,17 +541,11 @@ async def test_request_queue_unlock_requests(client: ApifyClient | ApifyClientAs
522541
rq_client.add_request({'url': f'https://example.com/unlock-{i}', 'unique_key': f'unlock-{i}'})
523542
)
524543

525-
# Poll until requests are available for locking (eventual consistency)
526-
lock_response: LockedRequestQueueHead | None = None
527-
for _ in range(5):
528-
await maybe_sleep(1, is_async=is_async)
529-
result = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
530-
assert isinstance(result, LockedRequestQueueHead)
531-
lock_response = result
532-
if len(lock_response.items) == 3:
533-
break
544+
await ensure_queue_is_populated(rq_client, expected_count=5, is_async=is_async)
534545

535-
assert lock_response is not None
546+
result = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
547+
assert isinstance(result, LockedRequestQueueHead)
548+
lock_response = result
536549
assert len(lock_response.items) == 3
537550

538551
# Unlock all requests

0 commit comments

Comments
 (0)