fix(search): a search that never reached YouTube gets its slot back, and a busy one waits a bounded time
The slot was kept as soon as search.list was about to be called, so a search refused before it went out (no connection, no token) cost the user a slot for nothing. It is kept now only once the client recorded the call's units, or the request went out and its answer never came (YouTube may have counted it): YouTubeError says whether a transport failure was sent, and the client counts what it spent. The process lock around the budget check and the call is waited for at most ten seconds; past that the search is refused as busy (search_busy, a retry can help) and gets its slot back, instead of parking a request worker behind every slow call before it. The lock test now pins one hold around both steps, and the busy test fails on a wait without a bound.
This commit is contained in:
@@ -6,8 +6,11 @@ outright gives its slot back; a zero limit turns live search off, which says so
|
||||
again tomorrow"; a lookup that fails says why instead of answering "no results"; only a few
|
||||
failures an hour get their slot back; and the API source — 100 units a page — reads one page per
|
||||
request, is refused before the call when the shared budget cannot pay for it (checked again under
|
||||
one lock with the call), counts one slot per search though search.list logs its own event, and
|
||||
keeps the slot of a search search.list was already paid for."""
|
||||
one lock with the call, whose wait is bounded), counts one slot per search though search.list logs
|
||||
its own event, and keeps the slot of a search search.list was already paid for — but not of one
|
||||
that never reached YouTube."""
|
||||
|
||||
import threading
|
||||
|
||||
import pytest
|
||||
|
||||
@@ -35,7 +38,7 @@ class _FakeYT:
|
||||
fail_videos = False
|
||||
|
||||
def __init__(self, *_a, **_kw):
|
||||
pass
|
||||
self.spent = 0
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
@@ -47,14 +50,17 @@ class _FakeYT:
|
||||
return []
|
||||
|
||||
# search.list: the pages the test hands out, each logged as the real client does (100 units,
|
||||
# under the action the route attributes it to).
|
||||
# under the action the route attributes it to) — a refusal YouTube answered too, but not a
|
||||
# failure no endpoint answered (no connection, no token).
|
||||
api_pages: list = []
|
||||
api_calls = 0
|
||||
|
||||
def search_videos(self, q, page_token=None, order="relevance"):
|
||||
_FakeYT.api_calls += 1
|
||||
quota.record_usage(100)
|
||||
page = _FakeYT.api_pages.pop(0)
|
||||
if not (isinstance(page, YouTubeError) and not page.path):
|
||||
quota.record_usage(100)
|
||||
self.spent += 100
|
||||
if isinstance(page, Exception):
|
||||
raise page
|
||||
return page
|
||||
@@ -249,27 +255,98 @@ def test_an_api_search_the_budget_refused_at_the_call_gives_its_slot_back(
|
||||
def test_the_budget_check_and_the_call_it_pays_for_hold_one_lock(
|
||||
db, make_user, as_user, pages, monkeypatch
|
||||
):
|
||||
# Checked apart, searches sent together at the last 100 units all passed, and all spent.
|
||||
# Checked apart, searches sent together at the last 100 units all passed, and all spent: the
|
||||
# check and the call sit inside ONE hold of the lock, not two.
|
||||
user = make_user()
|
||||
_api(db)
|
||||
held: list[tuple[str, bool]] = []
|
||||
events: list[str] = []
|
||||
real_check = quota.can_spend
|
||||
real_call = _FakeYT.search_videos
|
||||
|
||||
class _Recorded:
|
||||
def __init__(self):
|
||||
self._lock = threading.Lock()
|
||||
|
||||
def acquire(self, timeout=-1):
|
||||
events.append("acquire")
|
||||
return self._lock.acquire(timeout=timeout)
|
||||
|
||||
def release(self):
|
||||
events.append("release")
|
||||
self._lock.release()
|
||||
|
||||
def can_spend(db_, units):
|
||||
held.append(("check", search_routes._api_search.locked()))
|
||||
events.append("check")
|
||||
return real_check(db_, units)
|
||||
|
||||
def search_videos(self, q, page_token=None, order="relevance"):
|
||||
held.append(("call", search_routes._api_search.locked()))
|
||||
events.append("call")
|
||||
return real_call(self, q, page_token=page_token, order=order)
|
||||
|
||||
monkeypatch.setattr(search_routes, "_api_search", _Recorded())
|
||||
monkeypatch.setattr(search_routes.quota, "can_spend", can_spend)
|
||||
monkeypatch.setattr(_FakeYT, "search_videos", search_videos)
|
||||
_FakeYT.api_pages = [_page(1)]
|
||||
assert as_user(user).get("/api/search/youtube?q=cats").status_code == 200
|
||||
assert held == [("check", False), ("check", True), ("call", True)]
|
||||
assert not search_routes._api_search.locked()
|
||||
assert events == ["check", "acquire", "check", "call", "release"]
|
||||
|
||||
|
||||
def test_a_search_kept_waiting_for_the_lock_is_refused_as_busy_and_keeps_nothing(
|
||||
db, make_user, as_user, pages, monkeypatch
|
||||
):
|
||||
# Each waiter holds a request worker: a slow YouTube must not park them all behind one another.
|
||||
user = make_user()
|
||||
_api(db)
|
||||
monkeypatch.setattr(search_routes, "API_SEARCH_WAIT_SECONDS", 0.05)
|
||||
_FakeYT.api_pages = [_page(1)]
|
||||
# Held by another search for a while: a wait without its bound would get it, and be answered.
|
||||
assert search_routes._api_search.acquire(timeout=1)
|
||||
later = threading.Timer(2.0, search_routes._api_search.release)
|
||||
later.start()
|
||||
try:
|
||||
resp = as_user(user).get("/api/search/youtube?q=cats")
|
||||
finally:
|
||||
later.join()
|
||||
assert resp.status_code == 429
|
||||
assert resp.json()["detail"]["reason"] == "search_busy"
|
||||
assert _FakeYT.api_calls == 0
|
||||
assert quota.actions_today(db, user.id, ACTION) == 0
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"failure",
|
||||
[
|
||||
YouTubeError("YouTube API unreachable (ConnectError)", reason="transport"),
|
||||
YouTubeError("User has no stored OAuth token"),
|
||||
],
|
||||
ids=["no-connection", "no-token"],
|
||||
)
|
||||
def test_an_api_search_that_never_reached_youtube_gives_its_slot_back(
|
||||
db, make_user, as_user, pages, failure
|
||||
):
|
||||
user = make_user()
|
||||
_api(db)
|
||||
sysconfig.set_value(db, "search_daily_limit_per_user", 1)
|
||||
_FakeYT.api_pages = [failure, _page(1)]
|
||||
client = as_user(user)
|
||||
assert client.get("/api/search/youtube?q=cats").status_code == 422
|
||||
assert quota.actions_today(db, user.id, ACTION) == 0
|
||||
assert client.get("/api/search/youtube?q=cats").status_code == 200
|
||||
|
||||
|
||||
def test_an_api_search_whose_answer_never_came_keeps_its_slot(db, make_user, as_user, pages):
|
||||
# The request went out (a read timeout): YouTube may have counted it.
|
||||
user = make_user()
|
||||
_api(db)
|
||||
sysconfig.set_value(db, "search_daily_limit_per_user", 1)
|
||||
_FakeYT.api_pages = [
|
||||
YouTubeError("YouTube API unreachable (ReadTimeout)", reason="transport", sent=True),
|
||||
_page(1),
|
||||
]
|
||||
client = as_user(user)
|
||||
assert client.get("/api/search/youtube?q=cats").status_code == 422
|
||||
assert quota.actions_today(db, user.id, ACTION) == 1
|
||||
assert client.get("/api/search/youtube?q=cats").status_code == 429
|
||||
|
||||
|
||||
def test_failures_past_the_hours_refunds_keep_their_slot(db, make_user, as_user, pages):
|
||||
|
||||
@@ -193,3 +193,45 @@ def test_any_other_token_refusal_keeps_the_grant(monkeypatch):
|
||||
c._access_token()
|
||||
assert tok.scopes == "s"
|
||||
assert refusal_reason(caught.value) == "unavailable"
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("failure", "sent"),
|
||||
[
|
||||
(httpx.ConnectError("refused"), False),
|
||||
(httpx.ConnectTimeout("slow connect"), False),
|
||||
(httpx.ProxyError("proxy down"), False),
|
||||
(httpx.ReadTimeout("no answer"), True),
|
||||
(httpx.RemoteProtocolError("dropped"), True),
|
||||
],
|
||||
)
|
||||
def test_a_transport_failure_says_whether_the_request_went_out(failure, sent):
|
||||
"""A search that never reached YouTube spent nothing and gets its slot back; one whose answer
|
||||
never came may have been counted, and keeps it (`routes/search`)."""
|
||||
|
||||
def request(*_a, **_k):
|
||||
raise failure
|
||||
|
||||
c = yt.YouTubeClient.__new__(yt.YouTubeClient)
|
||||
c._http = SimpleNamespace(request=request)
|
||||
with pytest.raises(YouTubeError) as caught:
|
||||
c._send("GET", "https://example.invalid")
|
||||
assert caught.value.reason == "transport"
|
||||
assert caught.value.sent is sent
|
||||
|
||||
|
||||
def test_a_call_youtube_answered_is_spent_a_refused_one_too(monkeypatch):
|
||||
resp = httpx.Response(
|
||||
400,
|
||||
json={"error": {"errors": [{"reason": "invalidPageToken"}]}},
|
||||
request=httpx.Request("GET", f"{yt.API_BASE}/search"),
|
||||
)
|
||||
recorded: list[int] = []
|
||||
c = yt.YouTubeClient.__new__(yt.YouTubeClient)
|
||||
c.db, c.spent = None, 0
|
||||
monkeypatch.setattr(yt.sysconfig, "get_str", lambda d, key: "a-key")
|
||||
monkeypatch.setattr(yt.quota, "record_usage", recorded.append)
|
||||
monkeypatch.setattr(c, "_send", lambda *a, **k: resp)
|
||||
with pytest.raises(YouTubeError):
|
||||
c._get("search", {}, cost=100)
|
||||
assert (recorded, c.spent) == ([100], 100)
|
||||
|
||||
Reference in New Issue
Block a user