Skip to content
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.

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

Enhance User Experience by Opening external UI Links in new Tab on browser. #40635

Merged
merged 12 commits into from
Jul 9, 2024

Conversation

VICIWUOHA
Copy link
Contributor

@VICIWUOHA VICIWUOHA commented Jul 7, 2024


DESCRIPTION

In the Airflow UI today, a couple of pages on the Menu bar have links that point to external Apache Airflow related links eg; documentation/github Repo as outlined here .

Issue:
At the moment, when a user clicks on them, it literally removes you from the UI on the same browser tab. Users now need to click back to return to the UI, it gets more tricky when you've clicked so many links on the docs page. This is same for the prompt that comes up when no webserverSecretKey has been set.

Included: Also open provider links in new tab.

Proposed Solution:
Simply enrich the html tags to open in a new tab, easier to modify this via jinja.

Concerns: As at today, we have very few external links directly in the Menu Bar. Coincidentally containing "apache", if this changes in future, then users would experience the same issue.

  • For third party provider links, this implementation ensures that no referrer/origin information is sent to the external website, improving security of user platforms.

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 newsfragments.

@boring-cyborg boring-cyborg bot added area:helm-chart Airflow Helm Chart area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues labels Jul 7, 2024
Copy link

boring-cyborg bot commented Jul 7, 2024

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@VICIWUOHA
Copy link
Contributor Author

Still Finalizing tests on this.

@VICIWUOHA
Copy link
Contributor Author

May need to modify the test tests/www/views/test_views.py::test__clean_description to include target="_blank" rel="noopener noreferrer"

@VICIWUOHA
Copy link
Contributor Author

Have updated tests to validate this new behaviour.

New UI Link functionality in gif below.

Screen Recording 2024-07-07 at 16 (3)

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

I looked closer - small thing requested - to be more precise with URL prefix check rather than apache in the name,

@potiuk potiuk merged commit 270aa11 into apache:main Jul 9, 2024
64 checks passed
Copy link

boring-cyborg bot commented Jul 9, 2024

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

@utkarsharma2 utkarsharma2 added the type:improvement Changelog: Improvements label Jul 12, 2024
@utkarsharma2 utkarsharma2 added this to the Airflow 2.10.0 milestone Jul 12, 2024
romsharon98 pushed a commit to romsharon98/airflow that referenced this pull request Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:helm-chart Airflow Helm Chart area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues type:improvement Changelog: Improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants