fix: avoid changing url when removing filters #1530
Conversation
|
Thanks for the pull request, @DanielVZ96! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1530 +/- ##
=========================================
Coverage ? 92.91%
=========================================
Files ? 1065
Lines ? 20980
Branches ? 4538
=========================================
Hits ? 19494
Misses ? 1413
Partials ? 73 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
@DanielVZ96 Nice work figuring this out! Looks good to me, just have one suggestion which you can ignore if you don't agree.
We can modify the useStateWithUrlSearchParam hook to update the param only if it has changed like so:
// If using the default paramValue, remove it from the search params.
if (paramValue === defaultValue) {
newSearchParams.delete(paramName);
} else if (paramValue !== newSearchParams.get(paramName)){
newSearchParams.set(paramName, paramValue);
}
|
@navinkarkera I also tried that and the issue is that once you enter that callback the URL is going to be reverted to the memoized one regardless of changes to the newSearchParams. |
|
@DanielVZ96 It seems to work fine, i.e., preserves the tab on clearing filters. I might be missing something, how are you testing it? |
|
@navinkarkera do you mean testing this branch, testing master, or testing the lines of code above? |
|
I also tested #1530 (review), and doesn't work for me |
* Makes the Active Tab Key independent from the URL, except for the initial load, where the active tab is set from the url. *Avoids unnecessarily changing SearchParams: Due to a limitation of the useSearchParams react hook, which uses a memoized value for the URL that becomes stale after selecting a tab, it unexpectedly changes the URL value. Unfortunately there's no way to completely avoid this, so if there's a usageKey url param, the hook setter function will be called and the URL will revert to the stale memoized url.
* Makes the Active Tab Key independent from the URL, except for the initial load, where the active tab is set from the url. *Avoids unnecessarily changing SearchParams: Due to a limitation of the useSearchParams react hook, which uses a memoized value for the URL that becomes stale after selecting a tab, it unexpectedly changes the URL value. Unfortunately there's no way to completely avoid this, so if there's a usageKey url param, the hook setter function will be called and the URL will revert to the stale memoized url.
Description
When clearing filters the library authoring page redirects to the first tab that was navigated to. Here's a video for lack of a better explanation:
https://www.loom.com/share/355e907bb767476a8d50c434233bcd23?sid=5349e45e-fe07-4c1d-9d75-f2126cf3fee2
This PR does two things:
Supporting information
Issue: #1524
Private-Ref: https://tasks.opencraft.com/browse/FAL-3971
Testing instructions
(Follow the video above)