Renamed and updated multigrid controller checking endpoints; they now return a dictionary with useful properties regarding the status of the multigrid controller

Author: tieneupin

src/murfey/instrument_server/api.py

@@ -222,11 +222,15 @@ def stop_multigrid_watcher(session_id: MurfeySessionID, label: str):
 
 
 @router.get("/sessions/{session_id}/multigrid_controller/status")
-def check_multigrid_controller_exists(
+def check_multigrid_controller_status(
     session_id: MurfeySessionID,
 ):
     if controllers.get(session_id, None) is not None:
-        return {"exists": True}
+        return {
+            "dormant": controllers[session_id].dormant,
+            "exists": True,
+            "finalising": controllers[session_id].finalising,
+        }
     return {"exists": False}
 
 

src/murfey/server/api/instrument.py

@@ -102,7 +102,7 @@ async def check_if_session_is_active(
 
 
 @router.get("/sessions/{session_id}/multigrid_controller/status")
-async def check_multigrid_controller_exists(session_id: MurfeySessionID, db=murfey_db):
+async def check_multigrid_controller_status(session_id: MurfeySessionID, db=murfey_db):
     session = db.exec(select(Session).where(Session.id == session_id)).one()
     instrument_name = session.instrument_name
     machine_config = get_machine_config(instrument_name=instrument_name)[
@@ -114,7 +114,7 @@ async def check_multigrid_controller_exists(session_id: MurfeySessionID, db=murf
         )
         async with aiohttp.ClientSession() as clientsession:
             async with clientsession.get(
-                f"{machine_config.instrument_server_url}{url_path_for('api.router', 'check_multigrid_controller_exists', session_id=session_id)}",
+                f"{machine_config.instrument_server_url}{url_path_for('api.router', 'check_multigrid_controller_status', session_id=session_id)}",
                 headers={
                     "Authorization": f"Bearer {instrument_server_tokens[session_id]['access_token']}"
                 },

src/murfey/util/route_manifest.yaml

@@ -38,16 +38,16 @@ murfey.instrument_server.api.router:
         type: str
     methods:
       - DELETE
+  - path: /sessions/{session_id}/multigrid_controller/status
+    function: check_multigrid_controller_status
+    path_params: []
+    methods:
+      - GET
   - path: /sessions/{session_id}/multigrid_controller/visit_end_time
     function: update_multigrid_controller_visit_end_time
     path_params: []
     methods:
       - POST
-  - path: /sessions/{session_id}/multigrid_controller/status
-    function: check_multigrid_controller_exists
-    path_params: []
-    methods:
-      - GET
   - path: /sessions/{session_id}/stop_rsyncer
     function: stop_rsyncer
     path_params: []
@@ -498,6 +498,11 @@ murfey.server.api.instrument.router:
         type: int
     methods:
       - GET
+  - path: /instrument_server/sessions/{session_id}/multigrid_controller/status
+    function: check_multigrid_controller_status
+    path_params: []
+    methods:
+      - GET
   - path: /instrument_server/sessions/{session_id}/multigrid_watcher
     function: setup_multigrid_watcher
     path_params: []
@@ -508,11 +513,11 @@ murfey.server.api.instrument.router:
     path_params: []
     methods:
       - POST
-  - path: /instrument_server/sessions/{session_id}/multigrid_controller/status
-    function: check_multigrid_controller_exists
+  - path: /instrument_server/sessions/{session_id}/multigrid_controller/visit_end_time
+    function: update_visit_end_time
     path_params: []
     methods:
-      - GET
+      - POST
   - path: /instrument_server/sessions/{session_id}/provided_processing_parameters
     function: pass_proc_params_to_instrument_server
     path_params: []
@@ -559,11 +564,6 @@ murfey.server.api.instrument.router:
     path_params: []
     methods:
       - POST
-  - path: /instrument_server/sessions/{session_id}/multigrid_controller/visit_end_time
-    function: update_visit_end_time
-    path_params: []
-    methods:
-      - POST
   - path: /instrument_server/sessions/{session_id}/abandon_session
     function: abandon_session
     path_params: []