Include instruments in barcode

Author: gfrn

config.json

@@ -11,5 +11,13 @@
   },
   "db": { "pool": 3, "overflow": 6 },
   "ispyb_api": "http://127.0.0.1:8060/api",
-  "frontend_url": "http://localtest.diamond.ac.uk:9000"
+  "frontend_url": "http://localtest.diamond.ac.uk:9000",
+  "alerts": {
+    "contact_email": "pato@diamond.ac.uk",
+    "smtp_port": 8025,
+    "smtp_server": "mail.smtpbucket.com",
+    "local_contacts": {
+      "Mr Matt Spink": "bar@diamond.ac.uk"
+    }
+  }
 }

src/scaup/crud/top_level_containers.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from fastapi import HTTPException, status
 from lims_utils.logging import app_logger
 from lims_utils.models import Paged
@@ -125,7 +127,29 @@ def create_top_level_container(shipmentId: int | None, params: TopLevelContainer
     )
 
     if proposal:
-        bar_code = f"{proposal.reference}-{proposal.visitNumber}-{container.id:07}"
+        # This is required because the dewar logistics server expects an instrument in the barcode in order to match
+        # a dewar to the correct instrument
+        ext_resp = ExternalRequest.request(
+            token=token,
+            url=f"/proposals/{proposal.reference}/sessions/{proposal.visitNumber}",
+        )
+
+        if ext_resp.status_code != 200:
+            app_logger.warning(
+                "Error from Expeye while getting session %s-%i: %s",
+                proposal.reference,
+                proposal.visitNumber,
+                ext_resp.text,
+            )
+            raise HTTPException(
+                status_code=status.HTTP_424_FAILED_DEPENDENCY,
+                detail="Invalid response while creating top level container in ISPyB",
+            )
+
+        session_json: dict[str, Any] = ext_resp.json()
+        instrument = "-" if (i := session_json.get("beamLineName")) is None else f"-{i}-"
+
+        bar_code = f"{proposal.reference}-{proposal.visitNumber}{instrument}{container.id:07}"
 
         # This is because some users expect a sequential numeric ID to make tracking how old a dewar is easier,
         # and because of historical reasons, some users are used to seeing the proposal/session number on there

tests/shipments/top_level_containers/test_create.py

@@ -41,8 +41,8 @@ def test_create_no_name(client):
 
 
 @responses.activate
-def test_create_auto_barcode(client):
-    """Should automatically generate barcode if not provided in request"""
+def test_create_auto_barcode_no_instrument(client):
+    """Should automatically generate barcode if not provided in request, and instrument isn't returned from ISPyB"""
 
     resp = client.post(
         "/shipments/1/topLevelContainers",
@@ -60,6 +60,60 @@ def test_create_auto_barcode(client):
     )
 
 
+@pytest.mark.noregister
+@responses.activate
+def test_create_auto_barcode_with_instrument(client):
+    """Should automatically generate barcode if not provided in request"""
+    responses.get(
+        f"{Config.ispyb_api.url}/proposals/cm1/sessions/1",
+        status=200,
+        json={"beamLineName": "m02"},
+    )
+
+    responses.get(
+        f"{Config.ispyb_api.url}/proposals/cm1/dewar-registry/DLS-EM-0001",
+        status=200,
+        json={},
+    )
+
+    resp = client.post(
+        "/shipments/1/topLevelContainers",
+        json={
+            "type": "dewar",
+            "code": "DLS-EM-0001",
+        },
+    )
+
+    assert resp.status_code == 201
+    new_tlc = resp.json()["id"]
+    assert "cm1-1-m02-" in inner_db.session.scalar(
+        select(TopLevelContainer.barCode).filter(TopLevelContainer.id == new_tlc)
+    )
+
+
+@pytest.mark.noregister
+@responses.activate
+def test_create_auto_barcode_upstream_fail(client):
+    """Should raise exception if request fails upstream when generating barcode"""
+    responses.get(f"{Config.ispyb_api.url}/proposals/cm1/sessions/1", status=500)
+
+    responses.get(
+        f"{Config.ispyb_api.url}/proposals/cm1/dewar-registry/DLS-EM-0001",
+        status=200,
+        json={},
+    )
+
+    resp = client.post(
+        "/shipments/1/topLevelContainers",
+        json={
+            "type": "dewar",
+            "code": "DLS-EM-0001",
+        },
+    )
+
+    assert resp.status_code == 424
+
+
 @responses.activate
 def test_create_duplicate_name(client):
     """Should not allow creation if name is already present in shipment"""