feat(facets): apply result from facet ordering #4784
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
This adds a new option "facetOrdering" (boolean) to refinementList, menu, hierarchicalMenu which will read facet ordering from the results if available, but fall back to sortBy if no facetOrdering is available. The option facetOrdering defaults to `true` if no sortBy is given, to make it apply out of the box. references: - NLP-110 - [RFC 45](https://github.com/algolia/instantsearch-rfcs/blob/master/accepted/flexible-facet-values.md)
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 53b3745:
|
Haroenv
requested review from
a team,
tkrugg and
francoischalifour
and removed request for
a team
tkrugg
reviewed
Jun 18, 2021
tkrugg
reviewed
Jun 18, 2021
tkrugg
reviewed
Jun 18, 2021
tkrugg
reviewed
Jun 18, 2021
tkrugg
reviewed
Jun 18, 2021
Haroenv
added a commit
to algolia/react-instantsearch
that referenced
this issue
Jun 25, 2021
…mentList & HierarchicalMenu If `facetOrdering` is enabled (the default behaviour), before the default sortBy is used, the result from renderingContent.facetOrdering.values is first checked. If that's present, it will be used to sort the items. You can still change that ordering afterwards with the existing transformItems, so if you are sorting in transformItems, you actually override the sorting done by facet ordering, and won't see the effect. To use facetOrdering, you thus need to remove any sorting done in transformItems. If there is a facetOrdering present in the index, but you don't want to use it for a certain widget, you need to explicitly pass `facetOrdering: false` to the widget or connector References: - [RFC 45](https://github.com/algolia/instantsearch-rfcs/blob/master/accepted/flexible-facet-values.md) - algolia/instantsearch.js#4784 - algolia/algoliasearch-helper-js#822
Haroenv
added a commit
to algolia/react-instantsearch
that referenced
this issue
Jun 28, 2021
…mentList & HierarchicalMenu If `facetOrdering` is enabled (the default behaviour), before the default sortBy is used, the result from renderingContent.facetOrdering.values is first checked. If that's present, it will be used to sort the items. You can still change that ordering afterwards with the existing transformItems, so if you are sorting in transformItems, you actually override the sorting done by facet ordering, and won't see the effect. To use facetOrdering, you thus need to remove any sorting done in transformItems. If there is a facetOrdering present in the index, but you don't want to use it for a certain widget, you need to explicitly pass `facetOrdering: false` to the widget or connector References: - [RFC 45](https://github.com/algolia/instantsearch-rfcs/blob/master/accepted/flexible-facet-values.md) - algolia/instantsearch.js#4784 - algolia/algoliasearch-helper-js#822
Haroenv
added a commit
to algolia/react-instantsearch
that referenced
this issue
Jun 30, 2021
…mentList & HierarchicalMenu If `facetOrdering` is enabled (the default behaviour), before the default sortBy is used, the result from renderingContent.facetOrdering.values is first checked. If that's present, it will be used to sort the items. You can still change that ordering afterwards with the existing transformItems, so if you are sorting in transformItems, you actually override the sorting done by facet ordering, and won't see the effect. To use facetOrdering, you thus need to remove any sorting done in transformItems. If there is a facetOrdering present in the index, but you don't want to use it for a certain widget, you need to explicitly pass `facetOrdering: false` to the widget or connector References: - [RFC 45](https://github.com/algolia/instantsearch-rfcs/blob/master/accepted/flexible-facet-values.md) - algolia/instantsearch.js#4784 - algolia/algoliasearch-helper-js#822
tkrugg
reviewed
Jul 1, 2021
tkrugg
reviewed
Jul 1, 2021
src/widgets/hierarchical-menu/__tests__/hierarchical-menu-test.ts
Outdated
Show resolved
Hide resolved
tkrugg
reviewed
Jul 1, 2021
src/connectors/hierarchical-menu/__tests__/connectHierarchicalMenu-test.ts
Outdated
Show resolved
Hide resolved
Haroenv
added a commit
to algolia/react-instantsearch
that referenced
this issue
Jul 2, 2021
…mentList & HierarchicalMenu If `facetOrdering` is enabled (the default behaviour), before the default sortBy is used, the result from renderingContent.facetOrdering.values is first checked. If that's present, it will be used to sort the items. You can still change that ordering afterwards with the existing transformItems, so if you are sorting in transformItems, you actually override the sorting done by facet ordering, and won't see the effect. To use facetOrdering, you thus need to remove any sorting done in transformItems. If there is a facetOrdering present in the index, but you don't want to use it for a certain widget, you need to explicitly pass `facetOrdering: false` to the widget or connector References: - [RFC 45](https://github.com/algolia/instantsearch-rfcs/blob/master/accepted/flexible-facet-values.md) - algolia/instantsearch.js#4784 - algolia/algoliasearch-helper-js#822
tkrugg
reviewed
Jul 5, 2021
| ${true} | ${undefined} | ${resultsViaFacetOrdering} | ||
| ${false} | ${undefined} | ${resultsViaSortBy} | ||
| ${true} | ${['isRefined']} | ${resultsViaSortBy} | ||
| ${false} | ${['isRefined']} | ${resultsViaSortBy} |
There was a problem hiding this comment.
I think it's be worth picking a sortBy input that yields a different result than the default value (same for connectMenu-test.ts and connectHierarhicalMenu-test.ts). Just having resultsViaSortByDefaultValue and resultsViaSortByIsRefined.
The rational: right now, I could (accidentally) change the implementation to ignore sortBy prop and this test would still pass.
Another test is still going to break, so I don't consider this a blocker, just a safer testing strategy. Not a blocker for this PR.
There was a problem hiding this comment.
Haroenv
added a commit
to algolia/react-instantsearch
that referenced
this issue
Jul 5, 2021
…t & HierarchicalMenu (#3067) * feat(facetOrdering): add a new option "facetOrdering" to Menu, RefinementList & HierarchicalMenu If `facetOrdering` is enabled (the default behaviour), before the default sortBy is used, the result from renderingContent.facetOrdering.values is first checked. If that's present, it will be used to sort the items. You can still change that ordering afterwards with the existing transformItems, so if you are sorting in transformItems, you actually override the sorting done by facet ordering, and won't see the effect. To use facetOrdering, you thus need to remove any sorting done in transformItems. If there is a facetOrdering present in the index, but you don't want to use it for a certain widget, you need to explicitly pass `facetOrdering: false` to the widget or connector References: - [RFC 45](https://github.com/algolia/instantsearch-rfcs/blob/master/accepted/flexible-facet-values.md) - algolia/instantsearch.js#4784 - algolia/algoliasearch-helper-js#822 * clarify
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.
passes facetOrderign to refinementList, menu, hierarchicalMenu which will read facet ordering from the results if available and no sortBy is given, but fall back to sortBy if no facetOrdering is available.
The option facetOrdering defaults to
trueif no sortBy is given, to make it apply out of the box.references: