refactor: log WS messages as JSON data instead of a Python dict (#58)

Author: zehnm

CHANGELOG.md

@@ -15,6 +15,7 @@ _Changes in the next release_
 ### Changed
 - Improved WS msg processing with dedicated consumer, producer and router tasks with asyncio queues ([#47](https://github.com/unfoldedcircle/integration-python-library/pull/47)).
 - Sanitize log messages to prevent sensitive information exposure ([#56](https://github.com/unfoldedcircle/integration-python-library/pull/56)).
+- Log WebSocket messages as JSON data instead of a Python dict.
 - Updated GitHub actions and test dependencies.
 
 ---

ucapi/api.py

@@ -147,9 +147,10 @@ async def init(
         self, driver_path: str, setup_handler: uc.SetupHandler | None = None
     ):
         """
-        Load driver configuration and start integration-API WebSocket server.
+        Load driver configuration and start the integration-API WebSocket server.
 
-        :param driver_path: path to configuration file
+        :param driver_path: path to the configuration file. If it is not an absolute
+               path, the current working directory is used.
         :param setup_handler: optional driver setup handler if the driver metadata
                contains a setup_data_schema object
         """
@@ -389,7 +390,9 @@ async def _enqueue_ws_payload(self, websocket, payload: dict[str, Any]) -> None:
 
         if _LOG.isEnabledFor(logging.DEBUG):
             _LOG.debug(
-                "[%s] <-: %s", websocket.remote_address, sanitize_json_message(payload)
+                "[%s] <-: %s",
+                websocket.remote_address,
+                json.dumps(sanitize_json_message(payload)),
             )
 
         match payload.get("kind"):
@@ -515,7 +518,9 @@ async def _send_ws_event(
     async def _process_ws_message(self, websocket, data: dict[str, Any]) -> None:
         if _LOG.isEnabledFor(logging.DEBUG):
             _LOG.debug(
-                "[%s] ->: %s", websocket.remote_address, sanitize_json_message(data)
+                "[%s] ->: %s",
+                websocket.remote_address,
+                json.dumps(sanitize_json_message(data)),
             )
 
         kind = data["kind"]