Repository navigation
2.12.2
馃弳 Main features
馃拵 Introduction of the Recommender Explain module
This release introduces the Recommender Explain module to help you preview from the Magento Admin interface the behavior of the Elasticsuite Premium Recommender module.
It provides feedback about whether a recommendation is coming from manual selection (from the product edit page) or through the behavioral data based rules and also allows you to test a different configuration for a given recommendation type (Related Products, Upsell, Cross-sell).
We will build up upon this module in the coming releases to add more contextual information (which behavioral rule(s) a product matched, how the score is computed, etc).
You can install that Smile_ElasticsuiteRecommenderExplain module single-handedly by requiring the package smile/module-elasticsuite-recommender-explain through composer with the correct "Elasticsuite Branch-version" syntax, that is
| Magento version | Elasticsuite | Installation |
|---|---|---|
| <2.4.6 | 2.10.x | composer require [--ignore-platform-reqs] smile/module-elasticsuite-recommender-explain ~2.10.0 |
| >=2.4.6 && <2.4.9 | 2.11.x | composer require [--ignore-platform-reqs] smile/module-elasticsuite-recommender-explain ~2.11.0 |
| >=2.4.9 | 2.12.x | composer require [--ignore-platform-reqs] smile/module-elasticsuite-recommender-explain ~2.12.0 |
You will also automatically benefit from the module if you upgrade our Elasticsuite Premium metapackage
| Magento flavour | Metapackage upgrade |
|---|---|
| Community Edition / Magento | composer update --with-all-dependencies smile/elasticsuite-premium-magento |
| Enterprise Edition / Adobe Commerce | composer update --with-all-dependencies smile/elasticsuite-premium-commerce |
As a reminder, to install our metapackage for the first time
- for Community Edition / Magento
| Magento version | Metapackage first-time install in Community Edition / Magento |
|---|---|
| <2.4.6 | composer require [--ignore-platform-reqs] --with-all-dependencies smile/elasticsuite-premium-magento ~2.10.0 |
| >=2.4.6 && <2.4.9 | composer require [--ignore-platform-reqs] --with-all-dependencies smile/elasticsuite-premium-magento ~2.11.0 |
| >=2.4.9 | composer require [--ignore-platform-reqs] --with-all-dependencies smile/elasticsuite-premium-magento ~2.12.0 |
- for Enterprise Edition / Adobe Commerce
| Magento version | Metapackage first-time install in Enterprise Edition / Adobe Commerce |
|---|---|
| <2.4.6 | composer require [--ignore-platform-reqs] --with-all-dependencies smile/elasticsuite-premium-commerce ~2.10.0 |
| >=2.4.6 && <2.4.9 | composer require [--ignore-platform-reqs] --with-all-dependencies smile/elasticsuite-premium-commerce ~2.11.0 |
| >=2.4.9 | composer require [--ignore-platform-reqs] --with-all-dependencies smile/elasticsuite-premium-commerce ~2.12.0 |
馃拵 Explain: UI rework and ability to preview results without optimizers
The context information blocks (list of synonyms, optimizers, popular searches, ...) of the Explain screen are now located in a resizeable side panel to limit the amount elements to scroll over to reach the preview results from the Explain parameters form.
Above the preview results, there is also now an "Ignore optimizers" checkbox that allows you to re-run the same preview but without applying any of the applicable optimizers.

This can be useful when you want to have an idea of the pure, unaltered fulltext scores of products for a given search term(s).

Elasticsuite properties CSV import/export for Category attributes
Up until now, changing properties such as searchability, search weight, or search analyzer for category attributes required database changes or an elasticsuite_indices.xml override.
This release introduces a CSV import/export mechanism for category attributes Elasticsuite properties, similar to the one already existing for product attributes.
It is available through
- the native System > Data > Export and System > Data > Import screens where a new export/import model "ElasticSuite Category Attributes properties" is available
- the product attributes grid of Store > Attributes > Product where the grid's Export to now contains
- CSV Elasticsuite Product attributes properties, our legacy CSV export for product attributes' properties
- CSV Elasticsuite Category attributes properties, the new CSV export dedicated to category attributes' properties
Company selector (B2B) replaced in Search Usage analytics dashboard
The simple HTML select provided as Company filter on the Search Usage analytics for Magento B2B users since releases 2.10.24 and 2.11.10 has been upgraded to a search-as-you-type UI component to benefit user with hundreds and hundreds of registered companies.
Ability to hide Elasticsuite Health Checks notices
When there are some failed Elasticsuite Health Checks (Elasticsuite > System > Healthcheck), the Elasticsuite admin menu entry is decorated with a red bubble and the total number of failed checks :
Up until now, that happened whatever the severity level (Notice < Warning < Error < Critical) of the failed checks.
A new setting has been introduced in Store > Configuration > Elasticsuite > Base Settings > Healthchecks > Minimum Severity for Menu Decoration to allow you to only display that red bubble on the Elasticsuite menu entry if there are failed checks at and beyond a certain severity level.
For instance, by selecting Warning (meaning "Warning and above"), the red bubble will not show up on the Elasticsuite menu entry if failed health checks are all at the Notice severity level (it will still be present on the Elasticsuite > Healthcheck menu entry, though).
馃摝 Features
- [Analytics] M1: Introduce UI components in Search Usage dashboard by @rbayet in #3914
- [Catalog] Category attributes Elasticsuite properties import by @rbayet in #3918
- [Core][Healthcheck] Feature #3905, Severity threshold settings for the Healthcheck menu decoration by @vahonc in #3907
- 馃拵 [Explain] Allow to disable all optimizers by @rbayet
- 馃拵 [Explain] Introducing a side panel with the information blocks by @rbayet
- 馃拵 [RecommenderExplain] Module initialization by @rbayet
- 馃拵 [Recommender Explain] Feature #496, dynamic main button label switch by @vahonc
- 馃拵 [Recommender Explain] Feature #494, menu changes by @vahonc
- 馃拵 [Recommender Explain] Feature #495, label changes by @vahonc
馃捇 Technical
- [CatalogRule] Use a single terms query for SKU "is one of" conditions by @Nuranto in #3909
- [CatalogRule] Fix #3920, prevent StyleSmuggler-like vulnerability (backport of AC-2571) in Conditions controller by @vahonc in #3921
- 馃拵 [Explain] Pre-compute product total field matches score by @rbayet
- 馃拵 [Recommender,OptimizerCustomer*] Hardening customer/checkout session access by @rbayet
- [Tracker] Hardening session access by @rbayet in #3913
- 馃拵 [VirtualAttribute] Fix #500, backport logic of AC-2571 by @vahonc
馃悰 Fixes
- [Catalog] Fix #3882, prevent null array keys in product coverage provider by @vahonc in #3904
- [Catalog][VirtualCategories] Fixes #3859, keep all positions when switching sort order by @rbayet in #3919
- [Catalog] Fixes #3826, scope ajax facets to the requested category by @klo-chi in #3922
- [Core] Fix some PHPStan level 1 issues by @rbayet in #3906
- 馃拵 [Core] Fix some PHPStan level 1 issues by @rbayet
- 馃拵 [VirtualAttribute] Fixing historic approx. for future compatibility by @rbayet
- 馃拵 [VirtualAttributes] Backport of MySQL 8+ compatibility fixes by @rbayet
- 馃拵 [VirtualAttributes] Fix max 'value' length/size with regards to multi-column index. by @rbayet
- 馃拵 [VirtualAttributes] Fix max 'value' length/size with regards to multi-column index (2.11.x). by @rbayet
New Contributors
Full Changelog: 2.12.1.1...2.12.2