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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piphi-runtime-kit-python
-Version: 0.4.1
+Version: 0.4.2
 Summary: PiPhi Network runtime integration helpers
 Keywords: piphi,runtime,integration,iot
 Author-Email: KelvinSan <support@piphi.network>
@@ -362,15 +362,15 @@ async def health():
 async def config(payload: DemoConfig, request: Request):
     sync_runtime_auth_from_fastapi_payload(starter.runtime, request, payload)
     typed_payload = validate_typed_config(payload, DemoConfig)
+    identity = build_runtime_identity(typed_payload)
     starter.registry.set(
         typed_payload.id,
         {
-            "config_id": typed_payload.config_id or typed_payload.id,
-            "device_id": typed_payload.device_id or typed_payload.id,
+            **identity,
             "host": typed_payload.host,
         },
     )
-    return build_config_apply_response(config_id=typed_payload.config_id or typed_payload.id)
+    return build_config_apply_response(config_id=identity["config_id"])
 
 
 @app.post("/telemetry/example")

{piphi_runtime_kit_python-0.4.1 → piphi_runtime_kit_python-0.4.2}/README.md

@@ -336,15 +336,15 @@ async def health():
 async def config(payload: DemoConfig, request: Request):
     sync_runtime_auth_from_fastapi_payload(starter.runtime, request, payload)
     typed_payload = validate_typed_config(payload, DemoConfig)
+    identity = build_runtime_identity(typed_payload)
     starter.registry.set(
         typed_payload.id,
         {
-            "config_id": typed_payload.config_id or typed_payload.id,
-            "device_id": typed_payload.device_id or typed_payload.id,
+            **identity,
             "host": typed_payload.host,
         },
     )
-    return build_config_apply_response(config_id=typed_payload.config_id or typed_payload.id)
+    return build_config_apply_response(config_id=identity["config_id"])
 
 
 @app.post("/telemetry/example")

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

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

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

@@ -49,6 +49,7 @@ from .runtime.events import (
     normalize_event_payload,
 )
 from .runtime.health import build_runtime_diagnostics_response, build_runtime_health_response
