Add support for favorite/pin dags to dashboard by PNL0 · Pull Request #51264 · apache/airflow

PNL0 · 2025-05-31T16:21:25Z

The DAGs can be favorited in the DAGs list menu and are displayed in the Dashboard for easier access.
Information about the favorited DAGs is stored by user in the database and retrieved with API calls.

Dashboard view with 3 favorited DAGs (2 of them with previous DAG runs):

DAGs list menu view with some of the DAGs favorited:

cc @pierrejeambrun @bbovenzi

Closes: #45207

jscheffl

Looks good in general in my view. Besides th i18n also DB migration is missing allowing to upgrade existing setups.

jason810496

Thanks for the PR, LGMT.

FYI: https://github.com/apache/airflow/blob/main/contributing-docs/14_metadata_database_updates.rst for fixing database migrations

pierrejeambrun

Nice!

A few comments

PNL0 · 2025-06-05T22:21:14Z

Looks good in general in my view. Besides th i18n also DB migration is missing allowing to upgrade existing setups.

Thanks for the PR, LGMT.

FYI: https://github.com/apache/airflow/blob/main/contributing-docs/14_metadata_database_updates.rst for fixing database migrations

The DB migration should be present now. Let me know if anything is still missing or incomplete.

pierrejeambrun

Nice, thanks for all the hard work.

A few minor suggestions, but looking good overall.

PNL0 · 2025-06-18T21:07:47Z

Hello @pierrejeambrun @bbovenzi,

I just pushed a new commit that corrects the majority of the problems you pointed out.
Let me know if everything is as expected and if I didn't miss any of your requests (except the 2 not resolved in the conversation).

pierrejeambrun

Nice!

We're getting closer, a few suggestions

Create new tests for the favorite/unfavorite endpoints. Add favorite button to the dag header. Other small fixes. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt>

…et_dags.

Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt>

PNL0 · 2025-07-07T14:32:15Z

There's a conflict on a generated file (because something must have been merged in main).

We need one more rebase and regeneration of front-end types and we should be good to merge.
pre-commit run ts-compile-format-lint-ui --all-files

Hello @pierrejeambrun,

I just rebased and regenerated the frontend types with pre-commit run ts-compile-lint-ui --all-files (the command you suggested wasn't working for me at least).
Let me know if everything is as expected.

boring-cyborg · 2025-07-07T16:04:20Z

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

pierrejeambrun · 2025-07-07T16:04:31Z

Great job!

#protm

pierrejeambrun · 2025-07-07T16:05:02Z

🎉 🎉 🎉

bugraoz93 · 2025-07-07T19:58:03Z

Great job! Congrats! I have been traveling so I couldn't take a look

jscheffl · 2025-07-07T21:09:34Z

As expressed earlier... Cool!

* Add support for favorite/pin dags to dashboard, using localStorage. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Add support for favorite/pin dags to dashboard, persistent between sessions. Co-authored-by: Mariana Isabel Marçal Santana mariana.marcal.santana@tecnico.ulisboa.pt * Implement unit tests Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Add support for favorite/pin dags to dashboard. The favorited DAGs by an user, are stored persistently in the database. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Added no favorites message. Fix deleted DAGs being shown as favorites. Review the display structure of the favorite DAGs in the dashboard. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Rebase and minor fixes. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Use i18n module and fix DB migration. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Review API endpoints Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Develop favorite filter. Create new tests for the favorite/unfavorite endpoints. Add favorite button to the dag header. Other small fixes. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Create new filters and update the frontend to use the UI version of get_dags. * Small fixes. * Small fixes. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt> * Rebase and small fix * Fix issues * Fixed error in CI pipeline * Fixed errors in CI pipeline. * Fix CI pipeline issues. * Regeneration of front-end types --------- Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt>

Two more callers of ``session.scalars(...).first()`` / ``session.execute(select(...)).first()`` were still missing an explicit ``.limit(1)``. Because SQLAlchemy 2.0's ``Result.first()`` does not add one (unlike the legacy ``Query.first``), each call sends every matching row to the Python process and discards all but the first. The favorite existence check is bounded to a single row per (dag_id, user_id) by the schema, but the previous-TI lookup scans every earlier matching TI. Introduced independently of apache#52325's migration: get_previous_task_instance came in apache#59712, unfavorite_dag's existence probe in apache#51264. Same anti-pattern as the four sites apache#72554 fixes; the tests reuse the ``capture_orm_selects`` helper that PR introduces.

* Bound remaining single-row lookups with .limit(1) Two more callers of ``session.scalars(...).first()`` / ``session.execute(select(...)).first()`` were still missing an explicit ``.limit(1)``. Because SQLAlchemy 2.0's ``Result.first()`` does not add one (unlike the legacy ``Query.first``), each call sends every matching row to the Python process and discards all but the first. The favorite existence check is bounded to a single row per (dag_id, user_id) by the schema, but the previous-TI lookup scans every earlier matching TI. Introduced independently of #52325's migration: get_previous_task_instance came in #59712, unfavorite_dag's existence probe in #51264. Same anti-pattern as the four sites #72554 fixes; the tests reuse the ``capture_orm_selects`` helper that PR introduces. * Also assert the returned row on the previous-TI regression test

* Bound remaining single-row lookups with .limit(1) Two more callers of ``session.scalars(...).first()`` / ``session.execute(select(...)).first()`` were still missing an explicit ``.limit(1)``. Because SQLAlchemy 2.0's ``Result.first()`` does not add one (unlike the legacy ``Query.first``), each call sends every matching row to the Python process and discards all but the first. The favorite existence check is bounded to a single row per (dag_id, user_id) by the schema, but the previous-TI lookup scans every earlier matching TI. Introduced independently of #52325's migration: get_previous_task_instance came in #59712, unfavorite_dag's existence probe in #51264. Same anti-pattern as the four sites #72554 fixes; the tests reuse the ``capture_orm_selects`` helper that PR introduces. * Also assert the returned row on the previous-TI regression test (cherry picked from commit ff83957) Co-authored-by: Pierre Jeambrun <pierrejbrun@gmail.com>

* Bound remaining single-row lookups with .limit(1) Two more callers of ``session.scalars(...).first()`` / ``session.execute(select(...)).first()`` were still missing an explicit ``.limit(1)``. Because SQLAlchemy 2.0's ``Result.first()`` does not add one (unlike the legacy ``Query.first``), each call sends every matching row to the Python process and discards all but the first. The favorite existence check is bounded to a single row per (dag_id, user_id) by the schema, but the previous-TI lookup scans every earlier matching TI. Introduced independently of apache#52325's migration: get_previous_task_instance came in apache#59712, unfavorite_dag's existence probe in apache#51264. Same anti-pattern as the four sites apache#72554 fixes; the tests reuse the ``capture_orm_selects`` helper that PR introduces. * Also assert the returned row on the previous-TI regression test

…73411) * Document the 409 on favorite_dag and return a readable conflict message favorite_dag returns 409 when the Dag is already a favorite, and its test has asserted that since #51264, but the response was never declared, so it is missing from the OpenAPI spec and every client generated from it. The 409 also came from the generic unique-constraint handler, so a repeat favorite answered "Serious error when handling your request" and logged an error, while unfavorite_dag answers "Dag is not marked as favorite". Check for the row first, as unfavorite_dag does, and declare the 409. * Drop the unfavorite body assertion It pinned behaviour this change does not touch, which the review guidelines count as padding rather than coverage.

