History: add getLocationWithParams method #61823
Merged
Conversation
This file contains 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
jsnajdr
added
[Type] Code Quality
jsnajdr
requested review from
youknowriad,
kevin940726,
jorgefilipecosta and
ntsekouras
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +32 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 29291e1. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9186330670
|
jsnajdr
force-pushed
the
add/history-get-loc-with-params
branch
from
41eeb26
to
96073a0
Compare
youknowriad
reviewed
May 21, 2024
| const { CreatePatternModal, useAddPatternCategory } = unlock( | ||
| editPatternsPrivateApis | ||
| ); | ||
|
|
||
| export default function AddNewPattern() { | ||
| const history = useHistory(); | ||
| const { params } = useLocation(); |
There was a problem hiding this comment.
I personally like the direct hook to retrieve the current route's params. Most routers have a similar hook. React Router has useParams for instance.
|
I can reproduce the crash that forced me to avoid using the location object as cache in this PR too.
There's a |
jsnajdr
force-pushed
the
add/history-get-loc-with-params
branch
from
96073a0
to
105f924
Compare
Yes, I can reproduce this, the hook is infinity-loopy. That's fixable.
What are the other problems? What's different with the weakmap is that each That can be fixed either by fixing the effect hook that calls |
No other problems, it's just that using the map trick instead of weak-map fixed the crash above (while keeping the hook...) |
If that's the solution we want to go with, that's totally good for me, I'm not opinionated on how we do the caching, mainly want to avoid the crash. |
Pushed a fix in 29291e1. The PR should be in a mergeable condition now.
In a callback, however, retrieving the params iteratively is technically more correct. It avoids an unneeded rerender. And more importantly, see how in my PR I was able to eliminate |
ntsekouras
approved these changes
May 22, 2024
|
@jsnajdr can we apply a fix at the framework level instead of the application level, as I assume it might be easy to create this issue again inadvertently. |
|
@youknowriad One framework-level fix that comes to mind would be history.push( ( params ) => ( {
...params,
postId
} );That's elegant and you don't need the extra Many Site Editor navigations are of the kind where you want to preserve all query params and only add or remove some of them. This is probably not very typical in mainstream router applications. For example, in Calypso I never encountered a problem of this kind. |
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jun 4, 2024
* History: add getLocationWithParams method * Fix effect loop in pages dataview
patil-vipul
pushed a commit
to patil-vipul/gutenberg
that referenced
this pull request
Jun 17, 2024
* History: add getLocationWithParams method * Fix effect loop in pages dataview
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.
Add a new method to
historycalledgetLocationWithParams. The method is not really new, I'm just moving the existing function of the same name from theRouterProviderto thehistoryobject.The
RouterProvidercan now just use a very straightforwarduseSyncExternalStorewithout any complications.The method is memoized using a
WeakMapso that an identical input (location) produces an identical output (locationWithParams). In #61741 (comment) @youknowriad writes about the weakmap implementation:but I cannot confirm this. I put logpoints at the place where
locationWithParamsis recomputed, and didn't notice any extra rerenders that shouldn't be there.I'm also updating many places where the
locationWithParamsvalue was used in a non-reactive way, in event handlers and callbacks. Here I'm migrating reactiveuseLocationcalls to imperativehistory.getLocationWithParams()calls. That should save a lot of redundant rerenders. I first noticed this when working on #61230 and now I'm fixing it.This overlaps with #61741 -- depending on which one is merged first, there will be conflicts. But I believe they will be easy to resolve.