Merge pull request #17 from wandelbotsgmbh/fix/websocket-auth

fix: support auth for websocket handling

.vscode/launch.json

@@ -9,7 +9,10 @@
       "args": ["tests", "--maxfail=1", "--disable-warnings"],
       "console": "integratedTerminal",
       "justMyCode": false,
-      "envFile": "${workspaceFolder}/.env"
+      "envFile": "${workspaceFolder}/.env",
+      "env": {
+        "PYTHONPATH": "${workspaceFolder}"
+      }
     }
   ]
 }

pyproject.toml

@@ -9,8 +9,8 @@ readme = "README.md"
 python = "^3.9"
 httpx = "0.27.2"
 requests = "2.32.3"
-wandelbots_api_client = "24.8.0.dev17"
-websockets = "13.0.1"
+wandelbots_api_client = "24.8.0rc6"
+websockets = ">=14.0.0"
 numpy = "^1.26"
 scipy = "^1.11"
 nbqa = "^1.9.0"

requirements.txt

@@ -27,3 +27,6 @@ ipyleaflet
 # Python: plotting libraries (optional)
 plotly>=5,<6
 bqplot
+
+python-dotenv
+websockets>14

wandelbots/apis/motion.py

@@ -146,8 +146,13 @@ def stream_motion(
     direction: Literal["forward", "backward"] = "forward",
     callback: Callable[[MoveResponse], None] = None,
 ) -> None:
-    uri = f"{instance.socket_uri}/cells/{cell}/motions/{motion}/execute{direction}"
-    uri += f"?playback_speed_in_percent={playback_speed}&response_rate={response_rate}"
+    additional_params = {
+        "playback_speed_in_percent": playback_speed,
+        "response_rate": response_rate,
+    }
+    uri = instance.get_socket_uri_with_auth(
+        additional_params, f"/cells/{cell}/motions/{motion}/execute{direction}"
+    )
     logger.debug(f"Connecting to {uri}")
     with connect(uri) as socket:
         logger.debug(f"Connected to {uri}")

wandelbots/core/instance.py

@@ -1,3 +1,5 @@
+from urllib.parse import urlencode
+
 from wandelbots.util.logger import _get_logger
 
 
@@ -41,13 +43,22 @@ def _parse_url(self, host: str) -> str:
 
     @property
     def socket_uri(self):
-        if not self.has_auth():
-            _uri = self.url.replace("http", "ws").replace("https", "wss")
-            return f"{_uri}/api/{self._api_version}"
+        return self.url.replace("http", "ws").replace("https", "wss")
+
+    def get_socket_uri_with_auth(self, additional_params: dict = None, url: str = None):
+        if self.has_basic_auth():
+            _uri = self.socket_uri.replace("wss://", f"wss://{self.user}:{self.password}@")
         else:
-            _url_no_scheme = self.url.split("://")[1]
-            _uri = f"wss://{_url_no_scheme}"
-            return f"{_uri}/api/{self._api_version}"
+            _uri = self.socket_uri
+        params = {}
+        if self.has_access_token():
+            params["token"] = self.access_token
+
+        if additional_params:
+            params.update(additional_params)
+
+        query_string = urlencode(params)
+        return f"{_uri}/api/{self._api_version}/{url}?{query_string}"
 
     def _connect(self):
         self.logger.info(f"Connecting to {self.url}")

wandelbots/request/syncs.py

@@ -1,9 +1,11 @@
+from typing import Dict, Optional, Tuple
+
 import httpx
 import requests
-from typing import Dict, Tuple, Optional
-from wandelbots.util.logger import _get_logger
-from wandelbots.request.config import TIMEOUT
+
 from wandelbots.core.instance import Instance
+from wandelbots.request.config import TIMEOUT
+from wandelbots.util.logger import _get_logger
 
 __logger = _get_logger(__name__)