Add session endpoint

Author: gfrn

src/scaup/main.py

@@ -8,15 +8,7 @@
 from sqlalchemy.orm import sessionmaker
 
 from . import __version__
-from .routes import (
-    containers,
-    internal,
-    proposals,
-    samples,
-    shipments,
-    top_level_containers,
-    sessions
-)
+from .routes import containers, internal, proposals, samples, sessions, shipments, top_level_containers
 from .utils.config import Config
 
 app = FastAPI(version=__version__, title="Scaup API")

src/scaup/models/sessions.py

@@ -41,4 +41,4 @@ class SessionOut(OrmBaseModel):
         lt=2,
         description="The data for the session is archived and no longer available on disk",  # noqa: E501
     )
-    collectionGroups: Optional[int] = None
+    collectionGroups: Optional[int] = None

src/scaup/routes/sessions.py

@@ -1,5 +1,3 @@
-from datetime import datetime
-
 from fastapi import APIRouter, Depends, HTTPException, Query
 from fastapi.security import HTTPAuthorizationCredentials
 from lims_utils.logging import app_logger
@@ -19,21 +17,24 @@
 def get_sessions(
     token: HTTPAuthorizationCredentials = Depends(auth_scheme),
     page: dict[str, int] = Depends(pagination),
-    minEndDate: datetime | None = Query("Minimum session end date")
+    minEndDate: str | None = Query(default=None, description="Minimum session end date"),
 ):
     """Get sessions a user can view (wrapper for Expeye endpoint)"""
+    # TODO: replace search once Expeye supports filtering by beamline name
+    url = f"/sessions?limit={page['limit']}&page={page['page']}&search=m"
+    if minEndDate is not None:
+        url += f"&minEndDate={minEndDate}"
+
     expeye_response = ExternalRequest.request(
-        token=token,
-        url=f"/sessions?minEndDate={minEndDate}&limit={page['limit']}&page={page['page']}",
+        token=token.credentials,
+        url=url,
     )
 
     if expeye_response.status_code != 200:
-        app_logger.warning(
-            f"Failed to fetch proposals from Expeye: {expeye_response.text}"
-        )
+        app_logger.warning(f"Failed to fetch proposals from Expeye: {expeye_response.text}")
         raise HTTPException(
             status_code=expeye_response.status_code,
             detail="Failed to fetch proposals",
         )
 
-    return expeye_response.json()
+    return expeye_response.json()

tests/sessions/__init__.py

@@ -0,0 +1,73 @@
+import responses
+
+from scaup.utils.config import Config
+
+
+@responses.activate
+def test_get(client):
+    """Should get sessions data"""
+    responses.get(
+        f"{Config.ispyb_api.url}/sessions",
+        status=200,
+        json={
+            "page": 1,
+            "total": 99,
+            "limit": 1,
+            "items": [
+                {
+                    "bltimeStamp": "2025-01-01T12:00:00Z",
+                    "visitNumber": 1,
+                    "parentProposal": "cm00001",
+                    "sessionId": 1,
+                    "purgedProcessedData": False,
+                    "proposalId": 1,
+                    "archived": False,
+                }
+            ],
+        },
+    )
+
+    resp = client.get("/sessions")
+
+    assert resp.status_code == 200
+
+    assert resp.json()["total"] == 99
+
+@responses.activate
+def test_min_end_date(client):
+    """Should include search params in expeye request"""
+    resp_get = responses.get(
+        f"{Config.ispyb_api.url}/sessions",
+        status=200,
+        json={
+            "page": 1,
+            "total": 99,
+            "limit": 1,
+            "items": [
+                {
+                    "bltimeStamp": "2025-01-01T12:00:00Z",
+                    "visitNumber": 1,
+                    "parentProposal": "cm00001",
+                    "sessionId": 1,
+                    "purgedProcessedData": False,
+                    "proposalId": 1,
+                    "archived": False,
+                }
+            ],
+        },
+    )
+
+    resp = client.get("/sessions?minEndDate=2025-01-01T00:00:00Z")
+
+    assert resp.status_code == 200
+    assert resp_get.calls[0].request.url.endswith(
+        "/sessions?limit=25&page=0&search=m&minEndDate=2025-01-01T00:00:00Z")
+
+@responses.activate
+def test_invalid_response(client):
+    """Should propagate error if upstream API fails"""
+    responses.get(f"{Config.ispyb_api.url}/sessions", status=404)
+
+    resp = client.get("/sessions")
+
+    assert resp.status_code == 404