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

fix(browse): Fixing browse path to remove requirement for simple name suffix #5634

Merged

Conversation

jjoyce0510
Copy link
Collaborator

@jjoyce0510 jjoyce0510 commented Aug 12, 2022

Summary

For historical reasons, browse paths have always required to end with a "simple name". For example,

/my/custom/path/SimpleName.

In the UI, we've been hiding the final path component, and instead redirecting users directly to the entity which is associated with the SimpleName.

We've recently classified this legacy behavior as a bug in DataHub which needs to be addressed in order for browse to work as users expect. Users expect to be able to provide a simple path which omits the final "simple name", for example:

/my/custom/path and simply be able to view the entity under that path. This PR adds exactly that capability, while also solving a longstanding known issue where a single entity cannot have > 1 browse path.

The implications are that existing browse paths will no longer behave as the previously have, requiring a single additional click to navigate to any given entity. In order to address this, we've included an optional upgrade which can be configured using a runtime environment variable on the datahub-gms pod:

UPGRADE_DEFAULT_BROWSE_PATHS_ENABLED=true

A more detailed description is coming in a dedicated doc that will describe the issue and our solving of the issue.

Status

Ready for review.

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@jjoyce0510 jjoyce0510 changed the title fix(browse): Fixing browse path to remove requirement for suffix fix(browse): Fixing browse path to remove requirement for simple name suffix Aug 12, 2022
@github-actions
Copy link

github-actions bot commented Aug 12, 2022

Unit Test Results (build & test)

521 tests  +4   521 ✔️ +4   14m 14s ⏱️ + 5m 51s
122 suites +1       0 💤 ±0 
122 files   +1       0 ±0 

Results for commit a2cc7cc. ± Comparison against base commit aa146db.

♻️ This comment has been updated with latest results.

## Support

The Acryl team will be on standby to assist you in your migration. Please
join [#release-0_8_0](https://datahubspace.slack.com/archives/C0244FHMHJQ) channel and reach out to us if you find
Copy link
Contributor

Choose a reason for hiding this comment

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

looks like this channel has been deleted. should we just pick one that already exists?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

lol yes

case Constants.CHART_ENTITY_NAME:
ChartKey chartKey = (ChartKey) EntityKeyUtils.convertUrnToEntityKey(urn, getKeySchema(urn.getEntityType(), entityRegistry));
return ("/" + chartKey.getDashboardTool());
case Constants.DASHBOARD_ENTITY_NAME: // TODO -> Improve the quality of our browse path here.
Copy link
Contributor

Choose a reason for hiding this comment

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

i think the answer here might lie in providing a container to dashboards, data flows and datajobs rather than improve the urn-based browse path generation

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah absolutely - we need containers for these.

@jjoyce0510 jjoyce0510 merged commit d15518f into datahub-project:master Sep 7, 2022
shirshanka pushed a commit to shirshanka/datahub that referenced this pull request Sep 8, 2022
shirshanka pushed a commit to shirshanka/datahub that referenced this pull request Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants