Use config server for undulator config (#1768)

* Use server deployed on i03 beamline cluster for i03 config

* Reset cache between tests

* Fix lint

* Use config server in undulator device

* Use specific lut models for each undulator lut

* Use config server deployed on i04 cluster

* Improve patching of BEAMLINE env variable in tests

* Pass config client into undulator

* Push interaction with config client into devices where possible

* Read config at device instantiation

Author: jacob720

src/dodal/beamlines/i03.py

@@ -1,13 +1,14 @@
 from functools import cache
 
+from daq_config_server import ConfigClient
 from ophyd_async.core import PathProvider, Reference
 from ophyd_async.fastcs.eiger import EigerDetector as FastEiger
 from ophyd_async.fastcs.panda import HDFPanda
 from yarl import URL
 
 from dodal.common.beamlines.beamline_parameters import get_beamline_parameters
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.common.beamlines.beamline_utils import set_path_provider
+from dodal.common.beamlines.beamline_utils import set_config_client, set_path_provider
 from dodal.common.beamlines.commissioning_mode import set_commissioning_signal
 from dodal.common.udc_directory_provider import PandASubpathProvider
 from dodal.device_manager import DeviceManager
@@ -69,6 +70,7 @@
 )
 DISPLAY_CONFIG = "/dls_sw/i03/software/gda_versions/var/display.configuration"
 DAQ_CONFIGURATION_PATH = "/dls_sw/i03/software/daq_configuration"
+I03_CONFIG_SERVER_ENDPOINT = "https://i03-daq-config.diamond.ac.uk"
 
 BL = get_beamline_name("i03")
 set_log_beamline(BL)
@@ -92,6 +94,14 @@ def path_provider() -> PathProvider:
     return provider
 
 
+@devices.fixture
+@cache
+def config_client() -> ConfigClient:
+    client = ConfigClient(I03_CONFIG_SERVER_ENDPOINT)
+    set_config_client(client)
+    return client
+
+
 @devices.fixture
 def daq_configuration_path() -> str:
     return DAQ_CONFIGURATION_PATH
@@ -141,10 +151,11 @@ def vfm() -> FocusingMirrorWithStripes:
 
 
 @devices.factory()
-def mirror_voltages() -> MirrorVoltages:
+def mirror_voltages(config_client: ConfigClient) -> MirrorVoltages:
     return MirrorVoltages(
         prefix=f"{PREFIX.beamline_prefix}-MO-PSU-01:",
         daq_configuration_path=DAQ_CONFIGURATION_PATH,
+        config_client=config_client,
     )
 
 
@@ -223,22 +234,29 @@ def synchrotron() -> Synchrotron:
 
 
 @devices.factory()
-def undulator(baton: Baton, daq_configuration_path: str) -> UndulatorInKeV:
+def undulator(
+    baton: Baton, daq_configuration_path: str, config_client: ConfigClient
+) -> UndulatorInKeV:
     return UndulatorInKeV(
         f"{BeamlinePrefix(BL).insertion_prefix}-MO-SERVC-01:",
+        config_client=config_client,
         id_gap_lookup_table_path=f"{daq_configuration_path}/lookup/BeamLine_Undulator_toGap.txt",
         baton=baton,
     )
 
 
 @devices.factory()
 def undulator_dcm(
-    undulator: UndulatorInKeV, dcm: DCM, daq_configuration_path: str
+    undulator: UndulatorInKeV,
+    dcm: DCM,
+    daq_configuration_path: str,
+    config_client: ConfigClient,
 ) -> UndulatorDCM:
     return UndulatorDCM(
         undulator=undulator,
         dcm=dcm,
         daq_configuration_path=daq_configuration_path,
+        config_client=config_client,
     )
 
 

src/dodal/beamlines/i04.py

