Replace inter-service _handlers dicts with declarative sx defquery/defaction
All checks were successful
Build and Deploy / build-and-deploy (push) Successful in 2m5s
All checks were successful
Build and Deploy / build-and-deploy (push) Successful in 2m5s
The inter-service data layer (fetch_data/call_action) was the least structured part of the codebase — Python _handlers dicts with ad-hoc param extraction scattered across 16 route files. This replaces them with declarative .sx query/action definitions that make the entire inter-service protocol self-describing and greppable. Infrastructure: - defquery/defaction special forms in the sx evaluator - Query/action registry with load, lookup, and schema introspection - Query executor using async_eval with I/O primitives - Blueprint factories (create_data_blueprint/create_action_blueprint) with sx-first dispatch and Python fallback - /internal/schema endpoint on every service - parse-datetime and split-ids primitives for type coercion Service extractions: - LikesService (toggle, is_liked, liked_slugs, liked_ids) - PageConfigService (ensure, get_by_container, get_by_id, get_batch, update) - RelationsService (wraps module-level functions) - AccountDataService (user_by_email, newsletters) - CartItemsService, MarketDataService (raw SQLAlchemy lookups) 50 of 54 handlers converted to sx, 4 Python fallbacks remain (ghost-sync/push-member, clear-cart-for-order, create-order). Net: -1,383 lines Python, +251 lines modified. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -117,6 +117,15 @@ def create_base_app(
|
||||
load_shared_components()
|
||||
load_relation_registry()
|
||||
|
||||
# Load defquery/defaction definitions from {service}/queries.sx and actions.sx
|
||||
from shared.sx.query_registry import load_service_protocols
|
||||
_app_root = Path(os.getcwd())
|
||||
load_service_protocols(name, str(_app_root))
|
||||
|
||||
# Register /internal/schema endpoint for protocol introspection
|
||||
from shared.infrastructure.schema_blueprint import create_schema_blueprint
|
||||
app.register_blueprint(create_schema_blueprint(name))
|
||||
|
||||
# Load CSS registry (tw.css → class-to-rule lookup for on-demand CSS)
|
||||
from shared.sx.css_registry import load_css_registry, registry_loaded
|
||||
_styles = BASE_DIR / "static" / "styles"
|
||||
|
||||
58
shared/infrastructure/protocol_manifest.py
Normal file
58
shared/infrastructure/protocol_manifest.py
Normal file
@@ -0,0 +1,58 @@
|
||||
"""Protocol manifest — aggregates /internal/schema from all services.
|
||||
|
||||
Can be used as a CLI tool or imported for dev-mode inspection.
|
||||
|
||||
Usage::
|
||||
|
||||
python -m shared.infrastructure.protocol_manifest
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
from typing import Any
|
||||
|
||||
from shared.infrastructure.data_client import fetch_data
|
||||
|
||||
|
||||
# Service names that have inter-service protocols
|
||||
_SERVICES = [
|
||||
"blog", "market", "cart", "events", "account",
|
||||
"likes", "relations", "orders",
|
||||
]
|
||||
|
||||
|
||||
async def fetch_service_schema(service: str) -> dict[str, Any] | None:
|
||||
"""Fetch /internal/schema from a single service."""
|
||||
try:
|
||||
from shared.infrastructure.urls import service_url
|
||||
import aiohttp
|
||||
url = service_url(service, "/internal/schema")
|
||||
async with aiohttp.ClientSession() as session:
|
||||
async with session.get(url, timeout=aiohttp.ClientTimeout(total=3)) as resp:
|
||||
if resp.status == 200:
|
||||
return await resp.json()
|
||||
except Exception:
|
||||
return None
|
||||
return None
|
||||
|
||||
|
||||
async def generate_manifest() -> dict[str, Any]:
|
||||
"""Fetch schemas from all services and produce a unified protocol map."""
|
||||
results = await asyncio.gather(
|
||||
*(fetch_service_schema(s) for s in _SERVICES),
|
||||
return_exceptions=True,
|
||||
)
|
||||
manifest = {"services": {}}
|
||||
for service, result in zip(_SERVICES, results):
|
||||
if isinstance(result, dict):
|
||||
manifest["services"][service] = result
|
||||
else:
|
||||
manifest["services"][service] = {"error": str(result) if isinstance(result, Exception) else "unavailable"}
|
||||
return manifest
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
m = asyncio.run(generate_manifest())
|
||||
print(json.dumps(m, indent=2))
|
||||
127
shared/infrastructure/query_blueprint.py
Normal file
127
shared/infrastructure/query_blueprint.py
Normal file
@@ -0,0 +1,127 @@
|
||||
"""
|
||||
Blueprint factories for sx-dispatched data and action routes.
|
||||
|
||||
Replaces per-service boilerplate in ``bp/data/routes.py`` and
|
||||
``bp/actions/routes.py`` by dispatching to defquery/defaction definitions
|
||||
from the sx query registry. Falls back to Python ``_handlers`` dicts
|
||||
for queries/actions not yet converted.
|
||||
|
||||
Usage::
|
||||
|
||||
from shared.infrastructure.query_blueprint import (
|
||||
create_data_blueprint, create_action_blueprint,
|
||||
)
|
||||
|
||||
# In service's bp/data/routes.py:
|
||||
def register() -> Blueprint:
|
||||
bp, _handlers = create_data_blueprint("events")
|
||||
# Optional Python fallback handlers:
|
||||
# _handlers["some-query"] = _some_python_handler
|
||||
return bp
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
from typing import Any, Callable, Awaitable
|
||||
|
||||
from quart import Blueprint, g, jsonify, request
|
||||
|
||||
logger = logging.getLogger("sx.query_blueprint")
|
||||
|
||||
|
||||
def create_data_blueprint(
|
||||
service_name: str,
|
||||
) -> tuple[Blueprint, dict[str, Callable[[], Awaitable[Any]]]]:
|
||||
"""Create a data blueprint that dispatches to sx queries with Python fallback.
|
||||
|
||||
Returns (blueprint, python_handlers_dict) so the caller can register
|
||||
Python fallback handlers for queries not yet converted to sx.
|
||||
"""
|
||||
from shared.infrastructure.data_client import DATA_HEADER
|
||||
|
||||
bp = Blueprint("data", __name__, url_prefix="/internal/data")
|
||||
|
||||
_handlers: dict[str, Callable[[], Awaitable[Any]]] = {}
|
||||
|
||||
@bp.before_request
|
||||
async def _require_data_header():
|
||||
if not request.headers.get(DATA_HEADER):
|
||||
return jsonify({"error": "forbidden"}), 403
|
||||
from shared.infrastructure.internal_auth import validate_internal_request
|
||||
if not validate_internal_request():
|
||||
return jsonify({"error": "forbidden"}), 403
|
||||
|
||||
@bp.get("/<query_name>")
|
||||
async def handle_query(query_name: str):
|
||||
# 1. Check sx query registry first
|
||||
from shared.sx.query_registry import get_query
|
||||
from shared.sx.query_executor import execute_query
|
||||
|
||||
qdef = get_query(service_name, query_name)
|
||||
if qdef is not None:
|
||||
result = await execute_query(qdef, dict(request.args))
|
||||
return jsonify(result)
|
||||
|
||||
# 2. Fall back to Python handlers
|
||||
handler = _handlers.get(query_name)
|
||||
if handler is not None:
|
||||
result = await handler()
|
||||
return jsonify(result)
|
||||
|
||||
return jsonify({"error": "unknown query"}), 404
|
||||
|
||||
return bp, _handlers
|
||||
|
||||
|
||||
def create_action_blueprint(
|
||||
service_name: str,
|
||||
) -> tuple[Blueprint, dict[str, Callable[[], Awaitable[Any]]]]:
|
||||
"""Create an action blueprint that dispatches to sx actions with Python fallback.
|
||||
|
||||
Returns (blueprint, python_handlers_dict) so the caller can register
|
||||
Python fallback handlers for actions not yet converted to sx.
|
||||
"""
|
||||
from shared.infrastructure.actions import ACTION_HEADER
|
||||
|
||||
bp = Blueprint("actions", __name__, url_prefix="/internal/actions")
|
||||
|
||||
_handlers: dict[str, Callable[[], Awaitable[Any]]] = {}
|
||||
|
||||
@bp.before_request
|
||||
async def _require_action_header():
|
||||
if not request.headers.get(ACTION_HEADER):
|
||||
return jsonify({"error": "forbidden"}), 403
|
||||
from shared.infrastructure.internal_auth import validate_internal_request
|
||||
if not validate_internal_request():
|
||||
return jsonify({"error": "forbidden"}), 403
|
||||
|
||||
@bp.post("/<action_name>")
|
||||
async def handle_action(action_name: str):
|
||||
# 1. Check sx action registry first
|
||||
from shared.sx.query_registry import get_action
|
||||
from shared.sx.query_executor import execute_action
|
||||
|
||||
adef = get_action(service_name, action_name)
|
||||
if adef is not None:
|
||||
try:
|
||||
payload = await request.get_json(force=True) or {}
|
||||
result = await execute_action(adef, payload)
|
||||
return jsonify(result)
|
||||
except Exception as exc:
|
||||
logger.exception("SX action %s:%s failed", service_name, action_name)
|
||||
return jsonify({"error": str(exc)}), 500
|
||||
|
||||
# 2. Fall back to Python handlers
|
||||
handler = _handlers.get(action_name)
|
||||
if handler is not None:
|
||||
try:
|
||||
result = await handler()
|
||||
return jsonify(result)
|
||||
except Exception as exc:
|
||||
logger.exception("Action %s failed", action_name)
|
||||
return jsonify({"error": str(exc)}), 500
|
||||
|
||||
return jsonify({"error": "unknown action"}), 404
|
||||
|
||||
return bp, _handlers
|
||||
31
shared/infrastructure/schema_blueprint.py
Normal file
31
shared/infrastructure/schema_blueprint.py
Normal file
@@ -0,0 +1,31 @@
|
||||
"""Schema endpoint for inter-service protocol introspection.
|
||||
|
||||
Every service exposes ``GET /internal/schema`` which returns a JSON
|
||||
manifest of all defquery and defaction definitions with their parameter
|
||||
signatures and docstrings.
|
||||
|
||||
Usage::
|
||||
|
||||
from shared.infrastructure.schema_blueprint import create_schema_blueprint
|
||||
app.register_blueprint(create_schema_blueprint("events"))
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from quart import Blueprint, jsonify, request
|
||||
|
||||
|
||||
def create_schema_blueprint(service_name: str) -> Blueprint:
|
||||
"""Create a blueprint exposing ``/internal/schema``."""
|
||||
bp = Blueprint(
|
||||
f"schema_{service_name}",
|
||||
__name__,
|
||||
url_prefix="/internal",
|
||||
)
|
||||
|
||||
@bp.get("/schema")
|
||||
async def get_schema():
|
||||
from shared.sx.query_registry import schema_for_service
|
||||
return jsonify(schema_for_service(service_name))
|
||||
|
||||
return bp
|
||||
Reference in New Issue
Block a user