+from .runtime.identity import build_runtime_identity, resolve_config_id, resolve_device_id
 from .runtime.lifespan import (
     DEFAULT_CORE_CLIENT_TIMEOUT_SECONDS,
     DEFAULT_RUNTIME_CONTAINER_ID_ENV_NAME,
@@ -80,6 +81,8 @@ from .schemas import (
     IntegrationCommandRequest,
     IntegrationDiscoveryRequest,
     IntegrationDiscoveryResponse,
+    RuntimeEntityCommandFieldResponse,
+    RuntimeEntityCommandResponse,
     RuntimeEntityDashboardResponse,
     RuntimeEntitiesResponse,
     RuntimeEntityResponse,
@@ -113,6 +116,8 @@ __all__ = [
     "IntegrationCommandRequest",
     "IntegrationDiscoveryRequest",
     "IntegrationDiscoveryResponse",
+    "RuntimeEntityCommandFieldResponse",
+    "RuntimeEntityCommandResponse",
     "RuntimeEntityDashboardResponse",
     "RuntimeEntitiesResponse",
     "RuntimeEntityResponse",
@@ -144,6 +149,7 @@ __all__ = [
     "build_event_ingest_response",
     "build_event_list_response",
     "build_local_event_record",
+    "build_runtime_identity",
     "build_core_auth_headers",
     "build_config_apply_response",
     "build_config_remove_response",
@@ -175,6 +181,8 @@ __all__ = [
     "schedule_telemetry_delivery",
     "shutdown_background_tasks",
     "track_background_task",
+    "resolve_config_id",
+    "resolve_device_id",
     "validate_typed_config",
     "validate_typed_configs",
     "DEFAULT_SOURCE_TOPIC_PREFIX",

{piphi_runtime_kit_python-0.4.1 → piphi_runtime_kit_python-0.4.2}/src/piphi_runtime_kit_python/runtime/dispatch.py

@@ -2,8 +2,10 @@ from __future__ import annotations
 
 """Helpers for background dispatch of telemetry and event delivery."""
 
+import asyncio
 from typing import Any, Callable, Mapping
 
+from .errors import CoreDeliveryError
 from .events import EventClient
 from .tasks import create_tracked_task
 from .telemetry import TelemetryClient
@@ -14,6 +16,9 @@ EventRecorder = Callable[[dict[str, Any]], Any]
 SkipHandler = Callable[[str, dict[str, Any]], Any]
 ErrorHandler = Callable[[Exception, dict[str, Any]], Any]
 
+DEFAULT_RETRYABLE_DELIVERY_ATTEMPTS = 5
+DEFAULT_RETRYABLE_DELIVERY_INITIAL_DELAY_SECONDS = 0.5
+
 
 def build_local_event_record(
     *,
@@ -36,6 +41,30 @@ def build_local_event_record(
     }
 
 
+async def _run_with_retryable_core_delivery_backoff(
+    delivery: Callable[[], Any],
+    *,
+    max_attempts: int = DEFAULT_RETRYABLE_DELIVERY_ATTEMPTS,
+    initial_delay_seconds: float = DEFAULT_RETRYABLE_DELIVERY_INITIAL_DELAY_SECONDS,
+) -> Any:
+    """Retry transient Core delivery failures with a short exponential backoff."""
+
+    attempt = 1
+    delay_seconds = initial_delay_seconds
+    while True:
+        try:
+            result = delivery()
+            if asyncio.iscoroutine(result):
+                return await result
+            return result
+        except CoreDeliveryError as exc:
+            if not exc.retryable or attempt >= max_attempts:
+                raise
+            await asyncio.sleep(delay_seconds)
+            attempt += 1
+            delay_seconds *= 2
+
+
 async def dispatch_telemetry_delivery(
     *,
     telemetry_client: TelemetryClient,
@@ -59,13 +88,15 @@ async def dispatch_telemetry_delivery(
         return False
 
     try:
-        await telemetry_client.send_metrics(
-            device_id=device_id,
-            metrics=metrics,
-            auth_context=auth_context,
-            container_id=resolved_container_id,
-            units=units,
-            timestamp=timestamp,
+        await _run_with_retryable_core_delivery_backoff(
+            lambda: telemetry_client.send_metrics(
+                device_id=device_id,
+                metrics=metrics,
+                auth_context=auth_context,
+                container_id=resolved_container_id,
+                units=units,
+                timestamp=timestamp,
+            )
         )
         return True
     except Exception as exc:
@@ -119,16 +150,18 @@ async def dispatch_event_delivery(
 ) -> bool:
     """Send one event to Core and return whether delivery succeeded."""
     try:
-        event_sent = await event_client.send_event(
-            event_type=event_type,
-            integration_id=device.get("integration_id"),
-            config_id=device.get("config_id") or device.get("device_id"),
-            auth_context=auth_context,
-            container_id=device.get("container_id"),
-            device_id=device.get("device_id"),
-            payload=payload,
-            source=source,
-            severity=severity,
+        event_sent = await _run_with_retryable_core_delivery_backoff(
+            lambda: event_client.send_event(
+                event_type=event_type,
+                integration_id=device.get("integration_id"),
+                config_id=device.get("config_id"),
+                auth_context=auth_context,
+                container_id=device.get("container_id"),
+                device_id=device.get("device_id"),
+                payload=payload,
+                source=source,
+                severity=severity,
+            )
         )
         if not event_sent and on_skipped is not None:
             on_skipped(

piphi_runtime_kit_python-0.4.2/src/piphi_runtime_kit_python/runtime/identity.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+"""Helpers for keeping runtime config and device identity explicit."""
+
+from typing import Any, Mapping
+
+
+def _coerce_optional_string(value: Any) -> str | None:
+    if value is None:
+        return None
+    text = str(value).strip()
+    return text or None
+
+
+def _first_present(payload: Mapping[str, Any], *keys: str) -> str | None:
+    for key in keys:
+        resolved = _coerce_optional_string(payload.get(key))
+        if resolved:
+            return resolved
+    return None
+
+
+def resolve_config_id(payload: Mapping[str, Any] | Any) -> str:
+    """Resolve the Core-owned config id from a config-like payload."""
+
+    if isinstance(payload, Mapping):
+        return _first_present(payload, "config_id", "configId", "id") or "missing"
+    return (
+        _coerce_optional_string(getattr(payload, "config_id", None))
+        or _coerce_optional_string(getattr(payload, "configId", None))
+        or _coerce_optional_string(getattr(payload, "id", None))
+        or "missing"
+    )
+
+
+def resolve_device_id(payload: Mapping[str, Any] | Any) -> str:
+    """Resolve the integration-owned device id from a config-like payload."""
+
+    if isinstance(payload, Mapping):
+        return _first_present(payload, "device_id", "deviceId", "id") or "missing"
+    return (
+        _coerce_optional_string(getattr(payload, "device_id", None))
+        or _coerce_optional_string(getattr(payload, "deviceId", None))
+        or _coerce_optional_string(getattr(payload, "id", None))
+        or "missing"
+    )
+
+
+def build_runtime_identity(
+    payload: Mapping[str, Any] | Any,
+    *,
+    container_id: str | None = None,
+    integration_id: str | None = None,
+) -> dict[str, Any]:
+    """Build a canonical runtime identity record for one config-backed device."""
+
+    resolved = {
+        "config_id": resolve_config_id(payload),
+        "device_id": resolve_device_id(payload),
+    }
+    payload_container_id = (
+        _first_present(payload, "container_id", "containerId")
+        if isinstance(payload, Mapping)
+        else (
+            _coerce_optional_string(getattr(payload, "container_id", None))
+            or _coerce_optional_string(getattr(payload, "containerId", None))
+        )
+    )
+    payload_integration_id = (
+        _first_present(payload, "integration_id", "integrationId")
+        if isinstance(payload, Mapping)
+        else (
+            _coerce_optional_string(getattr(payload, "integration_id", None))
+            or _coerce_optional_string(getattr(payload, "integrationId", None))
+        )
+    )
+
+    resolved["container_id"] = _coerce_optional_string(container_id) or payload_container_id
+    resolved["integration_id"] = _coerce_optional_string(integration_id) or payload_integration_id
+    return resolved

{piphi_runtime_kit_python-0.4.1 → piphi_runtime_kit_python-0.4.2}/src/piphi_runtime_kit_python/runtime/registry.py

@@ -50,18 +50,30 @@ class RuntimeRegistry(Generic[TEntry, TState, TEvent]):
         first_entry_id = next(iter(self.entries))
         return self.entries[first_entry_id]
 
-    def update_state(self, entry_id: str, state: dict[str, Any]) -> dict[str, Any]:
+    def update_state(
+        self,
+        entry_id: str,
+        state: dict[str, Any],
+        *,
+        device_id: str | None = None,
+    ) -> dict[str, Any]:
         """Store the latest state snapshot and mirror it onto the active entry."""
         timestamp = dt.datetime.now(dt.timezone.utc).isoformat()
+        entry = self.entries.get(entry_id)
+        resolved_device_id = (
+            device_id
+            or (str(entry.get("device_id")) if entry and entry.get("device_id") else None)
+            or entry_id
+        )
         latest_state = {
-            "device_id": entry_id,
+            "device_id": resolved_device_id,
             "state": state,
             "last_updated": timestamp,
         }
         self.state_snapshots[entry_id] = latest_state
-        if entry_id in self.entries:
-            self.entries[entry_id]["latest_state"] = state
-            self.entries[entry_id]["last_updated"] = timestamp
+        if entry is not None:
+            entry["latest_state"] = state
+            entry["last_updated"] = timestamp
         return latest_state
 
     def append_event(self, event: TEvent) -> TEvent:

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

@@ -11,8 +11,26 @@ from pydantic import AliasChoices, BaseModel, ConfigDict, Field
 
 class RuntimeConfig(BaseModel):
     """Base runtime config model with a required config id and extensible fields."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
     id: str
-    model_config = ConfigDict(extra="allow")
+    config_id: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("config_id", "configId"),
+    )
+    container_id: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("container_id", "containerId"),
+    )
+    integration_id: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("integration_id", "integrationId"),
+    )
+    device_id: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("device_id", "deviceId"),
+    )
 
 
 class RuntimeConfigSnapshot(BaseModel):
@@ -94,6 +112,44 @@ class RuntimeEntityDashboardResponse(BaseModel):
     metadata: dict[str, Any] = Field(default_factory=dict)
 
 
+class RuntimeEntityCommandFieldResponse(BaseModel):
+    """Optional per-command argument metadata returned by a runtime entity."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    type: str
+    label: str | None = None
+    description: str | None = None
+    required: bool = False
+    default: Any | None = None
+    minimum: float | None = Field(
+        default=None,
+        validation_alias=AliasChoices("minimum", "min"),
+    )
+    maximum: float | None = Field(
+        default=None,
+        validation_alias=AliasChoices("maximum", "max"),
+    )
+    step: float | None = None
+    unit: str | None = None
+    options: list[Any] = Field(default_factory=list)
+
+
+class RuntimeEntityCommandResponse(BaseModel):
+    """One device-scoped command exposed by a runtime entity."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    id: str
+    label: str | None = None
+    description: str | None = None
+    kind: str | None = None
+    args_schema: dict[str, RuntimeEntityCommandFieldResponse] = Field(
+        default_factory=dict,
+        validation_alias=AliasChoices("args_schema", "argsSchema"),
+    )
+
+
 class RuntimeEntityResponse(BaseModel):
     """One live runtime entity tied to a configured device/account."""
 
@@ -122,6 +178,15 @@ class RuntimeEntityResponse(BaseModel):
         default=None,
         validation_alias=AliasChoices("entity_type", "entityType"),
     )
+    available_commands: list[RuntimeEntityCommandResponse | str] = Field(
+        default_factory=list,
+        validation_alias=AliasChoices(
+            "available_commands",
+            "availableCommands",
+            "supported_commands",
+            "supportedCommands",
+        ),
+    )
     dashboard: RuntimeEntityDashboardResponse | None = None
     metadata: dict[str, Any] = Field(default_factory=dict)
 

{piphi_runtime_kit_python-0.4.1 → piphi_runtime_kit_python-0.4.2}/tests/test_runtime_dispatch_matrix.py

@@ -2,6 +2,7 @@ import httpx
 import pytest
 
 from piphi_runtime_kit_python import EventClient, RuntimeAuthContext, RuntimeProcessState, TelemetryClient
+from piphi_runtime_kit_python.runtime.errors import CoreUnavailableError
 from piphi_runtime_kit_python.runtime.dispatch import (
     build_local_event_record,
     dispatch_event_delivery,
@@ -48,6 +49,39 @@ async def test_dispatch_telemetry_delivery_returns_true_on_success(
     assert called == [("device-1", "container-1")]
 
 
+@pytest.mark.asyncio
+async def test_dispatch_telemetry_delivery_retries_retryable_core_errors(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    process_state = RuntimeProcessState()
+    client = TelemetryClient(process_state=process_state, core_base_url="http://core.test")
+    auth_context = RuntimeAuthContext(container_id="container-retry", internal_token="token-retry")
+    attempts: list[int] = []
+
+    async def fake_send_metrics(self, **kwargs) -> None:  # noqa: ARG001
+        attempts.append(1)
+        if len(attempts) == 1:
+            raise CoreUnavailableError(
+                operation="telemetry_delivery",
+                url="http://core.test/api/v2/integrations/telemetry",
+                message="PiPhi Core is unreachable",
+                retryable=True,
+                timeout_seconds=3.0,
+            )
+
+    monkeypatch.setattr(TelemetryClient, "send_metrics", fake_send_metrics)
+
+    delivered = await dispatch_telemetry_delivery(
+        telemetry_client=client,
+        auth_context=auth_context,
+        device_id="device-retry",
+        metrics={"is_on": True},
+    )
+
+    assert delivered is True
+    assert len(attempts) == 2
+
+
 @pytest.mark.asyncio
 async def test_dispatch_telemetry_delivery_calls_error_handler_and_returns_false(
     monkeypatch: pytest.MonkeyPatch,
@@ -107,6 +141,46 @@ async def test_dispatch_event_delivery_returns_true_on_success(
     assert called == ["device.updated"]
 
 
+@pytest.mark.asyncio
+async def test_dispatch_event_delivery_retries_retryable_core_errors(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    process_state = RuntimeProcessState()
+    client = EventClient(process_state=process_state, core_base_url="http://core.test")
+    auth_context = RuntimeAuthContext(container_id="container-event", internal_token="token-event")
+    attempts: list[int] = []
+
+    async def fake_send_event(self, **kwargs) -> bool:  # noqa: ARG001
+        attempts.append(1)
+        if len(attempts) == 1:
+            raise CoreUnavailableError(
+                operation="event_delivery",
+                url="http://core.test/api/v2/events/ingest",
+                message="PiPhi Core is unreachable",
+                retryable=True,
+                timeout_seconds=3.0,
+            )
+        return True
+
+    monkeypatch.setattr(EventClient, "send_event", fake_send_event)
+
+    delivered = await dispatch_event_delivery(
+        event_client=client,
+        auth_context=auth_context,
+        event_type="device.updated",
+        device={
+            "device_id": "device-event",
+            "container_id": "container-event",
+            "integration_id": "integration-event",
+            "config_id": "config-event",
+        },
+        source="runtime-event",
+    )
+
+    assert delivered is True
+    assert len(attempts) == 2
+
+
 @pytest.mark.asyncio
 async def test_dispatch_event_delivery_calls_skip_handler_when_client_returns_false(
     monkeypatch: pytest.MonkeyPatch,

piphi_runtime_kit_python-0.4.2/tests/test_runtime_identity.py

@@ -0,0 +1,29 @@
+from piphi_runtime_kit_python import RuntimeConfig, build_runtime_identity, resolve_config_id, resolve_device_id
+
+
+def test_runtime_identity_helpers_prefer_explicit_config_and_device_ids() -> None:
+    payload = RuntimeConfig.model_validate(
+        {
+            "id": "core-config-uuid",
+            "config_id": "core-config-uuid",
+            "device_id": "vendor-device-42",
+            "container_id": "container-1",
+            "integration_id": "demo-runtime",
+        }
+    )
+
+    assert resolve_config_id(payload) == "core-config-uuid"
+    assert resolve_device_id(payload) == "vendor-device-42"
+    assert build_runtime_identity(payload) == {
+        "config_id": "core-config-uuid",
+        "device_id": "vendor-device-42",
+        "container_id": "container-1",
+        "integration_id": "demo-runtime",
+    }
+
+
+def test_runtime_identity_helpers_fall_back_to_id() -> None:
+    payload = {"id": "core-config-uuid"}
+
+    assert resolve_config_id(payload) == "core-config-uuid"
+    assert resolve_device_id(payload) == "core-config-uuid"

{piphi_runtime_kit_python-0.4.1 → piphi_runtime_kit_python-0.4.2}/tests/test_runtime_registry.py

@@ -21,6 +21,16 @@ def test_runtime_registry_update_state_mirrors_latest_state_to_entry() -> None:
     assert registry.entries["device-1"]["latest_state"] == {"is_on": True}
 
 
+def test_runtime_registry_update_state_uses_entry_device_id_when_present() -> None:
+    registry = RuntimeRegistry()
+    registry.set("cfg-1", {"device_id": "sensor-1"})
+
+    latest_state = registry.update_state("cfg-1", {"temperature_c": 21.5})
+
+    assert latest_state["device_id"] == "sensor-1"
+    assert registry.state_snapshots["cfg-1"]["device_id"] == "sensor-1"
+
+
 def test_runtime_registry_append_event_bounds_recent_event_window() -> None:
     registry = RuntimeRegistry(max_recent_events=2)
 

{piphi_runtime_kit_python-0.4.1 → piphi_runtime_kit_python-0.4.2}/tests/test_runtime_starter.py

@@ -40,6 +40,10 @@ def test_runtime_starter_entities_response_wraps_runtime_entities() -> None:
                 "config_id": "cfg-1",
                 "device_id": "office-plug",
                 "device_class": "plug",
+                "available_commands": [
+                    {"id": "toggle", "label": "Toggle", "kind": "primary"},
+                    {"id": "refresh", "label": "Refresh", "kind": "secondary"},
+                ],
             }
         ],
         capabilities={"switch": {"kind": "action"}},
@@ -49,5 +53,6 @@ def test_runtime_starter_entities_response_wraps_runtime_entities() -> None:
     assert isinstance(response, RuntimeEntitiesResponse)
     assert response.entities[0].name == "Office Plug"
     assert response.entities[0].device_class == "plug"
+    assert response.entities[0].available_commands[0].id == "toggle"
     assert response.capabilities == {"switch": {"kind": "action"}}
     assert response.commands == {"turn_on": {"description": "Turn on"}}

{piphi_runtime_kit_python-0.4.1 → piphi_runtime_kit_python-0.4.2}/tests/test_schemas_matrix.py

@@ -17,6 +17,7 @@ from piphi_runtime_kit_python import (
     RuntimeConfigSyncResponse,
     RuntimeDiagnosticsResponse,
     RuntimeEntitiesResponse,
+    RuntimeEntityCommandResponse,
     RuntimeEntityDashboardResponse,
     RuntimeEntityResponse,
     RuntimeHealthResponse,
@@ -85,6 +86,20 @@ def test_runtime_entity_models_support_aliases_and_defaults() -> None:
             "deviceId": "office-plug",
             "deviceClass": "plug",
             "entityType": "switch",
+            "availableCommands": [
+                {
+                    "id": "toggle",
+                    "label": "Toggle",
+                    "kind": "primary",
+                },
+                {
+                    "id": "set_brightness",
+                    "label": "Set Brightness",
+                    "argsSchema": {
+                        "brightness": {"type": "number", "min": 0, "max": 100, "unit": "%"}
+                    },
+                },
+            ],
             "dashboard": {
                 "allowedWidgets": ["tile", "stat"],
                 "defaultWidget": "tile",
@@ -97,6 +112,10 @@ def test_runtime_entity_models_support_aliases_and_defaults() -> None:
     assert entity.device_id == "office-plug"
     assert entity.device_class == "plug"
     assert entity.entity_type == "switch"
+    assert len(entity.available_commands) == 2
+    assert isinstance(entity.available_commands[0], RuntimeEntityCommandResponse)
+    assert entity.available_commands[0].id == "toggle"
+    assert entity.available_commands[1].args_schema["brightness"].minimum == 0
     assert entity.dashboard is not None
     assert entity.dashboard.allowed_widgets == ["tile", "stat"]
     assert entity.dashboard.default_widget == "tile"