PNL0 requested review from XD-DENG, ashb, bbovenzi, bugraoz93, ephraimbuddy, jason810496, jscheffl, kaxil, pierrejeambrun, potiuk, rawwar, ryanahamilton and shubhamraj-git as code owners May 31, 2025 16:21

boring-cyborg Bot added area:airflow-ctl area:API Airflow's REST/HTTP API area:UI Related to UI/UX. For Frontend Developers. labels May 31, 2025

jscheffl reviewed Jun 1, 2025

View reviewed changes

Comment thread airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx Resolved

jscheffl reviewed Jun 1, 2025

View reviewed changes

jason810496 reviewed Jun 2, 2025

View reviewed changes

pierrejeambrun reviewed Jun 2, 2025

View reviewed changes

bbovenzi reviewed Jun 4, 2025

View reviewed changes

Comment thread airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDagCard.tsx Resolved

bbovenzi reviewed Jun 4, 2025

View reviewed changes

Comment thread airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx Resolved

bbovenzi reviewed Jun 4, 2025

View reviewed changes

Comment thread airflow-core/src/airflow/ui/src/components/DagActions/FavoriteDagButton.tsx Resolved

bbovenzi added this to the Airflow 3.1.0 milestone Jun 4, 2025

pierrejeambrun reviewed Jun 10, 2025

View reviewed changes

pierrejeambrun reviewed Jun 20, 2025

View reviewed changes

Comment thread airflow-core/src/airflow/ui/src/pages/DagsList/DagsList.tsx Resolved

PNL0 force-pushed the feature branch from 65dc2b6 to 4bae14f Compare June 22, 2025 19:25

PNL0 and others added 10 commits July 7, 2025 14:58

Develop favorite filter.

1086f97

Create new tests for the favorite/unfavorite endpoints. Add favorite button to the dag header. Other small fixes. Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt>

Create new filters and update the frontend to use the UI version of g…

73fb03c

…et_dags.

Small fixes.

d7d4680

Small fixes.

55c3176

Co-authored-by: Mariana Isabel Marçal Santana <mariana.marcal.santana@tecnico.ulisboa.pt>

Rebase and small fix

461a062

Fix issues

7c2b4c0

Fixed error in CI pipeline

48389da

Fixed errors in CI pipeline.

ba54bda

Fix CI pipeline issues.

e7b27b8

Regeneration of front-end types

c0e1984

PNL0 force-pushed the feature branch from da08a99 to c0e1984 Compare July 7, 2025 14:29

pierrejeambrun merged commit c1a89ae into apache:main Jul 7, 2025

pierrejeambrun mentioned this pull request Sep 8, 2026

Bound remaining single-row lookups with .limit(1) #72699

Merged

1 task done

vsima mentioned this pull request Sep 20, 2026

Document favorite_dag's 409 and return a readable conflict message #73411

Merged

1 task done

yuseok89 mentioned this pull request Oct 14, 2026

UI: Keep unnamed columns out of the table columns menu #74774

Merged

1 task done

Conversation

PNL0 commented May 31, 2025

Uh oh!

Uh oh!

jscheffl left a comment

Choose a reason for hiding this comment

Uh oh!

jason810496 left a comment

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PNL0 commented Jun 5, 2025

Uh oh!

pierrejeambrun left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PNL0 commented Jun 18, 2025

Uh oh!

pierrejeambrun left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

boring-cyborg Bot commented Jul 7, 2025

Uh oh!

pierrejeambrun commented Jul 7, 2025

Uh oh!

pierrejeambrun commented Jul 7, 2025

Uh oh!

bugraoz93 commented Jul 7, 2025

Uh oh!

jscheffl commented Jul 7, 2025

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

PNL0 commented Jul 7, 2025 •

edited

Loading