You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "kacpermuda (via GitHub)" <gi...@apache.org> on 2026/07/14 13:19:35 UTC
[PR] Populate dag and note before firing dag run state-change listeners [airflow]
kacpermuda opened a new pull request, #69873:
URL: https://github.com/apache/airflow/pull/69873
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull request.
Write a good git commit message following this guide: http://chris.beams.io/posts/git-commit/
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the documentation.
For user-facing UI changes, please attach before/after screenshots (or a short
screen recording) so reviewers can assess the visual impact.
Feel free to ping (in general) for the review if you do not see reaction for a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
When patching a Dag Run's state to success or failed via the API, two issues
existed with the listener call:
1. `dag_run.dag` was always `None` when the listener received the object,
because the route loads the dag separately but never attached it to the run.
2. The listener message was an empty string.
3. When both `note` and `state` were patched in the same request, the note
could be applied after the listener fired, so the listener saw the old note.
Fix by setting `dag_run.dag = dag` before calling the hook, passing a
descriptive message, and sorting the patch fields so `note` is always
processed before `state`.
---
##### Was generative AI tooling used to co-author this PR?
- [X] Yes — Claude Sonnet 4.6
Generated-by: Claude Sonnet 4.6 following [the guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
---
* Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment: `{pr_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments). You can add this file in a follow-up commit after the PR is created so you know the PR number.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3631027647
##########
airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py:
##########
@@ -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()):
Review Comment:
Maybe I got confused, my point is we have the same problem for `patch_task_instance` endpoint I believe.
The `_patch_task_instance_state` call is before we mutate the 'note', therefore the listener inside will see the old note.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3584753099
##########
airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py:
##########
@@ -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()):
Review Comment:
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3631308003
##########
airflow-core/tests/unit/listeners/class_listener.py:
##########
@@ -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
Review Comment:
Will be addressed in the TI PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun merged PR #69873:
URL: https://github.com/apache/airflow/pull/69873
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "kacpermuda (via GitHub)" <gi...@apache.org>.
kacpermuda commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3587002675
##########
airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py:
##########
@@ -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()):
Review Comment:
Thanks, that makes sense, improved this piece of code by removing the loop entirely and just ordering calls explicitly. @pierrejeambrun do you mind linking the taskinstance PR? Would love to track it and make sure these fixes are all merged, included in next release and backported.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3585631321
##########
airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py:
##########
@@ -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()):
Review Comment:
+1 for this, we might have a similar problem on the Task Instance endpoint as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #69873:
URL: https://github.com/apache/airflow/pull/69873#issuecomment-5047979572
### Backport successfully created: v3-3-test
Note: As of [Merging PRs targeted for Airflow 3.X](https://github.com/apache/airflow/blob/main/dev/README_AIRFLOW3_DEV.md#merging-prs-targeted-for-airflow-3x)
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.
In matter of doubt please ask in [#release-management](https://apache-airflow.slack.com/archives/C03G9H97MM2) Slack channel.
<table>
<tr>
<th>Status</th>
<th>Branch</th>
<th>Result</th>
</tr>
<tr>
<td>✅</td>
<td>v3-3-test</td>
<td><a href="https://github.com/apache/airflow/pull/70245"><img src="https://img.shields.io/badge/PR-70245-blue" alt="PR Link"></a></td>
</tr>
</table>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3585631321
##########
airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py:
##########
@@ -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()):
Review Comment:
+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)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3631027647
##########
airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py:
##########
@@ -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()):
Review Comment:
Maybe I got confused, my point is we have the same problem for `patch_task_instance` endpoint I believe.
The `_patch_task_instance_state` call is before we mutate the 'note', therefore the listener inside will see the old note.
Probably need a follow up similar PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Populate dag and note before firing dag run state-change listeners [airflow]
Posted by "pierrejeambrun (via GitHub)" <gi...@apache.org>.
pierrejeambrun commented on code in PR #69873:
URL: https://github.com/apache/airflow/pull/69873#discussion_r3631103247
##########
airflow-core/tests/unit/listeners/class_listener.py:
##########
@@ -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
Review Comment:
nit:
```suggestion
self.dag_run_has_dag_attr: bool | None = None
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org