ucapi 0.3.0__tar.gz → 0.3.1__tar.gz

{ucapi-0.3.0 → ucapi-0.3.1}/CHANGELOG.md

@@ -11,6 +11,10 @@ _Changes in the next release_
 
 ---
 
+## v0.3.1 - 2024-05-14
+### Fixed
+- Filtered log messages may not modify original data. This sporadically removed media artwork URLs ([#27](https://github.com/unfoldedcircle/integration-python-library/pull/27)).
+
 ## v0.3.0 - 2024-04-25
 ### Added
 - New media-player attribute MEDIA_POSITION_UPDATED_AT ([feature-and-bug-tracker#443](https://github.com/unfoldedcircle/feature-and-bug-tracker/issues/443)).

{ucapi-0.3.0/ucapi.egg-info → ucapi-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi
-Version: 0.3.0
+Version: 0.3.1
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0

ucapi-0.3.1/tests/test_api.py

@@ -0,0 +1,95 @@
+import unittest
+from copy import deepcopy
+
+from ucapi.api import filter_log_msg_data
+from ucapi.media_player import Attributes
+
+
+class TestFilterLogMsgData(unittest.TestCase):
+
+    def test_no_modification_when_no_msg_data(self):
+        data = {}
+        result = filter_log_msg_data(data)
+        self.assertEqual(result, {}, "The result should be an empty dictionary")
+
+    def test_no_changes_when_media_image_url_not_present(self):
+        data = {"msg_data": {"attributes": {"state": "playing", "volume": 50}}}
+        original = deepcopy(data)
+
+        result = filter_log_msg_data(data)
+
+        self.assertEqual(
+            result,
+            original,
+            "The result should be the same as the input when no filtered attributes are present",
+        )
+
+    def test_filtering_media_image_url_in_dict(self):
+        data = {
+            "msg_data": {
+                "attributes": {
+                    "state": "playing",
+                    Attributes.MEDIA_IMAGE_URL: "data:image/png;base64,encodeddata",
+                }
+            }
+        }
+        expected_result = deepcopy(data)
+        expected_result["msg_data"]["attributes"][
+            Attributes.MEDIA_IMAGE_URL
+        ] = "data:***"
+
+        result = filter_log_msg_data(data)
+
+        self.assertEqual(
+            result, expected_result, "The MEDIA_IMAGE_URL attribute should be filtered"
+        )
+
+    def test_filtering_media_image_url_in_list(self):
+        data = {
+            "msg_data": [
+                {
+                    "attributes": {
+                        "state": "paused",
+                        Attributes.MEDIA_IMAGE_URL: "data:image/png;base64,exampledata",
+                    }
+                },
+                {
+                    "attributes": {
+                        "state": "playing",
+                        Attributes.MEDIA_IMAGE_URL: "data:image/jpg;base64,exampledata",
+                    }
+                },
+                {"attributes": {"state": "stopped"}},
+            ]
+        }
+        expected_result = deepcopy(data)
+        expected_result["msg_data"][0]["attributes"][
+            Attributes.MEDIA_IMAGE_URL
+        ] = "data:***"
+        expected_result["msg_data"][1]["attributes"][
+            Attributes.MEDIA_IMAGE_URL
+        ] = "data:***"
+
+        result = filter_log_msg_data(data)
+
+        self.assertEqual(
+            result,
+            expected_result,
+            "All MEDIA_IMAGE_URL attributes in the list should be filtered",
+        )
+
+    def test_input_is_not_modified(self):
+        data = {
+            "msg_data": {
+                "attributes": {
+                    Attributes.MEDIA_IMAGE_URL: "data:image/png;base64,encodeddata"
+                }
+            }
+        }
+        original_data = deepcopy(data)
+
+        filter_log_msg_data(data)
+
+        self.assertEqual(
+            data, original_data, "The input data should not be modified by the function"
+        )

{ucapi-0.3.0 → ucapi-0.3.1}/ucapi/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.0'
-__version_tuple__ = version_tuple = (0, 3, 0)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)

{ucapi-0.3.0 → ucapi-0.3.1}/ucapi/api.py

@@ -11,6 +11,7 @@ import logging
 import os
 import socket
 from asyncio import AbstractEventLoop
+from copy import deepcopy
 from typing import Any, Callable
 
 import websockets
@@ -25,8 +26,8 @@ from zeroconf import IPVersion
 from zeroconf.asyncio import AsyncServiceInfo, AsyncZeroconf
 
 import ucapi.api_definitions as uc
-from ucapi import media_player
 from ucapi.entities import Entities
+from ucapi.media_player import Attributes as MediaAttr
 
 try:
     from ._version import version as __version__
@@ -249,8 +250,9 @@ class IntegrationAPI:
         if websocket in self._clients:
             data_dump = json.dumps(data)
             if _LOG.isEnabledFor(logging.DEBUG):
-                data_log = json.dumps(data) if filter_log_msg_data(data) else data_dump
-                _LOG.debug("[%s] ->: %s", websocket.remote_address, data_log)
+                _LOG.debug(
+                    "[%s] ->: %s", websocket.remote_address, filter_log_msg_data(data)
+                )
             await websocket.send(data_dump)
         else:
             _LOG.error("Error sending response: connection no longer established")
@@ -270,14 +272,12 @@ class IntegrationAPI:
         """
         data = {"kind": "event", "msg": msg, "msg_data": msg_data, "cat": category}
         data_dump = json.dumps(data)
-        # filter fields
-        data_log = ""
-        if _LOG.isEnabledFor(logging.DEBUG):
-            data_log = json.dumps(data) if filter_log_msg_data(data) else data_dump
 
         for websocket in self._clients:
             if _LOG.isEnabledFor(logging.DEBUG):
-                _LOG.debug("[%s] =>: %s", websocket.remote_address, data_log)
+                _LOG.debug(
+                    "[%s] =>: %s", websocket.remote_address, filter_log_msg_data(data)
+                )
             try:
                 await websocket.send(data_dump)
             except websockets.exceptions.WebSocketException:
@@ -302,8 +302,9 @@ class IntegrationAPI:
 
         if websocket in self._clients:
             if _LOG.isEnabledFor(logging.DEBUG):
-                data_log = json.dumps(data) if filter_log_msg_data(data) else data_dump
-                _LOG.debug("[%s] ->: %s", websocket.remote_address, data_log)
+                _LOG.debug(
+                    "[%s] ->: %s", websocket.remote_address, filter_log_msg_data(data)
+                )
             await websocket.send(data_dump)
         else:
             _LOG.error("Error sending event: connection no longer established")
@@ -864,47 +865,42 @@ def local_hostname() -> str:
     )
 
 
-def filter_log_msg_data(data: dict[str, Any]) -> bool:
+def filter_log_msg_data(data: dict[str, Any]) -> dict[str, Any]:
     """
     Filter attribute fields to exclude for log messages in the given msg data dict.
 
-    Attention: the dictionary is modified!
-
     - Attributes are filtered in `data["msg_data"]`:
       - dict object: key `attributes`
       - list object: every list item `attributes`
     - Filtered attributes: `MEDIA_IMAGE_URL`
 
     :param data: the message data dict
-    :return: True if a field was filtered, False otherwise
+    :return: copy of the message data dict with filtered attributes
     """
+    # do not modify the original dict
+    log_upd = deepcopy(data)
+    if not log_upd:
+        return {}
+
     # filter out base64 encoded images in the media player's media_image_url attribute
-    if "msg_data" in data:
+    if "msg_data" in log_upd:
         if (
-            "attributes" in data["msg_data"]
-            and media_player.Attributes.MEDIA_IMAGE_URL
-            in data["msg_data"]["attributes"]
-            and data["msg_data"]["attributes"][
-                media_player.Attributes.MEDIA_IMAGE_URL
-            ].startswith("data:")
+            "attributes" in log_upd["msg_data"]
+            and MediaAttr.MEDIA_IMAGE_URL in log_upd["msg_data"]["attributes"]
+            and log_upd["msg_data"]["attributes"][MediaAttr.MEDIA_IMAGE_URL].startswith(
+                "data:"
+            )
         ):
-            data["msg_data"]["attributes"][
-                media_player.Attributes.MEDIA_IMAGE_URL
-            ] = "data:***"
-            return True
-
-        if isinstance(data["msg_data"], list):
-            for item in data["msg_data"]:
+            log_upd["msg_data"]["attributes"][MediaAttr.MEDIA_IMAGE_URL] = "data:***"
+        elif isinstance(log_upd["msg_data"], list):
+            for item in log_upd["msg_data"]:
                 if (
                     "attributes" in item
-                    and media_player.Attributes.MEDIA_IMAGE_URL in item["attributes"]
-                    and item["attributes"][
-                        media_player.Attributes.MEDIA_IMAGE_URL
-                    ].startswith("data:")
+                    and MediaAttr.MEDIA_IMAGE_URL in item["attributes"]
+                    and item["attributes"][MediaAttr.MEDIA_IMAGE_URL].startswith(
+                        "data:"
+                    )
                 ):
-                    item["attributes"][
-                        media_player.Attributes.MEDIA_IMAGE_URL
-                    ] = "data:***"
-            return True
+                    item["attributes"][MediaAttr.MEDIA_IMAGE_URL] = "data:***"
 
-    return False
+    return log_upd

{ucapi-0.3.0 → ucapi-0.3.1/ucapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi
-Version: 0.3.0
+Version: 0.3.1
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0

{ucapi-0.3.0 → ucapi-0.3.1}/ucapi.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ examples/remote.py
 examples/remote_ui_page.json
 examples/setup_flow.json
 examples/setup_flow.py
+tests/test_api.py
 ucapi/__init__.py
 ucapi/_version.py
 ucapi/api.py