Merge branch 'develop' into bugfix/MAGE-800

Author: mohitalgolia

CHANGELOG.md

@@ -1,10 +1,23 @@
 # CHANGE LOG
 
-## 3.11.0
+## 3.12.0
 
 ### Updates
-- Fixes related to NeuralSearch compatibility
-- Removed the redundant jquery library from AlgoliaBundle.
+- Updated code to consider user’s cookie consent to send events to Algolia by using ‘useCookie’ parameter
+- Updated references to [email protected] to new ticket link
+- Updated code to refactor the deprecated registry for categories
+- Updated code to ensure compatibility with NeuralSearch
+- Updated AlgoliaBundle by eliminating the unnecessary jQuery library
+- Included the promotion class in autocomplete menu when a product has any promotions
+
+### Bug Fixes
+- Fixed formatting issue in product object related to CategoryPageId attribute
+- Fixed issue with Clear Refinements button in InstantSearch page
+- Fixed issue with custom banner functionality via merchandising dashboard in admin
+- Fixed issue with hierarchicalMenu widget when utilizing transformItems when the number of categories exceeded the limit
+- Fixed issue with indexing text field attributes with a value of 0
+- Fixed issue with user cookies not clearing upon customer logout
+- Fixed back button issue with pagination in instant search page and category pages
 
 ## 3.11.0
 

Helper/Entity/ProductHelper.php

@@ -463,7 +463,7 @@ public function setSettings($indexName, $indexNameTmp, $storeId, $saveToTmpIndic
 
         // Managing Virtual Replica
         if ($this->configHelper->useVirtualReplica($storeId)) {
-            $replicas = $this->handleVirtualReplica($replicas);
+            $replicas = $this->handleVirtualReplica($replicas, $indexName);
         }
 
         // Merge current replicas with sorting replicas to not delete A/B testing replica indices
@@ -1534,7 +1534,7 @@ public function productIsInStock($product, $storeId)
      * @param $replica
      * @return array
      */
-    public function handleVirtualReplica($replicas)
+    public function handleVirtualReplica($replicas, $indexName)
     {
         $virtualReplicaArray = [];
         foreach ($replicas as $replica) {
@@ -1558,14 +1558,12 @@ public function handlingReplica($indexName, $storeId, $sortingAttribute = false)
                 return $sortingIndex['name'];
             }, $sortingIndices));
             try {
-                $replicasFormated = $this->handleVirtualReplica($replicas);
-                $availableReplicaMatch = array_merge($replicasFormated, $replicas);
                 if ($this->configHelper->useVirtualReplica($storeId)) {
-                   $replicas = $replicasFormated;
+                    $replicas = $this->handleVirtualReplica($replicas, $indexName);
                 }
                 $currentSettings = $this->algoliaHelper->getSettings($indexName);
                 if (is_array($currentSettings) && array_key_exists('replicas', $currentSettings)) {
-                    $replicasRequired = array_values(array_diff($currentSettings['replicas'], $availableReplicaMatch));
+                    $replicasRequired = array_values(array_diff_assoc($currentSettings['replicas'], $replicas));
                     $this->algoliaHelper->setSettings($indexName, ['replicas' => $replicasRequired]);
                     $setReplicasTaskId = $this->algoliaHelper->getLastTaskId();
                     $this->algoliaHelper->waitLastTask($indexName, $setReplicasTaskId);

Helper/InsightsHelper.php

@@ -23,6 +23,9 @@ class InsightsHelper
     /** @var PersonalizationHelper */
     private $personalizationHelper;
 
+    /** @var SessionManagerInterface */
+    private $sessionManager;
+    
     /** @var CookieManagerInterface */
     private $cookieManager;
 

Model/Backend/Sorts.php

@@ -74,12 +74,10 @@ public function afterSave()
         if ($this->isValueChanged()) {
             try{
                 $oldValue = $this->serializer->unserialize($this->getOldValue());
-                $updatedValue = $this->serializer->unserialize($this->getValue());
-                $sortingAttributes = array_merge($oldValue, $updatedValue);
                 $storeIds = array_keys($this->storeManager->getStores());
                 foreach ($storeIds as $storeId) {
                     $indexName = $this->helper->getIndexName($this->productHelper->getIndexNameSuffix(), $storeId);
-                    $this->productHelper->handlingReplica($indexName, $storeId, $sortingAttributes);
+                    $this->productHelper->handlingReplica($indexName, $storeId, $oldValue);
                 }
             } catch (AlgoliaException $e) {
                 if ($e->getCode() !== 404) {

README.md

@@ -1,7 +1,7 @@
-Algolia Search for Magento 2
-============================
+Algolia Search & Discovery extension for Magento 2
+==================================================
 
-![Latest version](https://img.shields.io/badge/latest-3.11.1%20beta-green)
+![Latest version](https://img.shields.io/badge/latest-3.12.0-green)
 ![Magento 2](https://img.shields.io/badge/Magento-2.4.x-orange)
 
 ![PHP](https://img.shields.io/badge/PHP-8.2%2C8.1%2C7.4-blue)
@@ -12,7 +12,7 @@ Algolia Search for Magento 2
 
 ## Features
 
-The Algolia extension replaces the default search in Magento Open Source and Adobe Commerce with a robust autocomplete search menu and instant search results page.
+The Algolia extension replaces the default search in Magento Open Source and Adobe Commerce with a robust autocomplete search menu and Instantsearch results page.
 
 This extension replaces the default search of Magento with a typo-tolerant, fast & relevant search experience backed by Algolia. It's based on [algoliasearch-client-php](https://github.com/algolia/algoliasearch-client-php), [autocomplete.js](https://github.com/algolia/autocomplete.js) and [instantsearch.js](https://github.com/algolia/instantsearch.js).
 
@@ -61,7 +61,7 @@ With the release of a new major version, we have decided to create minor and maj
 
 If you would like to stay on a minor version, please upgrade your composer to only accept versions less than version 2 like the example:
 
-`"algolia/algoliasearch-magento-2": "3.10.2"`
+`"algolia/algoliasearch-magento-2": "3.12.0"`
 
 ### Customisation
 
@@ -81,7 +81,7 @@ Knowing the version of the library will help you understand what is available in
 | v3.x              | [0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0) | [4.15.0](https://github.com/algolia/instantsearch.js/tree/v4.15.0) | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | NA |
 | v3.9.1            | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)   | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0) | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.5.0](https://github.com/algolia/recommend/tree/v1.5.0) |
 | v3.10.x            | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)   | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0) | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) |
-| v3.11.0-beta            | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)   | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0) | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) |
+| >=v3.11.0            | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)   | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0) | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) |
 
 The autocomplete and instantsearch libraries are accessible in the `algoliaBundle` global. This bundle is a prepackage javascript file that contains it's dependencies. What is included in this bundle can be seen here:
 
@@ -106,7 +106,8 @@ Depending on the extension version you are using, you could have a different PHP
 | v1.x              | [1.28.0](https://github.com/algolia/algoliasearch-client-php/tree/1.28.0) |
 | v2.x              | [2.5.1](https://github.com/algolia/algoliasearch-client-php/tree/2.5.1)   |
 | v3.x              | [2.5.1](https://github.com/algolia/algoliasearch-client-php/tree/2.5.1)   |
-| >= v3.6.x            | [3.2.0](https://github.com/algolia/algoliasearch-client-php/tree/3.2.0)   |
+| v3.6.x            | [3.2.0](https://github.com/algolia/algoliasearch-client-php/tree/3.2.0)   |
+| >= v3.11.0        | [3.3.2](https://github.com/algolia/algoliasearch-client-php/tree/3.3.2)   |
 
 Refer to these docs when customising your Algolia Magento extension backend:
 - [Indexing](https://www.algolia.com/doc/integration/magento-2/how-it-works/indexing/)

composer.json

@@ -1,9 +1,9 @@
 {
   "name": "algolia/algoliasearch-magento-2",
-  "description": "Algolia Search integration for Magento 2",
+  "description": "Algolia Search & Discovery extension for Magento 2",
   "type": "magento2-module",
   "license": ["MIT"],
-  "version": "3.11.1-beta",
+  "version": "3.12.0",
   "require": {
     "magento/framework": "~102.0|~103.0",
     "algolia/algoliasearch-client-php": "3.3.2",

etc/module.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="Algolia_AlgoliaSearch" setup_version="3.11.1">
+    <module name="Algolia_AlgoliaSearch" setup_version="3.12.0">
         <sequence>
             <module name="Magento_Theme"/>
             <module name="Magento_Backend"/>

view/frontend/web/insights/notices-mixin.js

@@ -660,7 +660,21 @@ define(
                             }
                     });
 
-                    var isStarted = false;
+                    // Capture active redirect URL with IS facet params for add to cart from PLP
+                    if (algoliaConfig.instant.isAddToCartEnabled) {
+                        search.on('render', () => {
+                            const cartForms = document.querySelectorAll('[data-role="tocart-form"]');
+                            cartForms.forEach((form, i) => {
+                                const ts = Date.now();
+                                form.addEventListener('submit', e => {
+                                    const url = `${algoliaConfig.request.url}${window.location.search}`;
+                                    e.target.elements[algoliaConfig.instant.addToCartParams.redirectUrlParam].value = AlgoliaBase64.mageEncode(url);
+                                })
+                            });
+                        });
+                    }
+		    
+		    var isStarted = false;
 
                     function startInstantSearch() {
                             if (isStarted === true) {