This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Filter by Stock and Filter by Rating: Fix the potential endless redirection loop when used on a search results page #8784
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
This is required as as removeQueryArgs() function uses decodeURIcomponent method which doesn't encode single quotes (') while it was still encoded in the original URL (%27). So when the single quote was in a query param, for example as a search term, it caused endless redirection loop.
kmanijak
added
type: bug
|
The release ZIP for this PR is accessible via: Script Dependencies ReportThere is no changed script dependency between this branch and trunk. This comment was automatically generated by the TypeScript Errors Report
🎉 🎉 This PR does not introduce new TS errors. |
|
Size Change: +294 B (0%) Total Size: 1.12 MB
ℹ️ View Unchanged
|
…in Filter by Rating
kmanijak
changed the title
kmanijak
changed the title
woocommercebot
requested review from
a team and
nefeline
and removed request for
a team
|
Hey @kmanijak ! Regarding:
Do you mind clarifying in which widget these filters should be added? I added them to the Footer widget (which seems to be the correct one based on your follow-up instruction on item number 5), but when I click on search, none of the filter blocks are rendered. |
I made a mistake and wrote to add a |
Closed
5 tasks
nefeline
approved these changes
Mar 22, 2023
There was a problem hiding this comment.
I made a mistake and wrote to add a Search block, while it has to be a Product Search block which would then show a product result search where filters appear. I'm editing the testing steps. Apologies!
No worries, thanks for clarifying!
Great work here 🎉 ! I can confirm things are working as expected.
Test Results:
Enable TT1 theme
Go to Appearance -> Widgets
Add there Filter by Stock, Filter by Rating, Active Filters and Product Search blocks
Save and go to your store's shop
Your blocks should be available in the footer
✅ Confirmed these blocks are visible in the footer of my shop (the Active filters block is rendered only when a filter is active):
Input in the search term: ' and then some other random terms including letters, numbers, white space, special characters
Expected: there's no endless redirections
✅ Confirmed the search works as expected with no infinite loops.
Screen.Recording.2023-03-22.at.10.00.11.mov
Click on some filters to Filter by Stock and Filter by Rating and confirm there's no redirection loop
✅ Confirmed there's no redirection loop when the filters are used. Sidenote: I noticed that the filter by rating is redirecting to the single product template after search; unsure if this is expected or not, but documenting it just in case:
Screen.Recording.2023-03-22.at.10.03.47.mov
Regarding:
When reviewing please focus on possible security concerns.
I can't think of any potential security issues by adopting this approach, but I would recommend reaching out for a second opinion just in case 👍
danielwrobert
approved these changes
Mar 22, 2023
tarunvijwani
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Issue: #8707
Problem statement
If we have the widget 'Filter Products by Stock' enabled (), when we search products and the string contains the single quote character
', the page gets in an infinite reloading loop.Explanation
Single quote character
'is not encoded bycomponentURIComponentsmethod (docs), while it is encoded in the URL (%27). So in the Filter by Stock and Filter by Rating, when there's a comparison of URL after augmenting the query params, the search param was never matching (s='vss=%27).Solution
The search term is encoded/normalized using
addQueryArgswhich does the encoding under the hood. It's used ONLY for comparison purposes.One caveat is that calling
addQueryArgsfrom@wordpress/urlruns encoding on each of the query param, not only the one that's added.Review
When reviewing please focus on possible security concerns.
Fixes #8707
Screenshots
Testing
Automated Tests
User Facing Testing
'and then some other random terms including letters, numbers, white space, special charactersWooCommerce Visibility
Performance Impact
Changelog