feat: new categoryPageId attribute #206
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
htuzel
approved these changes
Dec 5, 2024
sbellone
added a commit
that referenced
this pull request
Dec 9, 2024
Until today, we had the following list of default attributes: `'name', 'categories', 'primary_category_id', '__primary_category', 'in_stock', 'price', 'image_groups', 'url'` Some of them are not used by our default UI and are not following Algolia latest guidelines. We want to replace of remove them: - replace `categories` by the new `categoryPageId` attribute introduced in #206 - remove the `primary_category_id` attribute - remove the undocumented `_tags` attribute: `_tags` are a built-in way to do filtering in Algolia, but ours only contains the product id and are not used Now, the default list of attributes will be: `'name', 'categoryPageId', '__primary_category', 'in_stock', 'price', 'image_groups', 'url'` The former attribute definitions are kept, so if users rely on them, they can add them to their Additional Product Attributes and their records will stay unchanged. ### Changes - added proper attribute handler for `__primary_category`. Before, it was hardcoded in the `algoliaLocalizedProduct` function and computed from the `categories` attribute. Now it's directly computed from the SFCC product. - updated the `defaultAttributes_v2` list - updated tests --- SFCC-402
htuzel
pushed a commit
that referenced
this pull request
Dec 10, 2024
Implement [Category Pages](https://www.algolia.com/doc/guides/solutions/ecommerce/browse/tutorials/category-pages/) using the `categoryPageId` added in #206. This is done by adding a `filters` on the InstantSearch configuration ([doc](https://www.algolia.com/doc/guides/solutions/ecommerce/browse/tutorials/category-pages/#build-a-user-interface-with-instantsearch-js)) For categories pages, the `hierarchicalMenu` are not displayed anymore. This is on purpose, a category page is a standalone page of a single category. ### Changes - Pass the `categoryId` to the `enableInstantSearch` options - add a `filters` on `categoryPageId` when the `categoryId` is present - add the hierarchical menus otherwise (if we are on the search results page) - Remove the `breadcrumb` widget. The category title not be updated by InstantSearch anymore, it will be updated when the user browses another category ### How to test - Reindex products using the latest version from `develop`, to have the `categoryPageId` in the records - Browse categories using the top menu --- SFCC-407
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.
To be compatible with Category Merchandising, we are introducing a new attribute:
categoryPageIdIt follows the official recommendations described in this doc:
https://www.algolia.com/doc/guides/solutions/ecommerce/browse/tutorials/category-pages/#add-a-category-identifying-attribute-to-each-record
The only difference is that instead of using localized paths ("Womens", "Womens > Clothing"), we will use the categories ids:
This permits to keep the same ids across all indices, while still being human readable.
Changes
categoryPageIdnewarrivalscategory was not markedonlineand was missing from the existing snapshotsSFCC-401