interloper-api 0.57.0__tar.gz → 0.58.0__tar.gz

{interloper_api-0.57.0 → interloper_api-0.58.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: interloper-api
-Version: 0.57.0
+Version: 0.58.0
 Summary: Interloper FastAPI routes
 Author: Guillaume Onfroy
 Author-email: Guillaume Onfroy <guillaume@digitlcloud.com>

{interloper_api-0.57.0 → interloper_api-0.58.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "interloper-api"
-version = "0.57.0"
+version = "0.58.0"
 description = "Interloper FastAPI routes"
 readme = "README.md"
 requires-python = ">=3.10"

{interloper_api-0.57.0 → interloper_api-0.58.0}/pyproject.toml.orig

@@ -3,7 +3,7 @@
 # ###############
 [project]
 name = "interloper-api"
-version = "0.57.0"
+version = "0.58.0"
 description = "Interloper FastAPI routes"
 readme = "README.md"
 authors = [{ name = "Guillaume Onfroy", email = "guillaume@digitlcloud.com" }]

{interloper_api-0.57.0 → interloper_api-0.58.0}/src/interloper_api/app.py

@@ -9,7 +9,7 @@ from fastapi import APIRouter, FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse
 from interloper.catalog.base import Catalog
-from interloper.errors import ComponentDriftError, NotFoundError
+from interloper.errors import ComponentDriftError, NotFoundError, QuotaExceededError
 from interloper_db import Store
 
 from interloper_api.dependencies import (
@@ -17,6 +17,7 @@ from interloper_api.dependencies import (
     set_auth_config,
     set_catalog,
     set_features,
+    set_quota_defaults,
     set_smtp_config,
     set_store,
 )
@@ -76,6 +77,14 @@ def create_app(
         """
         return JSONResponse(status_code=409, content={"detail": str(exc)})
 
+    @app.exception_handler(QuotaExceededError)
+    async def _quota_exceeded_handler(_request: Request, exc: QuotaExceededError) -> JSONResponse:
+        """Store-level quota enforcement surfaces as 429 with structured context."""
+        return JSONResponse(
+            status_code=429,
+            content={"detail": {"message": str(exc), "quota": exc.quota, "limit": exc.limit, "used": exc.used}},
+        )
+
     if cors_origins:
         app.add_middleware(
             CORSMiddleware,
@@ -92,6 +101,7 @@ def create_app(
     if settings:
         set_auth_config(settings.auth)
         set_smtp_config(settings.smtp)
+        set_quota_defaults(settings.quota)
 
     api = APIRouter(prefix="/api")
     api.include_router(auth.router)

{interloper_api-0.57.0 → interloper_api-0.58.0}/src/interloper_api/dependencies.py

@@ -18,6 +18,7 @@ _auth_config: Any | None = None
 _smtp_config: Any | None = None
 _features: dict[str, bool] = {}
 _admin_config: Any | None = None
+_quota_defaults: Any | None = None
 
 # Role hierarchy: admin > editor > viewer
 _ROLE_RANK = {"viewer": 0, "editor": 1, "admin": 2}
@@ -154,6 +155,25 @@ def get_admin_config() -> Any:
     return _admin_config
 
 
+def set_quota_defaults(defaults: Any) -> None:
+    """Set the global default quota limits (from settings, at app creation).
+
+    Args:
+        defaults: The QuotaSettings instance.
+    """
+    global _quota_defaults  # noqa: PLW0603
+    _quota_defaults = defaults
+
+
+def get_quota_defaults() -> Any:
+    """Return the global default quota limits.
+
+    Returns:
+        The QuotaSettings instance, or None if not configured.
+    """
+    return _quota_defaults
+
+
 # -- Auth dependencies -------------------------------------------------------
 
 

{interloper_api-0.57.0 → interloper_api-0.58.0}/src/interloper_api/routes/admin.py

@@ -8,6 +8,7 @@ no access to org-scoped *data* (sources, jobs, runs, …).
 
 from __future__ import annotations
 
+import datetime as dt
 import inspect
 import logging
 from datetime import datetime
@@ -17,9 +18,10 @@ from uuid import UUID
 
 from fastapi import APIRouter, Depends, HTTPException, Request
 from interloper_db import Organisation, Profile, Store
+from interloper_db.store.quotas import METRIC_SUCCESSFUL_RUNS
 from pydantic import BaseModel
 
-from interloper_api.dependencies import get_admin_config, get_store, require_super_admin
+from interloper_api.dependencies import get_admin_config, get_quota_defaults, get_store, require_super_admin
 from interloper_api.email import send_invite_email
 
 logger = logging.getLogger(__name__)
@@ -223,6 +225,38 @@ class AdminDataConfig(BaseModel):
     catalog: dict[str, list[str]]
 
 
+class AdminQuotaLimits(BaseModel):
+    """One set of quota limits; null means unlimited (or unset, for overrides)."""
+
+    max_sources: int | None = None
+    max_assets_per_source: int | None = None
+    max_successful_runs_per_month: int | None = None
+
+
+class AdminOrgQuotaStatus(BaseModel):
+    """One organisation's quota limits and current usage."""
+
+    id: UUID
+    name: str
+    limits: AdminQuotaLimits
+    effective: AdminQuotaLimits
+    sources: int
+    max_assets_per_source: int
+    successful_runs: int
+    reserved_runs: int
+    #: Recomputed from the runs table; a mismatch with ``successful_runs``
+    #: (the ledger) signals counter drift.
+    recomputed_successful_runs: int
+
+
+class AdminQuotasResponse(BaseModel):
+    """Quota overview: global defaults plus per-organisation status."""
+
+    period_start: dt.date
+    defaults: AdminQuotaLimits
+    organisations: list[AdminOrgQuotaStatus]
+
+
 class AdminConfigResponse(BaseModel):
     """Read-only, secrets-redacted snapshot of the instance configuration."""
 
@@ -230,6 +264,7 @@ class AdminConfigResponse(BaseModel):
     auth: AdminAuthConfig
     services: AdminServicesConfig
     data: AdminDataConfig
+    quotas: AdminQuotaLimits
 
 
 # Non-secret launcher/runner config keys exposed on /admin/config. Anything not
@@ -400,12 +435,39 @@ def build_config_snapshot(settings: Any, features: dict[str, bool], catalog: Any
             encryption_configured=bool(settings.secrets.encryption_key),
             catalog=_catalog_by_kind(catalog) if catalog is not None else {},
         ),
+        quotas=_quota_limits(settings.quota),
     )
 
 
 # -- Helpers ------------------------------------------------------------------
 
 
+def _quota_limits(limits: Any) -> AdminQuotaLimits:
+    """Map any limits-shaped object (settings, Quota row, None) to the model."""
+    return AdminQuotaLimits(
+        max_sources=getattr(limits, "max_sources", None),
+        max_assets_per_source=getattr(limits, "max_assets_per_source", None),
+        max_successful_runs_per_month=getattr(limits, "max_successful_runs_per_month", None),
+    )
+
+
+def _effective_limits(overrides: AdminQuotaLimits, defaults: AdminQuotaLimits) -> AdminQuotaLimits:
+    """Per-org overrides win field-by-field over the global defaults."""
+    return AdminQuotaLimits(
+        max_sources=overrides.max_sources if overrides.max_sources is not None else defaults.max_sources,
+        max_assets_per_source=(
+            overrides.max_assets_per_source
+            if overrides.max_assets_per_source is not None
+            else defaults.max_assets_per_source
+        ),
+        max_successful_runs_per_month=(
+            overrides.max_successful_runs_per_month
+            if overrides.max_successful_runs_per_month is not None
+            else defaults.max_successful_runs_per_month
+        ),
+    )
+
+
 def _require_org(store: Store, org_id: UUID) -> Organisation:
     """Fetch an organisation or raise 404."""
     org = store.get_organisation(org_id)
@@ -466,6 +528,48 @@ def get_instance_config(
     return config
 
 
+# -- Quotas ---------------------------------------------------------------------
+
+
+@router.get("/quotas")
+def get_quotas(
+    user: Profile = Depends(require_super_admin),
+    store: Store = Depends(get_store),
+    quota_defaults: Any = Depends(get_quota_defaults),
+) -> AdminQuotasResponse:
+    """Quota limits and current-period usage for every organisation."""
+    defaults = _quota_limits(quota_defaults)
+    period_start = store.current_period_start()
+    overrides = {quota.org_id: quota for quota in store.list_quotas()}
+    usage = {
+        row.org_id: row
+        for row in store.list_usage(period_start=period_start)
+        if row.metric == METRIC_SUCCESSFUL_RUNS
+    }
+    sources = store.count_sources_by_org()
+    max_assets = store.max_assets_per_source_by_org()
+    recomputed = store.count_successful_runs_by_org(period_start)
+
+    organisations = []
+    for org, _member_count in store.list_all_organisations():
+        limits = _quota_limits(overrides.get(org.id))
+        org_usage = usage.get(org.id)
+        organisations.append(
+            AdminOrgQuotaStatus(
+                id=org.id,
+                name=org.name,
+                limits=limits,
+                effective=_effective_limits(limits, defaults),
+                sources=sources.get(org.id, 0),
+                max_assets_per_source=max_assets.get(org.id, 0),
+                successful_runs=org_usage.used if org_usage else 0,
+                reserved_runs=org_usage.reserved if org_usage else 0,
+                recomputed_successful_runs=recomputed.get(org.id, 0),
+            )
+        )
+    return AdminQuotasResponse(period_start=period_start, defaults=defaults, organisations=organisations)
+
+
 # -- Users --------------------------------------------------------------------
 
 

{interloper_api-0.57.0 → interloper_api-0.58.0}/src/interloper_api/routes/backfills.py

@@ -1,4 +1,4 @@
-"""Backfills API: read endpoints for backfill state."""
+"""Backfills API: queue, inspect, and cancel backfills."""
 
 from __future__ import annotations
 
@@ -100,14 +100,17 @@ def create_backfill(
     job = load_authorized(
         lambda i: store.get_component(i, kind="job"), body.component_id, user, store, label="Job", minimum="editor"
     )
-    backfill = store.create_backfill(
-        job.org_id,
-        component_id=body.component_id,
-        start_date=body.start_date,
-        end_date=body.end_date,
-        concurrency=body.concurrency,
-        fail_fast=body.fail_fast,
-    )
+    try:
+        backfill = store.create_backfill(
+            job.org_id,
+            component_id=body.component_id,
+            start_date=body.start_date,
+            end_date=body.end_date,
+            concurrency=body.concurrency,
+            fail_fast=body.fail_fast,
+        )
+    except ValueError as e:  # span cap
+        raise HTTPException(status_code=400, detail=str(e))
     return _backfill_to_response(backfill)
 
 
@@ -124,3 +127,24 @@ def get_backfill(
         raise HTTPException(status_code=404, detail=f"Backfill {backfill_id} not found")
     authorize_org_member(user, backfill.org_id, store, detail=f"Backfill {backfill_id} not found")
     return _backfill_to_response(backfill)
+
+
+@router.post("/{backfill_id}/cancel")
+def cancel_backfill(
+    backfill_id: UUID,
+    user: Profile = Depends(get_current_user),
+    store: Store = Depends(get_store),
+) -> BackfillResponse:
+    """Cancel a backfill: pending and queued runs are canceled, in-flight runs drain."""
+    try:
+        backfill = store.get_backfill(backfill_id)
+    except NotFoundError:
+        raise HTTPException(status_code=404, detail=f"Backfill {backfill_id} not found")
+    authorize_org_member(
+        user, backfill.org_id, store, minimum="editor", detail=f"Backfill {backfill_id} not found"
+    )
+    try:
+        backfill = store.cancel_backfill(backfill_id)
+    except ValueError as e:
+        raise HTTPException(status_code=409, detail=str(e))
+    return _backfill_to_response(backfill)