Migrate BeamlineParameters to use config server

src/dodal/beamlines/i03.py

@@ -95,7 +95,7 @@ def daq_configuration_path() -> str:
 
 @devices.factory()
 def aperture_scatterguard() -> ApertureScatterguard:
-    params = get_beamline_parameters()
+    params = get_beamline_parameters(BL)
     return ApertureScatterguard(
         aperture_prefix=f"{PREFIX.beamline_prefix}-MO-MAPT-01:",
         scatterguard_prefix=f"{PREFIX.beamline_prefix}-MO-SCAT-01:",
@@ -116,7 +116,7 @@ def attenuator() -> BinaryFilterAttenuator:
 def beamstop() -> Beamstop:
     return Beamstop(
         prefix=f"{PREFIX.beamline_prefix}-MO-BS-01:",
-        beamline_parameters=get_beamline_parameters(),
+        beamline_parameters=get_beamline_parameters(BL),
     )
 
 
@@ -346,7 +346,7 @@ def scintillator(aperture_scatterguard: ApertureScatterguard) -> Scintillator:
     return Scintillator(
         f"{PREFIX.beamline_prefix}-MO-SCIN-01:",
         Reference(aperture_scatterguard),
-        get_beamline_parameters(),
+        get_beamline_parameters(BL),
     )
 
 

src/dodal/beamlines/i04.py

@@ -99,7 +99,7 @@ def ipin() -> IPin:
 def beamstop() -> Beamstop:
     return Beamstop(
         f"{PREFIX.beamline_prefix}-MO-BS-01:",
-        beamline_parameters=get_beamline_parameters(),
+        beamline_parameters=get_beamline_parameters(BL),
     )
 
 
@@ -148,7 +148,7 @@ def backlight() -> Backlight:
 
 @devices.factory()
 def aperture_scatterguard() -> ApertureScatterguard:
-    params = get_beamline_parameters()
+    params = get_beamline_parameters(BL)
     return ApertureScatterguard(
         aperture_prefix=f"{PREFIX.beamline_prefix}-MO-MAPT-01:",
         scatterguard_prefix=f"{PREFIX.beamline_prefix}-MO-SCAT-01:",
@@ -281,7 +281,7 @@ def scintillator(aperture_scatterguard: ApertureScatterguard) -> Scintillator:
     return Scintillator(
         f"{PREFIX.beamline_prefix}-MO-SCIN-01:",
         Reference(aperture_scatterguard),
-        get_beamline_parameters(),
+        get_beamline_parameters(BL),
     )
 
 

src/dodal/common/beamlines/beamline_parameters.py

@@ -1,75 +1,26 @@
-import ast
-from typing import Any, cast
+from typing import Any
 
-from dodal.log import LOGGER
-from dodal.utils import get_beamline_name
-
-BEAMLINE_PARAMETER_KEYWORDS = ["FB", "FULL", "deadtime"]
+from dodal.common.beamlines.config_client import get_config_client
 
 BEAMLINE_PARAMETER_PATHS = {
     "i03": "/dls_sw/i03/software/daq_configuration/domain/beamlineParameters",
     "i04": "/dls_sw/i04/software/daq_configuration/domain/beamlineParameters",
 }
 
 
-class GDABeamlineParameters:
-    params: dict[str, Any]
-
-    def __init__(self, params: dict[str, Any]):
-        self.params = params
-
-    def __repr__(self) -> str:
-        return repr(self.params)
-
-    def __getitem__(self, item: str):
-        return self.params[item]
-
-    @classmethod
-    def from_lines(cls, file_name: str, config_lines: list[str]):
-        config_lines_nocomments = [line.split("#", 1)[0] for line in config_lines]
-        config_lines_sep_key_and_value = [
-            # XXX removes all whitespace instead of just trim
-            line.translate(str.maketrans("", "", " \n\t\r")).split("=")
-            for line in config_lines_nocomments
-        ]
-        config_pairs: list[tuple[str, Any]] = [
-            cast(tuple[str, Any], param)
-            for param in config_lines_sep_key_and_value
-            if len(param) == 2
-        ]
-        for i, (param, value) in enumerate(config_pairs):
-            try:
-                # BEAMLINE_PARAMETER_KEYWORDS effectively raw string but whitespace removed
-                if value not in BEAMLINE_PARAMETER_KEYWORDS:
-                    config_pairs[i] = (
-                        param,
-                        cls.parse_value(value),
-                    )
-            except Exception as e:
-                LOGGER.warning(f"Unable to parse {file_name} line {i}: {e}")
-
-        return cls(params=dict(config_pairs))
-
-    @classmethod
-    def from_file(cls, path: str):
-        with open(path) as f:
-            config_lines = f.readlines()
-        return cls.from_lines(path, config_lines)
-
-    @classmethod
-    def parse_value(cls, value: str):
-        return ast.literal_eval(value.replace("Yes", "True").replace("No", "False"))
+def get_beamline_parameters(beamline: str) -> dict[str, Any]:
+    """Loads the beamline parameters for a specified beamline from the config server.
 
+    Args:
+        beamline (str): The beamline for which beamline parameters will be retrieved.
 
-def get_beamline_parameters(beamline_param_path: str | None = None):
-    """Loads the beamline parameters from the specified path, or according to the
-    environment variable if none is given.
+    Returns:
+        dict[str, Any]: Dict of beamline parameters.
     """
-    if not beamline_param_path:
-        beamline_name = get_beamline_name("i03")
-        beamline_param_path = BEAMLINE_PARAMETER_PATHS.get(beamline_name)
-        if beamline_param_path is None:
-            raise KeyError(
-                "No beamline parameter path found, maybe 'BEAMLINE' environment variable is not set!"
-            )
-    return GDABeamlineParameters.from_file(beamline_param_path)
+    beamline_param_path = BEAMLINE_PARAMETER_PATHS.get(beamline)
+    if beamline_param_path is None:
+        raise KeyError(
+            "No beamline parameter path found, maybe 'BEAMLINE' environment variable is not set!"
+        )
+    config_client = get_config_client(beamline)
+    return config_client.get_file_contents(beamline_param_path, dict)

src/dodal/common/beamlines/config_client.py

@@ -0,0 +1,16 @@
+from functools import cache
+
+from daq_config_server.client import ConfigServer
+
+BEAMLINE_CONFIG_SERVER_ENDPOINTS = {
+    "i03": "https://i03-daq-config.diamond.ac.uk",
+    "i04": "https://daq-config.diamond.ac.uk",
+}
+
+
+@cache
+def get_config_client(beamline: str) -> ConfigServer:
+    url = BEAMLINE_CONFIG_SERVER_ENDPOINTS.get(
+        beamline, "https://daq-config.diamond.ac.uk"
+    )
+    return ConfigServer(url=url)

src/dodal/devices/aperturescatterguard.py

@@ -2,6 +2,7 @@
 
 import asyncio
 from math import inf
+from typing import Any
 
 from bluesky.protocols import Preparable
 from ophyd_async.core import (
@@ -14,7 +15,6 @@
 )
 from pydantic import BaseModel, Field
 
-from dodal.common.beamlines.beamline_parameters import GDABeamlineParameters
 from dodal.devices.aperture import Aperture
 from dodal.devices.motors import XYStage
 
@@ -65,7 +65,7 @@ def values(self) -> tuple[float, float, float, float, float]:
 
     @staticmethod
     def tolerances_from_gda_params(
-        params: GDABeamlineParameters,
+        params: dict[str, Any],
     ) -> AperturePosition:
         return AperturePosition(
             aperture_x=params["miniap_x_tolerance"],
@@ -79,7 +79,7 @@ def tolerances_from_gda_params(
     def from_gda_params(
         name: _GDAParamApertureValue,
         diameter: float,
-        params: GDABeamlineParameters,
+        params: dict[str, Any],
     ) -> AperturePosition:
         return AperturePosition(
             aperture_x=params[f"miniap_x_{name.value}"],
@@ -109,7 +109,7 @@ def __str__(self):
 
 
 def load_positions_from_beamline_parameters(
-    params: GDABeamlineParameters,
+    params: dict[str, Any],
 ) -> dict[ApertureValue, AperturePosition]:
     return {
         ApertureValue.OUT_OF_BEAM: AperturePosition.from_gda_params(

src/dodal/devices/beamlines/i03/undulator_dcm.py

@@ -7,6 +7,7 @@
 from dodal.devices.beamlines.i03.dcm import DCM
 from dodal.devices.undulator import UndulatorInKeV
 from dodal.log import LOGGER
+from dodal.utils import get_beamline_name
 
 ENERGY_TIMEOUT_S: float = 30.0
 
@@ -47,9 +48,9 @@ def __init__(
         )
         # I03 configures the DCM Perp as a side effect of applying this fixed value to the DCM Offset after an energy change
         # Nb this parameter is misleadingly named to confuse you
-        self.dcm_fixed_offset_mm = get_beamline_parameters(
-            daq_configuration_path + "/domain/beamlineParameters"
-        )["DCM_Perp_Offset_FIXED"]
+        self.dcm_fixed_offset_mm = get_beamline_parameters(get_beamline_name())[
+            "DCM_Perp_Offset_FIXED"
+        ]
 
         super().__init__(name)
 

src/dodal/devices/mx_phase1/beamstop.py

@@ -1,5 +1,6 @@
 import asyncio
 from math import isclose
+from typing import Any
 
 from ophyd_async.core import (
     StandardReadable,
@@ -8,8 +9,6 @@
 )
 from ophyd_async.epics.motor import Motor
 
-from dodal.common.beamlines.beamline_parameters import GDABeamlineParameters
-
 _BEAMSTOP_OUT_DELTA_Y_MM = -2
 
 
@@ -46,7 +45,7 @@ class Beamstop(StandardReadable):
     def __init__(
         self,
         prefix: str,
-        beamline_parameters: GDABeamlineParameters,
+        beamline_parameters: dict[str, Any],
         name: str = "",
     ):
         with self.add_children_as_readables():

src/dodal/devices/scintillator.py

@@ -1,9 +1,9 @@
 from math import isclose
+from typing import Any
 
 from ophyd_async.core import Reference, StandardReadable, StrictEnum, derived_signal_rw
 from ophyd_async.epics.motor import Motor
 
-from dodal.common.beamlines.beamline_parameters import GDABeamlineParameters
 from dodal.devices.aperturescatterguard import ApertureScatterguard, ApertureValue
 
 
@@ -29,7 +29,7 @@ def __init__(
         self,
         prefix: str,
         aperture_scatterguard: Reference[ApertureScatterguard],
-        beamline_parameters: GDABeamlineParameters,
+        beamline_parameters: dict[str, Any],
         name: str = "",
     ):
         with self.add_children_as_readables():

src/dodal/plan_stubs/check_topup.py

@@ -7,6 +7,7 @@
 )
 from dodal.devices.synchrotron import Synchrotron, SynchrotronMode
 from dodal.log import LOGGER
+from dodal.utils import get_beamline_name
 
 ALLOWED_MODES = [SynchrotronMode.USER, SynchrotronMode.SPECIAL]
 DECAY_MODE_COUNTDOWN = -1  # Value of the start_countdown PV when in decay mode
@@ -133,5 +134,5 @@ def check_topup_and_wait_if_necessary(
 
 
 def _load_topup_configuration_from_properties_file() -> dict[str, Any]:
-    params = get_beamline_parameters()
-    return params.params
+    params = get_beamline_parameters(get_beamline_name("i03"))
+    return params

src/dodal/testing/fixtures/config_server.py

@@ -0,0 +1,38 @@
+import json
+from pathlib import Path
+from typing import TypeVar
+from unittest.mock import patch
+
+import pytest
+from daq_config_server.models import ConfigModel
+
+T = TypeVar("T", str, dict, ConfigModel)
+
+
+def fake_config_server_get_file_contents(
+    filepath: str | Path,
+    desired_return_type: type[T] = str,
+    reset_cached_result: bool = True,
+) -> T:
+    filepath = Path(filepath)
+    # Minimal logic required for unit tests
+    with filepath.open("r") as f:
+        contents = f.read()
+    if desired_return_type is str:
+        return contents  # type: ignore
+    elif desired_return_type is dict:
+        return json.loads(contents)
+    elif issubclass(desired_return_type, ConfigModel):
+        return desired_return_type.model_validate(json.loads(contents))
+    raise ValueError("Invalid return type requested")
+
+
+@pytest.fixture(autouse=True)
+def mock_config_server():
+    # Don't actually talk to central service during unit tests, and reset caches between test
+
+    with patch(
+        "daq_config_server.client.ConfigServer.get_file_contents",
+        side_effect=fake_config_server_get_file_contents,
+    ):
+        yield

src/dodal/utils.py

@@ -66,8 +66,11 @@
 AnyDeviceFactory: TypeAlias = V1DeviceFactory | V2DeviceFactory
 
 
-def get_beamline_name(default: str) -> str:
-    return environ.get("BEAMLINE") or default
+def get_beamline_name(default: str | None = None) -> str:
+    beamline_name = environ.get("BEAMLINE") or default
+    if beamline_name is None:
+        raise ValueError("Set BEAMLINE environment variable or provide default.")
+    return beamline_name
 
 
 def is_test_mode() -> bool: