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.

Sign up for GitHub

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

Jump to bottom

Upgrade React Router #1349

Merged
merged 116 commits into from
Dec 20, 2023
Merged

Upgrade React Router #1349

merged 116 commits into from
Dec 20, 2023

Conversation

labkey-alan
Copy link
Contributor

@labkey-alan labkey-alan commented Nov 16, 2023 •
edited
Loading

Rationale

This PR upgrades React Router from 3.x to 6.x and bumps components version to 3.0.0.

Related Pull Requests

Changes

  • Breaking Changes:
    • Upgrade react-router dependency to react-router-dom version 6.x
      • If you use react-router you will need to upgrade
      • If you have history pinned in your dependencies you should remove it
    • withQueryModels updated to be compatible with React Router 6.x
  • Other Changes:
    • Note: all other changes listed here have to do with our upgrade of React Router, they're not considered breaking because they are all on our internal APIs which you should not be using
    • URL helpers:
      • use ReactRouter SetURLSearchParams instead of InjectedRouter and Location
      • remove resetParameters
      • remove Location type
      • add getQueryParams
    • Add withRouterDeprecated
      • This is a wrapper that is very similar to withRouter, which no longer exists, in order to ease the transition to React Router 6
    • Update components to use React Router Hooks
    • Don't export UsersGridPanel or PermissionAssignments

@labkey-alan labkey-alan self-assigned this Nov 16, 2023
@labkey-alan labkey-alan force-pushed the fb_upgrade_react_router branch 2 times, most recently from 7081abd to 5233f63 Compare November 30, 2023 23:20
labkey-nicka
labkey-nicka reviewed Dec 1, 2023
View reviewed changes
Copy link
Contributor

@labkey-nicka labkey-nicka left a comment

Choose a reason for hiding this comment

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

Looks good so far.

packages/components/src/internal/util/URL.ts Show resolved Hide resolved
packages/components/src/internal/actions.ts Outdated Show resolved Hide resolved
packages/components/src/internal/actions.ts Outdated Show resolved Hide resolved
packages/components/src/internal/actions.ts Outdated Show resolved Hide resolved
packages/components/src/internal/app/models.ts Outdated Show resolved Hide resolved
packages/components/src/internal/components/project/CreateProjectPage.tsx Outdated Show resolved Hide resolved
packages/components/src/internal/url/URLResolver.ts Show resolved Hide resolved
packages/components/src/internal/url/URLResolver.ts Outdated Show resolved Hide resolved
packages/components/src/internal/url/URLResolver.ts Outdated Show resolved Hide resolved
packages/components/src/internal/withRouterDeprecated.tsx Outdated Show resolved Hide resolved
@labkey-alan labkey-alan force-pushed the fb_upgrade_react_router branch from 7136c05 to 37dc6e0 Compare December 4, 2023 22:02
@labkey-alan labkey-alan force-pushed the fb_upgrade_react_router branch from 50954f6 to 02e7e9a Compare December 5, 2023 23:39
@labkey-alan labkey-alan mentioned this pull request Dec 6, 2023
Merged
@labkey-alan labkey-alan force-pushed the fb_upgrade_react_router branch 4 times, most recently from efd0251 to cbbe073 Compare December 18, 2023 15:44
@labkey-alan labkey-alan marked this pull request as ready for review December 18, 2023 16:10
@labkey-alan
ProductMenu: Don't use routes
2e8fc0c
@labkey-alan
NavigationBar: Don't use routes from React Router
560ea51
@labkey-alan
Remove react-router, add react-router-dom, remove history
f760b01
@labkey-alan
ProductMenu: improve helpers
46321d8
@labkey-alan
Don't export Location
09a725b
@labkey-alan
Add withRouterDeprecated
783108a 
A convenience wrapper to help us transition from react-router 3 to 6. It is not a fully backwards compatible change, but it is mostly backwards compatible.
@labkey-alan
Temporarily disable useRouteLeave
7c3a24b
@labkey-alan
Query pages: use RR hooks
61e0715
@labkey-alan
SubNav/NavItem: use RR hooks
1666c3f
@labkey-alan
ProductMenu: use RR hooks
9733f72
@labkey-alan
ProfilePage: don't use withRouter
2a2c9cd
@labkey-alan
AuditQueriesListingPage: Use RR hooks
0d1e4cf
@labkey-alan
UsersGridPanel: Use RR hooks
cc2394c
@labkey-alan
URL.ts: Update util methods to use setURLSearchParams instead of rout…
d4f08ed 
…er and location
@labkey-alan
mockUtils: Update createMockRouterProps to make a DeprecatedRouter
a595b21
@labkey-alan
Fix withQueryModels tests
de9231a
@labkey-alan
Fix AdminSettingsPage tests
583fe2a
@labkey-alan
Fix ProductMenu tests
8fe9a5f
@labkey-alan
Fix ProductMenuSection tests
cc4c28c
@labkey-alan
remove explicit calls to mock react-router-dom
91c5550
@labkey-alan
Fix CreateProjectPage tests
d2bca6a
@labkey-alan
Fix withAssayModels tests
499d820
@labkey-alan
Fix getHeaderMenuSubtitle tests
8978efb
@labkey-alan
Fix tests for useAdministrationSubNav
88dbe28
@labkey-alan
Remove unused imports
f4a329e
@labkey-alan
Remove unused imports
8017877
@labkey-alan
Add normalizr, @remix-run/router to externals for package build
d51d6dc
@labkey-alan
Bump build version
01cbbf2
@labkey-alan
Don't export unused search components, export additional search types
5219580
@labkey-alan
ReleaseNote: Use RR6
00ab718
@labkey-alan
withAssayModels: update comment
85b5079
@labkey-alan
Add unit tests for getQueryParams
c813d45
@labkey-alan
Generate Link components for empty sections
2cdf4bd
@labkey-alan
ProductMenuSection: Fix issue with empty link generation
72aa3f8
@labkey-alan
Remove console.log
7403d65
@labkey-alan
UserDetailsPanel: generate correct manage URLs
14aa397
@labkey-alan
UserDetailsPanel: use project from server context
e459e7f
@labkey-alan labkey-alan force-pushed the fb_upgrade_react_router branch from c332a95 to e459e7f Compare December 19, 2023 20:37
@labkey-alan labkey-alan merged commit a21e0a8 into develop Dec 20, 2023
@labkey-alan labkey-alan deleted the fb_upgrade_react_router branch December 20, 2023 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cnathe cnathe cnathe left review comments

@labkey-nicka labkey-nicka labkey-nicka approved these changes

Assignees

@labkey-alan labkey-alan

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@labkey-alan @labkey-nicka @cnathe