fix: bugfix within scibec metadata handler to accomodate changes of metadata

bec_lib/bec_lib/messages.py

@@ -573,6 +573,7 @@ class FileContentMessage(BECMessage):
     Args:
         file_path (str): Path to the file.
         data (str): Content of the file.
+        scan_info (dict): Scan information.
         metadata (dict, optional): Status metadata. Defaults to None.
 
     """
@@ -580,6 +581,7 @@ class FileContentMessage(BECMessage):
     msg_type: ClassVar[str] = "file_content_message"
     file_path: str
     data: dict
+    scan_info: dict
 
 
 class VariableMessage(BECMessage):

bec_lib/tests/test_bec_messages.py

@@ -324,7 +324,9 @@ def test_wrong_DAPRequestMessage():
 
 
 def test_FileContentMessage():
-    msg = messages.FileContentMessage(file_path="/path/to/file", data={}, metadata={"RID": "1234"})
+    msg = messages.FileContentMessage(
+        file_path="/path/to/file", data={}, scan_info={}, metadata={"RID": "1234"}
+    )
     res = MsgpackSerialization.dumps(msg)
     res_loaded = MsgpackSerialization.loads(res)
     assert res_loaded == msg

bec_server/bec_server/file_writer/file_writer.py

@@ -265,7 +265,7 @@ class HDF5FileWriter:
         file_data = {}
         for key, val in device_storage.items():
             file_data[key] = val if not isinstance(val, list) else merge_dicts(val)
-        msg_data = {"file_path": file_path, "data": file_data}
+        msg_data = {"file_path": file_path, "data": file_data, "scan_info": info_storage}
         msg = messages.FileContentMessage(**msg_data)
         self.file_writer_manager.connector.set_and_publish(MessageEndpoints.file_content(), msg)
 

bec_server/bec_server/scihub/scibec/config_handler.py

@@ -68,7 +68,11 @@ class ConfigHandler:
         config = msg.content["config"]
         scibec = self.scibec_connector.scibec
         logger.debug(self.scibec_connector.scibec_info)
-        experiment = self.scibec_connector.scibec_info.get("beamline", {}).get("activeExperiment")
+        beamline = self.scibec_connector.scibec_info.get("beamline", {})
+        if beamline:
+            experiments = beamline.experiments
+        else:
+            experiments = None
 
         msg.metadata["updated_config"] = False
         for name, device in config.items():

bec_server/bec_server/scihub/scibec/scibec_metadata_handler.py

@@ -168,22 +168,23 @@ class SciBecMetadataHandler:
             return self.serialize_special_data(data.tolist())
         return json_ext.dumps(data)
 
-    def update_scan_data(self, file_path: str, data: dict):
+    def update_scan_data(self, file_path: str, data: dict, scan_info: dict):
         """
         Update the scan data in SciBec
 
         Args:
             file_path(str): The path to the original NeXuS file
             data(dict): The scan data
