forked from 0xWheatyz/SPARC
Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0e68e8c900 | |||
| 313800215c | |||
| 222f29deb1 | |||
| e6d95bbf57 | |||
| 68484ef4b1 | |||
| a0cb9a5773 | |||
| 857b3444df | |||
| a95129904e | |||
| 7c6eed8d72 | |||
| 4c411e1e0b |
+30
-37
@@ -81,57 +81,50 @@ Items that have been implemented and merged into main.
|
|||||||
- ~~OpenAPI client generation.~~ TypeScript API client auto-generated from
|
- ~~OpenAPI client generation.~~ TypeScript API client auto-generated from
|
||||||
FastAPI spec with CI freshness check.
|
FastAPI spec with CI freshness check.
|
||||||
|
|
||||||
|
### Resilience
|
||||||
|
|
||||||
|
- ~~`_jobs` dict is in-memory only.~~ Database-backed job persistence
|
||||||
|
implemented using `db.list_jobs()` and `mark_stale_jobs_failed()`. The
|
||||||
|
in-memory `_jobs` dict has been removed.
|
||||||
|
|
||||||
|
### Test coverage (P1/P2)
|
||||||
|
|
||||||
|
- ~~Export endpoint tests.~~ Tests added for CSV and PDF export endpoints.
|
||||||
|
- ~~Tracked company admin endpoint tests.~~ Tests added for `/admin/tracked`
|
||||||
|
CRUD endpoints and scheduler integration.
|
||||||
|
- ~~Webhook integration tests.~~ Tests added for retry logic, Slack/Discord
|
||||||
|
payload format, and multi-URL dispatch.
|
||||||
|
- ~~S3/MinIO storage backend tests.~~ Unit tests added for the S3 backend
|
||||||
|
(read, write, exists, delete, error handling).
|
||||||
|
- ~~`analyze_single_patent` auto-download path tests.~~ Tests added for the
|
||||||
|
auto-download fallback (cache lookup, PDF download, FileNotFoundError).
|
||||||
|
|
||||||
|
### Code quality
|
||||||
|
|
||||||
|
- ~~Scheduler creates its own DatabaseClient.~~ Refactored to use the
|
||||||
|
application-level pooled `get_db_client()`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## P1 -- High Priority
|
## P1 -- High Priority
|
||||||
|
|
||||||
These items address correctness, reliability, and coverage gaps that should be
|
No outstanding P1 items. All previously listed items have been completed and
|
||||||
resolved before broader production use.
|
moved to the Completed section above.
|
||||||
|
|
||||||
### Resilience
|
|
||||||
|
|
||||||
- **`_jobs` dict is in-memory only.** Job state is lost on API restart.
|
|
||||||
Persist job status in PostgreSQL or Redis so async batch results survive
|
|
||||||
restarts.
|
|
||||||
|
|
||||||
### Test coverage gaps
|
|
||||||
|
|
||||||
- **Export endpoint tests.** The CSV and PDF export endpoints (`/export/`)
|
|
||||||
lack test coverage. Add tests covering auth, success, 404, and edge cases.
|
|
||||||
*(Issue #1655)*
|
|
||||||
- **Tracked company admin endpoint tests.** The `/admin/tracked` CRUD
|
|
||||||
endpoints and scheduler integration lack test coverage. *(Issue #1656)*
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## P2 -- Medium Priority
|
## P2 -- Medium Priority
|
||||||
|
|
||||||
Improvements to reliability, test coverage, and code quality.
|
Improvements to the API surface.
|
||||||
|
|
||||||
### Test coverage
|
|
||||||
|
|
||||||
- **Webhook integration tests.** The retry logic, Slack/Discord payload
|
|
||||||
format, and multi-URL dispatch in `webhooks.py` need test coverage.
|
|
||||||
*(Issue #1657)*
|
|
||||||
- **S3/MinIO storage backend tests.** `storage.py` has local filesystem tests
|
|
||||||
but no unit tests for the S3 backend (read, write, exists, delete,
|
|
||||||
error handling). *(Issue #1660)*
|
|
||||||
- **`analyze_single_patent` auto-download path tests.** The auto-download
|
|
||||||
fallback (cache lookup, PDF download, FileNotFoundError) in
|
|
||||||
`analyzer.py` lacks test coverage. *(Issue #1661)*
|
|
||||||
|
|
||||||
### Code quality
|
|
||||||
|
|
||||||
- **Scheduler creates its own DatabaseClient.** `scheduler.py` bypasses the
|
|
||||||
application-level pooled client, creating a new connection on every tick.
|
|
||||||
Refactor to use `get_db_client()`. *(Issue #1658)*
|
|
||||||
|
|
||||||
### API improvements
|
### API improvements
|
||||||
|
|
||||||
- **API pagination.** The `/analyze/batch` and `/jobs` endpoints could benefit
|
- **API pagination.** The `/analyze/batch` endpoint needs cursor-based
|
||||||
from cursor-based pagination for large result sets.
|
pagination for large result sets. The `/jobs` endpoint already has cursor
|
||||||
|
pagination. *(Issue #1669)*
|
||||||
- **Request validation improvements.** Add stricter input validation for
|
- **Request validation improvements.** Add stricter input validation for
|
||||||
company names (disallow special characters, enforce length limits).
|
company names (disallow special characters, enforce length limits).
|
||||||
|
*(Issue #1670)*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+149
-10
@@ -12,10 +12,10 @@ from typing import TYPE_CHECKING, Annotated, List
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from SPARC.database import DatabaseClient
|
from SPARC.database import DatabaseClient
|
||||||
|
|
||||||
from fastapi import BackgroundTasks, Depends, FastAPI, HTTPException, Query, Request
|
from fastapi import BackgroundTasks, Depends, FastAPI, HTTPException, Path, Query, Request
|
||||||
from fastapi.middleware.cors import CORSMiddleware
|
from fastapi.middleware.cors import CORSMiddleware
|
||||||
from fastapi.responses import JSONResponse, StreamingResponse
|
from fastapi.responses import JSONResponse, StreamingResponse
|
||||||
from pydantic import BaseModel, EmailStr, Field
|
from pydantic import BaseModel, EmailStr, Field, StringConstraints
|
||||||
from slowapi import Limiter
|
from slowapi import Limiter
|
||||||
from slowapi.errors import RateLimitExceeded
|
from slowapi.errors import RateLimitExceeded
|
||||||
from slowapi.util import get_remote_address
|
from slowapi.util import get_remote_address
|
||||||
@@ -36,6 +36,16 @@ from SPARC.auth import (
|
|||||||
)
|
)
|
||||||
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult
|
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult
|
||||||
|
|
||||||
|
# Validated company name type: 2-100 chars, alphanumeric + spaces/hyphens/ampersands/periods only.
|
||||||
|
CompanyName = Annotated[
|
||||||
|
str,
|
||||||
|
StringConstraints(
|
||||||
|
min_length=2,
|
||||||
|
max_length=100,
|
||||||
|
pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
# Pydantic models for API
|
# Pydantic models for API
|
||||||
class CompanyAnalysisResponse(BaseModel):
|
class CompanyAnalysisResponse(BaseModel):
|
||||||
@@ -72,7 +82,7 @@ class CompanyAnalysisRequest(BaseModel):
|
|||||||
class BatchAnalysisRequest(BaseModel):
|
class BatchAnalysisRequest(BaseModel):
|
||||||
"""Request model for batch company analysis."""
|
"""Request model for batch company analysis."""
|
||||||
|
|
||||||
companies: list[str] = Field(
|
companies: list[CompanyName] = Field(
|
||||||
..., min_length=1, max_length=20, description="List of company names to analyze"
|
..., min_length=1, max_length=20, description="List of company names to analyze"
|
||||||
)
|
)
|
||||||
max_workers: int = Field(
|
max_workers: int = Field(
|
||||||
@@ -96,6 +106,24 @@ class JobStatus(BaseModel):
|
|||||||
error: str | None = None
|
error: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class AnalysisRecord(BaseModel):
|
||||||
|
"""A single stored analysis result."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
company_name: str | None = None
|
||||||
|
analysis_type: str | None = None
|
||||||
|
model: str | None = None
|
||||||
|
response: str | None = None
|
||||||
|
timestamp: datetime | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class PaginatedAnalysisResponse(BaseModel):
|
||||||
|
"""Paginated response for analysis result listings."""
|
||||||
|
|
||||||
|
items: list[AnalysisRecord]
|
||||||
|
next_cursor: str | None = None
|
||||||
|
|
||||||
|
|
||||||
class PaginatedJobsResponse(BaseModel):
|
class PaginatedJobsResponse(BaseModel):
|
||||||
"""Paginated response for job listings."""
|
"""Paginated response for job listings."""
|
||||||
|
|
||||||
@@ -217,10 +245,37 @@ app = FastAPI(
|
|||||||
limiter = Limiter(key_func=get_remote_address)
|
limiter = Limiter(key_func=get_remote_address)
|
||||||
app.state.limiter = limiter
|
app.state.limiter = limiter
|
||||||
|
|
||||||
|
# In-memory rate limit statistics
|
||||||
|
_rate_limit_stats: dict[str, dict] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def _track_rate_limit_request(endpoint: str, ip: str, rejected: bool = False) -> None:
|
||||||
|
"""Record a request against a rate-limited endpoint."""
|
||||||
|
key = endpoint
|
||||||
|
if key not in _rate_limit_stats:
|
||||||
|
_rate_limit_stats[key] = {
|
||||||
|
"endpoint": endpoint,
|
||||||
|
"total_requests": 0,
|
||||||
|
"rejected_requests": 0,
|
||||||
|
"by_ip": {},
|
||||||
|
}
|
||||||
|
_rate_limit_stats[key]["total_requests"] += 1
|
||||||
|
if rejected:
|
||||||
|
_rate_limit_stats[key]["rejected_requests"] += 1
|
||||||
|
ip_stats = _rate_limit_stats[key].setdefault("by_ip", {})
|
||||||
|
if ip not in ip_stats:
|
||||||
|
ip_stats[ip] = {"total": 0, "rejected": 0}
|
||||||
|
ip_stats[ip]["total"] += 1
|
||||||
|
if rejected:
|
||||||
|
ip_stats[ip]["rejected"] += 1
|
||||||
|
|
||||||
|
|
||||||
@app.exception_handler(RateLimitExceeded)
|
@app.exception_handler(RateLimitExceeded)
|
||||||
async def rate_limit_handler(request: Request, exc: RateLimitExceeded):
|
async def rate_limit_handler(request: Request, exc: RateLimitExceeded):
|
||||||
"""Return 429 with Retry-After header when rate limit is exceeded."""
|
"""Return 429 with Retry-After header when rate limit is exceeded."""
|
||||||
|
endpoint = request.url.path
|
||||||
|
ip = get_remote_address(request)
|
||||||
|
_track_rate_limit_request(endpoint, ip, rejected=True)
|
||||||
retry_after = getattr(exc, "retry_after", 60)
|
retry_after = getattr(exc, "retry_after", 60)
|
||||||
return JSONResponse(
|
return JSONResponse(
|
||||||
status_code=429,
|
status_code=429,
|
||||||
@@ -249,6 +304,7 @@ async def register(request: Request, body: RegisterRequest):
|
|||||||
|
|
||||||
The first registered user automatically becomes an admin.
|
The first registered user automatically becomes an admin.
|
||||||
"""
|
"""
|
||||||
|
_track_rate_limit_request("/auth/register", get_remote_address(request))
|
||||||
db = get_db_client()
|
db = get_db_client()
|
||||||
|
|
||||||
# First user becomes admin
|
# First user becomes admin
|
||||||
@@ -279,6 +335,7 @@ async def register(request: Request, body: RegisterRequest):
|
|||||||
@limiter.limit("10/minute")
|
@limiter.limit("10/minute")
|
||||||
async def login(request: Request, body: LoginRequest):
|
async def login(request: Request, body: LoginRequest):
|
||||||
"""Authenticate user and return JWT tokens."""
|
"""Authenticate user and return JWT tokens."""
|
||||||
|
_track_rate_limit_request("/auth/login", get_remote_address(request))
|
||||||
db = get_db_client()
|
db = get_db_client()
|
||||||
|
|
||||||
user = db.authenticate_user(body.email, body.password)
|
user = db.authenticate_user(body.email, body.password)
|
||||||
@@ -405,7 +462,7 @@ async def delete_user(
|
|||||||
class TrackCompanyRequest(BaseModel):
|
class TrackCompanyRequest(BaseModel):
|
||||||
"""Request to add a company to tracking."""
|
"""Request to add a company to tracking."""
|
||||||
|
|
||||||
company_name: str = Field(..., min_length=1, max_length=255)
|
company_name: CompanyName = Field(...)
|
||||||
|
|
||||||
|
|
||||||
@app.get("/admin/tracked", tags=["Admin"])
|
@app.get("/admin/tracked", tags=["Admin"])
|
||||||
@@ -432,7 +489,7 @@ async def add_tracked_company(
|
|||||||
|
|
||||||
@app.delete("/admin/tracked/{company_name}", tags=["Admin"])
|
@app.delete("/admin/tracked/{company_name}", tags=["Admin"])
|
||||||
async def remove_tracked_company(
|
async def remove_tracked_company(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
_: UserResponse = Depends(get_current_admin),
|
_: UserResponse = Depends(get_current_admin),
|
||||||
):
|
):
|
||||||
"""Remove a company from the tracked list (admin only)."""
|
"""Remove a company from the tracked list (admin only)."""
|
||||||
@@ -443,6 +500,36 @@ async def remove_tracked_company(
|
|||||||
return {"message": f"Stopped tracking {company_name}"}
|
return {"message": f"Stopped tracking {company_name}"}
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/admin/rate-limits", tags=["Admin"])
|
||||||
|
async def get_rate_limit_stats(
|
||||||
|
_: UserResponse = Depends(get_current_admin),
|
||||||
|
):
|
||||||
|
"""Get rate limit status and usage statistics (admin only).
|
||||||
|
|
||||||
|
Returns current rate limit configuration and request statistics
|
||||||
|
for all rate-limited endpoints.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of rate limit stats per endpoint with total/rejected counts
|
||||||
|
"""
|
||||||
|
rate_limits_config = {
|
||||||
|
"/auth/register": {"limit": "5/minute"},
|
||||||
|
"/auth/login": {"limit": "10/minute"},
|
||||||
|
}
|
||||||
|
|
||||||
|
results = []
|
||||||
|
for endpoint, conf in rate_limits_config.items():
|
||||||
|
stats = _rate_limit_stats.get(endpoint, {})
|
||||||
|
results.append({
|
||||||
|
"endpoint": endpoint,
|
||||||
|
"limit": conf["limit"],
|
||||||
|
"total_requests": stats.get("total_requests", 0),
|
||||||
|
"rejected_requests": stats.get("rejected_requests", 0),
|
||||||
|
})
|
||||||
|
|
||||||
|
return {"rate_limits": results}
|
||||||
|
|
||||||
|
|
||||||
@app.get("/admin/alerts", tags=["Admin"])
|
@app.get("/admin/alerts", tags=["Admin"])
|
||||||
async def list_alerts(
|
async def list_alerts(
|
||||||
limit: int = Query(default=50, ge=1, le=200),
|
limit: int = Query(default=50, ge=1, le=200),
|
||||||
@@ -590,7 +677,7 @@ async def get_analytics_trends(
|
|||||||
|
|
||||||
@app.get("/export/{company_name}", tags=["Export"])
|
@app.get("/export/{company_name}", tags=["Export"])
|
||||||
async def export_company_csv(
|
async def export_company_csv(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Export analysis results for a company as a CSV file.
|
"""Export analysis results for a company as a CSV file.
|
||||||
@@ -642,7 +729,7 @@ async def export_company_csv(
|
|||||||
|
|
||||||
@app.get("/export/{company_name}/pdf", tags=["Export"])
|
@app.get("/export/{company_name}/pdf", tags=["Export"])
|
||||||
async def export_company_pdf(
|
async def export_company_pdf(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Export analysis results for a company as a formatted PDF report.
|
"""Export analysis results for a company as a formatted PDF report.
|
||||||
@@ -810,13 +897,65 @@ async def health_check():
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.get(
|
||||||
|
"/analyze/batch",
|
||||||
|
response_model=PaginatedAnalysisResponse,
|
||||||
|
tags=["Analysis"],
|
||||||
|
)
|
||||||
|
async def list_analysis_results(
|
||||||
|
company_name: Annotated[
|
||||||
|
str | None,
|
||||||
|
Query(description="Filter results by company name"),
|
||||||
|
] = None,
|
||||||
|
limit: Annotated[int, Query(ge=1, le=200)] = 50,
|
||||||
|
cursor: Annotated[
|
||||||
|
str | None,
|
||||||
|
Query(description="Opaque cursor from a previous response's next_cursor field"),
|
||||||
|
] = None,
|
||||||
|
_: UserResponse = Depends(get_current_user),
|
||||||
|
):
|
||||||
|
"""List stored analysis results with cursor-based pagination.
|
||||||
|
|
||||||
|
Returns past analysis results ordered by timestamp descending. Use
|
||||||
|
``limit`` to control page size (default 50, max 200). The response
|
||||||
|
includes a ``next_cursor`` field; pass it back as the ``cursor`` query
|
||||||
|
parameter to fetch the next page. When ``next_cursor`` is ``null``,
|
||||||
|
there are no more results.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
company_name: Optional filter by company name
|
||||||
|
limit: Maximum number of results to return (default 50, max 200)
|
||||||
|
cursor: Opaque pagination cursor from a previous response
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Paginated list of analysis results
|
||||||
|
"""
|
||||||
|
db = _get_job_db()
|
||||||
|
rows = db.list_analyses(company_name=company_name, limit=limit + 1, cursor=cursor)
|
||||||
|
|
||||||
|
has_next = len(rows) > limit
|
||||||
|
if has_next:
|
||||||
|
rows = rows[:limit]
|
||||||
|
|
||||||
|
items = [AnalysisRecord(**row) for row in rows]
|
||||||
|
|
||||||
|
next_cursor = None
|
||||||
|
if has_next and rows:
|
||||||
|
last = rows[-1]
|
||||||
|
ts = last["timestamp"]
|
||||||
|
ts_str = ts.isoformat() if hasattr(ts, "isoformat") else str(ts)
|
||||||
|
next_cursor = f"{ts_str}|{last['id']}"
|
||||||
|
|
||||||
|
return PaginatedAnalysisResponse(items=items, next_cursor=next_cursor)
|
||||||
|
|
||||||
|
|
||||||
@app.get(
|
@app.get(
|
||||||
"/analyze/{company_name}",
|
"/analyze/{company_name}",
|
||||||
response_model=CompanyAnalysisResponse,
|
response_model=CompanyAnalysisResponse,
|
||||||
tags=["Analysis"],
|
tags=["Analysis"],
|
||||||
)
|
)
|
||||||
async def analyze_company(
|
async def analyze_company(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
model: str | None = Query(default=None, description="LLM model to use (e.g. 'openai/gpt-4o'). Defaults to server config."),
|
model: str | None = Query(default=None, description="LLM model to use (e.g. 'openai/gpt-4o'). Defaults to server config."),
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
@@ -846,7 +985,7 @@ async def analyze_company(
|
|||||||
)
|
)
|
||||||
async def analyze_single_patent(
|
async def analyze_single_patent(
|
||||||
patent_id: str,
|
patent_id: str,
|
||||||
company_name: str = Query(description="Company name for analysis context"),
|
company_name: Annotated[str, Query(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$", description="Company name for analysis context")],
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Analyze a single patent by its publication ID.
|
"""Analyze a single patent by its publication ID.
|
||||||
@@ -1047,7 +1186,7 @@ async def list_jobs(
|
|||||||
str | None,
|
str | None,
|
||||||
Query(description="Filter by status: pending, running, completed, failed"),
|
Query(description="Filter by status: pending, running, completed, failed"),
|
||||||
] = None,
|
] = None,
|
||||||
limit: Annotated[int, Query(ge=1, le=100)] = 10,
|
limit: Annotated[int, Query(ge=1, le=200)] = 50,
|
||||||
cursor: Annotated[
|
cursor: Annotated[
|
||||||
str | None,
|
str | None,
|
||||||
Query(description="Opaque cursor from a previous response's next_cursor field"),
|
Query(description="Opaque cursor from a previous response's next_cursor field"),
|
||||||
|
|||||||
@@ -371,6 +371,48 @@ class DatabaseClient:
|
|||||||
cursor.execute(query, params)
|
cursor.execute(query, params)
|
||||||
return [dict(row) for row in cursor.fetchall()]
|
return [dict(row) for row in cursor.fetchall()]
|
||||||
|
|
||||||
|
def list_analyses(
|
||||||
|
self,
|
||||||
|
company_name: Optional[str] = None,
|
||||||
|
limit: int = 50,
|
||||||
|
cursor: Optional[str] = None,
|
||||||
|
) -> List[Dict]:
|
||||||
|
"""List analysis results with cursor-based pagination.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
company_name: Optional filter by company name.
|
||||||
|
limit: Maximum number of records to return.
|
||||||
|
cursor: Opaque cursor (``timestamp|id``) from a previous response.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of analysis dicts ordered by timestamp descending.
|
||||||
|
"""
|
||||||
|
conditions: list[str] = ["is_cached = FALSE"]
|
||||||
|
params: list = []
|
||||||
|
|
||||||
|
if company_name:
|
||||||
|
conditions.append("LOWER(company_name) = LOWER(%s)")
|
||||||
|
params.append(company_name)
|
||||||
|
|
||||||
|
if cursor:
|
||||||
|
try:
|
||||||
|
ts_str, cursor_id = cursor.rsplit("|", 1)
|
||||||
|
conditions.append("(timestamp, id) < (%s, %s)")
|
||||||
|
params.extend([ts_str, int(cursor_id)])
|
||||||
|
except (ValueError, TypeError):
|
||||||
|
pass # Ignore malformed cursors; return from start
|
||||||
|
|
||||||
|
query = "SELECT id, company_name, analysis_type, model, response, timestamp FROM llm_messages"
|
||||||
|
if conditions:
|
||||||
|
query += " WHERE " + " AND ".join(conditions)
|
||||||
|
query += " ORDER BY timestamp DESC, id DESC LIMIT %s"
|
||||||
|
params.append(limit)
|
||||||
|
|
||||||
|
with self.get_conn() as conn:
|
||||||
|
with conn.cursor(cursor_factory=RealDictCursor) as cur:
|
||||||
|
cur.execute(query, params)
|
||||||
|
return [dict(row) for row in cur.fetchall()]
|
||||||
|
|
||||||
def get_analytics(self, days: int = 30) -> Dict:
|
def get_analytics(self, days: int = 30) -> Dict:
|
||||||
"""Get analytics on message usage.
|
"""Get analytics on message usage.
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import axios, { AxiosError, InternalAxiosRequestConfig } from 'axios';
|
import axios, { AxiosError, InternalAxiosRequestConfig } from 'axios';
|
||||||
import type { TokenResponse, User, CompanyAnalysis, BatchAnalysisResult, JobStatus, Analytics } from '../types';
|
import type { TokenResponse, User, CompanyAnalysis, BatchAnalysisResult, JobStatus, Analytics, PaginatedJobsResponse, PaginatedAnalysisResponse } from '../types';
|
||||||
|
|
||||||
const API_BASE_URL = import.meta.env.VITE_API_URL || '/api';
|
const API_BASE_URL = import.meta.env.VITE_API_URL || '/api';
|
||||||
|
|
||||||
@@ -141,15 +141,60 @@ export const analysisApi = {
|
|||||||
return response.data;
|
return response.data;
|
||||||
},
|
},
|
||||||
|
|
||||||
listJobs: async (status?: string, limit = 10): Promise<JobStatus[]> => {
|
listJobs: async (status?: string, limit = 50, cursor?: string): Promise<PaginatedJobsResponse> => {
|
||||||
const params = new URLSearchParams();
|
const params = new URLSearchParams();
|
||||||
if (status) params.append('status', status);
|
if (status) params.append('status', status);
|
||||||
params.append('limit', limit.toString());
|
params.append('limit', limit.toString());
|
||||||
const response = await api.get<JobStatus[]>(`/jobs?${params}`);
|
if (cursor) params.append('cursor', cursor);
|
||||||
|
const response = await api.get<PaginatedJobsResponse>(`/jobs?${params}`);
|
||||||
|
return response.data;
|
||||||
|
},
|
||||||
|
|
||||||
|
listBatchAnalyses: async (companyName?: string, limit = 50, cursor?: string): Promise<PaginatedAnalysisResponse> => {
|
||||||
|
const params = new URLSearchParams();
|
||||||
|
if (companyName) params.append('company_name', companyName);
|
||||||
|
params.append('limit', limit.toString());
|
||||||
|
if (cursor) params.append('cursor', cursor);
|
||||||
|
const response = await api.get<PaginatedAnalysisResponse>(`/analyze/batch?${params}`);
|
||||||
|
return response.data;
|
||||||
|
},
|
||||||
|
|
||||||
|
getCompanyHistory: async (companyName: string, limit = 20): Promise<AnalysisHistoryItem[]> => {
|
||||||
|
const response = await api.get<AnalysisHistoryItem[]>(
|
||||||
|
`/analyze/${encodeURIComponent(companyName)}/history?limit=${limit}`
|
||||||
|
);
|
||||||
|
return response.data;
|
||||||
|
},
|
||||||
|
|
||||||
|
diffAnalyses: async (companyName: string, fromId: number, toId: number): Promise<AnalysisDiff> => {
|
||||||
|
const response = await api.get<AnalysisDiff>(
|
||||||
|
`/analyze/${encodeURIComponent(companyName)}/diff?from=${fromId}&to=${toId}`
|
||||||
|
);
|
||||||
return response.data;
|
return response.data;
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Analysis diff types
|
||||||
|
export interface AnalysisHistoryItem {
|
||||||
|
id: number;
|
||||||
|
analysis_type: string | null;
|
||||||
|
model: string | null;
|
||||||
|
timestamp: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AnalysisDiff {
|
||||||
|
company_name: string;
|
||||||
|
from_id: number;
|
||||||
|
to_id: number;
|
||||||
|
from_timestamp: string;
|
||||||
|
to_timestamp: string;
|
||||||
|
patent_count_delta: number;
|
||||||
|
added_patents: string[];
|
||||||
|
removed_patents: string[];
|
||||||
|
changed_fields: Record<string, { from: string | null; to: string | null }>;
|
||||||
|
summary: string;
|
||||||
|
}
|
||||||
|
|
||||||
// Export API
|
// Export API
|
||||||
export const exportApi = {
|
export const exportApi = {
|
||||||
exportCsv: async (companyName: string): Promise<void> => {
|
exportCsv: async (companyName: string): Promise<void> => {
|
||||||
@@ -201,6 +246,32 @@ export const analyticsApi = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Rate limit types
|
||||||
|
export interface RateLimitIpEntry {
|
||||||
|
ip: string;
|
||||||
|
total: number;
|
||||||
|
rejected: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RateLimitEndpointStats {
|
||||||
|
endpoint: string;
|
||||||
|
limit: string;
|
||||||
|
total_requests: number;
|
||||||
|
rejected_requests: number;
|
||||||
|
by_ip: RateLimitIpEntry[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ThrottledBucket {
|
||||||
|
timestamp: string;
|
||||||
|
count: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RateLimitStatsResponse {
|
||||||
|
rate_limits: RateLimitEndpointStats[];
|
||||||
|
throttled_24h: number;
|
||||||
|
throttled_over_time: ThrottledBucket[];
|
||||||
|
}
|
||||||
|
|
||||||
// Admin API
|
// Admin API
|
||||||
export const adminApi = {
|
export const adminApi = {
|
||||||
listUsers: async (limit = 100, offset = 0): Promise<User[]> => {
|
listUsers: async (limit = 100, offset = 0): Promise<User[]> => {
|
||||||
@@ -216,6 +287,11 @@ export const adminApi = {
|
|||||||
deleteUser: async (userId: number): Promise<void> => {
|
deleteUser: async (userId: number): Promise<void> => {
|
||||||
await api.delete(`/admin/users/${userId}`);
|
await api.delete(`/admin/users/${userId}`);
|
||||||
},
|
},
|
||||||
|
|
||||||
|
getRateLimits: async (): Promise<RateLimitStatsResponse> => {
|
||||||
|
const response = await api.get<RateLimitStatsResponse>('/admin/rate-limits');
|
||||||
|
return response.data;
|
||||||
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export default api;
|
export default api;
|
||||||
|
|||||||
Vendored
+96
-5
@@ -222,7 +222,17 @@ export interface paths {
|
|||||||
path?: never;
|
path?: never;
|
||||||
cookie?: never;
|
cookie?: never;
|
||||||
};
|
};
|
||||||
get?: never;
|
/**
|
||||||
|
* List Batch Analyses
|
||||||
|
* @description List stored analysis results with cursor-based pagination.
|
||||||
|
*
|
||||||
|
* Returns past analysis results ordered by timestamp descending. Use
|
||||||
|
* ``limit`` to control page size (default 50, max 200). The response
|
||||||
|
* includes a ``next_cursor`` field; pass it back as the ``cursor`` query
|
||||||
|
* parameter to fetch the next page. When ``next_cursor`` is ``null``,
|
||||||
|
* there are no more results.
|
||||||
|
*/
|
||||||
|
get: operations["list_batch_analyses_analyze_batch_get"];
|
||||||
put?: never;
|
put?: never;
|
||||||
/**
|
/**
|
||||||
* Analyze Companies Batch
|
* Analyze Companies Batch
|
||||||
@@ -308,14 +318,15 @@ export interface paths {
|
|||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
* List Jobs
|
* List Jobs
|
||||||
* @description List all analysis jobs.
|
* @description List analysis jobs with cursor-based pagination.
|
||||||
*
|
*
|
||||||
* Args:
|
* Args:
|
||||||
* status: Optional filter by job status
|
* status: Optional filter by job status
|
||||||
* limit: Maximum number of jobs to return (default 10, max 100)
|
* limit: Maximum number of jobs to return (default 50, max 200)
|
||||||
|
* cursor: Opaque cursor from a previous response's next_cursor field
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
* List of job statuses
|
* Paginated list of job statuses with next_cursor for subsequent pages
|
||||||
*/
|
*/
|
||||||
get: operations["list_jobs_jobs_get"];
|
get: operations["list_jobs_jobs_get"];
|
||||||
put?: never;
|
put?: never;
|
||||||
@@ -330,6 +341,27 @@ export interface paths {
|
|||||||
export type webhooks = Record<string, never>;
|
export type webhooks = Record<string, never>;
|
||||||
export interface components {
|
export interface components {
|
||||||
schemas: {
|
schemas: {
|
||||||
|
/**
|
||||||
|
* AnalysisRecord
|
||||||
|
* @description A single stored analysis result.
|
||||||
|
*/
|
||||||
|
AnalysisRecord: {
|
||||||
|
/** Id */
|
||||||
|
id: number;
|
||||||
|
/** Company Name */
|
||||||
|
company_name?: string | null;
|
||||||
|
/** Analysis Type */
|
||||||
|
analysis_type?: string | null;
|
||||||
|
/** Model */
|
||||||
|
model?: string | null;
|
||||||
|
/** Response */
|
||||||
|
response?: string | null;
|
||||||
|
/**
|
||||||
|
* Timestamp
|
||||||
|
* Format: date-time
|
||||||
|
*/
|
||||||
|
timestamp?: string | null;
|
||||||
|
};
|
||||||
/**
|
/**
|
||||||
* AnalyticsResponse
|
* AnalyticsResponse
|
||||||
* @description Analytics response model.
|
* @description Analytics response model.
|
||||||
@@ -425,6 +457,26 @@ export interface components {
|
|||||||
*/
|
*/
|
||||||
timestamp: string;
|
timestamp: string;
|
||||||
};
|
};
|
||||||
|
/**
|
||||||
|
* PaginatedAnalysisResponse
|
||||||
|
* @description Paginated response for analysis result listings.
|
||||||
|
*/
|
||||||
|
PaginatedAnalysisResponse: {
|
||||||
|
/** Items */
|
||||||
|
items: components["schemas"]["AnalysisRecord"][];
|
||||||
|
/** Next Cursor */
|
||||||
|
next_cursor?: string | null;
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* PaginatedJobsResponse
|
||||||
|
* @description Paginated response for job listings.
|
||||||
|
*/
|
||||||
|
PaginatedJobsResponse: {
|
||||||
|
/** Items */
|
||||||
|
items: components["schemas"]["JobStatus"][];
|
||||||
|
/** Next Cursor */
|
||||||
|
next_cursor?: string | null;
|
||||||
|
};
|
||||||
/**
|
/**
|
||||||
* JobStatus
|
* JobStatus
|
||||||
* @description Status of a background analysis job.
|
* @description Status of a background analysis job.
|
||||||
@@ -944,7 +996,10 @@ export interface operations {
|
|||||||
query?: {
|
query?: {
|
||||||
/** @description Filter by status: pending, running, completed, failed */
|
/** @description Filter by status: pending, running, completed, failed */
|
||||||
status?: string | null;
|
status?: string | null;
|
||||||
|
/** @description Maximum number of jobs to return (default 50, max 200) */
|
||||||
limit?: number;
|
limit?: number;
|
||||||
|
/** @description Opaque cursor from a previous response's next_cursor field */
|
||||||
|
cursor?: string | null;
|
||||||
};
|
};
|
||||||
header?: never;
|
header?: never;
|
||||||
path?: never;
|
path?: never;
|
||||||
@@ -958,7 +1013,43 @@ export interface operations {
|
|||||||
[name: string]: unknown;
|
[name: string]: unknown;
|
||||||
};
|
};
|
||||||
content: {
|
content: {
|
||||||
"application/json": components["schemas"]["JobStatus"][];
|
"application/json": components["schemas"]["PaginatedJobsResponse"];
|
||||||
|
};
|
||||||
|
};
|
||||||
|
/** @description Validation Error */
|
||||||
|
422: {
|
||||||
|
headers: {
|
||||||
|
[name: string]: unknown;
|
||||||
|
};
|
||||||
|
content: {
|
||||||
|
"application/json": components["schemas"]["HTTPValidationError"];
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
list_batch_analyses_analyze_batch_get: {
|
||||||
|
parameters: {
|
||||||
|
query?: {
|
||||||
|
/** @description Filter results by company name */
|
||||||
|
company_name?: string | null;
|
||||||
|
/** @description Maximum number of results to return (default 50, max 200) */
|
||||||
|
limit?: number;
|
||||||
|
/** @description Opaque cursor from a previous response's next_cursor field */
|
||||||
|
cursor?: string | null;
|
||||||
|
};
|
||||||
|
header?: never;
|
||||||
|
path?: never;
|
||||||
|
cookie?: never;
|
||||||
|
};
|
||||||
|
requestBody?: never;
|
||||||
|
responses: {
|
||||||
|
/** @description Successful Response */
|
||||||
|
200: {
|
||||||
|
headers: {
|
||||||
|
[name: string]: unknown;
|
||||||
|
};
|
||||||
|
content: {
|
||||||
|
"application/json": components["schemas"]["PaginatedAnalysisResponse"];
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
/** @description Validation Error */
|
/** @description Validation Error */
|
||||||
|
|||||||
@@ -30,3 +30,8 @@ export type HealthResponse = components['schemas']['HealthResponse'];
|
|||||||
export type BatchAnalysisRequest = components['schemas']['BatchAnalysisRequest'];
|
export type BatchAnalysisRequest = components['schemas']['BatchAnalysisRequest'];
|
||||||
export type ValidationError = components['schemas']['ValidationError'];
|
export type ValidationError = components['schemas']['ValidationError'];
|
||||||
export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
||||||
|
|
||||||
|
// Pagination types
|
||||||
|
export type AnalysisRecord = components['schemas']['AnalysisRecord'];
|
||||||
|
export type PaginatedAnalysisResponse = components['schemas']['PaginatedAnalysisResponse'];
|
||||||
|
export type PaginatedJobsResponse = components['schemas']['PaginatedJobsResponse'];
|
||||||
|
|||||||
@@ -0,0 +1,157 @@
|
|||||||
|
"""Tests for company name input validation on analysis endpoints."""
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
from unittest.mock import Mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
from SPARC.api import app
|
||||||
|
from SPARC.types import CompanyAnalysisResult
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def client():
|
||||||
|
"""Create test client."""
|
||||||
|
return TestClient(app)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_analyzer(mocker):
|
||||||
|
"""Mock the global analyzer so valid requests succeed."""
|
||||||
|
mock = Mock()
|
||||||
|
mock._analyze_company_safe.return_value = CompanyAnalysisResult(
|
||||||
|
company_name="nvidia",
|
||||||
|
analysis="Test analysis",
|
||||||
|
patent_count=1,
|
||||||
|
success=True,
|
||||||
|
timestamp=datetime.now(),
|
||||||
|
)
|
||||||
|
mocker.patch("SPARC.api._analyzer", mock)
|
||||||
|
return mock
|
||||||
|
|
||||||
|
|
||||||
|
class TestCompanyNameValidation:
|
||||||
|
"""Test that company names are validated on analysis endpoints."""
|
||||||
|
|
||||||
|
# --- Too short ---
|
||||||
|
|
||||||
|
def test_single_char_rejected(self, client, mock_analyzer):
|
||||||
|
"""A one-character company name should be rejected."""
|
||||||
|
response = client.get("/analyze/X")
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
# --- Too long ---
|
||||||
|
|
||||||
|
def test_over_100_chars_rejected(self, client, mock_analyzer):
|
||||||
|
"""A company name longer than 100 characters should be rejected."""
|
||||||
|
long_name = "A" * 101
|
||||||
|
response = client.get(f"/analyze/{long_name}")
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
# --- Special characters ---
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"bad_name",
|
||||||
|
[
|
||||||
|
"nvidia!",
|
||||||
|
"intel@corp",
|
||||||
|
"test#company",
|
||||||
|
"foo$bar",
|
||||||
|
"a%b",
|
||||||
|
"x^y",
|
||||||
|
"semi;colon",
|
||||||
|
"drop'table",
|
||||||
|
'say"hello',
|
||||||
|
"path/traversal",
|
||||||
|
"back\\slash",
|
||||||
|
"pipe|char",
|
||||||
|
"star*glob",
|
||||||
|
"question?mark",
|
||||||
|
"<script>",
|
||||||
|
"curly{brace}",
|
||||||
|
"equal=sign",
|
||||||
|
"plus+plus",
|
||||||
|
"comma,separated",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_special_chars_rejected(self, client, mock_analyzer, bad_name):
|
||||||
|
"""Company names with disallowed special characters should be rejected."""
|
||||||
|
response = client.get(f"/analyze/{bad_name}")
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
# --- Valid names ---
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"valid_name",
|
||||||
|
[
|
||||||
|
"nvidia",
|
||||||
|
"Intel",
|
||||||
|
"TSMC",
|
||||||
|
"Texas Instruments",
|
||||||
|
"Johnson-Johnson",
|
||||||
|
"AT&T",
|
||||||
|
"St. Jude Medical",
|
||||||
|
"3M",
|
||||||
|
"21st Century Fox",
|
||||||
|
"ab", # minimum length
|
||||||
|
"A" * 100, # maximum length
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_valid_names_accepted(self, client, mock_analyzer, valid_name):
|
||||||
|
"""Valid company names should be accepted (200, not 422)."""
|
||||||
|
response = client.get(f"/analyze/{valid_name}")
|
||||||
|
# Should not be a validation error; 200 or other non-422 status is fine
|
||||||
|
assert response.status_code != 422
|
||||||
|
|
||||||
|
# --- Batch endpoint validation ---
|
||||||
|
|
||||||
|
def test_batch_too_short_rejected(self, client, mock_analyzer):
|
||||||
|
"""Batch endpoint should reject company names that are too short."""
|
||||||
|
response = client.post(
|
||||||
|
"/analyze/batch",
|
||||||
|
json={"companies": ["X"]},
|
||||||
|
)
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_batch_too_long_rejected(self, client, mock_analyzer):
|
||||||
|
"""Batch endpoint should reject company names that are too long."""
|
||||||
|
response = client.post(
|
||||||
|
"/analyze/batch",
|
||||||
|
json={"companies": ["A" * 101]},
|
||||||
|
)
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_batch_special_chars_rejected(self, client, mock_analyzer):
|
||||||
|
"""Batch endpoint should reject company names with special chars."""
|
||||||
|
response = client.post(
|
||||||
|
"/analyze/batch",
|
||||||
|
json={"companies": ["nvidia!", "intel"]},
|
||||||
|
)
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_batch_valid_names_accepted(self, client, mock_analyzer):
|
||||||
|
"""Batch endpoint should accept valid company names."""
|
||||||
|
response = client.post(
|
||||||
|
"/analyze/batch",
|
||||||
|
json={"companies": ["nvidia", "Intel", "AT&T"]},
|
||||||
|
)
|
||||||
|
assert response.status_code != 422
|
||||||
|
|
||||||
|
# --- Name must start with alphanumeric ---
|
||||||
|
|
||||||
|
def test_leading_space_rejected(self, client, mock_analyzer):
|
||||||
|
"""Company name starting with a space should be rejected."""
|
||||||
|
response = client.post(
|
||||||
|
"/analyze/batch",
|
||||||
|
json={"companies": [" nvidia"]},
|
||||||
|
)
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_leading_hyphen_rejected(self, client, mock_analyzer):
|
||||||
|
"""Company name starting with a hyphen should be rejected."""
|
||||||
|
response = client.post(
|
||||||
|
"/analyze/batch",
|
||||||
|
json={"companies": ["-nvidia"]},
|
||||||
|
)
|
||||||
|
assert response.status_code == 422
|
||||||
@@ -0,0 +1,321 @@
|
|||||||
|
"""Tests for cursor-based pagination on /analyze/batch GET and /jobs endpoints."""
|
||||||
|
|
||||||
|
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
|
||||||
|
def client():
|
||||||
|
"""Create test 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)
|
||||||
|
return {
|
||||||
|
"id": id_,
|
||||||
|
"company_name": company,
|
||||||
|
"analysis_type": "patent_portfolio",
|
||||||
|
"model": "openai/gpt-4o",
|
||||||
|
"response": f"Analysis for {company}",
|
||||||
|
"timestamp": ts,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _make_job_row(job_id: str, minutes_ago: int = 0, status: str = "completed"):
|
||||||
|
"""Create a fake job row dict."""
|
||||||
|
ts = datetime.now() - timedelta(minutes=minutes_ago)
|
||||||
|
return {
|
||||||
|
"job_id": job_id,
|
||||||
|
"status": status,
|
||||||
|
"progress": 100 if status == "completed" else 0,
|
||||||
|
"total_companies": 1,
|
||||||
|
"completed_companies": 1 if status == "completed" else 0,
|
||||||
|
"result": None,
|
||||||
|
"error": None,
|
||||||
|
"created_at": ts,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class TestAnalyzeBatchGetPagination:
|
||||||
|
"""Test cursor-based pagination on GET /analyze/batch."""
|
||||||
|
|
||||||
|
@patch("SPARC.api._get_job_db")
|
||||||
|
def test_returns_items_and_no_cursor_when_less_than_limit(self, mock_get_db, client):
|
||||||
|
"""When fewer results than limit, next_cursor should be null."""
|
||||||
|
db = Mock()
|
||||||
|
db.list_analyses.return_value = [
|
||||||
|
_make_analysis_row(1, minutes_ago=10),
|
||||||
|
_make_analysis_row(2, minutes_ago=20),
|
||||||
|
]
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
response = client.get("/analyze/batch?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_returns_cursor_when_more_results_exist(self, mock_get_db, client):
|
||||||
|
"""When more results exist than limit, next_cursor should be set."""
|
||||||
|
db = Mock()
|
||||||
|
# Return limit+1 rows to simulate more data
|
||||||
|
rows = [_make_analysis_row(i, minutes_ago=i) for i in range(4)]
|
||||||
|
db.list_analyses.return_value = rows
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
response = client.get("/analyze/batch?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_cursor_passed_to_db(self, mock_get_db, client):
|
||||||
|
"""The cursor query param should be forwarded to the database layer."""
|
||||||
|
db = Mock()
|
||||||
|
db.list_analyses.return_value = []
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
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
|
||||||
|
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):
|
||||||
|
"""Default limit should be 50."""
|
||||||
|
db = Mock()
|
||||||
|
db.list_analyses.return_value = []
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
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", 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", headers=_auth_header())
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
@patch("SPARC.api._get_job_db")
|
||||||
|
def test_company_name_filter(self, mock_get_db, client):
|
||||||
|
"""The company_name filter should be forwarded to the database."""
|
||||||
|
db = Mock()
|
||||||
|
db.list_analyses.return_value = []
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
client.get("/analyze/batch?company_name=intel", headers=_auth_header())
|
||||||
|
call_kwargs = db.list_analyses.call_args
|
||||||
|
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):
|
||||||
|
"""Empty result set returns empty items and null cursor."""
|
||||||
|
db = Mock()
|
||||||
|
db.list_analyses.return_value = []
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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):
|
||||||
|
"""Default limit should now be 50."""
|
||||||
|
db = Mock()
|
||||||
|
db.list_jobs.return_value = []
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
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", 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")
|
||||||
|
def test_limit_200_accepted(self, mock_get_db, client):
|
||||||
|
"""Limit of exactly 200 should be accepted."""
|
||||||
|
db = Mock()
|
||||||
|
db.list_jobs.return_value = []
|
||||||
|
mock_get_db.return_value = db
|
||||||
|
|
||||||
|
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
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
"""Tests for the /admin/rate-limits endpoint."""
|
||||||
|
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
from SPARC import api
|
||||||
|
from SPARC.api import app
|
||||||
|
from SPARC.auth import UserResponse
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def client():
|
||||||
|
"""Create test client."""
|
||||||
|
return TestClient(app)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def reset_stats():
|
||||||
|
"""Reset rate limit stats between tests."""
|
||||||
|
api._rate_limit_stats.clear()
|
||||||
|
yield
|
||||||
|
api._rate_limit_stats.clear()
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_admin():
|
||||||
|
"""Return a mock admin user."""
|
||||||
|
return UserResponse(id=1, email="admin@test.com", role="admin", created_at="2025-01-01T00:00:00")
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_user():
|
||||||
|
"""Return a mock non-admin user."""
|
||||||
|
return UserResponse(id=2, email="user@test.com", role="user", created_at="2025-01-01T00:00:00")
|
||||||
|
|
||||||
|
|
||||||
|
class TestRateLimitAdminEndpoint:
|
||||||
|
"""Test GET /admin/rate-limits."""
|
||||||
|
|
||||||
|
def test_admin_can_access(self, client):
|
||||||
|
"""Admin users should be able to access the rate-limits endpoint."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "rate_limits" in data
|
||||||
|
assert isinstance(data["rate_limits"], list)
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_non_admin_rejected(self, client):
|
||||||
|
"""Non-admin users should get 403."""
|
||||||
|
# Without overriding the dependency, it should fail auth
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
assert response.status_code in (401, 403)
|
||||||
|
|
||||||
|
def test_returns_configured_endpoints(self, client):
|
||||||
|
"""Should list all rate-limited endpoints."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
endpoints = [rl["endpoint"] for rl in data["rate_limits"]]
|
||||||
|
assert "/auth/register" in endpoints
|
||||||
|
assert "/auth/login" in endpoints
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_empty_state_shows_zero_counts(self, client):
|
||||||
|
"""When no requests have been made, counts should be zero."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
data = response.json()
|
||||||
|
for rl in data["rate_limits"]:
|
||||||
|
assert rl["total_requests"] == 0
|
||||||
|
assert rl["rejected_requests"] == 0
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_tracks_requests(self, client):
|
||||||
|
"""After making requests, the stats should reflect them."""
|
||||||
|
api._track_rate_limit_request("/auth/login", "127.0.0.1")
|
||||||
|
api._track_rate_limit_request("/auth/login", "127.0.0.1")
|
||||||
|
api._track_rate_limit_request("/auth/login", "192.168.1.1", rejected=True)
|
||||||
|
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
data = response.json()
|
||||||
|
login_stats = next(rl for rl in data["rate_limits"] if rl["endpoint"] == "/auth/login")
|
||||||
|
assert login_stats["total_requests"] == 3
|
||||||
|
assert login_stats["rejected_requests"] == 1
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_includes_limit_config(self, client):
|
||||||
|
"""Each endpoint entry should include the rate limit config string."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
data = response.json()
|
||||||
|
for rl in data["rate_limits"]:
|
||||||
|
assert "limit" in rl
|
||||||
|
assert isinstance(rl["limit"], str)
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
Reference in New Issue
Block a user