diff --git a/Block/Adminhtml/LandingPage/SearchConfiguration.php b/Block/Adminhtml/LandingPage/SearchConfiguration.php index 0cbeb6638..54867fdc5 100755 --- a/Block/Adminhtml/LandingPage/SearchConfiguration.php +++ b/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 diff --git a/Helper/AdapterHelper.php b/Helper/AdapterHelper.php index a0cb06857..2d4110e94 100644 --- a/Helper/AdapterHelper.php +++ b/Helper/AdapterHelper.php @@ -4,6 +4,7 @@ use Algolia\AlgoliaSearch\Helper\Adapter\FiltersHelper; use Algolia\AlgoliaSearch\Helper\Data as AlgoliaDataHelper; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\CatalogSearch\Helper\Data as CatalogSearchDataHelper; class AdapterHelper @@ -11,35 +12,14 @@ class AdapterHelper public const INSTANTSEARCH_ORDER_PARAM = 'sortBy'; public const BACKEND_ORDER_PARAM = 'product_list_order'; - /** @var CatalogSearchDataHelper */ - private $catalogSearchHelper; - - /** @var AlgoliaDataHelper */ - private $algoliaHelper; - - /** @var FiltersHelper */ - private $filtersHelper; - - /** @var ConfigHelper */ - private $configHelper; - - /** - * @param CatalogSearchDataHelper $catalogSearchHelper - * @param AlgoliaDataHelper $algoliaHelper - * @param FiltersHelper $filtersHelper - * @param ConfigHelper $configHelper - */ public function __construct( - CatalogSearchDataHelper $catalogSearchHelper, - AlgoliaDataHelper $algoliaHelper, - FiltersHelper $filtersHelper, - ConfigHelper $configHelper - ) { - $this->catalogSearchHelper = $catalogSearchHelper; - $this->algoliaHelper = $algoliaHelper; - $this->filtersHelper = $filtersHelper; - $this->configHelper = $configHelper; - } + protected CatalogSearchDataHelper $catalogSearchHelper, + protected AlgoliaDataHelper $algoliaHelper, + protected FiltersHelper $filtersHelper, + protected ConfigHelper $configHelper, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} /** * Get search result from Algolia @@ -142,8 +122,7 @@ public function isAllowed() $storeId = $this->getStoreId(); return - $this->configHelper->getApplicationID($storeId) - && $this->configHelper->getAPIKey($storeId) + $this->algoliaCredentialsManager->checkCredentials($storeId) && $this->configHelper->isEnabledFrontEnd($storeId) && $this->configHelper->makeSeoRequest($storeId); } diff --git a/Helper/AlgoliaHelper.php b/Helper/AlgoliaHelper.php index 52fb59fa3..b43f51822 100755 --- a/Helper/AlgoliaHelper.php +++ b/Helper/AlgoliaHelper.php @@ -6,20 +6,18 @@ use Algolia\AlgoliaSearch\Configuration\SearchConfig; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Model\Search\SearchRulesResponse; -use Algolia\AlgoliaSearch\Response\AbstractResponse; -use Algolia\AlgoliaSearch\Response\BatchIndexingResponse; -use Algolia\AlgoliaSearch\Response\MultiResponse; +use Algolia\AlgoliaSearch\Model\Search\ListIndicesResponse; +use Algolia\AlgoliaSearch\Model\Search\SettingsResponse; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Algolia\AlgoliaSearch\Support\AlgoliaAgent; +use Exception; use Magento\Framework\App\Helper\AbstractHelper; use Magento\Framework\App\Helper\Context; -use Magento\Framework\App\RequestInterface; use Magento\Framework\Message\ManagerInterface; use Symfony\Component\Console\Output\ConsoleOutput; class AlgoliaHelper extends AbstractHelper { - /** * @var string Case-sensitive object ID key */ @@ -33,18 +31,18 @@ class AlgoliaHelper extends AbstractHelper */ public const ALGOLIA_API_TASK_ID = 'taskID'; + /** + * @var int + */ + public const ALGOLIA_DEFAULT_SCOPE = 0; + /** @var int This value should be configured based on system/full_page_cache/ttl * (which is by default 86400) and/or the configuration block TTL */ protected const ALGOLIA_API_SECURED_KEY_TIMEOUT_SECONDS = 60 * 60 * 24; // TODO: Implement as config - protected ?SearchClient $client = null; - - protected ConfigHelper $config; - - protected ManagerInterface $messageManager; - - protected ConsoleOutput $consoleOutput; + /** @var SearchClient[] */ + protected array $clients = []; protected ?int $maxRecordSize = null; @@ -54,77 +52,102 @@ class AlgoliaHelper extends AbstractHelper /** @var string[] */ protected array $nonCastableAttributes = ['sku', 'name', 'description', 'query']; + /** @var int */ + protected int $storeId = self::ALGOLIA_DEFAULT_SCOPE; + + /** @var bool */ + protected bool $userAgentsAdded = false; + protected static ?string $lastUsedIndexName; protected static ?int $lastTaskId; - /** - * @param Context $context - * @param ConfigHelper $configHelper - * @param ManagerInterface $messageManager - * @param ConsoleOutput $consoleOutput - */ public function __construct( Context $context, - ConfigHelper $configHelper, - ManagerInterface $messageManager, - ConsoleOutput $consoleOutput + protected ConfigHelper $config, + protected ManagerInterface $messageManager, + protected ConsoleOutput $consoleOutput, + protected AlgoliaCredentialsManager $algoliaCredentialsManager ) { parent::__construct($context); - $this->config = $configHelper; - $this->messageManager = $messageManager; - $this->consoleOutput = $consoleOutput; - - $this->resetCredentialsFromConfig(); - // Merge non castable attributes set in config $this->nonCastableAttributes = array_merge( $this->nonCastableAttributes, $this->config->getNonCastableAttributes() ); + } - $clientName = $this->client?->getClientConfig()?->getClientName(); + /** + * @return void + * @throws AlgoliaException + */ + protected function createClient(): void + { + $storeId = $this->getStoreId(); + if (!$this->algoliaCredentialsManager->checkCredentials($storeId)) { + throw new AlgoliaException('Client initialization could not be performed because Algolia credentials were not provided.'); + } + + $config = SearchConfig::create( + $this->config->getApplicationID($storeId), + $this->config->getAPIKey($storeId) + ); + $config->setConnectTimeout($this->config->getConnectionTimeout($storeId)); + $config->setReadTimeout($this->config->getReadTimeout($storeId)); + $config->setWriteTimeout($this->config->getWriteTimeout($storeId)); + $this->clients[$storeId] = SearchClient::createWithConfig($config); + } + + /** + * @return void + * @throws AlgoliaException + */ + protected function addAlgoliaUserAgent(): void + { + $clientName = $this->getClient()->getClientConfig()?->getClientName(); if ($clientName) { AlgoliaAgent::addAlgoliaAgent($clientName, 'Magento2 integration', $this->config->getExtensionVersion()); AlgoliaAgent::addAlgoliaAgent($clientName, 'PHP', phpversion()); AlgoliaAgent::addAlgoliaAgent($clientName, 'Magento', $this->config->getMagentoVersion()); AlgoliaAgent::addAlgoliaAgent($clientName, 'Edition', $this->config->getMagentoEdition()); + + $this->userAgentsAdded = true; } } /** - * @return RequestInterface + * @return SearchClient + * @throws AlgoliaException */ - public function getRequest(): RequestInterface + public function getClient(): SearchClient { - return $this->_getRequest(); + if (!isset($this->clients[$this->getStoreId()])) { + $this->createClient(); + if (!$this->userAgentsAdded) { + $this->addAlgoliaUserAgent(); + } + } + + return $this->clients[$this->getStoreId()]; } /** - * @return void + * @return int */ - public function resetCredentialsFromConfig(): void + public function getStoreId(): int { - if ($this->config->getApplicationID() && $this->config->getAPIKey()) { - $config = SearchConfig::create($this->config->getApplicationID(), $this->config->getAPIKey()); - $config->setConnectTimeout($this->config->getConnectionTimeout()); - $config->setReadTimeout($this->config->getReadTimeout()); - $config->setWriteTimeout($this->config->getWriteTimeout()); - $this->client = SearchClient::createWithConfig($config); - } + return $this->storeId; } /** - * @return SearchClient - * @throws AlgoliaException + * @param int $storeId + * @return void */ - public function getClient(): SearchClient + public function setStoreId(int $storeId): void { - $this->checkClient(__FUNCTION__); - - return $this->client; + $this->storeId = $storeId; } /** @@ -138,28 +161,24 @@ public function getIndex(string $name) } /** - * @return mixed + * @return ListIndicesResponse|array * @throws AlgoliaException */ public function listIndexes() { - $this->checkClient(__FUNCTION__); - - return $this->client->listIndices(); + return $this->getClient()->listIndices(); } /** - * @param $indexName - * @param $q - * @param $params + * @param string $indexName + * @param string $q + * @param array $params * @return array * @throws AlgoliaException * @internal This method is currently unstable and should not be used. It may be revisited ar fixed in a future version. */ public function query(string $indexName, string $q, array $params): array { - $this->checkClient(__FUNCTION__); - // TODO: Revisit - not compatible with PHP v4 // if (isset($params['disjunctiveFacets'])) { // return $this->searchWithDisjunctiveFaceting($indexName, $q, $params); @@ -174,7 +193,7 @@ public function query(string $indexName, string $q, array $params): array ); // TODO: Validate return value for integration tests - return $this->client->search([ + return $this->getClient()->search([ 'requests' => [ $params ] ]); } @@ -187,8 +206,6 @@ public function query(string $indexName, string $q, array $params): array */ public function getObjects(string $indexName, array $objectIds): array { - $this->checkClient(__FUNCTION__); - $requests = array_values( array_map( function($id) use ($indexName) { @@ -201,7 +218,7 @@ function($id) use ($indexName) { ) ); - return $this->client->getObjects([ 'requests' => $requests ]); + return $this->getClient()->getObjects([ 'requests' => $requests ]); } /** @@ -216,17 +233,15 @@ function($id) use ($indexName) { public function setSettings( $indexName, $settings, - $forwardToReplicas = false, - $mergeSettings = false, - $mergeSettingsFrom = '' + bool $forwardToReplicas = false, + bool $mergeSettings = false, + string $mergeSettingsFrom = '' ) { - $this->checkClient(__FUNCTION__); - if ($mergeSettings === true) { $settings = $this->mergeSettings($indexName, $settings, $mergeSettingsFrom); } - $res = $this->client->setSettings($indexName, $settings, $forwardToReplicas); + $res = $this->getClient()->setSettings($indexName, $settings, $forwardToReplicas); self::setLastOperationInfo($indexName, $res); } @@ -235,10 +250,11 @@ public function setSettings( * @param string $indexName * @param array $requests * @return array + * @throws AlgoliaException */ protected function performBatchOperation(string $indexName, array $requests): array { - $response = $this->client->batch($indexName, [ 'requests' => $requests ] ); + $response = $this->getClient()->batch($indexName, [ 'requests' => $requests ] ); self::setLastOperationInfo($indexName, $response); @@ -252,8 +268,7 @@ protected function performBatchOperation(string $indexName, array $requests): ar */ public function deleteIndex(string $indexName): void { - $this->checkClient(__FUNCTION__); - $res = $this->client->deleteIndex($indexName); + $res = $this->getClient()->deleteIndex($indexName); self::setLastOperationInfo($indexName, $res); } @@ -266,7 +281,6 @@ public function deleteIndex(string $indexName): void */ public function deleteObjects(array $ids, string $indexName): void { - $this->checkClient(__FUNCTION__); $requests = array_values( array_map( function ($id) { @@ -292,8 +306,7 @@ function ($id) { */ public function moveIndex(string $fromIndexName, string $toIndexName): void { - $this->checkClient(__FUNCTION__); - $response = $this->client->operationIndex( + $response = $this->getClient()->operationIndex( $fromIndexName, [ 'operation' => 'move', @@ -307,6 +320,7 @@ public function moveIndex(string $fromIndexName, string $toIndexName): void * @param string $key * @param array $params * @return string + * @throws AlgoliaException */ public function generateSearchSecuredApiKey(string $key, array $params = []): string { @@ -317,21 +331,19 @@ public function generateSearchSecuredApiKey(string $key, array $params = []): st $params['validUntil'] = time() + self::ALGOLIA_API_SECURED_KEY_TIMEOUT_SECONDS; - return $this->client->generateSecuredApiKey($key, $params); + return $this->getClient()->generateSecuredApiKey($key, $params); } /** - * @param $indexName + * @param string $indexName * @return array - * @throws \Exception + * @throws AlgoliaException */ public function getSettings(string $indexName): array { - $this->checkClient(__FUNCTION__); - try { - return $this->client->getSettings($indexName); - } catch (\Exception $e) { + return $this->getClient()->getSettings($indexName); + } catch (Exception $e) { if ($e->getCode() !== 404) { throw $e; } @@ -342,10 +354,10 @@ public function getSettings(string $indexName): array /** * @param $indexName * @param $settings - * @param $mergeSettingsFrom - * @return array|void + * @param string $mergeSettingsFrom + * @return SettingsResponse|array */ - public function mergeSettings($indexName, $settings, $mergeSettingsFrom = '') + public function mergeSettings($indexName, $settings, string $mergeSettingsFrom = ''): SettingsResponse|array { $onlineSettings = []; @@ -355,8 +367,8 @@ public function mergeSettings($indexName, $settings, $mergeSettingsFrom = '') $sourceIndex = $mergeSettingsFrom; } - $onlineSettings = $this->client->getSettings($sourceIndex); - } catch (\Exception $e) { + $onlineSettings = $this->getClient()->getSettings($sourceIndex); + } catch (Exception $e) { } $removes = ['slaves', 'replicas', 'decompoundedAttributes']; @@ -393,7 +405,7 @@ public function mergeSettings($indexName, $settings, $mergeSettingsFrom = '') * @param array $objects * @param string $indexName * @return void - * @throws \Exception + * @throws Exception * @deprecated Do not use. This method has been replaced by saveObjects and may be removed in the future. */ public function addObjects(array $objects, string $indexName): void { @@ -406,7 +418,7 @@ public function addObjects(array $objects, string $indexName): void { * @param array $objects * @param bool $isPartialUpdate * @return void - * @throws \Exception + * @throws Exception */ public function saveObjects(string $indexName, array $objects, bool $isPartialUpdate = false): void { @@ -430,8 +442,8 @@ function ($object) use ($action) { } /** - * @param $indexName - * @param $response + * @param string $indexName + * @param array $response * @return void */ protected static function setLastOperationInfo(string $indexName, array $response): void @@ -445,10 +457,11 @@ protected static function setLastOperationInfo(string $indexName, array $respons * @param string $indexName * @param bool $forwardToReplicas * @return void + * @throws AlgoliaException */ public function saveRule(array $rule, string $indexName, bool $forwardToReplicas = false): void { - $res = $this->client->saveRule( + $res = $this->getClient()->saveRule( $indexName, $rule[AlgoliaHelper::ALGOLIA_API_OBJECT_ID], $rule, @@ -466,7 +479,7 @@ public function saveRule(array $rule, string $indexName, bool $forwardToReplicas */ public function saveRules(string $indexName, array $rules, bool $forwardToReplicas = false): void { - $res = $this->client->saveRules($indexName, $rules, $forwardToReplicas); + $res = $this->getClient()->saveRules($indexName, $rules, $forwardToReplicas); self::setLastOperationInfo($indexName, $res); } @@ -477,10 +490,11 @@ public function saveRules(string $indexName, array $rules, bool $forwardToReplic * @param string $objectID * @param bool $forwardToReplicas * @return void + * @throws AlgoliaException */ public function deleteRule(string $indexName, string $objectID, bool $forwardToReplicas = false): void { - $res = $this->client->deleteRule($indexName, $objectID, $forwardToReplicas); + $res = $this->getClient()->deleteRule($indexName, $objectID, $forwardToReplicas); self::setLastOperationInfo($indexName, $res); } @@ -506,8 +520,7 @@ public function setSynonyms($indexName, $synonyms): void */ public function copySynonyms(string $fromIndexName, string $toIndexName): void { - $this->checkClient(__FUNCTION__); - $response = $this->client->operationIndex( + $response = $this->getClient()->operationIndex( $fromIndexName, [ 'operation' => 'copy', @@ -527,8 +540,7 @@ public function copySynonyms(string $fromIndexName, string $toIndexName): void */ public function copyQueryRules(string $fromIndexName, string $toIndexName): void { - $this->checkClient(__FUNCTION__); - $response = $this->client->operationIndex( + $response = $this->getClient()->operationIndex( $fromIndexName, [ 'operation' => 'copy', @@ -549,40 +561,17 @@ public function copyQueryRules(string $fromIndexName, string $toIndexName): void */ public function searchRules(string $indexName, array$searchRulesParams = null) { - $this->checkClient(__FUNCTION__); - - return $this->client->searchRules($indexName, $searchRulesParams); - } - - /** - * @param $methodName - * @return void - * @throws AlgoliaException - */ - protected function checkClient($methodName): void - { - if (isset($this->client)) { - return; - } - - $this->resetCredentialsFromConfig(); - - if (!isset($this->client)) { - $msg = 'Operation ' . $methodName . ' could not be performed because Algolia credentials were not provided.'; - - throw new AlgoliaException($msg); - } + return $this->getClient()->searchRules($indexName, $searchRulesParams); } /** * @param string $indexName * @return void + * @throws AlgoliaException */ public function clearIndex(string $indexName): void { - $this->checkClient(__FUNCTION__); - - $res = $this->client->clearObjects($indexName); + $res = $this->getClient()->clearObjects($indexName); self::setLastOperationInfo($indexName, $res); } @@ -595,8 +584,6 @@ public function clearIndex(string $indexName): void */ public function waitLastTask(string $lastUsedIndexName = null, int $lastTaskId = null): void { - $this->checkClient(__FUNCTION__); - if ($lastUsedIndexName === null && isset(self::$lastUsedIndexName)) { $lastUsedIndexName = self::$lastUsedIndexName; } @@ -609,14 +596,14 @@ public function waitLastTask(string $lastUsedIndexName = null, int $lastTaskId = return; } - $this->client->waitForTask($lastUsedIndexName, $lastTaskId); + $this->getClient()->waitForTask($lastUsedIndexName, $lastTaskId); } /** * @param array $objects * @param string $indexName * @return void - * @throws \Exception + * @throws Exception */ protected function prepareRecords(array &$objects, string $indexName): void { @@ -684,7 +671,7 @@ protected function getMaxRecordSize(): int * @param $object * @return false|mixed */ - protected function handleTooBigRecord($object) + protected function handleTooBigRecord($object): mixed { $size = $this->calculateObjectSize($object); @@ -734,7 +721,7 @@ protected function handleTooBigRecord($object) * @param $object * @return int|string */ - protected function getLongestAttribute($object) + protected function getLongestAttribute($object): int|string { $maxLength = 0; $longestAttribute = ''; @@ -756,7 +743,7 @@ protected function getLongestAttribute($object) * @param $productData * @return void */ - public function castProductObject(&$productData) + public function castProductObject(&$productData): void { foreach ($productData as $key => &$data) { if (in_array($key, $this->nonCastableAttributes, true) === true) { @@ -785,7 +772,7 @@ public function castProductObject(&$productData) * @param $object * @return mixed */ - protected function castRecord($object) + protected function castRecord($object): mixed { foreach ($object as $key => &$value) { if (in_array($key, $this->nonCastableAttributes, true) === true) { @@ -814,9 +801,9 @@ public function isValidFloat(string $value) : bool { /** * @param $value - * @return float|int + * @return mixed */ - protected function castAttribute($value) + protected function castAttribute($value): mixed { if (is_numeric($value) && floatval($value) === floatval((int) $value)) { return (int) $value; @@ -863,7 +850,7 @@ protected function calculateObjectSize($object): int * @throws AlgoliaException * @internal This method is currently unstable and should not be used. It may be revisited ar fixed in a future version. */ - protected function searchWithDisjunctiveFaceting($indexName, $q, $params) + protected function searchWithDisjunctiveFaceting($indexName, $q, $params): mixed { throw new AlgoliaException("This function is not currently supported on PHP connector v4"); @@ -905,7 +892,7 @@ protected function searchWithDisjunctiveFaceting($indexName, $q, $params) /** * Do all queries in one call */ - $results = $this->client->multipleQueries(array_values($disjunctiveQueries)); + $results = $this->getClient()->multipleQueries(array_values($disjunctiveQueries)); $results = $results['results']; /** @@ -934,7 +921,7 @@ protected function searchWithDisjunctiveFaceting($indexName, $q, $params) * @param $queryParams * @return array */ - protected function getDisjunctiveQueries($queryParams) + protected function getDisjunctiveQueries($queryParams): array { $queriesParams = []; @@ -967,9 +954,9 @@ protected function getDisjunctiveQueries($queryParams) /** * @param $filters * @param $needle - * @return mixed + * @return array */ - protected function getAlgoliaFiltersArrayWithoutCurrentRefinement($filters, $needle) + protected function getAlgoliaFiltersArrayWithoutCurrentRefinement($filters, $needle): array { // iterate on each filters which can be string or array and filter out every refinement matching the needle for ($i = 0; $i < count($filters); $i++) { diff --git a/Helper/ConfigHelper.php b/Helper/ConfigHelper.php index 80ea53baf..c090c7a5f 100755 --- a/Helper/ConfigHelper.php +++ b/Helper/ConfigHelper.php @@ -1201,6 +1201,7 @@ public function setCustomerGroupsEnabled(bool $val, ?string $scope = null, ?int /** * @param $storeId * @return bool + * @deprecated Use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager instead */ public function credentialsAreConfigured($storeId = null) { diff --git a/Helper/Configuration/AssetHelper.php b/Helper/Configuration/AssetHelper.php index 1f1e3d2ac..14b961bcb 100644 --- a/Helper/Configuration/AssetHelper.php +++ b/Helper/Configuration/AssetHelper.php @@ -2,17 +2,11 @@ namespace Algolia\AlgoliaSearch\Helper\Configuration; -use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Framework\View\Asset\Repository as AssetRepository; class AssetHelper extends \Magento\Framework\App\Helper\AbstractHelper { - /** @var ConfigHelper */ - private $configHelper; - - /** @var AssetRepository */ - private $assetRepository; - /** @var array */ private $videosConfig = [ 'algoliasearch_credentials' => [ @@ -189,12 +183,9 @@ class AssetHelper extends \Magento\Framework\App\Helper\AbstractHelper public function __construct( \Magento\Framework\App\Helper\Context $context, - ConfigHelper $configHelper, - AssetRepository $assetRepository + protected AssetRepository $assetRepository, + protected AlgoliaCredentialsManager $algoliaCredentialsManager ) { - $this->configHelper = $configHelper; - $this->assetRepository = $assetRepository; - $this->icons = [ 'iconDocs' => $this->assetRepository->getUrl('Algolia_AlgoliaSearch::images/icon-docs.svg'), 'iconFaq' => $this->assetRepository->getUrl('Algolia_AlgoliaSearch::images/icon-faq.svg'), @@ -236,9 +227,7 @@ public function getLinksAndVideoTemplate($section) { $configNotSet = false; // Check if all the mandatory credentials have been set - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { $configNotSet = true; } diff --git a/Helper/Configuration/NoticeHelper.php b/Helper/Configuration/NoticeHelper.php index ea9f075c9..9df27fcd6 100644 --- a/Helper/Configuration/NoticeHelper.php +++ b/Helper/Configuration/NoticeHelper.php @@ -5,6 +5,7 @@ use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Model\ExtensionNotification; use Algolia\AlgoliaSearch\Model\ResourceModel\Job\CollectionFactory as JobCollectionFactory; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Framework\Module\Manager as ModuleManager; use Magento\Framework\ObjectManagerInterface; use Magento\Framework\UrlInterface; @@ -12,30 +13,6 @@ class NoticeHelper extends \Magento\Framework\App\Helper\AbstractHelper { - /** @var ConfigHelper */ - private $configHelper; - - /** @var PersonalizationHelper */ - private $personalizationHelper; - - /** @var ModuleManager */ - private $moduleManager; - - /** @var ObjectManagerInterface */ - private $objectManager; - - /** @var ExtensionNotification */ - private $extensionNotification; - - /** @var JobCollectionFactory */ - private $jobCollectionFactory; - - /** @var UrlInterface */ - protected $urlBuilder; - - /** @var AssetRepository */ - protected $assetRepository; - /** @var string[] */ protected $noticeFunctions = [ 'getQueueNotice', @@ -45,6 +22,7 @@ class NoticeHelper extends \Magento\Framework\App\Helper\AbstractHelper 'getPersonalizationNotice', 'getRecommendNotice', 'getCookieConfigurationNotice', + 'getMultiApplicationIDsNotice', ]; /** @var array[] */ @@ -60,25 +38,17 @@ class NoticeHelper extends \Magento\Framework\App\Helper\AbstractHelper protected $notices; public function __construct( - \Magento\Framework\App\Helper\Context $context, - ConfigHelper $configHelper, - PersonalizationHelper $personalizationHelper, - ModuleManager $moduleManager, - ObjectManagerInterface $objectManager, - ExtensionNotification $extensionNotification, - JobCollectionFactory $jobCollectionFactory, - UrlInterface $urlBuilder, - AssetRepository $assetRepository + protected \Magento\Framework\App\Helper\Context $context, + protected ConfigHelper $configHelper, + protected PersonalizationHelper $personalizationHelper, + protected ModuleManager $moduleManager, + protected ObjectManagerInterface $objectManager, + protected ExtensionNotification $extensionNotification, + protected JobCollectionFactory $jobCollectionFactory, + protected UrlInterface $urlBuilder, + protected AssetRepository $assetRepository, + protected AlgoliaCredentialsManager $algoliaCredentialsManager ) { - $this->configHelper = $configHelper; - $this->personalizationHelper = $personalizationHelper; - $this->moduleManager = $moduleManager; - $this->objectManager = $objectManager; - $this->extensionNotification = $extensionNotification; - $this->jobCollectionFactory = $jobCollectionFactory; - $this->urlBuilder = $urlBuilder; - $this->assetRepository = $assetRepository; - foreach ($this->noticeFunctions as $noticeFunction) { call_user_func([$this, $noticeFunction]); } @@ -372,4 +342,25 @@ protected function getRecommendNotice() 'message' => $noticeContent, ]; } + + /** + * Displays a warning when multiple application IDs are configured + * @return void + */ + protected function getMultiApplicationIDsNotice(): void + { + if (!$this->algoliaCredentialsManager->hasMultipleApplicationIDs()) { + return; + } + + $noticeTitle = 'Multi Application IDs'; + $noticeContent = '

