matter-python-client 1.4.1a5.dev20260916__tar.gz → 1.4.1a6.dev20260918__tar.gz

{matter_python_client-1.4.1a5.dev20260916 → matter_python_client-1.4.1a6.dev20260918}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matter-python-client
-Version: 1.4.1a5.dev20260916
+Version: 1.4.1a6.dev20260918
 Summary: Python Client for the OHF Matter Server
 Author-email: Open Home Foundation <hello@openhomefoundation.io>
 License-Expression: Apache-2.0

{matter_python_client-1.4.1a5.dev20260916 → matter_python_client-1.4.1a6.dev20260918}/matter_python_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matter-python-client
-Version: 1.4.1a5.dev20260916
+Version: 1.4.1a6.dev20260918
 Summary: Python Client for the OHF Matter Server
 Author-email: Open Home Foundation <hello@openhomefoundation.io>
 License-Expression: Apache-2.0

{matter_python_client-1.4.1a5.dev20260916 → matter_python_client-1.4.1a6.dev20260918}/matter_server/client/client.py

@@ -774,8 +774,8 @@ class MatterClient:
         message = self._prepare_message(command, require_schema, **kwargs)
         future: asyncio.Future[Any] = self._loop.create_future()
         self._result_futures[message.message_id] = future
-        await self.connection.send_message(message)
         try:
+            await self.connection.send_message(message)
             return await future
         finally:
             self._result_futures.pop(message.message_id)
@@ -850,7 +850,11 @@ class MatterClient:
         if isinstance(msg, ResultMessageBase):
             future = self._result_futures.get(msg.message_id)
 
-            if future is None or future.done():
+            if future is None:
+                self.logger.debug("No listener for result of message id %s", msg.message_id)
+                return
+            if future.done():
+                self.logger.debug("Result arrived for already settled message id %s", msg.message_id)
                 return
 
             if isinstance(msg, SuccessResultMessage):

{matter_python_client-1.4.1a5.dev20260916 → matter_python_client-1.4.1a6.dev20260918}/pyproject.toml

@@ -25,7 +25,7 @@ license = "Apache-2.0"
 name = "matter-python-client"
 readme = "README.md"
 requires-python = ">=3.12"
-version = "1.4.1a5.dev20260916"
+version = "1.4.1a6.dev20260918"
 
 [project.urls]
 Homepage = "https://github.com/matter-js/matterjs-server"

matter_python_client-1.4.1a6.dev20260918/tests/test_client.py

