The last big push to switch to using routers to determine URLs

Author: d-j-hatton

src/murfey/client/tui/screens.py

@@ -56,6 +56,14 @@
 )
 from murfey.client.rsync import RSyncer
 from murfey.client.tui.forms import FormDependency
+from murfey.server.api.file_manip import router as file_manip_router
+from murfey.server.api.prometheus import router as prom_router
+from murfey.server.api.session_control import (
+    correlative_router as session_correlative_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.server.api.workflow import tomo_router as workflow_tomo_router
 from murfey.util import posix_path
 from murfey.util.client import capture_post, get_machine_config_client, read_config
 from murfey.util.models import ProcessingParametersSPA, ProcessingParametersTomo
@@ -84,7 +92,7 @@ def determine_default_destination(
     use_suggested_path: bool = True,
 ) -> str:
     machine_data = requests.get(
-        f"{environment.url.geturl()}/instruments/{environment.instrument_name}/machine"
+        f"{environment.url.geturl()}{session_router.url_path_for('machine_info_by_instrument', instrument_name=environment.instrument_name)}"
     ).json()
     _default = ""
     if environment.processing_only_mode and environment.sources:
@@ -109,7 +117,7 @@ def determine_default_destination(
                                 _default = environment.destination_registry[source_name]
                             else:
                                 suggested_path_response = capture_post(
-                                    url=f"{str(environment.url.geturl())}/visits/{visit}/{environment.murfey_session}/suggested_path",
+                                    url=f"{str(environment.url.geturl())}{file_manip_router.url_path_for('suggest_path', visit_name=visit, sesion_id=environment.murfey_session)}",
                                     json={
                                         "base_path": f"{destination}/{visit}/{mid_path.parent if include_mid_path else ''}/raw",
                                         "touch": touch,
@@ -265,7 +273,7 @@ def __init__(
     def compose(self):
 
         machine_data = requests.get(
-            f"{self.app._environment.url.geturl()}/instruments/{instrument_name}/machine"
+            f"{self.app._environment.url.geturl()}{session_router.url_path_for('machine_info_by_instrument', instrument_name=instrument_name)}"
         ).json()
         self._dir_tree = _DirectoryTree(
             str(self._selected_dir),
@@ -476,16 +484,16 @@ def _write_params(
             self.app._start_dc(params)
             if model == ProcessingParametersTomo:
                 requests.post(
-                    f"{self.app._environment.url.geturl()}/sessions/{self.app._environment.murfey_session}/tomography_processing_parameters",
+                    f"{self.app._environment.url.geturl()}/{workflow_tomo_router.url_path_for('register_tomo_proc_params', session_id=self.app._environment.murfey_session)}",
                     json=params,
                 )
             elif model == ProcessingParametersSPA:
                 requests.post(
-                    f"{self.app._environment.url.geturl()}/sessions/{self.app._environment.murfey_session}/spa_processing_parameters",
+                    f"{self.app._environment.url.geturl()}{workflow_spa_router.url_path_for('register_spa_proc_params', session_id=self.app._environment.murfey_session)}",
                     json=params,
                 )
                 requests.post(
-                    f"{self.app._environment.url.geturl()}/visits/{self.app._environment.visit}/{self.app._environment.murfey_session}/flush_spa_processing"
+                    f"{self.app._environment.url.geturl()}{workflow_spa_router.url_path_for('flush_spa_processing', visit_name=self.app._environment.visit, session_id=self.app._environment.murfey_session)}",
                 )
 
     def on_switch_changed(self, event):
@@ -645,14 +653,16 @@ def on_button_pressed(self, event: Button.Pressed):
             self.app.pop_screen()
         session_name = "Client connection"
         self.app._environment.murfey_session = requests.post(
-            f"{self.app._environment.url.geturl()}/instruments/{self.app._environment.instrument_name}/clients/{self.app._environment.client_id}/session",
+            f"{self.app._environment.url.geturl()}{session_router.url_path_for('link_client_to_session', instrument_name=self.app._environment.instrument_name, client_id=self.app._environment.client_id)}",
             json={"session_id": session_id, "session_name": session_name},
         ).json()
 
     def _remove_session(self, session_id: int, **kwargs):
-        requests.delete(f"{self.app._environment.url.geturl()}/sessions/{session_id}")
+        requests.delete(
+            f"{self.app._environment.url.geturl()}{session_router.url_path_for('remove_session', session_id=session_id)}"
+        )
         exisiting_sessions = requests.get(
-            f"{self.app._environment.url.geturl()}/sessions"
+            f"{self.app._environment.url.geturl()}{session_router.url_path_for('get_sessions')}"
         ).json()
         self.app.uninstall_screen("session-select-screen")
         if exisiting_sessions:
@@ -674,7 +684,7 @@ def _remove_session(self, session_id: int, **kwargs):
         else:
             session_name = "Client connection"
             resp = capture_post(
-                f"{self.app._environment.url.geturl()}/instruments/{self._environment.instrument_name}/clients/{self.app._environment.client_id}/session",
+                f"{self.app._environment.url.geturl()}{session_router.url_path_for('link_client_to_session', instrument_name=self.app._environment.instrument_name, client_id=self.app._environment.client_id)}",
                 json={"session_id": None, "session_name": session_name},
             )
             if resp:
@@ -735,7 +745,7 @@ def on_button_pressed(self, event: Button.Pressed):
 
         if machine_data.get("upstream_data_directories"):
             upstream_downloads = requests.get(
-                f"{self.app._environment.url.geturl()}/sessions/{self.app._environment.murfey_session}/upstream_visits"
+                f"{self.app._environment.url.geturl()}{session_correlative_router.url_path_for('find_upstream_visits', session_id=self.app._environment.murfey_session)}"
             ).json()
             self.app.install_screen(
                 UpstreamDownloads(upstream_downloads), "upstream-downloads"
@@ -768,7 +778,7 @@ def on_button_pressed(self, event: Button.Pressed):
         )
         log.info(f"Posted visit registration: {response.status_code}")
         machine_data = requests.get(
-            f"{self.app._environment.url.geturl()}/instruments/{instrument_name}/machine"
+            f"{self.app._environment.url.geturl()}{session_router.url_path_for('machine_info_by_instrument', instrument_name=instrument_name)}"
         ).json()
 
         self.app.install_screen(
@@ -797,7 +807,7 @@ def on_button_pressed(self, event: Button.Pressed):
 
         if machine_data.get("upstream_data_directories"):
             upstream_downloads = requests.get(
-                f"{self.app._environment.url.geturl()}/sessions/{self.app._environment.murfey_session}/upstream_visits"
+                f"{self.app._environment.url.geturl()}{session_correlative_router.url_path_for('find_upstream_visits', session_id=self.app._environment.murfey_session)}"
             ).json()
             self.app.install_screen(
                 UpstreamDownloads(upstream_downloads), "upstream-downloads"
@@ -819,7 +829,7 @@ def compose(self):
 
     def on_button_pressed(self, event: Button.Pressed):
         machine_data = requests.get(
-            f"{self.app._environment.url.geturl()}/instruments/{instrument_name}/machine"
+            f"{self.app._environment.url.geturl()}{session_router.url_path_for('machine_info_by_instrument', instrument_name=instrument_name)}"
         ).json()
         if machine_data.get("upstream_data_download_directory"):
             # Create the directory locally to save files to
@@ -830,7 +840,7 @@ def on_button_pressed(self, event: Button.Pressed):
 
             # Get the paths to the TIFF files generated previously under the same session ID
             upstream_tiff_paths_response = requests.get(
-                f"{self.app._environment.url.geturl()}/visits/{event.button.label}/{self.app._environment.murfey_session}/upstream_tiff_paths"
+                f"{self.app._environment.url.geturl()}{session_correlative_router.url_path_for('gather_upstream_tiffs', visit_name=event.button.label, session_id=self.app._environment.murfey_session)}"
             )
             upstream_tiff_paths = upstream_tiff_paths_response.json() or []
 
@@ -839,7 +849,7 @@ def on_button_pressed(self, event: Button.Pressed):
                 (download_dir / tp).parent.mkdir(exist_ok=True, parents=True)
                 # Write TIFF to the specified file path
                 stream_response = requests.get(
-                    f"{self.app._environment.url.geturl()}/visits/{event.button.label}/{self.app._environment.murfey_session}/upstream_tiff/{tp}",
+                    f"{self.app._environment.url.geturl()}{session_correlative_router.url_path_for('get_tiff', visit_name=event.button.label, session_id=self.app._environment.murfey_session, tiff_path=tp)}",
                     stream=True,
                 )
                 # Write the file chunk-by-chunk to avoid hogging memory
@@ -903,7 +913,7 @@ def on_button_pressed(self, event):
                         f"Gain reference file {posix_path(self._dir_tree._gain_reference)!r} was not successfully transferred to {visit_path}/processing"
                     )
             process_gain_response = requests.post(
-                url=f"{str(self.app._environment.url.geturl())}/sessions/{self.app._environment.murfey_session}/process_gain",
+                url=f"{str(self.app._environment.url.geturl())}{file_manip_router.url_path_for('process_gain', session_id=self.app._environment.murfey_session)}",
                 json={
                     "gain_ref": str(self._dir_tree._gain_reference),
                     "eer": bool(
@@ -1231,10 +1241,10 @@ def file_copied(self, *args, **kwargs):
         self.query_one(ProgressBar).advance(1)
         if self.query_one(ProgressBar).progress == self.query_one(ProgressBar).total:
             requests.post(
-                f"{self.app._environment.url.geturl()}/sessions/{self.app._environment.murfey_session}/successful_processing"
+                f"{self.app._environment.url.geturl()}{session_router.url_path_for('register_processing_success_in_ispyb', session_id=self.app._environment.murfey_session)}"
             )
             requests.delete(
-                f"{self.app._environment.url.geturl()}/instruments/{self._environment.instrument_name}/clients/{self.app._environment.client_id}/session"
+                f"{self.app._environment.url.geturl()}{session_router.url_path_for('remove_session', session_id=self.app._environment.murfey_session)}"
             )
             self.app.exit()
 
@@ -1266,5 +1276,5 @@ def compose(self):
 
     def on_mount(self, event):
         requests.post(
-            f"{self.app._environment.url.geturl()}/visits/{self.app._environment.visit}/monitoring/1"
+            f"{self.app._environment.url.geturl()}{prom_router.url_path_for('change_monitoring_status', visit_name=self.app._environment.visit, on=1)}"
         )

src/murfey/server/api/__init__.py

@@ -1,87 +1,19 @@
 from __future__ import annotations
 
 import logging
-from pathlib import Path
-from typing import List, Optional
+from typing import Optional
 
 from fastapi import APIRouter, Depends
 from prometheus_client import Counter, Gauge
-from sqlmodel import select
 
 import murfey.server.prometheus as prom
-from murfey.server import sanitise
 from murfey.server.api.auth import validate_token
-from murfey.server.murfey_db import murfey_db
-from murfey.util.db import (
-    ClientEnvironment,
-    MagnificationLookup,
-    RsyncInstance,
-    Session,
-)
-from murfey.util.models import ClientInfo
 
 log = logging.getLogger("murfey.server.api")
 
 router = APIRouter(dependencies=[Depends(validate_token)])
 
 
-@router.get("/mag_table/")
-def get_mag_table(db=murfey_db) -> List[MagnificationLookup]:
-    return db.exec(select(MagnificationLookup)).all()
-
-
-@router.post("/mag_table/")
-def add_to_mag_table(rows: List[MagnificationLookup], db=murfey_db):
-    for r in rows:
-        db.add(r)
-    db.commit()
-
-
-@router.delete("/mag_table/{mag}")
-def remove_mag_table_row(mag: int, db=murfey_db):
-    row = db.exec(
-        select(MagnificationLookup).where(MagnificationLookup.magnification == mag)
-    ).one()
-    db.delete(row)
-    db.commit()
-
-
-@router.post("/visits/{visit_name}")
-def register_client_to_visit(visit_name: str, client_info: ClientInfo, db=murfey_db):
-    client_env = db.exec(
-        select(ClientEnvironment).where(ClientEnvironment.client_id == client_info.id)
-    ).one()
-    session = db.exec(select(Session).where(Session.id == client_env.session_id)).one()
-    if client_env:
-        client_env.visit = visit_name
-        db.add(client_env)
-        db.commit()
-    if session:
-        session.visit = visit_name
-        db.add(session)
-        db.commit()
-    db.close()
-    return client_info
-
-
-@router.delete("/sessions/{session_id}/rsyncer")
-def delete_rsyncer(session_id: int, source: Path, db=murfey_db):
-    try:
-        rsync_instance = db.exec(
-            select(RsyncInstance)
-            .where(RsyncInstance.session_id == session_id)
-            .where(RsyncInstance.source == str(source))
-        ).one()
-        db.delete(rsync_instance)
-        db.commit()
-    except Exception:
-        log.error(
-            f"Failed to delete rsyncer for source directory {sanitise(str(source))!r} "
-            f"in session {session_id}.",
-            exc_info=True,
-        )
-
-
 @router.get("/prometheus/{metric_name}")
 def inspect_prometheus_metrics(
     metric_name: str,

src/murfey/server/api/mag_table.py

@@ -0,0 +1,35 @@
+from typing import List
+
+from fastapi import APIRouter, Depends
+from sqlmodel import select
+
+from murfey.server.api.auth import validate_token
+from murfey.server.murfey_db import murfey_db
+from murfey.util.db import MagnificationLookup
+
+router = APIRouter(
+    prefix="/mag_table",
+    dependencies=[Depends(validate_token)],
+    tags=["magnification table"],
+)
+
+
+@router.get("/mag_table/")
+def get_mag_table(db=murfey_db) -> List[MagnificationLookup]:
+    return db.exec(select(MagnificationLookup)).all()
+
+
+@router.post("/mag_table/")
+def add_to_mag_table(rows: List[MagnificationLookup], db=murfey_db):
+    for r in rows:
+        db.add(r)
+    db.commit()
+
+
+@router.delete("/mag_table/{mag}")
+def remove_mag_table_row(mag: int, db=murfey_db):
+    row = db.exec(
+        select(MagnificationLookup).where(MagnificationLookup.magnification == mag)
+    ).one()
+    db.delete(row)
+    db.commit()