forked from 0xWheatyz/SPARC
Compare commits
51 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ab3964b18d | |||
| 313800215c | |||
| 222f29deb1 | |||
| e6d95bbf57 | |||
| 68484ef4b1 | |||
| a0cb9a5773 | |||
| 857b3444df | |||
| a95129904e | |||
| 7c6eed8d72 | |||
| 4c411e1e0b | |||
| 6165d66760 | |||
| e610dea9a9 | |||
| b5f10d2032 | |||
| b5d8b0b344 | |||
| 1170356b2b | |||
| 84341b3ec4 | |||
| 0639fb3649 | |||
| b032bf0c90 | |||
| a2f81b0396 | |||
| 63ca18e9bf | |||
| 4cb1a6ed21 | |||
| 417b7ab31e | |||
| 2eabb1d704 | |||
| fc942b2aa4 | |||
| 44a162056d | |||
| a07a0c7fbe | |||
| 43fd2c9575 | |||
| d4d43cf9b8 | |||
| 2f2b6382fa | |||
| 1319530f04 | |||
| b32eebff8a | |||
|
68ee19025a
|
|||
|
ef97710d1c
|
|||
|
88812b5967
|
|||
|
90e58949fc
|
|||
|
bd10925c97
|
|||
|
89fec43aa2
|
|||
|
02e1c41126
|
|||
|
c17a0d006a
|
|||
|
c6760a39a1
|
|||
|
2ae6280566
|
|||
|
9745ed75a8
|
|||
|
c649eaf343
|
|||
| 7e66d0e7e0 | |||
| 71465401c6 | |||
| 97048917f2 | |||
| 88abd9574b | |||
| e0ed39908e | |||
| 87e09b365b | |||
| 5d11f514c0 | |||
| cbc8f449a1 |
@@ -15,7 +15,7 @@ jobs:
|
|||||||
- name: Install system dependencies
|
- name: Install system dependencies
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
apk add --no-cache git python3 py3-pip gcc musl-dev libpq-dev python3-dev
|
apt-get update && apt-get install -y git python3 python3-pip gcc libpq-dev python3-dev
|
||||||
|
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
shell: sh
|
shell: sh
|
||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Install Python dependencies
|
- name: Install Python dependencies
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
pip3 install --break-system-packages -r requirements.txt ruff
|
pip3 install -r requirements.txt ruff
|
||||||
|
|
||||||
- name: Run ruff linter
|
- name: Run ruff linter
|
||||||
shell: sh
|
shell: sh
|
||||||
@@ -36,7 +36,7 @@ jobs:
|
|||||||
- name: Install Node.js and check TypeScript types
|
- name: Install Node.js and check TypeScript types
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
apk add --no-cache nodejs npm
|
apt-get install -y nodejs npm
|
||||||
cd frontend
|
cd frontend
|
||||||
npm ci
|
npm ci
|
||||||
npm run generate:local
|
npm run generate:local
|
||||||
@@ -56,6 +56,7 @@ jobs:
|
|||||||
JWT_SECRET: "test-secret-for-ci"
|
JWT_SECRET: "test-secret-for-ci"
|
||||||
APP_ENV: "development"
|
APP_ENV: "development"
|
||||||
run: |
|
run: |
|
||||||
|
pip3 install pytest
|
||||||
python3 -m pytest tests/ -v --tb=short -x
|
python3 -m pytest tests/ -v --tb=short -x
|
||||||
|
|
||||||
build-api:
|
build-api:
|
||||||
@@ -65,7 +66,7 @@ jobs:
|
|||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
apk add --no-cache git docker-cli
|
apt-get update && apt-get install -y git docker.io
|
||||||
|
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
shell: sh
|
shell: sh
|
||||||
@@ -137,7 +138,7 @@ jobs:
|
|||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
apk add --no-cache git docker-cli
|
apt-get update && apt-get install -y git docker.io
|
||||||
|
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
shell: sh
|
shell: sh
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ jobs:
|
|||||||
- name: Install system dependencies
|
- name: Install system dependencies
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
apk add --no-cache git python3 py3-pip gcc musl-dev libpq-dev python3-dev
|
apt-get update && apt-get install -y git python3 python3-pip gcc libpq-dev python3-dev
|
||||||
|
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
shell: sh
|
shell: sh
|
||||||
@@ -27,7 +27,7 @@ jobs:
|
|||||||
- name: Install Python dependencies
|
- name: Install Python dependencies
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
pip3 install --break-system-packages -r requirements.txt ruff
|
pip3 install -r requirements.txt ruff
|
||||||
|
|
||||||
- name: Run ruff linter
|
- name: Run ruff linter
|
||||||
shell: sh
|
shell: sh
|
||||||
@@ -37,7 +37,7 @@ jobs:
|
|||||||
- name: Install Node.js and frontend dependencies
|
- name: Install Node.js and frontend dependencies
|
||||||
shell: sh
|
shell: sh
|
||||||
run: |
|
run: |
|
||||||
apk add --no-cache nodejs npm
|
apt-get install -y nodejs npm
|
||||||
cd frontend && npm ci
|
cd frontend && npm ci
|
||||||
|
|
||||||
- name: Verify generated API types are up to date
|
- name: Verify generated API types are up to date
|
||||||
|
|||||||
+120
-85
@@ -7,86 +7,124 @@ Semiconductor Patent & Analytics Report Core -- development priorities.
|
|||||||
SPARC is a patent analysis platform with a working end-to-end pipeline:
|
SPARC is a patent analysis platform with a working end-to-end pipeline:
|
||||||
Python/FastAPI backend, React/TypeScript frontend, PostgreSQL for persistence
|
Python/FastAPI backend, React/TypeScript frontend, PostgreSQL for persistence
|
||||||
and caching, Docker Compose for local development, and Gitea Actions CI/CD for
|
and caching, Docker Compose for local development, and Gitea Actions CI/CD for
|
||||||
image builds. Core features (patent retrieval via SerpAPI, PDF parsing, LLM
|
image builds and testing. Core features include patent retrieval via SerpAPI,
|
||||||
analysis via OpenRouter/Claude, batch processing, JWT authentication, analytics
|
PDF parsing, LLM analysis via OpenRouter (multi-model: Claude, GPT-4o, Gemini,
|
||||||
dashboard) are all implemented and functional.
|
Llama), batch processing, JWT authentication, analytics dashboard with patent
|
||||||
|
trend charts, scheduled recurring analysis with alerting, webhook notifications
|
||||||
|
(Slack/Discord), CSV and PDF export, S3/MinIO storage, side-by-side company
|
||||||
|
comparison, and dark mode.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Completed
|
||||||
|
|
||||||
|
Items that have been implemented and merged into main.
|
||||||
|
|
||||||
|
### Security hardening
|
||||||
|
|
||||||
|
- ~~Rotate default JWT secret.~~ Startup check refuses to start with the
|
||||||
|
default secret in non-development environments.
|
||||||
|
- ~~CORS allow-origins are hardcoded.~~ Allowed origins are now configurable
|
||||||
|
via environment variable.
|
||||||
|
- ~~Database credentials in docker-compose.yml.~~ Compose references `.env`
|
||||||
|
for sensitive values.
|
||||||
|
|
||||||
|
### Error handling and resilience
|
||||||
|
|
||||||
|
- ~~`get_db_client()` creates a new `DatabaseClient` on every call.~~ Refactored
|
||||||
|
to a shared pooled singleton initialized at startup.
|
||||||
|
- ~~No rate limiting on auth endpoints.~~ Rate limiting middleware added to
|
||||||
|
`/auth/login` and `/auth/register`.
|
||||||
|
|
||||||
|
### Test coverage
|
||||||
|
|
||||||
|
- ~~API tests bypass authentication.~~ JWT auth integration tests added (33
|
||||||
|
cases covering registration, login, protected routes, token refresh, and
|
||||||
|
admin-only endpoints).
|
||||||
|
- ~~No test stage in CI.~~ Gitea Actions workflow now runs `pytest` and gates
|
||||||
|
the build.
|
||||||
|
- ~~No linting or type checking in CI.~~ `ruff` (Python) and `tsc --noEmit`
|
||||||
|
(TypeScript) added to CI pipeline.
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
- ~~Add structured logging.~~ Python `logging` module used throughout.
|
||||||
|
- ~~Make LLM model configurable.~~ `MODEL` environment variable accepted;
|
||||||
|
multi-model support with per-analysis selection (GPT-4o, Gemini, Claude,
|
||||||
|
Llama).
|
||||||
|
- ~~SERP cache TTL hardcoded.~~ `SERP_CACHE_TTL_HOURS` exposed as env var.
|
||||||
|
- ~~Patent PDF storage.~~ S3/MinIO object storage backend added alongside
|
||||||
|
local filesystem. Volume mount requirement documented.
|
||||||
|
- ~~`analyze_single_patent` assumes local file.~~ Auto-download from cached
|
||||||
|
metadata link integrated.
|
||||||
|
- ~~`Patent.patent_id` typed as `int`.~~ Fixed to `str`.
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
- ~~No loading/error states.~~ Skeleton loaders and error states added to
|
||||||
|
Batch and Analytics pages.
|
||||||
|
- ~~No dark mode.~~ Full dark mode support with theme-aware chart colors.
|
||||||
|
- ~~Missing lockfile.~~ `package-lock.json` committed.
|
||||||
|
|
||||||
|
### Features (formerly P3)
|
||||||
|
|
||||||
|
- ~~Export analysis reports.~~ CSV and PDF export endpoints implemented.
|
||||||
|
- ~~Comparison view.~~ Side-by-side company patent portfolio comparison added.
|
||||||
|
- ~~Scheduled/recurring analysis.~~ APScheduler-based periodic re-analysis
|
||||||
|
with configurable interval and change-threshold alerting.
|
||||||
|
- ~~Webhook/notification support.~~ Slack, Discord, and generic HTTP POST
|
||||||
|
webhooks with retry logic.
|
||||||
|
- ~~Multi-model support.~~ Model picker in Analysis and Batch pages; backend
|
||||||
|
allow-list validation.
|
||||||
|
- ~~Patent trend charts.~~ Filing frequency and category distribution
|
||||||
|
visualizations added to Analytics page.
|
||||||
|
- ~~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
|
## P1 -- High Priority
|
||||||
|
|
||||||
These items address correctness, security, and reliability 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.
|
||||||
|
|
||||||
### Security hardening
|
|
||||||
|
|
||||||
- **Rotate default JWT secret.** `auth.py` ships a fallback
|
|
||||||
`sparc-secret-key-change-in-production` that will be used if `JWT_SECRET` is
|
|
||||||
unset. Add a startup check that refuses to start with the default secret in
|
|
||||||
non-development environments.
|
|
||||||
- **CORS allow-origins are hardcoded.** `api.py` only permits
|
|
||||||
`localhost:3000` and `localhost:5173`. Make the allowed origins configurable
|
|
||||||
via environment variable so the dashboard works when deployed behind a real
|
|
||||||
domain.
|
|
||||||
- **Database credentials in docker-compose.yml.** The compose file embeds
|
|
||||||
`postgres:postgres` in plain text. Reference a `.env` file or Docker secrets
|
|
||||||
instead.
|
|
||||||
|
|
||||||
### Error handling and resilience
|
|
||||||
|
|
||||||
- **`get_db_client()` in `auth.py` creates a new `DatabaseClient` on every
|
|
||||||
call.** This bypasses the connection pool and can exhaust database
|
|
||||||
connections under load. Refactor to share a single pooled client.
|
|
||||||
- **`_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.
|
|
||||||
- **No rate limiting on auth endpoints.** `/auth/login` and `/auth/register`
|
|
||||||
are unprotected against brute-force or abuse. Add rate limiting middleware.
|
|
||||||
|
|
||||||
### Test coverage for auth and admin
|
|
||||||
|
|
||||||
- The existing API tests (`tests/test_api.py`) bypass authentication entirely.
|
|
||||||
Add tests that exercise the JWT flow: registration, login, protected-route
|
|
||||||
access, token refresh, and admin-only endpoints.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## P2 -- Medium Priority
|
## P2 -- Medium Priority
|
||||||
|
|
||||||
Improvements to usability, performance, and developer experience.
|
Improvements to the API surface.
|
||||||
|
|
||||||
### Backend
|
### API improvements
|
||||||
|
|
||||||
- **Add structured logging.** Replace `print()` calls throughout `analyzer.py`,
|
- **API pagination.** The `/analyze/batch` endpoint needs cursor-based
|
||||||
`serp_api.py`, and `llm.py` with Python `logging` so log levels and
|
pagination for large result sets. The `/jobs` endpoint already has cursor
|
||||||
formatting are consistent.
|
pagination. *(Issue #1669)*
|
||||||
- **Make LLM model configurable.** `llm.py` hardcodes
|
- **Request validation improvements.** Add stricter input validation for
|
||||||
`anthropic/claude-3.5-sonnet`. Accept a `MODEL` environment variable to allow
|
company names (disallow special characters, enforce length limits).
|
||||||
switching models without code changes.
|
*(Issue #1670)*
|
||||||
- **SERP cache TTL is hardcoded to 24 hours.** Expose `SERP_CACHE_TTL_HOURS`
|
|
||||||
as an environment variable in `config.py`.
|
|
||||||
- **Patent PDF storage.** PDFs are saved to a local `patents/` directory. For
|
|
||||||
containerized deployments, consider object storage (S3/MinIO) or at minimum
|
|
||||||
document the volume mount requirement more prominently.
|
|
||||||
- **`analyze_single_patent` assumes local file path.** The method constructs
|
|
||||||
`patents/{patent_id}.pdf` and reads from disk, but does not download the PDF
|
|
||||||
first. Either integrate the download step or document the prerequisite.
|
|
||||||
- **`Patent.patent_id` typed as `int` in `types.py` but used as `str`
|
|
||||||
everywhere.** Fix the type annotation to `str`.
|
|
||||||
|
|
||||||
### Frontend
|
|
||||||
|
|
||||||
- **No loading/error states on several pages.** The Batch and Analytics pages
|
|
||||||
would benefit from skeleton loaders and user-friendly error messages.
|
|
||||||
- **No dark mode.** Tailwind is configured but no dark variant is applied.
|
|
||||||
- **Missing `package-lock.json` or `pnpm-lock.yaml`.** The frontend has no
|
|
||||||
lockfile committed, leading to non-reproducible builds.
|
|
||||||
|
|
||||||
### CI/CD
|
|
||||||
|
|
||||||
- **No test stage in the Gitea Actions workflow.** `build.yaml` builds and
|
|
||||||
pushes images but never runs `pytest`. Add a test job that gates the build.
|
|
||||||
- **No linting or type checking.** Add `ruff` (Python) and `tsc --noEmit`
|
|
||||||
(TypeScript) to CI.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -94,23 +132,20 @@ Improvements to usability, performance, and developer experience.
|
|||||||
|
|
||||||
Lower-urgency enhancements and future features.
|
Lower-urgency enhancements and future features.
|
||||||
|
|
||||||
- **Export analysis reports.** Allow users to download analysis results as PDF
|
- **Historical analysis diffing.** Show what changed between two analysis runs
|
||||||
or CSV from the dashboard.
|
for the same company, highlighting new patents and score shifts.
|
||||||
- **Comparison view.** Side-by-side comparison of two companies' patent
|
- **Patent classification tagging.** Automatically tag patents by technology
|
||||||
portfolios.
|
domain (AI, semiconductors, materials science) using LLM classification.
|
||||||
- **Scheduled/recurring analysis.** Periodically re-analyze tracked companies
|
- **User-level API keys.** Allow users to generate personal API keys for
|
||||||
and alert on significant changes.
|
programmatic access without JWT token refresh.
|
||||||
- **Webhook/notification support.** Send alerts (Slack, Discord, email) when
|
- **Batch export.** Export analysis results for multiple companies at once as
|
||||||
batch jobs complete or when a company's innovation score changes
|
a ZIP archive.
|
||||||
significantly.
|
- **Rate limiting dashboard.** Surface rate limit status and usage statistics
|
||||||
- **Multi-model support.** Let users choose between LLM providers per analysis
|
in the admin panel.
|
||||||
(e.g., GPT-4o, Gemini, Claude) and compare outputs.
|
- **Async webhook delivery.** Move webhook delivery to a background task queue
|
||||||
- **Patent trend charts.** Visualize patent filing frequency and technology
|
(e.g., Celery, arq) to avoid blocking the scheduler.
|
||||||
category distribution over time in the Analytics page.
|
- **Multi-tenant support.** Scope analysis results and tracked companies per
|
||||||
- **API pagination.** The `/analyze/batch` and `/jobs` endpoints could benefit
|
user or organization.
|
||||||
from cursor-based pagination for large result sets.
|
|
||||||
- **OpenAPI client generation.** Auto-generate the TypeScript API client from
|
|
||||||
the FastAPI OpenAPI spec to keep frontend types in sync.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -10,13 +10,13 @@ from concurrent.futures import ThreadPoolExecutor, as_completed
|
|||||||
from typing import Callable
|
from typing import Callable
|
||||||
|
|
||||||
from SPARC import config
|
from SPARC import config
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
from SPARC.database import DatabaseClient
|
from SPARC.database import DatabaseClient
|
||||||
from SPARC.llm import LLMAnalyzer
|
from SPARC.llm import LLMAnalyzer
|
||||||
from SPARC.serp_api import SERP
|
from SPARC.serp_api import SERP
|
||||||
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult, Patent, Patents
|
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult, Patent, Patents
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class CompanyAnalyzer:
|
class CompanyAnalyzer:
|
||||||
"""Orchestrates end-to-end company performance analysis via patents."""
|
"""Orchestrates end-to-end company performance analysis via patents."""
|
||||||
|
|||||||
+182
-17
@@ -3,14 +3,19 @@
|
|||||||
Provides REST API endpoints for analyzing company patent portfolios.
|
Provides REST API endpoints for analyzing company patent portfolios.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
from contextlib import asynccontextmanager
|
from contextlib import asynccontextmanager
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from typing import Annotated, List
|
from typing import TYPE_CHECKING, Annotated, List
|
||||||
|
|
||||||
from fastapi import BackgroundTasks, Depends, FastAPI, HTTPException, Query, Request
|
if TYPE_CHECKING:
|
||||||
|
from SPARC.database import DatabaseClient
|
||||||
|
|
||||||
|
from fastapi import BackgroundTasks, Depends, FastAPI, HTTPException, Path, Query, Request
|
||||||
from fastapi.middleware.cors import CORSMiddleware
|
from fastapi.middleware.cors import CORSMiddleware
|
||||||
from fastapi.responses import JSONResponse, StreamingResponse
|
from fastapi.responses import JSONResponse, StreamingResponse
|
||||||
from pydantic import BaseModel, EmailStr, Field
|
from pydantic import BaseModel, EmailStr, Field, StringConstraints
|
||||||
from slowapi import Limiter
|
from slowapi import Limiter
|
||||||
from slowapi.errors import RateLimitExceeded
|
from slowapi.errors import RateLimitExceeded
|
||||||
from slowapi.util import get_remote_address
|
from slowapi.util import get_remote_address
|
||||||
@@ -31,6 +36,16 @@ from SPARC.auth import (
|
|||||||
)
|
)
|
||||||
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult
|
from SPARC.types import BatchAnalysisResult, CompanyAnalysisResult
|
||||||
|
|
||||||
|
# Validated company name type: 2-100 chars, alphanumeric + spaces/hyphens/ampersands/periods only.
|
||||||
|
CompanyName = Annotated[
|
||||||
|
str,
|
||||||
|
StringConstraints(
|
||||||
|
min_length=2,
|
||||||
|
max_length=100,
|
||||||
|
pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
# Pydantic models for API
|
# Pydantic models for API
|
||||||
class CompanyAnalysisResponse(BaseModel):
|
class CompanyAnalysisResponse(BaseModel):
|
||||||
@@ -67,7 +82,7 @@ class CompanyAnalysisRequest(BaseModel):
|
|||||||
class BatchAnalysisRequest(BaseModel):
|
class BatchAnalysisRequest(BaseModel):
|
||||||
"""Request model for batch company analysis."""
|
"""Request model for batch company analysis."""
|
||||||
|
|
||||||
companies: list[str] = Field(
|
companies: list[CompanyName] = Field(
|
||||||
..., min_length=1, max_length=20, description="List of company names to analyze"
|
..., min_length=1, max_length=20, description="List of company names to analyze"
|
||||||
)
|
)
|
||||||
max_workers: int = Field(
|
max_workers: int = Field(
|
||||||
@@ -91,6 +106,24 @@ class JobStatus(BaseModel):
|
|||||||
error: str | None = None
|
error: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class AnalysisRecord(BaseModel):
|
||||||
|
"""A single stored analysis result."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
company_name: str | None = None
|
||||||
|
analysis_type: str | None = None
|
||||||
|
model: str | None = None
|
||||||
|
response: str | None = None
|
||||||
|
timestamp: datetime | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class PaginatedAnalysisResponse(BaseModel):
|
||||||
|
"""Paginated response for analysis result listings."""
|
||||||
|
|
||||||
|
items: list[AnalysisRecord]
|
||||||
|
next_cursor: str | None = None
|
||||||
|
|
||||||
|
|
||||||
class PaginatedJobsResponse(BaseModel):
|
class PaginatedJobsResponse(BaseModel):
|
||||||
"""Paginated response for job listings."""
|
"""Paginated response for job listings."""
|
||||||
|
|
||||||
@@ -191,11 +224,16 @@ async def lifespan(app: FastAPI):
|
|||||||
import logging
|
import logging
|
||||||
logging.getLogger(__name__).warning("Marked %d stale jobs as failed on startup", stale)
|
logging.getLogger(__name__).warning("Marked %d stale jobs as failed on startup", stale)
|
||||||
_db.close()
|
_db.close()
|
||||||
|
# Start webhook background worker
|
||||||
|
from SPARC.task_queue import start_worker as start_webhook_worker
|
||||||
|
from SPARC.task_queue import stop_worker as stop_webhook_worker
|
||||||
|
start_webhook_worker()
|
||||||
# Start scheduled analysis if tracked companies are configured
|
# Start scheduled analysis if tracked companies are configured
|
||||||
from SPARC.scheduler import start_scheduler
|
from SPARC.scheduler import start_scheduler
|
||||||
start_scheduler()
|
start_scheduler()
|
||||||
yield
|
yield
|
||||||
# Cleanup
|
# Cleanup
|
||||||
|
stop_webhook_worker()
|
||||||
_analyzer = None
|
_analyzer = None
|
||||||
close_db_client()
|
close_db_client()
|
||||||
|
|
||||||
@@ -212,10 +250,37 @@ app = FastAPI(
|
|||||||
limiter = Limiter(key_func=get_remote_address)
|
limiter = Limiter(key_func=get_remote_address)
|
||||||
app.state.limiter = limiter
|
app.state.limiter = limiter
|
||||||
|
|
||||||
|
# In-memory rate limit statistics
|
||||||
|
_rate_limit_stats: dict[str, dict] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def _track_rate_limit_request(endpoint: str, ip: str, rejected: bool = False) -> None:
|
||||||
|
"""Record a request against a rate-limited endpoint."""
|
||||||
|
key = endpoint
|
||||||
|
if key not in _rate_limit_stats:
|
||||||
|
_rate_limit_stats[key] = {
|
||||||
|
"endpoint": endpoint,
|
||||||
|
"total_requests": 0,
|
||||||
|
"rejected_requests": 0,
|
||||||
|
"by_ip": {},
|
||||||
|
}
|
||||||
|
_rate_limit_stats[key]["total_requests"] += 1
|
||||||
|
if rejected:
|
||||||
|
_rate_limit_stats[key]["rejected_requests"] += 1
|
||||||
|
ip_stats = _rate_limit_stats[key].setdefault("by_ip", {})
|
||||||
|
if ip not in ip_stats:
|
||||||
|
ip_stats[ip] = {"total": 0, "rejected": 0}
|
||||||
|
ip_stats[ip]["total"] += 1
|
||||||
|
if rejected:
|
||||||
|
ip_stats[ip]["rejected"] += 1
|
||||||
|
|
||||||
|
|
||||||
@app.exception_handler(RateLimitExceeded)
|
@app.exception_handler(RateLimitExceeded)
|
||||||
async def rate_limit_handler(request: Request, exc: RateLimitExceeded):
|
async def rate_limit_handler(request: Request, exc: RateLimitExceeded):
|
||||||
"""Return 429 with Retry-After header when rate limit is exceeded."""
|
"""Return 429 with Retry-After header when rate limit is exceeded."""
|
||||||
|
endpoint = request.url.path
|
||||||
|
ip = get_remote_address(request)
|
||||||
|
_track_rate_limit_request(endpoint, ip, rejected=True)
|
||||||
retry_after = getattr(exc, "retry_after", 60)
|
retry_after = getattr(exc, "retry_after", 60)
|
||||||
return JSONResponse(
|
return JSONResponse(
|
||||||
status_code=429,
|
status_code=429,
|
||||||
@@ -244,6 +309,7 @@ async def register(request: Request, body: RegisterRequest):
|
|||||||
|
|
||||||
The first registered user automatically becomes an admin.
|
The first registered user automatically becomes an admin.
|
||||||
"""
|
"""
|
||||||
|
_track_rate_limit_request("/auth/register", get_remote_address(request))
|
||||||
db = get_db_client()
|
db = get_db_client()
|
||||||
|
|
||||||
# First user becomes admin
|
# First user becomes admin
|
||||||
@@ -274,6 +340,7 @@ async def register(request: Request, body: RegisterRequest):
|
|||||||
@limiter.limit("10/minute")
|
@limiter.limit("10/minute")
|
||||||
async def login(request: Request, body: LoginRequest):
|
async def login(request: Request, body: LoginRequest):
|
||||||
"""Authenticate user and return JWT tokens."""
|
"""Authenticate user and return JWT tokens."""
|
||||||
|
_track_rate_limit_request("/auth/login", get_remote_address(request))
|
||||||
db = get_db_client()
|
db = get_db_client()
|
||||||
|
|
||||||
user = db.authenticate_user(body.email, body.password)
|
user = db.authenticate_user(body.email, body.password)
|
||||||
@@ -400,7 +467,7 @@ async def delete_user(
|
|||||||
class TrackCompanyRequest(BaseModel):
|
class TrackCompanyRequest(BaseModel):
|
||||||
"""Request to add a company to tracking."""
|
"""Request to add a company to tracking."""
|
||||||
|
|
||||||
company_name: str = Field(..., min_length=1, max_length=255)
|
company_name: CompanyName = Field(...)
|
||||||
|
|
||||||
|
|
||||||
@app.get("/admin/tracked", tags=["Admin"])
|
@app.get("/admin/tracked", tags=["Admin"])
|
||||||
@@ -427,7 +494,7 @@ async def add_tracked_company(
|
|||||||
|
|
||||||
@app.delete("/admin/tracked/{company_name}", tags=["Admin"])
|
@app.delete("/admin/tracked/{company_name}", tags=["Admin"])
|
||||||
async def remove_tracked_company(
|
async def remove_tracked_company(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
_: UserResponse = Depends(get_current_admin),
|
_: UserResponse = Depends(get_current_admin),
|
||||||
):
|
):
|
||||||
"""Remove a company from the tracked list (admin only)."""
|
"""Remove a company from the tracked list (admin only)."""
|
||||||
@@ -438,6 +505,36 @@ async def remove_tracked_company(
|
|||||||
return {"message": f"Stopped tracking {company_name}"}
|
return {"message": f"Stopped tracking {company_name}"}
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/admin/rate-limits", tags=["Admin"])
|
||||||
|
async def get_rate_limit_stats(
|
||||||
|
_: UserResponse = Depends(get_current_admin),
|
||||||
|
):
|
||||||
|
"""Get rate limit status and usage statistics (admin only).
|
||||||
|
|
||||||
|
Returns current rate limit configuration and request statistics
|
||||||
|
for all rate-limited endpoints.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of rate limit stats per endpoint with total/rejected counts
|
||||||
|
"""
|
||||||
|
rate_limits_config = {
|
||||||
|
"/auth/register": {"limit": "5/minute"},
|
||||||
|
"/auth/login": {"limit": "10/minute"},
|
||||||
|
}
|
||||||
|
|
||||||
|
results = []
|
||||||
|
for endpoint, conf in rate_limits_config.items():
|
||||||
|
stats = _rate_limit_stats.get(endpoint, {})
|
||||||
|
results.append({
|
||||||
|
"endpoint": endpoint,
|
||||||
|
"limit": conf["limit"],
|
||||||
|
"total_requests": stats.get("total_requests", 0),
|
||||||
|
"rejected_requests": stats.get("rejected_requests", 0),
|
||||||
|
})
|
||||||
|
|
||||||
|
return {"rate_limits": results}
|
||||||
|
|
||||||
|
|
||||||
@app.get("/admin/alerts", tags=["Admin"])
|
@app.get("/admin/alerts", tags=["Admin"])
|
||||||
async def list_alerts(
|
async def list_alerts(
|
||||||
limit: int = Query(default=50, ge=1, le=200),
|
limit: int = Query(default=50, ge=1, le=200),
|
||||||
@@ -479,6 +576,20 @@ SUPPORTED_MODELS = [
|
|||||||
{"id": "meta-llama/llama-3.1-70b-instruct", "name": "Llama 3.1 70B", "provider": "Meta"},
|
{"id": "meta-llama/llama-3.1-70b-instruct", "name": "Llama 3.1 70B", "provider": "Meta"},
|
||||||
]
|
]
|
||||||
|
|
||||||
|
_SUPPORTED_MODEL_IDS = {m["id"] for m in SUPPORTED_MODELS}
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_model(model: str | None) -> None:
|
||||||
|
"""Raise HTTP 400 if *model* is not in the supported allow-list."""
|
||||||
|
if model is not None and model not in _SUPPORTED_MODEL_IDS:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=400,
|
||||||
|
detail=(
|
||||||
|
f"Unsupported model '{model}'. "
|
||||||
|
f"Supported models: {', '.join(sorted(_SUPPORTED_MODEL_IDS))}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.get("/models", tags=["System"])
|
@app.get("/models", tags=["System"])
|
||||||
async def list_models():
|
async def list_models():
|
||||||
@@ -571,7 +682,7 @@ async def get_analytics_trends(
|
|||||||
|
|
||||||
@app.get("/export/{company_name}", tags=["Export"])
|
@app.get("/export/{company_name}", tags=["Export"])
|
||||||
async def export_company_csv(
|
async def export_company_csv(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Export analysis results for a company as a CSV file.
|
"""Export analysis results for a company as a CSV file.
|
||||||
@@ -623,7 +734,7 @@ async def export_company_csv(
|
|||||||
|
|
||||||
@app.get("/export/{company_name}/pdf", tags=["Export"])
|
@app.get("/export/{company_name}/pdf", tags=["Export"])
|
||||||
async def export_company_pdf(
|
async def export_company_pdf(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Export analysis results for a company as a formatted PDF report.
|
"""Export analysis results for a company as a formatted PDF report.
|
||||||
@@ -639,7 +750,6 @@ async def export_company_pdf(
|
|||||||
PDF file download
|
PDF file download
|
||||||
"""
|
"""
|
||||||
import io
|
import io
|
||||||
import textwrap
|
|
||||||
|
|
||||||
from reportlab.lib import colors
|
from reportlab.lib import colors
|
||||||
from reportlab.lib.pagesizes import letter
|
from reportlab.lib.pagesizes import letter
|
||||||
@@ -798,7 +908,7 @@ async def health_check():
|
|||||||
tags=["Analysis"],
|
tags=["Analysis"],
|
||||||
)
|
)
|
||||||
async def analyze_company(
|
async def analyze_company(
|
||||||
company_name: str,
|
company_name: Annotated[str, Path(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$")],
|
||||||
model: str | None = Query(default=None, description="LLM model to use (e.g. 'openai/gpt-4o'). Defaults to server config."),
|
model: str | None = Query(default=None, description="LLM model to use (e.g. 'openai/gpt-4o'). Defaults to server config."),
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
@@ -814,6 +924,7 @@ async def analyze_company(
|
|||||||
Returns:
|
Returns:
|
||||||
Analysis results including patent count, AI insights, and success status
|
Analysis results including patent count, AI insights, and success status
|
||||||
"""
|
"""
|
||||||
|
_validate_model(model)
|
||||||
if not _analyzer:
|
if not _analyzer:
|
||||||
raise HTTPException(status_code=503, detail="Analyzer not initialized")
|
raise HTTPException(status_code=503, detail="Analyzer not initialized")
|
||||||
|
|
||||||
@@ -827,7 +938,7 @@ async def analyze_company(
|
|||||||
)
|
)
|
||||||
async def analyze_single_patent(
|
async def analyze_single_patent(
|
||||||
patent_id: str,
|
patent_id: str,
|
||||||
company_name: str = Query(description="Company name for analysis context"),
|
company_name: Annotated[str, Query(min_length=2, max_length=100, pattern=r"^[a-zA-Z0-9][a-zA-Z0-9 \-&.]*$", description="Company name for analysis context")],
|
||||||
_: UserResponse = Depends(get_current_user),
|
_: UserResponse = Depends(get_current_user),
|
||||||
):
|
):
|
||||||
"""Analyze a single patent by its publication ID.
|
"""Analyze a single patent by its publication ID.
|
||||||
@@ -853,6 +964,58 @@ async def analyze_single_patent(
|
|||||||
raise HTTPException(status_code=404, detail=str(e))
|
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(
|
@app.post(
|
||||||
"/analyze/batch",
|
"/analyze/batch",
|
||||||
response_model=BatchAnalysisResponse,
|
response_model=BatchAnalysisResponse,
|
||||||
@@ -873,6 +1036,7 @@ async def analyze_companies_batch(
|
|||||||
Returns:
|
Returns:
|
||||||
Batch results with individual company analyses and summary statistics
|
Batch results with individual company analyses and summary statistics
|
||||||
"""
|
"""
|
||||||
|
_validate_model(request.model)
|
||||||
if not _analyzer:
|
if not _analyzer:
|
||||||
raise HTTPException(status_code=503, detail="Analyzer not initialized")
|
raise HTTPException(status_code=503, detail="Analyzer not initialized")
|
||||||
|
|
||||||
@@ -945,9 +1109,9 @@ def _run_batch_job(job_id: str, companies: list[str], max_workers: int, model: s
|
|||||||
progress=100,
|
progress=100,
|
||||||
result_json=_json.dumps(batch_response.model_dump(), default=str),
|
result_json=_json.dumps(batch_response.model_dump(), default=str),
|
||||||
)
|
)
|
||||||
# Fire webhook notification
|
# Fire webhook notification (non-blocking via task queue)
|
||||||
from SPARC.webhooks import notify_job_completed
|
from SPARC.webhooks import enqueue_job_completed
|
||||||
notify_job_completed(
|
enqueue_job_completed(
|
||||||
job_id=job_id,
|
job_id=job_id,
|
||||||
status="completed",
|
status="completed",
|
||||||
total_companies=result.total_companies,
|
total_companies=result.total_companies,
|
||||||
@@ -956,8 +1120,8 @@ def _run_batch_job(job_id: str, companies: list[str], max_workers: int, model: s
|
|||||||
)
|
)
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
db.update_job(job_id, status="failed", error=str(e))
|
db.update_job(job_id, status="failed", error=str(e))
|
||||||
from SPARC.webhooks import notify_job_completed
|
from SPARC.webhooks import enqueue_job_completed
|
||||||
notify_job_completed(
|
enqueue_job_completed(
|
||||||
job_id=job_id,
|
job_id=job_id,
|
||||||
status="failed",
|
status="failed",
|
||||||
total_companies=len(companies),
|
total_companies=len(companies),
|
||||||
@@ -983,6 +1147,7 @@ async def analyze_companies_async(
|
|||||||
Returns:
|
Returns:
|
||||||
Job status with job_id for polling
|
Job status with job_id for polling
|
||||||
"""
|
"""
|
||||||
|
_validate_model(request.model)
|
||||||
global _job_counter
|
global _job_counter
|
||||||
|
|
||||||
_job_counter += 1
|
_job_counter += 1
|
||||||
@@ -1026,7 +1191,7 @@ async def list_jobs(
|
|||||||
str | None,
|
str | None,
|
||||||
Query(description="Filter by status: pending, running, completed, failed"),
|
Query(description="Filter by status: pending, running, completed, failed"),
|
||||||
] = None,
|
] = None,
|
||||||
limit: Annotated[int, Query(ge=1, le=100)] = 10,
|
limit: Annotated[int, Query(ge=1, le=200)] = 50,
|
||||||
cursor: Annotated[
|
cursor: Annotated[
|
||||||
str | None,
|
str | None,
|
||||||
Query(description="Opaque cursor from a previous response's next_cursor field"),
|
Query(description="Opaque cursor from a previous response's next_cursor field"),
|
||||||
|
|||||||
@@ -371,6 +371,48 @@ class DatabaseClient:
|
|||||||
cursor.execute(query, params)
|
cursor.execute(query, params)
|
||||||
return [dict(row) for row in cursor.fetchall()]
|
return [dict(row) for row in cursor.fetchall()]
|
||||||
|
|
||||||
|
def list_analyses(
|
||||||
|
self,
|
||||||
|
company_name: Optional[str] = None,
|
||||||
|
limit: int = 50,
|
||||||
|
cursor: Optional[str] = None,
|
||||||
|
) -> List[Dict]:
|
||||||
|
"""List analysis results with cursor-based pagination.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
company_name: Optional filter by company name.
|
||||||
|
limit: Maximum number of records to return.
|
||||||
|
cursor: Opaque cursor (``timestamp|id``) from a previous response.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of analysis dicts ordered by timestamp descending.
|
||||||
|
"""
|
||||||
|
conditions: list[str] = ["is_cached = FALSE"]
|
||||||
|
params: list = []
|
||||||
|
|
||||||
|
if company_name:
|
||||||
|
conditions.append("LOWER(company_name) = LOWER(%s)")
|
||||||
|
params.append(company_name)
|
||||||
|
|
||||||
|
if cursor:
|
||||||
|
try:
|
||||||
|
ts_str, cursor_id = cursor.rsplit("|", 1)
|
||||||
|
conditions.append("(timestamp, id) < (%s, %s)")
|
||||||
|
params.extend([ts_str, int(cursor_id)])
|
||||||
|
except (ValueError, TypeError):
|
||||||
|
pass # Ignore malformed cursors; return from start
|
||||||
|
|
||||||
|
query = "SELECT id, company_name, analysis_type, model, response, timestamp FROM llm_messages"
|
||||||
|
if conditions:
|
||||||
|
query += " WHERE " + " AND ".join(conditions)
|
||||||
|
query += " ORDER BY timestamp DESC, id DESC LIMIT %s"
|
||||||
|
params.append(limit)
|
||||||
|
|
||||||
|
with self.get_conn() as conn:
|
||||||
|
with conn.cursor(cursor_factory=RealDictCursor) as cur:
|
||||||
|
cur.execute(query, params)
|
||||||
|
return [dict(row) for row in cur.fetchall()]
|
||||||
|
|
||||||
def get_analytics(self, days: int = 30) -> Dict:
|
def get_analytics(self, days: int = 30) -> Dict:
|
||||||
"""Get analytics on message usage.
|
"""Get analytics on message usage.
|
||||||
|
|
||||||
|
|||||||
+19
-7
@@ -2,14 +2,17 @@
|
|||||||
|
|
||||||
Uses APScheduler to periodically re-analyze tracked companies and
|
Uses APScheduler to periodically re-analyze tracked companies and
|
||||||
detect significant changes in patent counts.
|
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 logging
|
||||||
import os
|
import os
|
||||||
|
|
||||||
from SPARC import config
|
|
||||||
from SPARC.analyzer import CompanyAnalyzer
|
from SPARC.analyzer import CompanyAnalyzer
|
||||||
from SPARC.database import DatabaseClient
|
from SPARC.auth import get_db_client
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -21,10 +24,13 @@ CHANGE_THRESHOLD_PERCENT = int(os.getenv("CHANGE_THRESHOLD_PERCENT", "20"))
|
|||||||
|
|
||||||
|
|
||||||
def run_scheduled_analysis() -> None:
|
def run_scheduled_analysis() -> None:
|
||||||
"""Re-analyze all tracked companies and check for significant changes."""
|
"""Re-analyze all tracked companies and check for significant changes.
|
||||||
db = DatabaseClient(config.database_url)
|
|
||||||
db.connect()
|
Uses the shared pooled DatabaseClient from ``SPARC.auth.get_db_client()``
|
||||||
db.initialize_schema()
|
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()
|
tracked = db.list_tracked_companies()
|
||||||
if not tracked:
|
if not tracked:
|
||||||
@@ -65,6 +71,13 @@ def run_scheduled_analysis() -> None:
|
|||||||
old_value=old_count,
|
old_value=old_count,
|
||||||
new_value=new_count,
|
new_value=new_count,
|
||||||
)
|
)
|
||||||
|
# Fire non-blocking webhook notification
|
||||||
|
from SPARC.webhooks import enqueue_alert
|
||||||
|
enqueue_alert(
|
||||||
|
company_name=name,
|
||||||
|
alert_type="patent_count_change",
|
||||||
|
message=message,
|
||||||
|
)
|
||||||
elif new_count > 0:
|
elif new_count > 0:
|
||||||
# First analysis -- record baseline
|
# First analysis -- record baseline
|
||||||
logger.info("Baseline for %s: %d patents", name, new_count)
|
logger.info("Baseline for %s: %d patents", name, new_count)
|
||||||
@@ -74,7 +87,6 @@ def run_scheduled_analysis() -> None:
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.error("Error analyzing tracked company %s: %s", name, e)
|
logger.error("Error analyzing tracked company %s: %s", name, e)
|
||||||
|
|
||||||
db.close()
|
|
||||||
logger.info("Scheduled analysis complete")
|
logger.info("Scheduled analysis complete")
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,113 @@
|
|||||||
|
"""Lightweight in-process task queue for non-blocking webhook delivery.
|
||||||
|
|
||||||
|
Uses a daemon thread and a :class:`queue.Queue` so that the scheduler and
|
||||||
|
background jobs can enqueue webhook deliveries without blocking on HTTP
|
||||||
|
round-trips and retry backoff.
|
||||||
|
|
||||||
|
No external dependencies (Redis, etc.) are required.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import queue
|
||||||
|
import threading
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class WebhookTask:
|
||||||
|
"""A single webhook delivery request."""
|
||||||
|
|
||||||
|
url: str
|
||||||
|
payload: dict[str, Any]
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Module-level singleton
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
_queue: queue.Queue[WebhookTask | None] = queue.Queue()
|
||||||
|
_worker_thread: threading.Thread | None = None
|
||||||
|
_started = threading.Event()
|
||||||
|
|
||||||
|
|
||||||
|
def _worker_loop() -> None:
|
||||||
|
"""Process webhook tasks until a ``None`` sentinel is received."""
|
||||||
|
import SPARC.webhooks as _webhooks # deferred to avoid circular import
|
||||||
|
|
||||||
|
logger.info("Webhook worker thread started")
|
||||||
|
_started.set()
|
||||||
|
|
||||||
|
while True:
|
||||||
|
task = _queue.get()
|
||||||
|
if task is None:
|
||||||
|
# Sentinel — shut down
|
||||||
|
logger.info("Webhook worker thread stopping")
|
||||||
|
_queue.task_done()
|
||||||
|
break
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Look up dynamically so that tests can patch the function
|
||||||
|
_webhooks._send_with_retry(task.url, task.payload)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Unexpected error delivering webhook to %s", task.url)
|
||||||
|
finally:
|
||||||
|
_queue.task_done()
|
||||||
|
|
||||||
|
|
||||||
|
def start_worker() -> None:
|
||||||
|
"""Start the background worker thread (idempotent)."""
|
||||||
|
global _worker_thread
|
||||||
|
if _worker_thread is not None and _worker_thread.is_alive():
|
||||||
|
return
|
||||||
|
|
||||||
|
_started.clear()
|
||||||
|
_worker_thread = threading.Thread(target=_worker_loop, daemon=True, name="webhook-worker")
|
||||||
|
_worker_thread.start()
|
||||||
|
_started.wait() # block until the worker is actually running
|
||||||
|
logger.info("Webhook task queue ready")
|
||||||
|
|
||||||
|
|
||||||
|
def stop_worker(timeout: float = 5.0) -> None:
|
||||||
|
"""Send the stop sentinel and wait for the worker to finish.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
timeout: Maximum seconds to wait for the worker thread to join.
|
||||||
|
"""
|
||||||
|
global _worker_thread
|
||||||
|
if _worker_thread is None or not _worker_thread.is_alive():
|
||||||
|
_worker_thread = None
|
||||||
|
return
|
||||||
|
|
||||||
|
_queue.put(None) # sentinel
|
||||||
|
_worker_thread.join(timeout=timeout)
|
||||||
|
_worker_thread = None
|
||||||
|
logger.info("Webhook task queue stopped")
|
||||||
|
|
||||||
|
|
||||||
|
def enqueue(task: WebhookTask) -> None:
|
||||||
|
"""Add a webhook delivery task to the queue.
|
||||||
|
|
||||||
|
If the worker has not been started the task is still accepted into the
|
||||||
|
queue and will be processed once :func:`start_worker` is called.
|
||||||
|
"""
|
||||||
|
_queue.put(task)
|
||||||
|
|
||||||
|
|
||||||
|
def queue_size() -> int:
|
||||||
|
"""Return the approximate number of pending tasks."""
|
||||||
|
return _queue.qsize()
|
||||||
|
|
||||||
|
|
||||||
|
def drain(timeout: float = 10.0) -> None:
|
||||||
|
"""Block until all currently-enqueued tasks have been processed.
|
||||||
|
|
||||||
|
Useful in tests and graceful shutdown to ensure pending deliveries
|
||||||
|
complete before the process exits.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
timeout: Maximum seconds to wait.
|
||||||
|
"""
|
||||||
|
_queue.join()
|
||||||
+58
-3
@@ -91,9 +91,10 @@ def _send_with_retry(url: str, payload: dict) -> bool:
|
|||||||
|
|
||||||
|
|
||||||
def notify(event_type: str, data: dict[str, Any]) -> None:
|
def notify(event_type: str, data: dict[str, Any]) -> None:
|
||||||
"""Fire all configured webhooks for an event.
|
"""Fire all configured webhooks for an event (**blocking**).
|
||||||
|
|
||||||
Safe to call even when no webhooks are configured (returns immediately).
|
Safe to call even when no webhooks are configured (returns immediately).
|
||||||
|
For non-blocking delivery, use :func:`enqueue_notify` instead.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
event_type: Event identifier (e.g., "job_completed", "patent_alert")
|
event_type: Event identifier (e.g., "job_completed", "patent_alert")
|
||||||
@@ -108,6 +109,29 @@ def notify(event_type: str, data: dict[str, Any]) -> None:
|
|||||||
_send_with_retry(url, payload)
|
_send_with_retry(url, payload)
|
||||||
|
|
||||||
|
|
||||||
|
def enqueue_notify(event_type: str, data: dict[str, Any]) -> None:
|
||||||
|
"""Enqueue webhook delivery for all configured URLs (non-blocking).
|
||||||
|
|
||||||
|
Returns immediately after placing tasks on the background queue.
|
||||||
|
The worker thread handles retry logic asynchronously.
|
||||||
|
|
||||||
|
Safe to call even when no webhooks are configured.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
event_type: Event identifier (e.g., "job_completed", "patent_alert")
|
||||||
|
data: Event data to include in the payload
|
||||||
|
"""
|
||||||
|
if not WEBHOOK_URLS:
|
||||||
|
return
|
||||||
|
|
||||||
|
from SPARC.task_queue import WebhookTask, enqueue
|
||||||
|
|
||||||
|
for url in WEBHOOK_URLS:
|
||||||
|
slack = _is_slack_url(url)
|
||||||
|
payload = _build_payload(event_type, data, slack=slack)
|
||||||
|
enqueue(WebhookTask(url=url, payload=payload))
|
||||||
|
|
||||||
|
|
||||||
def notify_job_completed(
|
def notify_job_completed(
|
||||||
job_id: str,
|
job_id: str,
|
||||||
status: str,
|
status: str,
|
||||||
@@ -115,7 +139,7 @@ def notify_job_completed(
|
|||||||
successful: int,
|
successful: int,
|
||||||
failed: int,
|
failed: int,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Send notification when a batch job completes."""
|
"""Send notification when a batch job completes (blocking)."""
|
||||||
notify("job_completed", {
|
notify("job_completed", {
|
||||||
"job_id": job_id,
|
"job_id": job_id,
|
||||||
"status": status,
|
"status": status,
|
||||||
@@ -126,14 +150,45 @@ def notify_job_completed(
|
|||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
|
def enqueue_job_completed(
|
||||||
|
job_id: str,
|
||||||
|
status: str,
|
||||||
|
total_companies: int,
|
||||||
|
successful: int,
|
||||||
|
failed: int,
|
||||||
|
) -> None:
|
||||||
|
"""Enqueue notification when a batch job completes (non-blocking)."""
|
||||||
|
enqueue_notify("job_completed", {
|
||||||
|
"job_id": job_id,
|
||||||
|
"status": status,
|
||||||
|
"total_companies": total_companies,
|
||||||
|
"successful": successful,
|
||||||
|
"failed": failed,
|
||||||
|
"summary": f"Batch job {job_id}: {successful}/{total_companies} succeeded",
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
def notify_alert(
|
def notify_alert(
|
||||||
company_name: str,
|
company_name: str,
|
||||||
alert_type: str,
|
alert_type: str,
|
||||||
message: str,
|
message: str,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Send notification for a tracked company alert."""
|
"""Send notification for a tracked company alert (blocking)."""
|
||||||
notify("patent_alert", {
|
notify("patent_alert", {
|
||||||
"company_name": company_name,
|
"company_name": company_name,
|
||||||
"alert_type": alert_type,
|
"alert_type": alert_type,
|
||||||
"message": message,
|
"message": message,
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
|
def enqueue_alert(
|
||||||
|
company_name: str,
|
||||||
|
alert_type: str,
|
||||||
|
message: str,
|
||||||
|
) -> None:
|
||||||
|
"""Enqueue notification for a tracked company alert (non-blocking)."""
|
||||||
|
enqueue_notify("patent_alert", {
|
||||||
|
"company_name": company_name,
|
||||||
|
"alert_type": alert_type,
|
||||||
|
"message": message,
|
||||||
|
})
|
||||||
|
|||||||
+6
-2
@@ -18,6 +18,7 @@ services:
|
|||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|
||||||
init-db:
|
init-db:
|
||||||
|
image: gitea.leeworks.dev/0xwheatyz/sparc:latest
|
||||||
build: .
|
build: .
|
||||||
container_name: sparc-init-db
|
container_name: sparc-init-db
|
||||||
command: python scripts/init_database.py
|
command: python scripts/init_database.py
|
||||||
@@ -29,6 +30,7 @@ services:
|
|||||||
restart: "no"
|
restart: "no"
|
||||||
|
|
||||||
api:
|
api:
|
||||||
|
image: gitea.leeworks.dev/0xwheatyz/sparc:latest
|
||||||
build: .
|
build: .
|
||||||
container_name: sparc-api
|
container_name: sparc-api
|
||||||
command: uvicorn SPARC.api:app --host 0.0.0.0 --port 8000
|
command: uvicorn SPARC.api:app --host 0.0.0.0 --port 8000
|
||||||
@@ -40,7 +42,7 @@ services:
|
|||||||
JWT_SECRET: ${JWT_SECRET:-sparc-secret-key-change-in-production}
|
JWT_SECRET: ${JWT_SECRET:-sparc-secret-key-change-in-production}
|
||||||
CORS_ORIGINS: ${CORS_ORIGINS:-}
|
CORS_ORIGINS: ${CORS_ORIGINS:-}
|
||||||
APP_ENV: ${APP_ENV:-development}
|
APP_ENV: ${APP_ENV:-development}
|
||||||
ROOT_PATH: /api
|
ROOT_PATH: ""
|
||||||
ports:
|
ports:
|
||||||
- "8000:8000"
|
- "8000:8000"
|
||||||
depends_on:
|
depends_on:
|
||||||
@@ -49,7 +51,7 @@ services:
|
|||||||
init-db:
|
init-db:
|
||||||
condition: service_completed_successfully
|
condition: service_completed_successfully
|
||||||
volumes:
|
volumes:
|
||||||
- ./patents:/app/patents
|
- patent_data:/app/patents
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|
||||||
# Optional: MinIO for S3-compatible local object storage
|
# Optional: MinIO for S3-compatible local object storage
|
||||||
@@ -76,6 +78,7 @@ services:
|
|||||||
- s3
|
- s3
|
||||||
|
|
||||||
dashboard:
|
dashboard:
|
||||||
|
image: gitea.leeworks.dev/0xwheatyz/sparc:frontend-latest
|
||||||
build: ./frontend
|
build: ./frontend
|
||||||
container_name: sparc-dashboard
|
container_name: sparc-dashboard
|
||||||
ports:
|
ports:
|
||||||
@@ -86,4 +89,5 @@ services:
|
|||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
postgres_data:
|
postgres_data:
|
||||||
|
patent_data:
|
||||||
minio_data:
|
minio_data:
|
||||||
|
|||||||
+76
-1
@@ -276,7 +276,7 @@ The `docker-compose.yml` includes all services needed for production:
|
|||||||
|---------|-----------|------|-------------|
|
|---------|-----------|------|-------------|
|
||||||
| `postgres` | sparc-postgres | 5432 | PostgreSQL database |
|
| `postgres` | sparc-postgres | 5432 | PostgreSQL database |
|
||||||
| `init-db` | sparc-init-db | - | One-time database initialization (seeds admin user) |
|
| `init-db` | sparc-init-db | - | One-time database initialization (seeds admin user) |
|
||||||
| `api` | sparc-api | 8000 | FastAPI REST API with JWT auth |
|
| `api` | sparc-api | 8000 | FastAPI REST API with JWT auth (patent PDFs stored in `patent_data` volume) |
|
||||||
| `dashboard` | sparc-dashboard | 8080 | React TypeScript web UI |
|
| `dashboard` | sparc-dashboard | 8080 | React TypeScript web UI |
|
||||||
|
|
||||||
### Common Docker Compose Commands
|
### Common Docker Compose Commands
|
||||||
@@ -307,6 +307,81 @@ docker-compose restart api
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Patent PDF Storage
|
||||||
|
|
||||||
|
The SPARC API downloads patent PDFs during analysis and stores them at `/app/patents` inside the container. These files are used for subsequent single-patent analysis requests and as a local cache to avoid re-downloading. If this directory is not persisted, all downloaded PDFs are lost when the container is recreated.
|
||||||
|
|
||||||
|
### Docker Compose (default)
|
||||||
|
|
||||||
|
The default `docker-compose.yml` declares a named volume called `patent_data` that is mounted at `/app/patents`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# In the api service:
|
||||||
|
volumes:
|
||||||
|
- patent_data:/app/patents
|
||||||
|
|
||||||
|
# At the top-level volumes section:
|
||||||
|
volumes:
|
||||||
|
patent_data:
|
||||||
|
```
|
||||||
|
|
||||||
|
This means PDFs survive `docker compose down` and `docker compose up` cycles. To remove patent data intentionally, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose down -v # WARNING: also removes postgres_data
|
||||||
|
# or selectively:
|
||||||
|
docker volume rm sparc_patent_data
|
||||||
|
```
|
||||||
|
|
||||||
|
If you prefer a bind mount (e.g., for easy host-side access during development), replace the volume with:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
volumes:
|
||||||
|
- ./patents:/app/patents
|
||||||
|
```
|
||||||
|
|
||||||
|
### Kubernetes
|
||||||
|
|
||||||
|
For Kubernetes deployments, create a PersistentVolumeClaim and mount it into the API pod:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
apiVersion: v1
|
||||||
|
kind: PersistentVolumeClaim
|
||||||
|
metadata:
|
||||||
|
name: sparc-patent-data
|
||||||
|
spec:
|
||||||
|
accessModes:
|
||||||
|
- ReadWriteOnce
|
||||||
|
resources:
|
||||||
|
requests:
|
||||||
|
storage: 5Gi
|
||||||
|
---
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: sparc-api
|
||||||
|
spec:
|
||||||
|
template:
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- name: api
|
||||||
|
volumeMounts:
|
||||||
|
- name: patent-data
|
||||||
|
mountPath: /app/patents
|
||||||
|
volumes:
|
||||||
|
- name: patent-data
|
||||||
|
persistentVolumeClaim:
|
||||||
|
claimName: sparc-patent-data
|
||||||
|
```
|
||||||
|
|
||||||
|
Adjust the storage size based on expected patent volume. Each patent PDF is typically 1-5 MB.
|
||||||
|
|
||||||
|
### S3 Object Storage (alternative)
|
||||||
|
|
||||||
|
For production deployments that need shared or highly durable storage, set `STORAGE_BACKEND=s3` in your `.env` file. This stores patent PDFs in an S3-compatible bucket (AWS S3 or MinIO) instead of the local filesystem, eliminating the need for a persistent volume. See the S3/MinIO section in `.env.example` for configuration details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### Database Connection Issues
|
### Database Connection Issues
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ server {
|
|||||||
|
|
||||||
# Proxy API requests to backend
|
# Proxy API requests to backend
|
||||||
location /api/ {
|
location /api/ {
|
||||||
proxy_pass ${API_URL}/;
|
proxy_pass ${API_URL};
|
||||||
proxy_http_version 1.1;
|
proxy_http_version 1.1;
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
proxy_set_header Upgrade $http_upgrade;
|
||||||
proxy_set_header Connection 'upgrade';
|
proxy_set_header Connection 'upgrade';
|
||||||
|
|||||||
Generated
+257
@@ -26,6 +26,7 @@
|
|||||||
"eslint-plugin-react-hooks": "^5.1.0",
|
"eslint-plugin-react-hooks": "^5.1.0",
|
||||||
"eslint-plugin-react-refresh": "^0.4.7",
|
"eslint-plugin-react-refresh": "^0.4.7",
|
||||||
"globals": "^15.8.0",
|
"globals": "^15.8.0",
|
||||||
|
"openapi-typescript": "^7.0.0",
|
||||||
"postcss": "^8.4.39",
|
"postcss": "^8.4.39",
|
||||||
"tailwindcss": "^3.4.4",
|
"tailwindcss": "^3.4.4",
|
||||||
"typescript": "~5.5.3",
|
"typescript": "~5.5.3",
|
||||||
@@ -1025,6 +1026,82 @@
|
|||||||
"node": ">= 8"
|
"node": ">= 8"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/@redocly/ajv": {
|
||||||
|
"version": "8.11.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.2.tgz",
|
||||||
|
"integrity": "sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"fast-deep-equal": "^3.1.1",
|
||||||
|
"json-schema-traverse": "^1.0.0",
|
||||||
|
"require-from-string": "^2.0.2",
|
||||||
|
"uri-js-replace": "^1.0.1"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"type": "github",
|
||||||
|
"url": "https://github.com/sponsors/epoberezkin"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@redocly/ajv/node_modules/json-schema-traverse": {
|
||||||
|
"version": "1.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
|
||||||
|
"integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/@redocly/config": {
|
||||||
|
"version": "0.22.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.22.0.tgz",
|
||||||
|
"integrity": "sha512-gAy93Ddo01Z3bHuVdPWfCwzgfaYgMdaZPcfL7JZ7hWJoK9V0lXDbigTWkhiPFAaLWzbOJ+kbUQG1+XwIm0KRGQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/@redocly/openapi-core": {
|
||||||
|
"version": "1.34.11",
|
||||||
|
"resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.34.11.tgz",
|
||||||
|
"integrity": "sha512-V09ayfnb5GyysmvARbt+voFZAjGcf7hSYxOYxSkCc4fbH/DTfq5YWoec8cflvmHHqyIFbqvmGKmYFzqhr9zxDg==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@redocly/ajv": "8.11.2",
|
||||||
|
"@redocly/config": "0.22.0",
|
||||||
|
"colorette": "1.4.0",
|
||||||
|
"https-proxy-agent": "7.0.6",
|
||||||
|
"js-levenshtein": "1.1.6",
|
||||||
|
"js-yaml": "4.1.1",
|
||||||
|
"minimatch": "5.1.9",
|
||||||
|
"pluralize": "8.0.0",
|
||||||
|
"yaml-ast-parser": "0.0.43"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18.17.0",
|
||||||
|
"npm": ">=9.5.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@redocly/openapi-core/node_modules/brace-expansion": {
|
||||||
|
"version": "2.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.3.tgz",
|
||||||
|
"integrity": "sha512-MCV/fYJEbqx68aE58kv2cA/kiky1G8vux3OR6/jbS+jIMe/6fJWa0DTzJU7dqijOWYwHi1t29FlfYI9uytqlpA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"balanced-match": "^1.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@redocly/openapi-core/node_modules/minimatch": {
|
||||||
|
"version": "5.1.9",
|
||||||
|
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.9.tgz",
|
||||||
|
"integrity": "sha512-7o1wEA2RyMP7Iu7GNba9vc0RWWGACJOCZBJX2GJWip0ikV+wcOsgVuY9uE8CPiyQhkGFSlhuSkZPavN7u1c2Fw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "ISC",
|
||||||
|
"dependencies": {
|
||||||
|
"brace-expansion": "^2.0.1"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=10"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/@remix-run/router": {
|
"node_modules/@remix-run/router": {
|
||||||
"version": "1.23.2",
|
"version": "1.23.2",
|
||||||
"resolved": "https://registry.npmjs.org/@remix-run/router/-/router-1.23.2.tgz",
|
"resolved": "https://registry.npmjs.org/@remix-run/router/-/router-1.23.2.tgz",
|
||||||
@@ -1906,6 +1983,16 @@
|
|||||||
"acorn": "^6.0.0 || ^7.0.0 || ^8.0.0"
|
"acorn": "^6.0.0 || ^7.0.0 || ^8.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/agent-base": {
|
||||||
|
"version": "7.1.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz",
|
||||||
|
"integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 14"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/ajv": {
|
"node_modules/ajv": {
|
||||||
"version": "6.14.0",
|
"version": "6.14.0",
|
||||||
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz",
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz",
|
||||||
@@ -1923,6 +2010,16 @@
|
|||||||
"url": "https://github.com/sponsors/epoberezkin"
|
"url": "https://github.com/sponsors/epoberezkin"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/ansi-colors": {
|
||||||
|
"version": "4.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz",
|
||||||
|
"integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=6"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/ansi-styles": {
|
"node_modules/ansi-styles": {
|
||||||
"version": "4.3.0",
|
"version": "4.3.0",
|
||||||
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
|
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
|
||||||
@@ -2190,6 +2287,13 @@
|
|||||||
"url": "https://github.com/chalk/chalk?sponsor=1"
|
"url": "https://github.com/chalk/chalk?sponsor=1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/change-case": {
|
||||||
|
"version": "5.4.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz",
|
||||||
|
"integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
"node_modules/chokidar": {
|
"node_modules/chokidar": {
|
||||||
"version": "3.6.0",
|
"version": "3.6.0",
|
||||||
"resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
|
||||||
@@ -2257,6 +2361,13 @@
|
|||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
},
|
},
|
||||||
|
"node_modules/colorette": {
|
||||||
|
"version": "1.4.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz",
|
||||||
|
"integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
"node_modules/combined-stream": {
|
"node_modules/combined-stream": {
|
||||||
"version": "1.0.8",
|
"version": "1.0.8",
|
||||||
"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
|
"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
|
||||||
@@ -3165,6 +3276,20 @@
|
|||||||
"node": ">= 0.4"
|
"node": ">= 0.4"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/https-proxy-agent": {
|
||||||
|
"version": "7.0.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz",
|
||||||
|
"integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"agent-base": "^7.1.2",
|
||||||
|
"debug": "4"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 14"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/ignore": {
|
"node_modules/ignore": {
|
||||||
"version": "5.3.2",
|
"version": "5.3.2",
|
||||||
"resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz",
|
"resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz",
|
||||||
@@ -3202,6 +3327,19 @@
|
|||||||
"node": ">=0.8.19"
|
"node": ">=0.8.19"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/index-to-position": {
|
||||||
|
"version": "1.2.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/index-to-position/-/index-to-position-1.2.0.tgz",
|
||||||
|
"integrity": "sha512-Yg7+ztRkqslMAS2iFaU+Oa4KTSidr63OsFGlOrJoW981kIYO3CGCS3wA95P1mUi/IVSJkn0D479KTJpVpvFNuw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/sponsors/sindresorhus"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/internmap": {
|
"node_modules/internmap": {
|
||||||
"version": "2.0.3",
|
"version": "2.0.3",
|
||||||
"resolved": "https://registry.npmjs.org/internmap/-/internmap-2.0.3.tgz",
|
"resolved": "https://registry.npmjs.org/internmap/-/internmap-2.0.3.tgz",
|
||||||
@@ -3290,6 +3428,16 @@
|
|||||||
"jiti": "bin/jiti.js"
|
"jiti": "bin/jiti.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/js-levenshtein": {
|
||||||
|
"version": "1.1.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/js-levenshtein/-/js-levenshtein-1.1.6.tgz",
|
||||||
|
"integrity": "sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.10.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/js-tokens": {
|
"node_modules/js-tokens": {
|
||||||
"version": "4.0.0",
|
"version": "4.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
|
||||||
@@ -3608,6 +3756,40 @@
|
|||||||
"node": ">= 6"
|
"node": ">= 6"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/openapi-typescript": {
|
||||||
|
"version": "7.13.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.13.0.tgz",
|
||||||
|
"integrity": "sha512-EFP392gcqXS7ntPvbhBzbF8TyBA+baIYEm791Hy5YkjDYKTnk/Tn5OQeKm5BIZvJihpp8Zzr4hzx0Irde1LNGQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@redocly/openapi-core": "^1.34.6",
|
||||||
|
"ansi-colors": "^4.1.3",
|
||||||
|
"change-case": "^5.4.4",
|
||||||
|
"parse-json": "^8.3.0",
|
||||||
|
"supports-color": "^10.2.2",
|
||||||
|
"yargs-parser": "^21.1.1"
|
||||||
|
},
|
||||||
|
"bin": {
|
||||||
|
"openapi-typescript": "bin/cli.js"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"typescript": "^5.x"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/openapi-typescript/node_modules/supports-color": {
|
||||||
|
"version": "10.2.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-10.2.2.tgz",
|
||||||
|
"integrity": "sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/chalk/supports-color?sponsor=1"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/optionator": {
|
"node_modules/optionator": {
|
||||||
"version": "0.9.4",
|
"version": "0.9.4",
|
||||||
"resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz",
|
"resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz",
|
||||||
@@ -3671,6 +3853,24 @@
|
|||||||
"node": ">=6"
|
"node": ">=6"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/parse-json": {
|
||||||
|
"version": "8.3.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.3.0.tgz",
|
||||||
|
"integrity": "sha512-ybiGyvspI+fAoRQbIPRddCcSTV9/LsJbf0e/S85VLowVGzRmokfneg2kwVW/KU5rOXrPSbF1qAKPMgNTqqROQQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@babel/code-frame": "^7.26.2",
|
||||||
|
"index-to-position": "^1.1.0",
|
||||||
|
"type-fest": "^4.39.1"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/sponsors/sindresorhus"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/path-exists": {
|
"node_modules/path-exists": {
|
||||||
"version": "4.0.0",
|
"version": "4.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz",
|
||||||
@@ -3738,6 +3938,16 @@
|
|||||||
"node": ">= 6"
|
"node": ">= 6"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/pluralize": {
|
||||||
|
"version": "8.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz",
|
||||||
|
"integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/postcss": {
|
"node_modules/postcss": {
|
||||||
"version": "8.5.8",
|
"version": "8.5.8",
|
||||||
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz",
|
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz",
|
||||||
@@ -4124,6 +4334,16 @@
|
|||||||
"decimal.js-light": "^2.4.1"
|
"decimal.js-light": "^2.4.1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/require-from-string": {
|
||||||
|
"version": "2.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
|
||||||
|
"integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.10.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/resolve": {
|
"node_modules/resolve": {
|
||||||
"version": "1.22.11",
|
"version": "1.22.11",
|
||||||
"resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz",
|
"resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz",
|
||||||
@@ -4510,6 +4730,19 @@
|
|||||||
"node": ">= 0.8.0"
|
"node": ">= 0.8.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/type-fest": {
|
||||||
|
"version": "4.41.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz",
|
||||||
|
"integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "(MIT OR CC0-1.0)",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=16"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/sponsors/sindresorhus"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/typescript": {
|
"node_modules/typescript": {
|
||||||
"version": "5.5.4",
|
"version": "5.5.4",
|
||||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz",
|
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz",
|
||||||
@@ -4589,6 +4822,13 @@
|
|||||||
"punycode": "^2.1.0"
|
"punycode": "^2.1.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/uri-js-replace": {
|
||||||
|
"version": "1.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/uri-js-replace/-/uri-js-replace-1.0.1.tgz",
|
||||||
|
"integrity": "sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
"node_modules/util-deprecate": {
|
"node_modules/util-deprecate": {
|
||||||
"version": "1.0.2",
|
"version": "1.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
|
"resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
|
||||||
@@ -4711,6 +4951,23 @@
|
|||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "ISC"
|
"license": "ISC"
|
||||||
},
|
},
|
||||||
|
"node_modules/yaml-ast-parser": {
|
||||||
|
"version": "0.0.43",
|
||||||
|
"resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz",
|
||||||
|
"integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "Apache-2.0"
|
||||||
|
},
|
||||||
|
"node_modules/yargs-parser": {
|
||||||
|
"version": "21.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
|
||||||
|
"integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "ISC",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=12"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/yocto-queue": {
|
"node_modules/yocto-queue": {
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
|
||||||
|
|||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import { useTheme } from './ThemeContext';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns theme-aware color values for recharts components.
|
||||||
|
*
|
||||||
|
* Recharts accepts only raw color strings (not CSS variables),
|
||||||
|
* so this hook bridges the Tailwind/CSS-variable theme system
|
||||||
|
* to the imperative recharts API.
|
||||||
|
*/
|
||||||
|
export function useChartTheme() {
|
||||||
|
const { theme } = useTheme();
|
||||||
|
const isDark = theme === 'dark';
|
||||||
|
|
||||||
|
return {
|
||||||
|
/** Axis tick and grid line stroke color */
|
||||||
|
axisStroke: isDark ? '#94a3b8' : '#64748b',
|
||||||
|
/** Tooltip container background */
|
||||||
|
tooltipBg: isDark ? '#1e293b' : '#ffffff',
|
||||||
|
/** Tooltip container border */
|
||||||
|
tooltipBorder: isDark
|
||||||
|
? '1px solid rgba(99, 102, 241, 0.3)'
|
||||||
|
: '1px solid rgba(99, 102, 241, 0.2)',
|
||||||
|
/** Tooltip label text color */
|
||||||
|
tooltipLabelColor: isDark ? '#f8fafc' : '#0f172a',
|
||||||
|
/** Tooltip item text color */
|
||||||
|
tooltipItemColor: isDark ? '#e2e8f0' : '#334155',
|
||||||
|
/** Convenience: full contentStyle object for recharts Tooltip */
|
||||||
|
tooltipContentStyle: {
|
||||||
|
backgroundColor: isDark ? '#1e293b' : '#ffffff',
|
||||||
|
border: isDark
|
||||||
|
? '1px solid rgba(99, 102, 241, 0.3)'
|
||||||
|
: '1px solid rgba(99, 102, 241, 0.2)',
|
||||||
|
borderRadius: '8px',
|
||||||
|
color: isDark ? '#f8fafc' : '#0f172a',
|
||||||
|
},
|
||||||
|
/** Convenience: labelStyle for recharts Tooltip */
|
||||||
|
tooltipLabelStyle: {
|
||||||
|
color: isDark ? '#f8fafc' : '#0f172a',
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -159,7 +159,7 @@ export function Analysis() {
|
|||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div className="prose prose-invert max-w-none">
|
<div className="prose dark:prose-invert max-w-none">
|
||||||
<div className="text-text-primary whitespace-pre-wrap leading-relaxed">
|
<div className="text-text-primary whitespace-pre-wrap leading-relaxed">
|
||||||
{result.analysis}
|
{result.analysis}
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -3,11 +3,13 @@ import { useQuery } from '@tanstack/react-query';
|
|||||||
import { analyticsApi } from '../api/client';
|
import { analyticsApi } from '../api/client';
|
||||||
import { AlertCircle, Database } from 'lucide-react';
|
import { AlertCircle, Database } from 'lucide-react';
|
||||||
import { PieChart, Pie, Cell, BarChart, Bar, LineChart, Line, XAxis, YAxis, Tooltip, ResponsiveContainer, Legend } from 'recharts';
|
import { PieChart, Pie, Cell, BarChart, Bar, LineChart, Line, XAxis, YAxis, Tooltip, ResponsiveContainer, Legend } from 'recharts';
|
||||||
|
import { useChartTheme } from '../context/useChartTheme';
|
||||||
|
|
||||||
const COLORS = ['#6366f1', '#0ea5e9', '#10b981', '#f59e0b', '#ef4444', '#8b5cf6', '#ec4899', '#14b8a6'];
|
const COLORS = ['#6366f1', '#0ea5e9', '#10b981', '#f59e0b', '#ef4444', '#8b5cf6', '#ec4899', '#14b8a6'];
|
||||||
|
|
||||||
export function AnalyticsPage() {
|
export function AnalyticsPage() {
|
||||||
const [days, setDays] = useState(30);
|
const [days, setDays] = useState(30);
|
||||||
|
const chartTheme = useChartTheme();
|
||||||
|
|
||||||
const { data, isLoading, isError, refetch } = useQuery({
|
const { data, isLoading, isError, refetch } = useQuery({
|
||||||
queryKey: ['analytics', days],
|
queryKey: ['analytics', days],
|
||||||
@@ -160,11 +162,7 @@ export function AnalyticsPage() {
|
|||||||
))}
|
))}
|
||||||
</Pie>
|
</Pie>
|
||||||
<Tooltip
|
<Tooltip
|
||||||
contentStyle={{
|
contentStyle={chartTheme.tooltipContentStyle}
|
||||||
backgroundColor: '#1e293b',
|
|
||||||
border: '1px solid rgba(99, 102, 241, 0.3)',
|
|
||||||
borderRadius: '8px',
|
|
||||||
}}
|
|
||||||
/>
|
/>
|
||||||
<Legend />
|
<Legend />
|
||||||
</PieChart>
|
</PieChart>
|
||||||
@@ -178,15 +176,11 @@ export function AnalyticsPage() {
|
|||||||
<h3 className="text-lg font-semibold text-text-primary mb-4">Analysis Types</h3>
|
<h3 className="text-lg font-semibold text-text-primary mb-4">Analysis Types</h3>
|
||||||
<ResponsiveContainer width="100%" height={300}>
|
<ResponsiveContainer width="100%" height={300}>
|
||||||
<BarChart data={typeData}>
|
<BarChart data={typeData}>
|
||||||
<XAxis dataKey="name" stroke="#94a3b8" fontSize={12} />
|
<XAxis dataKey="name" stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<YAxis stroke="#94a3b8" fontSize={12} />
|
<YAxis stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<Tooltip
|
<Tooltip
|
||||||
contentStyle={{
|
contentStyle={chartTheme.tooltipContentStyle}
|
||||||
backgroundColor: '#1e293b',
|
labelStyle={chartTheme.tooltipLabelStyle}
|
||||||
border: '1px solid rgba(99, 102, 241, 0.3)',
|
|
||||||
borderRadius: '8px',
|
|
||||||
}}
|
|
||||||
labelStyle={{ color: '#f8fafc' }}
|
|
||||||
/>
|
/>
|
||||||
<Bar dataKey="count" fill="#6366f1" radius={[4, 4, 0, 0]} />
|
<Bar dataKey="count" fill="#6366f1" radius={[4, 4, 0, 0]} />
|
||||||
</BarChart>
|
</BarChart>
|
||||||
@@ -222,15 +216,11 @@ export function AnalyticsPage() {
|
|||||||
<h4 className="text-md font-semibold text-text-primary mb-4">Analyses per Company Over Time</h4>
|
<h4 className="text-md font-semibold text-text-primary mb-4">Analyses per Company Over Time</h4>
|
||||||
<ResponsiveContainer width="100%" height={300}>
|
<ResponsiveContainer width="100%" height={300}>
|
||||||
<LineChart data={pivoted}>
|
<LineChart data={pivoted}>
|
||||||
<XAxis dataKey="month" stroke="#94a3b8" fontSize={12} />
|
<XAxis dataKey="month" stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<YAxis stroke="#94a3b8" fontSize={12} />
|
<YAxis stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<Tooltip
|
<Tooltip
|
||||||
contentStyle={{
|
contentStyle={chartTheme.tooltipContentStyle}
|
||||||
backgroundColor: '#1e293b',
|
labelStyle={chartTheme.tooltipLabelStyle}
|
||||||
border: '1px solid rgba(99, 102, 241, 0.3)',
|
|
||||||
borderRadius: '8px',
|
|
||||||
}}
|
|
||||||
labelStyle={{ color: '#f8fafc' }}
|
|
||||||
/>
|
/>
|
||||||
<Legend />
|
<Legend />
|
||||||
{companies.map((company, idx) => (
|
{companies.map((company, idx) => (
|
||||||
@@ -268,15 +258,11 @@ export function AnalyticsPage() {
|
|||||||
<h4 className="text-md font-semibold text-text-primary mb-4">Analysis Types Over Time</h4>
|
<h4 className="text-md font-semibold text-text-primary mb-4">Analysis Types Over Time</h4>
|
||||||
<ResponsiveContainer width="100%" height={300}>
|
<ResponsiveContainer width="100%" height={300}>
|
||||||
<BarChart data={pivoted}>
|
<BarChart data={pivoted}>
|
||||||
<XAxis dataKey="month" stroke="#94a3b8" fontSize={12} />
|
<XAxis dataKey="month" stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<YAxis stroke="#94a3b8" fontSize={12} />
|
<YAxis stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<Tooltip
|
<Tooltip
|
||||||
contentStyle={{
|
contentStyle={chartTheme.tooltipContentStyle}
|
||||||
backgroundColor: '#1e293b',
|
labelStyle={chartTheme.tooltipLabelStyle}
|
||||||
border: '1px solid rgba(99, 102, 241, 0.3)',
|
|
||||||
borderRadius: '8px',
|
|
||||||
}}
|
|
||||||
labelStyle={{ color: '#f8fafc' }}
|
|
||||||
/>
|
/>
|
||||||
<Legend />
|
<Legend />
|
||||||
{types.map((type, idx) => (
|
{types.map((type, idx) => (
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { useMutation, useQuery } from '@tanstack/react-query';
|
|||||||
import { analysisApi } from '../api/client';
|
import { analysisApi } from '../api/client';
|
||||||
import { Rocket, CheckCircle, AlertCircle, ChevronDown, ChevronUp, RefreshCw, Inbox } from 'lucide-react';
|
import { Rocket, CheckCircle, AlertCircle, ChevronDown, ChevronUp, RefreshCw, Inbox } from 'lucide-react';
|
||||||
import { BarChart, Bar, XAxis, YAxis, Tooltip, ResponsiveContainer, Cell } from 'recharts';
|
import { BarChart, Bar, XAxis, YAxis, Tooltip, ResponsiveContainer, Cell } from 'recharts';
|
||||||
|
import { useChartTheme } from '../context/useChartTheme';
|
||||||
import type { BatchAnalysisResult } from '../types';
|
import type { BatchAnalysisResult } from '../types';
|
||||||
|
|
||||||
export function Batch() {
|
export function Batch() {
|
||||||
@@ -12,6 +13,8 @@ export function Batch() {
|
|||||||
const [result, setResult] = useState<BatchAnalysisResult | null>(null);
|
const [result, setResult] = useState<BatchAnalysisResult | null>(null);
|
||||||
const [expandedItems, setExpandedItems] = useState<Set<string>>(new Set());
|
const [expandedItems, setExpandedItems] = useState<Set<string>>(new Set());
|
||||||
|
|
||||||
|
const chartTheme = useChartTheme();
|
||||||
|
|
||||||
const modelsQuery = useQuery({
|
const modelsQuery = useQuery({
|
||||||
queryKey: ['models'],
|
queryKey: ['models'],
|
||||||
queryFn: () => analysisApi.listModels(),
|
queryFn: () => analysisApi.listModels(),
|
||||||
@@ -210,15 +213,11 @@ export function Batch() {
|
|||||||
<div className="bg-bg-card/60 border border-primary/15 rounded-2xl p-6">
|
<div className="bg-bg-card/60 border border-primary/15 rounded-2xl p-6">
|
||||||
<ResponsiveContainer width="100%" height={300}>
|
<ResponsiveContainer width="100%" height={300}>
|
||||||
<BarChart data={chartData}>
|
<BarChart data={chartData}>
|
||||||
<XAxis dataKey="name" stroke="#94a3b8" fontSize={12} />
|
<XAxis dataKey="name" stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<YAxis stroke="#94a3b8" fontSize={12} />
|
<YAxis stroke={chartTheme.axisStroke} fontSize={12} />
|
||||||
<Tooltip
|
<Tooltip
|
||||||
contentStyle={{
|
contentStyle={chartTheme.tooltipContentStyle}
|
||||||
backgroundColor: '#1e293b',
|
labelStyle={chartTheme.tooltipLabelStyle}
|
||||||
border: '1px solid rgba(99, 102, 241, 0.3)',
|
|
||||||
borderRadius: '8px',
|
|
||||||
}}
|
|
||||||
labelStyle={{ color: '#f8fafc' }}
|
|
||||||
/>
|
/>
|
||||||
<Bar dataKey="patents" radius={[4, 4, 0, 0]}>
|
<Bar dataKey="patents" radius={[4, 4, 0, 0]}>
|
||||||
{chartData.map((entry, index) => (
|
{chartData.map((entry, index) => (
|
||||||
|
|||||||
@@ -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)
|
||||||
@@ -182,3 +182,47 @@ class TestJobEndpoints:
|
|||||||
"""Test listing jobs with status filter."""
|
"""Test listing jobs with status filter."""
|
||||||
response = client.get("/jobs?status=completed")
|
response = client.get("/jobs?status=completed")
|
||||||
assert response.status_code == 200
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
|
||||||
|
class TestModelValidation:
|
||||||
|
"""Test that unsupported model identifiers are rejected."""
|
||||||
|
|
||||||
|
def test_analyze_rejects_unsupported_model(self, client, mock_analyzer):
|
||||||
|
"""GET /analyze/{company} with unsupported model returns 400."""
|
||||||
|
response = client.get("/analyze/nvidia?model=fake/nonexistent-model")
|
||||||
|
assert response.status_code == 400
|
||||||
|
assert "Unsupported model" in response.json()["detail"]
|
||||||
|
|
||||||
|
def test_analyze_accepts_supported_model(self, client, mock_analyzer):
|
||||||
|
"""GET /analyze/{company} with a supported model succeeds."""
|
||||||
|
mock_result = CompanyAnalysisResult(
|
||||||
|
company_name="nvidia",
|
||||||
|
analysis="test",
|
||||||
|
patent_count=1,
|
||||||
|
success=True,
|
||||||
|
timestamp=datetime.now(),
|
||||||
|
model="anthropic/claude-3.5-sonnet",
|
||||||
|
)
|
||||||
|
mock_analyzer._analyze_company_safe.return_value = mock_result
|
||||||
|
|
||||||
|
response = client.get("/analyze/nvidia?model=anthropic/claude-3.5-sonnet")
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
def test_batch_rejects_unsupported_model(self, client, mock_analyzer):
|
||||||
|
"""POST /analyze/batch with unsupported model returns 400."""
|
||||||
|
response = client.post(
|
||||||
|
"/analyze/batch",
|
||||||
|
json={"companies": ["nvidia"], "model": "fake/nonexistent-model"},
|
||||||
|
)
|
||||||
|
assert response.status_code == 400
|
||||||
|
assert "Unsupported model" in response.json()["detail"]
|
||||||
|
|
||||||
|
def test_list_models_returns_supported(self, client):
|
||||||
|
"""GET /models returns the allow-list."""
|
||||||
|
response = client.get("/models")
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "models" in data
|
||||||
|
assert "default" in data
|
||||||
|
assert len(data["models"]) > 0
|
||||||
|
assert all("id" in m and "name" in m and "provider" in m for m in data["models"])
|
||||||
|
|||||||
+209
-9
@@ -1,13 +1,29 @@
|
|||||||
"""Tests for JWT authentication flow: register, login, protected routes, refresh, admin access."""
|
"""Tests for JWT authentication flow: register, login, protected routes, refresh, admin access.
|
||||||
|
|
||||||
from datetime import datetime, timezone
|
Covers all five scenarios required by issue #1624:
|
||||||
|
1. Registration (POST /auth/register)
|
||||||
|
2. Login (POST /auth/login)
|
||||||
|
3. Protected route access (GET /auth/me) -- valid, missing, expired, wrong-type tokens
|
||||||
|
4. Token refresh (POST /auth/refresh)
|
||||||
|
5. Admin-only endpoints (GET /admin/users, PATCH role, DELETE user)
|
||||||
|
|
||||||
|
All tests use mocked DB fixtures and require no live database.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
from unittest.mock import MagicMock, patch
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import jwt as pyjwt
|
||||||
import pytest
|
import pytest
|
||||||
from fastapi.testclient import TestClient
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
from SPARC.api import app
|
from SPARC.api import app
|
||||||
from SPARC.auth import create_access_token, create_refresh_token
|
from SPARC.auth import (
|
||||||
|
JWT_ALGORITHM,
|
||||||
|
JWT_SECRET,
|
||||||
|
create_access_token,
|
||||||
|
create_refresh_token,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -171,12 +187,6 @@ class TestGetMe:
|
|||||||
|
|
||||||
def test_expired_token_returns_401(self, client, mock_db):
|
def test_expired_token_returns_401(self, client, mock_db):
|
||||||
"""An expired token should return 401."""
|
"""An expired token should return 401."""
|
||||||
# Create a token that has already expired
|
|
||||||
from datetime import timedelta
|
|
||||||
|
|
||||||
import jwt as pyjwt
|
|
||||||
from SPARC.auth import JWT_ALGORITHM, JWT_SECRET
|
|
||||||
|
|
||||||
payload = {
|
payload = {
|
||||||
"sub": "1",
|
"sub": "1",
|
||||||
"email": "user@test.com",
|
"email": "user@test.com",
|
||||||
@@ -300,3 +310,193 @@ class TestAdminUsers:
|
|||||||
|
|
||||||
assert response.status_code == 400
|
assert response.status_code == 400
|
||||||
assert "own role" in response.json()["detail"].lower()
|
assert "own role" in response.json()["detail"].lower()
|
||||||
|
|
||||||
|
def test_role_change_nonexistent_user_returns_404(self, client, mock_db):
|
||||||
|
"""Changing role for a user that does not exist should return 404."""
|
||||||
|
admin = _make_admin_user()
|
||||||
|
mock_db.get_user_by_id.return_value = admin
|
||||||
|
mock_db.update_user_role.return_value = None
|
||||||
|
|
||||||
|
response = client.patch(
|
||||||
|
"/admin/users/999/role",
|
||||||
|
json={"role": "admin"},
|
||||||
|
headers=_auth_header(admin),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 404
|
||||||
|
assert "not found" in response.json()["detail"].lower()
|
||||||
|
|
||||||
|
def test_regular_user_cannot_change_role(self, client, mock_db):
|
||||||
|
"""Non-admin user should receive 403 when trying to change roles."""
|
||||||
|
user = _make_regular_user()
|
||||||
|
mock_db.get_user_by_id.return_value = user
|
||||||
|
|
||||||
|
response = client.patch(
|
||||||
|
"/admin/users/1/role",
|
||||||
|
json={"role": "admin"},
|
||||||
|
headers=_auth_header(user),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
|
||||||
|
class TestAdminDeleteUser:
|
||||||
|
"""DELETE /admin/users/{user_id}"""
|
||||||
|
|
||||||
|
def test_admin_can_delete_user(self, client, mock_db):
|
||||||
|
"""Admin should be able to delete another user."""
|
||||||
|
admin = _make_admin_user()
|
||||||
|
mock_db.get_user_by_id.return_value = admin
|
||||||
|
mock_db.delete_user.return_value = True
|
||||||
|
|
||||||
|
response = client.delete(
|
||||||
|
"/admin/users/2",
|
||||||
|
headers=_auth_header(admin),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert "deleted" in response.json()["message"].lower()
|
||||||
|
mock_db.delete_user.assert_called_once_with(2)
|
||||||
|
|
||||||
|
def test_admin_cannot_delete_self(self, client, mock_db):
|
||||||
|
"""Admin should not be able to delete themselves."""
|
||||||
|
admin = _make_admin_user()
|
||||||
|
mock_db.get_user_by_id.return_value = admin
|
||||||
|
|
||||||
|
response = client.delete(
|
||||||
|
"/admin/users/1",
|
||||||
|
headers=_auth_header(admin),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 400
|
||||||
|
assert "yourself" in response.json()["detail"].lower()
|
||||||
|
|
||||||
|
def test_delete_nonexistent_user_returns_404(self, client, mock_db):
|
||||||
|
"""Deleting a user that does not exist should return 404."""
|
||||||
|
admin = _make_admin_user()
|
||||||
|
mock_db.get_user_by_id.return_value = admin
|
||||||
|
mock_db.delete_user.return_value = False
|
||||||
|
|
||||||
|
response = client.delete(
|
||||||
|
"/admin/users/999",
|
||||||
|
headers=_auth_header(admin),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 404
|
||||||
|
assert "not found" in response.json()["detail"].lower()
|
||||||
|
|
||||||
|
def test_regular_user_cannot_delete_user(self, client, mock_db):
|
||||||
|
"""Non-admin user should receive 403 when trying to delete users."""
|
||||||
|
user = _make_regular_user()
|
||||||
|
mock_db.get_user_by_id.return_value = user
|
||||||
|
|
||||||
|
response = client.delete(
|
||||||
|
"/admin/users/1",
|
||||||
|
headers=_auth_header(user),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
def test_no_token_cannot_delete_user(self, client):
|
||||||
|
"""Missing token should be rejected for delete endpoint."""
|
||||||
|
response = client.delete("/admin/users/1")
|
||||||
|
assert response.status_code in (401, 403)
|
||||||
|
|
||||||
|
|
||||||
|
class TestEdgeCases:
|
||||||
|
"""Additional edge-case tests for auth robustness."""
|
||||||
|
|
||||||
|
def test_register_invalid_email_returns_422(self, client, mock_db):
|
||||||
|
"""Registration with an invalid email format should return 422."""
|
||||||
|
response = client.post(
|
||||||
|
"/auth/register",
|
||||||
|
json={"email": "not-an-email", "password": "securepass123"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_register_short_password_returns_422(self, client, mock_db):
|
||||||
|
"""Registration with a password shorter than 8 chars should return 422."""
|
||||||
|
response = client.post(
|
||||||
|
"/auth/register",
|
||||||
|
json={"email": "user@test.com", "password": "short"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_register_missing_fields_returns_422(self, client, mock_db):
|
||||||
|
"""Registration with missing fields should return 422."""
|
||||||
|
response = client.post("/auth/register", json={})
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_login_missing_fields_returns_422(self, client, mock_db):
|
||||||
|
"""Login with missing fields should return 422."""
|
||||||
|
response = client.post("/auth/login", json={"email": "user@test.com"})
|
||||||
|
assert response.status_code == 422
|
||||||
|
|
||||||
|
def test_malformed_token_returns_401(self, client, mock_db):
|
||||||
|
"""A completely malformed token string should return 401."""
|
||||||
|
response = client.get(
|
||||||
|
"/auth/me",
|
||||||
|
headers={"Authorization": "Bearer not.a.valid.jwt.token"},
|
||||||
|
)
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_token_with_wrong_secret_returns_401(self, client, mock_db):
|
||||||
|
"""A token signed with a different secret should return 401."""
|
||||||
|
payload = {
|
||||||
|
"sub": "1",
|
||||||
|
"email": "user@test.com",
|
||||||
|
"role": "user",
|
||||||
|
"exp": datetime.now(timezone.utc) + timedelta(hours=1),
|
||||||
|
"type": "access",
|
||||||
|
}
|
||||||
|
wrong_secret_token = pyjwt.encode(payload, "wrong-secret", algorithm=JWT_ALGORITHM)
|
||||||
|
|
||||||
|
response = client.get(
|
||||||
|
"/auth/me",
|
||||||
|
headers={"Authorization": f"Bearer {wrong_secret_token}"},
|
||||||
|
)
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_token_for_deleted_user_returns_401(self, client, mock_db):
|
||||||
|
"""A valid token for a user no longer in the DB should return 401."""
|
||||||
|
user = _make_regular_user()
|
||||||
|
mock_db.get_user_by_id.return_value = None # user was deleted
|
||||||
|
|
||||||
|
response = client.get("/auth/me", headers=_auth_header(user))
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_refresh_for_deleted_user_returns_401(self, client, mock_db):
|
||||||
|
"""Refreshing a token for a deleted user should return 401."""
|
||||||
|
user = _make_regular_user()
|
||||||
|
mock_db.get_user_by_id.return_value = None
|
||||||
|
refresh = create_refresh_token(user["id"], user["email"], user["role"])
|
||||||
|
|
||||||
|
response = client.post(
|
||||||
|
"/auth/refresh", json={"refresh_token": refresh}
|
||||||
|
)
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_login_returns_decodable_tokens(self, client, mock_db):
|
||||||
|
"""Tokens returned by login should be decodable and contain expected claims."""
|
||||||
|
user = _make_regular_user()
|
||||||
|
mock_db.authenticate_user.return_value = user
|
||||||
|
|
||||||
|
response = client.post(
|
||||||
|
"/auth/login",
|
||||||
|
json={"email": "user@test.com", "password": "correctpassword"},
|
||||||
|
)
|
||||||
|
|
||||||
|
data = response.json()
|
||||||
|
access_payload = pyjwt.decode(
|
||||||
|
data["access_token"], JWT_SECRET, algorithms=[JWT_ALGORITHM]
|
||||||
|
)
|
||||||
|
assert access_payload["sub"] == str(user["id"])
|
||||||
|
assert access_payload["email"] == user["email"]
|
||||||
|
assert access_payload["type"] == "access"
|
||||||
|
|
||||||
|
refresh_payload = pyjwt.decode(
|
||||||
|
data["refresh_token"], JWT_SECRET, algorithms=[JWT_ALGORITHM]
|
||||||
|
)
|
||||||
|
assert refresh_payload["type"] == "refresh"
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
"""Tests for rate limiting on auth endpoints."""
|
"""Tests for rate limiting on auth endpoints."""
|
||||||
|
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from unittest.mock import Mock, patch, MagicMock
|
|
||||||
from fastapi.testclient import TestClient
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
from SPARC.api import app
|
from SPARC.api import app
|
||||||
|
|||||||
@@ -0,0 +1,109 @@
|
|||||||
|
"""Tests for the /admin/rate-limits endpoint."""
|
||||||
|
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
from SPARC import api
|
||||||
|
from SPARC.api import app
|
||||||
|
from SPARC.auth import UserResponse
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def client():
|
||||||
|
"""Create test client."""
|
||||||
|
return TestClient(app)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def reset_stats():
|
||||||
|
"""Reset rate limit stats between tests."""
|
||||||
|
api._rate_limit_stats.clear()
|
||||||
|
yield
|
||||||
|
api._rate_limit_stats.clear()
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_admin():
|
||||||
|
"""Return a mock admin user."""
|
||||||
|
return UserResponse(id=1, email="admin@test.com", role="admin", created_at="2025-01-01T00:00:00")
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_user():
|
||||||
|
"""Return a mock non-admin user."""
|
||||||
|
return UserResponse(id=2, email="user@test.com", role="user", created_at="2025-01-01T00:00:00")
|
||||||
|
|
||||||
|
|
||||||
|
class TestRateLimitAdminEndpoint:
|
||||||
|
"""Test GET /admin/rate-limits."""
|
||||||
|
|
||||||
|
def test_admin_can_access(self, client):
|
||||||
|
"""Admin users should be able to access the rate-limits endpoint."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "rate_limits" in data
|
||||||
|
assert isinstance(data["rate_limits"], list)
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_non_admin_rejected(self, client):
|
||||||
|
"""Non-admin users should get 403."""
|
||||||
|
# Without overriding the dependency, it should fail auth
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
assert response.status_code in (401, 403)
|
||||||
|
|
||||||
|
def test_returns_configured_endpoints(self, client):
|
||||||
|
"""Should list all rate-limited endpoints."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
endpoints = [rl["endpoint"] for rl in data["rate_limits"]]
|
||||||
|
assert "/auth/register" in endpoints
|
||||||
|
assert "/auth/login" in endpoints
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_empty_state_shows_zero_counts(self, client):
|
||||||
|
"""When no requests have been made, counts should be zero."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
data = response.json()
|
||||||
|
for rl in data["rate_limits"]:
|
||||||
|
assert rl["total_requests"] == 0
|
||||||
|
assert rl["rejected_requests"] == 0
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_tracks_requests(self, client):
|
||||||
|
"""After making requests, the stats should reflect them."""
|
||||||
|
api._track_rate_limit_request("/auth/login", "127.0.0.1")
|
||||||
|
api._track_rate_limit_request("/auth/login", "127.0.0.1")
|
||||||
|
api._track_rate_limit_request("/auth/login", "192.168.1.1", rejected=True)
|
||||||
|
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
data = response.json()
|
||||||
|
login_stats = next(rl for rl in data["rate_limits"] if rl["endpoint"] == "/auth/login")
|
||||||
|
assert login_stats["total_requests"] == 3
|
||||||
|
assert login_stats["rejected_requests"] == 1
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
|
|
||||||
|
def test_includes_limit_config(self, client):
|
||||||
|
"""Each endpoint entry should include the rate limit config string."""
|
||||||
|
app.dependency_overrides[api.get_current_admin] = _mock_admin
|
||||||
|
try:
|
||||||
|
response = client.get("/admin/rate-limits")
|
||||||
|
data = response.json()
|
||||||
|
for rl in data["rate_limits"]:
|
||||||
|
assert "limit" in rl
|
||||||
|
assert isinstance(rl["limit"], str)
|
||||||
|
finally:
|
||||||
|
app.dependency_overrides.clear()
|
||||||
@@ -14,6 +14,7 @@ class TestJWTSecretStartupCheck:
|
|||||||
with patch.dict(os.environ, {"APP_ENV": "production"}):
|
with patch.dict(os.environ, {"APP_ENV": "production"}):
|
||||||
# Reload config to pick up the new APP_ENV
|
# Reload config to pick up the new APP_ENV
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
import SPARC.config
|
import SPARC.config
|
||||||
importlib.reload(SPARC.config)
|
importlib.reload(SPARC.config)
|
||||||
|
|
||||||
@@ -31,6 +32,7 @@ class TestJWTSecretStartupCheck:
|
|||||||
"""Starting with default secret and APP_ENV=development must not raise."""
|
"""Starting with default secret and APP_ENV=development must not raise."""
|
||||||
with patch.dict(os.environ, {"APP_ENV": "development"}):
|
with patch.dict(os.environ, {"APP_ENV": "development"}):
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
import SPARC.config
|
import SPARC.config
|
||||||
importlib.reload(SPARC.config)
|
importlib.reload(SPARC.config)
|
||||||
|
|
||||||
@@ -46,6 +48,7 @@ class TestJWTSecretStartupCheck:
|
|||||||
"""Starting with a custom secret in production must not raise."""
|
"""Starting with a custom secret in production must not raise."""
|
||||||
with patch.dict(os.environ, {"APP_ENV": "production"}):
|
with patch.dict(os.environ, {"APP_ENV": "production"}):
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
import SPARC.config
|
import SPARC.config
|
||||||
importlib.reload(SPARC.config)
|
importlib.reload(SPARC.config)
|
||||||
|
|
||||||
@@ -65,6 +68,7 @@ class TestJWTSecretStartupCheck:
|
|||||||
env.pop("APP_ENV", None)
|
env.pop("APP_ENV", None)
|
||||||
with patch.dict(os.environ, env, clear=True):
|
with patch.dict(os.environ, env, clear=True):
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
import SPARC.config
|
import SPARC.config
|
||||||
importlib.reload(SPARC.config)
|
importlib.reload(SPARC.config)
|
||||||
|
|
||||||
@@ -84,6 +88,7 @@ class TestCORSConfig:
|
|||||||
"""When CORS_ORIGINS is unset, defaults to localhost origins."""
|
"""When CORS_ORIGINS is unset, defaults to localhost origins."""
|
||||||
with patch.dict(os.environ, {"CORS_ORIGINS": ""}):
|
with patch.dict(os.environ, {"CORS_ORIGINS": ""}):
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
import SPARC.config
|
import SPARC.config
|
||||||
importlib.reload(SPARC.config)
|
importlib.reload(SPARC.config)
|
||||||
assert SPARC.config.cors_origins == [
|
assert SPARC.config.cors_origins == [
|
||||||
@@ -95,6 +100,7 @@ class TestCORSConfig:
|
|||||||
"""Setting CORS_ORIGINS configures allowed origins."""
|
"""Setting CORS_ORIGINS configures allowed origins."""
|
||||||
with patch.dict(os.environ, {"CORS_ORIGINS": "https://sparc.example.com,https://app.example.com"}):
|
with patch.dict(os.environ, {"CORS_ORIGINS": "https://sparc.example.com,https://app.example.com"}):
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
import SPARC.config
|
import SPARC.config
|
||||||
importlib.reload(SPARC.config)
|
importlib.reload(SPARC.config)
|
||||||
assert SPARC.config.cors_origins == [
|
assert SPARC.config.cors_origins == [
|
||||||
@@ -109,6 +115,7 @@ class TestCORSConfig:
|
|||||||
"""A single origin without comma works correctly."""
|
"""A single origin without comma works correctly."""
|
||||||
with patch.dict(os.environ, {"CORS_ORIGINS": "https://sparc.example.com"}):
|
with patch.dict(os.environ, {"CORS_ORIGINS": "https://sparc.example.com"}):
|
||||||
import importlib
|
import importlib
|
||||||
|
|
||||||
import SPARC.config
|
import SPARC.config
|
||||||
importlib.reload(SPARC.config)
|
importlib.reload(SPARC.config)
|
||||||
assert SPARC.config.cors_origins == ["https://sparc.example.com"]
|
assert SPARC.config.cors_origins == ["https://sparc.example.com"]
|
||||||
|
|||||||
@@ -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,262 @@
|
|||||||
|
"""Tests for the webhook background task queue.
|
||||||
|
|
||||||
|
Covers:
|
||||||
|
- Worker lifecycle (start / stop / idempotent start)
|
||||||
|
- Tasks are processed asynchronously by the worker
|
||||||
|
- Retry logic is preserved (executed inside the worker thread)
|
||||||
|
- enqueue_notify / enqueue_job_completed / enqueue_alert non-blocking helpers
|
||||||
|
- Integration: queued webhook task is eventually delivered (mocked HTTP)
|
||||||
|
"""
|
||||||
|
|
||||||
|
import threading
|
||||||
|
import time
|
||||||
|
from unittest.mock import MagicMock, call, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from SPARC.task_queue import (
|
||||||
|
WebhookTask,
|
||||||
|
drain,
|
||||||
|
enqueue,
|
||||||
|
queue_size,
|
||||||
|
start_worker,
|
||||||
|
stop_worker,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Fixtures
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _worker_lifecycle():
|
||||||
|
"""Start the worker before each test and stop it after."""
|
||||||
|
start_worker()
|
||||||
|
yield
|
||||||
|
stop_worker(timeout=3)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Worker lifecycle
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestWorkerLifecycle:
|
||||||
|
def test_start_is_idempotent(self):
|
||||||
|
"""Calling start_worker() twice does not create a second thread."""
|
||||||
|
import SPARC.task_queue as tq
|
||||||
|
|
||||||
|
first = tq._worker_thread
|
||||||
|
start_worker()
|
||||||
|
assert tq._worker_thread is first
|
||||||
|
|
||||||
|
def test_stop_worker_gracefully(self):
|
||||||
|
"""stop_worker joins the thread cleanly."""
|
||||||
|
import SPARC.task_queue as tq
|
||||||
|
|
||||||
|
assert tq._worker_thread is not None
|
||||||
|
stop_worker(timeout=3)
|
||||||
|
assert tq._worker_thread is None
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Task processing
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestTaskProcessing:
|
||||||
|
@patch("SPARC.webhooks._send_with_retry")
|
||||||
|
def test_enqueued_task_is_delivered(self, mock_send):
|
||||||
|
"""A task put on the queue is eventually processed by the worker."""
|
||||||
|
mock_send.return_value = True
|
||||||
|
task = WebhookTask(url="https://example.com/hook", payload={"event": "test"})
|
||||||
|
|
||||||
|
enqueue(task)
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
mock_send.assert_called_once_with("https://example.com/hook", {"event": "test"})
|
||||||
|
|
||||||
|
@patch("SPARC.webhooks._send_with_retry")
|
||||||
|
def test_multiple_tasks_processed_in_order(self, mock_send):
|
||||||
|
"""Tasks are processed FIFO."""
|
||||||
|
mock_send.return_value = True
|
||||||
|
|
||||||
|
for i in range(3):
|
||||||
|
enqueue(WebhookTask(url=f"https://example.com/{i}", payload={"n": i}))
|
||||||
|
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
assert mock_send.call_count == 3
|
||||||
|
urls = [c[0][0] for c in mock_send.call_args_list]
|
||||||
|
assert urls == [
|
||||||
|
"https://example.com/0",
|
||||||
|
"https://example.com/1",
|
||||||
|
"https://example.com/2",
|
||||||
|
]
|
||||||
|
|
||||||
|
@patch("SPARC.webhooks._send_with_retry")
|
||||||
|
def test_enqueue_returns_immediately(self, mock_send):
|
||||||
|
"""enqueue() does not block even if the worker is slow."""
|
||||||
|
event = threading.Event()
|
||||||
|
|
||||||
|
def slow_send(url, payload):
|
||||||
|
event.wait(timeout=5)
|
||||||
|
return True
|
||||||
|
|
||||||
|
mock_send.side_effect = slow_send
|
||||||
|
|
||||||
|
start = time.monotonic()
|
||||||
|
enqueue(WebhookTask(url="https://slow.example.com", payload={}))
|
||||||
|
elapsed = time.monotonic() - start
|
||||||
|
|
||||||
|
# enqueue should return in well under 1 second
|
||||||
|
assert elapsed < 0.5
|
||||||
|
|
||||||
|
# Let the worker finish
|
||||||
|
event.set()
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
@patch("SPARC.webhooks._send_with_retry", side_effect=RuntimeError("boom"))
|
||||||
|
def test_worker_survives_unexpected_error(self, mock_send):
|
||||||
|
"""An unexpected exception in delivery does not kill the worker."""
|
||||||
|
enqueue(WebhookTask(url="https://example.com/bad", payload={}))
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
# Worker is still alive; enqueue another task
|
||||||
|
mock_send.side_effect = None
|
||||||
|
mock_send.return_value = True
|
||||||
|
|
||||||
|
enqueue(WebhookTask(url="https://example.com/good", payload={"ok": True}))
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
assert mock_send.call_count == 2
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Retry logic preserved in worker context
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestRetryInWorker:
|
||||||
|
@patch("SPARC.webhooks.time.sleep")
|
||||||
|
@patch("SPARC.webhooks.requests.post")
|
||||||
|
def test_retry_logic_runs_inside_worker(self, mock_post, mock_sleep):
|
||||||
|
"""The worker thread uses _send_with_retry, which retries on failure."""
|
||||||
|
mock_post.side_effect = [
|
||||||
|
MagicMock(status_code=500),
|
||||||
|
MagicMock(status_code=200),
|
||||||
|
]
|
||||||
|
|
||||||
|
enqueue(WebhookTask(
|
||||||
|
url="https://example.com/retry",
|
||||||
|
payload={"event": "test"},
|
||||||
|
))
|
||||||
|
drain(timeout=10)
|
||||||
|
|
||||||
|
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_in_worker(self, mock_post, mock_sleep):
|
||||||
|
"""Worker handles permanent failure gracefully."""
|
||||||
|
mock_post.return_value = MagicMock(status_code=500)
|
||||||
|
|
||||||
|
enqueue(WebhookTask(
|
||||||
|
url="https://example.com/fail",
|
||||||
|
payload={"event": "test"},
|
||||||
|
))
|
||||||
|
drain(timeout=10)
|
||||||
|
|
||||||
|
from SPARC.webhooks import MAX_RETRIES
|
||||||
|
assert mock_post.call_count == MAX_RETRIES
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Integration: enqueue_notify and convenience helpers
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class TestEnqueueHelpers:
|
||||||
|
@patch("SPARC.webhooks._send_with_retry")
|
||||||
|
@patch("SPARC.webhooks.WEBHOOK_URLS", ["https://example.com/hook"])
|
||||||
|
def test_enqueue_notify_delivers_via_worker(self, mock_send):
|
||||||
|
"""enqueue_notify puts a task on the queue and the worker delivers it."""
|
||||||
|
mock_send.return_value = True
|
||||||
|
|
||||||
|
from SPARC.webhooks import enqueue_notify
|
||||||
|
enqueue_notify("test_event", {"key": "val"})
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
mock_send.assert_called_once()
|
||||||
|
url, payload = mock_send.call_args[0]
|
||||||
|
assert url == "https://example.com/hook"
|
||||||
|
assert payload["event"] == "test_event"
|
||||||
|
assert payload["key"] == "val"
|
||||||
|
|
||||||
|
@patch("SPARC.webhooks._send_with_retry")
|
||||||
|
@patch("SPARC.webhooks.WEBHOOK_URLS", ["https://example.com/hook"])
|
||||||
|
def test_enqueue_job_completed(self, mock_send):
|
||||||
|
"""enqueue_job_completed sends job completion data via the queue."""
|
||||||
|
mock_send.return_value = True
|
||||||
|
|
||||||
|
from SPARC.webhooks import enqueue_job_completed
|
||||||
|
enqueue_job_completed(
|
||||||
|
job_id="job-1",
|
||||||
|
status="completed",
|
||||||
|
total_companies=5,
|
||||||
|
successful=4,
|
||||||
|
failed=1,
|
||||||
|
)
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
mock_send.assert_called_once()
|
||||||
|
payload = mock_send.call_args[0][1]
|
||||||
|
assert payload["event"] == "job_completed"
|
||||||
|
assert payload["job_id"] == "job-1"
|
||||||
|
assert payload["successful"] == 4
|
||||||
|
|
||||||
|
@patch("SPARC.webhooks._send_with_retry")
|
||||||
|
@patch("SPARC.webhooks.WEBHOOK_URLS", ["https://example.com/hook"])
|
||||||
|
def test_enqueue_alert(self, mock_send):
|
||||||
|
"""enqueue_alert sends alert data via the queue."""
|
||||||
|
mock_send.return_value = True
|
||||||
|
|
||||||
|
from SPARC.webhooks import enqueue_alert
|
||||||
|
enqueue_alert(
|
||||||
|
company_name="NVIDIA",
|
||||||
|
alert_type="patent_count_change",
|
||||||
|
message="Patent count increased by 30%",
|
||||||
|
)
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
mock_send.assert_called_once()
|
||||||
|
payload = mock_send.call_args[0][1]
|
||||||
|
assert payload["event"] == "patent_alert"
|
||||||
|
assert payload["company_name"] == "NVIDIA"
|
||||||
|
|
||||||
|
@patch("SPARC.webhooks._send_with_retry")
|
||||||
|
@patch("SPARC.webhooks.WEBHOOK_URLS", [])
|
||||||
|
def test_enqueue_notify_noop_when_no_urls(self, mock_send):
|
||||||
|
"""enqueue_notify is a no-op when WEBHOOK_URLS is empty."""
|
||||||
|
from SPARC.webhooks import enqueue_notify
|
||||||
|
enqueue_notify("test_event", {"key": "val"})
|
||||||
|
drain(timeout=2)
|
||||||
|
|
||||||
|
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_enqueue_notify_slack_formatting(self, mock_send):
|
||||||
|
"""Slack URLs get Slack-formatted payloads even via the queue."""
|
||||||
|
mock_send.return_value = True
|
||||||
|
|
||||||
|
from SPARC.webhooks import enqueue_notify
|
||||||
|
enqueue_notify("test_event", {"key": "val"})
|
||||||
|
drain(timeout=5)
|
||||||
|
|
||||||
|
assert mock_send.call_count == 2
|
||||||
|
slack_payload = mock_send.call_args_list[0][0][1]
|
||||||
|
assert "text" in slack_payload
|
||||||
|
|
||||||
|
generic_payload = mock_send.call_args_list[1][0][1]
|
||||||
|
assert "event" in generic_payload
|
||||||
@@ -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