@@ -1,7 +1,11 @@
+from functools import cache
+
+from daq_config_server import ConfigClient
 from ophyd_async.core import Reference
 
 from dodal.common.beamlines.beamline_parameters import get_beamline_parameters
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import set_config_client
 from dodal.device_manager import DeviceManager
 from dodal.devices.aperturescatterguard import (
     AperturePosition,
@@ -57,7 +61,7 @@
 ZOOM_PARAMS_FILE = "/dls_sw/i04/software/bluesky/scratch/jCameraManZoomLevels.xml"
 DISPLAY_CONFIG = "/dls_sw/i04/software/bluesky/scratch/display.configuration"
 DAQ_CONFIGURATION_PATH = "/dls_sw/i04/software/daq_configuration"
-
+I04_CONFIG_SERVER_ENDPOINT = "https://i04-daq-config.diamond.ac.uk"
 
 BL = get_beamline_name("i04")
 set_log_beamline(BL)
@@ -72,6 +76,14 @@
 devices = DeviceManager()
 
 
+@devices.fixture
+@cache
+def config_client() -> ConfigClient:
+    client = ConfigClient(I04_CONFIG_SERVER_ENDPOINT)
+    set_config_client(client)
+    return client
+
+
 @devices.factory(use_factory_name=False)
 def smargon() -> Smargon:
     return Smargon(f"{PREFIX.beamline_prefix}-MO-SGON-01:", name="gonio")
@@ -179,9 +191,12 @@ def daq_configuration_path() -> str:
 
 
 @devices.factory()
-def undulator(baton: Baton, daq_configuration_path: str) -> UndulatorInKeV:
+def undulator(
+    baton: Baton, daq_configuration_path: str, config_client: ConfigClient
+) -> UndulatorInKeV:
     return UndulatorInKeV(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
+        config_client=config_client,
         id_gap_lookup_table_path=f"{daq_configuration_path}/lookup/BeamLine_Undulator_toGap.txt",
         baton=baton,
     )

src/dodal/beamlines/i07.py

@@ -1,4 +1,9 @@
+from functools import cache
+
+from daq_config_server import ConfigClient
+
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import set_config_client
 from dodal.device_manager import DeviceManager
 from dodal.devices.beamlines.i07.dcm import DCM
 from dodal.devices.beamlines.i07.id import InsertionDevice
@@ -14,6 +19,14 @@
 devices = DeviceManager()
 
 
+@devices.fixture
+@cache
+def config_client() -> ConfigClient:
+    client = ConfigClient()
+    set_config_client(client)
+    return client
+
+
 @devices.factory()
 def dcm() -> DCM:
     """Instantiate DCM using two PV bases."""
@@ -28,12 +41,13 @@ def harmonic() -> UndulatorOrder:
 
 
 @devices.factory()
-def id(harmonic: UndulatorOrder) -> InsertionDevice:
+def id(harmonic: UndulatorOrder, config_client: ConfigClient) -> InsertionDevice:
     """Get the i07 undulator device, instantiate it if it hasn't already been.
     If this is called when already instantiated it will return the existing object.
     """
     return InsertionDevice(
         f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
         harmonic,
+        config_client,
         id_gap_lookup_table_path="/dls_sw/i07/software/gda/config/lookupTables/IIDCalibrationTable.txt",
     )

src/dodal/beamlines/i18.py

@@ -1,10 +1,13 @@
 from pathlib import Path
 
+from daq_config_server import ConfigClient
 from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import (
     device_factory,
+    get_config_client,
     get_path_provider,
+    set_config_client,
     set_path_provider,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
@@ -46,6 +49,8 @@
     )
 )
 
+set_config_client(ConfigClient())
+
 
 @device_factory()
 def synchrotron() -> Synchrotron:
@@ -54,7 +59,9 @@ def synchrotron() -> Synchrotron:
 
 @device_factory()
 def undulator() -> UndulatorInKeV:
-    return UndulatorInKeV(f"{PREFIX.insertion_prefix}-MO-SERVC-01:")
+    return UndulatorInKeV(
+        f"{PREFIX.insertion_prefix}-MO-SERVC-01:", get_config_client()
+    )
 
 
 # See https://github.com/DiamondLightSource/dodal/issues/1180

src/dodal/beamlines/i22.py

@@ -1,6 +1,7 @@
 from functools import cache
 from pathlib import Path
 
