chore: improve default error handling 1379 1409 by Alexj9837 · Pull Request #1491 · DiamondLightSource/blueapi

Alexj9837 · 2026-04-16T14:01:24Z

Both issues related to error handling in the REST client.

1379 - Catches 'UnauthorisedAccessErrorexplicitly instead of string-matching onBlueskyRemoteControlError`.

1409 - Expands the exception hierarchy so each
HTTP status code raises a distinct typed exception rather than bundling
everything into BlueskyRemoteControlError.
Tests

Update tests to match new exception signatures
Add missing coverage for 422 non-list detail response
Add missing coverage for streaming error in run command

Poor grammar. Co-authored-by: Peter Holloway <peter.holloway@diamond.ac.uk>

… having an effect when running plans - you'll still get the Unauthorised request message"

…ted to return some more details

rebased from main to fix merge conflicts --------- Co-authored-by: Shreelakshmi Iyengar <shreelakshmi.iyengar@diamond.ac.uk> Co-authored-by: Zoheb Shaikh <zoheb.shaikh@diamond.ac.uk> Co-authored-by: Daniel Fernandes <65790536+dan-fernandes@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Zoheb Shaikh <26975142+ZohebShaikh@users.noreply.github.com> Co-authored-by: Abigail Emery <abigail.emery@diamond.ac.uk> Co-authored-by: oliwenmandiamond <136330507+oliwenmandiamond@users.noreply.github.com> Co-authored-by: Peter Holloway <peter.holloway@diamond.ac.uk> Co-authored-by: NeilSmithDLS <118457264+NeilSmithDLS@users.noreply.github.com>

Removed duplicate BlueskyRequestError exception class from rest.py.

codecov · 2026-04-16T14:27:40Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.33%. Comparing base (107d54e) to head (b666346).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1491      +/-   ##
==========================================
+ Coverage   95.25%   95.33%   +0.07%     
==========================================
  Files          43       43              
  Lines        3163     3172       +9     
==========================================
+ Hits         3013     3024      +11     
+ Misses        150      148       -2

☔ View full report in Codecov by Sentry.
📢 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.

tpoliaw · 2026-04-22T14:19:11Z

It wasn't mentioned in the original issue but the controller env -r code path doesn't seem to be catching the same errors.

$ uv run blueapi controller env -r

Reloading environment
Traceback (most recent call last):
  File "/dls/athena/blueapi/src/blueapi/client/client.py", line 663, in reload_environment
    status = self._rest.delete_environment()
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/src/blueapi/client/rest.py", line 272, in delete_environment
    return self._request_and_deserialize(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/observability_utils/tracing/decorators.py", line 151, in wrapper
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/src/blueapi/client/rest.py", line 318, in _request_and_deserialize
    raise exception
blueapi.client.rest.UnauthorisedAccessError: (401, '{"detail":"Not authenticated"}')

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/dls/athena/blueapi/.venv/bin/blueapi", line 10, in <module>
    sys.exit(main())
             ^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/click/core.py", line 1485, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/click/core.py", line 1406, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/click/core.py", line 1873, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/click/core.py", line 1873, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/click/core.py", line 1269, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/click/core.py", line 824, in invoke
    return callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/click/decorators.py", line 46, in new_func
    return f(get_current_context().obj, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/src/blueapi/cli/cli.py", line 245, in wrapper
    raise e
  File "/dls/athena/blueapi/src/blueapi/cli/cli.py", line 235, in wrapper
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/src/blueapi/cli/cli.py", line 471, in env
    status = client.reload_environment(timeout=timeout)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/.venv/lib/python3.11/site-packages/observability_utils/tracing/decorators.py", line 151, in wrapper
    return func(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/dls/athena/blueapi/src/blueapi/client/client.py", line 665, in reload_environment
    raise BlueskyRemoteControlError(
blueapi.client.rest.BlueskyRemoteControlError: Failed to tear down the environment

Any chance of handling this error in the same way as the others?

tpoliaw

Much better errors for the main error cases, thanks.

tpoliaw · 2026-04-22T15:15:27Z

-class BlueskyRequestError(Exception):
-    def __init__(self, code: int, message: str) -> None:
-        super().__init__(message, code)
+class NotFoundError(BlueskyRequestError):


Why do some extend BlueskyRequestError and some don't?

The exception that returned (code , message) format inhered it from BlueskyRequestError. I thought it'd look cleaner.

Co-authored-by: Peter Holloway <peter.holloway@diamond.ac.uk>

Alexj9837 and others added 12 commits March 17, 2026 13:33

chore: Improve default error handling and enhance exception messages

2756a2b

fix: Use typed exceptions in cli and client

94657ad

test: Update tests for new exception hierarchy

b2061c7

fix: Address PR review comments

575518b

added content for test

f33a736

Update src/blueapi/cli/cli.py

4cb9605

Poor grammar. Co-authored-by: Peter Holloway <peter.holloway@diamond.ac.uk>

updated expected error message for poor grammar

4de01fa

Removing "I think this will prevent your new check_connection changes…

04973f0

… having an effect when running plans - you'll still get the Unauthorised request message"

Fix: 400 responsed previously raised a bare status with no body, upda…

b3cc259

…ted to return some more details

Merge branch 'main' into chore/improve-default-error-handling-1379-1409

ffefee4

Remove duplicate BlueskyRequestError

135cd15

Removed duplicate BlueskyRequestError exception class from rest.py.

Alexj9837 marked this pull request as ready for review April 16, 2026 14:47

Alexj9837 requested a review from a team as a code owner April 16, 2026 14:47

Alexj9837 added 3 commits April 22, 2026 14:50

Merge branch 'main' into chore/improve-default-error-handling-1379-1409

74f83e4

add another test for non_json_body

eb037b7

chasing from raising a KeyError to a NotFoundError

61e973a

Alexj9837 force-pushed the chore/improve-default-error-handling-1379-1409 branch from 7a76c2c to 61e973a Compare April 22, 2026 14:25

tpoliaw reviewed Apr 22, 2026

View reviewed changes

Alexj9837 and others added 3 commits April 22, 2026 17:17

Update src/blueapi/client/rest.py

deb0dae

Co-authored-by: Peter Holloway <peter.holloway@diamond.ac.uk>

responding to PR feedback

38965f8

formatting

b666346

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: improve default error handling 1379 1409#1491

chore: improve default error handling 1379 1409#1491
Alexj9837 wants to merge 18 commits intomainfrom
chore/improve-default-error-handling-1379-1409

Alexj9837 commented Apr 16, 2026

Uh oh!

codecov Bot commented Apr 16, 2026 •

edited

Loading

Uh oh!

tpoliaw commented Apr 22, 2026

Uh oh!

tpoliaw left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tpoliaw Apr 22, 2026

Uh oh!

Alexj9837 Apr 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Alexj9837 commented Apr 16, 2026

Uh oh!

codecov Bot commented Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tpoliaw commented Apr 22, 2026

Uh oh!

tpoliaw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tpoliaw Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Alexj9837 Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Apr 16, 2026 •

edited

Loading