Add run_id filter for dag runs #52437

noeunkim · 2025-06-29T05:00:14Z

Feature

Adds single run_id pattern filter to /dag_runs page
Based on Feature Gap - UI/API Filters #52363
This filter was available in previous version but is currently missing in v3

Discussion points

Single run_id filter sufficient? or should we support more complex search parser?
- e.g., AND / OR conditions
Any suggestions for improving the UI design? more structured form preferable?

Feedback and suggestions are welcome!

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

boring-cyborg · 2025-06-29T05:00:16Z

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
Be sure to read the Airflow Coding style.
Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: [email protected]
Slack: https://s.apache.org/airflow-slack

…and-api

jscheffl

If something in UI changes it is cool to always also add a screenshot - that makes review easier. Can you add some mugshot to PR description?

airflow-core/src/airflow/ui/src/pages/DagRuns.tsx

…and-api

jscheffl

I am not fully sure about this feature, it is really a gap from previous version but the implementation only offers an exact match. No globbing.

I'd request some other reviewers as well, I assume next level is also we need to invest into better search capabilities in general, only exact run ID match is not much of a great value.

Please do not treat it tooo negative. I think in general the search capabilties are a shortcoming in the UI in general. I am unsure about the increments needed to get back to 2.11 state of options.

airflow-core/src/airflow/ui/public/i18n/locales/en/common.json

jason810496

Nice! Thanks for the PR, just a small nit. LGTM on API side after fix.

airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py

…and-api

fritz-astronomer · 2025-06-30T15:10:49Z

That was fast! Awesome work.

There are a number of other fields that could be sorted on, and I agree with

only exact run ID match is not much of a great value

However, I do also think something is better than nothing?
Maybe can revisit at a later time to add something more generic and powerful for many fields across many models?

pierrejeambrun

Thanks for the pull request, that's a good idea.

We do support searching on patterns:

    DESCRIPTION = (
        "SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). "
        "Regular expressions are **not** supported."
    )

You can take a look at search_param_factory to construct such filters on the API side.

For instance for the task_display_name_pattern search.

…and-api

pierrejeambrun

Nice, just a few nitpicks and should be good to merge.

Thanks for the pull request.

airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py

airflow-core/src/airflow/ui/src/constants/searchParams.ts

airflow-core/src/airflow/ui/src/pages/DagRuns.tsx

…and-api

noeunkim · 2025-07-02T05:00:11Z

Thanks to everyone’s effort and feedback, we now have pattern search for run_id (e.g., %2025-07-02%)

I do also think something is better than nothing? Maybe can revisit at a later time to add something more generic and powerful for many fields across many models?

I agree and think our next step could be to support multi field filtering not just a single filter.
Do you think we should split the feature into another PR for it, or continue enhancing this feature here?
I’d love to hear your thoughts experts!

cc. @fritz-astronomer

pierrejeambrun · 2025-07-02T11:48:29Z

I agree and think our next step could be to support multi field filtering not just a single filter.
Do you think we should split the feature into another PR for it, or continue enhancing this feature here?
I’d love to hear your thoughts experts!

This one is close to be ready and is a nice improvement on its own. I don't think we should delay it further more by building on top of it, what you are suggesting could be a nice follow up PR.

…and-api

jscheffl

I am okay and thanks for adding a wildcard such that users can better use it! Like it!

I am though a bit un-easy with "%" as being the wildcard. I know that "%" is used in most DB systems but for a nono DBA user the % char is in my view not very common.
Could we change it that a "" is also possible or exachange "%" with "" as being the wildcard?

Won't block if others are okay with "%" but from UX perspective a "%" is non -intuitive in my view.

jscheffl · 2025-07-02T19:20:30Z

airflow-core/src/airflow/ui/public/i18n/locales/en/dags.json

@@ -13,7 +13,8 @@
      "active": "Active",
      "all": "All",
      "paused": "Paused"
-    }
+    },
+    "runIdPatternFilter": "Add run_id filter"


Can we add a tooltip or similar that helps the user to know that "%" is the wildcard? Else user probably does not know or attempts to use "*".

I think we let the user simply type "2025" and we handle the % behind the scenes

That would also be great. So user enters "abc" and the query is automatically be made with "%abc%"
That would also made it so easy we don't need to add a tooltip then.