+from daq_config_server import ConfigClient
 from ophyd_async.core import (
     PathProvider,
     StaticPathProvider,
@@ -12,6 +13,7 @@
 from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import set_config_client
 from dodal.common.beamlines.device_helpers import CAM_SUFFIX, DET_SUFFIX, HDF5_SUFFIX
 from dodal.common.crystal_metadata import (
     MaterialsEnum,
@@ -52,6 +54,14 @@ def path_provider() -> PathProvider:
     return StaticPathProvider(UUIDFilenameProvider(), Path("/tmp"))
 
 
+@devices.fixture
+@cache
+def config_client() -> ConfigClient:
+    client = ConfigClient()
+    set_config_client(client)
+    return client
+
+
 @devices.factory()
 def saxs(path_provider: PathProvider) -> PilatusDetector:
     metadata_holder = NXSasMetadataHolder(
@@ -178,9 +188,10 @@ def dcm() -> DCM:
 
 
 @devices.factory()
-def undulator() -> UndulatorInKeV:
+def undulator(config_client: ConfigClient) -> UndulatorInKeV:
     return UndulatorInKeV(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
+        config_client=config_client,
         id_gap_lookup_table_path="/dls_sw/i22/software/daq_configuration/lookup/BeamLine_Undulator_toGap.txt",
         poles=80,
         length=2.0,

src/dodal/beamlines/p38.py

@@ -1,11 +1,14 @@
 from pathlib import Path
 
+from daq_config_server import ConfigClient
 from ophyd_async.epics.adaravis import AravisDetector
 from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import (
     device_factory,
+    get_config_client,
     get_path_provider,
+    set_config_client,
     set_path_provider,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
@@ -45,6 +48,8 @@
     )
 )
 
+set_config_client(ConfigClient())
+
 
 @device_factory()
 def d3() -> AravisDetector:
@@ -160,6 +165,7 @@ def dcm() -> DCM:
 def undulator() -> UndulatorInKeV:
     return UndulatorInKeV(
         f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
+        get_config_client(),
         poles=80,
         length=2.0,
     )

src/dodal/common/beamlines/beamline_parameters.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from dodal.common.beamlines.config_client import get_config_client
+from dodal.common.beamlines.beamline_utils import get_config_client
 
 BEAMLINE_PARAMETER_PATHS = {
     "i03": "/dls_sw/i03/software/daq_configuration/domain/beamlineParameters",
@@ -22,5 +22,5 @@ def get_beamline_parameters(beamline: str) -> dict[str, Any]:
         raise KeyError(
             "No beamline parameter path found, maybe 'BEAMLINE' environment variable is not set!"
         )
-    config_client = get_config_client(beamline)
+    config_client = get_config_client()
     return config_client.get_file_contents(beamline_param_path, dict)

src/dodal/common/beamlines/beamline_utils.py

@@ -3,6 +3,7 @@
 from typing import Annotated, Final, TypeVar, cast
 
 from bluesky.run_engine import call_in_bluesky_event_loop
+from daq_config_server import ConfigClient
 from ophyd import Device as OphydV1Device
 from ophyd.sim import make_fake_device
 from ophyd_async.core import (
@@ -183,3 +184,26 @@ def clear_path_provider() -> None:
     except NameError:
         # In this case the path provider was never set so we can do nothing
         pass
+
+
+def set_config_client(config_client: ConfigClient):
+    global CONFIG_CLIENT
+
+    LOGGER.info(
+        f"Setting global config client to {config_client} (previously {globals().get('CONFIG_CLIENT')})",
+    )
+    CONFIG_CLIENT = config_client
+
+
+def get_config_client() -> ConfigClient:
+    return CONFIG_CLIENT
+
+
+def clear_config_client() -> None:
+    global CONFIG_CLIENT
+    LOGGER.info(f"Clearing global config client: {globals().get('CONFIG_CLIENT')}")
+    try:
+        del CONFIG_CLIENT
+    except NameError:
+        # In this case the config client was never set so we can do nothing
+        pass