refactor: rename /dashboards and /resources redirect path helpers
#3748
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Code Climate has analyzed commit 1667d68 and detected 0 issues on this pull request. View more on Code Climate. |
Paul-Bob
reviewed
Mar 19, 2025
There was a problem hiding this comment.
Thanks for submitting this PR, @dark-panda!
I've left a suggestion, could you check if it works for your use case?
This approach retains the route with a different path helper method, preventing breaking changes for users who might be relying on the existing route.
Thanks!
config/routes.rb
Outdated
| @@ -2,7 +2,6 @@ | |||
| root "home#index" | |||
|
|
|||
| get "resources", to: redirect(Avo.configuration.root_path) | |||
There was a problem hiding this comment.
Suggested change
| get "resources", to: redirect(Avo.configuration.root_path) | |
| get "resources", to: redirect(Avo.configuration.root_path), as: :avo_resources_redirect | |
| get "dashboards", to: redirect(Avo.configuration.root_path), as: :avo_dashboards_redirect |
This route is sort of duplicated with the root route in the `avo-dashboards` gem which defines a similarly unused route by default. Having two identically named routes may result in unpredictable behaviour outside of Avo when named routes are being used for things like client-side routing.
dark-panda
force-pushed
the
fix-dashboard-routes
branch
from
c4fa34b to
1667d68
Compare
Paul-Bob
changed the title
/dashboards/dashboards and /resources redirect path helpers
|
I did not know about that gem @dark-panda. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This route is sort of duplicated with the root route in the
avo-dashboardsgem which defines a similarly unused route by default. Having two identically named routes may result in unpredictable behaviour outside of Avo when named routes are being used for things like client-side routing.Description
Renames the path helpers for the redirect routes
/dashboardsand/resources.Checklist:
Manual review steps
This issue was discovered via an edge case scenario where using the js-routes gem (https://github.com/railsware/js-routes) produces invalid JavaScript where the
avoDashboardsPathroute was being generated twice -- once by the route inconfig/routes.rband once in theavo-dashboardsgem. This leads to two identically named routes being set up in Rails, which causes two identically named routes to be produced by js-routes. When js-routes produces two identically named constants, it results in an invalid JavaScript file.To see this behaviour in js-routes:
js-routesgem to a Rails applicationGemfilerake js:routesroutes.jsfile for multiple instances ofavoDashboardsPath. There should only be one.