Skip to content

Populate dag and note before firing dag run state-change listeners #69873

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
kacpermuda wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Populate dag and note before firing dag run state-change listeners #69873

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
4 changes: 3 additions & 1 deletion airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,9 @@ def patch_dag_run(

data = patch_body.model_dump(include=fields_to_update, by_alias=True)

for attr_name, attr_value_raw in data.items():
# Sort keys so that the "note" update happens before "state" update, so that the listeners called inside
# `patch_dag_run_state()` already receive updated DagRun object with note.
for attr_name, attr_value_raw in sorted(data.items()):
Comment on lines +225 to +227

@amoghrajesh amoghrajesh Jul 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Using sorted(data.items()) to force "note" before "state" couples correctness to the field names' alphabetical order rather than expressing the ordering intent explicitly. This works today because "note" < "state", but is a trap for the next field added to DAGRunPatchBody & nothing would signal that ordering matters.

I suggest using an explicit ordering or just processing "note" before the loop which would be clearer and safer.

@pierrejeambrun pierrejeambrun Jul 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1 for this, we might have a similar problem on the Task Instance endpoint as well. (Just realized there is another PR opened for this)

if attr_name == "state" and patch_body.state is not None:
patch_dag_run_state(dag=dag, dag_run=dag_run, state=patch_body.state, session=session)
elif attr_name == "note":
Expand Down
14 changes: 12 additions & 2 deletions airflow-core/src/airflow/api_fastapi/core_api/services/public/dag_run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,12 @@ def patch_dag_run_state(
if state == DagRunMutableStates.SUCCESS:
set_dag_run_state_to_success(dag=dag, run_id=dag_run.run_id, commit=True, session=session)
try:
get_listener_manager().hook.on_dag_run_success(dag_run=dag_run, msg="")
if dag_run.dag is None:
dag_run.dag = dag
get_listener_manager().hook.on_dag_run_success(
dag_run=dag_run,
msg=f"Dag Run's state was manually set to `{DagRunMutableStates.SUCCESS.value}`.",
)
except Exception:
log.exception("error calling listener")
elif state == DagRunMutableStates.QUEUED:
Expand All @@ -206,7 +211,12 @@ def patch_dag_run_state(
elif state == DagRunMutableStates.FAILED:
set_dag_run_state_to_failed(dag=dag, run_id=dag_run.run_id, commit=True, session=session)
try:
get_listener_manager().hook.on_dag_run_failed(dag_run=dag_run, msg="")
if dag_run.dag is None:
dag_run.dag = dag
get_listener_manager().hook.on_dag_run_failed(
dag_run=dag_run,
msg=f"Dag Run's state was manually set to `{DagRunMutableStates.FAILED.value}`.",
)
except Exception:
log.exception("error calling listener")

Expand Down
28 changes: 23 additions & 5 deletions airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_dag_run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1594,20 +1594,38 @@ def test_patch_dag_run_bad_request(self, test_client):
assert body["detail"][0]["msg"] == "Input should be 'queued', 'success' or 'failed'"

@pytest.mark.parametrize(
("state", "listener_state"),
("state", "listener_state", "expected_msg"),
[
("queued", []),
("success", [DagRunState.SUCCESS]),
("failed", [DagRunState.FAILED]),
("queued", [], None),
("success", [DagRunState.SUCCESS], "Dag Run's state was manually set to `success`."),
("failed", [DagRunState.FAILED], "Dag Run's state was manually set to `failed`."),
],
)
@pytest.mark.usefixtures("configure_git_connection_for_dag_bundle")
def test_patch_dag_run_notifies_listeners(self, test_client, state, listener_state, listener_manager):
def test_patch_dag_run_notifies_listeners(
self, test_client, state, listener_state, expected_msg, listener_manager
):
listener = ClassBasedListener()
listener_manager(listener)
response = test_client.patch(f"/dags/{DAG1_ID}/dagRuns/{DAG1_RUN1_ID}", json={"state": state})
assert response.status_code == 200
assert listener.state == listener_state
if expected_msg is not None:
assert listener.dag_run_msg == expected_msg
assert listener.dag_has_dag_attr is True

@pytest.mark.usefixtures("configure_git_connection_for_dag_bundle")
def test_patch_dag_run_listener_sees_note_when_note_and_state_both_patched(
self, test_client, listener_manager
):
listener = ClassBasedListener()
listener_manager(listener)
response = test_client.patch(
f"/dags/{DAG1_ID}/dagRuns/{DAG1_RUN2_ID}",
json={"state": "success", "note": "listener_note"},
)
assert response.status_code == 200
assert listener.dag_run_note_at_listener == "listener_note"


class TestDeleteDagRun:
Expand Down
9 changes: 9 additions & 0 deletions airflow-core/tests/unit/listeners/class_listener.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ def __init__(self):
self.started_component = None
self.stopped_component = None
self.state = []
self.dag_run_msg: str | None = None
self.dag_has_dag_attr: bool | None = None
self.dag_run_note_at_listener: str | None = None

@hookimpl
def on_starting(self, component):
Expand Down Expand Up @@ -60,10 +63,16 @@ def on_dag_run_running(self, dag_run, msg: str):
@hookimpl
def on_dag_run_success(self, dag_run, msg: str):
self.state.append(DagRunState.SUCCESS)
self.dag_run_msg = msg
self.dag_has_dag_attr = dag_run.dag is not None
self.dag_run_note_at_listener = dag_run.note

@hookimpl
def on_dag_run_failed(self, dag_run, msg: str):
self.state.append(DagRunState.FAILED)
self.dag_run_msg = msg
self.dag_has_dag_attr = dag_run.dag is not None
self.dag_run_note_at_listener = dag_run.note


def clear():
Expand Down