-
Notifications
You must be signed in to change notification settings - Fork 2
fix(deps): update react-router monorepo to v6 (major) #3563
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @asajjad2, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request performs a substantial upgrade of the application's routing system by migrating from React Router v4 to v6. This involves a comprehensive refactoring of how routes are defined and handled throughout the codebase, ensuring compatibility with the new major version's API while preserving all existing navigation functionality.
Highlights
- Dependency Upgrade: Upgraded
react-routerandreact-router-domfrom version 4 to version 6 (specifically6.30.1), which is a major version update requiring significant API changes. - API Modernization: Replaced
Switchcomponents withRoutes,Redirectcomponents withNavigate, and updatedRoutedefinitions to use theelementprop instead of thecomponentprop, aligning with React Router v6's new API. - Hooks Adoption: Converted the
ScrollToTopclass component to a functional component, leveraging React Hooks (useEffect,useLocation) for managing scroll behavior based on route changes, replacing thewithRouterHOC. - Routing Logic Adaptation: Modified the
PrivateRoutecomponent's usage pattern to align with React Router v6, where it now wraps child components as elements (<PrivateRoute><ChildComponent /></PrivateRoute>) rather than rendering them directly via thecomponentprop. - Test Updates: Adjusted existing tests, particularly for
PrivateRoute, to reflect the newNavigatecomponent and updated assertions forLinkcomponents in registration pages. - Route Path Refinements: Several route paths within the application, especially in admin, B2B, and login/registration sections, were refined for consistency and clarity.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request upgrades react-router-dom and react-router from v4 to v6. The upgrade includes updating all routing-related code to use the new v6 API. There are several components that need to be updated to be compatible with React Router v6.
static/js/Router.js
Outdated
| } | ||
|
|
||
| export const routes = <Route url="/" component={withTracker(App)} /> | ||
| export const routes = <Route url="/" element={<TrackedApp />} /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| exact | ||
| path={routes.login.forgot.begin} | ||
| element={<ForgotPasswordPages />} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| <Switch> | ||
| <PrivateRoute | ||
| exact | ||
| <Routes> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| const EcommerceAdminPages = () => ( | ||
| <React.Fragment> | ||
| <Switch> | ||
| <Routes> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| <Route | ||
| exact | ||
| path={routes.login.forgot.password} | ||
| element={<LoginForgotPasswordPage />} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
@asajjad2 Could you please rebase this PR and take a look at the issues flagged in the Gemini review to see if they can be addressed? |
1669620 to
c5a305a
Compare
|
We've encountered several key issues after following the migration guide which was preventing rendering of various components:
I've refactored our PrivateRoute from a custom route to a wrapper component and updated parent routes to include trailing wildcards (*) for nested routing. There are also Hot reloading conflicts with react-hot-loader which required temporary disabling, this might need migrating to React Fast Refresh. Prop access changes meant components no longer automatically received history/location/match props, forcing us to use hooks like useNavigate/useLocation or create wrapper components for class components. I've replaced all history.push() calls with the new navigate() function. API changes included replacing the component prop with element (requiring JSX), replacing with , and updating query parameter handling. Route matching has became stricter, breaking a lot existing patterns. Some components are still breaking mainly due to route nesting and private route conflicts, the solution to which I'm looking into. |
|
@asajjad2 should we mark this PR as blocked? |
What are the relevant tickets?
#3541
Description (What does it do?)
This PR upgrades
react-router-domandreact-routerfromv4tov6. The upgrade includes updating all routing-related code to use the new v6 API while maintaining compatibility with our existing React 16.8+ setup.Key changes include:
Switchcomponents withRoutesRedirecttoNavigateuseHistory()calls touseNavigate()elementprop instead ofcomponentprop.All existing routing functionality has been preserved with the new API.
How can this be tested?
Test all major navigation flows in the application: