forked from 0xWheatyz/SPARC
Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3dfa651f2d | |||
| 313800215c | |||
| 222f29deb1 | |||
| e6d95bbf57 | |||
| 68484ef4b1 | |||
| a0cb9a5773 | |||
| 857b3444df | |||
| a95129904e | |||
| 7c6eed8d72 | |||
| 4c411e1e0b | |||
| 6165d66760 | |||
| e610dea9a9 | |||
| b5f10d2032 | |||
| b5d8b0b344 | |||
| 1170356b2b | |||
| 84341b3ec4 | |||
| 0639fb3649 | |||
| b032bf0c90 | |||
| a2f81b0396 | |||
| 63ca18e9bf | |||
| 417b7ab31e | |||
| 2eabb1d704 | |||
| fc942b2aa4 | |||
| 44a162056d |
+30
-37
@@ -81,57 +81,50 @@ Items that have been implemented and merged into main.
|
||||
- ~~OpenAPI client generation.~~ TypeScript API client auto-generated from
|
||||
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
|
||||
|
||||
These items address correctness, reliability, and coverage gaps that should be
|
||||
resolved before broader production use.
|
||||
|
||||
### 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)*
|
||||
No outstanding P1 items. All previously listed items have been completed and
|
||||
moved to the Completed section above.
|
||||
|
||||
---
|
||||
|
||||
## P2 -- Medium Priority
|
||||
|
||||
Improvements to reliability, test coverage, and code quality.
|
||||
|
||||
### 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)*
|
||||
Improvements to the API surface.
|
||||
|
||||
### API improvements
|
||||
|
||||
- **API pagination.** The `/analyze/batch` and `/jobs` endpoints could benefit
|
||||
from cursor-based pagination for large result sets.
|
||||
- **API pagination.** The `/analyze/batch` endpoint needs cursor-based
|
||||
pagination for large result sets. The `/jobs` endpoint already has cursor
|
||||
pagination. *(Issue #1669)*
|
||||
- **Request validation improvements.** Add stricter input validation for
|
||||
company names (disallow special characters, enforce length limits).
|
||||
*(Issue #1670)*
|
||||
|
||||
---
|
||||
|
||||
|
||||
+192
-11
@@ -5,17 +5,18 @@ Provides REST API endpoints for analyzing company patent portfolios.
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections import deque
|
||||
from contextlib import asynccontextmanager
|
||||
from datetime import datetime
|
||||
from datetime import datetime, timedelta, timezone
|
||||
from typing import TYPE_CHECKING, Annotated, List
|
||||
|
||||
if TYPE_CHECKING:
|
||||
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.responses import JSONResponse, StreamingResponse
|
||||
from pydantic import BaseModel, EmailStr, Field
|
||||
from pydantic import BaseModel, EmailStr, Field, StringConstraints
|
||||
from slowapi import Limiter
|
||||
from slowapi.errors import RateLimitExceeded
|
||||
from slowapi.util import get_remote_address
|
||||
@@ -36,6 +37,16 @@ from SPARC.auth import (
|
||||
)
|
||||
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
|
||||
class CompanyAnalysisResponse(BaseModel):
|
||||
@@ -72,7 +83,7 @@ class CompanyAnalysisRequest(BaseModel):
|
||||
class BatchAnalysisRequest(BaseModel):
|
||||
"""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"
|
||||
)
|
||||
max_workers: int = Field(
|
||||
@@ -96,6 +107,24 @@ class JobStatus(BaseModel):
|
||||
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):
|
||||
"""Paginated response for job listings."""
|
||||
|
||||
@@ -217,10 +246,45 @@ app = FastAPI(
|
||||
limiter = Limiter(key_func=get_remote_address)
|
||||
app.state.limiter = limiter
|
||||
|
||||
# In-memory rate limit statistics
|
||||
_rate_limit_stats: dict[str, dict] = {}
|
||||
|
||||
# Time-series log of rejected requests (capped to last 24 h worth of entries).
|
||||
_rejected_log: deque[dict] = deque(maxlen=100_000)
|
||||
|
||||
|
||||
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
|
||||
_rejected_log.append({
|
||||
"endpoint": endpoint,
|
||||
"ip": ip,
|
||||
"timestamp": datetime.now(timezone.utc).isoformat(),
|
||||
})
|
||||
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)
|
||||
async def rate_limit_handler(request: Request, exc: RateLimitExceeded):
|
||||
"""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)
|
||||
return JSONResponse(
|
||||
status_code=429,
|
||||
@@ -249,6 +313,7 @@ async def register(request: Request, body: RegisterRequest):
|
||||
|
||||
The first registered user automatically becomes an admin.
|
||||
"""
|
||||
_track_rate_limit_request("/auth/register", get_remote_address(request))
|
||||
db = get_db_client()
|
||||
|
||||
# First user becomes admin
|
||||
@@ -279,6 +344,7 @@ async def register(request: Request, body: RegisterRequest):
|
||||
@limiter.limit("10/minute")
|
||||
async def login(request: Request, body: LoginRequest):
|
||||
"""Authenticate user and return JWT tokens."""
|
||||
_track_rate_limit_request("/auth/login", get_remote_address(request))
|
||||
db = get_db_client()
|
||||
|
||||
user = db.authenticate_user(body.email, body.password)
|
||||
@@ -405,7 +471,7 @@ async def delete_user(
|
||||
class TrackCompanyRequest(BaseModel):
|
||||
"""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"])
|
||||
@@ -432,7 +498,7 @@ async def add_tracked_company(
|
||||
|
||||
@app.delete("/admin/tracked/{company_name}", tags=["Admin"])
|
||||
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),
|
||||
):
|
||||
"""Remove a company from the tracked list (admin only)."""
|
||||
@@ -443,6 +509,69 @@ async def remove_tracked_company(
|
||||
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, including per-IP breakdown and
|
||||
a time-series of throttled (rejected) requests in the last 24 hours.
|
||||
|
||||
Returns:
|
||||
Rate limit stats per endpoint, per-IP breakdown, and throttled
|
||||
request history bucketed by hour.
|
||||
"""
|
||||
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, {})
|
||||
by_ip_raw = stats.get("by_ip", {})
|
||||
by_ip = [
|
||||
{"ip": ip, "total": counts["total"], "rejected": counts["rejected"]}
|
||||
for ip, counts in by_ip_raw.items()
|
||||
]
|
||||
results.append({
|
||||
"endpoint": endpoint,
|
||||
"limit": conf["limit"],
|
||||
"total_requests": stats.get("total_requests", 0),
|
||||
"rejected_requests": stats.get("rejected_requests", 0),
|
||||
"by_ip": by_ip,
|
||||
})
|
||||
|
||||
# Build hourly buckets of throttled requests for the last 24 hours
|
||||
now = datetime.now(timezone.utc)
|
||||
cutoff = now - timedelta(hours=24)
|
||||
hourly_buckets: dict[str, int] = {}
|
||||
throttled_24h = 0
|
||||
for entry in _rejected_log:
|
||||
ts_str = entry["timestamp"]
|
||||
try:
|
||||
ts = datetime.fromisoformat(ts_str)
|
||||
except (ValueError, TypeError):
|
||||
continue
|
||||
if ts >= cutoff:
|
||||
throttled_24h += 1
|
||||
bucket = ts.strftime("%Y-%m-%dT%H:00:00Z")
|
||||
hourly_buckets[bucket] = hourly_buckets.get(bucket, 0) + 1
|
||||
|
||||
throttled_over_time = [
|
||||
{"timestamp": k, "count": v}
|
||||
for k, v in sorted(hourly_buckets.items())
|
||||
]
|
||||
|
||||
return {
|
||||
"rate_limits": results,
|
||||
"throttled_24h": throttled_24h,
|
||||
"throttled_over_time": throttled_over_time,
|
||||
}
|
||||
|
||||
|
||||
@app.get("/admin/alerts", tags=["Admin"])
|
||||
async def list_alerts(
|
||||
limit: int = Query(default=50, ge=1, le=200),
|
||||
@@ -590,7 +719,7 @@ async def get_analytics_trends(
|
||||
|
||||
@app.get("/export/{company_name}", tags=["Export"])
|
||||
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),
|
||||
):
|
||||
"""Export analysis results for a company as a CSV file.
|
||||
@@ -642,7 +771,7 @@ async def export_company_csv(
|
||||
|
||||
@app.get("/export/{company_name}/pdf", tags=["Export"])
|
||||
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),
|
||||
):
|
||||
"""Export analysis results for a company as a formatted PDF report.
|
||||
@@ -816,7 +945,7 @@ async def health_check():
|
||||
tags=["Analysis"],
|
||||
)
|
||||
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."),
|
||||
_: UserResponse = Depends(get_current_user),
|
||||
):
|
||||
@@ -846,7 +975,7 @@ async def analyze_company(
|
||||
)
|
||||
async def analyze_single_patent(
|
||||
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),
|
||||
):
|
||||
"""Analyze a single patent by its publication ID.
|
||||
@@ -872,6 +1001,58 @@ async def analyze_single_patent(
|
||||
raise HTTPException(status_code=404, detail=str(e))
|
||||
|
||||
|
||||
@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.post(
|
||||
"/analyze/batch",
|
||||
response_model=BatchAnalysisResponse,
|
||||
@@ -1047,7 +1228,7 @@ async def list_jobs(
|
||||
str | None,
|
||||
Query(description="Filter by status: pending, running, completed, failed"),
|
||||
] = None,
|
||||
limit: Annotated[int, Query(ge=1, le=100)] = 10,
|
||||
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"),
|
||||
|
||||
@@ -371,6 +371,48 @@ class DatabaseClient:
|
||||
cursor.execute(query, params)
|
||||
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:
|
||||
"""Get analytics on message usage.
|
||||
|
||||
|
||||
+12
-7
@@ -2,14 +2,17 @@
|
||||
|
||||
Uses APScheduler to periodically re-analyze tracked companies and
|
||||
detect significant changes in patent counts.
|
||||
|
||||
The scheduler reuses the application-level pooled DatabaseClient
|
||||
(from ``SPARC.auth``) instead of creating its own connection, which
|
||||
avoids exhausting the database connection pool under load.
|
||||
"""
|
||||
|
||||
import logging
|
||||
import os
|
||||
|
||||
from SPARC import config
|
||||
from SPARC.analyzer import CompanyAnalyzer
|
||||
from SPARC.database import DatabaseClient
|
||||
from SPARC.auth import get_db_client
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
@@ -21,10 +24,13 @@ CHANGE_THRESHOLD_PERCENT = int(os.getenv("CHANGE_THRESHOLD_PERCENT", "20"))
|
||||
|
||||
|
||||
def run_scheduled_analysis() -> None:
|
||||
"""Re-analyze all tracked companies and check for significant changes."""
|
||||
db = DatabaseClient(config.database_url)
|
||||
db.connect()
|
||||
db.initialize_schema()
|
||||
"""Re-analyze all tracked companies and check for significant changes.
|
||||
|
||||
Uses the shared pooled DatabaseClient from ``SPARC.auth.get_db_client()``
|
||||
rather than creating a disposable connection, so the scheduler participates
|
||||
in the same connection pool as the rest of the application.
|
||||
"""
|
||||
db = get_db_client()
|
||||
|
||||
tracked = db.list_tracked_companies()
|
||||
if not tracked:
|
||||
@@ -74,7 +80,6 @@ def run_scheduled_analysis() -> None:
|
||||
except Exception as e:
|
||||
logger.error("Error analyzing tracked company %s: %s", name, e)
|
||||
|
||||
db.close()
|
||||
logger.info("Scheduled analysis complete")
|
||||
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ import { Batch } from './pages/Batch';
|
||||
import { AnalyticsPage } from './pages/Analytics';
|
||||
import { About } from './pages/About';
|
||||
import { AdminUsers } from './pages/AdminUsers';
|
||||
import { AdminRateLimits } from './pages/AdminRateLimits';
|
||||
import { Compare } from './pages/Compare';
|
||||
|
||||
const queryClient = new QueryClient({
|
||||
@@ -56,6 +57,14 @@ function App() {
|
||||
</ProtectedRoute>
|
||||
}
|
||||
/>
|
||||
<Route
|
||||
path="/admin/rate-limits"
|
||||
element={
|
||||
<ProtectedRoute requireAdmin>
|
||||
<AdminRateLimits />
|
||||
</ProtectedRoute>
|
||||
}
|
||||
/>
|
||||
</Route>
|
||||
|
||||
{/* Default redirect */}
|
||||
|
||||
@@ -201,6 +201,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
|
||||
export const adminApi = {
|
||||
listUsers: async (limit = 100, offset = 0): Promise<User[]> => {
|
||||
@@ -216,6 +242,11 @@ export const adminApi = {
|
||||
deleteUser: async (userId: number): Promise<void> => {
|
||||
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;
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { Outlet, NavLink, useNavigate } from 'react-router-dom';
|
||||
import { useAuth } from '../context/AuthContext';
|
||||
import { useTheme } from '../context/ThemeContext';
|
||||
import { Search, Layers, BarChart3, Info, Users, LogOut, GitCompareArrows, Sun, Moon } from 'lucide-react';
|
||||
import { Search, Layers, BarChart3, Info, Users, LogOut, GitCompareArrows, Sun, Moon, ShieldAlert } from 'lucide-react';
|
||||
|
||||
export function Layout() {
|
||||
const { user, isAdmin, logout } = useAuth();
|
||||
@@ -23,6 +23,7 @@ export function Layout() {
|
||||
|
||||
if (isAdmin) {
|
||||
navItems.push({ to: '/admin/users', icon: Users, label: 'Users' });
|
||||
navItems.push({ to: '/admin/rate-limits', icon: ShieldAlert, label: 'Rate Limits' });
|
||||
}
|
||||
|
||||
return (
|
||||
|
||||
@@ -0,0 +1,240 @@
|
||||
import { useState } from 'react';
|
||||
import { useQuery } from '@tanstack/react-query';
|
||||
import { adminApi } from '../api/client';
|
||||
import type { RateLimitStatsResponse } from '../api/client';
|
||||
import { ShieldAlert, Activity, AlertCircle, RefreshCw, Clock } from 'lucide-react';
|
||||
|
||||
const REFRESH_OPTIONS = [
|
||||
{ label: '15s', value: 15_000 },
|
||||
{ label: '30s', value: 30_000 },
|
||||
{ label: '1m', value: 60_000 },
|
||||
{ label: 'Off', value: 0 },
|
||||
];
|
||||
|
||||
export function AdminRateLimits() {
|
||||
const [refreshInterval, setRefreshInterval] = useState(30_000);
|
||||
|
||||
const { data, isLoading, isError, dataUpdatedAt } = useQuery<RateLimitStatsResponse>({
|
||||
queryKey: ['admin-rate-limits'],
|
||||
queryFn: () => adminApi.getRateLimits(),
|
||||
refetchInterval: refreshInterval || false,
|
||||
});
|
||||
|
||||
if (isLoading) {
|
||||
return (
|
||||
<div className="flex items-center justify-center min-h-[400px]">
|
||||
<div className="animate-spin rounded-full h-12 w-12 border-t-2 border-b-2 border-primary"></div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
if (isError) {
|
||||
return (
|
||||
<div className="flex items-center gap-2 bg-error/10 border border-error/20 text-error rounded-xl px-4 py-3">
|
||||
<AlertCircle size={18} />
|
||||
<span>Failed to load rate limit statistics.</span>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
const maxThrottledCount = data?.throttled_over_time?.length
|
||||
? Math.max(...data.throttled_over_time.map((b) => b.count))
|
||||
: 0;
|
||||
|
||||
return (
|
||||
<div className="space-y-6">
|
||||
{/* Header */}
|
||||
<div className="flex items-center justify-between flex-wrap gap-4">
|
||||
<div>
|
||||
<h2 className="text-xl font-semibold text-text-primary border-b-2 border-primary/30 pb-2 mb-2">
|
||||
Rate Limiting Dashboard
|
||||
</h2>
|
||||
<p className="text-text-secondary">Monitor API rate limits and throttled requests.</p>
|
||||
</div>
|
||||
<div className="flex items-center gap-3">
|
||||
{/* Last updated */}
|
||||
{dataUpdatedAt > 0 && (
|
||||
<span className="text-xs text-text-secondary flex items-center gap-1">
|
||||
<Clock size={12} />
|
||||
Updated {new Date(dataUpdatedAt).toLocaleTimeString()}
|
||||
</span>
|
||||
)}
|
||||
{/* Refresh interval selector */}
|
||||
<div className="flex items-center gap-1 bg-bg-card/60 border border-primary/15 rounded-xl p-1">
|
||||
<RefreshCw size={14} className="text-text-secondary ml-2" />
|
||||
{REFRESH_OPTIONS.map((opt) => (
|
||||
<button
|
||||
key={opt.value}
|
||||
onClick={() => setRefreshInterval(opt.value)}
|
||||
className={`px-3 py-1 rounded-lg text-xs font-medium transition-all ${
|
||||
refreshInterval === opt.value
|
||||
? 'bg-primary text-white'
|
||||
: 'text-text-secondary hover:text-text-primary hover:bg-bg-card-hover'
|
||||
}`}
|
||||
>
|
||||
{opt.label}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Summary cards */}
|
||||
<div className="grid grid-cols-1 md:grid-cols-3 gap-4">
|
||||
<div className="bg-bg-card/60 border border-primary/15 rounded-2xl p-5">
|
||||
<div className="flex items-center gap-2 mb-2">
|
||||
<Activity size={18} className="text-primary" />
|
||||
<span className="text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Total Requests
|
||||
</span>
|
||||
</div>
|
||||
<div className="text-3xl font-bold text-text-primary">
|
||||
{data?.rate_limits.reduce((sum, rl) => sum + rl.total_requests, 0) ?? 0}
|
||||
</div>
|
||||
</div>
|
||||
<div className="bg-bg-card/60 border border-error/15 rounded-2xl p-5">
|
||||
<div className="flex items-center gap-2 mb-2">
|
||||
<ShieldAlert size={18} className="text-error" />
|
||||
<span className="text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Throttled (24h)
|
||||
</span>
|
||||
</div>
|
||||
<div className="text-3xl font-bold text-error">
|
||||
{data?.throttled_24h ?? 0}
|
||||
</div>
|
||||
</div>
|
||||
<div className="bg-bg-card/60 border border-secondary/15 rounded-2xl p-5">
|
||||
<div className="flex items-center gap-2 mb-2">
|
||||
<ShieldAlert size={18} className="text-secondary" />
|
||||
<span className="text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Rate-Limited Endpoints
|
||||
</span>
|
||||
</div>
|
||||
<div className="text-3xl font-bold text-text-primary">
|
||||
{data?.rate_limits.length ?? 0}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Throttled over time chart (simple bar chart) */}
|
||||
{data?.throttled_over_time && data.throttled_over_time.length > 0 && (
|
||||
<div className="bg-bg-card/60 border border-primary/15 rounded-2xl p-5">
|
||||
<h3 className="text-sm font-semibold text-text-secondary uppercase tracking-wider mb-4">
|
||||
Throttled Requests Over Time (Last 24h)
|
||||
</h3>
|
||||
<div className="flex items-end gap-1 h-32">
|
||||
{data.throttled_over_time.map((bucket) => {
|
||||
const height = maxThrottledCount > 0 ? (bucket.count / maxThrottledCount) * 100 : 0;
|
||||
const hour = new Date(bucket.timestamp).getHours();
|
||||
return (
|
||||
<div key={bucket.timestamp} className="flex-1 flex flex-col items-center gap-1">
|
||||
<span className="text-xs text-text-secondary">{bucket.count}</span>
|
||||
<div
|
||||
className="w-full bg-error/70 rounded-t-sm min-h-[2px] transition-all"
|
||||
style={{ height: `${Math.max(height, 2)}%` }}
|
||||
title={`${bucket.timestamp}: ${bucket.count} throttled`}
|
||||
/>
|
||||
<span className="text-[10px] text-text-secondary">{hour}:00</span>
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{/* Per-endpoint table */}
|
||||
<div className="bg-bg-card/60 border border-primary/15 rounded-2xl overflow-hidden">
|
||||
<div className="overflow-x-auto">
|
||||
<table className="w-full">
|
||||
<thead>
|
||||
<tr className="border-b border-primary/10">
|
||||
<th className="text-left px-6 py-4 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Endpoint
|
||||
</th>
|
||||
<th className="text-left px-6 py-4 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Limit
|
||||
</th>
|
||||
<th className="text-right px-6 py-4 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Total Requests
|
||||
</th>
|
||||
<th className="text-right px-6 py-4 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Rejected
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="divide-y divide-primary/10">
|
||||
{data?.rate_limits.map((rl) => (
|
||||
<tr key={rl.endpoint} className="hover:bg-bg-card-hover/50 transition-colors">
|
||||
<td className="px-6 py-4 font-mono text-sm text-text-primary">{rl.endpoint}</td>
|
||||
<td className="px-6 py-4">
|
||||
<span className="inline-flex px-2 py-0.5 rounded-full text-xs font-medium bg-primary/10 text-primary border border-primary/20">
|
||||
{rl.limit}
|
||||
</span>
|
||||
</td>
|
||||
<td className="px-6 py-4 text-right text-text-primary font-semibold">
|
||||
{rl.total_requests}
|
||||
</td>
|
||||
<td className="px-6 py-4 text-right">
|
||||
<span className={rl.rejected_requests > 0 ? 'text-error font-semibold' : 'text-text-secondary'}>
|
||||
{rl.rejected_requests}
|
||||
</span>
|
||||
</td>
|
||||
</tr>
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Per-IP breakdown */}
|
||||
{data?.rate_limits.some((rl) => rl.by_ip.length > 0) && (
|
||||
<div className="bg-bg-card/60 border border-primary/15 rounded-2xl overflow-hidden">
|
||||
<div className="px-6 py-4 border-b border-primary/10">
|
||||
<h3 className="text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Per-IP Breakdown
|
||||
</h3>
|
||||
</div>
|
||||
<div className="overflow-x-auto">
|
||||
<table className="w-full">
|
||||
<thead>
|
||||
<tr className="border-b border-primary/10">
|
||||
<th className="text-left px-6 py-3 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Endpoint
|
||||
</th>
|
||||
<th className="text-left px-6 py-3 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
IP Address
|
||||
</th>
|
||||
<th className="text-right px-6 py-3 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Total
|
||||
</th>
|
||||
<th className="text-right px-6 py-3 text-sm font-semibold text-text-secondary uppercase tracking-wider">
|
||||
Rejected
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody className="divide-y divide-primary/10">
|
||||
{data.rate_limits.flatMap((rl) =>
|
||||
rl.by_ip.map((ipEntry) => (
|
||||
<tr
|
||||
key={`${rl.endpoint}-${ipEntry.ip}`}
|
||||
className="hover:bg-bg-card-hover/50 transition-colors"
|
||||
>
|
||||
<td className="px-6 py-3 font-mono text-sm text-text-primary">{rl.endpoint}</td>
|
||||
<td className="px-6 py-3 font-mono text-sm text-text-secondary">{ipEntry.ip}</td>
|
||||
<td className="px-6 py-3 text-right text-text-primary">{ipEntry.total}</td>
|
||||
<td className="px-6 py-3 text-right">
|
||||
<span className={ipEntry.rejected > 0 ? 'text-error font-semibold' : 'text-text-secondary'}>
|
||||
{ipEntry.rejected}
|
||||
</span>
|
||||
</td>
|
||||
</tr>
|
||||
))
|
||||
)}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,211 @@
|
||||
"""Tests for analyze_single_patent auto-download path.
|
||||
|
||||
Covers issue #1661:
|
||||
- PDF exists on disk: direct analysis (happy path)
|
||||
- PDF not on disk, cached link exists: auto-download and analyze
|
||||
- PDF not on disk, no cached link: FileNotFoundError
|
||||
- Analysis failure after PDF found: graceful error message
|
||||
- Model override parameter passthrough
|
||||
"""
|
||||
|
||||
import os
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from SPARC.analyzer import CompanyAnalyzer
|
||||
from SPARC.types import Patent
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def mock_db(mocker):
|
||||
"""Mock DatabaseClient so no real DB is needed."""
|
||||
mock_db_cls = mocker.patch("SPARC.analyzer.DatabaseClient")
|
||||
mock_db_instance = MagicMock()
|
||||
mock_db_instance.get_cached_patent.return_value = None
|
||||
mock_db_instance.get_cached_serp_query.return_value = None
|
||||
mock_db_cls.return_value = mock_db_instance
|
||||
return mock_db_instance
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def analyzer(mocker, mock_db):
|
||||
"""Create a CompanyAnalyzer with mocked LLM and DB."""
|
||||
mocker.patch("SPARC.analyzer.LLMAnalyzer")
|
||||
return CompanyAnalyzer(openrouter_api_key="test-key")
|
||||
|
||||
|
||||
class TestAnalyzeSinglePatentAutoDownload:
|
||||
"""Test the auto-download logic in analyze_single_patent."""
|
||||
|
||||
def test_pdf_on_disk_analyzed_directly(self, analyzer, mocker, tmp_path):
|
||||
"""When PDF exists on disk, it is analyzed directly without download."""
|
||||
patent_id = "US-11234567-B2"
|
||||
|
||||
# Create the patents dir and PDF file
|
||||
patents_dir = tmp_path / "patents"
|
||||
patents_dir.mkdir()
|
||||
pdf_path = patents_dir / f"{patent_id}.pdf"
|
||||
pdf_path.write_bytes(b"fake PDF content")
|
||||
|
||||
mock_parse = mocker.patch("SPARC.analyzer.SERP.parse_patent_pdf")
|
||||
mock_minimize = mocker.patch("SPARC.analyzer.SERP.minimize_patent_for_llm")
|
||||
mock_parse.return_value = {"abstract": "test", "claims": "test claims"}
|
||||
mock_minimize.return_value = "minimized content"
|
||||
analyzer.llm_analyzer.analyze_patent_content.return_value = "Good patent."
|
||||
|
||||
# Change cwd so patents/{patent_id}.pdf resolves to our tmp_path
|
||||
original_cwd = os.getcwd()
|
||||
os.chdir(tmp_path)
|
||||
try:
|
||||
result = analyzer.analyze_single_patent(patent_id, "TestCo")
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
|
||||
assert result == "Good patent."
|
||||
# DB cache should not have been queried since file existed
|
||||
analyzer.db.get_cached_patent.assert_not_called()
|
||||
|
||||
def test_auto_download_from_cached_link(self, analyzer, mocker, tmp_path):
|
||||
"""When PDF is not on disk but link is cached, auto-download occurs."""
|
||||
patent_id = "US-99887766-A1"
|
||||
|
||||
# No patents dir exists (PDF not on disk)
|
||||
mock_save = mocker.patch("SPARC.analyzer.SERP.save_patents")
|
||||
downloaded_patent = Patent(patent_id=patent_id, pdf_link="https://example.com/patent.pdf")
|
||||
downloaded_patent.pdf_path = f"patents/{patent_id}.pdf"
|
||||
mock_save.return_value = downloaded_patent
|
||||
|
||||
# Cached patent has a PDF link
|
||||
analyzer.db.get_cached_patent.return_value = {
|
||||
"patent_id": patent_id,
|
||||
"pdf_link": "https://example.com/patent.pdf",
|
||||
}
|
||||
|
||||
# Mock the rest of the analysis pipeline
|
||||
mock_parse = mocker.patch("SPARC.analyzer.SERP.parse_patent_pdf")
|
||||
mock_minimize = mocker.patch("SPARC.analyzer.SERP.minimize_patent_for_llm")
|
||||
mock_parse.return_value = {"abstract": "test abstract"}
|
||||
mock_minimize.return_value = "minimized content"
|
||||
analyzer.llm_analyzer.analyze_patent_content.return_value = "Strong innovation."
|
||||
|
||||
# Change cwd so patents/{patent_id}.pdf does NOT exist
|
||||
original_cwd = os.getcwd()
|
||||
os.chdir(tmp_path)
|
||||
try:
|
||||
result = analyzer.analyze_single_patent(patent_id, "DownloadCo")
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
|
||||
assert result == "Strong innovation."
|
||||
analyzer.db.get_cached_patent.assert_called_once_with(patent_id)
|
||||
mock_save.assert_called_once()
|
||||
# Verify the Patent passed to save_patents has the correct ID and link
|
||||
saved_patent = mock_save.call_args[0][0]
|
||||
assert saved_patent.patent_id == patent_id
|
||||
assert saved_patent.pdf_link == "https://example.com/patent.pdf"
|
||||
|
||||
def test_no_cached_link_raises_file_not_found(self, analyzer, mocker, tmp_path):
|
||||
"""When PDF is not on disk and no cached link, FileNotFoundError raised."""
|
||||
patent_id = "US-00000000-X1"
|
||||
|
||||
analyzer.db.get_cached_patent.return_value = None
|
||||
|
||||
original_cwd = os.getcwd()
|
||||
os.chdir(tmp_path)
|
||||
try:
|
||||
with pytest.raises(FileNotFoundError, match="no download link is cached"):
|
||||
analyzer.analyze_single_patent(patent_id, "MissingCo")
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
|
||||
def test_cached_patent_without_pdf_link_raises(self, analyzer, mocker, tmp_path):
|
||||
"""When cached patent exists but has no pdf_link, FileNotFoundError raised."""
|
||||
patent_id = "US-11111111-B1"
|
||||
|
||||
analyzer.db.get_cached_patent.return_value = {
|
||||
"patent_id": patent_id,
|
||||
"pdf_link": None,
|
||||
}
|
||||
|
||||
original_cwd = os.getcwd()
|
||||
os.chdir(tmp_path)
|
||||
try:
|
||||
with pytest.raises(FileNotFoundError, match="no download link is cached"):
|
||||
analyzer.analyze_single_patent(patent_id, "NoPDFCo")
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
|
||||
def test_analysis_exception_returns_error_message(self, analyzer, mocker, tmp_path):
|
||||
"""When analysis pipeline fails, returns error string instead of raising."""
|
||||
patent_id = "US-22222222-A2"
|
||||
|
||||
# Create the PDF on disk so it skips download
|
||||
patents_dir = tmp_path / "patents"
|
||||
patents_dir.mkdir()
|
||||
(patents_dir / f"{patent_id}.pdf").write_bytes(b"fake PDF")
|
||||
|
||||
# Parse fails
|
||||
mocker.patch(
|
||||
"SPARC.analyzer.SERP.parse_patent_pdf",
|
||||
side_effect=ValueError("Corrupt PDF"),
|
||||
)
|
||||
|
||||
original_cwd = os.getcwd()
|
||||
os.chdir(tmp_path)
|
||||
try:
|
||||
result = analyzer.analyze_single_patent(patent_id, "ErrorCo")
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
|
||||
assert "Failed to analyze patent" in result
|
||||
assert "Corrupt PDF" in result
|
||||
|
||||
def test_model_override_passed_to_llm(self, analyzer, mocker, tmp_path):
|
||||
"""The model parameter is forwarded to the LLM analyzer."""
|
||||
patent_id = "US-33333333-B2"
|
||||
|
||||
patents_dir = tmp_path / "patents"
|
||||
patents_dir.mkdir()
|
||||
(patents_dir / f"{patent_id}.pdf").write_bytes(b"fake PDF")
|
||||
|
||||
mocker.patch("SPARC.analyzer.SERP.parse_patent_pdf", return_value={"abstract": "test"})
|
||||
mocker.patch("SPARC.analyzer.SERP.minimize_patent_for_llm", return_value="content")
|
||||
analyzer.llm_analyzer.analyze_patent_content.return_value = "Analysis result."
|
||||
|
||||
original_cwd = os.getcwd()
|
||||
os.chdir(tmp_path)
|
||||
try:
|
||||
result = analyzer.analyze_single_patent(
|
||||
patent_id, "ModelCo", model="openai/gpt-4o"
|
||||
)
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
|
||||
assert result == "Analysis result."
|
||||
analyzer.llm_analyzer.analyze_patent_content.assert_called_once_with(
|
||||
patent_content="content",
|
||||
company_name="ModelCo",
|
||||
model="openai/gpt-4o",
|
||||
)
|
||||
|
||||
def test_file_not_found_during_parse_re_raised(self, analyzer, mocker, tmp_path):
|
||||
"""FileNotFoundError during parsing is re-raised, not caught."""
|
||||
patent_id = "US-44444444-C1"
|
||||
|
||||
patents_dir = tmp_path / "patents"
|
||||
patents_dir.mkdir()
|
||||
(patents_dir / f"{patent_id}.pdf").write_bytes(b"fake PDF")
|
||||
|
||||
mocker.patch(
|
||||
"SPARC.analyzer.SERP.parse_patent_pdf",
|
||||
side_effect=FileNotFoundError("PDF file vanished"),
|
||||
)
|
||||
|
||||
original_cwd = os.getcwd()
|
||||
os.chdir(tmp_path)
|
||||
try:
|
||||
with pytest.raises(FileNotFoundError, match="PDF file vanished"):
|
||||
analyzer.analyze_single_patent(patent_id, "VanishCo")
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
@@ -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,224 @@
|
||||
"""Tests for export endpoints: CSV and PDF export of analysis results.
|
||||
|
||||
Covers issue #1655:
|
||||
- GET /export/{company_name} (CSV export)
|
||||
- GET /export/{company_name}/pdf (PDF export)
|
||||
|
||||
All tests mock the database layer and use JWT auth fixtures from test_auth patterns.
|
||||
"""
|
||||
|
||||
from datetime import datetime, timezone
|
||||
from unittest.mock import MagicMock, 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_db():
|
||||
"""Mock the database client used by export and auth endpoints."""
|
||||
db = MagicMock()
|
||||
|
||||
# Default: user exists for auth
|
||||
db.get_user_by_id.return_value = {
|
||||
"id": 1,
|
||||
"email": "user@test.com",
|
||||
"role": "user",
|
||||
"created_at": datetime(2025, 1, 1, tzinfo=timezone.utc),
|
||||
}
|
||||
|
||||
# Mock get_conn for export queries
|
||||
mock_cursor = MagicMock()
|
||||
mock_conn = MagicMock()
|
||||
mock_conn.cursor.return_value.__enter__ = MagicMock(return_value=mock_cursor)
|
||||
mock_conn.cursor.return_value.__exit__ = MagicMock(return_value=False)
|
||||
db.get_conn.return_value.__enter__ = MagicMock(return_value=mock_conn)
|
||||
db.get_conn.return_value.__exit__ = MagicMock(return_value=False)
|
||||
db._mock_cursor = mock_cursor
|
||||
|
||||
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 an Authorization header with a valid access token."""
|
||||
token = create_access_token(1, "user@test.com", "user")
|
||||
return {"Authorization": f"Bearer {token}"}
|
||||
|
||||
|
||||
def _sample_rows():
|
||||
"""Return sample llm_messages rows as tuples (matching cursor.fetchall format)."""
|
||||
return [
|
||||
(
|
||||
"NVIDIA",
|
||||
"company_analysis",
|
||||
"anthropic/claude-3.5-sonnet",
|
||||
"Strong AI patent portfolio with focus on GPU architectures.",
|
||||
datetime(2025, 6, 15, 10, 30, 0),
|
||||
),
|
||||
(
|
||||
"NVIDIA",
|
||||
"patent_analysis",
|
||||
"openai/gpt-4o",
|
||||
"Patent US-12345678-B2 covers novel tensor core design.",
|
||||
datetime(2025, 6, 14, 9, 0, 0),
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
class TestCSVExport:
|
||||
"""GET /export/{company_name} -- CSV export."""
|
||||
|
||||
def test_csv_export_success(self, client, mock_db):
|
||||
"""Valid company with results returns a CSV file."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.headers["content-type"].startswith("text/csv")
|
||||
assert "attachment" in response.headers.get("content-disposition", "")
|
||||
assert "sparc_nvidia_export.csv" in response.headers["content-disposition"]
|
||||
|
||||
# Verify CSV content (CSV uses \r\n line endings)
|
||||
lines = response.text.strip().split("\n")
|
||||
assert len(lines) == 3 # header + 2 data rows
|
||||
assert lines[0].strip() == "company_name,analysis_type,model,analysis,timestamp"
|
||||
assert "NVIDIA" in lines[1]
|
||||
assert "company_analysis" in lines[1]
|
||||
|
||||
def test_csv_export_no_results_returns_404(self, client, mock_db):
|
||||
"""Unknown company returns 404."""
|
||||
mock_db._mock_cursor.fetchall.return_value = []
|
||||
|
||||
response = client.get("/export/nonexistent", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 404
|
||||
assert "No analysis results found" in response.json()["detail"]
|
||||
|
||||
def test_csv_export_unauthenticated_returns_401(self, client):
|
||||
"""Request without token returns 401."""
|
||||
response = client.get("/export/NVIDIA")
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_csv_export_invalid_token_returns_401(self, client):
|
||||
"""Request with invalid token returns 401."""
|
||||
response = client.get(
|
||||
"/export/NVIDIA",
|
||||
headers={"Authorization": "Bearer invalid.token.here"},
|
||||
)
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_csv_export_filename_sanitization(self, client, mock_db):
|
||||
"""Company names with spaces get sanitized in the filename."""
|
||||
mock_db._mock_cursor.fetchall.return_value = [
|
||||
(
|
||||
"Tesla Motors",
|
||||
"company_analysis",
|
||||
"anthropic/claude-3.5-sonnet",
|
||||
"EV patent portfolio analysis.",
|
||||
datetime(2025, 6, 15, 10, 0, 0),
|
||||
),
|
||||
]
|
||||
|
||||
response = client.get("/export/Tesla Motors", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert "tesla_motors" in response.headers["content-disposition"]
|
||||
|
||||
def test_csv_export_single_row(self, client, mock_db):
|
||||
"""Single analysis result produces valid CSV with one data row."""
|
||||
mock_db._mock_cursor.fetchall.return_value = [_sample_rows()[0]]
|
||||
|
||||
response = client.get("/export/NVIDIA", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
lines = response.text.strip().split("\n")
|
||||
assert len(lines) == 2 # header + 1 data row
|
||||
|
||||
|
||||
class TestPDFExport:
|
||||
"""GET /export/{company_name}/pdf -- PDF report export."""
|
||||
|
||||
def test_pdf_export_success(self, client, mock_db):
|
||||
"""Valid company with results returns a PDF file."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.headers["content-type"] == "application/pdf"
|
||||
assert "attachment" in response.headers.get("content-disposition", "")
|
||||
# PDF files start with %PDF
|
||||
assert response.content[:4] == b"%PDF"
|
||||
|
||||
def test_pdf_export_no_results_returns_404(self, client, mock_db):
|
||||
"""Unknown company returns 404."""
|
||||
mock_db._mock_cursor.fetchall.return_value = []
|
||||
|
||||
response = client.get("/export/nonexistent/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 404
|
||||
assert "No analysis results found" in response.json()["detail"]
|
||||
|
||||
def test_pdf_export_unauthenticated_returns_401(self, client):
|
||||
"""Request without token returns 401."""
|
||||
response = client.get("/export/NVIDIA/pdf")
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_pdf_export_invalid_token_returns_401(self, client):
|
||||
"""Request with invalid token returns 401."""
|
||||
response = client.get(
|
||||
"/export/NVIDIA/pdf",
|
||||
headers={"Authorization": "Bearer invalid.token.here"},
|
||||
)
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_pdf_export_filename_contains_date(self, client, mock_db):
|
||||
"""PDF filename includes the analysis date."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
disposition = response.headers["content-disposition"]
|
||||
assert "nvidia-analysis-" in disposition
|
||||
assert ".pdf" in disposition
|
||||
|
||||
def test_pdf_export_special_chars_in_response(self, client, mock_db):
|
||||
"""Analysis text with XML-special chars (<, >, &) does not break PDF generation."""
|
||||
rows = [
|
||||
(
|
||||
"TestCo",
|
||||
"company_analysis",
|
||||
"anthropic/claude-3.5-sonnet",
|
||||
"Revenue > $1B & growth <20% for Q4. Test <html> escaping.",
|
||||
datetime(2025, 6, 15, 10, 0, 0),
|
||||
),
|
||||
]
|
||||
mock_db._mock_cursor.fetchall.return_value = rows
|
||||
|
||||
response = client.get("/export/TestCo/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.content[:4] == b"%PDF"
|
||||
|
||||
def test_pdf_export_multiple_analyses(self, client, mock_db):
|
||||
"""Multiple analysis records produce a valid PDF with content."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
# PDF should have reasonable size (more than just headers)
|
||||
assert len(response.content) > 500
|
||||
@@ -0,0 +1,169 @@
|
||||
"""Tests for cursor-based pagination on /analyze/batch GET and /jobs endpoints."""
|
||||
|
||||
from datetime import datetime, timedelta
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from SPARC.api import app
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def client():
|
||||
"""Create test client."""
|
||||
return TestClient(app)
|
||||
|
||||
|
||||
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")
|
||||
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")
|
||||
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")
|
||||
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)
|
||||
|
||||
@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")
|
||||
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")
|
||||
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")
|
||||
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")
|
||||
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 [])
|
||||
|
||||
@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")
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["items"] == []
|
||||
assert data["next_cursor"] is None
|
||||
|
||||
|
||||
class TestJobsPaginationDefaults:
|
||||
"""Test that /jobs endpoint uses updated defaults."""
|
||||
|
||||
@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")
|
||||
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")
|
||||
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")
|
||||
assert response.status_code == 200
|
||||
@@ -0,0 +1,178 @@
|
||||
"""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()
|
||||
api._rejected_log.clear()
|
||||
yield
|
||||
api._rate_limit_stats.clear()
|
||||
api._rejected_log.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 401/403."""
|
||||
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
|
||||
assert rl["by_ip"] == []
|
||||
assert data["throttled_24h"] == 0
|
||||
assert data["throttled_over_time"] == []
|
||||
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()
|
||||
|
||||
def test_per_ip_breakdown(self, client):
|
||||
"""Stats should include per-IP breakdown with total and rejected counts."""
|
||||
api._track_rate_limit_request("/auth/login", "10.0.0.1")
|
||||
api._track_rate_limit_request("/auth/login", "10.0.0.1", rejected=True)
|
||||
api._track_rate_limit_request("/auth/login", "10.0.0.2")
|
||||
|
||||
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")
|
||||
by_ip = login_stats["by_ip"]
|
||||
assert len(by_ip) == 2
|
||||
ip1 = next(entry for entry in by_ip if entry["ip"] == "10.0.0.1")
|
||||
assert ip1["total"] == 2
|
||||
assert ip1["rejected"] == 1
|
||||
ip2 = next(entry for entry in by_ip if entry["ip"] == "10.0.0.2")
|
||||
assert ip2["total"] == 1
|
||||
assert ip2["rejected"] == 0
|
||||
finally:
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
def test_throttled_24h_count(self, client):
|
||||
"""Should report total throttled requests in the last 24 hours."""
|
||||
api._track_rate_limit_request("/auth/login", "10.0.0.1", rejected=True)
|
||||
api._track_rate_limit_request("/auth/register", "10.0.0.2", rejected=True)
|
||||
|
||||
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||
try:
|
||||
response = client.get("/admin/rate-limits")
|
||||
data = response.json()
|
||||
assert data["throttled_24h"] == 2
|
||||
finally:
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
def test_throttled_over_time_structure(self, client):
|
||||
"""Throttled-over-time should be a list of {timestamp, count} buckets."""
|
||||
api._track_rate_limit_request("/auth/login", "10.0.0.1", rejected=True)
|
||||
|
||||
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||
try:
|
||||
response = client.get("/admin/rate-limits")
|
||||
data = response.json()
|
||||
assert len(data["throttled_over_time"]) >= 1
|
||||
entry = data["throttled_over_time"][0]
|
||||
assert "timestamp" in entry
|
||||
assert "count" in entry
|
||||
assert entry["count"] >= 1
|
||||
finally:
|
||||
app.dependency_overrides.clear()
|
||||
|
||||
def test_response_shape_matches_contract(self, client):
|
||||
"""The full response should match the expected shape for the frontend."""
|
||||
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||
try:
|
||||
response = client.get("/admin/rate-limits")
|
||||
data = response.json()
|
||||
# Top-level keys
|
||||
assert set(data.keys()) == {"rate_limits", "throttled_24h", "throttled_over_time"}
|
||||
# Each rate_limit entry
|
||||
for rl in data["rate_limits"]:
|
||||
assert set(rl.keys()) == {"endpoint", "limit", "total_requests", "rejected_requests", "by_ip"}
|
||||
finally:
|
||||
app.dependency_overrides.clear()
|
||||
@@ -0,0 +1,263 @@
|
||||
"""Tests for S3/MinIO storage backend in storage.py.
|
||||
|
||||
Covers issue #1660:
|
||||
- S3StorageBackend read, write, exists, path_for
|
||||
- Error handling: NoSuchKey, generic S3 errors, bucket auto-creation
|
||||
- get_storage_backend() factory function
|
||||
- LocalStorageBackend (basic sanity checks)
|
||||
"""
|
||||
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from SPARC.storage import LocalStorageBackend, S3StorageBackend, get_storage_backend
|
||||
|
||||
|
||||
# ---------- S3StorageBackend ----------
|
||||
|
||||
class TestS3StorageBackend:
|
||||
"""Tests for the S3-compatible storage backend."""
|
||||
|
||||
@pytest.fixture
|
||||
def s3_backend(self):
|
||||
"""Create an S3StorageBackend with a fully mocked boto3 client."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
mock_s3.head_bucket.return_value = {}
|
||||
|
||||
backend = S3StorageBackend(
|
||||
bucket="test-bucket",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="minioadmin",
|
||||
secret_key="minioadmin",
|
||||
)
|
||||
# Expose mock for assertions
|
||||
backend._mock_s3 = mock_s3
|
||||
yield backend
|
||||
|
||||
def test_write_puts_object(self, s3_backend):
|
||||
"""write() calls put_object with correct bucket, key, and body."""
|
||||
s3_backend.write("US-12345678-B2.pdf", b"PDF content here")
|
||||
|
||||
s3_backend._mock_s3.put_object.assert_called_once_with(
|
||||
Bucket="test-bucket",
|
||||
Key="US-12345678-B2.pdf",
|
||||
Body=b"PDF content here",
|
||||
ContentType="application/pdf",
|
||||
)
|
||||
|
||||
def test_read_returns_body(self, s3_backend):
|
||||
"""read() returns the Body content from get_object."""
|
||||
mock_body = MagicMock()
|
||||
mock_body.read.return_value = b"PDF data"
|
||||
s3_backend._mock_s3.get_object.return_value = {"Body": mock_body}
|
||||
|
||||
result = s3_backend.read("US-12345678-B2.pdf")
|
||||
|
||||
assert result == b"PDF data"
|
||||
s3_backend._mock_s3.get_object.assert_called_once_with(
|
||||
Bucket="test-bucket",
|
||||
Key="US-12345678-B2.pdf",
|
||||
)
|
||||
|
||||
def test_read_nosuchkey_raises_file_not_found(self, s3_backend):
|
||||
"""read() raises FileNotFoundError when object does not exist."""
|
||||
# Create a NoSuchKey exception class on the mock
|
||||
nosuchkey = type("NoSuchKey", (Exception,), {})
|
||||
s3_backend._mock_s3.exceptions.NoSuchKey = nosuchkey
|
||||
s3_backend._mock_s3.get_object.side_effect = nosuchkey("not found")
|
||||
|
||||
# Reassign s3 to trigger the except branch
|
||||
s3_backend.s3 = s3_backend._mock_s3
|
||||
|
||||
with pytest.raises(FileNotFoundError, match="S3 object not found"):
|
||||
s3_backend.read("missing.pdf")
|
||||
|
||||
def test_read_generic_404_raises_file_not_found(self, s3_backend):
|
||||
"""read() handles generic 404 errors from S3-compatible APIs."""
|
||||
nosuchkey = type("NoSuchKey", (Exception,), {})
|
||||
s3_backend._mock_s3.exceptions.NoSuchKey = nosuchkey
|
||||
s3_backend.s3 = s3_backend._mock_s3
|
||||
s3_backend.s3.get_object.side_effect = Exception("An error occurred (404)")
|
||||
|
||||
with pytest.raises(FileNotFoundError, match="S3 object not found"):
|
||||
s3_backend.read("missing.pdf")
|
||||
|
||||
def test_read_other_error_re_raises(self, s3_backend):
|
||||
"""read() re-raises non-404 errors."""
|
||||
nosuchkey = type("NoSuchKey", (Exception,), {})
|
||||
s3_backend._mock_s3.exceptions.NoSuchKey = nosuchkey
|
||||
s3_backend.s3 = s3_backend._mock_s3
|
||||
s3_backend.s3.get_object.side_effect = Exception("Internal server error")
|
||||
|
||||
with pytest.raises(Exception, match="Internal server error"):
|
||||
s3_backend.read("some-file.pdf")
|
||||
|
||||
def test_exists_returns_true_for_existing_object(self, s3_backend):
|
||||
"""exists() returns True when head_object succeeds with content."""
|
||||
s3_backend._mock_s3.head_object.return_value = {"ContentLength": 1024}
|
||||
|
||||
assert s3_backend.exists("US-12345678-B2.pdf") is True
|
||||
|
||||
def test_exists_returns_false_for_missing_object(self, s3_backend):
|
||||
"""exists() returns False when head_object raises an exception."""
|
||||
s3_backend._mock_s3.head_object.side_effect = Exception("Not Found")
|
||||
|
||||
assert s3_backend.exists("missing.pdf") is False
|
||||
|
||||
def test_exists_returns_false_for_zero_length(self, s3_backend):
|
||||
"""exists() returns False when object has zero content length."""
|
||||
s3_backend._mock_s3.head_object.return_value = {"ContentLength": 0}
|
||||
|
||||
assert s3_backend.exists("empty.pdf") is False
|
||||
|
||||
def test_path_for_returns_s3_uri(self, s3_backend):
|
||||
"""path_for() returns an s3:// URI."""
|
||||
path = s3_backend.path_for("US-12345678-B2.pdf")
|
||||
|
||||
assert path == "s3://test-bucket/US-12345678-B2.pdf"
|
||||
|
||||
def test_constructor_creates_bucket_if_missing(self):
|
||||
"""Constructor creates the bucket if head_bucket fails."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
mock_s3.head_bucket.side_effect = Exception("Bucket not found")
|
||||
|
||||
S3StorageBackend(
|
||||
bucket="new-bucket",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="admin",
|
||||
secret_key="admin",
|
||||
)
|
||||
|
||||
mock_s3.create_bucket.assert_called_once_with(Bucket="new-bucket")
|
||||
|
||||
def test_constructor_handles_bucket_creation_failure(self):
|
||||
"""Constructor logs warning but does not crash if bucket creation fails."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
mock_s3.head_bucket.side_effect = Exception("Bucket not found")
|
||||
mock_s3.create_bucket.side_effect = Exception("Permission denied")
|
||||
|
||||
# Should not raise
|
||||
backend = S3StorageBackend(
|
||||
bucket="locked-bucket",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="admin",
|
||||
secret_key="admin",
|
||||
)
|
||||
assert backend.bucket == "locked-bucket"
|
||||
|
||||
def test_constructor_passes_endpoint_and_credentials(self):
|
||||
"""Constructor passes endpoint_url and credentials to boto3.client."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
|
||||
S3StorageBackend(
|
||||
bucket="test",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="mykey",
|
||||
secret_key="mysecret",
|
||||
)
|
||||
|
||||
mock_boto.client.assert_called_with(
|
||||
"s3",
|
||||
endpoint_url="http://minio:9000",
|
||||
aws_access_key_id="mykey",
|
||||
aws_secret_access_key="mysecret",
|
||||
)
|
||||
|
||||
|
||||
# ---------- LocalStorageBackend ----------
|
||||
|
||||
class TestLocalStorageBackend:
|
||||
"""Basic sanity checks for the local filesystem backend."""
|
||||
|
||||
def test_write_and_read(self, tmp_path):
|
||||
"""Write and read round-trip produces identical content."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
backend.write("test.pdf", b"hello world")
|
||||
|
||||
result = backend.read("test.pdf")
|
||||
assert result == b"hello world"
|
||||
|
||||
def test_read_missing_file_raises(self, tmp_path):
|
||||
"""Reading a non-existent file raises FileNotFoundError."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
|
||||
with pytest.raises(FileNotFoundError):
|
||||
backend.read("nonexistent.pdf")
|
||||
|
||||
def test_exists_true_for_written_file(self, tmp_path):
|
||||
"""exists() returns True after writing a file."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
backend.write("test.pdf", b"data")
|
||||
|
||||
assert backend.exists("test.pdf") is True
|
||||
|
||||
def test_exists_false_for_missing_file(self, tmp_path):
|
||||
"""exists() returns False for non-existent file."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
|
||||
assert backend.exists("missing.pdf") is False
|
||||
|
||||
def test_exists_false_for_empty_file(self, tmp_path):
|
||||
"""exists() returns False for zero-length file."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
backend.write("empty.pdf", b"")
|
||||
|
||||
assert backend.exists("empty.pdf") is False
|
||||
|
||||
def test_path_for_returns_full_path(self, tmp_path):
|
||||
"""path_for() returns the full filesystem path."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
path = backend.path_for("test.pdf")
|
||||
|
||||
assert path == str(tmp_path / "test.pdf")
|
||||
|
||||
|
||||
# ---------- get_storage_backend() factory ----------
|
||||
|
||||
class TestGetStorageBackend:
|
||||
"""Tests for the storage backend factory function."""
|
||||
|
||||
@patch("SPARC.storage.config")
|
||||
def test_returns_local_backend_by_default(self, mock_config):
|
||||
"""Default config returns LocalStorageBackend."""
|
||||
mock_config.storage_backend = "local"
|
||||
|
||||
backend = get_storage_backend()
|
||||
|
||||
assert isinstance(backend, LocalStorageBackend)
|
||||
|
||||
@patch("SPARC.storage.config")
|
||||
def test_returns_s3_backend_when_configured(self, mock_config):
|
||||
"""Setting storage_backend=s3 returns S3StorageBackend."""
|
||||
mock_config.storage_backend = "s3"
|
||||
mock_config.s3_bucket = "test-bucket"
|
||||
mock_config.s3_endpoint_url = "http://minio:9000"
|
||||
mock_config.s3_access_key = "key"
|
||||
mock_config.s3_secret_key = "secret"
|
||||
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
backend = get_storage_backend()
|
||||
|
||||
assert isinstance(backend, S3StorageBackend)
|
||||
|
||||
@patch("SPARC.storage.config")
|
||||
def test_case_insensitive_backend_selection(self, mock_config):
|
||||
"""Backend selection is case-insensitive."""
|
||||
mock_config.storage_backend = "LOCAL"
|
||||
|
||||
backend = get_storage_backend()
|
||||
|
||||
assert isinstance(backend, LocalStorageBackend)
|
||||
@@ -0,0 +1,387 @@
|
||||
"""Tests for tracked company admin endpoints and scheduler integration.
|
||||
|
||||
Covers issue #1656:
|
||||
- GET /admin/tracked (list tracked companies)
|
||||
- POST /admin/tracked (add a tracked company)
|
||||
- DELETE /admin/tracked/{company_name} (remove a tracked company)
|
||||
- GET /admin/alerts (list alerts)
|
||||
- scheduler.run_scheduled_analysis() integration
|
||||
|
||||
All tests mock the database layer and use JWT auth fixtures.
|
||||
"""
|
||||
|
||||
from datetime import datetime, timezone
|
||||
from unittest.mock import MagicMock, patch, call
|
||||
|
||||
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_db():
|
||||
"""Mock the database client used by admin and auth endpoints."""
|
||||
db = MagicMock()
|
||||
|
||||
# Default admin user for auth
|
||||
db.get_user_by_id.return_value = {
|
||||
"id": 1,
|
||||
"email": "admin@test.com",
|
||||
"role": "admin",
|
||||
"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 _admin_header():
|
||||
"""Create an Authorization header with a valid admin access token."""
|
||||
token = create_access_token(1, "admin@test.com", "admin")
|
||||
return {"Authorization": f"Bearer {token}"}
|
||||
|
||||
|
||||
def _user_header():
|
||||
"""Create an Authorization header with a regular user access token."""
|
||||
token = create_access_token(2, "user@test.com", "user")
|
||||
return {"Authorization": f"Bearer {token}"}
|
||||
|
||||
|
||||
# ---------- GET /admin/tracked ----------
|
||||
|
||||
class TestListTrackedCompanies:
|
||||
"""GET /admin/tracked"""
|
||||
|
||||
def test_list_tracked_returns_companies(self, client, mock_db):
|
||||
"""Admin can list tracked companies."""
|
||||
mock_db.list_tracked_companies.return_value = [
|
||||
{"company_name": "NVIDIA", "last_patent_count": 120, "last_analyzed": "2025-06-15"},
|
||||
{"company_name": "AMD", "last_patent_count": 80, "last_analyzed": "2025-06-14"},
|
||||
]
|
||||
|
||||
response = client.get("/admin/tracked", headers=_admin_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert len(data) == 2
|
||||
assert data[0]["company_name"] == "NVIDIA"
|
||||
|
||||
def test_list_tracked_empty(self, client, mock_db):
|
||||
"""Returns empty list when no companies are tracked."""
|
||||
mock_db.list_tracked_companies.return_value = []
|
||||
|
||||
response = client.get("/admin/tracked", headers=_admin_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.json() == []
|
||||
|
||||
def test_list_tracked_requires_admin(self, client, mock_db):
|
||||
"""Regular user cannot access tracked companies list."""
|
||||
mock_db.get_user_by_id.return_value = {
|
||||
"id": 2,
|
||||
"email": "user@test.com",
|
||||
"role": "user",
|
||||
"created_at": datetime(2025, 1, 1, tzinfo=timezone.utc),
|
||||
}
|
||||
|
||||
response = client.get("/admin/tracked", headers=_user_header())
|
||||
|
||||
assert response.status_code == 403
|
||||
|
||||
def test_list_tracked_unauthenticated(self, client):
|
||||
"""Unauthenticated request returns 401."""
|
||||
response = client.get("/admin/tracked")
|
||||
assert response.status_code == 401
|
||||
|
||||
|
||||
# ---------- POST /admin/tracked ----------
|
||||
|
||||
class TestAddTrackedCompany:
|
||||
"""POST /admin/tracked"""
|
||||
|
||||
def test_add_tracked_company_success(self, client, mock_db):
|
||||
"""Admin can add a company to tracking."""
|
||||
mock_db.add_tracked_company.return_value = {
|
||||
"company_name": "Intel",
|
||||
"last_patent_count": 0,
|
||||
"last_analyzed": None,
|
||||
}
|
||||
|
||||
response = client.post(
|
||||
"/admin/tracked",
|
||||
json={"company_name": "Intel"},
|
||||
headers=_admin_header(),
|
||||
)
|
||||
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert data["company_name"] == "Intel"
|
||||
mock_db.add_tracked_company.assert_called_once_with("Intel")
|
||||
|
||||
def test_add_duplicate_returns_409(self, client, mock_db):
|
||||
"""Adding an already-tracked company returns 409."""
|
||||
mock_db.add_tracked_company.return_value = None
|
||||
|
||||
response = client.post(
|
||||
"/admin/tracked",
|
||||
json={"company_name": "NVIDIA"},
|
||||
headers=_admin_header(),
|
||||
)
|
||||
|
||||
assert response.status_code == 409
|
||||
assert "already tracked" in response.json()["detail"].lower()
|
||||
|
||||
def test_add_tracked_requires_admin(self, client, mock_db):
|
||||
"""Regular user cannot add tracked companies."""
|
||||
mock_db.get_user_by_id.return_value = {
|
||||
"id": 2,
|
||||
"email": "user@test.com",
|
||||
"role": "user",
|
||||
"created_at": datetime(2025, 1, 1, tzinfo=timezone.utc),
|
||||
}
|
||||
|
||||
response = client.post(
|
||||
"/admin/tracked",
|
||||
json={"company_name": "Intel"},
|
||||
headers=_user_header(),
|
||||
)
|
||||
|
||||
assert response.status_code == 403
|
||||
|
||||
def test_add_tracked_empty_name_rejected(self, client):
|
||||
"""Empty company name is rejected by validation."""
|
||||
response = client.post(
|
||||
"/admin/tracked",
|
||||
json={"company_name": ""},
|
||||
headers=_admin_header(),
|
||||
)
|
||||
|
||||
assert response.status_code == 422 # Pydantic validation error
|
||||
|
||||
|
||||
# ---------- DELETE /admin/tracked/{company_name} ----------
|
||||
|
||||
class TestRemoveTrackedCompany:
|
||||
"""DELETE /admin/tracked/{company_name}"""
|
||||
|
||||
def test_remove_tracked_company_success(self, client, mock_db):
|
||||
"""Admin can remove a tracked company."""
|
||||
mock_db.remove_tracked_company.return_value = True
|
||||
|
||||
response = client.delete(
|
||||
"/admin/tracked/NVIDIA",
|
||||
headers=_admin_header(),
|
||||
)
|
||||
|
||||
assert response.status_code == 200
|
||||
assert "Stopped tracking" in response.json()["message"]
|
||||
mock_db.remove_tracked_company.assert_called_once_with("NVIDIA")
|
||||
|
||||
def test_remove_nonexistent_returns_404(self, client, mock_db):
|
||||
"""Removing a non-tracked company returns 404."""
|
||||
mock_db.remove_tracked_company.return_value = False
|
||||
|
||||
response = client.delete(
|
||||
"/admin/tracked/UnknownCorp",
|
||||
headers=_admin_header(),
|
||||
)
|
||||
|
||||
assert response.status_code == 404
|
||||
assert "not found" in response.json()["detail"].lower()
|
||||
|
||||
def test_remove_tracked_requires_admin(self, client, mock_db):
|
||||
"""Regular user cannot remove tracked companies."""
|
||||
mock_db.get_user_by_id.return_value = {
|
||||
"id": 2,
|
||||
"email": "user@test.com",
|
||||
"role": "user",
|
||||
"created_at": datetime(2025, 1, 1, tzinfo=timezone.utc),
|
||||
}
|
||||
|
||||
response = client.delete(
|
||||
"/admin/tracked/NVIDIA",
|
||||
headers=_user_header(),
|
||||
)
|
||||
|
||||
assert response.status_code == 403
|
||||
|
||||
|
||||
# ---------- GET /admin/alerts ----------
|
||||
|
||||
class TestListAlerts:
|
||||
"""GET /admin/alerts"""
|
||||
|
||||
def test_list_alerts_returns_data(self, client, mock_db):
|
||||
"""Admin can list alerts."""
|
||||
mock_db.list_alerts.return_value = [
|
||||
{
|
||||
"id": 1,
|
||||
"company_name": "NVIDIA",
|
||||
"alert_type": "patent_count_change",
|
||||
"message": "Patent count increased by 25%",
|
||||
"created_at": "2025-06-15T10:00:00Z",
|
||||
},
|
||||
]
|
||||
|
||||
response = client.get("/admin/alerts", headers=_admin_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
data = response.json()
|
||||
assert len(data) == 1
|
||||
assert data[0]["alert_type"] == "patent_count_change"
|
||||
|
||||
def test_list_alerts_with_limit(self, client, mock_db):
|
||||
"""Custom limit parameter is passed to the database."""
|
||||
mock_db.list_alerts.return_value = []
|
||||
|
||||
response = client.get("/admin/alerts?limit=10", headers=_admin_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
mock_db.list_alerts.assert_called_once_with(limit=10)
|
||||
|
||||
def test_list_alerts_requires_admin(self, client, mock_db):
|
||||
"""Regular user cannot access alerts."""
|
||||
mock_db.get_user_by_id.return_value = {
|
||||
"id": 2,
|
||||
"email": "user@test.com",
|
||||
"role": "user",
|
||||
"created_at": datetime(2025, 1, 1, tzinfo=timezone.utc),
|
||||
}
|
||||
|
||||
response = client.get("/admin/alerts", headers=_user_header())
|
||||
|
||||
assert response.status_code == 403
|
||||
|
||||
|
||||
# ---------- Scheduler integration ----------
|
||||
|
||||
class TestSchedulerIntegration:
|
||||
"""Tests for scheduler.run_scheduled_analysis()."""
|
||||
|
||||
def test_no_tracked_companies_skips_analysis(self):
|
||||
"""Scheduler does nothing when no companies are tracked."""
|
||||
mock_db = MagicMock()
|
||||
mock_db.list_tracked_companies.return_value = []
|
||||
|
||||
with patch("SPARC.scheduler.get_db_client", return_value=mock_db), \
|
||||
patch("SPARC.scheduler.CompanyAnalyzer") as mock_analyzer_cls:
|
||||
from SPARC.scheduler import run_scheduled_analysis
|
||||
run_scheduled_analysis()
|
||||
|
||||
mock_analyzer_cls.assert_not_called()
|
||||
|
||||
def test_scheduler_analyzes_each_tracked_company(self):
|
||||
"""Scheduler runs analysis for every tracked company."""
|
||||
mock_db = MagicMock()
|
||||
mock_db.list_tracked_companies.return_value = [
|
||||
{"company_name": "NVIDIA", "last_patent_count": 100},
|
||||
{"company_name": "AMD", "last_patent_count": 50},
|
||||
]
|
||||
|
||||
mock_result_nvidia = MagicMock(success=True, patent_count=110)
|
||||
mock_result_amd = MagicMock(success=True, patent_count=55)
|
||||
mock_analyzer = MagicMock()
|
||||
mock_analyzer._analyze_company_safe.side_effect = [mock_result_nvidia, mock_result_amd]
|
||||
|
||||
with patch("SPARC.scheduler.get_db_client", return_value=mock_db), \
|
||||
patch("SPARC.scheduler.CompanyAnalyzer", return_value=mock_analyzer):
|
||||
from SPARC.scheduler import run_scheduled_analysis
|
||||
run_scheduled_analysis()
|
||||
|
||||
assert mock_analyzer._analyze_company_safe.call_count == 2
|
||||
mock_db.update_tracked_company.assert_any_call("NVIDIA", 110)
|
||||
mock_db.update_tracked_company.assert_any_call("AMD", 55)
|
||||
|
||||
def test_scheduler_triggers_alert_on_significant_change(self):
|
||||
"""Scheduler stores an alert when patent count changes significantly."""
|
||||
mock_db = MagicMock()
|
||||
mock_db.list_tracked_companies.return_value = [
|
||||
{"company_name": "Tesla", "last_patent_count": 100},
|
||||
]
|
||||
|
||||
mock_result = MagicMock(success=True, patent_count=130) # 30% increase
|
||||
mock_analyzer = MagicMock()
|
||||
mock_analyzer._analyze_company_safe.return_value = mock_result
|
||||
|
||||
with patch("SPARC.scheduler.get_db_client", return_value=mock_db), \
|
||||
patch("SPARC.scheduler.CompanyAnalyzer", return_value=mock_analyzer):
|
||||
from SPARC.scheduler import run_scheduled_analysis
|
||||
run_scheduled_analysis()
|
||||
|
||||
mock_db.store_alert.assert_called_once()
|
||||
alert_kwargs = mock_db.store_alert.call_args
|
||||
assert alert_kwargs[1]["company_name"] == "Tesla"
|
||||
assert alert_kwargs[1]["alert_type"] == "patent_count_change"
|
||||
assert alert_kwargs[1]["old_value"] == 100
|
||||
assert alert_kwargs[1]["new_value"] == 130
|
||||
|
||||
def test_scheduler_no_alert_for_small_change(self):
|
||||
"""Scheduler does not alert when change is below threshold."""
|
||||
mock_db = MagicMock()
|
||||
mock_db.list_tracked_companies.return_value = [
|
||||
{"company_name": "Intel", "last_patent_count": 100},
|
||||
]
|
||||
|
||||
mock_result = MagicMock(success=True, patent_count=105) # 5% increase
|
||||
mock_analyzer = MagicMock()
|
||||
mock_analyzer._analyze_company_safe.return_value = mock_result
|
||||
|
||||
with patch("SPARC.scheduler.get_db_client", return_value=mock_db), \
|
||||
patch("SPARC.scheduler.CompanyAnalyzer", return_value=mock_analyzer):
|
||||
from SPARC.scheduler import run_scheduled_analysis
|
||||
run_scheduled_analysis()
|
||||
|
||||
mock_db.store_alert.assert_not_called()
|
||||
|
||||
def test_scheduler_handles_analysis_failure(self):
|
||||
"""Scheduler continues when one company fails analysis."""
|
||||
mock_db = MagicMock()
|
||||
mock_db.list_tracked_companies.return_value = [
|
||||
{"company_name": "FailCo", "last_patent_count": 50},
|
||||
{"company_name": "SuccessCo", "last_patent_count": 30},
|
||||
]
|
||||
|
||||
mock_fail_result = MagicMock(success=False, error="API timeout")
|
||||
mock_ok_result = MagicMock(success=True, patent_count=35)
|
||||
mock_analyzer = MagicMock()
|
||||
mock_analyzer._analyze_company_safe.side_effect = [mock_fail_result, mock_ok_result]
|
||||
|
||||
with patch("SPARC.scheduler.get_db_client", return_value=mock_db), \
|
||||
patch("SPARC.scheduler.CompanyAnalyzer", return_value=mock_analyzer):
|
||||
from SPARC.scheduler import run_scheduled_analysis
|
||||
run_scheduled_analysis()
|
||||
|
||||
# FailCo should not get updated, SuccessCo should
|
||||
mock_db.update_tracked_company.assert_called_once_with("SuccessCo", 35)
|
||||
|
||||
def test_scheduler_handles_exception_in_analysis(self):
|
||||
"""Scheduler continues even when analysis raises an exception."""
|
||||
mock_db = MagicMock()
|
||||
mock_db.list_tracked_companies.return_value = [
|
||||
{"company_name": "CrashCo", "last_patent_count": 10},
|
||||
{"company_name": "OKCo", "last_patent_count": 20},
|
||||
]
|
||||
|
||||
mock_ok_result = MagicMock(success=True, patent_count=22)
|
||||
mock_analyzer = MagicMock()
|
||||
mock_analyzer._analyze_company_safe.side_effect = [
|
||||
RuntimeError("unexpected error"),
|
||||
mock_ok_result,
|
||||
]
|
||||
|
||||
with patch("SPARC.scheduler.get_db_client", return_value=mock_db), \
|
||||
patch("SPARC.scheduler.CompanyAnalyzer", return_value=mock_analyzer):
|
||||
from SPARC.scheduler import run_scheduled_analysis
|
||||
run_scheduled_analysis()
|
||||
|
||||
# OKCo should still be processed
|
||||
mock_db.update_tracked_company.assert_called_once_with("OKCo", 22)
|
||||
@@ -0,0 +1,280 @@
|
||||
"""Tests for webhook notification system: retry logic and Slack/Discord payload format.
|
||||
|
||||
Covers issue #1657:
|
||||
- Retry logic with exponential backoff in _send_with_retry
|
||||
- Slack/Discord payload formatting in _build_payload
|
||||
- Generic HTTP POST payload formatting
|
||||
- notify() dispatching to multiple URLs
|
||||
- notify_job_completed() and notify_alert() convenience helpers
|
||||
"""
|
||||
|
||||
from datetime import datetime
|
||||
from unittest.mock import MagicMock, patch, call
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
from SPARC.webhooks import (
|
||||
MAX_RETRIES,
|
||||
_build_payload,
|
||||
_is_slack_url,
|
||||
_send_with_retry,
|
||||
notify,
|
||||
notify_alert,
|
||||
notify_job_completed,
|
||||
)
|
||||
|
||||
|
||||
class TestIsSlackUrl:
|
||||
"""Tests for Slack/Discord URL detection."""
|
||||
|
||||
def test_slack_webhook_url(self):
|
||||
assert _is_slack_url("https://hooks.slack.com/services/T00/B00/xxx") is True
|
||||
|
||||
def test_discord_webhook_url(self):
|
||||
assert _is_slack_url("https://discord.com/api/webhooks/123/abc") is True
|
||||
|
||||
def test_generic_url(self):
|
||||
assert _is_slack_url("https://example.com/webhook") is False
|
||||
|
||||
def test_empty_url(self):
|
||||
assert _is_slack_url("") is False
|
||||
|
||||
|
||||
class TestBuildPayload:
|
||||
"""Tests for payload construction."""
|
||||
|
||||
def test_generic_payload_structure(self):
|
||||
"""Generic payload includes event type, timestamp, and data."""
|
||||
payload = _build_payload("job_completed", {"job_id": "abc123"})
|
||||
|
||||
assert payload["event"] == "job_completed"
|
||||
assert payload["job_id"] == "abc123"
|
||||
assert "timestamp" in payload
|
||||
# Timestamp should be ISO format ending with Z
|
||||
assert payload["timestamp"].endswith("Z")
|
||||
|
||||
def test_slack_payload_wraps_in_text(self):
|
||||
"""Slack payload wraps content in a 'text' field."""
|
||||
payload = _build_payload("patent_alert", {"company_name": "NVIDIA"}, slack=True)
|
||||
|
||||
assert "text" in payload
|
||||
assert "patent_alert" in payload["text"]
|
||||
assert "NVIDIA" in payload["text"]
|
||||
# Slack payload should NOT have the event/timestamp at top level
|
||||
assert "event" not in payload
|
||||
assert "timestamp" not in payload
|
||||
|
||||
def test_generic_payload_does_not_have_text_field(self):
|
||||
"""Non-Slack payload does not wrap in text."""
|
||||
payload = _build_payload("job_completed", {"status": "done"})
|
||||
|
||||
assert "text" not in payload
|
||||
assert payload["status"] == "done"
|
||||
|
||||
def test_slack_payload_contains_bold_header(self):
|
||||
"""Slack payload starts with bold event header using Slack markdown."""
|
||||
payload = _build_payload("job_completed", {"count": 5}, slack=True)
|
||||
|
||||
assert payload["text"].startswith("*[SPARC] job_completed*")
|
||||
|
||||
def test_payload_merges_all_data_keys(self):
|
||||
"""All data keys are included in the generic payload."""
|
||||
data = {"key1": "val1", "key2": 42, "key3": True}
|
||||
payload = _build_payload("test_event", data)
|
||||
|
||||
assert payload["key1"] == "val1"
|
||||
assert payload["key2"] == 42
|
||||
assert payload["key3"] is True
|
||||
|
||||
|
||||
class TestSendWithRetry:
|
||||
"""Tests for retry logic in _send_with_retry."""
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_success_on_first_attempt(self, mock_post, mock_sleep):
|
||||
"""Successful delivery on first attempt, no retries."""
|
||||
mock_post.return_value = MagicMock(status_code=200)
|
||||
|
||||
result = _send_with_retry("https://example.com/hook", {"event": "test"})
|
||||
|
||||
assert result is True
|
||||
mock_post.assert_called_once()
|
||||
mock_sleep.assert_not_called()
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_success_on_second_attempt(self, mock_post, mock_sleep):
|
||||
"""Fails first, succeeds on retry."""
|
||||
mock_post.side_effect = [
|
||||
MagicMock(status_code=500),
|
||||
MagicMock(status_code=200),
|
||||
]
|
||||
|
||||
result = _send_with_retry("https://example.com/hook", {"event": "test"})
|
||||
|
||||
assert result is True
|
||||
assert mock_post.call_count == 2
|
||||
mock_sleep.assert_called_once()
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_all_retries_exhausted(self, mock_post, mock_sleep):
|
||||
"""Returns False after all retries fail."""
|
||||
mock_post.return_value = MagicMock(status_code=500)
|
||||
|
||||
result = _send_with_retry("https://example.com/hook", {"event": "test"})
|
||||
|
||||
assert result is False
|
||||
assert mock_post.call_count == MAX_RETRIES
|
||||
assert mock_sleep.call_count == MAX_RETRIES - 1
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_exponential_backoff_timing(self, mock_post, mock_sleep):
|
||||
"""Backoff wait times follow exponential pattern (2^attempt)."""
|
||||
mock_post.return_value = MagicMock(status_code=500)
|
||||
|
||||
_send_with_retry("https://example.com/hook", {"event": "test"})
|
||||
|
||||
# With BACKOFF_BASE=2: attempt 1 -> sleep(2), attempt 2 -> sleep(4)
|
||||
expected_waits = [call(2 ** i) for i in range(1, MAX_RETRIES)]
|
||||
assert mock_sleep.call_args_list == expected_waits
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_network_error_triggers_retry(self, mock_post, mock_sleep):
|
||||
"""Network exceptions trigger retry, not immediate failure."""
|
||||
mock_post.side_effect = [
|
||||
requests.ConnectionError("Connection refused"),
|
||||
MagicMock(status_code=200),
|
||||
]
|
||||
|
||||
result = _send_with_retry("https://example.com/hook", {"event": "test"})
|
||||
|
||||
assert result is True
|
||||
assert mock_post.call_count == 2
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_timeout_error_triggers_retry(self, mock_post, mock_sleep):
|
||||
"""Timeout exceptions trigger retry."""
|
||||
mock_post.side_effect = [
|
||||
requests.Timeout("Request timed out"),
|
||||
MagicMock(status_code=200),
|
||||
]
|
||||
|
||||
result = _send_with_retry("https://example.com/hook", {"event": "test"})
|
||||
|
||||
assert result is True
|
||||
assert mock_post.call_count == 2
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_2xx_status_codes_accepted(self, mock_post, mock_sleep):
|
||||
"""Any 2xx status code is treated as success."""
|
||||
mock_post.return_value = MagicMock(status_code=204)
|
||||
|
||||
result = _send_with_retry("https://example.com/hook", {"event": "test"})
|
||||
|
||||
assert result is True
|
||||
mock_post.assert_called_once()
|
||||
|
||||
@patch("SPARC.webhooks.time.sleep")
|
||||
@patch("SPARC.webhooks.requests.post")
|
||||
def test_posts_json_payload(self, mock_post, mock_sleep):
|
||||
"""Payload is sent as JSON with correct timeout."""
|
||||
mock_post.return_value = MagicMock(status_code=200)
|
||||
payload = {"event": "test", "data": "value"}
|
||||
|
||||
_send_with_retry("https://example.com/hook", payload)
|
||||
|
||||
mock_post.assert_called_once_with(
|
||||
"https://example.com/hook", json=payload, timeout=10
|
||||
)
|
||||
|
||||
|
||||
class TestNotify:
|
||||
"""Tests for the notify() dispatcher."""
|
||||
|
||||
@patch("SPARC.webhooks._send_with_retry")
|
||||
@patch("SPARC.webhooks.WEBHOOK_URLS", ["https://example.com/hook1", "https://example.com/hook2"])
|
||||
def test_dispatches_to_all_urls(self, mock_send):
|
||||
"""notify() sends to every configured webhook URL."""
|
||||
mock_send.return_value = True
|
||||
|
||||
notify("job_completed", {"job_id": "test123"})
|
||||
|
||||
assert mock_send.call_count == 2
|
||||
|
||||
@patch("SPARC.webhooks._send_with_retry")
|
||||
@patch("SPARC.webhooks.WEBHOOK_URLS", [])
|
||||
def test_no_urls_configured_returns_immediately(self, mock_send):
|
||||
"""No-op when no webhook URLs are configured."""
|
||||
notify("job_completed", {"job_id": "test123"})
|
||||
|
||||
mock_send.assert_not_called()
|
||||
|
||||
@patch("SPARC.webhooks._send_with_retry")
|
||||
@patch("SPARC.webhooks.WEBHOOK_URLS", [
|
||||
"https://hooks.slack.com/services/T00/B00/xxx",
|
||||
"https://example.com/generic",
|
||||
])
|
||||
def test_slack_url_gets_slack_payload(self, mock_send):
|
||||
"""Slack URLs receive Slack-formatted payloads, others get generic."""
|
||||
mock_send.return_value = True
|
||||
|
||||
notify("test_event", {"key": "val"})
|
||||
|
||||
# First call (Slack URL) should have "text" key
|
||||
slack_payload = mock_send.call_args_list[0][0][1]
|
||||
assert "text" in slack_payload
|
||||
|
||||
# Second call (generic URL) should have "event" key
|
||||
generic_payload = mock_send.call_args_list[1][0][1]
|
||||
assert "event" in generic_payload
|
||||
assert generic_payload["event"] == "test_event"
|
||||
|
||||
|
||||
class TestNotifyJobCompleted:
|
||||
"""Tests for notify_job_completed() convenience function."""
|
||||
|
||||
@patch("SPARC.webhooks.notify")
|
||||
def test_sends_correct_event_and_data(self, mock_notify):
|
||||
"""Job completion sends proper event type and summary."""
|
||||
notify_job_completed(
|
||||
job_id="batch-001",
|
||||
status="completed",
|
||||
total_companies=10,
|
||||
successful=8,
|
||||
failed=2,
|
||||
)
|
||||
|
||||
mock_notify.assert_called_once()
|
||||
event, data = mock_notify.call_args[0]
|
||||
assert event == "job_completed"
|
||||
assert data["job_id"] == "batch-001"
|
||||
assert data["successful"] == 8
|
||||
assert data["failed"] == 2
|
||||
assert "8/10" in data["summary"]
|
||||
|
||||
|
||||
class TestNotifyAlert:
|
||||
"""Tests for notify_alert() convenience function."""
|
||||
|
||||
@patch("SPARC.webhooks.notify")
|
||||
def test_sends_correct_event_and_data(self, mock_notify):
|
||||
"""Alert notification sends patent_alert event type."""
|
||||
notify_alert(
|
||||
company_name="NVIDIA",
|
||||
alert_type="patent_count_change",
|
||||
message="Patent count increased by 30%",
|
||||
)
|
||||
|
||||
mock_notify.assert_called_once()
|
||||
event, data = mock_notify.call_args[0]
|
||||
assert event == "patent_alert"
|
||||
assert data["company_name"] == "NVIDIA"
|
||||
assert data["alert_type"] == "patent_count_change"
|
||||
assert "30%" in data["message"]
|
||||
Reference in New Issue
Block a user