Add support for favorite/pin dags to dashboard #51264

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

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx

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

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

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

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx

airflow-core/src/airflow/ui/src/components/DagActions/FavoriteDagButton.tsx

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.

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

airflow-core/src/airflow/api_fastapi/core_api/datamodels/dags.py

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_dags.py

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

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx

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

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

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_dags.py

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

PNL0 · 2025-06-22T19:40:54Z

Hello @pierrejeambrun,

I just pushed a new commit.
All your requests should be solved, but let me know if I missed anything.

pierrejeambrun

Nice, a few suggestions but that's looking great 🎉

airflow-core/src/airflow/api_fastapi/common/parameters.py

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

airflow-core/src/airflow/api_fastapi/core_api/openapi/v2-rest-api-generated.yaml

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx

PNL0 · 2025-06-25T18:46:07Z

Hello @pierrejeambrun,

Your requests should be fixed.
Let me know if everything is as expected.

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx

airflow-core/src/airflow/ui/src/queries/useFavoriteDag.ts

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

PNL0 · 2025-06-26T09:51:12Z

Hello @bbovenzi,

I just pushed some changes that should cover your requests.
Let me know if everything is ok.

airflow-core/src/airflow/ui/src/components/DagActions/FavoriteDagButton.tsx

bbovenzi

Looks like we need a rebase too

PNL0 · 2025-06-27T09:16:12Z

Hello @bbovenzi,

The rebase is done.

pierrejeambrun

This is looking really promising, and I think users will love it.

A few suggestions and things to fix before we can merge

We need to fix it for FabAuthManager. If you run breeze with --auth-manager FabAuthManager you will see that the server returns error 500. (apparently we need to cast the user_id at some point because SQLAchemy is not happy about it)

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

airflow-core/src/airflow/ui/src/pages/Dag/Header.tsx

PNL0 · 2025-06-30T13:51:29Z

Hello @pierrejeambrun,

I just pushed some changes that should resolve the issues you pointed out.
I did a rebase to fix some conflicts, but you can see the changes in the last commit.

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

…ssions. Co-authored-by: Mariana Isabel Marçal Santana [email protected]

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

The favorited DAGs by an user, are stored persistently in the database. Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

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 <[email protected]>

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

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 <[email protected]>

…et_dags.

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

PNL0 requested review from bbovenzi, pierrejeambrun, ryanahamilton, jscheffl, shubhamraj-git, bugraoz93, kaxil, potiuk, ephraimbuddy, rawwar, jason810496, XD-DENG and ashb 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

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDags.tsx Outdated Show resolved Hide 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

airflow-core/src/airflow/ui/src/pages/Dashboard/FavoriteDags/FavoriteDagCard.tsx Outdated Show resolved Hide resolved

bbovenzi reviewed Jun 4, 2025

View reviewed changes

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

bbovenzi reviewed Jun 4, 2025

View reviewed changes

airflow-core/src/airflow/ui/src/components/DagActions/FavoriteDagButton.tsx Show resolved Hide 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

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

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

pierrejeambrun reviewed Jun 24, 2025

View reviewed changes

bbovenzi reviewed Jun 25, 2025

View reviewed changes

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

bbovenzi reviewed Jun 25, 2025

View reviewed changes

airflow-core/src/airflow/ui/src/queries/useFavoriteDag.ts Outdated Show resolved Hide resolved

bbovenzi reviewed Jun 25, 2025

View reviewed changes

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

bbovenzi reviewed Jun 26, 2025

View reviewed changes

airflow-core/src/airflow/ui/src/components/DagActions/FavoriteDagButton.tsx Outdated Show resolved Hide resolved

bbovenzi reviewed Jun 26, 2025

View reviewed changes

PNL0 force-pushed the feature branch from 9a5db59 to 7811c20 Compare June 27, 2025 09:10

pierrejeambrun reviewed Jun 27, 2025

View reviewed changes

PNL0 and others added 14 commits June 30, 2025 15:08

Add support for favorite/pin dags to dashboard, using localStorage.

7f965df

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

Add support for favorite/pin dags to dashboard, persistent between se…

26050bf

…ssions. Co-authored-by: Mariana Isabel Marçal Santana [email protected]

Implement unit tests

a1cf558

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

Add support for favorite/pin dags to dashboard.

7fe9e1e

The favorited DAGs by an user, are stored persistently in the database. Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

Added no favorites message.

f981a75

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 <[email protected]>

Rebase and minor fixes.

7f806f8

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

Use i18n module and fix DB migration.

6874cf5

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

Review API endpoints

f65e181

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

Develop favorite filter.

a2098a2

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 <[email protected]>

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

0a55143

…et_dags.

Small fixes.

42f3a50

Small fixes.

aa021fc

Co-authored-by: Mariana Isabel Marçal Santana <[email protected]>

Rebase and small fix

97f0035

Fix issues

48cb0fd

PNL0 force-pushed the feature branch from 33dc74c to 48cb0fd Compare June 30, 2025 14:12

Add support for favorite/pin dags to dashboard #51264

Are you sure you want to change the base?

Add support for favorite/pin dags to dashboard #51264

Uh oh!

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 Jun 22, 2025

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PNL0 commented Jun 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PNL0 commented Jun 26, 2025

Uh oh!

Uh oh!

bbovenzi left a comment

Choose a reason for hiding this comment

Uh oh!

PNL0 commented Jun 27, 2025

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!

Uh oh!

Uh oh!

Uh oh!

pierrejeambrun left a comment •

edited

Loading

pierrejeambrun left a comment •

edited

Loading

PNL0 commented Jun 30, 2025 •

edited

Loading