interloper-api 0.70.0__tar.gz → 0.72.0__tar.gz

{interloper_api-0.70.0 → interloper_api-0.72.0}/PKG-INFO

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

{interloper_api-0.70.0 → interloper_api-0.72.0}/pyproject.toml

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

{interloper_api-0.70.0 → interloper_api-0.72.0}/pyproject.toml.orig

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

{interloper_api-0.70.0 → interloper_api-0.72.0}/src/interloper_api/app.py

@@ -10,7 +10,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, QuotaExceededError
+from interloper.errors import ComponentDriftError, HydrationError, NotFoundError, QuotaExceededError
 from interloper_db import Store
 
 from interloper_api.dependencies import (
@@ -87,6 +87,25 @@ async def _component_drift(_request: Request, exception: ComponentDriftError) ->
     return JSONResponse(status_code=409, content={"detail": str(exception)})
 
 
+async def _hydration_failed(_request: Request, exception: HydrationError) -> JSONResponse:
+    """Render an unreadable stored record as a conflict rather than a 500.
+
+    A record that cannot be rebuilt from the database (a payload the active
+    ``INTERLOPER_ENCRYPTION_KEY`` cannot decrypt, a stored config the class no
+    longer accepts) stays broken until an operator re-keys or rewrites it, so
+    like drift it surfaces as a 409 carrying the reason instead of an opaque
+    500 that only the server log explains.
+
+    Args:
+        _request: The incoming request, unused.
+        exception: The raised :class:`HydrationError`.
+
+    Returns:
+        A 409 response carrying the exception message as ``detail``.
+    """
+    return JSONResponse(status_code=409, content={"detail": str(exception)})
+
+
 async def _quota_exceeded(_request: Request, exception: QuotaExceededError) -> JSONResponse:
     """Render store-level quota enforcement as a 429 with structured context.
 
@@ -116,6 +135,7 @@ async def _quota_exceeded(_request: Request, exception: QuotaExceededError) -> J
 _ERROR_HANDLERS: dict[type[Exception], Any] = {
     NotFoundError: _not_found,
     ComponentDriftError: _component_drift,
+    HydrationError: _hydration_failed,
     QuotaExceededError: _quota_exceeded,
 }
 

{interloper_api-0.70.0 → interloper_api-0.72.0}/src/interloper_api/routes/components.py

@@ -6,8 +6,9 @@ unsaved config — resolving a FetchField's options (``/resolve``) and
 checking a connection (``/check``).
 
 The response shape is kind-agnostic — identity, drift ``status``, ``config``
-(decoded for secret kinds on detail responses), machine-owned ``state``,
-typed ``relations``, and one level of ``children`` (a source's assets).
+(decoded for secret kinds on detail responses; the schema's ``x-public``
+subset elsewhere), machine-owned ``state``, typed ``relations``, and one
+level of ``children`` (a source's assets).
 What a kind's config looks like and which relation types it may declare
 come from the catalog (``/catalog``), not from this router.
 """
@@ -118,7 +119,12 @@ class ComponentUpdateRequest(BaseModel):
 
 
 class ComponentResponse(BaseModel):
-    """Response body for a component of any kind."""
+    """Response body for a component of any kind.
+
+    A secret kind whose payload does not decrypt carries ``status``
+    ``unreadable`` and no ``config`` at all, rather than a subset that was
+    never read.
+    """
 
     id: UUID
     org_id: UUID
@@ -146,9 +152,15 @@ class ComponentResponse(BaseModel):
     ) -> ComponentResponse:
         """Convert a component row to its response model.
 
-        ``status`` is the catalog-resolution state (drift detection), derived from
-        the same resolver hydration uses. Secret kinds expose their decoded
-        payload as ``config`` only when *include_config* is set (detail responses).
+        ``status`` is the usability state hydration gates on: catalog resolution
+        (drift detection) plus, for an encrypted row, whether its payload
+        decrypts. Secret kinds expose their decoded payload as ``config`` only
+        when *include_config* is set (detail responses); otherwise ``config``
+        carries just the schema's ``x-public`` subset (operational fields such
+        as a connection's ``auto_renew``). An ``unreadable`` row carries no
+        ``config`` either way: the reason rides its ``status``, so the
+        collection still lists and the UI can say what is wrong instead of the
+        request failing over one row.
 
         Args:
             row: The component row to convert.
@@ -165,7 +177,12 @@ class ComponentResponse(BaseModel):
 
         config: dict[str, Any] | None = row.config
         if KINDS[row.kind].sensitive:
-            config = store.components.decode_config(row) if include_config else None
+            if status is ComponentStatus.UNREADABLE:
+                config = None
+            elif include_config:
+                config = store.components.decode_config(row)
+            else:
+                config = store.components.public_config(row)
 
         return cls(
             id=row.id,