Skip to content

feat: add blueapi_task_id to metadata #1628

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

Merged
ZohebShaikh merged 1 commit into from
Aug 17, 2026
Merged

feat: add blueapi_task_id to metadata #1628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/blueapi/worker/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Task(BlueapiBaseModel):
params: Mapping[str, Any] = Field(
description="Values for parameters to plan, if any", default_factory=dict
)
metadata: Mapping[str, Any] = Field(
metadata: dict[str, Any] = Field(
description="Any metadata to apply to all runs within this task",
default_factory=dict,
)
Expand Down
1 change: 1 addition & 0 deletions src/blueapi/worker/task_worker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ def submit_task(self, task: Task) -> str:
"""
task.prepare_params(self._ctx) # Will raise if parameters are invalid
task_id: str = str(uuid.uuid4())
task.metadata["blueapi_task_id"] = task_id
add_span_attributes({"TaskId": task_id})
request_id = get_baggage("correlation_id")
# If request id is not a string, we do not pass it into a TrackableTask
Expand Down
5 changes: 4 additions & 1 deletion tests/system_tests/test_blueapi_system.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ def test_create_task_and_delete_task_by_id(
rest_client.clear_task(create_task.task_id)


def test_instrument_session_propagated(
def test_task_metadata_propagated(
rest_client: BlueapiRestClient, small_task: TaskRequest
):
response = rest_client.create_task(small_task)
Expand All @@ -353,6 +353,7 @@ def test_instrument_session_propagated(
"tiled_access_tags": [
'{"proposal": 12345, "visit": 1, "beamline": "adsim"}',
],
"blueapi_task_id": response.task_id,
}


Expand Down Expand Up @@ -624,6 +625,8 @@ def on_event(event: AnyEvent) -> None:
assert start_metadata["instrument_session"] == VALID_INSTRUMENT_SESSION[user]
assert "scan_id" in start_metadata
assert start_metadata["scan_id"] == scan_id
assert "blueapi_task_id" in start_metadata
assert start_metadata["blueapi_task_id"] == final_event.task_id
assert "detectors" in start_metadata
assert "det" in start_metadata["detectors"]

Expand Down
5 changes: 4 additions & 1 deletion tests/unit_tests/service/test_interface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,7 @@ def test_get_task_by_id(

expected_metadata: dict[str, Any] = {
"instrument_session": FAKE_INSTRUMENT_SESSION,
"blueapi_task_id": task_id,
}

if tiled_enabled:
Expand Down Expand Up @@ -408,13 +409,15 @@ def test_submit_task_inserts_metadata(context_mock: MagicMock):
metadata,
)

expected_metadata = {**metadata, "blueapi_task_id": task_id}

assert interface.get_task_by_id(task_id) == TrackableTask.model_construct(
task_id=task_id,
request_id=ANY,
task=Task(
name="my_plan",
params={},
metadata=metadata,
metadata=expected_metadata,
),
is_complete=False,
is_pending=True,
Expand Down