Merge pull request #54 from lawtancool/copilot/fix-blocking-call-load-default-certs

Pass caller's session to socketio to avoid blocking SSL calls in event loop

Author: lawtancool

.gitignore

@@ -3,3 +3,4 @@
 __pycache__/
 login_info.py
 allitems.json
+*.egg-info/

pyControl4/websocket.py

@@ -101,12 +101,16 @@ def __init__(
         Parameters:
             `ip` - The IP address of the Control4 Director/Controller.
 
-            `session` - (Optional) Allows the use of an
+            `session_no_verify_ssl` - (Optional) Allows the use of an
                         `aiohttp.ClientSession` object
                         for all network requests. This
                         session will not be closed by the library.
                         If not provided, the library will open and
                         close its own `ClientSession`s as needed.
+                        This session is also passed to the underlying
+                        socketio/engineio client to avoid blocking
+                        `ssl.create_default_context()` calls inside
+                        the event loop.
 
             `connect_callback` - (Optional) A callback to be called when the
                 Websocket connection is opened or reconnected after a network
@@ -193,7 +197,18 @@ async def sio_connect(self, director_bearer_token):
         # Disconnect previous sio object
         await self.sio_disconnect()
 
-        self._sio = socketio.AsyncClient(ssl_verify=False)
+        if self.session is not None:
+            # Create a new session using the caller's connector so engineio
+            # can safely close it in _reset() without affecting the caller's
+            # session.
+            http_session = aiohttp.ClientSession(
+                connector=self.session.connector, connector_owner=False
+            )
+            self._sio = socketio.AsyncClient(
+                ssl_verify=False, http_session=http_session
+            )
+        else:
+            self._sio = socketio.AsyncClient(ssl_verify=False)
         self._sio.register_namespace(
             _C4DirectorNamespace(
                 token=director_bearer_token,

tests/test_websocket_ssl.py

@@ -0,0 +1,54 @@
+"""Tests for SSL context passthrough in C4Websocket."""
+
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import aiohttp
+import socketio_v4
+import pytest
+
+from pyControl4.websocket import C4Websocket
+
+
+@pytest.mark.asyncio
+async def test_sio_connect_without_session():
+    """Test that sio_connect uses ssl_verify=False without http_session when
+    no session is provided."""
+    ws = C4Websocket("192.168.1.1")
+    with patch.object(
+        socketio_v4.AsyncClient, "__init__", return_value=None
+    ) as mock_init, patch.object(
+        socketio_v4.AsyncClient, "register_namespace"
+    ), patch.object(
+        socketio_v4.AsyncClient, "connect", new_callable=AsyncMock
+    ):
+        await ws.sio_connect("test-token")
+        mock_init.assert_called_once_with(ssl_verify=False)
+
+
+@pytest.mark.asyncio
+async def test_sio_connect_with_session():
+    """Test that sio_connect creates a new session sharing the caller's
+    connector and passes it as http_session, so engineio can safely close
+    it without affecting the caller's session."""
+    mock_connector = MagicMock()
+    mock_session = MagicMock()
+    mock_session.connector = mock_connector
+    ws = C4Websocket("192.168.1.1", session_no_verify_ssl=mock_session)
+    with patch.object(
+        socketio_v4.AsyncClient, "__init__", return_value=None
+    ) as mock_init, patch.object(
+        socketio_v4.AsyncClient, "register_namespace"
+    ), patch.object(
+        socketio_v4.AsyncClient, "connect", new_callable=AsyncMock
+    ), patch.object(
+        aiohttp, "ClientSession"
+    ) as mock_session_cls:
+        mock_http_session = MagicMock()
+        mock_session_cls.return_value = mock_http_session
+        await ws.sio_connect("test-token")
+        mock_session_cls.assert_called_once_with(
+            connector=mock_connector, connector_owner=False
+        )
+        mock_init.assert_called_once_with(
+            ssl_verify=False, http_session=mock_http_session
+        )