[oliwenmandiamond]

As requested by @ZohebShaikh , this is done in a separate PR. The only logic that has changed is to remove the redundant name for Plan and DeviceRef as the model.name attribute shares the exact same one. The previous logic duplicated the name. Instead, we remove the name attribute and just delegate to the model for the name.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.42%. Comparing base (89952c9) to head (76d43ca).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1697      +/-   ##
==========================================
- Coverage   96.42%   96.42%   -0.01%     
==========================================
  Files          49       49              
  Lines        3749     3745       -4     
==========================================
- Hits         3615     3611       -4     
  Misses        134      134              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[oliwenmandiamond]

@ZohebShaikh, I had a look at your integration test and also tested it myself locally

>>> pl.rd(devs.stage.x)
Traceback (most recent call last):
  File "<python-input-9>", line 1, in <module>
    pl.rd(devs.stage.x)
    ~~~~~^^^^^^^^^^^^^^
  File "/scratch/bluesky_development/blueapi/src/blueapi/client/plan_cache.py", line 78, in __call__
    match self._client.run_task(req):
          ~~~~~~~~~~~~~~~~~~~~~^^^^^
  File "/scratch/bluesky_development/blueapi/.venv/lib/python3.14/site-packages/observability_utils/tracing/decorators.py", line 151, in wrapper
    return func(*args, **kwargs)
  File "/scratch/bluesky_development/blueapi/src/blueapi/client/client.py", line 361, in run_task
    task_response = self._rest.create_task(task)
  File "/scratch/bluesky_development/blueapi/src/blueapi/client/rest.py", line 256, in create_task
    return self._request_and_deserialize(
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
        "/tasks",
        ^^^^^^^^^
    ...<3 lines>...
        data=task.model_dump(mode="json", fallback=_task_model_fallback),
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    )
    ^
  File "/scratch/bluesky_development/blueapi/.venv/lib/python3.14/site-packages/observability_utils/tracing/decorators.py", line 151, in wrapper
    return func(*args, **kwargs)
  File "/scratch/bluesky_development/blueapi/src/blueapi/client/rest.py", line 340, in _request_and_deserialize
    raise exception
blueapi.client.rest.InvalidParametersError: [ParameterError(loc=['body', 'params', 'readable'], msg='Value error, Device stage-x cannot be found', type='value_error', input='stage-x')]

I now understand why we have a name for the model and the name for the cache. The issue is the name being used is stage-x. This relates to DiamondLightSource/dodal#2216 I raised a couple of weeks ago. Basically, dodal/ophyd-async treats all sub devices names like this: parent-child-x. However, blueapi internally treats all devices names like this: parent.child.x. So there is a conflict on the device name and the blueapi name for a device. So this must be unified first before we can make this change.

So the options are

1. We make a change in ophyd-async that allows us to override the deliminator between sub device to be . and then apply this to dodal. MX have already expressed they do not want to do this.
2. Blueapi updates the naming it uses to look up devices to use - to separate devices.

I and I think others would prefer option 2. It would be too painful to update ophyd-async plus dodal plus all plan repos to account for this. It is simpler to make blueapi to look up devices using the actual name given to them.

[oliwenmandiamond]

Blocked by #1700

[abbiemery]

From many past conversations, 1 is not an option. Happy to discuss 2.

[fajinyuan]

Please mark this a breaking API change, and ensure change log records this for release.

[oliwenmandiamond]

@fajinyuan I think this can't be merged yet. This change focuses on the client, simplifying the name. However, the server still uses the old name which is different and will cause the client to fail. #1700 is needed first which hasn't been done yet. I think once #1699 is merged which adds more system tests for client, it will demonstrate the issue and cause this to fail system tests

[abbiemery]

Please mark this a breaking API change, and ensure change log records this for release.

This is a draft and shouldn't be approved yet. In addition we still need to decide some things about it.

This is still a draft and depends on other work before it is viable.