+            scan_info(dict): The scan information
         """
         scibec = self.scibec_connector.scibec
         if not scibec:
             return
-        scan_filter = py_scibec.bec.ScanFilterWhere(where={"scanId": data["metadata"]["scan_id"]})
+        scan_filter = py_scibec.bec.ScanFilterWhere(where={"scanId": scan_info["bec"]["scan_id"]})
         scan = scibec.scan.scan_controller_find(scan_filter)
         if not scan:
             logger.warning(
-                f"Could not find scan with scan_id {data['metadata']['scan_id']}. Cannot write scan"
+                f"Could not find scan with scan_id {scan_info['bec']['scan_id']}. Cannot write scan"
                 " data to SciBec."
             )
             return
@@ -211,7 +212,7 @@ class SciBecMetadataHandler:
             )
             scibec.scan_data.scan_data_controller_create_many(new_scan_data)
         logger.info(
-            f"Wrote scan data to SciBec for scan_id {data['metadata']['scan_id']} in {time.time() - start} seconds."
+            f"Wrote scan data to SciBec for scan_id {scan_info['bec']['scan_id']} in {time.time() - start} seconds."
         )
 
     def _write_scan_data_chunks(

bec_server/tests/tests_scihub/test_scibec_metadata_handler.py

@@ -79,7 +79,7 @@ def test_update_scan_status_patch(md_handler, active_experiment, scan_document):
 
 def test_handle_file_content(md_handler):
     # pylint: disable=protected-access
-    msg = messages.FileContentMessage(file_path="my_file.h5", data={"data": {}})
+    msg = messages.FileContentMessage(file_path="my_file.h5", data={"data": {}}, scan_info={})
     msg_raw = MessageObject(value=msg, topic="file_content")
     with mock.patch.object(md_handler, "update_scan_data") as mock_update_scan_data:
         md_handler._handle_file_content(msg_raw, parent=md_handler)
@@ -88,7 +88,7 @@ def test_handle_file_content(md_handler):
 
 def test_handle_file_content_ignores_errors(md_handler):
     # pylint: disable=protected-access
-    msg = messages.FileContentMessage(file_path="my_file.h5", data={"data": {}})
+    msg = messages.FileContentMessage(file_path="my_file.h5", data={"data": {}}, scan_info={})
     msg_raw = MessageObject(value=msg, topic="file_content")
     with mock.patch("bec_server.scihub.scibec.scibec_metadata_handler.logger") as mock_logger:
         with mock.patch.object(md_handler, "update_scan_data") as mock_update_scan_data:
@@ -103,7 +103,7 @@ def test_handle_file_content_ignores_errors(md_handler):
 def test_update_scan_data_return_without_scibec(md_handler):
     # pylint: disable=protected-access
     md_handler.scibec_connector.scibec = None
-    md_handler.update_scan_data(file_path="my_file.h5", data={"data": {}})
+    md_handler.update_scan_data(file_path="my_file.h5", data={"data": {}}, scan_info={})
 
 
 def test_update_scan_data_without_scan(md_handler):
@@ -112,7 +112,7 @@ def test_update_scan_data_without_scan(md_handler):
     md_handler.scibec_connector.scibec = scibec
     scibec.scan.scan_controller_find = mock.MagicMock(return_value=[])
     md_handler.update_scan_data(
-        file_path="my_file.h5", data={"data": {}, "metadata": {"scan_id": "scan_id"}}
+        file_path="my_file.h5", data={"data": {}}, scan_info={"bec": {"scan_id": "scan_id"}}
     )
 
 
@@ -122,7 +122,7 @@ def test_update_scan_data(md_handler, scan_document):
     md_handler.scibec_connector.scibec = scibec
     scibec.scan.scan_controller_find = mock.MagicMock(return_value=[scan_document])
     md_handler.update_scan_data(
-        file_path="my_file.h5", data={"data": {}, "metadata": {"scan_id": "scan_id"}}
+        file_path="my_file.h5", data={"data": {}}, scan_info={"bec": {"scan_id": "scan_id"}}
     )
     scibec.scan_data.scan_data_controller_create_many.assert_called_once_with(
         NewScanData(
@@ -132,7 +132,8 @@ def test_update_scan_data(md_handler, scan_document):
                 "owner": ["owner"],
                 "scanId": "dummy_id",
                 "filePath": "my_file.h5",
-                "data": {"data": {}, "metadata": {"scan_id": "scan_id"}},
+                "data": {"data": {}},
+                "scaninfo": {"bec": {"scan_id": "scan_id"}},
             }
         )
     )
@@ -145,8 +146,9 @@ def test_update_scan_data_exceeding_limit(md_handler, scan_document):
     md_handler.scibec_connector.scibec = scibec
     scibec.scan.scan_controller_find = mock.MagicMock(return_value=[scan_document])
     data_block = {f"key_{i}": {"signal": list(range(100))} for i in range(10)}
-    data_block.update({"metadata": {"scan_id": "scan_id"}})
-    md_handler.update_scan_data(file_path="my_file.h5", data=data_block)
+    md_handler.update_scan_data(
+        file_path="my_file.h5", data=data_block, scan_info={"bec": {"scan_id": "scan_id"}}
+    )
     num_calls = scibec.scan_data.scan_data_controller_create_many.call_count
     assert num_calls == 5