OCPBUGS-53200: Fix highlighting nav items with nested routes

[aptmac]

Hi! I've been working on porting over an application to be a dynamic plugin, and ran into a nav highlighting issue where if a nested route existed for another nav item then both of them would be highlighted. At the moment I have some code in our plugin that corrects the highlighting, but it would be nicer if this solution was baked into the console.

For example, our application (cryostat) has a landing page which displays dashboards. In our original web app we want this to be the entry point, so it uses the route "/cryostat". In our nav we have a "Dashboard" item, that routes to "/cryostat", alongside all the other nav items that route to other pages.

When working on the console plugin we found that if we visited any other page, lets say "/cryostat/about" for example, then both nav items for "Dashboard" and "About" would be highlighted. This is because the current logic tries to match the href and location fragments, and returns true for both nav items because of our nested route.

I posted a question about this on Slack and was pointed at the code here, so here's a change that will make the highlighting logic match the scopeless href to scopeless location in order to avoid nested routes from being highlighted.

Before

After

[openshift-ci]

Hi @aptmac. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[logonoff]

/ok-to-test

Nice! Do you mind opening an OCPBUGS, with Management Console in the component/s field, so this can be backported?

https://issues.redhat.com/projects/OCPBUGS/issues

[openshift-ci]

@aptmac: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/okd-scos-e2e-aws-ovn	7835b95	link	false	/test okd-scos-e2e-aws-ovn

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[aptmac]

/ok-to-test

Nice! Do you mind opening an OCPBUGS, with Management Console in the component/s field, so this can be backported?

https://issues.redhat.com/projects/OCPBUGS/issues

Sure! I've opened: https://issues.redhat.com/browse/OCPBUGS-53200

[logonoff]

/retitle OCPBUGS-53200: Fix highlighting nav items with nested routes

[openshift-ci-robot]

@aptmac: This pull request references Jira Issue OCPBUGS-53200, which is invalid:

• expected the bug to target the "4.19.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Hi! I've been working on porting over an application to be a dynamic plugin, and ran into a nav highlighting issue where if a nested route existed for another nav item then both of them would be highlighted. At the moment I have some code in our plugin that corrects the highlighting, but it would be nicer if this solution was baked into the console.

For example, our application (cryostat) has a landing page which displays dashboards. In our original web app we want this to be the entry point, so it uses the route "/cryostat". In our nav we have a "Dashboard" item, that routes to "/cryostat", alongside all the other nav items that route to other pages.

When working on the console plugin we found that if we visited any other page, lets say "/cryostat/about" for example, then both nav items for "Dashboard" and "About" would be highlighted. This is because the current logic tries to match the href and location fragments, and returns true for both nav items because of our nested route.

I posted a question about this on Slack and was pointed at the code here, so here's a change that will make the highlighting logic match the scopeless href to scopeless location in order to avoid nested routes from being highlighted.

Before

After

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[logonoff]

/jira refresh
/lgtm

/cc @jhadvig

[openshift-ci-robot]

@logonoff: This pull request references Jira Issue OCPBUGS-53200, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.19.0) matches configured target version for branch (4.19.0)
• bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

In response to this:

/jira refresh
/lgtm

/cc @jhadvig

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: aptmac, logonoff
Once this PR has been reviewed and has the lgtm label, please assign vikram-raj for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• frontend/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment