Merge pull request #1694 from algolia/release/3.15.0-dev

MAGE-1117: Update `3.15.0-beta` branch

Author: damcou

Api/Data/IndexOptionsInterface.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Data;
+
+interface IndexOptionsInterface
+{
+    const STORE_ID = 'store_id';
+
+    const INDEX_SUFFIX = 'index_suffix';
+
+    const IS_TMP = 'is_tmp';
+
+    const INDEX_NAME = 'index_name';
+
+    /**
+     * Get field: store_id
+     *
+     * @return int|null
+     */
+    public function getStoreId(): ?int;
+
+    /**
+     * Get field: index_suffix
+     *
+     * @return string|null
+     */
+    public function getIndexSuffix(): ?string;
+
+    /**
+     * Get field: is_tmp
+     *
+     * @return bool
+     */
+    public function isTemporaryIndex(): bool;
+
+    /**
+     * Get field: index_name
+     *
+     * @return string|null
+     */
+    public function getIndexName(): ?string;
+
+    /**
+     * Set field: index_name
+     *
+     * @param string $indexName
+     * @return void
+     */
+    public function setIndexName(string $indexName): void;
+}

Api/IndexBuilder/IndexBuilderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\IndexBuilder;
+
+interface IndexBuilderInterface
+{
+    public function buildIndex(int $storeId, ?array $entityIds, ?array $options): void;
+
+    public function buildIndexFull(int $storeId, ?array $options): void;
+}

Api/IndexBuilder/UpdatableIndexBuilderInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\IndexBuilder;
+
+interface UpdatableIndexBuilderInterface extends IndexBuilderInterface
+{
+    public function buildIndexList(int $storeId, ?array $entityIds, ?array $options): void;
+}

Block/Configuration.php

@@ -13,7 +13,7 @@ class Configuration extends Algolia implements CollectionDataSourceInterface
     //Placeholder for future implementation (requires custom renderer for hierarchicalMenu widget)
     private const IS_CATEGORY_NAVIGATION_ENABLED = false;
 
