forked from 0xWheatyz/SPARC
Add cursor-based pagination to /analyze/batch and /jobs endpoints
- Fix route ordering bug: GET /analyze/batch was shadowed by
GET /analyze/{company_name} causing all GET requests to /analyze/batch
to be erroneously handled as single-company analysis (503). Move
/analyze/batch GET registration to before the {company_name} route.
- Update TypeScript schema.d.ts: add AnalysisRecord, PaginatedAnalysisResponse,
PaginatedJobsResponse schemas; add GET /analyze/batch operation with
cursor+limit+company_name params; update list_jobs_jobs_get to include
cursor param and return PaginatedJobsResponse.
- Update frontend/src/api/client.ts: add listBatchAnalyses() method with
cursor/limit support; update listJobs() to accept cursor and return
PaginatedJobsResponse; default limit changed from 10 to 50.
- Update frontend/src/types/index.ts: export AnalysisRecord,
PaginatedAnalysisResponse, PaginatedJobsResponse.
- Expand tests/test_pagination.py: add auth fixture so tests pass JWT
validation; add 11 new /jobs tests covering first page, last page,
subsequent pages, empty results, status filter, limit boundaries, cursor
forwarding, and paginated response shape.
Closes leeworks-agents/SPARC#1684
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
+171
-19
@@ -1,12 +1,13 @@
|
||||
"""Tests for cursor-based pagination on /analyze/batch GET and /jobs endpoints."""
|
||||
|
||||
from datetime import datetime, timedelta
|
||||
from unittest.mock import Mock, patch
|
||||
from datetime import datetime, timedelta, timezone
|
||||
from unittest.mock import MagicMock, Mock, patch
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from SPARC.api import app
|
||||
from SPARC.auth import create_access_token
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
@@ -15,6 +16,27 @@ def client():
|
||||
return TestClient(app)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def mock_auth_db():
|
||||
"""Mock the auth DB so JWT token validation succeeds without a real database."""
|
||||
db = MagicMock()
|
||||
db.get_user_by_id.return_value = {
|
||||
"id": 1,
|
||||
"email": "user@test.com",
|
||||
"role": "user",
|
||||
"created_at": datetime(2025, 1, 1, tzinfo=timezone.utc),
|
||||
}
|
||||
with patch("SPARC.api.get_db_client", return_value=db), \
|
||||
patch("SPARC.auth.get_db_client", return_value=db):
|
||||
yield db
|
||||
|
||||
|
||||
def _auth_header():
|
||||
"""Create a Bearer auth header for a regular user."""
|
||||
token = create_access_token(1, "user@test.com", "user")
|
||||
return {"Authorization": f"Bearer {token}"}
|
||||
|
||||
|
||||
def _make_analysis_row(id_: int, minutes_ago: int = 0, company: str = "nvidia"):
|
||||
"""Create a fake analysis row dict."""
|
||||
ts = datetime.now() - timedelta(minutes=minutes_ago)
|
||||
@@ -56,7 +78,7 @@ class TestAnalyzeBatchGetPagination:
|
||||
]
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/analyze/batch?limit=10")
|
||||
response = client.get("/analyze/batch?limit=10", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert len(data["items"]) == 2
|
||||
@@ -71,7 +93,7 @@ class TestAnalyzeBatchGetPagination:
|
||||
db.list_analyses.return_value = rows
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/analyze/batch?limit=3")
|
||||
response = client.get("/analyze/batch?limit=3", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert len(data["items"]) == 3
|
||||
@@ -84,11 +106,14 @@ class TestAnalyzeBatchGetPagination:
|
||||
db.list_analyses.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
client.get("/analyze/batch?cursor=2025-01-01T00:00:00|42")
|
||||
client.get("/analyze/batch?cursor=2025-01-01T00:00:00|42", headers=_auth_header())
|
||||
db.list_analyses.assert_called_once()
|
||||
call_kwargs = db.list_analyses.call_args
|
||||
assert call_kwargs.kwargs.get("cursor") == "2025-01-01T00:00:00|42" or \
|
||||
(call_kwargs[1].get("cursor") == "2025-01-01T00:00:00|42" if len(call_kwargs) > 1 else False)
|
||||
cursor_val = (
|
||||
call_kwargs.kwargs.get("cursor")
|
||||
or (call_kwargs[1].get("cursor") if len(call_kwargs) > 1 else None)
|
||||
)
|
||||
assert cursor_val == "2025-01-01T00:00:00|42"
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_default_limit_is_50(self, mock_get_db, client):
|
||||
@@ -97,19 +122,19 @@ class TestAnalyzeBatchGetPagination:
|
||||
db.list_analyses.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
client.get("/analyze/batch")
|
||||
client.get("/analyze/batch", headers=_auth_header())
|
||||
call_kwargs = db.list_analyses.call_args
|
||||
# The endpoint requests limit+1 from DB, so 51
|
||||
assert 51 in call_kwargs.args or call_kwargs.kwargs.get("limit") == 51
|
||||
|
||||
def test_limit_over_200_rejected(self, client):
|
||||
"""Limit > 200 should be rejected with 422."""
|
||||
response = client.get("/analyze/batch?limit=201")
|
||||
response = client.get("/analyze/batch?limit=201", headers=_auth_header())
|
||||
assert response.status_code == 422
|
||||
|
||||
def test_limit_zero_rejected(self, client):
|
||||
"""Limit < 1 should be rejected with 422."""
|
||||
response = client.get("/analyze/batch?limit=0")
|
||||
response = client.get("/analyze/batch?limit=0", headers=_auth_header())
|
||||
assert response.status_code == 422
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
@@ -119,10 +144,13 @@ class TestAnalyzeBatchGetPagination:
|
||||
db.list_analyses.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
client.get("/analyze/batch?company_name=intel")
|
||||
client.get("/analyze/batch?company_name=intel", headers=_auth_header())
|
||||
call_kwargs = db.list_analyses.call_args
|
||||
assert call_kwargs.kwargs.get("company_name") == "intel" or \
|
||||
"intel" in (call_kwargs.args if call_kwargs.args else [])
|
||||
company_val = (
|
||||
call_kwargs.kwargs.get("company_name")
|
||||
or (call_kwargs[1].get("company_name") if len(call_kwargs) > 1 else None)
|
||||
)
|
||||
assert company_val == "intel"
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_empty_result_set(self, mock_get_db, client):
|
||||
@@ -131,15 +159,30 @@ class TestAnalyzeBatchGetPagination:
|
||||
db.list_analyses.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/analyze/batch")
|
||||
response = client.get("/analyze/batch", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["items"] == []
|
||||
assert data["next_cursor"] is None
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_subsequent_page_uses_cursor(self, mock_get_db, client):
|
||||
"""Passing a cursor should retrieve the next page of results."""
|
||||
db = Mock()
|
||||
db.list_analyses.return_value = [_make_analysis_row(99, minutes_ago=100)]
|
||||
mock_get_db.return_value = db
|
||||
|
||||
class TestJobsPaginationDefaults:
|
||||
"""Test that /jobs endpoint uses updated defaults."""
|
||||
cursor = "2025-06-01T12:00:00|50"
|
||||
response = client.get(f"/analyze/batch?limit=10&cursor={cursor}", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
# Only one item returned → last page → no next cursor
|
||||
assert len(data["items"]) == 1
|
||||
assert data["next_cursor"] is None
|
||||
|
||||
|
||||
class TestJobsPagination:
|
||||
"""Test cursor-based pagination on GET /jobs."""
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_default_limit_is_50(self, mock_get_db, client):
|
||||
@@ -148,14 +191,19 @@ class TestJobsPaginationDefaults:
|
||||
db.list_jobs.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
client.get("/jobs")
|
||||
client.get("/jobs", headers=_auth_header())
|
||||
call_kwargs = db.list_jobs.call_args
|
||||
# Endpoint requests limit+1 from DB, so 51
|
||||
assert 51 in call_kwargs.args or call_kwargs.kwargs.get("limit") == 51
|
||||
|
||||
def test_limit_over_200_rejected(self, client):
|
||||
"""Limit > 200 should be rejected with 422."""
|
||||
response = client.get("/jobs?limit=201")
|
||||
response = client.get("/jobs?limit=201", headers=_auth_header())
|
||||
assert response.status_code == 422
|
||||
|
||||
def test_limit_zero_rejected(self, client):
|
||||
"""Limit < 1 should be rejected with 422."""
|
||||
response = client.get("/jobs?limit=0", headers=_auth_header())
|
||||
assert response.status_code == 422
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
@@ -165,5 +213,109 @@ class TestJobsPaginationDefaults:
|
||||
db.list_jobs.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/jobs?limit=200")
|
||||
response = client.get("/jobs?limit=200", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_first_page_returns_items_and_cursor(self, mock_get_db, client):
|
||||
"""First page with more results than limit should return next_cursor."""
|
||||
db = Mock()
|
||||
# Return limit+1 rows to simulate more data available
|
||||
rows = [_make_job_row(f"job-{i}", minutes_ago=i) for i in range(4)]
|
||||
db.list_jobs.return_value = rows
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/jobs?limit=3", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert len(data["items"]) == 3
|
||||
assert data["next_cursor"] is not None
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_last_page_returns_no_cursor(self, mock_get_db, client):
|
||||
"""When fewer results than limit, next_cursor should be null (last page)."""
|
||||
db = Mock()
|
||||
rows = [
|
||||
_make_job_row("job-a", minutes_ago=5),
|
||||
_make_job_row("job-b", minutes_ago=10),
|
||||
]
|
||||
db.list_jobs.return_value = rows
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/jobs?limit=10", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert len(data["items"]) == 2
|
||||
assert data["next_cursor"] is None
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_cursor_forwarded_to_db(self, mock_get_db, client):
|
||||
"""The cursor query param should be forwarded to the database layer."""
|
||||
db = Mock()
|
||||
db.list_jobs.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
client.get("/jobs?cursor=2025-01-01T00:00:00|job-99", headers=_auth_header())
|
||||
db.list_jobs.assert_called_once()
|
||||
call_kwargs = db.list_jobs.call_args
|
||||
cursor_val = (
|
||||
call_kwargs.kwargs.get("cursor")
|
||||
or (call_kwargs[1].get("cursor") if len(call_kwargs) > 1 else None)
|
||||
)
|
||||
assert cursor_val == "2025-01-01T00:00:00|job-99"
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_empty_result_set(self, mock_get_db, client):
|
||||
"""Empty result set returns empty items list and null next_cursor."""
|
||||
db = Mock()
|
||||
db.list_jobs.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/jobs", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["items"] == []
|
||||
assert data["next_cursor"] is None
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_status_filter_forwarded(self, mock_get_db, client):
|
||||
"""The status filter should be forwarded to the database layer."""
|
||||
db = Mock()
|
||||
db.list_jobs.return_value = []
|
||||
mock_get_db.return_value = db
|
||||
|
||||
client.get("/jobs?status=completed", headers=_auth_header())
|
||||
db.list_jobs.assert_called_once()
|
||||
call_kwargs = db.list_jobs.call_args
|
||||
status_val = (
|
||||
call_kwargs.kwargs.get("status")
|
||||
or (call_kwargs[1].get("status") if len(call_kwargs) > 1 else None)
|
||||
)
|
||||
assert status_val == "completed"
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_response_has_paginated_shape(self, mock_get_db, client):
|
||||
"""Response must have 'items' and 'next_cursor' fields (paginated shape)."""
|
||||
db = Mock()
|
||||
db.list_jobs.return_value = [_make_job_row("job-x")]
|
||||
mock_get_db.return_value = db
|
||||
|
||||
response = client.get("/jobs?limit=10", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert "items" in data
|
||||
assert "next_cursor" in data
|
||||
|
||||
@patch("SPARC.api._get_job_db")
|
||||
def test_subsequent_page_uses_cursor(self, mock_get_db, client):
|
||||
"""Passing cursor returns the next page; last page has null next_cursor."""
|
||||
db = Mock()
|
||||
db.list_jobs.return_value = [_make_job_row("job-last", minutes_ago=200)]
|
||||
mock_get_db.return_value = db
|
||||
|
||||
cursor = "2025-06-01T12:00:00|job-50"
|
||||
response = client.get(f"/jobs?limit=10&cursor={cursor}", headers=_auth_header())
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert len(data["items"]) == 1
|
||||
assert data["next_cursor"] is None
|
||||
|
||||
Reference in New Issue
Block a user