Skip to content

Commit 2f4de93

Browse files
committed
fix(pagination): ensure get_all stops fetching when next page returns None
1 parent 66a57a6 commit 2f4de93

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

‎src/mistapi/__pagination.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,15 @@ def get_all(mist_session: _APISession, response: _APIResponse) -> list:
6060
if tmp:
6161
response = tmp
6262
data += response.data
63+
else:
64+
break
6365
elif isinstance(response.data, dict) and "results" in response.data:
6466
data = response.data["results"].copy()
6567
while response.next:
6668
tmp = get_next(mist_session, response)
6769
if tmp:
6870
response = tmp
6971
data += response.data["results"]
72+
else:
73+
break
7074
return data

‎tests/unit/test_pagination.py‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,23 @@ def test_empty_list_with_next_follows_links(self):
131131

132132
assert result == [{"id": "1"}]
133133

134+
def test_stops_when_fetching_next_page_returns_none(self):
135+
"""get_all() should stop when fetching a next page returns None."""
136+
session = Mock()
137+
session.mist_get.side_effect = [
138+
None,
139+
AssertionError("get_all() retried a page fetch that returned None"),
140+
]
141+
response = _make_response(
142+
data=[{"id": "1"}],
143+
next_url="/api/v1/items?page=2",
144+
)
145+
146+
result = get_all(session, response)
147+
148+
assert result == [{"id": "1"}]
149+
session.mist_get.assert_called_once_with("/api/v1/items?page=2")
150+
134151

135152
class TestGetAllDict:
136153
"""Tests for get_all() when response.data is a dict with 'results' key."""
@@ -217,6 +234,23 @@ def test_empty_results_with_next_follows_links(self):
217234

218235
assert result == [{"id": "1"}]
219236

237+
def test_stops_when_fetching_next_page_returns_none(self):
238+
"""get_all() should stop when fetching a next page returns None."""
239+
session = Mock()
240+
session.mist_get.side_effect = [
241+
None,
242+
AssertionError("get_all() retried a page fetch that returned None"),
243+
]
244+
response = _make_response(
245+
data={"results": [{"id": "1"}]},
246+
next_url="/api/v1/items?page=2",
247+
)
248+
249+
result = get_all(session, response)
250+
251+
assert result == [{"id": "1"}]
252+
session.mist_get.assert_called_once_with("/api/v1/items?page=2")
253+
220254

221255
class TestGetAllEdgeCases:
222256
"""Tests for get_all() edge cases and unsupported data types."""

0 commit comments

Comments
 (0)