Replace client websocket (#716)

Replaced Client-Side Websocket Connection-Based Logging with HTTPX One
The websocket connection between the client and the backend server has been unstable, prone to error, and unable to fulfil its role of sending logs to the backend for subsequent forwarding to the logging dashboard. In this PR, the log forwarding logic has been replaced by a HTTPX-based log handler that sends batches of logs to a backend FastAPI endpoint. It also removes the now-defunct websocket-related components from the client end.

Simplifcation of pyproject.toml Dependency Keys
Consequently, the optional dependency keys needed for our pyproject.toml file can also been streamlined. As of this PR, the client and instrument-server optional dependency keys are no longer needed, as the packages needed to run the instrument server are a subset of those needed to run the backend server, and have thus been integrated into the essential dependencies section. The documentation and GitHub workflows have thus been updated to reflect this.

Author: tieneupin

.github/workflows/ci.yml

@@ -77,7 +77,7 @@ jobs:
       - name: Install Murfey
         run: |
           set -eux
-          pip install --disable-pip-version-check -e "."[cicd,client,server,developer]
+          pip install --disable-pip-version-check -e "."[cicd,server,developer]
 
       - uses: shogo82148/actions-setup-mysql@v1
         with:

.github/workflows/publish-version.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Check current tag
         id: checkTag
         run: |
-          pip install --disable-pip-version-check -e "."[cicd,client,server,developer]
+          pip install --disable-pip-version-check -e "."[cicd,server,developer]
           VERSION=$(python -c "import murfey; print(murfey.__version__)")
           echo "newVersion=v$VERSION" >> $GITHUB_OUTPUT
 

.github/workflows/version-bump.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Install package
         run: |
           set -eux
-          pip install --disable-pip-version-check -e "."[cicd,client,server,developer]
+          pip install --disable-pip-version-check -e "."[cicd,server,developer]
       - name: Run bumpversion and push tag
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dockerfiles/murfey-instrument-server

@@ -32,7 +32,7 @@ RUN apt-get update && \
         pip \
         build \
         importlib-metadata && \
-    /venv/bin/python -m pip install /python-murfey[client]
+    /venv/bin/python -m pip install /python-murfey
 
 
 # Transfer completed Murfey build to base image

README.md

@@ -19,7 +19,7 @@ then install using the following command.
 ```text
 $ git clone [email protected]:DiamondLightSource/python-murfey.git
 $ cd python-murfey
-$ pip install -e .[client,server,developer]
+$ pip install -e .[server,developer]
 ```
 
 The packages included under the `[developer]` installation key contain some helpful tools to aid you with developing Murfey further:
@@ -43,7 +43,7 @@ $ murfey.server
 and connect the client with
 
 ```text
-$ murfey --server http://127.0.0.1:8000
+$ murfey.instrument_server --port 8000
 ```
 
 You can also install a client on a remote machine. This machine only needs to have

pyproject.toml

@@ -44,14 +44,12 @@ dependencies = [
 cicd = [
     "pytest-cov", # Used for generating PyTest coverage reports
 ]
-client = [
-    "websocket-client",
-]
 developer = [
     "bump-my-version", # Version control
     "ipykernel", # Enable interactive coding with VS Code and Jupyter Notebook
     "pre-commit", # Formatting, linting, type checking, etc.
     "pytest", # Test code functionality
+    "pytest-asyncio", # For testing async functions
     "pytest-mock", # Additional mocking tools for unit tests
 ]
 server = [

src/murfey/bootstrap/__main__.py

@@ -144,7 +144,7 @@ def _download_to_file(url: str, outfile: str):
             murfey_hostname,
             "-i",
             f"{murfey_base}{url_path_for('bootstrap.pypi', 'get_pypi_index')}",
-            "murfey[client]",
+            "murfey",
         ]
     )
     if result.returncode:

src/murfey/client/customlogging.py

@@ -1,4 +1,3 @@
-import json
 import logging
 import subprocess
 import threading
@@ -10,7 +9,6 @@
 from typing import Dict, List, Optional
 from urllib.parse import urlparse
 
-import murfey.client.websocket
 from murfey.client.analyser import Analyser
 from murfey.client.context import ensure_dcg_exists
 from murfey.client.contexts.spa import SPAModularContext
@@ -96,11 +94,6 @@ def __post_init__(self):
         self.rsync_processes = self.rsync_processes or {}
         self.analysers = self.analysers or {}
 
-        self.ws = murfey.client.websocket.WSApp(
-            server=self.murfey_url,
-            register_client=False,
-        )
-
         # Calculate the time offset between the client and the server
         current_time = datetime.now()
         server_timestamp = capture_get(
@@ -181,17 +174,6 @@ def clean_up_once_dormant(self, running_threads: list[threading.Thread]):
         if not success:
             log.warning(f"Could not delete database data for {self.session_id}")
 
-        # Send message to frontend to trigger a refresh
-        self.ws.send(
-            json.dumps(
-                {
-                    "message": "refresh",
-                    "target": "sessions",
-                    "instrument_name": self.instrument_name,
-                }
-            )
-        )
-
         # Mark as dormant
         self.dormant = True
 
@@ -289,15 +271,6 @@ def _start_rsyncer_multigrid(
             transfer=machine_data.get("data_transfer_enabled", True),
             restarted=str(source) in self.rsync_restarts,
         )
-        self.ws.send(
-            json.dumps(
-                {
-                    "message": "refresh",
-                    "target": "rsyncer",
-                    "session_id": self.session_id,
-                }
-            )
-        )
 
     def _rsyncer_stopped(self, source: Path, explicit_stop: bool = False):
         if explicit_stop:

src/murfey/client/multigrid_control.py

@@ -78,7 +78,7 @@ def install_murfey(api_base: ParseResult, version: str) -> bool:
                 path=f"{proxy_path}{url_path_for('bootstrap.pypi', 'get_pypi_index')}",
                 query="",
             ).geturl(),
-            f"murfey[client]=={version}",
+            f"murfey=={version}",
         ]
     )
     return result.returncode == 0