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

[BUG] Not all default routes are translated correctly when upgrading to Dashboards #665

Open
tmarkley opened this issue Jul 23, 2021 · 4 comments
Labels
backwards-compatibility bug Something isn't working technical debt If not paid, jeapardizes long-term success and maintainability of the repository. v3.0.0

Comments

@tmarkley
Copy link
Contributor

Describe the bug

When upgrading from ODFE 1.x or Kibana 7.x to Dashboards 1.0, not all default routes are migrated to the new routes if names have changed.

To Reproduce
Steps to reproduce the behavior:

  1. Follow the BWC testing instructions but use a default route such as /app/opendistro-alerting or /app/kibana#/dashboard/722b74f0-b882-11e8-a6d9-e546fe2bba5f
  2. Upgrade to Dashboards 1.0
  3. Notice the 404 when loading for the first time. There is no option provided to the customer to fix this.
  4. The user must manually edit the URL to access Dashboards.

Expected behavior
Some initial ideas:

  • Generic translation that takes anything with opendistro or kibana and replaces with the dashboards equivalent
  • Have a list of equivalent routes for all known routes in ODFE or Kibana that changed in Dashboards and execute a replace for the user's default route.
  • Have an automated check for a default route that 404's and revert back to the default.
    • OR if the default route 404's, let the user choose the correct default route before continuing so that it can be fixed.

OpenSearch Version
1.0.0

Dashboards Version
1.0.0

Plugins

N/A

@kavilla
Copy link
Member

kavilla commented Jul 26, 2021

  • Generic translation that takes anything with opendistro or kibana and replaces with the dashboards equivalent
  • Have a list of equivalent routes for all known routes in ODFE or Kibana that changed in Dashboards and execute a replace for the user's default route.

For the original, I was too worried about generically replacing kibana/opendistro.

The third option we could revert it back to default or I was thinking have a button that lets them go back to app home and potentially another button to take them to settings?

What do you think @tmarkley ? @ahopp as well.

@tmarkley
Copy link
Contributor Author

I like giving the user options. Would we want to edit the 404 experience in general so that in all cases they have the ability to go back to app home or settings?

I'd be hesitant to revert it back to default without asking the user first.

@kavilla
Copy link
Member

kavilla commented Jul 28, 2021

I'd be hesitant to revert it back to default without asking the user first.

Same.

It could be easy to provide a button to app home but it might be difficult to determine if the user got to the 404 page because their default route took them there or some other way.

@kavilla
Copy link
Member

kavilla commented Apr 5, 2022

Looked into this and was not a trivial solution. Likely not achievable for 2.0.0

@kavilla kavilla added v3.0.0 and removed v2.0.0 labels Apr 5, 2022
@tmarkley tmarkley added the technical debt If not paid, jeapardizes long-term success and maintainability of the repository. label May 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backwards-compatibility bug Something isn't working technical debt If not paid, jeapardizes long-term success and maintainability of the repository. v3.0.0
Projects
None yet
Development

No branches or pull requests

3 participants