@@ -0,0 +1,222 @@
+"""Tests for matter_server.client.client.MatterClient."""
+
+from __future__ import annotations
+
+import asyncio
+from typing import TYPE_CHECKING
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+
+from chip.clusters import Objects as clusters
+from matter_server.client.client import MatterClient
+from matter_server.client.connection import MatterClientConnection
+from matter_server.common.const import SCHEMA_VERSION
+from matter_server.common.errors import NodeCommissionFailed
+from matter_server.common.models import (
+    APICommand,
+    CommandMessage,
+    ErrorResultMessage,
+    MessageType,
+    ServerInfoMessage,
+    SuccessResultMessage,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Awaitable, Callable
+
+
+def _make_client() -> MatterClient:
+    return MatterClient(ws_server_url="ws://example.invalid/ws", aiohttp_session=MagicMock())
+
+
+@pytest.mark.parametrize(
+    "message",
+    [
+        SuccessResultMessage(message_id="late-result", result={"ok": True}),
+        ErrorResultMessage(message_id="late-result", error_code=1, details="late error"),
+    ],
+    ids=["success", "error"],
+)
+@pytest.mark.parametrize("done_state", ["cancelled", "resolved"])
+async def test_handle_incoming_message_ignores_result_for_done_future(
+    message: SuccessResultMessage | ErrorResultMessage, done_state: str
+) -> None:
+    client = _make_client()
+    future = asyncio.get_running_loop().create_future()
+    client._result_futures[message.message_id] = future
+
+    if done_state == "cancelled":
+        future.cancel()
+    else:
+        future.set_result("existing result")
+
+    client._handle_incoming_message(message)
+
+    if done_state == "cancelled":
+        assert future.cancelled()
+    else:
+        assert future.result() == "existing result"
+
+
+async def test_handle_incoming_message_resolves_pending_success() -> None:
+    client = _make_client()
+    future = asyncio.get_running_loop().create_future()
+    client._result_futures["pending-success"] = future
+
+    client._handle_incoming_message(SuccessResultMessage(message_id="pending-success", result={"ok": True}))
+
+    assert future.result() == {"ok": True}
+
+
+async def test_handle_incoming_message_rejects_pending_error() -> None:
+    client = _make_client()
+    future = asyncio.get_running_loop().create_future()
+    client._result_futures["pending-error"] = future
+
+    client._handle_incoming_message(
+        ErrorResultMessage(message_id="pending-error", error_code=1, details="expected error")
+    )
+
+    error = future.exception()
+    assert type(error) is NodeCommissionFailed
+    assert str(error) == "expected error"
+
+
+async def test_write_attribute_sends_tag_keyed_value() -> None:
+    """write_attribute must route struct values through dataclass_to_tag_dict.
+
+    send_command must receive TLV-tag keys ("0".."5"), not field names, or the
+    server rejects the write with INVALID_DATA_TYPE.
+    """
+    client = MatterClient(ws_server_url="ws://example.invalid/ws", aiohttp_session=MagicMock())
+    client.send_command = AsyncMock(return_value=None)
+
+    preset = clusters.Thermostat.Structs.PresetStruct(
+        presetHandle=b"\x01",
+        presetScenario=clusters.Thermostat.Enums.PresetScenarioEnum.kOccupied,
+        name=None,
+        coolingSetpoint=2500,
+        heatingSetpoint=2100,
+        builtIn=True,
+    )
+
+    await client.write_attribute(node_id=1, attribute_path="1/513/80", value=preset)
+
+    client.send_command.assert_awaited_once_with(
+        APICommand.WRITE_ATTRIBUTE,
+        require_schema=4,
+        node_id=1,
+        attribute_path="1/513/80",
+        value={
+            "0": b"\x01",
+            "1": clusters.Thermostat.Enums.PresetScenarioEnum.kOccupied,
+            "3": 2500,
+            "4": 2100,
+            "5": True,
+        },
+    )
+
+
+async def test_handle_incoming_message_ignores_result_without_listener() -> None:
+    client = _make_client()
+    unrelated = asyncio.get_running_loop().create_future()
+    client._result_futures["other"] = unrelated
+
+    client._handle_incoming_message(SuccessResultMessage(message_id="unknown", result={"ok": True}))
+
+    assert client._result_futures == {"other": unrelated}
+    assert not unrelated.done()
+
+
+_FAKE_SERVER_SCHEMA_VERSION = 13
+
+
+class _FakeConnection(MatterClientConnection):
+    """Connection stub driving the client read loop from an in-memory queue."""
+
+    def __init__(self, send_error: Exception | None = None) -> None:
+        super().__init__(ws_server_url="ws://example.invalid/ws", aiohttp_session=MagicMock())
+        self.sent = list[CommandMessage]()
+        self.send_error = send_error
+        self.is_connected = False
+        self.on_receive: Callable[[], Awaitable[None]] | None = None
+        self.message_sent = asyncio.Event()
+        self._incoming = asyncio.Queue[MessageType]()
+
+    @property
+    def connected(self) -> bool:
+        return self.is_connected
+
+    async def connect(self) -> None:
+        self.is_connected = True
+        self.server_info = ServerInfoMessage(
+            fabric_id=1,
+            compressed_fabric_id=1,
+            schema_version=_FAKE_SERVER_SCHEMA_VERSION,
+            min_supported_schema_version=SCHEMA_VERSION,
+            sdk_version="test",
+            wifi_credentials_set=False,
+            thread_credentials_set=False,
+            bluetooth_enabled=False,
+        )
+
+    async def disconnect(self) -> None:
+        self.is_connected = False
+
+    async def send_message(self, message: CommandMessage) -> None:
+        if self.send_error is not None:
+            raise self.send_error
+        self.sent.append(message)
+        self.message_sent.set()
+
+    async def receive_message_or_raise(self) -> MessageType:
+        message = await self._incoming.get()
+        if self.on_receive is not None:
+            await self.on_receive()
+        return message
+
+    def deliver(self, message: MessageType) -> None:
+        self._incoming.put_nowait(message)
+
+
+async def test_send_command_forgets_the_future_when_the_send_fails() -> None:
+    client = _make_client()
+    connection = _FakeConnection(send_error=ConnectionResetError("Cannot write to closing transport"))
+    connection.is_connected = True
+    client.connection = connection
+    client._loop = asyncio.get_running_loop()
+
+    with pytest.raises(ConnectionResetError):
+        await client.send_command(APICommand.SERVER_DIAGNOSTICS)
+
+    assert client._result_futures == {}
+
+
+async def test_late_result_after_disconnect_keeps_the_read_loop_alive(
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    caplog.set_level("DEBUG", logger="matter_server.client")
+    client = _make_client()
+    connection = _FakeConnection()
+    client.connection = connection
+
+    init_ready = asyncio.Event()
+    listen_task = asyncio.create_task(client.start_listening(init_ready))
+    connection.deliver(SuccessResultMessage(message_id="start-listening", result=[]))
+    await asyncio.wait_for(init_ready.wait(), timeout=1)
+
+    connection.message_sent.clear()
+    command_task = asyncio.create_task(client.send_command(APICommand.SERVER_DIAGNOSTICS))
+    await asyncio.wait_for(connection.message_sent.wait(), timeout=1)
+    message_id = next(iter(client._result_futures))
+
+    # disconnect must land between the wire read and the handler, or the race cannot occur
+    connection.on_receive = client.disconnect
+    connection.deliver(SuccessResultMessage(message_id=message_id, result={"late": True}))
+
+    await asyncio.wait_for(listen_task, timeout=1)
+    with pytest.raises(asyncio.CancelledError):
+        await command_task
+    assert client._result_futures == {}
+    assert f"Result arrived for already settled message id {message_id}" in caplog.text

{matter_python_client-1.4.1a5.dev20260916 → matter_python_client-1.4.1a6.dev20260918}/tests/test_client_integration.py

@@ -75,6 +75,7 @@ async def test_send_command_and_receive_response(mock_server, client_session):
 
     result = await client.send_command("diagnostics")
     assert result == {"info": "test"}
+    assert client._result_futures == {}
 
     await client.disconnect()
     listen_task.cancel()

matter_python_client-1.4.1a5.dev20260916/tests/test_client.py

@@ -1,105 +0,0 @@
-"""Tests for matter_server.client.client.MatterClient."""
-
-from __future__ import annotations
-
-import asyncio
-from unittest.mock import AsyncMock, MagicMock
-
-import pytest
-
-from chip.clusters import Objects as clusters
-from matter_server.client.client import MatterClient
-from matter_server.common.errors import MatterError
-from matter_server.common.models import APICommand, ErrorResultMessage, SuccessResultMessage
-
-
-def _make_client() -> MatterClient:
-    return MatterClient(ws_server_url="ws://example.invalid/ws", aiohttp_session=MagicMock())
-
-
-@pytest.mark.parametrize(
-    "message",
-    [
-        SuccessResultMessage(message_id="late-result", result={"ok": True}),
-        ErrorResultMessage(message_id="late-result", error_code=1, details="late error"),
-    ],
-    ids=["success", "error"],
-)
-@pytest.mark.parametrize("done_state", ["cancelled", "resolved"])
-async def test_handle_incoming_message_ignores_result_for_done_future(
-    message: SuccessResultMessage | ErrorResultMessage, done_state: str
-) -> None:
-    client = _make_client()
-    future = asyncio.get_running_loop().create_future()
-    client._result_futures[message.message_id] = future
-
-    if done_state == "cancelled":
-        future.cancel()
-    else:
-        future.set_result("existing result")
-
-    client._handle_incoming_message(message)
-
-    if done_state == "cancelled":
-        assert future.cancelled()
-    else:
-        assert future.result() == "existing result"
-
-
-async def test_handle_incoming_message_resolves_pending_success() -> None:
-    client = _make_client()
-    future = asyncio.get_running_loop().create_future()
-    client._result_futures["pending-success"] = future
-
-    client._handle_incoming_message(SuccessResultMessage(message_id="pending-success", result={"ok": True}))
-
-    assert future.result() == {"ok": True}
-
-
-async def test_handle_incoming_message_rejects_pending_error() -> None:
-    client = _make_client()
-    future = asyncio.get_running_loop().create_future()
-    client._result_futures["pending-error"] = future
-
-    client._handle_incoming_message(
-        ErrorResultMessage(message_id="pending-error", error_code=1, details="expected error")
-    )
-
-    error = future.exception()
-    assert isinstance(error, MatterError)
-    assert str(error) == "expected error"
-
-
-async def test_write_attribute_sends_tag_keyed_value() -> None:
-    """write_attribute must route struct values through dataclass_to_tag_dict.
-
-    send_command must receive TLV-tag keys ("0".."5"), not field names, or the
-    server rejects the write with INVALID_DATA_TYPE.
-    """
-    client = MatterClient(ws_server_url="ws://example.invalid/ws", aiohttp_session=MagicMock())
-    client.send_command = AsyncMock(return_value=None)
-
-    preset = clusters.Thermostat.Structs.PresetStruct(
-        presetHandle=b"\x01",
-        presetScenario=clusters.Thermostat.Enums.PresetScenarioEnum.kOccupied,
-        name=None,
-        coolingSetpoint=2500,
-        heatingSetpoint=2100,
-        builtIn=True,
-    )
-
-    await client.write_attribute(node_id=1, attribute_path="1/513/80", value=preset)
-
-    client.send_command.assert_awaited_once_with(
-        APICommand.WRITE_ATTRIBUTE,
-        require_schema=4,
-        node_id=1,
-        attribute_path="1/513/80",
-        value={
-            "0": b"\x01",
-            "1": clusters.Thermostat.Enums.PresetScenarioEnum.kOccupied,
-            "3": 2500,
-            "4": 2100,
-            "5": True,
-        },
-    )