Skip to content

refactor: improve numtracker error messages #1538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shree-iyengar-dls wants to merge 3 commits into
base: main
Choose a base branch
from
+36 −0
Open

refactor: improve numtracker error messages #1538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e7768f
refactor: make changes to auth failed error message
shree-iyengar-dls May 8, 2026
61df86f
Merge branch 'main' into improve_error_message
shree-iyengar-dls May 8, 2026
c421585
test: add runtime auth error test
shree-iyengar-dls May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/blueapi/utils/numtracker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ async def create_scan(
json = response.json()

if json.get("errors") is not None:
for error in json["errors"]:
code = (error.get("extensions") or {}).get("code")
Comment thread
shree-iyengar-dls marked this conversation as resolved.

if code == "AUTH_FAILED":
Copy link
Copy Markdown
Contributor

@tpoliaw tpoliaw May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to improve the error message for the other cases while we're here? Could be a good use for match - something like

match code:
    case "AUTH_FAILED":
        raise ...
    case "AUTH_MISSING":
        raise ...
    case "AUTH_SERVER_ERROR":
        raise ...

and then the fall-through case could be the existing Numtracker error: ... we were previously raising.

Copy link
Copy Markdown
Contributor Author

@shree-iyengar-dls shree-iyengar-dls May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yuss that's a good idea thanks

raise RuntimeError(
f"Not authorised to create a scan number for "
f"{instrument} and {instrument_session}."
)
raise RuntimeError(f"Numtracker error: {json['errors']}")

new_collection = NumtrackerScanMutationResponse.model_validate(json["data"])
Expand Down
28 changes: 28 additions & 0 deletions tests/unit_tests/utils/test_numtracker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ def numtracker() -> NumtrackerClient:
],
}

AUTH_ERROR = {
"data": None,
"errors": [
{
"message": "No configuration available for instrument p46",
Copy link
Copy Markdown
Contributor

@tpoliaw tpoliaw May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really minor but having the message match the error might prevent confusion later on

"locations": [{"line": 3, "column": 5}],
"path": ["scan"],
"extensions": {"code": "AUTH_FAILED"},
}
],
}


async def test_create_scan(
numtracker: NumtrackerClient, httpx_mock: HTTPXMock, nt_query, nt_response
Expand Down Expand Up @@ -109,3 +121,19 @@ async def test_create_scan_raises_runtime_error_on_graphql_error(
)
with pytest.raises(RuntimeError, match="Numtracker error:"):
await numtracker.create_scan("ab123", "p46")


async def test_create_scan_raises_runtime_auth_error_on_graphql_error(
numtracker: NumtrackerClient, httpx_mock: HTTPXMock, nt_query
):
httpx_mock.add_response(
method="POST",
url=URL,
match_json=nt_query,
status_code=200,
json=AUTH_ERROR,
)
with pytest.raises(
RuntimeError, match="Not authorised to create a scan number for p46 and ab123"
):
await numtracker.create_scan("ab123", "p46")
Loading