Fix device types and params

Author: olliesilvester

src/mx_bluesky/beamlines/i02_1/i02_1_gridscan_plan.py

@@ -7,15 +7,15 @@
 from dodal.beamlines.i02_1 import ZebraFastGridScanTwoD
 from dodal.common import inject
 from dodal.devices.attenuator.attenuator import ReadOnlyAttenuator
+from dodal.devices.beamlines.i02_1.flux import Flux
 from dodal.devices.common_dcm import DoubleCrystalMonochromatorBase
 from dodal.devices.fast_grid_scan import (
     set_fast_grid_scan_params as set_flyscan_params_plan,
 )
-from dodal.devices.flux import Flux
-from dodal.devices.s4_slit_gaps import S4SlitGaps
+from dodal.devices.slits import Slits
 from dodal.devices.undulator import BaseUndulator
 from dodal.devices.zebra.zebra import Zebra
-from pydantic import BaseModel, PrivateAttr
+from pydantic import BaseModel
 from pydantic_extra_types.semantic_version import SemanticVersion
 from semver import Version
 
@@ -45,6 +45,10 @@
 from mx_bluesky.common.external_interaction.callbacks.grid.utils import (
     generate_start_info_from_num_grids,
 )
+from mx_bluesky.common.parameters.components import (
+    IspybExperimentType,
+    get_param_version,
+)
 from mx_bluesky.common.parameters.constants import (
     EnvironmentConstants,
     PlanNameConstants,
@@ -82,7 +86,7 @@ class FlyScanXRayCentreComposite(FlyScanEssentialDevices[GonioWithOmegaType]):
     attenuator: ReadOnlyAttenuator
     flux: Flux
     undulator: BaseUndulator
-    s4_slit_gaps: S4SlitGaps
+    s4_slit_gaps: Slits
 
 
 def construct_i02_1_specific_features(
@@ -139,35 +143,65 @@ def get_internal_param_version() -> SemanticVersion:
 
 
 class ExternalGridScanParams(BaseModel):
-    gda_parameter_version: SemanticVersion
     visit: str
     file_name: str
-    storage_directory: Path
+    storage_directory: str
     exposure_time_s: float
     snapshot_directory: Path
     x_start_um: float
     y_start_um: float
     z_start_um: float
     x_steps: int
     y_steps: int
-    sample_id: int | None = None
-
-    # Internal parameter version compatible with this external model
-    _internal_param_version: str = PrivateAttr(default="6.0.0")
+    beam_size_x: float
+    beam_size_y: float
+    microns_per_pixel_x: float
+    microns_per_pixel_y: float
+    upper_left_x: int
+    upper_left_y: int
+    detector_distance_mm: float
+    sample_id: int
+
+
+def get_internal_params(params: ExternalGridScanParams) -> I02_1FgsParams:
+    return I02_1FgsParams(
+        y_starts_um=[params.y_start_um],
+        x_start_um=params.x_start_um,
+        z_starts_um=[params.z_start_um],
+        omega_starts_deg=[0],
+        sample_id=params.sample_id,
+        visit=params.visit,
+        parameter_model_version=get_param_version(),
+        file_name=params.file_name,
+        storage_directory=params.storage_directory,
+        x_steps=params.x_steps,
+        y_steps=[params.y_steps],
+        path_to_xtal_snapshot=params.snapshot_directory,
+        beam_size_x=params.beam_size_x,
+        beam_size_y=params.beam_size_y,
+        microns_per_pixel_x=params.microns_per_pixel_x,
+        microns_per_pixel_y=params.microns_per_pixel_y,
+        upper_left_x=params.upper_left_x,
+        upper_left_y=params.upper_left_y,
+        detector_distance_mm=params.detector_distance_mm,
+        ispyb_experiment_type=IspybExperimentType.GRIDSCAN_2D,
+    )
 
 
 def i02_1_gridscan_plan(
-    parameters: I02_1FgsParams,
+    parameters: ExternalGridScanParams,
     composite: FlyScanXRayCentreComposite = inject(""),
 ) -> MsgGenerator:
     """BlueAPI entry point for i02-1 grid scans"""
 
-    beamline_specific = construct_i02_1_specific_features(composite, parameters)
-    callbacks = create_gridscan_callbacks(parameters)
+    params = get_internal_params(parameters)
+
+    beamline_specific = construct_i02_1_specific_features(composite, params)
+    callbacks = create_gridscan_callbacks(params)
 
     @bpp.subs_decorator(callbacks)
-    @ispyb_activation_decorator(parameters)
+    @ispyb_activation_decorator(params)
     def decorated_flyscan_plan():
-        yield from common_flyscan_xray_centre(composite, parameters, beamline_specific)
+        yield from common_flyscan_xray_centre(composite, params, beamline_specific)
 
     yield from decorated_flyscan_plan()

tests/unit_tests/beamlines/i02_1/test_i02_1_gridscan_plan.py

@@ -5,17 +5,18 @@
 from dodal.beamlines import i02_1
 from dodal.beamlines.i02_1 import ZebraFastGridScanTwoD
 from dodal.devices.attenuator.attenuator import ReadOnlyAttenuator
+from dodal.devices.beamlines.i02_1.flux import Flux
 from dodal.devices.common_dcm import DoubleCrystalMonochromatorBase
 from dodal.devices.eiger import EigerDetector
-from dodal.devices.flux import Flux
-from dodal.devices.s4_slit_gaps import S4SlitGaps
+from dodal.devices.slits import Slits
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.undulator import BaseUndulator
 from dodal.devices.zebra.zebra import Zebra
 from pydantic import ValidationError
 
 from mx_bluesky.beamlines.i02_1.composites import I02_1FgsParams
 from mx_bluesky.beamlines.i02_1.i02_1_gridscan_plan import (
+    ExternalGridScanParams,
     FlyScanXRayCentreComposite,
     construct_i02_1_specific_features,
     i02_1_gridscan_plan,
@@ -42,6 +43,44 @@ def zebra_fgs_two_d() -> ZebraFastGridScanTwoD:
     return device
 
 
+@pytest.fixture
+def entry_params(tmp_path) -> ExternalGridScanParams:
+    return ExternalGridScanParams(
+        visit="visit",
+        file_name="file_name",
+        storage_directory=str(tmp_path),
+        exposure_time_s=0.004,
+        snapshot_directory=tmp_path,
+        x_start_um=0,
+        y_start_um=0,
+        z_start_um=0,
+        x_steps=5,
+        y_steps=5,
+        beam_size_x=5,
+        beam_size_y=5,
+        microns_per_pixel_x=1,
+        microns_per_pixel_y=1,
+        upper_left_x=1,
+        upper_left_y=2,
+        detector_distance_mm=100,
+        sample_id=1,
+    )
+
+
+@pytest.fixture
+def slits() -> Slits:
+    device = i02_1.s4_slit_gaps.build(connect_immediately=True, mock=True)
+
+    return device
+
+
+@pytest.fixture
+def flux() -> Flux:
+    device = i02_1.flux.build(connect_immediately=True, mock=True)
+
+    return device
+
+
 @pytest.fixture
 def fgs_composite(
     eiger: EigerDetector,
@@ -52,7 +91,7 @@ def fgs_composite(
     attenuator: ReadOnlyAttenuator,
     flux: Flux,
     undulator: BaseUndulator,
-    s4_slit_gaps: S4SlitGaps,
+    slits: Slits,
     zebra: Zebra,
 ) -> FlyScanXRayCentreComposite:
     return FlyScanXRayCentreComposite(
@@ -65,7 +104,7 @@ def fgs_composite(
         attenuator,
         flux,
         undulator,
-        s4_slit_gaps,
+        slits,
     )
 
 
@@ -132,36 +171,43 @@ def test_i02_1_flyscan_xray_centre_in_re(
     run_engine: RunEngine,
     fgs_params_two_d: I02_1FgsParams,
     fgs_composite: FlyScanXRayCentreComposite,
+    entry_params: ExternalGridScanParams,
 ):
     expected_features = construct_i02_1_specific_features(
         fgs_composite, fgs_params_two_d
     )
 
     mock_create_features.return_value = expected_features
-    run_engine(i02_1_gridscan_plan(fgs_params_two_d, fgs_composite))
+    run_engine(i02_1_gridscan_plan(entry_params, fgs_composite))
     mock_common_scan.assert_called_once_with(
         fgs_composite, fgs_params_two_d, expected_features
     )
 
 
-@patch(
-    "mx_bluesky.beamlines.i02_1.i02_1_gridscan_plan.construct_i02_1_specific_features",
-)
 @patch(
     "mx_bluesky.beamlines.i02_1.i02_1_gridscan_plan.common_flyscan_xray_centre",
     new=MagicMock(),
 )
+@patch(
+    "mx_bluesky.beamlines.i02_1.i02_1_gridscan_plan.get_internal_params",
+)
+@patch(
+    "mx_bluesky.beamlines.i02_1.i02_1_gridscan_plan.construct_i02_1_specific_features",
+)
 @patch(
     "mx_bluesky.common.external_interaction.callbacks.grid.gridscan.ispyb_callback.StoreInIspyb"
 )
 def test_ispyb_activated_correct_params(
     mock_store_ispyb: MagicMock,
     mock_create_features: MagicMock,
+    mock_get_internal_params: MagicMock,
     run_engine: RunEngine,
     fgs_params_two_d: I02_1FgsParams,
     fgs_composite: FlyScanXRayCentreComposite,
+    entry_params: ExternalGridScanParams,
 ):
     mock_ispyb = MagicMock()
+    mock_get_internal_params.return_value = fgs_params_two_d
 
     mock_store_ispyb.return_value = mock_ispyb
     expected_features = construct_i02_1_specific_features(
@@ -171,7 +217,7 @@ def test_ispyb_activated_correct_params(
 
     mock_create_features.return_value = expected_features
 
-    run_engine(i02_1_gridscan_plan(fgs_params_two_d, fgs_composite))
+    run_engine(i02_1_gridscan_plan(entry_params, fgs_composite))
     initial_group_info = populate_data_collection_group(fgs_params_two_d)
     initial_group_info.comments = f"Diffraction grid scan of {fgs_params_two_d.x_steps} by {fgs_params_two_d.y_steps[0]}.Zocalo processing took 0.00 s."
     initial_scan_info = ScanDataInfo(