Used a common 'UpstreamFileRequestInfo' model for backend endpoints

Author: tieneupin

src/murfey/server/api/instrument.py

@@ -27,7 +27,7 @@
 from murfey.util.api import url_path_for
 from murfey.util.config import get_machine_config
 from murfey.util.db import RsyncInstance, Session, SessionProcessingParameters
-from murfey.util.models import File, MultigridWatcherSetup
+from murfey.util.models import File, MultigridWatcherSetup, UpstreamFileRequestInfo
 
 # Create APIRouter class object
 router = APIRouter(
@@ -396,11 +396,6 @@ async def request_upstream_tiff_data_download(
     return data
 
 
-class UpstreamFileRequestInfo(BaseModel):
-    upstream_instrument: str
-    upstream_visit_path: Path
-
-
 @router.post("/visits/{visit_name}/sessions/{session_id}/upstream_file_data_request")
 async def request_upstream_file_data_download(
     visit_name: str,

src/murfey/server/api/session_control.py

@@ -52,6 +52,7 @@
     GridSquareParameters,
     RsyncerInfo,
     SearchMapParameters,
+    UpstreamFileRequestInfo,
     Visit,
 )
 from murfey.workflows.spa.atlas import atlas_jpg_from_mrc
@@ -424,24 +425,19 @@ async def find_upstream_visits(session_id: MurfeySessionID, db=murfey_db):
     return _find_upstream_visits(session_id=session_id, db=db)
 
 
-class UpstreamFileGatheringInfo(BaseModel):
-    upstream_instrument: str
-    upstream_visit_path: Path
-
-
 @correlative_router.get(
     "/visits/{visit_name}/sessions/{session_id}/upstream_file_paths"
 )
 async def gather_upstream_files(
     visit_name: str,
     session_id: MurfeySessionID,
-    upstream_file_gathering: UpstreamFileGatheringInfo,
+    upstream_file_request: UpstreamFileRequestInfo,
     db=murfey_db,
 ):
     return _gather_upstream_files(
         session_id=session_id,
-        upstream_instrument=upstream_file_gathering.upstream_instrument,
-        upstream_visit_path=upstream_file_gathering.upstream_visit_path,
+        upstream_instrument=upstream_file_request.upstream_instrument,
+        upstream_visit_path=upstream_file_request.upstream_visit_path,
         db=db,
     )
 

src/murfey/server/api/session_info.py

@@ -49,7 +49,7 @@
     Tilt,
     TiltSeries,
 )
-from murfey.util.models import Visit
+from murfey.util.models import UpstreamFileRequestInfo, Visit
 
 logger = getLogger("murfey.server.api.session_info")
 
@@ -418,24 +418,19 @@ async def find_upstream_visits(session_id: MurfeySessionID, db=murfey_db):
     return _find_upstream_visits(session_id=session_id, db=db)
 
 
-class UpstreamFileGatheringInfo(BaseModel):
-    upstream_instrument: str
-    upstream_visit_path: Path
-
-
 @correlative_router.get(
     "/visits/{visit_name}/sessions/{session_id}/upstream_file_paths"
 )
 async def gather_upstream_files(
     visit_name: str,
     session_id: MurfeySessionID,
-    upstream_file_gathering: UpstreamFileGatheringInfo,
+    upstream_file_request: UpstreamFileRequestInfo,
     db=murfey_db,
 ):
     return _gather_upstream_files(
         session_id=session_id,
-        upstream_instrument=upstream_file_gathering.upstream_instrument,
-        upstream_visit_path=upstream_file_gathering.upstream_visit_path,
+        upstream_instrument=upstream_file_request.upstream_instrument,
+        upstream_visit_path=upstream_file_request.upstream_visit_path,
         db=db,
     )
 

src/murfey/util/models.py

@@ -84,6 +84,12 @@ class RsyncerSkippedFiles(BaseModel):
     increment_count: int = 1
 
 
+class UpstreamFileRequestInfo(BaseModel):
+    # Used in backend server for cross-instrument file download requests
+    upstream_instrument: str
+    upstream_visit_path: Path
+
+
 """
 Single Particle Analysis
 ========================