piphi-runtime-kit-python 0.4.2__tar.gz → 0.4.3__tar.gz

{piphi_runtime_kit_python-0.4.2 → piphi_runtime_kit_python-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piphi-runtime-kit-python
-Version: 0.4.2
+Version: 0.4.3
 Summary: PiPhi Network runtime integration helpers
 Keywords: piphi,runtime,integration,iot
 Author-Email: KelvinSan <support@piphi.network>

{piphi_runtime_kit_python-0.4.2 → piphi_runtime_kit_python-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "piphi-runtime-kit-python"
-version = "0.4.2"
+version = "0.4.3"
 description = "PiPhi Network runtime integration helpers"
 authors = [
     { name = "KelvinSan", email = "support@piphi.network" },

{piphi_runtime_kit_python-0.4.2 → piphi_runtime_kit_python-0.4.3}/src/piphi_runtime_kit_python/__init__.py

@@ -8,7 +8,18 @@ from .runtime.auth import (
     format_runtime_auth_sync_log,
     mask_token,
 )
-from .runtime.config_sync import ConfigSyncCoordinator, build_sync_response, reconcile_config_ids
+from .runtime.config_sync import (
+    CORE_BASE_URL_ENV_NAME,
+    DEFAULT_RUNTIME_CONFIG_SNAPSHOT_FILENAME,
+    DEFAULT_RUNTIME_VOLUME_DIR,
+    RUNTIME_CONFIG_SNAPSHOT_PATH_ENV_NAME,
+    ConfigSyncCoordinator,
+    build_sync_response,
+    load_runtime_config_snapshot,
+    reconcile_config_ids,
+    resolve_core_base_url,
+    resolve_runtime_config_snapshot_path,
+)
 from .runtime.configuration import (
     build_config_apply_response,
     build_config_remove_response,
@@ -109,6 +120,10 @@ __all__ = [
     "CoreUnavailableError",
     "CoreUnexpectedResponseError",
     "DEFAULT_CORE_CLIENT_TIMEOUT_SECONDS",
+    "CORE_BASE_URL_ENV_NAME",
+    "DEFAULT_RUNTIME_CONFIG_SNAPSHOT_FILENAME",
+    "DEFAULT_RUNTIME_VOLUME_DIR",
+    "RUNTIME_CONFIG_SNAPSHOT_PATH_ENV_NAME",
     "DEFAULT_RUNTIME_CONTAINER_ID_ENV_NAME",
     "DEFAULT_RUNTIME_INTERNAL_TOKEN_ENV_NAME",
     "RUNTIME_CONTAINER_ID_HEADER_NAME",
@@ -169,6 +184,7 @@ __all__ = [
     "format_discovery_attempt_log",
     "format_event_log",
     "format_runtime_auth_sync_log",
+    "load_runtime_config_snapshot",
     "mask_token",
     "MqttBrokerConfig",
     "MqttJsonClient",
@@ -176,6 +192,8 @@ __all__ = [
     "normalize_event_payload",
     "redact_config_secrets",
     "reconcile_config_ids",
+    "resolve_core_base_url",
+    "resolve_runtime_config_snapshot_path",
     "runtime_lifespan",
     "schedule_event_delivery",
     "schedule_telemetry_delivery",

{piphi_runtime_kit_python-0.4.2 → piphi_runtime_kit_python-0.4.3}/src/piphi_runtime_kit_python/runtime/config_sync.py

@@ -3,6 +3,9 @@ from __future__ import annotations
 """Helpers for basic config-sync orchestration and generation tracking."""
 
 from dataclasses import dataclass
+import json
+import os
+from pathlib import Path
 from typing import Awaitable, Callable, TypeVar
 
 from ..schemas import RuntimeConfig, RuntimeConfigSnapshot, RuntimeConfigSyncResponse
@@ -10,6 +13,77 @@ from .state import RuntimeProcessState
 
 TConfig = TypeVar("TConfig", bound=RuntimeConfig)
 
+CORE_BASE_URL_ENV_NAME = "PIPHI_CORE_BASE_URL"
+RUNTIME_CONTAINER_ID_ENV_NAME = "PIPHI_CONTAINER_ID"
+RUNTIME_CONFIG_SNAPSHOT_PATH_ENV_NAME = "PIPHI_CONFIG_SNAPSHOT_PATH"
+DEFAULT_RUNTIME_VOLUME_DIR = "/.piphinetwork"
+DEFAULT_RUNTIME_CONFIG_SNAPSHOT_FILENAME = "configs.json"
+
+
+def resolve_core_base_url(default: str | None = None) -> str | None:
+    """Resolve Core's base URL from the managed-runtime environment."""
+    value = (os.getenv(CORE_BASE_URL_ENV_NAME) or "").strip().rstrip("/")
+    if value:
+        return value
+    return default.rstrip("/") if isinstance(default, str) and default.strip() else default
+
+
+def resolve_runtime_config_snapshot_path(
+    *,
+    container_id: str | None = None,
+    volume_dir: str | Path = DEFAULT_RUNTIME_VOLUME_DIR,
+) -> Path:
+    """Resolve the local config snapshot path mounted by PiPhi Core."""
+    explicit_path = (os.getenv(RUNTIME_CONFIG_SNAPSHOT_PATH_ENV_NAME) or "").strip()
+    if explicit_path:
+        return Path(explicit_path)
+
+    resolved_container_id = (
+        str(container_id or "").strip()
+        or (os.getenv(RUNTIME_CONTAINER_ID_ENV_NAME) or "").strip()
+    )
+    if resolved_container_id:
+        return Path(volume_dir).joinpath(f"{resolved_container_id}.json")
+    return Path(volume_dir).joinpath(DEFAULT_RUNTIME_CONFIG_SNAPSHOT_FILENAME)
+
+
+def load_runtime_config_snapshot(
+    *,
+    path: str | Path | None = None,
+    container_id: str | None = None,
+    volume_dir: str | Path = DEFAULT_RUNTIME_VOLUME_DIR,
+) -> RuntimeConfigSnapshot | None:
+    """Load Core's last known config snapshot from the mounted runtime volume.
+
+    Missing, unreadable, or invalid snapshots return ``None`` so integrations can
+    treat snapshot rehydration as a safe startup fallback rather than a crash
+    trigger.
+    """
+    snapshot_path = (
+        Path(path)
+        if path is not None
+        else resolve_runtime_config_snapshot_path(
+            container_id=container_id,
+            volume_dir=volume_dir,
+        )
+    )
+    try:
+        raw_payload = snapshot_path.read_text(encoding="utf-8")
+    except (FileNotFoundError, OSError):
+        return None
+
+    try:
+        payload = json.loads(raw_payload)
+    except json.JSONDecodeError:
+        return None
+    if not isinstance(payload, dict):
+        return None
+
+    try:
+        return RuntimeConfigSnapshot.model_validate(payload)
+    except ValueError:
+        return None
+
 
 def reconcile_config_ids(
     *,

{piphi_runtime_kit_python-0.4.2 → piphi_runtime_kit_python-0.4.3}/src/piphi_runtime_kit_python/runtime/health.py

@@ -15,6 +15,7 @@ def _build_runtime_snapshot(runtime_context: RuntimeContext) -> dict[str, Any]:
         "core_auth_present": bool(runtime_context.auth.internal_token),
         "core_http_client_bound": process_state.core_http_client is not None,
         "current_generation": process_state.current_generation,
+        "config_generation": process_state.current_generation,
         "pending_task_count": len(
             [task for task in process_state.background_tasks if not task.done()]
         ),

{piphi_runtime_kit_python-0.4.2 → piphi_runtime_kit_python-0.4.3}/src/piphi_runtime_kit_python/schemas.py

@@ -35,12 +35,34 @@ class RuntimeConfig(BaseModel):
 
 class RuntimeConfigSnapshot(BaseModel):
     """Snapshot payload sent from PiPhi Core to an integration runtime."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    schema_version: int | None = Field(
+        default=None,
+        validation_alias=AliasChoices("schema_version", "schemaVersion"),
+    )
     container_id: str
     integration_id: str | None = None
     driver_pid: int | None = None
     reason: str | None = None
     generation: int | None = None
+    updated_at: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("updated_at", "updatedAt"),
+    )
     configs: list[RuntimeConfig] = Field(default_factory=list)
+    deleted_config_ids: list[str] = Field(
+        default_factory=list,
+        validation_alias=AliasChoices("deleted_config_ids", "deletedConfigIds"),
+    )
+    config_hash: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("config_hash", "configHash"),
+    )
+    internal_token: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("internal_token", "internalToken"),
+    )
 
 
 class RuntimeConfigSyncResponse(BaseModel):

piphi_runtime_kit_python-0.4.3/tests/test_config_sync.py

@@ -0,0 +1,138 @@
+import pytest
+
+from piphi_runtime_kit_python import (
+    ConfigSyncCoordinator,
+    RuntimeConfig,
+    RuntimeConfigSnapshot,
+    RuntimeProcessState,
+    load_runtime_config_snapshot,
+    reconcile_config_ids,
+    resolve_core_base_url,
+    resolve_runtime_config_snapshot_path,
+)
+
+
+def test_reconcile_config_ids_returns_removed_and_unchanged_ids() -> None:
+    removed_ids, unchanged_ids = reconcile_config_ids(
+        active_ids=["a", "b", "c"],
+        incoming_ids=["b", "c", "d"],
+    )
+
+    assert removed_ids == ["a"]
+    assert unchanged_ids == ["b", "c"]
+
+
+def test_config_sync_coordinator_detects_stale_snapshot() -> None:
+    state = RuntimeProcessState(current_generation=10)
+    coordinator = ConfigSyncCoordinator(process_state=state)
+    snapshot = RuntimeConfigSnapshot(
+        container_id="container-1",
+        generation=9,
+        configs=[RuntimeConfig(id="device-1")],
+    )
+
+    assert coordinator.is_stale(snapshot) is True
+
+
+def test_config_sync_coordinator_updates_generation() -> None:
+    state = RuntimeProcessState()
+    coordinator = ConfigSyncCoordinator(process_state=state)
+
+    assert coordinator.mark_generation(42) == 42
+    assert state.current_generation == 42
+
+
+def test_resolve_core_base_url_uses_managed_runtime_env(monkeypatch) -> None:
+    monkeypatch.setenv("PIPHI_CORE_BASE_URL", "http://127.0.0.1:31419/")
+
+    assert resolve_core_base_url() == "http://127.0.0.1:31419"
+
+
+def test_resolve_runtime_config_snapshot_path_uses_container_id(monkeypatch, tmp_path) -> None:
+    monkeypatch.delenv("PIPHI_CONFIG_SNAPSHOT_PATH", raising=False)
+    monkeypatch.setenv("PIPHI_CONTAINER_ID", "container-1")
+
+    assert resolve_runtime_config_snapshot_path(volume_dir=tmp_path) == tmp_path / "container-1.json"
+
+
+def test_resolve_runtime_config_snapshot_path_prefers_explicit_path(monkeypatch, tmp_path) -> None:
+    explicit_path = tmp_path / "custom.json"
+    monkeypatch.setenv("PIPHI_CONFIG_SNAPSHOT_PATH", str(explicit_path))
+
+    assert resolve_runtime_config_snapshot_path(volume_dir=tmp_path) == explicit_path
+
+
+def test_load_runtime_config_snapshot_reads_core_volume_contract(tmp_path) -> None:
+    snapshot_path = tmp_path / "container-1.json"
+    snapshot_path.write_text(
+        """
+        {
+          "schema_version": 1,
+          "container_id": "container-1",
+          "integration_id": "integration-1",
+          "reason": "startup",
+          "generation": 42,
+          "updated_at": "2026-04-27T12:00:00+00:00",
+          "configs": [{"id": "device-1", "serial": "abc123"}],
+          "deleted_config_ids": ["device-2"],
+          "config_hash": "sha256:abc",
+          "internal_token": "runtime-token"
+        }
+        """,
+        encoding="utf-8",
+    )
+
+    snapshot = load_runtime_config_snapshot(path=snapshot_path)
+
+    assert snapshot is not None
+    assert snapshot.schema_version == 1
+    assert snapshot.container_id == "container-1"
+    assert snapshot.generation == 42
+    assert snapshot.configs[0].id == "device-1"
+    assert snapshot.deleted_config_ids == ["device-2"]
+    assert snapshot.config_hash == "sha256:abc"
+    assert snapshot.internal_token == "runtime-token"
+
+
+def test_load_runtime_config_snapshot_returns_none_for_missing_or_invalid_snapshot(tmp_path) -> None:
+    assert load_runtime_config_snapshot(path=tmp_path / "missing.json") is None
+
+    invalid_path = tmp_path / "invalid.json"
+    invalid_path.write_text("not-json", encoding="utf-8")
+
+    assert load_runtime_config_snapshot(path=invalid_path) is None
+
+
+@pytest.mark.asyncio
+async def test_config_sync_coordinator_apply_snapshot_orchestrates_callbacks() -> None:
+    state = RuntimeProcessState(current_generation=1)
+    coordinator = ConfigSyncCoordinator(process_state=state)
+    snapshot = RuntimeConfigSnapshot(
+        container_id="container-1",
+        generation=2,
+        configs=[RuntimeConfig(id="device-2"), RuntimeConfig(id="device-3")],
+    )
+    active_ids = ["device-1", "device-2"]
+    applied: list[str] = []
+    removed: list[str] = []
+
+    async def apply_config(config: RuntimeConfig) -> None:
+        applied.append(config.id)
+
+    async def remove_config(config_id: str) -> bool:
+        removed.append(config_id)
+        return True
+
+    response = await coordinator.apply_snapshot(
+        snapshot=snapshot,
+        active_config_ids=active_ids,
+        apply_config=apply_config,
+        remove_config=remove_config,
+        get_active_config_ids=lambda: ["device-2", "device-3"],
+    )
+
+    assert applied == ["device-2", "device-3"]
+    assert removed == ["device-1"]
+    assert response.status == "synced"
+    assert response.generation == 2
+    assert response.active_config_ids == ["device-2", "device-3"]

piphi_runtime_kit_python-0.4.2/tests/test_config_sync.py

@@ -1,74 +0,0 @@
-import pytest
-
-from piphi_runtime_kit_python import (
-    ConfigSyncCoordinator,
-    RuntimeConfig,
-    RuntimeConfigSnapshot,
-    RuntimeProcessState,
-    reconcile_config_ids,
-)
-
-
-def test_reconcile_config_ids_returns_removed_and_unchanged_ids() -> None:
-    removed_ids, unchanged_ids = reconcile_config_ids(
-        active_ids=["a", "b", "c"],
-        incoming_ids=["b", "c", "d"],
-    )
-
-    assert removed_ids == ["a"]
-    assert unchanged_ids == ["b", "c"]
-
-
-def test_config_sync_coordinator_detects_stale_snapshot() -> None:
-    state = RuntimeProcessState(current_generation=10)
-    coordinator = ConfigSyncCoordinator(process_state=state)
-    snapshot = RuntimeConfigSnapshot(
-        container_id="container-1",
-        generation=9,
-        configs=[RuntimeConfig(id="device-1")],
-    )
-
-    assert coordinator.is_stale(snapshot) is True
-
-
-def test_config_sync_coordinator_updates_generation() -> None:
-    state = RuntimeProcessState()
-    coordinator = ConfigSyncCoordinator(process_state=state)
-
-    assert coordinator.mark_generation(42) == 42
-    assert state.current_generation == 42
-
-
-@pytest.mark.asyncio
-async def test_config_sync_coordinator_apply_snapshot_orchestrates_callbacks() -> None:
-    state = RuntimeProcessState(current_generation=1)
-    coordinator = ConfigSyncCoordinator(process_state=state)
-    snapshot = RuntimeConfigSnapshot(
-        container_id="container-1",
-        generation=2,
-        configs=[RuntimeConfig(id="device-2"), RuntimeConfig(id="device-3")],
-    )
-    active_ids = ["device-1", "device-2"]
-    applied: list[str] = []
-    removed: list[str] = []
-
-    async def apply_config(config: RuntimeConfig) -> None:
-        applied.append(config.id)
-
-    async def remove_config(config_id: str) -> bool:
-        removed.append(config_id)
-        return True
-
-    response = await coordinator.apply_snapshot(
-        snapshot=snapshot,
-        active_config_ids=active_ids,
-        apply_config=apply_config,
-        remove_config=remove_config,
-        get_active_config_ids=lambda: ["device-2", "device-3"],
-    )
-
-    assert applied == ["device-2", "device-3"]
-    assert removed == ["device-1"]
-    assert response.status == "synced"
-    assert response.generation == 2
-    assert response.active_config_ids == ["device-2", "device-3"]