Files
shelfmark/tests/metadata/test_googlebooks_parse.py
T
splitsec2 61cf0792bd fix(googlebooks): report more pages when limit is above the 40 result maximum (#1434)
Kept small on purpose so it's easy to review. Same kind of small fix as
#1429 to #1432, so see the question in #1429 about separate PRs versus
combined. I'm sending them separately until I hear otherwise.

`search_paginated` guesses `has_more` as `len(books) >= options.limit`.
Google Books returns at most 40 per page and `search` already caps
`maxResults` at 40, but `/api/metadata/search` accepts a limit up to
100. With a limit over 40 a full page of 40 never reaches `limit`, so
`has_more` is always False. The UI sends 40, so this only affects direct
API callers.

The Google provider now overrides `search_paginated` to apply the same
cap before the base heuristic runs. A full page of 40 with a limit of
100 reports more results and a short page doesn't. The first test fails
on current `main`. Ruff, basedpyright and `tests/metadata` pass.

The one red check is the existing clock-dependent test
`test_a_queued_torrent_asks_for_a_grace_once`, which fails on any runner
that booted recently. It is fixed in #1426 and is not caused by this
change.
2026-10-20 01:01:38 -04:00

179 lines
5.6 KiB
Python

import requests
from shelfmark.core.cache import get_metadata_cache
from shelfmark.metadata_providers import MetadataSearchOptions
from shelfmark.metadata_providers.googlebooks import GoogleBooksProvider
class _GoogleBooksResponse:
def __init__(self, payload):
self._payload = payload
def raise_for_status(self):
return None
def json(self):
return self._payload
class _FlakyGoogleBooksSession:
def __init__(self):
self.calls = 0
def get(self, *args, **kwargs):
self.calls += 1
if self.calls == 1:
raise requests.Timeout
return _GoogleBooksResponse(
{
"items": [
{
"id": "volume-1",
"volumeInfo": {
"title": "Recovered Book",
"authors": ["Alice Author"],
},
}
]
}
)
class _RecordingGoogleBooksSession:
def __init__(self):
self.params = []
def get(self, *args, **kwargs):
self.params.append(dict(kwargs["params"]))
return _GoogleBooksResponse({"items": []})
def test_googlebooks_search_does_not_cache_request_failures():
get_metadata_cache().clear()
provider = GoogleBooksProvider(api_key="test-key")
session = _FlakyGoogleBooksSession()
provider.session = session
options = MetadataSearchOptions(query="Recovered Book")
assert provider.search(options) == []
result = provider.search(options)
assert session.calls == 2
assert [book.title for book in result] == ["Recovered Book"]
def test_googlebooks_pages_tile_when_limit_exceeds_api_maximum():
get_metadata_cache().clear()
provider = GoogleBooksProvider(api_key="test-key")
session = _RecordingGoogleBooksSession()
provider.session = session
for page in (1, 2):
provider.search(MetadataSearchOptions(query="Dune", limit=50, page=page))
first, second = session.params
assert first["maxResults"] == 40
assert first["startIndex"] == 0
assert second["startIndex"] == first["startIndex"] + first["maxResults"]
def test_googlebooks_page_stride_follows_limit_below_api_maximum():
get_metadata_cache().clear()
provider = GoogleBooksProvider(api_key="test-key")
session = _RecordingGoogleBooksSession()
provider.session = session
provider.search(MetadataSearchOptions(query="Dune", limit=25, page=3))
assert session.params[0]["maxResults"] == 25
assert session.params[0]["startIndex"] == 50
class TestGoogleBooksParseVolume:
def test_parse_volume_returns_metadata_for_valid_payload(self):
provider = GoogleBooksProvider(api_key="test-key")
result = provider._parse_volume(
{
"id": "volume-1",
"volumeInfo": {
"title": "Test Book",
"authors": ["Alice Author"],
"industryIdentifiers": [
{"type": "ISBN_10", "identifier": "1234567890"},
{"type": "ISBN_13", "identifier": "9781234567897"},
],
"imageLinks": {
"thumbnail": "http://example.com/cover.jpg&edge=curl",
},
"publisher": "Test Publisher",
"publishedDate": "2024-03-01",
"language": "en",
"categories": ["Fiction", "Fantasy"],
"description": "A book.",
"infoLink": "https://example.com/books/volume-1",
"averageRating": 4.2,
"ratingsCount": 1200,
},
}
)
assert result is not None
assert result.provider_id == "volume-1"
assert result.title == "Test Book"
assert result.authors == ["Alice Author"]
assert result.isbn_10 == "1234567890"
assert result.isbn_13 == "9781234567897"
assert result.cover_url == "https://example.com/cover.jpg"
assert result.publish_year == 2024
assert result.display_fields[0].value == "4.2 (1,200)"
def test_parse_volume_returns_none_for_malformed_rating_payload(self):
provider = GoogleBooksProvider(api_key="test-key")
result = provider._parse_volume(
{
"id": "volume-2",
"volumeInfo": {
"title": "Broken Book",
"averageRating": "not-a-number",
},
}
)
assert result is None
class _FullPageSession:
def __init__(self, count):
self.count = count
def get(self, *args, **kwargs):
items = [
{"id": f"v{i}", "volumeInfo": {"title": f"Book {i}", "authors": ["Alice Author"]}}
for i in range(self.count)
]
return _GoogleBooksResponse({"items": items})
def test_googlebooks_reports_more_pages_when_limit_exceeds_api_maximum():
get_metadata_cache().clear()
provider = GoogleBooksProvider(api_key="test-key")
provider.session = _FullPageSession(40)
result = provider.search_paginated(MetadataSearchOptions(query="Dune", limit=100))
assert len(result.books) == 40
assert result.has_more is True
def test_googlebooks_reports_no_more_pages_after_a_short_page():
get_metadata_cache().clear()
provider = GoogleBooksProvider(api_key="test-key")
provider.session = _FullPageSession(12)
result = provider.search_paginated(MetadataSearchOptions(query="Dune", limit=100))
assert result.has_more is False