forked from 0xWheatyz/SPARC
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 7c6eed8d72 |
+30
-37
@@ -81,57 +81,50 @@ Items that have been implemented and merged into main.
|
|||||||
- ~~OpenAPI client generation.~~ TypeScript API client auto-generated from
|
- ~~OpenAPI client generation.~~ TypeScript API client auto-generated from
|
||||||
FastAPI spec with CI freshness check.
|
FastAPI spec with CI freshness check.
|
||||||
|
|
||||||
|
### Resilience
|
||||||
|
|
||||||
|
- ~~`_jobs` dict is in-memory only.~~ Database-backed job persistence
|
||||||
|
implemented using `db.list_jobs()` and `mark_stale_jobs_failed()`. The
|
||||||
|
in-memory `_jobs` dict has been removed.
|
||||||
|
|
||||||
|
### Test coverage (P1/P2)
|
||||||
|
|
||||||
|
- ~~Export endpoint tests.~~ Tests added for CSV and PDF export endpoints.
|
||||||
|
- ~~Tracked company admin endpoint tests.~~ Tests added for `/admin/tracked`
|
||||||
|
CRUD endpoints and scheduler integration.
|
||||||
|
- ~~Webhook integration tests.~~ Tests added for retry logic, Slack/Discord
|
||||||
|
payload format, and multi-URL dispatch.
|
||||||
|
- ~~S3/MinIO storage backend tests.~~ Unit tests added for the S3 backend
|
||||||
|
(read, write, exists, delete, error handling).
|
||||||
|
- ~~`analyze_single_patent` auto-download path tests.~~ Tests added for the
|
||||||
|
auto-download fallback (cache lookup, PDF download, FileNotFoundError).
|
||||||
|
|
||||||
|
### Code quality
|
||||||
|
|
||||||
|
- ~~Scheduler creates its own DatabaseClient.~~ Refactored to use the
|
||||||
|
application-level pooled `get_db_client()`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## P1 -- High Priority
|
## P1 -- High Priority
|
||||||
|
|
||||||
These items address correctness, reliability, and coverage gaps that should be
|
No outstanding P1 items. All previously listed items have been completed and
|
||||||
resolved before broader production use.
|
moved to the Completed section above.
|
||||||
|
|
||||||
### Resilience
|
|
||||||
|
|
||||||
- **`_jobs` dict is in-memory only.** Job state is lost on API restart.
|
|
||||||
Persist job status in PostgreSQL or Redis so async batch results survive
|
|
||||||
restarts.
|
|
||||||
|
|
||||||
### Test coverage gaps
|
|
||||||
|
|
||||||
- **Export endpoint tests.** The CSV and PDF export endpoints (`/export/`)
|
|
||||||
lack test coverage. Add tests covering auth, success, 404, and edge cases.
|
|
||||||
*(Issue #1655)*
|
|
||||||
- **Tracked company admin endpoint tests.** The `/admin/tracked` CRUD
|
|
||||||
endpoints and scheduler integration lack test coverage. *(Issue #1656)*
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## P2 -- Medium Priority
|
## P2 -- Medium Priority
|
||||||
|
|
||||||
Improvements to reliability, test coverage, and code quality.
|
Improvements to the API surface.
|
||||||
|
|
||||||
### Test coverage
|
|
||||||
|
|
||||||
- **Webhook integration tests.** The retry logic, Slack/Discord payload
|
|
||||||
format, and multi-URL dispatch in `webhooks.py` need test coverage.
|
|
||||||
*(Issue #1657)*
|
|
||||||
- **S3/MinIO storage backend tests.** `storage.py` has local filesystem tests
|
|
||||||
but no unit tests for the S3 backend (read, write, exists, delete,
|
|
||||||
error handling). *(Issue #1660)*
|
|
||||||
- **`analyze_single_patent` auto-download path tests.** The auto-download
|
|
||||||
fallback (cache lookup, PDF download, FileNotFoundError) in
|
|
||||||
`analyzer.py` lacks test coverage. *(Issue #1661)*
|
|
||||||
|
|
||||||
### Code quality
|
|
||||||
|
|
||||||
- **Scheduler creates its own DatabaseClient.** `scheduler.py` bypasses the
|
|
||||||
application-level pooled client, creating a new connection on every tick.
|
|
||||||
Refactor to use `get_db_client()`. *(Issue #1658)*
|
|
||||||
|
|
||||||
### API improvements
|
### API improvements
|
||||||
|
|
||||||
- **API pagination.** The `/analyze/batch` and `/jobs` endpoints could benefit
|
- **API pagination.** The `/analyze/batch` endpoint needs cursor-based
|
||||||
from cursor-based pagination for large result sets.
|
pagination for large result sets. The `/jobs` endpoint already has cursor
|
||||||
|
pagination. *(Issue #1669)*
|
||||||
- **Request validation improvements.** Add stricter input validation for
|
- **Request validation improvements.** Add stricter input validation for
|
||||||
company names (disallow special characters, enforce length limits).
|
company names (disallow special characters, enforce length limits).
|
||||||
|
*(Issue #1670)*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+9
-19
@@ -12,10 +12,10 @@ from typing import TYPE_CHECKING, Annotated, List
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from SPARC.database import DatabaseClient
|
from SPARC.database import DatabaseClient
|
||||||
|
|
||||||
from fastapi import BackgroundTasks, Depends, FastAPI, HTTPException, Path, Query, Request
|
from fastapi import BackgroundTasks, Depends, FastAPI, HTTPException, Query, Request
|
||||||
from fastapi.middleware.cors import CORSMiddleware
|
from fastapi.middleware.cors import CORSMiddleware
|
||||||
from fastapi.responses import JSONResponse, StreamingResponse
|
from fastapi.responses import JSONResponse, StreamingResponse
|
||||||
from pydantic import BaseModel, EmailStr, Field, StringConstraints
|
from pydantic import BaseModel, EmailStr, Field
|
||||||
from slowapi import Limiter
|
from slowapi import Limiter
|
||||||
from slowapi.errors import RateLimitExceeded
|
from slowapi.errors import RateLimitExceeded
|
||||||
from slowapi.util import get_remote_address
|
from slowapi.util import get_remote_address
|
||||||
@@ -36,16 +36,6 @@ from SPARC.auth import (
|
|||||||
)
|
)
|
||||||
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult
|
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult
|
||||||
|
|
||||||
# Validated company name type: 2-100 chars, alphanumeric + spaces/hyphens/ampersands/periods only.
|
|
||||||
CompanyName = Annotated[
|
|
||||||
str,
|
|
||||||
StringConstraints(
|
|
||||||
min_length=2,
|
|
||||||
max_length=100,
|
|
||||||
pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$",
|
|
||||||
),
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
# Pydantic models for API
|
# Pydantic models for API
|
||||||
class CompanyAnalysisResponse(BaseModel):
|
class CompanyAnalysisResponse(BaseModel):
|
||||||
@@ -82,7 +72,7 @@ class CompanyAnalysisRequest(BaseModel):
|
|||||||
class BatchAnalysisRequest(BaseModel):
|
class BatchAnalysisRequest(BaseModel):
|
||||||
"""Request model for batch company analysis."""
|
"""Request model for batch company analysis."""
|
||||||
|
|
||||||
companies: list[CompanyName] = Field(
|
companies: list[str] = Field(
|
||||||
..., min_length=1, max_length=20, description="List of company names to analyze"
|
..., min_length=1, max_length=20, description="List of company names to analyze"
|
||||||
)
|
)
|
||||||
max_workers: int = Field(
|
max_workers: int = Field(
|
||||||
@@ -415,7 +405,7 @@ async def delete_user(
|
|||||||
class TrackCompanyRequest(BaseModel):
|
class TrackCompanyRequest(BaseModel):
|
||||||
"""Request to add a company to tracking."""
|
"""Request to add a company to tracking."""
|
||||||
|
|
||||||
company_name: CompanyName = Field(...)
|
company_name: str = Field(..., min_length=1, max_length=255)
|
||||||
|
|
||||||
|
|
||||||
@app.get("/admin/tracked", tags=["Admin"])
|
@app.get("/admin/tracked", tags=["Admin"])
|
||||||
@@ -442,7 +432,7 @@ async def add_tracked_company(
|
|||||||
|
|
||||||
@app.delete("/admin/tracked/{company_name}", tags=["Admin"])
|
@app.delete("/admin/tracked/{company_name}", tags=["Admin"])
|
||||||
async def remove_tracked_company(
|
async def remove_tracked_company(
|
||||||
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
company_name: str,
|
||||||
_: UserResponse = Depends(get_current_admin),
|
_: UserResponse = Depends(get_current_admin),
|
||||||
):
|
):
|
||||||
"""Remove a company from the tracked list (admin only)."""
|
"""Remove a company from the tracked list (admin only)."""
|
||||||
@@ -600,7 +590,7 @@ async def get_analytics_trends(
|
|||||||
|
|
||||||
@app.get("/export/{company_name}", tags=["Export"])
|
@app.get("/export/{company_name}", tags=["Export"])
|
||||||
async def export_company_csv(
|
async def export_company_csv(
|
||||||
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
company_name: str,
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Export analysis results for a company as a CSV file.
|
"""Export analysis results for a company as a CSV file.
|
||||||
@@ -652,7 +642,7 @@ async def export_company_csv(
|
|||||||
|
|
||||||
@app.get("/export/{company_name}/pdf", tags=["Export"])
|
@app.get("/export/{company_name}/pdf", tags=["Export"])
|
||||||
async def export_company_pdf(
|
async def export_company_pdf(
|
||||||
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
company_name: str,
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Export analysis results for a company as a formatted PDF report.
|
"""Export analysis results for a company as a formatted PDF report.
|
||||||
@@ -826,7 +816,7 @@ async def health_check():
|
|||||||
tags=["Analysis"],
|
tags=["Analysis"],
|
||||||
)
|
)
|
||||||
async def analyze_company(
|
async def analyze_company(
|
||||||
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
company_name: str,
|
||||||
model: str | None = Query(default=None, description="LLM model to use (e.g. 'openai/gpt-4o'). Defaults to server config."),
|
model: str | None = Query(default=None, description="LLM model to use (e.g. 'openai/gpt-4o'). Defaults to server config."),
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
@@ -856,7 +846,7 @@ async def analyze_company(
|
|||||||
)
|
)
|
||||||
async def analyze_single_patent(
|
async def analyze_single_patent(
|
||||||
patent_id: str,
|
patent_id: str,
|
||||||
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")],
|
company_name: str = Query(description="Company name for analysis context"),
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Analyze a single patent by its publication ID.
|
"""Analyze a single patent by its publication ID.
|
||||||
|
|||||||
@@ -1,157 +0,0 @@
|
|||||||
"""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
|
|
||||||
Reference in New Issue
Block a user