Add run_id filter for dag runs

40a8982

noeunkim requested review from bbovenzi, pierrejeambrun, ryanahamilton, jscheffl, shubhamraj-git and ephraimbuddy as code owners June 29, 2025 05:00

noeunkim requested review from rawwar, jason810496 and bugraoz93 as code owners June 29, 2025 05:00

boring-cyborg bot added area:API Airflow's REST/HTTP API area:UI Related to UI/UX. For Frontend Developers. labels Jun 29, 2025

Merge branch 'main' into feature/issue-52363-add-run-id-filter-to-ui-…

b5411bf

…and-api

jscheffl reviewed Jun 29, 2025

View reviewed changes

airflow-core/src/airflow/ui/src/pages/DagRuns.tsx Outdated Show resolved Hide resolved

noeunkim and others added 2 commits June 29, 2025 19:24

Update i18n support for run_id filter in Dag Runs page

d0afa38

Merge branch 'main' into feature/issue-52363-add-run-id-filter-to-ui-…

97ddb24

…and-api

jscheffl reviewed Jun 29, 2025

View reviewed changes

airflow-core/src/airflow/ui/public/i18n/locales/en/common.json Outdated Show resolved Hide resolved

jason810496 reviewed Jun 29, 2025

View reviewed changes

airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py Outdated Show resolved Hide resolved

airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py Outdated Show resolved Hide resolved

noeunkim and others added 2 commits June 30, 2025 01:25

Merge branch 'main' into feature/issue-52363-add-run-id-filter-to-ui-…

361e695

…and-api

Apply param dependency injection and update i18n key structure

f164c25

pierrejeambrun reviewed Jun 30, 2025

View reviewed changes

noeunkim and others added 2 commits July 1, 2025 23:54

Apply _SearchParam to support pattern search

47eed2f

Merge branch 'main' into feature/issue-52363-add-run-id-filter-to-ui-…

d2e8c9a

…and-api

pierrejeambrun reviewed Jul 1, 2025

View reviewed changes

airflow-core/src/airflow/api_fastapi/core_api/routes/public/dag_run.py Outdated Show resolved Hide resolved

airflow-core/src/airflow/ui/src/constants/searchParams.ts Outdated Show resolved Hide resolved

airflow-core/src/airflow/ui/src/pages/DagRuns.tsx Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

bbovenzi reviewed Jul 1, 2025

View reviewed changes

airflow-core/src/airflow/ui/src/pages/DagRuns.tsx Outdated Show resolved Hide resolved

bbovenzi added this to the Airflow 3.1.0 milestone Jul 1, 2025

Rename run_id to run_id_pattern and refactor DagRuns ui to use SearchBar

6b75074

noeunkim and others added 3 commits July 2, 2025 13:42

Merge branch 'main' into feature/issue-52363-add-run-id-filter-to-ui-…

38dfe34

…and-api

Resolve merge conflict

d39c3da

Merge branch 'main' into feature/issue-52363-add-run-id-filter-to-ui-…

e26b625

…and-api

Merge branch 'main' into feature/issue-52363-add-run-id-filter-to-ui-…

41e4b63

…and-api

noeunkim requested review from jscheffl, jason810496 and bbovenzi July 2, 2025 15:15

jscheffl reviewed Jul 2, 2025

View reviewed changes

Add run_id filter for dag runs #52437

Are you sure you want to change the base?

Add run_id filter for dag runs #52437

Conversation

noeunkim commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Feature

Discussion points

Uh oh!

boring-cyborg bot commented Jun 29, 2025

Uh oh!

jscheffl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jscheffl left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jason810496 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fritz-astronomer commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pierrejeambrun left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pierrejeambrun left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

noeunkim commented Jul 2, 2025

Uh oh!

pierrejeambrun commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jscheffl left a comment

Choose a reason for hiding this comment

Uh oh!

jscheffl Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

bbovenzi Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

jscheffl Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

noeunkim commented Jun 29, 2025 •

edited

Loading

jscheffl left a comment •

edited

Loading

fritz-astronomer commented Jun 30, 2025 •

edited

Loading

pierrejeambrun left a comment •

edited

Loading

pierrejeambrun commented Jul 2, 2025 •

edited

Loading

jscheffl Jul 2, 2025 •

edited

Loading