You are currently using multiple Algolia application IDs with your Magento installation.

+

When verifying data in Algolia, please make sure you are referencing the correct application.

'; + + $this->notices[] = [ + 'selector' => '.entry-edit', + 'method' => 'before', + 'message' => $this->formatNotice($noticeTitle, $noticeContent), + ]; + } } diff --git a/Helper/Data.php b/Helper/Data.php index 64f23d571..7436729e8 100755 --- a/Helper/Data.php +++ b/Helper/Data.php @@ -25,6 +25,7 @@ use Magento\Framework\Indexer\IndexerRegistry; use Magento\Search\Model\Query; use Magento\Search\Model\ResourceModel\Query\Collection as QueryCollection; +use Magento\Store\Api\Data\StoreInterface; use Magento\Store\Model\App\Emulation; use Magento\Store\Model\StoreManagerInterface; @@ -165,6 +166,8 @@ public function rebuildStoreAdditionalSectionsIndex(int $storeId): void return; } + $this->algoliaHelper->setStoreId($storeId); + $additionalSections = $this->configHelper->getAutocompleteSections(); $protectedSections = ['products', 'categories', 'pages', 'suggestions']; @@ -188,6 +191,8 @@ public function rebuildStoreAdditionalSectionsIndex(int $storeId): void $this->algoliaHelper->moveIndex($tempIndexName, $indexName); $this->algoliaHelper->setSettings($indexName, $this->additionalSectionHelper->getIndexSettings($storeId)); + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } } @@ -209,6 +214,8 @@ public function rebuildStorePageIndex($storeId, array $pageIds = null): void return; } + $this->algoliaHelper->setStoreId($storeId); + $indexName = $this->pageHelper->getIndexName($storeId); $this->startEmulation($storeId); @@ -252,6 +259,7 @@ public function rebuildStorePageIndex($storeId, array $pageIds = null): void $this->algoliaHelper->moveIndex($tempIndexName, $indexName); } $this->algoliaHelper->setSettings($indexName, $this->pageHelper->getIndexSettings($storeId)); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** @@ -351,11 +359,12 @@ public function moveStoreSuggestionIndex(int $storeId): void if ($this->isIndexingEnabled($storeId) === false) { return; } - + $this->algoliaHelper->setStoreId($storeId); $tmpIndexName = $this->suggestionHelper->getTempIndexName($storeId); $indexName = $this->suggestionHelper->getIndexName($storeId); $this->algoliaHelper->copyQueryRules($indexName, $tmpIndexName); $this->algoliaHelper->moveIndex($tmpIndexName, $indexName); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** @@ -462,6 +471,7 @@ public function rebuildStoreSuggestionIndexPage(int $storeId, QueryCollection $c return; } + $this->algoliaHelper->setStoreId($storeId); $collection = clone $collectionDefault; $collection->setCurPage($page)->setPageSize($pageSize); $collection->load(); @@ -483,6 +493,7 @@ public function rebuildStoreSuggestionIndexPage(int $storeId, QueryCollection $c unset($indexData); $collection->walk('clearInstance'); $collection->clear(); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); unset($collection); } @@ -495,6 +506,7 @@ public function rebuildStoreCategoryIndexPage($storeId, $collection, $page, $pag if ($this->isIndexingEnabled($storeId) === false) { return; } + $this->algoliaHelper->setStoreId($storeId); $collection->setCurPage($page)->setPageSize($pageSize); $collection->load(); $indexName = $this->categoryHelper->getIndexName($storeId); @@ -519,6 +531,7 @@ public function rebuildStoreCategoryIndexPage($storeId, $collection, $page, $pag $collection->walk('clearInstance'); $collection->clear(); unset($collection); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** @@ -682,6 +695,8 @@ public function rebuildStoreProductIndexPage( return; } + $this->algoliaHelper->setStoreId($storeId); + $wrapperLogMessage = 'rebuildStoreProductIndexPage: ' . $this->logger->getStoreName($storeId) . ', page ' . $page . ', pageSize ' . $pageSize; @@ -743,6 +758,9 @@ public function rebuildStoreProductIndexPage( if ($emulationInfo === null) { $this->stopEmulation(); } + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); + $this->logger->stop($wrapperLogMessage); } @@ -856,6 +874,7 @@ protected function getSalesData($storeId, Collection $collection) public function deleteInactiveProducts($storeId): void { $indexName = $this->productHelper->getIndexName($storeId); + $this->algoliaHelper->setStoreId($storeId); $client = $this->algoliaHelper->getClient(); $objectIds = []; $counter = 0; @@ -876,6 +895,7 @@ public function deleteInactiveProducts($storeId): void if (!empty($objectIds)) { $this->deleteInactiveIds($storeId, $objectIds, $indexName); } + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** @@ -906,20 +926,39 @@ public function getBaseIndexName(int $storeId = null): string */ public function getIndexDataByStoreIds(): array { + $indexNames = []; - $indexNames[0] = [ - 'indexName' => $this->getBaseIndexName(), - 'priceKey' => '.' . $this->configHelper->getCurrencyCode() . '.default', - ]; + $indexNames[AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE] = $this->buildIndexData(); foreach ($this->storeManager->getStores() as $store) { - $indexNames[$store->getId()] = [ - 'indexName' => $this->getBaseIndexName($store->getId()), - 'priceKey' => '.' . $store->getCurrentCurrencyCode($store->getId()) . '.default', - ]; + $indexNames[$store->getId()] = $this->buildIndexData($store); } return $indexNames; } + /** + * @param StoreInterface|null $store + * @return array + * @throws NoSuchEntityException + */ + protected function buildIndexData(StoreInterface $store = null): array + { + $storeId = !is_null($store) ? $store->getStoreId() : null; + $currencyCode = !is_null($store) ? + $store->getCurrentCurrencyCode($storeId) : + $this->configHelper->getCurrencyCode(); + + return [ + 'appId' => $this->configHelper->getApplicationID($storeId), + 'apiKey' => $this->configHelper->getAPIKey($storeId), + 'indexName' => $this->getBaseIndexName($storeId), + 'priceKey' => '.' . $currencyCode . '.default', + 'facets' => $this->configHelper->getFacets($storeId), + 'currencyCode' => $this->configHelper->getCurrencyCode($storeId), + 'maxValuesPerFacet' => (int) $this->configHelper->getMaxValuesPerFacet($storeId), + 'categorySeparator' => $this->configHelper->getCategorySeparator($storeId), + ]; + } + /** * @param $storeId * @param $objectIds diff --git a/Helper/Entity/ProductHelper.php b/Helper/Entity/ProductHelper.php index 250d3cb63..45c54f5b3 100755 --- a/Helper/Entity/ProductHelper.php +++ b/Helper/Entity/ProductHelper.php @@ -350,6 +350,7 @@ public function getIndexSettings(?int $storeId = null): array */ public function setSettings(string $indexName, string $indexNameTmp, int $storeId, bool $saveToTmpIndicesToo = false): void { + $this->algoliaHelper->setStoreId($storeId); $indexSettings = $this->getIndexSettings($storeId); $this->algoliaHelper->setSettings($indexName, $indexSettings, false, true); @@ -378,6 +379,7 @@ public function setSettings(string $indexName, string $indexNameTmp, int $storeI '); } catch (AlgoliaException $e) { $this->logger->error('Error encountered while copying synonyms: ' . $e->getMessage()); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } try { @@ -390,8 +392,10 @@ public function setSettings(string $indexName, string $indexNameTmp, int $storeI if ($e->getCode() !== 404) { throw $e; } + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } } + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** @@ -1206,12 +1210,12 @@ protected function getAttributesForFaceting($storeId) } /** - * @param $indexName - * @param $storeId + * @param string $indexName + * @param int|null $storeId * @return void * @throws AlgoliaException */ - protected function setFacetsQueryRules($indexName, $storeId = null) + protected function setFacetsQueryRules(string $indexName, int $storeId = null) { $this->clearFacetsQueryRules($indexName); diff --git a/Helper/MerchandisingHelper.php b/Helper/MerchandisingHelper.php index a54090a78..942d67ec0 100755 --- a/Helper/MerchandisingHelper.php +++ b/Helper/MerchandisingHelper.php @@ -85,7 +85,9 @@ public function saveQueryRule(int $storeId, // Not catching AlgoliaSearchException for disabled query rules on purpose // It displays correct error message and navigates user to pricing page + $this->algoliaHelper->setStoreId($storeId); $this->algoliaHelper->saveRule($rule, $productsIndexName); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** @@ -106,7 +108,9 @@ public function deleteQueryRule(int $storeId, int $entityId, string $entityType) // Not catching AlgoliaSearchException for disabled query rules on purpose // It displays correct error message and navigates user to pricing page + $this->algoliaHelper->setStoreId($storeId); $this->algoliaHelper->deleteRule($productsIndexName, $ruleId); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** diff --git a/Model/IndexMover.php b/Model/IndexMover.php index 594a36987..7de50cd28 100644 --- a/Model/IndexMover.php +++ b/Model/IndexMover.php @@ -44,7 +44,9 @@ public function moveIndex(string $tmpIndexName, string $indexName, int $storeId) return; } + $this->algoliaHelper->setStoreId($storeId); $this->algoliaHelper->moveIndex($tmpIndexName, $indexName); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** diff --git a/Model/Indexer/AdditionalSection.php b/Model/Indexer/AdditionalSection.php index 73eb09db2..e4dd66ca1 100755 --- a/Model/Indexer/AdditionalSection.php +++ b/Model/Indexer/AdditionalSection.php @@ -5,34 +5,19 @@ use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Data; use Algolia\AlgoliaSearch\Model\Queue; -use Magento\Framework\Message\ManagerInterface; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Store\Model\StoreManagerInterface; -use Symfony\Component\Console\Output\ConsoleOutput; class AdditionalSection implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - private $fullAction; - private $storeManager; - private $queue; - private $configHelper; - private $messageManager; - private $output; - public function __construct( - StoreManagerInterface $storeManager, - Data $helper, - Queue $queue, - ConfigHelper $configHelper, - ManagerInterface $messageManager, - ConsoleOutput $output - ) { - $this->fullAction = $helper; - $this->storeManager = $storeManager; - $this->queue = $queue; - $this->configHelper = $configHelper; - $this->messageManager = $messageManager; - $this->output = $output; - } + protected StoreManagerInterface $storeManager, + protected Data $fullAction, + protected Queue $queue, + protected ConfigHelper $configHelper, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} public function execute($ids) { @@ -41,21 +26,6 @@ public function execute($ids) public function executeFull() { - if (!$this->configHelper->credentialsAreConfigured()) { - $errorMessage = 'Algolia reindexing failed: - You need to configure your Algolia credentials in Stores > Configuration > Algolia Search.'; - - if (php_sapi_name() === 'cli') { - $this->output->writeln($errorMessage); - - return; - } - - $this->messageManager->addErrorMessage($errorMessage); - - return; - } - $storeIds = array_keys($this->storeManager->getStores()); foreach ($storeIds as $storeId) { @@ -63,8 +33,14 @@ public function executeFull() continue; } + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + $this->queue->addToQueue( - $this->fullAction, + Data::class, 'rebuildStoreAdditionalSectionsIndex', ['storeId' => $storeId], 1 diff --git a/Model/Indexer/Category.php b/Model/Indexer/Category.php index e2d5c9ffa..38f020b9a 100755 --- a/Model/Indexer/Category.php +++ b/Model/Indexer/Category.php @@ -7,59 +7,25 @@ use Algolia\AlgoliaSearch\Helper\Entity\CategoryHelper; use Algolia\AlgoliaSearch\Model\IndicesConfigurator; use Algolia\AlgoliaSearch\Model\Queue; -use Magento\Framework\Message\ManagerInterface; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Store\Model\StoreManagerInterface; -use Symfony\Component\Console\Output\ConsoleOutput; class Category implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - private $storeManager; - private $categoryHelper; - private $fullAction; - private $queue; - private $configHelper; - private $messageManager; - private $output; - public static $affectedProductIds = []; public function __construct( - StoreManagerInterface $storeManager, - CategoryHelper $categoryHelper, - Data $helper, - Queue $queue, - ConfigHelper $configHelper, - ManagerInterface $messageManager, - ConsoleOutput $output - ) { - $this->fullAction = $helper; - $this->storeManager = $storeManager; - $this->categoryHelper = $categoryHelper; - $this->queue = $queue; - $this->configHelper = $configHelper; - $this->messageManager = $messageManager; - $this->output = $output; - } + protected StoreManagerInterface $storeManager, + protected CategoryHelper $categoryHelper, + protected Data $fullAction, + protected Queue $queue, + protected ConfigHelper $configHelper, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} public function execute($categoryIds) { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { - $errorMessage = 'Algolia reindexing failed: - You need to configure your Algolia credentials in Stores > Configuration > Algolia Search.'; - - if (php_sapi_name() === 'cli') { - $this->output->writeln($errorMessage); - - return; - } - - $this->messageManager->addErrorMessage($errorMessage); - - return; - } - $storeIds = array_keys($this->storeManager->getStores()); foreach ($storeIds as $storeId) { @@ -67,6 +33,12 @@ public function execute($categoryIds) continue; } + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + $this->rebuildAffectedProducts($storeId); $categoriesPerPage = $this->configHelper->getNumberOfElementByPage(); diff --git a/Model/Indexer/CategoryObserver.php b/Model/Indexer/CategoryObserver.php index 68fb9198e..c58ddee93 100755 --- a/Model/Indexer/CategoryObserver.php +++ b/Model/Indexer/CategoryObserver.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; -use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Model\Indexer\Category as CategoryIndexer; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Catalog\Model\Category as CategoryModel; use Magento\Catalog\Model\ResourceModel\Category as CategoryResourceModel; use Magento\Catalog\Model\ResourceModel\Product\Collection as ProductCollection; @@ -12,34 +12,15 @@ class CategoryObserver { - /** @var IndexerRegistry */ - private $indexerRegistry; - /** @var CategoryIndexer */ private $indexer; - /** @var ConfigHelper */ - private $configHelper; - - /** @var ResourceConnection */ - protected $resource; - - /** - * CategoryObserver constructor. - * - * @param IndexerRegistry $indexerRegistry - * @param ConfigHelper $configHelper - * @param ResourceConnection $resource - */ public function __construct( IndexerRegistry $indexerRegistry, - ConfigHelper $configHelper, - ResourceConnection $resource + protected ResourceConnection $resource, + protected AlgoliaCredentialsManager $algoliaCredentialsManager ) { - $this->indexerRegistry = $indexerRegistry; $this->indexer = $indexerRegistry->get('algolia_categories'); - $this->configHelper = $configHelper; - $this->resource = $resource; } /** @@ -54,9 +35,7 @@ public function afterSave( CategoryResourceModel $result, CategoryModel $category ) { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { return $result; } $categoryResource->addCommitCallback(function () use ($category) { diff --git a/Model/Indexer/DeleteProduct.php b/Model/Indexer/DeleteProduct.php index ad6078bf1..97ab9ef4a 100755 --- a/Model/Indexer/DeleteProduct.php +++ b/Model/Indexer/DeleteProduct.php @@ -3,40 +3,21 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; -use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Data; use Algolia\AlgoliaSearch\Model\Queue; -use Magento\Framework\Message\ManagerInterface; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Store\Model\StoreManagerInterface; -use Symfony\Component\Console\Output\ConsoleOutput; class DeleteProduct implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - private $fullAction; - private $storeManager; - private $algoliaHelper; - private $queue; - private $configHelper; - private $messageManager; - private $output; - public function __construct( - StoreManagerInterface $storeManager, - Data $helper, - AlgoliaHelper $algoliaHelper, - Queue $queue, - ConfigHelper $configHelper, - ManagerInterface $messageManager, - ConsoleOutput $output - ) { - $this->fullAction = $helper; - $this->storeManager = $storeManager; - $this->algoliaHelper = $algoliaHelper; - $this->queue = $queue; - $this->configHelper = $configHelper; - $this->messageManager = $messageManager; - $this->output = $output; - } + protected StoreManagerInterface $storeManager, + protected Data $fullAction, + protected AlgoliaHelper $algoliaHelper, + protected Queue $queue, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} public function execute($ids) { @@ -45,23 +26,6 @@ public function execute($ids) public function executeFull() { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { - $errorMessage = 'Algolia reindexing failed: - You need to configure your Algolia credentials in Stores > Configuration > Algolia Search.'; - - if (php_sapi_name() === 'cli') { - $this->output->writeln($errorMessage); - - return; - } - - $this->messageManager->addErrorMessage($errorMessage); - - return; - } - $storeIds = array_keys($this->storeManager->getStores()); foreach ($storeIds as $storeId) { @@ -69,6 +33,12 @@ public function executeFull() continue; } + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + $this->fullAction->deleteInactiveProducts($storeId); } } diff --git a/Model/Indexer/Page.php b/Model/Indexer/Page.php index 21dbd9d2e..4602bd58c 100755 --- a/Model/Indexer/Page.php +++ b/Model/Indexer/Page.php @@ -7,74 +7,21 @@ use Algolia\AlgoliaSearch\Helper\Data; use Algolia\AlgoliaSearch\Helper\Entity\PageHelper; use Algolia\AlgoliaSearch\Model\Queue; -use Magento\Framework\Message\ManagerInterface; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Store\Model\StoreManagerInterface; -use Symfony\Component\Console\Output\ConsoleOutput; class Page implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - /** - * @var Data - */ - protected $fullAction; - /** - * @var StoreManagerInterface - */ - protected $storeManager; - /** - * @var PageHelper - */ - protected $pageHelper; - /** - * @var AlgoliaHelper - */ - protected $algoliaHelper; - /** - * @var Queue - */ - protected $queue; - /** - * @var ConfigHelper - */ - protected $configHelper; - /** - * @var ManagerInterface - */ - protected $messageManager; - /** - * @var ConsoleOutput - */ - protected $output; - - /** - * @param StoreManagerInterface $storeManager - * @param PageHelper $pageHelper - * @param Data $helper - * @param AlgoliaHelper $algoliaHelper - * @param Queue $queue - * @param ConfigHelper $configHelper - * @param ManagerInterface $messageManager - * @param ConsoleOutput $output - */ public function __construct( - StoreManagerInterface $storeManager, - PageHelper $pageHelper, - Data $helper, - AlgoliaHelper $algoliaHelper, - Queue $queue, - ConfigHelper $configHelper, - ManagerInterface $messageManager, - ConsoleOutput $output - ) { - $this->fullAction = $helper; - $this->storeManager = $storeManager; - $this->pageHelper = $pageHelper; - $this->algoliaHelper = $algoliaHelper; - $this->queue = $queue; - $this->configHelper = $configHelper; - $this->messageManager = $messageManager; - $this->output = $output; - } + protected StoreManagerInterface $storeManager, + protected PageHelper $pageHelper, + protected Data $fullAction, + protected AlgoliaHelper $algoliaHelper, + protected Queue $queue, + protected ConfigHelper $configHelper, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} /** * @param $ids @@ -82,23 +29,6 @@ public function __construct( */ public function execute($ids) { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { - $errorMessage = 'Algolia reindexing failed: - You need to configure your Algolia credentials in Stores > Configuration > Algolia Search.'; - - if (php_sapi_name() === 'cli') { - $this->output->writeln($errorMessage); - - return; - } - - $this->messageManager->addErrorMessage($errorMessage); - - return; - } - $storeIds = $this->pageHelper->getStores(); foreach ($storeIds as $storeId) { @@ -106,6 +36,12 @@ public function execute($ids) continue; } + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + if ($this->isPagesInAdditionalSections($storeId)) { $data = ['storeId' => $storeId]; if (is_array($ids) && count($ids) > 0) { @@ -113,7 +49,7 @@ public function execute($ids) } $this->queue->addToQueue( - $this->fullAction, + Data::class, 'rebuildStorePageIndex', $data, is_array($ids) ? count($ids) : 1 diff --git a/Model/Indexer/PageObserver.php b/Model/Indexer/PageObserver.php index 6908dd8ec..6dc51e785 100644 --- a/Model/Indexer/PageObserver.php +++ b/Model/Indexer/PageObserver.php @@ -2,7 +2,7 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; -use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Framework\Indexer\IndexerRegistry; use Magento\Framework\Model\AbstractModel; @@ -10,26 +10,18 @@ class PageObserver { private $indexer; - /** - * @var ConfigHelper - */ - private $configHelper; - public function __construct( IndexerRegistry $indexerRegistry, - ConfigHelper $configHelper + protected AlgoliaCredentialsManager $algoliaCredentialsManager ) { $this->indexer = $indexerRegistry->get('algolia_pages'); - $this->configHelper = $configHelper; } public function beforeSave( \Magento\Cms\Model\ResourceModel\Page $pageResource, AbstractModel $page ) { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { return [$page]; } @@ -46,9 +38,7 @@ public function beforeDelete( \Magento\Cms\Model\ResourceModel\Page $pageResource, AbstractModel $page ) { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { return [$page]; } diff --git a/Model/Indexer/Product.php b/Model/Indexer/Product.php index f0c6bb01a..85be4476d 100755 --- a/Model/Indexer/Product.php +++ b/Model/Indexer/Product.php @@ -9,75 +9,47 @@ use Algolia\AlgoliaSearch\Model\IndexMover; use Algolia\AlgoliaSearch\Model\IndicesConfigurator; use Algolia\AlgoliaSearch\Model\Queue; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Framework\Exception\NoSuchEntityException; -use Magento\Framework\Message\ManagerInterface; use Magento\Store\Model\StoreManagerInterface; -use Symfony\Component\Console\Output\ConsoleOutput; class Product implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - private $storeManager; - private $productHelper; - private $algoliaHelper; - private $fullAction; - private $configHelper; - private $queue; - private $messageManager; - private $output; - public function __construct( - StoreManagerInterface $storeManager, - ProductHelper $productHelper, - Data $helper, - AlgoliaHelper $algoliaHelper, - ConfigHelper $configHelper, - Queue $queue, - ManagerInterface $messageManager, - ConsoleOutput $output - ) { - $this->fullAction = $helper; - $this->storeManager = $storeManager; - $this->productHelper = $productHelper; - $this->algoliaHelper = $algoliaHelper; - $this->configHelper = $configHelper; - $this->queue = $queue; - $this->messageManager = $messageManager; - $this->output = $output; - } + protected StoreManagerInterface $storeManager, + protected ProductHelper $productHelper, + protected Data $fullAction, + protected AlgoliaHelper $algoliaHelper, + protected ConfigHelper $configHelper, + protected Queue $queue, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} /** * @throws NoSuchEntityException */ public function execute($productIds) { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { - $errorMessage = 'Algolia reindexing failed: - You need to configure your Algolia credentials in Stores > Configuration > Algolia Search.'; - - if (php_sapi_name() === 'cli') { - $this->output->writeln($errorMessage); - - return; - } - - $this->messageManager->addWarning($errorMessage); - - return; - } - - if ($productIds) { - $productIds = array_unique(array_merge($productIds, $this->productHelper->getParentProductIds($productIds))); - } - $storeIds = array_keys($this->storeManager->getStores()); + $areParentsLoaded = false; foreach ($storeIds as $storeId) { if ($this->fullAction->isIndexingEnabled($storeId) === false) { continue; } + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + if ($productIds && !$areParentsLoaded) { + $productIds = array_unique(array_merge($productIds, $this->productHelper->getParentProductIds($productIds))); + $areParentsLoaded = true; + } + $productsPerPage = $this->configHelper->getNumberOfElementByPage(); if (is_array($productIds) && count($productIds) > 0) { diff --git a/Model/Indexer/QueueRunner.php b/Model/Indexer/QueueRunner.php index 09116693d..8b7b02ee0 100644 --- a/Model/Indexer/QueueRunner.php +++ b/Model/Indexer/QueueRunner.php @@ -4,29 +4,18 @@ use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Model\Queue; -use Magento\Framework\Message\ManagerInterface; -use Symfony\Component\Console\Output\ConsoleOutput; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; class QueueRunner implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { public const INDEXER_ID = 'algolia_queue_runner'; - private $configHelper; - private $queue; - private $messageManager; - private $output; - public function __construct( - ConfigHelper $configHelper, - Queue $queue, - ManagerInterface $messageManager, - ConsoleOutput $output - ) { - $this->configHelper = $configHelper; - $this->queue = $queue; - $this->messageManager = $messageManager; - $this->output = $output; - } + protected ConfigHelper $configHelper, + protected Queue $queue, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} public function execute($ids) { @@ -35,19 +24,8 @@ public function execute($ids) public function executeFull() { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { - $errorMessage = 'Algolia reindexing failed: - You need to configure your Algolia credentials in Stores > Configuration > Algolia Search.'; - - if (php_sapi_name() === 'cli') { - $this->output->writeln($errorMessage); - - return; - } - - $this->messageManager->addErrorMessage($errorMessage); + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class); return; } diff --git a/Model/Indexer/Suggestion.php b/Model/Indexer/Suggestion.php index 5e43aa87d..9173902a7 100755 --- a/Model/Indexer/Suggestion.php +++ b/Model/Indexer/Suggestion.php @@ -7,40 +7,21 @@ use Algolia\AlgoliaSearch\Helper\Data; use Algolia\AlgoliaSearch\Helper\Entity\SuggestionHelper; use Algolia\AlgoliaSearch\Model\Queue; -use Magento\Framework\Message\ManagerInterface; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Magento\Store\Model\StoreManagerInterface; -use Symfony\Component\Console\Output\ConsoleOutput; class Suggestion implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - private $fullAction; - private $storeManager; - private $suggestionHelper; - private $algoliaHelper; - private $queue; - private $configHelper; - private $messageManager; - private $output; - public function __construct( - StoreManagerInterface $storeManager, - SuggestionHelper $suggestionHelper, - Data $helper, - AlgoliaHelper $algoliaHelper, - Queue $queue, - ConfigHelper $configHelper, - ManagerInterface $messageManager, - ConsoleOutput $output - ) { - $this->fullAction = $helper; - $this->storeManager = $storeManager; - $this->suggestionHelper = $suggestionHelper; - $this->algoliaHelper = $algoliaHelper; - $this->queue = $queue; - $this->configHelper = $configHelper; - $this->messageManager = $messageManager; - $this->output = $output; - } + protected StoreManagerInterface $storeManager, + protected SuggestionHelper $suggestionHelper, + protected Data $fullAction, + protected AlgoliaHelper $algoliaHelper, + protected Queue $queue, + protected ConfigHelper $configHelper, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} public function execute($ids) { @@ -48,23 +29,6 @@ public function execute($ids) public function executeFull() { - if (!$this->configHelper->getApplicationID() - || !$this->configHelper->getAPIKey() - || !$this->configHelper->getSearchOnlyAPIKey()) { - $errorMessage = 'Algolia reindexing failed: - You need to configure your Algolia credentials in Stores > Configuration > Algolia Search.'; - - if (php_sapi_name() === 'cli') { - $this->output->writeln($errorMessage); - - return; - } - - $this->messageManager->addErrorMessage($errorMessage); - - return; - } - $storeIds = array_keys($this->storeManager->getStores()); foreach ($storeIds as $storeId) { @@ -72,7 +36,13 @@ public function executeFull() continue; } - $this->queue->addToQueue($this->fullAction, 'rebuildStoreSuggestionIndex', ['storeId' => $storeId], 1); + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + $this->queue->addToQueue(Data::class, 'rebuildStoreSuggestionIndex', ['storeId' => $storeId], 1); } } diff --git a/Model/IndicesConfigurator.php b/Model/IndicesConfigurator.php index 8179adfca..662d0485d 100644 --- a/Model/IndicesConfigurator.php +++ b/Model/IndicesConfigurator.php @@ -12,70 +12,25 @@ use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Helper\Entity\SuggestionHelper; use Algolia\AlgoliaSearch\Helper\Logger; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Algolia\AlgoliaSearch\Service\IndexNameFetcher; use Magento\Framework\Exception\NoSuchEntityException; class IndicesConfigurator { - /** @var Data */ - protected $baseHelper; - - /** @var AlgoliaHelper */ - protected $algoliaHelper; - - /** @var ConfigHelper */ - protected $configHelper; - - /** @var ProductHelper */ - protected $productHelper; - - /** @var CategoryHelper */ - protected $categoryHelper; - - /** @var PageHelper */ - protected $pageHelper; - - /** @var SuggestionHelper */ - protected $suggestionHelper; - - /** @var AdditionalSectionHelper */ - protected $additionalSectionHelper; - - /** @var Logger */ - protected $logger; - - /** - * @param Data $baseHelper - * @param AlgoliaHelper $algoliaHelper - * @param ConfigHelper $configHelper - * @param ProductHelper $productHelper - * @param CategoryHelper $categoryHelper - * @param PageHelper $pageHelper - * @param SuggestionHelper $suggestionHelper - * @param AdditionalSectionHelper $additionalSectionHelper - * @param Logger $logger - */ public function __construct( - Data $baseHelper, - AlgoliaHelper $algoliaHelper, - ConfigHelper $configHelper, - ProductHelper $productHelper, - CategoryHelper $categoryHelper, - PageHelper $pageHelper, - SuggestionHelper $suggestionHelper, - AdditionalSectionHelper $additionalSectionHelper, - Logger $logger - ) { - $this->baseHelper = $baseHelper; - $this->algoliaHelper = $algoliaHelper; - $this->configHelper = $configHelper; - $this->productHelper = $productHelper; - $this->categoryHelper = $categoryHelper; - $this->pageHelper = $pageHelper; - $this->suggestionHelper = $suggestionHelper; - $this->additionalSectionHelper = $additionalSectionHelper; - $this->logger = $logger; - } + protected Data $baseHelper, + protected AlgoliaHelper $algoliaHelper, + protected ConfigHelper $configHelper, + protected ProductHelper $productHelper, + protected CategoryHelper $categoryHelper, + protected PageHelper $pageHelper, + protected SuggestionHelper $suggestionHelper, + protected AdditionalSectionHelper $additionalSectionHelper, + protected AlgoliaCredentialsManager $algoliaCredentialsManager, + protected Logger $logger + ) + {} /** * @param int $storeId @@ -90,7 +45,7 @@ public function saveConfigurationToAlgolia(int $storeId, bool $useTmpIndex = fal $logEventName = 'Save configuration to Algolia for store: ' . $this->logger->getStoreName($storeId); $this->logger->start($logEventName); - if (!($this->configHelper->getApplicationID() && $this->configHelper->getAPIKey())) { + if (!$this->algoliaCredentialsManager->checkCredentials($storeId)) { $this->logger->log('Algolia credentials are not filled.'); $this->logger->stop($logEventName); @@ -103,6 +58,8 @@ public function saveConfigurationToAlgolia(int $storeId, bool $useTmpIndex = fal return; } + $this->algoliaHelper->setStoreId($storeId); + $this->setCategoriesSettings($storeId); $this->algoliaHelper->waitLastTask(); @@ -126,10 +83,10 @@ public function saveConfigurationToAlgolia(int $storeId, bool $useTmpIndex = fal $this->algoliaHelper->waitLastTask(); $this->setProductsSettings($storeId, $useTmpIndex); - $this->algoliaHelper->waitLastTask(); $this->setExtraSettings($storeId, $useTmpIndex); - $this->algoliaHelper->waitLastTask(); + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** @@ -273,6 +230,7 @@ protected function setExtraSettings(int $storeId, bool $saveToTmpIndicesToo): vo $this->logger->log('Index name: ' . $indexName); $this->logger->log('Extra settings: ' . json_encode($extraSettings)); $this->algoliaHelper->setSettings($indexName, $extraSettings, true); + $this->algoliaHelper->waitLastTask(); if ($section === 'products' && $saveToTmpIndicesToo) { $tempIndexName = $indexName . IndexNameFetcher::INDEX_TEMP_SUFFIX; diff --git a/Observer/AddAlgoliaAssetsObserver.php b/Observer/AddAlgoliaAssetsObserver.php index d7a5ac512..e957f7b51 100755 --- a/Observer/AddAlgoliaAssetsObserver.php +++ b/Observer/AddAlgoliaAssetsObserver.php @@ -3,7 +3,11 @@ namespace Algolia\AlgoliaSearch\Observer; use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; +use Magento\Catalog\Model\Category; +use Magento\Framework\App\Request\Http; use Magento\Framework\Event\ObserverInterface; +use Magento\Framework\Exception\NoSuchEntityException; use Magento\Framework\Registry; use Magento\Framework\View\Layout; use Magento\Framework\View\Page\Config as PageConfig; @@ -11,65 +15,49 @@ /** * Algolia search observer model - * @todo Add AlgoliaCredentialsManager to this class once it's available */ class AddAlgoliaAssetsObserver implements ObserverInterface { - protected $config; - protected $registry; - protected $storeManager; - protected $pageConfig; - protected $request; + public function __construct( + protected ConfigHelper $config, + protected Registry $registry, + protected StoreManagerInterface $storeManager, + protected PageConfig $pageConfig, + protected Http $request, + protected AlgoliaCredentialsManager $algoliaCredentialsManager + ) + {} /** - * @param ConfigHelper $configHelper - * @param Registry $registry - * @param StoreManagerInterface $storeManager - * @param PageConfig $pageConfig - * @param \Magento\Framework\App\Request\Http $http + * @throws NoSuchEntityException */ - public function __construct( - ConfigHelper $configHelper, - Registry $registry, - StoreManagerInterface $storeManager, - PageConfig $pageConfig, - \Magento\Framework\App\Request\Http $http - ) { - $this->config = $configHelper; - $this->registry = $registry; - $this->storeManager = $storeManager; - $this->pageConfig = $pageConfig; - $this->request = $http; - } - public function execute(\Magento\Framework\Event\Observer $observer) { $actionName = $this->request->getFullActionName(); if ($actionName === 'swagger_index_index') { return $this; } - if ($this->config->isEnabledFrontEnd()) { - if ($this->config->getApplicationID() && $this->config->getAPIKey()) { - if ($this->config->isAutoCompleteEnabled() || $this->config->isInstantEnabled()) { + $storeId = $this->storeManager->getStore()->getId(); + if ($this->config->isEnabledFrontEnd($storeId)) { + if ($this->algoliaCredentialsManager->checkCredentials($storeId)) { + if ($this->config->isAutoCompleteEnabled($storeId) || $this->config->isInstantEnabled($storeId)) { /** @var Layout $layout */ $layout = $observer->getData('layout'); $layout->getUpdate()->addHandle('algolia_search_handle'); - $this->loadPreventBackendRenderingHandle($layout); + $this->loadPreventBackendRenderingHandle($layout, $storeId); } } } } - private function loadPreventBackendRenderingHandle(Layout $layout) + private function loadPreventBackendRenderingHandle(Layout $layout, int $storeId): void { - $storeId = $this->storeManager->getStore()->getId(); - - if ($this->config->preventBackendRendering() === false) { + if ($this->config->preventBackendRendering($storeId) === false) { return; } - /** @var \Magento\Catalog\Model\Category $category */ + /** @var Category $category */ $category = $this->registry->registry('current_category'); if (!$category) { return; @@ -79,7 +67,7 @@ private function loadPreventBackendRenderingHandle(Layout $layout) return; } - $displayMode = $this->config->getBackendRenderingDisplayMode(); + $displayMode = $this->config->getBackendRenderingDisplayMode($storeId); if ($displayMode === 'only_products' && $category->getDisplayMode() === 'PAGE') { return; } diff --git a/Service/AlgoliaCredentialsManager.php b/Service/AlgoliaCredentialsManager.php new file mode 100644 index 000000000..b3a171f59 --- /dev/null +++ b/Service/AlgoliaCredentialsManager.php @@ -0,0 +1,94 @@ +configHelper->getApplicationID($storeId) && $this->configHelper->getAPIKey($storeId); + } + + /** + * Validates the credentials set on a given store level with an additional check on the search only API Key + * + * @param int|null $storeId + * @return bool + */ + public function checkCredentialsWithSearchOnlyAPIKey(int $storeId = null): bool + { + return $this->checkCredentials($storeId) && $this->configHelper->getSearchOnlyAPIKey($storeId); + } + + /** + * Displays an error message in the console or in the admin + * + * @param string $class + * @param int|null $storeId + * @return void + */ + public function displayErrorMessage(string $class, ?int $storeId = null): void + { + try { + $storeInfo = $storeId ? ' for store '. $this->storeManager->getStore($storeId)->getName() : ''; + $errorMessage = ' +' . $class . ': Algolia credentials missing' . $storeInfo . ' + => You need to configure your credentials in Stores > Configuration > Algolia Search.'; + + if (php_sapi_name() === 'cli') { + $this->output->writeln($errorMessage); + + return; + } + + $this->messageManager->addErrorMessage($errorMessage); + } catch (NoSuchEntityException $exception) { + $this->messageManager->addErrorMessage(__("Unable to locate store details: %1", $exception->getMessage())); + } + } + + /** + * Checks if multiple application IDs are configured + * + * @return bool + */ + public function hasMultipleApplicationIDs(): bool + { + $applications = []; + + foreach ($this->storeManager->getStores() as $store) { + $storeId = $store->getId(); + if ($this->checkCredentials($storeId)) { + if (!isset($applications[$this->configHelper->getApplicationID($storeId)])) { + $applications[$this->configHelper->getApplicationID($storeId)] = true; + } + + if (count($applications) > 1) { + return true; + } + } + } + + return false; + } +} diff --git a/Setup/Patch/Data/RebuildReplicasPatch.php b/Setup/Patch/Data/RebuildReplicasPatch.php index b5f96a39c..10a120eb7 100644 --- a/Setup/Patch/Data/RebuildReplicasPatch.php +++ b/Setup/Patch/Data/RebuildReplicasPatch.php @@ -2,9 +2,9 @@ namespace Algolia\AlgoliaSearch\Setup\Patch\Data; -use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Registry\ReplicaState; +use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; use Algolia\AlgoliaSearch\Service\Product\ReplicaManager; use Magento\Framework\App\Area; use Magento\Framework\App\State as AppState; @@ -18,14 +18,14 @@ class RebuildReplicasPatch implements DataPatchInterface { public function __construct( - protected ModuleDataSetupInterface $moduleDataSetup, - protected StoreManagerInterface $storeManager, - protected ReplicaManager $replicaManager, - protected ProductHelper $productHelper, - protected AppState $appState, - protected ReplicaState $replicaState, - protected ConfigHelper $configHelper, - protected LoggerInterface $logger + protected ModuleDataSetupInterface $moduleDataSetup, + protected StoreManagerInterface $storeManager, + protected ReplicaManager $replicaManager, + protected ProductHelper $productHelper, + protected AppState $appState, + protected ReplicaState $replicaState, + protected AlgoliaCredentialsManager $algoliaCredentialsManager, + protected LoggerInterface $logger ) {} @@ -52,11 +52,6 @@ public function getAliases(): array */ public function apply(): PatchInterface { - if (!$this->configHelper->credentialsAreConfigured()) { - $this->logger->warning("Algolia credentials are not configured. Aborting replica rebuild patch. If you need to rebuild your replicas run `bin/magento algolia:replicas:rebuild`"); - return $this; - } - $this->moduleDataSetup->getConnection()->startSetup(); try { $this->appState->setAreaCode(Area::AREA_ADMINHTML); @@ -67,10 +62,19 @@ public function apply(): PatchInterface $storeIds = array_keys($this->storeManager->getStores()); // Delete all replicas before resyncing in case of incorrect replica assignments foreach ($storeIds as $storeId) { + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->logger->warning("Algolia credentials are not configured for store $storeId. Skipping auto replica rebuild for this store. If you need to rebuild your replicas run `bin/magento algolia:replicas:rebuild`"); + continue; + } + $this->replicaManager->deleteReplicasFromAlgolia($storeId); } foreach ($storeIds as $storeId) { + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + continue; + } + $this->replicaState->setChangeState(ReplicaState::REPLICA_STATE_CHANGED, $storeId); // avoids latency $this->replicaManager->syncReplicasToAlgolia($storeId, $this->productHelper->getIndexSettings($storeId)); } diff --git a/Test/Integration/Category/MultiStoreCategoriesTest.php b/Test/Integration/Category/MultiStoreCategoriesTest.php index 11af9176d..ed8c8f947 100644 --- a/Test/Integration/Category/MultiStoreCategoriesTest.php +++ b/Test/Integration/Category/MultiStoreCategoriesTest.php @@ -4,6 +4,7 @@ use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; +use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Model\Indexer\Category; use Algolia\AlgoliaSearch\Test\Integration\MultiStoreTestCase; use Magento\Catalog\Api\CategoryRepositoryInterface; @@ -55,9 +56,12 @@ public function testMultiStoreCategoryIndices() { // Check that every store has the right number of categories foreach ($this->storeManager->getStores() as $store) { + $this->algoliaHelper->setStoreId($store->getId()); $this->assertNbOfRecordsPerStore($store->getCode(), 'categories', $this->assertValues->expectedCategory); } + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); + $defaultStore = $this->storeRepository->get('default'); $fixtureSecondStore = $this->storeRepository->get('fixture_second_store'); @@ -78,12 +82,14 @@ public function testMultiStoreCategoryIndices() $this->categoriesIndexer->execute([self::BAGS_CATEGORY_ID]); $this->algoliaHelper->waitLastTask(); + $this->algoliaHelper->setStoreId($defaultStore->getId()); $this->assertAlgoliaRecordValues( $this->indexPrefix . 'default_categories', (string) self::BAGS_CATEGORY_ID, ['name' => self::BAGS_CATEGORY_NAME] ); + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $this->assertAlgoliaRecordValues( $this->indexPrefix . 'fixture_second_store_categories', (string) self::BAGS_CATEGORY_ID, @@ -97,20 +103,25 @@ public function testMultiStoreCategoryIndices() ['is_active' => 0] ); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); $this->categoriesIndexer->execute([self::BAGS_CATEGORY_ID]); $this->algoliaHelper->waitLastTask(); + $this->algoliaHelper->setStoreId($defaultStore->getId()); $this->assertNbOfRecordsPerStore( $defaultStore->getCode(), 'categories', $this->assertValues->expectedCategory ); + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $this->assertNbOfRecordsPerStore( $fixtureSecondStore->getCode(), 'categories', $this->assertValues->expectedCategory - 1 ); + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** diff --git a/Test/Integration/Config/MultiStoreConfigTest.php b/Test/Integration/Config/MultiStoreConfigTest.php index 76e99147c..651b7d97b 100644 --- a/Test/Integration/Config/MultiStoreConfigTest.php +++ b/Test/Integration/Config/MultiStoreConfigTest.php @@ -2,6 +2,8 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Config; +use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; +use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Test\Integration\MultiStoreTestCase; @@ -26,23 +28,20 @@ public function testMultiStoreIndicesCreation() $this->setupStore($store, true); } + $defaultStore = $this->storeRepository->get('default'); + $fixtureSecondStore = $this->storeRepository->get('fixture_second_store'); + $indicesCreatedByTest = 0; - $indices = $this->algoliaHelper->listIndexes(); - foreach ($indices['items'] as $index) { - $name = $index['name']; + $this->algoliaHelper->setStoreId($defaultStore->getId()); + $indicesCreatedByTest += $this->countStoreIndices(); - if (mb_strpos($name, $this->indexPrefix) === 0) { - $indicesCreatedByTest++; - } - } + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); + $indicesCreatedByTest += $this->countStoreIndices(); // Check that the configuration created the appropriate number of indices (7 (4 mains + 3 replicas per store => 3*7=21) $this->assertEquals(21, $indicesCreatedByTest); - $defaultStore = $this->storeRepository->get('default'); - $fixtureSecondStore = $this->storeRepository->get('fixture_second_store'); - // Change category configuration at store level (attributes and ranking) $attributesFromConfig = $this->configHelper->getCategoryAdditionalAttributes($defaultStore->getId()); $attributesFromConfigAlt = $attributesFromConfig; @@ -88,10 +87,14 @@ public function testMultiStoreIndicesCreation() $fixtureSecondStore->getCode() ); + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $this->indicesConfigurator->saveConfigurationToAlgolia($fixtureSecondStore->getId()); $this->algoliaHelper->waitLastTask(); + $this->algoliaHelper->setStoreId($defaultStore->getId()); $defaultCategoryIndexSettings = $this->algoliaHelper->getSettings($this->indexPrefix . 'default_categories'); + + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $fixtureCategoryIndexSettings = $this->algoliaHelper->getSettings($this->indexPrefix . 'fixture_second_store_categories'); $attributeFromConfig = 'unordered(' . self::ADDITIONAL_ATTRIBUTE . ')'; @@ -102,12 +105,38 @@ public function testMultiStoreIndicesCreation() $this->assertNotContains($rankingFromConfig, $defaultCategoryIndexSettings['customRanking']); $this->assertContains($rankingFromConfig, $fixtureCategoryIndexSettings['customRanking']); + $this->algoliaHelper->setStoreId($defaultStore->getId()); $defaultProductIndexRules = $this->algoliaHelper->searchRules($this->indexPrefix . 'default_products'); + + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $fixtureProductIndexRules = $this->algoliaHelper->searchRules($this->indexPrefix . 'fixture_second_store_products'); // Check that the Rule has only been created for the fixture store $this->assertEquals(0, $defaultProductIndexRules['nbHits']); $this->assertEquals(1, $fixtureProductIndexRules['nbHits']); + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); + } + + /** + * @return int + * @throws AlgoliaException + */ + protected function countStoreIndices(): int + { + $indices = $this->algoliaHelper->listIndexes(); + + $indicesCreatedByTest = 0; + + foreach ($indices['items'] as $index) { + $name = $index['name']; + + if (mb_strpos($name, $this->indexPrefix) === 0) { + $indicesCreatedByTest++; + } + } + + return $indicesCreatedByTest; } protected function tearDown(): void diff --git a/Test/Integration/MultiStoreTestCase.php b/Test/Integration/MultiStoreTestCase.php index 25ea0f71b..83f82a9c0 100644 --- a/Test/Integration/MultiStoreTestCase.php +++ b/Test/Integration/MultiStoreTestCase.php @@ -3,6 +3,8 @@ namespace Algolia\AlgoliaSearch\Test\Integration; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; +use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; +use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Model\IndicesConfigurator; use Magento\Framework\Exception\LocalizedException; @@ -68,17 +70,23 @@ protected function setupStore(StoreInterface $store, bool $enableInstantSearch = { $this->setConfig( 'algoliasearch_credentials/credentials/application_id', - getenv('ALGOLIA_APPLICATION_ID'), + $store->getCode() === 'fixture_second_store' && getenv('ALGOLIA_APPLICATION_ID_ALT') ? + getenv('ALGOLIA_APPLICATION_ID_ALT') : + getenv('ALGOLIA_APPLICATION_ID'), $store->getCode() ); $this->setConfig( 'algoliasearch_credentials/credentials/search_only_api_key', - getenv('ALGOLIA_SEARCH_KEY_1') ?: getenv('ALGOLIA_SEARCH_API_KEY'), + $store->getCode() === 'fixture_second_store' && getenv('ALGOLIA_SEARCH_KEY_ALT') ? + getenv('ALGOLIA_SEARCH_KEY_ALT') : + getenv('ALGOLIA_SEARCH_KEY'), $store->getCode() ); $this->setConfig( 'algoliasearch_credentials/credentials/api_key', - getenv('ALGOLIA_API_KEY'), + $store->getCode() === 'fixture_second_store' && getenv('ALGOLIA_API_KEY_ALT') ? + getenv('ALGOLIA_API_KEY_ALT') : + getenv('ALGOLIA_API_KEY'), $store->getCode() ); $this->setConfig( @@ -91,7 +99,48 @@ protected function setupStore(StoreInterface $store, bool $enableInstantSearch = $this->setConfig(ConfigHelper::IS_INSTANT_ENABLED, 1, $store->getCode()); } + $this->algoliaHelper->setStoreId($store->getId()); $this->indicesConfigurator->saveConfigurationToAlgolia($store->getId()); $this->algoliaHelper->waitLastTask(); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); + } + + /** + * @throws ExceededRetriesException + * @throws AlgoliaException + */ + protected function tearDown(): void + { + $this->clearStoresIndices(true); + $this->clearStoresIndices(); // Remaining replicas + } + + protected function clearStoresIndices($wait = false) + { + foreach ($this->storeManager->getStores() as $store) { + $this->algoliaHelper->setStoreId($store->getId()); + $deletedStoreIndices = 0; + + $indices = $this->algoliaHelper->listIndexes(); + + foreach ($indices['items'] as $index) { + $name = $index['name']; + + if (mb_strpos($name, $this->indexPrefix) === 0) { + try { + $this->algoliaHelper->deleteIndex($name); + $deletedStoreIndices++; + } catch (AlgoliaException $e) { + // Might be a replica + } + } + } + + if ($deletedStoreIndices > 0 && $wait) { + $this->algoliaHelper->waitLastTask(); + } + } + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } } diff --git a/Test/Integration/Page/MultiStorePagesTest.php b/Test/Integration/Page/MultiStorePagesTest.php index 84cb1c5a6..0a71cdba8 100644 --- a/Test/Integration/Page/MultiStorePagesTest.php +++ b/Test/Integration/Page/MultiStorePagesTest.php @@ -4,6 +4,7 @@ use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; +use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Test\Integration\MultiStoreTestCase; use Algolia\AlgoliaSearch\Model\Indexer\Page; @@ -55,6 +56,7 @@ public function testMultiStorePageIndices() { // Check that every store has the right number of pages foreach ($this->storeManager->getStores() as $store) { + $this->algoliaHelper->setStoreId($store->getId()); $this->assertNbOfRecordsPerStore( $store->getCode(), 'pages', @@ -64,6 +66,8 @@ public function testMultiStorePageIndices() ); } + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); + $defaultStore = $this->storeRepository->get('default'); $fixtureSecondStore = $this->storeRepository->get('fixture_second_store'); @@ -80,17 +84,21 @@ public function testMultiStorePageIndices() $this->pagesIndexer->execute([self::ABOUT_US_PAGE_ID]); $this->algoliaHelper->waitLastTask(); + $this->algoliaHelper->setStoreId($defaultStore->getId()); $this->assertNbOfRecordsPerStore( $defaultStore->getCode(), 'pages', $this->assertValues->expectedPages ); + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $this->assertNbOfRecordsPerStore( $fixtureSecondStore->getCode(), 'pages', $this->assertValues->expectedExcludePages - 1 ); + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** diff --git a/Test/Integration/Product/MultiStoreProductsTest.php b/Test/Integration/Product/MultiStoreProductsTest.php index 207ce43b3..f3e67e596 100644 --- a/Test/Integration/Product/MultiStoreProductsTest.php +++ b/Test/Integration/Product/MultiStoreProductsTest.php @@ -2,6 +2,7 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Product; +use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Model\Indexer\Product; use Algolia\AlgoliaSearch\Test\Integration\MultiStoreTestCase; use Magento\Catalog\Api\Data\ProductInterface; @@ -69,6 +70,7 @@ public function testMultiStoreProductIndices() { // Check that every store has the right number of products foreach ($this->storeManager->getStores() as $store) { + $this->algoliaHelper->setStoreId($store->getId()); $this->assertNbOfRecordsPerStore( $store->getCode(), 'products', @@ -103,18 +105,22 @@ public function testMultiStoreProductIndices() $this->productsIndexer->execute([self::VOYAGE_YOGA_BAG_ID]); $this->algoliaHelper->waitLastTask(); + $this->algoliaHelper->setStoreId($defaultStore->getId()); $this->assertAlgoliaRecordValues( $this->indexPrefix . 'default_products', (string) self::VOYAGE_YOGA_BAG_ID, ['name' => self::VOYAGE_YOGA_BAG_NAME] ); + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $this->assertAlgoliaRecordValues( $this->indexPrefix . 'fixture_second_store_products', (string) self::VOYAGE_YOGA_BAG_ID, ['name' => self::VOYAGE_YOGA_BAG_NAME_ALT] ); + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); + // Unassign product from a single website (removed from test website (second and third store)) $baseWebsite = $this->websiteRepository->get('base'); @@ -128,6 +134,7 @@ public function testMultiStoreProductIndices() $this->algoliaHelper->waitLastTask(); // default store should have the same number of products + $this->algoliaHelper->setStoreId($defaultStore->getId()); $this->assertNbOfRecordsPerStore( $defaultStore->getCode(), 'products', @@ -135,17 +142,21 @@ public function testMultiStoreProductIndices() ); // Stores from test website must have one less product + $this->algoliaHelper->setStoreId($fixtureThirdStore->getId()); $this->assertNbOfRecordsPerStore( $fixtureThirdStore->getCode(), 'products', count(self::SKUS) - 1 ); + $this->algoliaHelper->setStoreId($fixtureSecondStore->getId()); $this->assertNbOfRecordsPerStore( $fixtureSecondStore->getCode(), 'products', count(self::SKUS) - 1 ); + + $this->algoliaHelper->setStoreId(AlgoliaHelper::ALGOLIA_DEFAULT_SCOPE); } /** diff --git a/Test/Integration/Product/ProductsIndexingTest.php b/Test/Integration/Product/ProductsIndexingTest.php index 1b42779ea..f953314d4 100644 --- a/Test/Integration/Product/ProductsIndexingTest.php +++ b/Test/Integration/Product/ProductsIndexingTest.php @@ -106,8 +106,8 @@ private function getValidTestProduct() */ protected function tearDown(): void { - parent::tearDown(); - $this->updateStockItem(self::OUT_OF_STOCK_PRODUCT_SKU, true); + + parent::tearDown(); } } diff --git a/Test/Integration/Product/ReplicaIndexingTest.php b/Test/Integration/Product/ReplicaIndexingTest.php index c0e27cc53..394ea1ac1 100644 --- a/Test/Integration/Product/ReplicaIndexingTest.php +++ b/Test/Integration/Product/ReplicaIndexingTest.php @@ -317,4 +317,30 @@ protected function assertNoSortingAttribute($sortAttr, $sortDir): void $this->assertFalse($this->hasSortingAttribute($sortAttr, $sortDir)); } + protected function tearDown(): void + { + parent::tearDown(); + + // Makes sure that the original values are restored in case a test is failing and doesn't finish + $this->configHelper->setSorting( + [ + [ + 'attribute' => 'price', + 'sort' => 'asc', + 'sortLabel' => 'Lowest Price' + ], + [ + 'attribute' => 'price', + 'sort' => 'desc', + 'sortLabel' => 'Highest Price' + ], + [ + 'attribute' => 'created_at', + 'sort' => 'desc', + 'sortLabel' => 'Newest first' + ] + ] + ); + } + } diff --git a/Test/Integration/TestCase.php b/Test/Integration/TestCase.php index 2c3f39ec0..d127fd5c3 100644 --- a/Test/Integration/TestCase.php +++ b/Test/Integration/TestCase.php @@ -162,6 +162,7 @@ protected function setConfigFromArray(array $settings): void { foreach ($settings as $key => $value) { $this->setConfig($key, $value); + $this->setConfig($key, $value, 'admin'); } } @@ -213,10 +214,17 @@ private function bootstrap() $this->configHelper = $this->getObjectManager()->create(ConfigHelper::class); + $this->indexPrefix = 'magento2_' . date('Y-m-d_H:i:s') . '_' . (getenv('INDEX_PREFIX') ?: 'circleci_'); + + // Admin + $this->setConfig('algoliasearch_credentials/credentials/application_id', getenv('ALGOLIA_APPLICATION_ID'), 'admin'); + $this->setConfig('algoliasearch_credentials/credentials/search_only_api_key', getenv('ALGOLIA_SEARCH_KEY'), 'admin'); + $this->setConfig('algoliasearch_credentials/credentials/api_key', getenv('ALGOLIA_API_KEY'), 'admin'); + $this->setConfig('algoliasearch_credentials/credentials/index_prefix', $this->indexPrefix, 'admin'); + // Default website $this->setConfig('algoliasearch_credentials/credentials/application_id', getenv('ALGOLIA_APPLICATION_ID')); - $this->setConfig('algoliasearch_credentials/credentials/search_only_api_key', getenv('ALGOLIA_SEARCH_KEY_1') ?: getenv('ALGOLIA_SEARCH_API_KEY')); + $this->setConfig('algoliasearch_credentials/credentials/search_only_api_key', getenv('ALGOLIA_SEARCH_KEY')); $this->setConfig('algoliasearch_credentials/credentials/api_key', getenv('ALGOLIA_API_KEY')); - $this->indexPrefix = 'magento2_' . date('Y-m-d_H:i:s') . '_' . (getenv('INDEX_PREFIX') ?: 'circleci_'); $this->setConfig('algoliasearch_credentials/credentials/index_prefix', $this->indexPrefix); $this->algoliaHelper = $this->getObjectManager()->create(AlgoliaHelper::class); diff --git a/Test/Integration/_files/second_website_with_two_stores_and_products.php b/Test/Integration/_files/second_website_with_two_stores_and_products.php index f07321e61..3283de0bb 100644 --- a/Test/Integration/_files/second_website_with_two_stores_and_products.php +++ b/Test/Integration/_files/second_website_with_two_stores_and_products.php @@ -66,13 +66,11 @@ } $configManager = $objectManager->get(\Magento\Framework\App\Config\MutableScopeConfigInterface::class); - -$configManager->setValue('algoliasearch_credentials/credentials/application_id', getenv('ALGOLIA_APPLICATION_ID')); -$configManager->setValue('algoliasearch_credentials/credentials/search_only_api_key', getenv('ALGOLIA_SEARCH_API_KEY')); -$configManager->setValue('algoliasearch_credentials/credentials/api_key', getenv('ALGOLIA_API_KEY')); -$configManager->setValue('algoliasearch_credentials/credentials/index_prefix', 'TEMP'); // Temporarily disable indexing during product assignment to stores -$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 0); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 0, 'store', 'admin'); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 0, 'store', 'default'); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 0, 'store', 'fixture_second_store'); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 0, 'store', 'fixture_third_store'); $productSkus = MultiStoreProductsTest::SKUS; $productRepository = Bootstrap::getObjectManager() @@ -84,7 +82,10 @@ $productRepository->save($product); } -$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 1); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 1, 'store', 'admin'); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 1, 'store', 'default'); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 1, 'store', 'fixture_second_store'); +$configManager->setValue('algoliasearch_credentials/credentials/enable_backend', 1, 'store', 'fixture_third_store'); /* Refresh CatalogSearch index */ /** @var IndexerRegistry $indexerRegistry */ diff --git a/view/adminhtml/templates/landingpage/search-configuration.phtml b/view/adminhtml/templates/landingpage/search-configuration.phtml index 274b74119..67937b490 100644 --- a/view/adminhtml/templates/landingpage/search-configuration.phtml +++ b/view/adminhtml/templates/landingpage/search-configuration.phtml @@ -11,15 +11,9 @@ $landingPage = $block->getLandingPage(); $landingPageId = $landingPage->getId(); $isConfig = [ - 'appId' => $configHelper->getApplicationID(), - 'apiKey' => $configHelper->getSearchOnlyAPIKey(), 'indexDataByStoreIds' => $block->getCoreHelper()->getIndexDataByStoreIds(), 'routing' => false, - 'facets' => $configHelper->getFacets(), - 'currencyCode' => $configHelper->getCurrencyCode(), - 'maxValuesPerFacet' => (int) $configHelper->getMaxValuesPerFacet(), 'landingPageConfig' => json_decode($landingPage->getConfiguration()), - 'categorySeparator' => $configHelper->getCategorySeparator(), 'searchParameters' => [ 'query' => $landingPage->getQuery(), 'hitsPerPage' => 10, @@ -79,9 +73,11 @@ $isConfig = [

Products shown on landing page

- + + +
@@ -301,490 +297,501 @@ $isConfig = [ diff --git a/view/adminhtml/web/js/components/query-merchandising.js b/view/adminhtml/web/js/components/query-merchandising.js index 556c7739e..6eb69e6d3 100644 --- a/view/adminhtml/web/js/components/query-merchandising.js +++ b/view/adminhtml/web/js/components/query-merchandising.js @@ -16,7 +16,6 @@ define( storeId: '', imports: { queryText: '${$.provider}:${$.dataScope}.query_text', - storeId: '${$.provider}:${$.dataScope}.store_id', }, }, @@ -26,12 +25,12 @@ define( $( document ).ready(function() { self.initSubscribers(); }); - + }, initObservable: function () { this._super().observe( - 'queryText storeId' + 'queryText' ); return this; }, @@ -44,16 +43,9 @@ define( window.algoliaSearch.helper.setQuery(queryText).search(); } } - ); - self.storeId.subscribe( - function (storeId) { - if (typeof window.algoliaSearch != "undefined") { - window.algoliaSearch.helper.setIndex(window.algoliaSearchConfig.indexDataByStoreIds[storeId].indexName + '_products').search(); - } - } - ); + ); }, } ); } -); \ No newline at end of file +);