mic-datastore

Briques de persistance & messaging du framework MIC. Dépend de mic-core (DAG platform → data → core — jamais l'inverse).

Modules

Namespace PEP 420 (pas de mic/__init__.py).

mic.realtime — WebSocket depuis un navigateur

Un navigateur ne peut pas poser d'en-tête Authorization sur l'upgrade WebSocket, et un jeton en query string finit dans les journaux d'accès : le client passe son jeton en sous-protocole et propose en plus un sous-protocole applicatif, que le serveur doit renvoyer dans l'accept (sinon le navigateur ferme la connexion).

const ws = new WebSocket(url, ["app.v1", `bearer.${jwt}`]);
ws.onclose = (e) => {
  if (e.code === 4401) { /* jeton expiré/invalide : se reconnecter avec un jeton neuf */ }
  if (e.code === 4403) { /* interdit : ne pas réessayer */ }
};

from mic.auth import OidcTokenVerifier
from mic.realtime import OidcWebSocketAuthenticator, make_websocket_endpoint

def is_librarian(claims):  # claims propriétaires (Keycloak…) dans `extra`
    return "librarian" in claims.extra.get("realm_access", {}).get("roles", [])

endpoint = make_websocket_endpoint(
    room=room,
    authenticator=OidcWebSocketAuthenticator(  # extra [ws-oidc]
        verifier=OidcTokenVerifier(issuer=..., audience=..., jwks_url=...),
        authorize=is_librarian,  # False → 4403
    ),
    subprotocol="app.v1",  # renvoyé seulement si proposé ; jamais `bearer.<jwt>`
    allowed_origins=["https://app.example.org"],  # anti-CSWSH (même hôte toujours admis)
)

async def handler(ws, **params):
    ws.auth.sub  # claims vérifiés renvoyés par l'authenticator

Les refus acceptent puis ferment aussitôt (aucune frame métier) : un refus au handshake devient un HTTP 403 dont le navigateur ne voit qu'un 1006, sans pouvoir distinguer 4401 de 4403. refuse_before_accept=True rétablit le refus au handshake. Authenticators livrés : OidcWebSocketAuthenticator (async, JWKS vérifié hors de la boucle d'événements, jeton en sous-protocole seul par défaut) et ServiceAuthWebSocketAuthenticator (sync, jetons de service) ; pour un cas maison, AsyncWebSocketAuthenticator + extract_bearer_token(scope, query_param=None).

RedisStreamsBackend(client=redis, maxlen=1_000) plafonne chaque stream de room via XADD MAXLEN ~ (défaut DEFAULT_MAXLEN = 1000, trim approximatif ; maxlen=None = pas de plafond).

mic.scheduling — tâches périodiques observables

Le planificateur de la plateforme (CronJob Kubernetes, systemd timer, boucle du service) appelle run_due() ; MIC porte les garanties qui doivent rester identiques quel que soit ce planificateur : exclusion distribuée, reprise, état d'exécution et détection du silence.

from mic.locking import RedisDistributedLock
from mic.scheduling import (
    PeriodicTaskRunner,
    RedisSchedulingStore,
    SilenceMonitor,
    TaskContext,
    TaskResult,
    periodic,
)

@periodic(
    name="collect:k8s",
    every="15m",
    lock="collect:k8s",
    timeout="10m",
    silence_after="35m",
)
def collect(ctx: TaskContext) -> TaskResult:
    cursor = ctx.checkpoint
    processed, next_cursor = collect_batch(cursor)
    ctx.raise_if_timed_out()  # point d'arrêt sûr entre deux lots
    return TaskResult(processed=processed, checkpoint=next_cursor)

store = RedisSchedulingStore(redis_url="redis://redis:6379/0")
runner = PeriodicTaskRunner(
    lock_backend=RedisDistributedLock(redis_url="redis://redis:6379/0"),
    store=store,
    metrics=metrics_backend,  # MetricsBackend optionnel
)
runner.run_due(collect)

alerts = SilenceMonitor(store=store, metrics=metrics_backend).check([collect])

Une tâche en échec ne fait jamais avancer son checkpoint et son exception est propagée au superviseur. Le timeout est une échéance coopérative : le runner mesure tout dépassement au retour et TaskContext.raise_if_timed_out() permet de l'interrompre entre deux lots. Il ne tue pas un thread Python arbitraire ; un arrêt forcé reste la responsabilité du superviseur de processus ou du activeDeadlineSeconds d'un CronJob. SilenceMonitor doit vivre dans un processus de supervision distinct si l'on veut détecter la disparition totale du worker.

Métriques émises via MetricsBackend : mic_scheduling_runs_total (task, status), mic_scheduling_duration_seconds, mic_scheduling_last_processed, mic_scheduling_last_success_timestamp_seconds et mic_scheduling_silent.

Installation

pip install "mic-datastore[postgres,redis]"

Extras

Versionnage

Brique volatile — reste en 0.x plus longtemps que mic-core. Contraindre avec >=0.1,<1. Release : make release-pkg PKG=data VERSION=x.y.z → tag data-vX.Y.Z (cf. ../../RELEASING.md).