-    public function isSearchPage()
+    public function isSearchPage(): bool
     {
         if ($this->getConfigHelper()->isInstantEnabled()) {
             /** @var Http $request */
@@ -80,8 +80,6 @@ public function getConfiguration()
 
         $suggestionHelper = $this->getSuggestionHelper();
 
-        $productHelper = $this->getProductHelper();
-
         $algoliaHelper = $this->getAlgoliaHelper();
 
         $persoHelper = $this->getPersonalizationHelper();
@@ -249,12 +247,13 @@ public function getConfiguration()
             'indexName' => $coreHelper->getBaseIndexName(),
             'apiKey' => $algoliaHelper->generateSearchSecuredApiKey(
                 $config->getSearchOnlyAPIKey(),
-                $attributesToFilter
+                $attributesToFilter,
+                $this->getStoreId()
             ),
             'attributeFilter' => $attributesToFilter,
             'facets' => $facets,
             'areCategoriesInFacets' => $areCategoriesInFacets,
-            'hitsPerPage' => (int) $config->getNumberOfProductResults(),
+            'hitsPerPage' => $config->getNumberOfProductResults(),
             'sortingIndices' => array_values($this->sortingTransformer->getSortingIndices(
                 $this->getStoreId(),
                 $customerGroupId
@@ -421,7 +420,7 @@ protected function getOrderedProductIds(ConfigHelper $configHelper, Http $reques
         return $ids;
     }
 
-    protected function isLandingPage()
+    protected function isLandingPage(): bool
     {
         return $this->getRequest()->getFullActionName() === 'algolia_landingpage_view';
     }
@@ -440,4 +439,15 @@ protected function getLandingPageConfiguration()
     {
         return $this->isLandingPage() ? $this->getCurrentLandingPage()->getConfiguration() : json_encode([]);
     }
+
+    public function canLoadInstantSearch(): bool
+    {
+        return $this->getConfigHelper()->isInstantEnabled()
+            && $this->isProductListingPage();
+    }
+
+    protected function isProductListingPage(): bool
+    {
+        return $this->isSearchPage() || $this->isLandingPage();
+    }
 }

CHANGELOG.md

@@ -1,9 +1,53 @@
 # CHANGE LOG
 
-## 3.15.0-beta.1
+## 3.15.0-beta.2
 
-## Updates
-- Added support for Multi-Application IDs
+### Features
+- Added support for Multi-Application IDs (see [preview documentation](https://deploy-preview-9703--algolia-docs.netlify.app/doc/integration/magento-2/getting-started/quick-start/#support-for-multiple-application-ids))
+- Refactored frontend library to no longer utilize the legacy `algoliaBundle` (see [preview documentation](https://deploy-preview-9703--algolia-docs.netlify.app/doc/integration/magento-2/customize/custom-front-end-events/?client=php#frontend-javascript-libraries-and-the-legacy-bundle))
+- Added support for core Algolia UI library overrides via RequireJS
+- Added support for mixins through RequireJS in addition to [front end custom events](https://www.algolia.com/doc/integration/magento-2/customize/custom-front-end-events) 
+- See our `CustomAlgolia` demo extension's [1.4.0 release](https://github.com/algolia/algoliasearch-custom-algolia-magento-2/releases/tag/1.4.0) for examples on how to take advantage of these changes
+- Added granular profiling through the [Magento Profiler](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/setup/mage-profiler) to aid in troubleshooting indexing performance issues
+- Added a feature to enable automatic price indexing within the Advanced section of the configuration (This feature should help alleviate issues where missing pricing records prevent Algolia from being able to index products. See [preview documentation](https://deploy-preview-9703--algolia-docs.netlify.app/doc/integration/magento-2/troubleshooting/data-indexes-queues/#price-index-dependencies) for further details.)
+
+### Updates
+- Tests: Added possibility to run tests with multiple applications IDs.
+- Introduced Index Builders which are services responsible for creating and filling indices with data.
+- **IMPORTANT**: As a result `AlgoliaHelper` is now deprecated and will be removed from the codebase in version 3.16.0
+- Added `BackendSearch` Service to move `getSearchResults` method into.
+- Updated Indexing Queue display in the admin by adding the `class` column
+- Updated Indexing Queue `data` column formatting
+- Added documentation link on the queue archive page
+- Debugging information now writes to `algolia.log`
+- Removed dependency on `algoliaBundle` package
+- Removed dependency on JavaScript global `window` objects with the exception of `algoliaConfig`
+- The Hogan.js library is still packaged for injection as needed but be advised that Mustache.js is now used internally instead (see [preview documentation](https://deploy-preview-9703--algolia-docs.netlify.app/doc/integration/magento-2/customize/instant-search-page/?client=php#mustache-templates))
+- JavaScript bundling is supported but to use the RequireJS Optimizer transpiling will be needed for ES6 constructs
+
+### Bug Fixes
+- Fixed a bug where admin menus didn't display properly on Magento 2.4.7
+- Fixed customer groups prices ranges on configurable products
+- Fixed a bug where categories highlighting didn't work as expected on PLP powered by InstantSearch
+
+### Breaking Changes
+- If you have customized your front end implementation based on the `algoliaBundle` you may need to shim your application accordingly (Full details are shared in [our preview documentation](https://deploy-preview-9703--algolia-docs.netlify.app/doc/integration/magento-2/troubleshooting/front-end-issues/))
+
+
+
+## 3.14.4
+
+### Features
+- Added a feature to enable automatic price indexing on the Advanced section of the configuration (This feature should help alleviate issues where missing pricing records prevent Algolia from being able to index products.)
+
+### Updates
+- Updated `getCookie` method to make it more consistent
+- Removed dependency to `catalog_product_price` indexer
+
+### Bug Fixes
+- Fixed a bug where the Landing Page Builder was crashing on save with customer group pricing was enabled.
+- Fixed issue where Insights information wasn't kept on the url after clicking "add to cart" on PLP powered by InstantSearch
+- Fixed a bug where synonyms were unintentionally duplicated on the Algolia dashboard
 
 ## 3.14.3
 
@@ -103,6 +147,30 @@ If you have customized your Algolia implementation or are running on an older ve
 - Added stronger typing to affected classes and methods
 - Added Looking Similar recommendations
 
+## 3.13.8
+
+### Bug Fixes
+- Restored compatibility with PHP 7.4
+
+## 3.13.7
+
+### Features
+- Added a feature to enable automatic price indexing on the Advanced section of the configuration (This feature should help alleviate issues where missing pricing records prevent Algolia from being able to index products.)
+
+### Updates
+- Updated `getCookie` method to make it more consistent
+- Removed dependency to `catalog_product_price` indexer
+
+### Bug Fixes
+- Fixed a bug where the Landing Page Builder was crashing on save with customer group pricing was enabled.
+- Fixed issue where Insights information wasn't kept on the url after clicking "add to cart" on PLP powered by InstantSearch
+
+## 3.13.6
+
+### Bug Fixes
+- Improve handling of insights params for URLs that already have a query string
+- Improve query method for alternate root categories - Thank you @igorfigueiredogen
+
 ## 3.13.5
 
 ### Updates

Controller/Adminhtml/Landingpage/Save.php

@@ -107,13 +107,15 @@ public function execute()
                 $data['configuration'] = $data['algolia_configuration'];
                 if ($this->configHelper->isCustomerGroupsEnabled($data['store_id'])) {
                     $configuration = json_decode($data['algolia_configuration'], true);
-                    $priceConfig = $configuration['price'.$data['price_key']];
-                    $customerGroups = $this->customerGroupCollectionFactory->create();
-                    $store = $this->storeManager->getStore($data['store_id']);
-                    $baseCurrencyCode = $store->getBaseCurrencyCode();
-                    foreach ($customerGroups as $group) {
-                        $groupId = (int) $group->getData('customer_group_id');
-                        $configuration['price.'.$baseCurrencyCode.'.group_'.$groupId] = $priceConfig;
+                    if (isset($configuration['price'.$data['price_key']])) {
+                        $priceConfig = $configuration['price'.$data['price_key']];
+                        $customerGroups = $this->customerGroupCollectionFactory->create();
+                        $store = $this->storeManager->getStore($data['store_id']);
+                        $baseCurrencyCode = $store->getBaseCurrencyCode();
+                        foreach ($customerGroups as $group) {
+                            $groupId = (int) $group->getData('customer_group_id');
+                            $configuration['price.'.$baseCurrencyCode.'.group_'.$groupId] = $priceConfig;
+                        }
                     }
                     $data['configuration'] = json_encode($configuration);
                 }

Controller/Adminhtml/Reindex/Save.php

@@ -9,47 +9,27 @@
 use Algolia\AlgoliaSearch\Exception\UnknownSkuException;
 use Algolia\AlgoliaSearch\Helper\Data as DataHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
+use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder;
 use Magento\Backend\App\Action\Context;
 use Magento\Catalog\Api\ProductRepositoryInterface;
 use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\StoreManagerInterface;
 
 class Save extends \Magento\Backend\App\Action
 {
     public const MAX_SKUS = 10;
 
-    /** @var ProductRepositoryInterface */
-    protected $productRepository;
-
-    /** @var StoreManagerInterface */
-    protected $storeManager;
-
-    /** @var DataHelper */
-    protected $dataHelper;
-
-    /** @var ProductHelper */
-    protected $productHelper;
-
-    /**
-     * @param Context $context
-     * @param ProductRepositoryInterface $productRepository
-     * @param StoreManagerInterface $storeManager
-     * @param DataHelper $dataHelper
-     * @param ProductHelper $productHelper
-     */
     public function __construct(
-        Context $context,
-        ProductRepositoryInterface $productRepository,
-        StoreManagerInterface $storeManager,
-        DataHelper $dataHelper,
-        ProductHelper $productHelper
+        protected Context $context,
+        protected ProductRepositoryInterface $productRepository,
+        protected StoreManagerInterface $storeManager,
+        protected DataHelper $dataHelper,
+        protected ProductHelper $productHelper,
+        protected ProductIndexBuilder $productIndexBuilder
     ) {
         parent::__construct($context);
-        $this->storeManager = $storeManager;
-        $this->dataHelper = $dataHelper;
-        $this->productHelper = $productHelper;
-        $this->productRepository = $productRepository;
     }
 
     /**
@@ -131,6 +111,7 @@ public function execute()
      * @param $stores
      * @return void
      * @throws NoSuchEntityException
+     * @throws LocalizedException
      */
     protected function checkAndReindex($product, $stores)
     {
@@ -220,7 +201,7 @@ protected function checkAndReindex($product, $stores)
             $productIds = [$product->getId()];
             $productIds = array_merge($productIds, $this->productHelper->getParentProductIds($productIds));
 
-            $this->dataHelper->rebuildStoreProductIndex($storeId, $productIds);
+            $this->productIndexBuilder->buildIndexList($storeId, $productIds);
             $this->messageManager->addSuccessMessage(
                 __(
                     'The Product "%1" (%2) has been reindexed for store "%3 / %4 / %5".',

Exception/DiagnosticsException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Exception;
+
+use Magento\Framework\Exception\LocalizedException;
+
+class DiagnosticsException extends LocalizedException
+{
+
+}

Helper/AdapterHelper.php

@@ -3,8 +3,8 @@
 namespace Algolia\AlgoliaSearch\Helper;
 
 use Algolia\AlgoliaSearch\Helper\Adapter\FiltersHelper;
-use Algolia\AlgoliaSearch\Helper\Data as AlgoliaDataHelper;
 use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager;
+use Algolia\AlgoliaSearch\Service\Product\BackendSearch;
 use Magento\CatalogSearch\Helper\Data as CatalogSearchDataHelper;
 
 class AdapterHelper
@@ -14,7 +14,7 @@ class AdapterHelper
 
     public function __construct(
         protected CatalogSearchDataHelper $catalogSearchHelper,
-        protected AlgoliaDataHelper $algoliaHelper,
+        protected BackendSearch $backendSearch,
         protected FiltersHelper $filtersHelper,
         protected ConfigHelper $configHelper,
         protected AlgoliaCredentialsManager $algoliaCredentialsManager
@@ -52,7 +52,7 @@ public function getDocumentsFromAlgolia()
             }
         }
 
-        return $this->algoliaHelper->getSearchResult($algoliaQuery, $storeId, $searchParams, $targetedIndex);
+        return $this->backendSearch->getSearchResult($algoliaQuery, $storeId, $searchParams, $targetedIndex);
     }
 
     /**