Make two endpoints in the cases where functionality needs to be shared between the instrument server and frontend

Author: d-j-hatton

src/murfey/client/contexts/spa.py

@@ -16,6 +16,7 @@
     MurfeyInstanceEnvironment,
 )
 from murfey.server.api.file_manip import router as file_manip_router
+from murfey.server.api.session_control import router as session_router
 from murfey.server.api.workflow import spa_router as workflow_spa_router
 from murfey.util.client import (
     authorised_requests,
@@ -264,7 +265,7 @@ def gather_metadata(
         binning_factor = 1
         if environment:
             server_config_response = capture_get(
-                f"{str(environment.url.geturl())}/instruments/{environment.instrument_name}/machine"
+                f"{str(environment.url.geturl())}{session_router.url_path_for('machine_info_by_instrument', instrument_name=environment.instrument_name)}"
             )
             if server_config_response is None:
                 return None

src/murfey/client/contexts/tomo.py

@@ -18,6 +18,7 @@
     MurfeyInstanceEnvironment,
 )
 from murfey.server.api.file_manip import router as file_manip_router
+from murfey.server.api.session_control import router as session_router
 from murfey.server.api.workflow import router as workflow_router
 from murfey.server.api.workflow import tomo_router as workflow_tomo_router
 from murfey.util.client import (
@@ -595,7 +596,7 @@ def gather_metadata(
             binning_factor = 1
             if environment:
                 server_config = requests.get(
-                    f"{str(environment.url.geturl())}/instruments/{environment.instrument_name}/machine"
+                    f"{str(environment.url.geturl())}{session_router.url_path_for('machine_info_by_instrument', instrument_name=environment.instrument_name)}"
                 ).json()
                 if (
                     server_config.get("superres")

src/murfey/server/api/__init__.py

@@ -1,8 +1,6 @@
 from __future__ import annotations
 
 import logging
-import os
-from functools import lru_cache
 from pathlib import Path
 from typing import Dict, List, Optional
 
@@ -29,7 +27,6 @@
 from murfey.server.api.auth import MurfeySessionID, validate_token
 from murfey.server.murfey_db import murfey_db
 from murfey.util import safe_run
-from murfey.util.config import MachineConfig, from_file, settings
 from murfey.util.db import (
     ClientEnvironment,
     DataCollection,
@@ -97,26 +94,6 @@ def connections_check():
     return {"connections": list(ws.manager.active_connections.keys())}
 
 
-@router.get("/machine")
-def machine_info() -> Optional[MachineConfig]:
-    instrument_name = os.getenv("BEAMLINE")
-    if settings.murfey_machine_configuration and instrument_name:
-        return from_file(Path(settings.murfey_machine_configuration), instrument_name)[
-            instrument_name
-        ]
-    return None
-
-
-@lru_cache(maxsize=5)
-@router.get("/instruments/{instrument_name}/machine")
-def machine_info_by_name(instrument_name: str) -> Optional[MachineConfig]:
-    if settings.murfey_machine_configuration:
-        return from_file(Path(settings.murfey_machine_configuration), instrument_name)[
-            instrument_name
-        ]
-    return None
-
-
 @router.get("/mag_table/")
 def get_mag_table(db=murfey_db) -> List[MagnificationLookup]:
     return db.exec(select(MagnificationLookup)).all()

src/murfey/server/api/session_control.py

@@ -8,7 +8,9 @@
 import murfey.server.ispyb
 from murfey.server import _transport_object
 from murfey.server.api.auth import MurfeySessionID, validate_token
+from murfey.server.api.shared import get_machine_config_for_instrument
 from murfey.server.murfey_db import murfey_db
+from murfey.util.config import MachineConfig
 from murfey.util.db import (
     AutoProcProgram,
     ClientEnvironment,
@@ -25,6 +27,11 @@
 )
 
 
+@router.get("/instruments/{instrument_name}/machine")
+def machine_info_by_instrument(instrument_name: str) -> Optional[MachineConfig]:
+    return get_machine_config_for_instrument(instrument_name)
+
+
 @router.get("/new_client_id/")
 async def new_client_id(db=murfey_db):
     clients = db.exec(select(ClientEnvironment)).all()

src/murfey/server/api/session_info.py

@@ -11,8 +11,9 @@
 import murfey.server.ispyb
 from murfey.server import sanitise, templates
 from murfey.server.api.auth import MurfeySessionID, validate_token
+from murfey.server.api.shared import get_machine_config_for_instrument
 from murfey.server.murfey_db import murfey_db
-from murfey.util.config import get_machine_config
+from murfey.util.config import MachineConfig, get_machine_config
 from murfey.util.db import (
     ClientEnvironment,
     DataCollection,
@@ -39,6 +40,11 @@
 )
 
 
+@router.get("/instruments/{instrument_name}/machine")
+def machine_info_by_instrument(instrument_name: str) -> Optional[MachineConfig]:
+    return get_machine_config_for_instrument(instrument_name)
+
+
 @router.get("/instruments/{instrument_name}/visits_raw", response_model=List[Visit])
 def get_current_visits(instrument_name: str, db=murfey.server.ispyb.DB):
     return murfey.server.ispyb.get_all_ongoing_visits(instrument_name, db)

src/murfey/server/api/shared.py

@@ -0,0 +1,14 @@
+from functools import lru_cache
+from pathlib import Path
+from typing import Optional
+
+from murfey.util.config import MachineConfig, from_file, settings
+
+
+@lru_cache(maxsize=5)
+def get_machine_config_for_instrument(instrument_name: str) -> Optional[MachineConfig]:
+    if settings.murfey_machine_configuration:
+        return from_file(Path(settings.murfey_machine_configuration), instrument_name)[
+            instrument_name
+        ]
+    return None