jmri_server.context

 1"""``ServerContext`` — the shared state every service can see.
 2
 3Owns the connection, service registry, WebSocket connection manager, and
 4metadata (railroad name, node identity, active profile). Constructed once
 5at app startup and passed into each :class:`JsonService` instance.
 6"""
 7from __future__ import annotations
 8
 9import platform
10import uuid
11from dataclasses import dataclass, field
12
13from jmri_core.hal.connection import SystemConnection
14
15
16@dataclass
17class ServerMetadata:
18    """Server-identity metadata returned by the hello/version/railroad services."""
19
20    jmri_version: str = "5.14.0-py"
21    json_protocol_version: str = "5.7.0"
22    railroad: str = "Python JMRI"
23    node: str = field(default_factory=lambda: f"node-{platform.node()}-{uuid.uuid4().hex[:8]}")
24    active_profile: str | None = "default"
25    heartbeat_ms: int = 15000
26
27
28@dataclass
29class ServerContext:
30    """Container for everything a service needs at runtime."""
31
32    connection: SystemConnection
33    metadata: ServerMetadata = field(default_factory=ServerMetadata)
34    # Set during app startup by ``create_app``. Bean services use this to
35    # persist created/edited beans to PanelPro.xml. Optional so tests
36    # that build the app via ``build_app`` directly leave it ``None`` for
37    # hermeticity (no writes to the user's real settings dir).
38    config_store: object | None = None
39    # JMRI's ``profiles.xml``-driven multi-profile model. Populated by
40    # ``create_app`` when the settings directory has a ``profiles.xml``;
41    # tests can leave it None.
42    profile_registry: object | None = None
43    # Profile-scoped registry of LogixNG programs. Constructed lazily in
44    # :func:`build_app` so every ServerContext (including the ones
45    # tests spin up via ``build_app``) has a real manager without
46    # needing a profile on disk. ``create_app`` additionally
47    # populates it from ``<profile>/logixng/*.yaml`` at startup.
48    logix_ng: object | None = None
49    # Auth subsystem — populated by ``attach_auth`` when
50    # ``JMRI_AUTH_ENABLED=1``, else stays ``None`` (auth off, every
51    # request is admin-equivalent). Typed as ``object`` here so the
52    # ``jmri_server.auth`` module isn't imported when auth is off.
53    # See :class:`jmri_server.auth.manager.AuthManager` for the
54    # runtime shape.
55    auth: object | None = None