This repository has been archived by the owner on Dec 30, 2022. It is now read-only.
fix(sffv): clamp maxFacetHits to the allowed range #1696
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
|
Deploy preview for react-instantsearch ready! Built with commit ed44141 https://deploy-preview-1696--react-instantsearch.netlify.com |
Haroenv
reviewed
Oct 27, 2018
| function onSearchForFacetValues({ facetName, query, maxFacetHits = 10 }) { | ||
| // The values 1, 100 are the min / max values that the engine accepts. | ||
| // see: https://www.algolia.com/doc/api-reference/api-parameters/maxFacetHits | ||
| const maxFacetHitsWithinRange = Math.max(1, Math.min(maxFacetHits, 100)); |
There was a problem hiding this comment.
Do we have this issue as well in InstantSearch.js?
There was a problem hiding this comment.
We have kinda the same issue, but it's less visible because we don't use the showMore option to conditionally pick the value for maxFacetHits.
Haroenv
approved these changes
Oct 29, 2018
samouss
force-pushed
the
fix/sffv-max-hits
branch
from
7043274 to
ed44141
Compare
samouss
added a commit
that referenced
this pull request
Oct 30, 2018
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.
Summary
With the current implementation the value used for
maxFacetHitsis the default limit of the widget or the user provided value. It's fine for most cases, but it happens that the value provided by the user is higher than 100. This leads to an issue because the Algolia engine only accepts values between 1 - 100. When the value is not in that range the API throws an error.I chose to fix the issue inside InstantSearch rather than in the helper because it feels odd (to me) to change the value on behalf of the user. The helper can be directly manipulate by users so it makes sense to throw an error if the value is invalid. With InstantSearch it's a bit different we use the helper, they don't have any knowledge of it. Since we allow any value for the limit it makes sense to send the correct a value to the API.
The fix clamp the provided value in the range 1, 100. I've also create a default value of 10 for the
maxFacetHitsin case no value is provided. It avoid to gets aNaNvalue fromMath.{min,max}. It doesn't breaks anything because10is the default value on the engine.Before
After