Merge pull request #1730 from algolia/release/3.15.0

3.15.0 to main

Author: damcou

Api/Builder/EntityIndexOptionsBuilderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Builder;
+
+use Algolia\AlgoliaSearch\Api\Data\IndexOptionsInterface;
+
+interface EntityIndexOptionsBuilderInterface
+{
+    public function buildEntityIndexOptions(int $storeId, ?bool $isTmp = false): IndexOptionsInterface;
+}

Api/Builder/IndexBuilderInterface.php

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

Api/Builder/RecordBuilderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Builder;
+
+use Magento\Framework\DataObject;
+
+interface RecordBuilderInterface
+{
+    public function buildRecord(DataObject $entity): array;
+}

Api/Builder/UpdatableIndexBuilderInterface.php

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

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;
+}

Block/Adminhtml/LandingPage/SearchConfiguration.php

@@ -22,9 +22,6 @@ class SearchConfiguration extends \Magento\Backend\Block\Template
     /** @var Data */
     private $coreHelper;
 
-    /** @var int */
-    protected $planLevel;
-
     /**
      * @param Context $context
      * @param SessionManagerInterface $backendSession

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,5 +1,43 @@
 # CHANGE LOG
 
+## 3.15.0
+
+### Features
+- Added support for Multi-Application IDs (see [documentation](https://www.algolia.com/doc/integration/magento-2/getting-started/quick-start/#support-for-multiple-application-ids))
+- Refactored frontend library to no longer utilize the legacy `algoliaBundle` (see [documentation](https://www.algolia.com/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 [documentation](https://www.algolia.com/doc/integration/magento-2/troubleshooting/data-indexes-queues/#price-index-dependencies) for further details.)
+- Reorganization of the test folders
+- Added unit and integration tests for full page cache (FPC)
+
+### 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 [documentation](https://www.algolia.com/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
+- Fixed a bug where excluded websites weren't taken into account while indexing customer prices on products. (thanks @kamilszewczyk)
+- Fixed a bug where full page cache (FPC) didn't work on category pages
+
+### 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 documentation](https://www.algolia.com/doc/integration/magento-2/troubleshooting/front-end-issues/))
+
+
 ## 3.14.4
 
 ### Features
@@ -93,24 +131,29 @@ If you have customized your Algolia implementation or are running on an older ve
 - Dropped support for Magento 2.3
 - PHP 8.1+ required
 
-## 3.14.0-beta.2
+## 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
 
-- Introduced new admin groups to InstantSearch for improved UX
-- Updated `ConfigHelper` to use new paths
-- Added data patch to migrate old configurations
-- Bugfix for query rule disable on facets with new admin groupings
-- Added new sorting admin option via source model
-- Added derived virtual replica enablement to `ConfigHelper` based on `ArraySerialized`
-- Intro’d simplified data structures to avoid array diff mismatches
-- Intro’d new `ReplicaManager` abstraction to map Magento sorting to Algolia replica configuration
-- Removed dependencies in backend models to handle replica config updates in Algolia addressing stale data
-- Added `ReplicaState` registry for tracking changes to sorting configuration to minimize number of replica build operations
-- Added logic to preserve replicas created outside of Magento such as Merchandising Studio "sorting strategies"
-- Introduced PHP 8 constructor property promotion on affected classes
-- Added stronger typing to affected classes and methods
-- Added Looking Similar recommendations
+### 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
 
@@ -129,20 +172,6 @@ If you have customized your Algolia implementation or are running on an older ve
 - Fixed lock timeout issue on indexing queue integration test
 - Community fix added - job queue dropping jobs from sandwiched full reindexes - thank you @pikulsky
 
-## 3.14.0-beta.1
-
-### Updates:
-
-- New PHP API client (v4) under the hood for communicating with Algolia
-- Authenticated user tokens now utilized for backend and frontend events to track entire customer journey
-- Revenue data now sent with all events including application of Magento specific discounts such as catalog price rules and customer group pricing
-- Support for event subtypes allowing the capture of conversion data for both "Add to cart" and "Place order" events
-- Increased protection of PII in the event data
-
-### Bug fixes:
-- Fixed issue with how Algolia extension handles end user consent for allowing cookies
-- Improved handling of user tokens across insights events and corresponding queries
-
 ## 3.13.3
 
 ### Updates

Console/Command/AbstractReplicaCommand.php

@@ -2,123 +2,11 @@
 
 namespace Algolia\AlgoliaSearch\Console\Command;
 
-use Algolia\AlgoliaSearch\Service\StoreNameFetcher;
-use Magento\Framework\App\Area;
-use Magento\Framework\App\State;
-use Magento\Framework\Exception\LocalizedException;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputArgument;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Question\ConfirmationQuestion;
-
-abstract class AbstractReplicaCommand extends Command
+abstract class AbstractReplicaCommand extends AbstractStoreCommand
 {
-    protected const STORE_ARGUMENT = 'store';
-
-    protected ?OutputInterface $output = null;
-    protected ?InputInterface $input = null;
-
-    public function __construct(
-        protected State            $state,
-        protected StoreNameFetcher $storeNameFetcher,
-        ?string                    $name = null
-    )
-    {
-        parent::__construct($name);
-    }
-
-    abstract protected function getReplicaCommandName(): string;
-
-    abstract protected function getCommandDescription(): string;
-
-    abstract protected function getStoreArgumentDescription(): string;
-
-    abstract protected function getAdditionalDefinition(): array;
-
-    /**
-     * @inheritDoc
-     */
-    protected function configure(): void
-    {
-        $definition = [$this->getStoreArgumentDefinition()];
-        $definition = array_merge($definition, $this->getAdditionalDefinition());
-
-        $this->setName($this->getCommandName())
-            ->setDescription($this->getCommandDescription())
-            ->setDefinition($definition);
-
-        parent::configure();
-    }
-
-    protected function getStoreArgumentDefinition(): InputArgument {
-        return new InputArgument(
-            self::STORE_ARGUMENT,
-            InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-            $this->getStoreArgumentDescription()
-        );
-    }
-
-    public function getCommandName(): string
-    {
-        return 'algolia:replicas:' . $this->getReplicaCommandName();
-    }
-
-    protected function setAreaCode(): void
-    {
-        try {
-            $this->state->setAreaCode(Area::AREA_CRONTAB);
-        } catch (LocalizedException) {
-            // Area code is already set - nothing to do
-        }
-    }
-
-    /**
-     * @param InputInterface $input
-     * @return int[]
-     */
-    protected function getStoreIds(InputInterface $input): array
-    {
-        return (array) $input->getArgument(self::STORE_ARGUMENT);
-    }
-
-    /**
-     * @param int[] $storeIds
-     * @return string
-     */
-    protected function getOperationTargetLabel(array $storeIds): string
-    {
-        return ($storeIds ? count($storeIds) : 'all') . ' store' . (!$storeIds || count($storeIds) > 1 ? 's' : '');
-    }
-
-    /**
-     * Generate a CLI operation announcement based on passed store arguments
-     * @param string $msg Use {{target} in message as a placeholder for inserting the generated target label
-     * @param int[] $storeIds
-     * @return string
-     */
-    protected function decorateOperationAnnouncementMessage(string $msg, array $storeIds): string
+    protected function getCommandPrefix(): string
     {
-        $msg = str_replace('{{target}}', $this->getOperationTargetLabel($storeIds), $msg);
-        return ($storeIds)
-            ? "<info>$msg: " . join(", ", $this->storeNameFetcher->getStoreNames($storeIds)) . '</info>'
-            : "<info>$msg</info>";
+        return parent::getCommandPrefix() . 'replicas:';
     }
 
-    protected function confirmOperation(string $okMessage = '', string $cancelMessage = 'Operation cancelled'): bool
-    {
-        $helper = $this->getHelper('question');
-        $question = new ConfirmationQuestion('<question>Are you sure wish to proceed? (y/n)</question> ', false);
-        if (!$helper->ask($this->input, $this->output, $question)) {
-            if ($cancelMessage) {
-                $this->output->writeln("<comment>$cancelMessage</comment>");
-            }
-            return false;
-        }
-
-        if ($okMessage) {
-            $this->output->writeln("<comment>$okMessage</comment>");
-        }
-        return true;
-    }
 }