diff --git a/.circleci/algolia-phpunit-code-coverage.xml b/.circleci/algolia-phpunit-code-coverage.xml new file mode 100644 index 000000000..7ef74265e --- /dev/null +++ b/.circleci/algolia-phpunit-code-coverage.xml @@ -0,0 +1,36 @@ + + + + + + /var/www/html/vendor/algolia/algoliasearch-magento-2 + + + /var/www/html/vendor/algolia/algoliasearch-magento-2/Test + + + + + /var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit + + + + . + + + + + + + + \ No newline at end of file diff --git a/.circleci/config.yml b/.circleci/config.yml index 3aca6b114..b3c389a1c 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -2,6 +2,7 @@ version: 2.1 orbs: php: circleci/php@2.0.0 + slack: circleci/slack@4.9.3 executors: magento-executor: @@ -9,10 +10,9 @@ executors: image: ubuntu-2404:2024.11.1 docker_layer_caching: true -jobs: - magento-build: - executor: - name: magento-executor +commands: + setup-magento-environment: + description: "Setup Magento environment with common configuration" parameters: php-version: type: string @@ -32,13 +32,13 @@ jobs: name: Setup folder structure and override file command: | mkdir ~/Sites - mkdir ~/Sites/unit-tests - mkdir ~/Sites/unit-coverage cd ~/Sites cat \< compose.override.yml services: phpfpm: image: markoshust/magento-php:<< parameters.php-version >>-fpm + db: + image: mariadb:10.11 EOF - run: name: Setup magento enterprise @@ -64,24 +64,113 @@ jobs: command: | bin/magento setup:di:compile bin/magento module:status Algolia_AlgoliaSearch + +jobs: + magento-build: + executor: + name: magento-executor + parameters: + php-version: + type: string + magento-version: + type: string + steps: + - setup-magento-environment: + php-version: << parameters.php-version >> + magento-version: << parameters.magento-version >> + - run: + name: Create test directories + command: | + mkdir ~/Sites/unit-tests + mkdir ~/Sites/unit-coverage + - persist_to_workspace: + root: ~/Sites + paths: + - . - run: name: Run Unit Tests and copy results to CircleCI working_directory: ~/Sites command: | - bin/cli vendor/bin/phpunit --log-junit /var/www/html/dev/tests/unit/report/junit.xml /var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit + bin/cli sed -i '//,/<\/extensions>/d' /var/www/html/dev/tests/unit/phpunit.xml.dist + bin/cli vendor/bin/phpunit -c /var/www/html/dev/tests/unit/phpunit.xml.dist --log-junit /var/www/html/dev/tests/unit/report/junit.xml /var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit docker cp $(docker compose ps -q phpfpm):/var/www/html/dev/tests/unit/report/junit.xml ./unit-tests/ - store_test_results: path: ~/Sites/unit-tests + - run: + name: Create Algolia-specific PHPUnit config for code coverage + working_directory: ~/Sites + command: | + cp ~/project/.circleci/algolia-phpunit-code-coverage.xml algolia-phpunit.xml + docker cp algolia-phpunit.xml $(docker compose ps -q phpfpm):/var/www/html/algolia-phpunit.xml - run: name: Run Unit Test Coverage and copy results to CircleCI working_directory: ~/Sites command: | - bin/cli php -d xdebug.mode=coverage vendor/bin/phpunit --log-junit /var/www/html/dev/tests/unit/report/junit.xml --coverage-html /var/www/html/dev/tests/unit/report --coverage-filter /var/www/html/vendor/algolia/algoliasearch-magento-2/ /var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit + bin/cli php -d xdebug.mode=coverage vendor/bin/phpunit -c /var/www/html/algolia-phpunit.xml --log-junit /var/www/html/dev/tests/unit/report/junit.xml --coverage-html /var/www/html/dev/tests/unit/report --coverage-text docker cp $(docker compose ps -q phpfpm):/var/www/html/dev/tests/unit/report ./unit-coverage/ - store_artifacts: path: ~/Sites/unit-coverage/report destination: test-results/magento-<< parameters.magento-version >>-php-<< parameters.php-version >> + magento-integration-test: + executor: + name: magento-executor + parameters: + php-version: + type: string + magento-version: + type: string + steps: + - setup-magento-environment: + php-version: << parameters.php-version >> + magento-version: << parameters.magento-version >> + - run: + name: Configure integration tests + working_directory: ~/Sites + command: | + bin/cli cp dev/tests/integration/phpunit.xml.dist dev/tests/integration/phpunit.xml + - run: + name: Create integration test environment file + working_directory: ~/Sites + command: | + echo "MAGENTO_ADMIN_EMAIL=john.smith@gmail.com" > .env + echo "MAGENTO_ADMIN_FIRST_NAME=john" >> .env + echo "MAGENTO_ADMIN_LAST_NAME=smith" >> .env + echo "MAGENTO_ADMIN_USER=john.smith" >> .env + echo "MAGENTO_ADMIN_PASSWORD=password123" >> .env + echo "MAGENTO_ADMIN_FRONTNAME=admin" >> .env + echo "MAGENTO_LOCALE=en_US" >> .env + echo "MAGENTO_CURRENCY=USD" >> .env + echo "MAGENTO_TIMEZONE=America/New_York" >> .env + echo "ALGOLIA_APPLICATION_ID=$ALGOLIA_APPLICATION_ID" >> .env + echo "ALGOLIA_SEARCH_KEY=$ALGOLIA_SEARCH_API_KEY" >> .env + echo "ALGOLIA_API_KEY=$ALGOLIA_API_KEY" >> .env + echo "INDEX_PREFIX=integration_test_" >> .env + docker cp .env $(docker compose ps -q phpfpm):/var/www/html/dev/tests/integration/.env + - run: + name: Prepare integration test environment + working_directory: ~/Sites + command: | + docker cp ../project/.circleci/install-config-mysql.php $(docker compose ps -q phpfpm):/var/www/html/dev/tests/integration/etc/install-config-mysql.php + bin/magento module:enable --all + bin/setup-integration-tests + - run: + name: Run Integration Tests + working_directory: ~/Sites + command: | + bin/cli bash -c "cd ./dev/tests/integration && export $(cat .env | xargs) && ../../../vendor/bin/phpunit --debug --exclude-group problematic ../../../vendor/algolia/algoliasearch-magento-2/Test/Integration/" + + notify: + docker: + - image: cimg/base:current + steps: + - slack/notify: + event: fail + template: basic_fail_1 + - slack/notify: + event: pass + template: success_tagged_deploy_1 + workflows: magento-build-and-test-workflow: jobs: @@ -90,3 +179,20 @@ workflows: parameters: php-version: ["8.2"] magento-version: ["2.4.6-p11", "2.4.7-p6"] + - notify: + context: mage-slack +# magento-integration-test-workflow: +# when: +# or: +# - equal: [ main, << pipeline.git.branch >> ] +# - matches: +# pattern: ".*release.*" +# value: << pipeline.git.branch >> +# jobs: +# - magento-integration-test: +# matrix: +# parameters: +# php-version: ["8.2"] +# magento-version: ["2.4.7-p6"] +# - notify: +# context: mage-slack diff --git a/.circleci/install-config-mysql.php b/.circleci/install-config-mysql.php new file mode 100644 index 000000000..413798435 --- /dev/null +++ b/.circleci/install-config-mysql.php @@ -0,0 +1,39 @@ + 'db', + 'db-user' => 'magento', + 'db-password' => 'magento', + 'db-name' => 'magento_integration_tests', + 'db-prefix' => '', + 'backend-frontname' => 'backend', + 'search-engine' => 'opensearch', + 'opensearch-host' => 'opensearch', + 'admin-user' => \Magento\TestFramework\Bootstrap::ADMIN_NAME, + 'admin-password' => \Magento\TestFramework\Bootstrap::ADMIN_PASSWORD, + 'admin-email' => \Magento\TestFramework\Bootstrap::ADMIN_EMAIL, + 'admin-firstname' => \Magento\TestFramework\Bootstrap::ADMIN_FIRSTNAME, + 'admin-lastname' => \Magento\TestFramework\Bootstrap::ADMIN_LASTNAME, + 'amqp-host' => 'rabbitmq', + 'amqp-port' => '5672', + 'amqp-user' => 'magento', + 'amqp-password' => 'magento', + 'consumers-wait-for-messages' => '0', + 'session-save' => 'redis', + 'session-save-redis-host' => 'redis', + 'session-save-redis-port' => 6379, + 'session-save-redis-db' => 5, + 'session-save-redis-max-concurrency' => 20, + 'cache-backend' => 'redis', + 'cache-backend-redis-server' => 'redis', + 'cache-backend-redis-db' => 4, + 'cache-backend-redis-port' => 6379, + 'page-cache' => 'redis', + 'page-cache-redis-server' => 'redis', + 'page-cache-redis-db' => 3, + 'page-cache-redis-port' => 6379 +]; \ No newline at end of file diff --git a/Api/Insights/EventProcessorInterface.php b/Api/Insights/EventProcessorInterface.php index 328e96269..54e5107e0 100644 --- a/Api/Insights/EventProcessorInterface.php +++ b/Api/Insights/EventProcessorInterface.php @@ -91,7 +91,7 @@ public function convertAddToCart( string $eventName, string $indexName, Item $item, - string $queryID = null + ?string $queryID = null ): array; /** @@ -123,7 +123,7 @@ public function convertPurchaseForItems( string $eventName, string $indexName, array $items, - string $queryID = null + ?string $queryID = null ): array; } diff --git a/Api/LoggerInterface.php b/Api/LoggerInterface.php new file mode 100644 index 000000000..3337f9980 --- /dev/null +++ b/Api/LoggerInterface.php @@ -0,0 +1,4 @@ +getResource()->load($landingPage, $modelId); return $landingPage; - } catch (\Magento\Framework\Exception\NoSuchEntityException $e) { + } catch (\Magento\Framework\Exception\NoSuchEntityException) { } return null; diff --git a/Block/Adminhtml/Query/Edit/AbstractButton.php b/Block/Adminhtml/Query/Edit/AbstractButton.php index 7ab52306d..e7e1fc680 100644 --- a/Block/Adminhtml/Query/Edit/AbstractButton.php +++ b/Block/Adminhtml/Query/Edit/AbstractButton.php @@ -52,7 +52,7 @@ public function getObject() $query->getResource()->load($query, $modelId); return $query; - } catch (\Magento\Framework\Exception\NoSuchEntityException $e) { + } catch (\Magento\Framework\Exception\NoSuchEntityException) { } return null; diff --git a/Block/Adminhtml/Queue/Status.php b/Block/Adminhtml/Queue/Status.php index 5faa548b4..10bd9c400 100644 --- a/Block/Adminhtml/Queue/Status.php +++ b/Block/Adminhtml/Queue/Status.php @@ -70,20 +70,12 @@ public function isQueueActive() public function getQueueRunnerStatus() { $status = 'unknown'; - switch ($this->queueRunnerIndexer->getStatus()) { - case \Magento\Framework\Indexer\StateInterface::STATUS_VALID: - $status = 'Ready'; - - break; - case \Magento\Framework\Indexer\StateInterface::STATUS_INVALID: - $status = 'Reindex required'; - - break; - case \Magento\Framework\Indexer\StateInterface::STATUS_WORKING: - $status = 'Processing'; - - break; - } + $status = match ($this->queueRunnerIndexer->getStatus()) { + \Magento\Framework\Indexer\StateInterface::STATUS_VALID => 'Ready', + \Magento\Framework\Indexer\StateInterface::STATUS_INVALID => 'Reindex required', + \Magento\Framework\Indexer\StateInterface::STATUS_WORKING => 'Processing', + default => $status, + }; return $status; } diff --git a/Block/Adminhtml/Reindex/AbstractReindexAllButton.php b/Block/Adminhtml/Reindex/AbstractReindexAllButton.php new file mode 100644 index 000000000..e52cfc22a --- /dev/null +++ b/Block/Adminhtml/Reindex/AbstractReindexAllButton.php @@ -0,0 +1,61 @@ +entity; + } + + /** + * @return string + */ + protected function getRedirectPath(): string + { + return $this->redirectPath; + } + + /** + * @return array + */ + public function getButtonData(): array + { + $entity = $this->getEntity(); + $redirectPath = $this->getRedirectPath(); + + $message = "Are you sure you want to reindex all $entity to Algolia ?"; + + if (!$this->configHelper->isQueueActive() && $entity === 'products') { + $message .= ' Warning : Your Indexing Queue is not activated. Depending on the size of the data you want to index, it may takes a lot of time and resources.'; + $message .= 'We highly suggest to turn it on if you\'re performing a full product reindexing with a large catalog.'; + } + + $message = htmlentities(__($message)); + $url = $this->context->getUrlBuilder()->getUrl('algolia_algoliasearch/indexingmanager/reindex'); + + return [ + 'label' => __('Reindex All ' . ucfirst($this->getEntity()) . ' to Algolia'), + 'class' => 'algolia_reindex_all', + 'on_click' => "deleteConfirm('{$message}', '{$url}', {data:{'entity':'{$entity}', 'redirect': '{$redirectPath}'}})", + 'sort_order' => 5, + ]; + } +} diff --git a/Block/Adminhtml/Reindex/ReindexAll/Page.php b/Block/Adminhtml/Reindex/ReindexAll/Page.php new file mode 100644 index 000000000..12d7740f5 --- /dev/null +++ b/Block/Adminhtml/Reindex/ReindexAll/Page.php @@ -0,0 +1,12 @@ +getHtmlId(); + + $html = $this->getCss($elementId); + + $html .= sprintf('
', $elementId); + $name = $element->getName(); + $options = $element->getValues(); + $values = empty($element->getValue()) ? [] : explode(',', $element->getValue()); // store as CSV in config + + foreach ($options as $key => $option) { + $value = $option['value']; + $html .= $this->getCheckboxHtml( + $elementId . '_' . $key, + $name, + $value, + in_array($value, $values), + $option['label'], + array_key_exists('description', $option) ? $option['description'] : '' + ); + } + + $html .= '
'; + return $html; + } + + protected function getCss($elementId): string { + return << + #$elementId .form-group { + display: grid; + grid-template-columns: 24px 1fr; + align-items: start; + margin-bottom: 20px; + } + + #$elementId .form-group input[type="checkbox"] { + margin-top: 2px; + } + #$elementId .form-content { + display: flex; + flex-direction: column; + } + #$elementId .form-content label { + font-weight: bold; + color: #333; + } + #$elementId .form-content .description { + font-size: 0.9em; + color: #666; + margin-top: 2px; + } + + CSS; + } + + protected function getCheckboxHtml( + string $id, + string $name, + string $value, + bool $checked, + ?string $label = null, + ?string $description = null + ): string + { + $html = '
'; + $html .= sprintf( + '', + $id, + $name, + $value, + $checked ? 'checked' : '' + ); + $html .= '
'; + $html .= sprintf('',$id, $label ?? $name); + if ($description) { + $html .= sprintf('%s', $description); + } + $html .= '
'; + $html .= '
'; + return $html; + } +} diff --git a/Block/Algolia.php b/Block/Algolia.php index 528626603..01113b45f 100755 --- a/Block/Algolia.php +++ b/Block/Algolia.php @@ -2,8 +2,9 @@ namespace Algolia\AlgoliaSearch\Block; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper; +use Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper; use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper; use Algolia\AlgoliaSearch\Helper\Data as CoreHelper; use Algolia\AlgoliaSearch\Helper\Entity\CategoryHelper; @@ -13,6 +14,7 @@ use Algolia\AlgoliaSearch\Model\LandingPage as LandingPageModel; use Algolia\AlgoliaSearch\Registry\CurrentCategory; use Algolia\AlgoliaSearch\Registry\CurrentProduct; +use Algolia\AlgoliaSearch\Service\AlgoliaConnector; use Algolia\AlgoliaSearch\Service\Product\SortingTransformer; use Magento\Catalog\Api\Data\CategoryInterface; use Magento\Catalog\Api\Data\ProductInterface; @@ -40,12 +42,15 @@ class Algolia extends Template implements CollectionDataSourceInterface public function __construct( protected ConfigHelper $config, + protected AutocompleteHelper $autocompleteConfig, + protected InstantSearchHelper $instantSearchConfig, + protected PersonalizationHelper $personalizationHelper, protected CatalogSearchHelper $catalogSearchHelper, protected ProductHelper $productHelper, protected Currency $currency, protected Format $format, protected CurrentProduct $currentProduct, - protected AlgoliaHelper $algoliaHelper, + protected AlgoliaConnector $algoliaConnector, protected UrlHelper $urlHelper, protected FormKey $formKey, protected HttpContext $httpContext, @@ -53,7 +58,6 @@ public function __construct( protected CategoryHelper $categoryHelper, protected SuggestionHelper $suggestionHelper, protected LandingPageHelper $landingPageHelper, - protected PersonalizationHelper $personalizationHelper, protected CheckoutSession $checkoutSession, protected DateTime $date, protected CurrentCategory $currentCategory, @@ -103,11 +107,6 @@ public function getCatalogSearchHelper(): CatalogSearchHelper return $this->catalogSearchHelper; } - public function getAlgoliaHelper(): AlgoliaHelper - { - return $this->algoliaHelper; - } - public function getPersonalizationHelper(): PersonalizationHelper { return $this->personalizationHelper; @@ -208,7 +207,7 @@ protected function getAddToCartUrl($additional = []): string $urlParamName = ActionInterface::PARAM_NAME_URL_ENCODED; $routeParams = [ $urlParamName => $continueUrl, - '_secure' => $this->algoliaHelper->getRequest()->isSecure(), + '_secure' => $this->getRequest()->isSecure(), ]; if ($additional !== []) { $routeParams = array_merge($routeParams, $additional); diff --git a/Block/Checkout/Conversion.php b/Block/Checkout/Conversion.php index 0eb95b4bd..b1f314183 100644 --- a/Block/Checkout/Conversion.php +++ b/Block/Checkout/Conversion.php @@ -54,7 +54,7 @@ public function getOrderItemsConversionJson() /** @var Item $item */ foreach ($orderItems as $item) { if ($item->hasData(InsightsHelper::QUOTE_ITEM_QUERY_PARAM)) { - $orderItemsData[$item->getProductId()] = json_decode($item->getData(InsightsHelper::QUOTE_ITEM_QUERY_PARAM)); + $orderItemsData[$item->getProductId()] = json_decode((string) $item->getData(InsightsHelper::QUOTE_ITEM_QUERY_PARAM)); } } diff --git a/Block/Configuration.php b/Block/Configuration.php index 58e7c09ac..f788e5473 100755 --- a/Block/Configuration.php +++ b/Block/Configuration.php @@ -4,6 +4,8 @@ use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\InsightsHelper; +use Algolia\AlgoliaSearch\Model\Source\AutocompleteRedirectMode; +use Algolia\AlgoliaSearch\Model\Source\InstantSearchRedirectOptions; use Magento\Framework\App\Request\Http; use Magento\Framework\Data\CollectionDataSourceInterface; use Magento\Framework\DataObject; @@ -55,7 +57,7 @@ protected function initCategoryParentPath(\Magento\Catalog\Model\Category $cat): * @param array $arr * @return array */ - protected function getChildCategoryUrls(\Magento\Catalog\Model\Category $cat, string $parent = '', array $arr = array()): array { + protected function getChildCategoryUrls(\Magento\Catalog\Model\Category $cat, string $parent = '', array $arr = []): array { if (!$parent) { $parent = $this->initCategoryParentPath($cat); } @@ -80,7 +82,7 @@ public function getConfiguration() $suggestionHelper = $this->getSuggestionHelper(); - $algoliaHelper = $this->getAlgoliaHelper(); + $algoliaConnector = $this->algoliaConnector; $persoHelper = $this->getPersonalizationHelper(); @@ -185,32 +187,8 @@ public function getConfiguration() $attributesToFilter = $config->getAttributesToFilter($customerGroupId); $algoliaJsConfig = [ - 'instant' => [ - 'enabled' => $config->isInstantEnabled(), - 'selector' => $config->getInstantSelector(), - 'isAddToCartEnabled' => $config->isAddToCartEnable(), - 'addToCartParams' => $addToCartParams, - 'infiniteScrollEnabled' => $config->isInfiniteScrollEnabled(), - 'urlTrackedParameters' => $this->getUrlTrackedParameters(), - 'isSearchBoxEnabled' => $config->isInstantSearchBoxEnabled(), - 'isVisualMerchEnabled' => $config->isVisualMerchEnabled(), - 'categorySeparator' => $config->getCategorySeparator(), - 'categoryPageIdAttribute' => $config->getCategoryPageIdAttributeName(), - 'isCategoryNavigationEnabled' => self::IS_CATEGORY_NAVIGATION_ENABLED, - 'hidePagination' => $config->hidePaginationInInstantSearchPage() - ], - 'autocomplete' => [ - 'enabled' => $config->isAutoCompleteEnabled(), - 'selector' => $config->getAutocompleteSelector(), - 'sections' => $config->getAutocompleteSections(), - 'nbOfProductsSuggestions' => $config->getNumberOfProductsSuggestions(), - 'nbOfCategoriesSuggestions' => $config->getNumberOfCategoriesSuggestions(), - 'nbOfQueriesSuggestions' => $config->getNumberOfQueriesSuggestions(), - 'isDebugEnabled' => $config->isAutocompleteDebugEnabled(), - 'isNavigatorEnabled' => $config->isAutocompleteNavigatorEnabled(), - 'debounceMilliseconds' => $config->getAutocompleteDebounceMilliseconds(), - 'minimumCharacters' => $config->getAutocompleteMinimumCharacterLength() - ], + 'instant' => $this->getInstantSearchConfig($addToCartParams), + 'autocomplete' => $this->getAutocompleteConfiguration(), 'landingPage' => [ 'query' => $this->getLandingPageQuery(), 'configuration' => $this->getLandingPageConfiguration(), @@ -244,8 +222,10 @@ public function getConfiguration() ], 'extensionVersion' => $config->getExtensionVersion(), 'applicationId' => $config->getApplicationID(), + // Legacy misnomer - retained for backward compatibility 'indexName' => $coreHelper->getBaseIndexName(), - 'apiKey' => $algoliaHelper->generateSearchSecuredApiKey( + 'baseIndexName' => $coreHelper->getBaseIndexName(), + 'apiKey' => $algoliaConnector->generateSearchSecuredApiKey( $config->getSearchOnlyAPIKey(), $attributesToFilter, $this->getStoreId() @@ -368,6 +348,7 @@ public function getConfiguration() 'products' => __('Products'), 'suggestions' => __('Suggestions'), 'searchBy' => __('Search by'), + 'redirectSearchPrompt' => __("Continue search for"), 'searchForFacetValuesPlaceholder' => __('Search for other ...'), 'showMore' => __('Show more products'), 'searchTitle' => __('Search results for'), @@ -381,6 +362,59 @@ public function getConfiguration() return $transport->getData(); } + protected function getAutocompleteConfiguration(): array + { + $config = $this->autocompleteConfig; + return [ + 'enabled' => $config->isEnabled(), + 'selector' => $config->getDomSelector(), + 'sections' => $config->getAdditionalSections(), + 'nbOfProductsSuggestions' => $config->getNumberOfProductsSuggestions(), + 'nbOfCategoriesSuggestions' => $config->getNumberOfCategoriesSuggestions(), + 'nbOfQueriesSuggestions' => $config->getNumberOfQueriesSuggestions(), + 'isDebugEnabled' => $config->isDebugEnabled(), + 'isNavigatorEnabled' => $config->isKeyboardNavigationEnabled(), + 'debounceMilliseconds' => $config->getDebounceMilliseconds(), + 'minimumCharacters' => $config->getMinimumCharacterLength(), + 'redirects' => [ + 'enabled' => $config->isRedirectEnabled(), + 'showSelectableRedirect' => $config->getRedirectMode() !== AutocompleteRedirectMode::SUBMIT_ONLY, + 'showHitsWithRedirect' => $config->getRedirectMode() !== AutocompleteRedirectMode::SELECTABLE_REDIRECT, + 'openInNewWindow' => $config->isRedirectInNewWindowEnabled() + ] + ]; + } + + protected function getInstantSearchConfig(array $addToCartParams): array + { + $config = $this->instantSearchConfig; + $redirectOptions = $config->getInstantRedirectOptions(); + $mainConfig = $this->config; + + return [ + 'enabled' => $config->isEnabled(), + 'selector' => $config->getDomSelector(), + 'isAddToCartEnabled' => $config->isAddToCartEnabled(), + 'addToCartParams' => $addToCartParams, + 'infiniteScrollEnabled' => $config->isInfiniteScrollEnabled(), + 'urlTrackedParameters' => $this->getUrlTrackedParameters(), + 'isSearchBoxEnabled' => $config->isSearchBoxEnabled(), + 'isVisualMerchEnabled' => $mainConfig->isVisualMerchEnabled(), + 'categorySeparator' => $mainConfig->getCategorySeparator(), + 'categoryPageIdAttribute' => $mainConfig->getCategoryPageIdAttributeName(), + 'isCategoryNavigationEnabled' => self::IS_CATEGORY_NAVIGATION_ENABLED, + 'hidePagination' => $config->shouldHidePagination(), + 'isDynamicFacetsEnabled' => $config->isDynamicFacetsEnabled(), + 'redirects' => [ + 'enabled' => $config->isInstantRedirectEnabled(), + 'onPageLoad' => in_array(InstantSearchRedirectOptions::REDIRECT_ON_PAGE_LOAD, $redirectOptions), + 'onSearchAsYouType' => in_array(InstantSearchRedirectOptions::REDIRECT_ON_SEARCH_AS_YOU_TYPE, $redirectOptions), + 'showSelectableRedirect' => in_array(InstantSearchRedirectOptions::SELECTABLE_REDIRECT, $redirectOptions), + 'openInNewWindow' => in_array(InstantSearchRedirectOptions::OPEN_IN_NEW_WINDOW, $redirectOptions) + ] + ]; + } + protected function areCategoriesInFacets($facets) { return in_array('categories', array_column($facets, 'attribute')); diff --git a/Block/LandingPage.php b/Block/LandingPage.php index 7ee2c1423..a41ad2bef 100644 --- a/Block/LandingPage.php +++ b/Block/LandingPage.php @@ -90,7 +90,7 @@ protected function _prepareLayout() $page = $this->getPage(); $this->pageConfig->addBodyClass('algolia-landingpage-' . $page->getUrlKey()); $metaTitle = $page->getMetaTitle(); - $this->pageConfig->getTitle()->set($page->getTitle() ? $page->getTitle() : $metaTitle); + $this->pageConfig->getTitle()->set($page->getTitle() ?: $metaTitle); $this->pageConfig->setKeywords($page->getMetaKeywords()); $this->pageConfig->setDescription($page->getMetaDescription()); diff --git a/Block/Navigation/Renderer/SliderRenderer.php b/Block/Navigation/Renderer/SliderRenderer.php index d29210871..9030aa310 100644 --- a/Block/Navigation/Renderer/SliderRenderer.php +++ b/Block/Navigation/Renderer/SliderRenderer.php @@ -158,6 +158,6 @@ private function getUrlTemplate() $regexp = "/({$filter->getRequestVar()})=(-?[0-9A-Z\-\%]+)/"; $replacement = '${1}=<%- from %>-<%- to %>'; - return preg_replace($regexp, $replacement, $item->getUrl()); + return preg_replace($regexp, $replacement, (string) $item->getUrl()); } } diff --git a/Block/System/Form/Field/Select.php b/Block/System/Form/Field/Select.php index 164a605b4..a433413df 100755 --- a/Block/System/Form/Field/Select.php +++ b/Block/System/Form/Field/Select.php @@ -9,6 +9,6 @@ protected function _toHtml() $this->setData('name', $this->getData('input_name')); $this->setClass('select'); - return trim(preg_replace('/\s+/', ' ', parent::_toHtml())); + return trim((string) preg_replace('/\s+/', ' ', parent::_toHtml())); } } diff --git a/Block/Widget/LookingSimilar.php b/Block/Widget/LookingSimilar.php index e04cee45f..23c82a59c 100644 --- a/Block/Widget/LookingSimilar.php +++ b/Block/Widget/LookingSimilar.php @@ -51,7 +51,7 @@ public function generateUniqueToken() */ public function getProductIds() { - return json_encode(explode(",", $this->getData('productIds'))); + return json_encode(explode(",", (string) $this->getData('productIds'))); } /** diff --git a/CHANGELOG.md b/CHANGELOG.md index 8aa9e56ce..3464ba3c1 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,54 @@ # CHANGE LOG +## 3.16.0 + +### Features + +- Automatic full indexing has been deprecated in 3.16 - you can now opt out of Algolia initiating full reindexing from `indexer_reindex_all_invalid`. +- Added an "Indexing Manager" section within the Algolia configuration which allows disabling automatic full reindexing with Magento indexers. **IMPORTANT: If you want to perform full reindexing, we highly suggest to turn this configuration off and run the newly created CLI commands instead.** +- Added an "Indexing Manager" page which shows the created indices for main entities (products, categories and pages) and corresponding stores with a link to directly check them on the Algolia dashboard along with a form to reindex those entities directly from the Magento admin. +- CLI commands are now provided to run explicit full reindex of all entities and stores. +- Products and CMS pages can now be reindexed directly from Magento admin grids. +- The indexing queue cron job can now be configured from the Magento admin. +- Dynamic faceting through Algolia merchandising rules is now supported in Magento via an opt-in feature flag. +- No code redirects via merchandising rules in Algolia are now supported in Magento for both Autocomplete and InstantSearch. Support is enabled by default for Autocomplete. +- Settings updates are now automatically forwarded to replicas (if this behavior is not desirable it can be disabled in the admin) +- Integration tests and unit tests added + +### Bug Fixes +- Behavior of conjunctive vs disjunctive facets has been clarified. +- Replica data patches and delete operations have been enhanced to handle potential latency when detaching from the primary index. +- Prices are now indexed using store scoped currency codes. +- Fixed WSOD error on invalid creds when using manual SKU indexer (also included in 3.15.1). +- Fixed Recommend model validation when configuring through the Magento admin +- Fixed edge case with null queries - thank you @PromInc +- Removed conditional behavior on setting the vary string from the plugin on `\Magento\Framework\App\Http\Context` so that a consistent `X-Magento-Vary` cookie is sent across all requests + +### Updates +- `beforecontent.html` is no longer used and has been deprecated. If you're overriding or referencing this file, please update your layout and customizations accordingly. +- An additional separate crontab is no longer needed to run the indexing queue. Enable via admin config to run the queue using Magento's built-in cron. +- `BatchQueueProcessorInterface` has been introduced to decouple Algolia operations for core `Indexer` models. +- Magento will set a default `renderingContent` based on its configured facets. Be sure that "Facet Display" is supported by your Algolia plan before attempting to use. +- Auto full indexing can be disabled in this release under Stores > Configuration > Algolia Search > Indexing Manager. We are moving towards more intentional indexing so please note that this will become the default in a future release. +- InstantSearch has been refactored to support customization via JavaScript mixins. +- A new front end hook called `beforeFacetInitialization` has been added which allows a user to extend the functionality by adding, removing or modifying "builder" functions which are used to define a facet config that will drive the rendering of facets. +- Removed InstantSearch enablement dependency in Magento admin to prevent losing facet and sorting config when disabling the feature. +- InstantSearch has been updated to v4.78. +- Autocomplete has been updated to v1.18.1. +- PHP API client has been pinned to 4.18.3 (also included in 3.15.1). +- Credentials form expanded by default in admin +- Removed deprecated methods from Entity Helpers +- Removed every call to deprecated `AlgoliaHelper`'s methods in the codebase, `AlgoliaConnector` is now targeted directly. (`AlgoliaHelper` will be removed in a future v3.17.0) +- Updated integration tests +- Added support for PHPUnit 10 +- Added support for Magento 2.4.8 on PHP 8.4 - Special shout out to @jajajaime for his help here +- Refactored code to PHP 8.2 baseline standard +- Added string escaping to untrusted inputs +- The InstantSearch "replace categories" feature must now be explicitly enabled on new instances aligning with our documentation: https://www.algolia.com/doc/integration/magento-2/guides/category-pages/#enable-category-pages + +### Breaking Changes +- `ProductHelper::setSettings()` is now taking `IndexOptions` objects as two first parameters instead of index names (strings). + ## 3.15.1 ### Features @@ -50,6 +99,7 @@ - Fixed a bug where categories highlighting didn't work as expected on PLP powered by InstantSearch - Fixed a bug where excluded websites weren't taken into account while indexing customer prices on products. (thanks @kamilszewczyk) - Fixed a bug where full page cache (FPC) didn't work on category pages +- Fixed a bug where credentials errors weren't gracefully handled on the SKU reindexing form ### Breaking Changes - If you have customized your front end implementation based on the `algoliaBundle` you may need to shim your application accordingly (Full details are shared in [our documentation](https://www.algolia.com/doc/integration/magento-2/troubleshooting/front-end-issues/)) diff --git a/Console/Command/AbstractStoreCommand.php b/Console/Command/AbstractStoreCommand.php index 18b5363fd..f6481f9c8 100644 --- a/Console/Command/AbstractStoreCommand.php +++ b/Console/Command/AbstractStoreCommand.php @@ -87,7 +87,7 @@ protected function getStoreIds(InputInterface $input): array protected function validateStoreIds(array $storeIds): array { foreach ($storeIds as $storeId) { - if (!ctype_digit($storeId) || (int) $storeId < 1) { + if (!ctype_digit((string) $storeId) || (int) $storeId < 1) { throw new LocalizedException(__("Store ID argument must be an integer")); } } @@ -123,7 +123,7 @@ protected function decorateOperationAnnouncementMessage(string $msg, array $stor { $msg = str_replace('{{target}}', $this->getOperationTargetLabel($storeIds), $msg); return ($storeIds) - ? "$msg: " . join(", ", $this->storeNameFetcher->getStoreNames($storeIds)) . '' + ? "$msg: " . implode(", ", $this->storeNameFetcher->getStoreNames($storeIds)) . '' : "$msg"; } diff --git a/Console/Command/Indexer/AbstractIndexerCommand.php b/Console/Command/Indexer/AbstractIndexerCommand.php new file mode 100644 index 000000000..e8f77ab3d --- /dev/null +++ b/Console/Command/Indexer/AbstractIndexerCommand.php @@ -0,0 +1,41 @@ +getStoreIds($input); + + if (count($storeIds) === 0) { + $storeIds = array_keys($this->storeManager->getStores()); + } + + return $storeIds; + } +} diff --git a/Console/Command/Indexer/DeleteProductsCommand.php b/Console/Command/Indexer/DeleteProductsCommand.php new file mode 100644 index 000000000..094e001ee --- /dev/null +++ b/Console/Command/Indexer/DeleteProductsCommand.php @@ -0,0 +1,54 @@ +output = $output; + $this->input = $input; + $this->setAreaCode(); + + $storeIds = $this->getStoreIdsToIndex($input); + + foreach ($storeIds as $storeId) { + $output->writeln('Deleting inactive products for ' . $this->storeNameFetcher->getStoreName($storeId)) . ''; + $this->productBatchQueueProcessor->deleteInactiveProducts($storeId); + } + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/Indexer/IndexAdditionalSectionsCommand.php b/Console/Command/Indexer/IndexAdditionalSectionsCommand.php new file mode 100644 index 000000000..e03c9b023 --- /dev/null +++ b/Console/Command/Indexer/IndexAdditionalSectionsCommand.php @@ -0,0 +1,55 @@ +output = $output; + $this->input = $input; + $this->setAreaCode(); + + $storeIds = $this->getStoreIdsToIndex($input); + + foreach ($storeIds as $storeId) { + $output->writeln( + 'Reindexing additional sections for ' . $this->storeNameFetcher->getStoreName($storeId)) . ''; + $this->additionalSectionBatchQueueProcessorr->processBatch($storeId); + } + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/Indexer/IndexAllCommand.php b/Console/Command/Indexer/IndexAllCommand.php new file mode 100644 index 000000000..afa1cb374 --- /dev/null +++ b/Console/Command/Indexer/IndexAllCommand.php @@ -0,0 +1,64 @@ +output = $output; + $this->input = $input; + $this->setAreaCode(); + + $output->writeln('Reindex all entities to Algolia (if the queue is enabled, indexing will be processed asynchronously)'); + if (!$this->confirmOperation()) { + return CLI::RETURN_SUCCESS; + } + + foreach ($this->commandsList as $commandName) { + $command = $this->getApplication()->find($commandName); + $command->run($input, $output); + } + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/Indexer/IndexCategoriesCommand.php b/Console/Command/Indexer/IndexCategoriesCommand.php new file mode 100644 index 000000000..b3e304205 --- /dev/null +++ b/Console/Command/Indexer/IndexCategoriesCommand.php @@ -0,0 +1,54 @@ +output = $output; + $this->input = $input; + $this->setAreaCode(); + + $storeIds = $this->getStoreIdsToIndex($input); + + foreach ($storeIds as $storeId) { + $output->writeln('Reindexing categories for ' . $this->storeNameFetcher->getStoreName($storeId)) . ''; + $this->categoryBatchQueueProcessor->processBatch($storeId); + } + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/Indexer/IndexPagesCommand.php b/Console/Command/Indexer/IndexPagesCommand.php new file mode 100644 index 000000000..c2aff07e6 --- /dev/null +++ b/Console/Command/Indexer/IndexPagesCommand.php @@ -0,0 +1,54 @@ +output = $output; + $this->input = $input; + $this->setAreaCode(); + + $storeIds = $this->getStoreIdsToIndex($input); + + foreach ($storeIds as $storeId) { + $output->writeln('Reindexing pages for ' . $this->storeNameFetcher->getStoreName($storeId)) . ''; + $this->pageBatchQueueProcessor->processBatch($storeId); + } + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/Indexer/IndexProductsCommand.php b/Console/Command/Indexer/IndexProductsCommand.php new file mode 100644 index 000000000..65c69089b --- /dev/null +++ b/Console/Command/Indexer/IndexProductsCommand.php @@ -0,0 +1,54 @@ +output = $output; + $this->input = $input; + $this->setAreaCode(); + + $storeIds = $this->getStoreIdsToIndex($input); + + foreach ($storeIds as $storeId) { + $output->writeln('Reindexing products for ' . $this->storeNameFetcher->getStoreName($storeId)) . ''; + $this->productBatchQueueProcessor->processBatch($storeId); + } + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/Indexer/IndexSuggestionsCommand.php b/Console/Command/Indexer/IndexSuggestionsCommand.php new file mode 100644 index 000000000..8d7951ef4 --- /dev/null +++ b/Console/Command/Indexer/IndexSuggestionsCommand.php @@ -0,0 +1,54 @@ +output = $output; + $this->input = $input; + $this->setAreaCode(); + + $storeIds = $this->getStoreIdsToIndex($input); + + foreach ($storeIds as $storeId) { + $output->writeln('Reindexing suggestions for ' . $this->storeNameFetcher->getStoreName($storeId)) . ''; + $this->suggestionBatchQueueProcessor->processBatch($storeId); + } + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/Indexer/ProcessQueueCommand.php b/Console/Command/Indexer/ProcessQueueCommand.php new file mode 100644 index 000000000..13db37e56 --- /dev/null +++ b/Console/Command/Indexer/ProcessQueueCommand.php @@ -0,0 +1,68 @@ +setName($this->getCommandName()) + ->setDescription($this->getCommandDescription()); + + parent::configure(); + } + + protected function execute(InputInterface $input, OutputInterface $output): int + { + $this->output = $output; + try { + $this->state->setAreaCode(Area::AREA_CRONTAB); + } catch (LocalizedException $e) { + // Area code is already set - nothing to do - but report regardless + $this->output->writeln("Unable to set area code due to the following error: " . $e->getMessage()); + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class); + + return Cli::RETURN_SUCCESS; + } + + $this->queue->runCron(); + + return Cli::RETURN_SUCCESS; + } +} diff --git a/Console/Command/ReplicaDisableVirtualCommand.php b/Console/Command/ReplicaDisableVirtualCommand.php index 4e3e5e0ea..47efc00f4 100644 --- a/Console/Command/ReplicaDisableVirtualCommand.php +++ b/Console/Command/ReplicaDisableVirtualCommand.php @@ -139,9 +139,9 @@ protected function disableVirtualReplicasForStore(int $storeId): bool protected function disableVirtualReplicasForAllStores(): void { - $this->configChecker->checkAndApplyAllScopes(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, [$this, 'removeLegacyVirtualReplicaConfig']); + $this->configChecker->checkAndApplyAllScopes(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, $this->removeLegacyVirtualReplicaConfig(...)); - $this->configChecker->checkAndApplyAllScopes(ConfigHelper::SORTING_INDICES, [$this, 'disableVirtualReplicaSortConfig']); + $this->configChecker->checkAndApplyAllScopes(ConfigHelper::SORTING_INDICES, $this->disableVirtualReplicaSortConfig(...)); $this->scopeConfig->reinit(); diff --git a/Console/Command/SynonymDeduplicateCommand.php b/Console/Command/SynonymDeduplicateCommand.php index a85727e03..3f5f582c0 100644 --- a/Console/Command/SynonymDeduplicateCommand.php +++ b/Console/Command/SynonymDeduplicateCommand.php @@ -151,17 +151,13 @@ protected function dedupeSpecificSettings(array $settingNames, array $settings): array_combine( $settingNames, array_map( - function($settingName) use ($settings) { - return isset($settings[$settingName]) - ? $this->dedupeArrayOfArrays($settings[$settingName]) - : null; - }, + fn($settingName) => isset($settings[$settingName]) + ? $this->dedupeArrayOfArrays($settings[$settingName]) + : null, $settingNames ) ), - function($val) { - return $val !== null; - } + fn($val) => $val !== null ); } @@ -174,8 +170,8 @@ function($val) { protected function dedupeArrayOfArrays(array $data): array { $encoded = array_map('json_encode', $data); $unique = array_values(array_unique($encoded)); - $decoded = array_map(function($item) { - return json_decode($item, true); }, + $decoded = array_map( + fn($item) => json_decode((string) $item, true), $unique ); return $decoded; diff --git a/Controller/Adminhtml/IndexingManager/Index.php b/Controller/Adminhtml/IndexingManager/Index.php new file mode 100644 index 000000000..b415cbbcc --- /dev/null +++ b/Controller/Adminhtml/IndexingManager/Index.php @@ -0,0 +1,37 @@ +resultFactory = $context->getResultFactory(); + } + + /** + * @return Page + */ + public function execute() + { + $breadMain = __('Algolia | Indexing Manager'); + + /** @var Page $resultPage */ + $resultPage = $this->resultFactory->create(ResultFactory::TYPE_PAGE); + $resultPage->getConfig()->getTitle()->set($breadMain); + + return $resultPage; + } +} diff --git a/Controller/Adminhtml/IndexingManager/Reindex.php b/Controller/Adminhtml/IndexingManager/Reindex.php new file mode 100644 index 000000000..f3214593d --- /dev/null +++ b/Controller/Adminhtml/IndexingManager/Reindex.php @@ -0,0 +1,169 @@ +getRequest()->getParams(); + $storeIds = !isset($params["store_id"]) || $params["store_id"] === (string) AlgoliaConnector::ALGOLIA_DEFAULT_SCOPE ? + array_keys($this->storeManager->getStores()) : + [(int) $params["store_id"]]; + + $entities = $this->defineEntitiesToIndex($params); + $entityIds = $params['selected'] ?? null; + + $this->reindexEntities($entities, $storeIds, $entityIds); + + /** @var Redirect $resultRedirect */ + $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT); + + return $resultRedirect->setPath($this->defineRedirectPath($params)); + } + + /** + * @return array|string[] + */ + protected function defineEntitiesToIndex(array $params): array + { + $entities = []; + if (isset($params["entity"])) { + $entities = $this->isFullIndex($params) ? + ['products', 'categories', 'pages'] : + [$params["entity"]]; + } else if ($this->isMassAction($params)) { + $entities = match ($params["namespace"]) { + 'product_listing' => ['products'], + 'cms_page_listing' => ['pages'], + default => [] + }; + } + + return $entities; + } + + /** + * @param array $params + * @return string + */ + protected function defineRedirectPath(array $params): string + { + $redirect = '*/*/'; + + if (isset($params["redirect"])) { + return $params["redirect"]; + } + + if ($this->isMassAction($params)) { + $redirect = match ($params["namespace"]) { + 'product_listing' => 'catalog/product/index', + 'cms_page_listing' => 'cms/page/index', + default => '*/*/' + }; + } + + return $redirect; + } + + /** + * Defines if all entities need to be reindex + * + * @param array $params + * @return bool + */ + protected function isFullIndex(array $params): bool + { + return isset($params["entity"]) && $params["entity"] === 'all'; + } + + /** + * Check if the request is coming from a grid (products or pages) + * + * @param array $params + * @return bool + */ + protected function isMassAction(array $params): bool + { + return isset($params["namespace"]); + } + + /** + * @param array $entities + * @param array|null $storeIds + * @param array|null $entityIds + * @return void + * @throws AlgoliaException + * @throws DiagnosticsException + * @throws NoSuchEntityException + * @throws LocalizedException + */ + protected function reindexEntities(array $entities, ?array $storeIds = null, ?array $entityIds = null): void + { + foreach ($entities as $entity) { + $processor = match ($entity) { + 'products' => $this->productBatchQueueProcessor, + 'categories' => $this->categoryBatchQueueProcessor, + 'pages' => $this->pageBatchQueueProcessor, + default => throw new AlgoliaException('Unknown entity to index.'), + }; + + foreach ($storeIds as $storeId) { + $processor->processBatch($storeId, $entityIds); + $message = $this->storeNameFetcher->getStoreName($storeId) . " "; + $message .= "(" . $this->indexNameFetcher->getIndexName('_' . $entity, $storeId); + + if (!is_null($entityIds)) { + $recordLabel = count($entityIds) > 1 ? "records" : "record"; + $message .= " - " . count($entityIds) . " " . $recordLabel; + } else { + $message .= " - full reindexing job"; + } + + if (!$this->configHelper->isQueueActive($storeId)) { + $message .= " successfully processed)"; + } else { + $message .= " successfully added to the Algolia indexing queue)"; + } + + $this->messageManager->addSuccessMessage(htmlentities(__($message))); + } + } + } +} diff --git a/Controller/Adminhtml/Landingpage/Save.php b/Controller/Adminhtml/Landingpage/Save.php index db77242d3..94c0c73e9 100755 --- a/Controller/Adminhtml/Landingpage/Save.php +++ b/Controller/Adminhtml/Landingpage/Save.php @@ -106,7 +106,7 @@ public function execute() if (isset($data['algolia_configuration']) && $data['algolia_configuration'] != $data['configuration']) { $data['configuration'] = $data['algolia_configuration']; if ($this->configHelper->isCustomerGroupsEnabled($data['store_id'])) { - $configuration = json_decode($data['algolia_configuration'], true); + $configuration = json_decode((string) $data['algolia_configuration'], true); if (isset($configuration['price'.$data['price_key']])) { $priceConfig = $configuration['price'.$data['price_key']]; $customerGroups = $this->customerGroupCollectionFactory->create(); @@ -163,7 +163,7 @@ public function execute() */ protected function manageQueryRules(int $landingPageId, array $data): void { - $positions = json_decode($data['algolia_merchandising_positions'], true); + $positions = json_decode((string) $data['algolia_merchandising_positions'], true); $stores = []; if ($data['store_id'] == 0) { foreach ($this->storeManager->getStores() as $store) { diff --git a/Controller/Adminhtml/Query/Save.php b/Controller/Adminhtml/Query/Save.php index 49c346ece..d62dc6ccc 100755 --- a/Controller/Adminhtml/Query/Save.php +++ b/Controller/Adminhtml/Query/Save.php @@ -157,7 +157,7 @@ public function execute() */ private function manageQueryRules(int $queryId, array $data): void { - $positions = json_decode($data['algolia_merchandising_positions'], true); + $positions = json_decode((string) $data['algolia_merchandising_positions'], true); $stores = []; if ($data['store_id'] == 0) { $stores = $this->getActiveStores(); diff --git a/Controller/Adminhtml/Reindex/Save.php b/Controller/Adminhtml/Reindex/Save.php index 3de8e46fc..d6d65aa91 100644 --- a/Controller/Adminhtml/Reindex/Save.php +++ b/Controller/Adminhtml/Reindex/Save.php @@ -10,6 +10,7 @@ use Algolia\AlgoliaSearch\Helper\Data as DataHelper; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder; +use Algolia\AlgoliaSearch\Service\Product\RecordBuilder as ProductRecordBuilder; use Magento\Backend\App\Action\Context; use Magento\Catalog\Api\ProductRepositoryInterface; use Magento\Framework\Controller\ResultFactory; @@ -27,6 +28,7 @@ public function __construct( protected StoreManagerInterface $storeManager, protected DataHelper $dataHelper, protected ProductHelper $productHelper, + protected ProductRecordBuilder $productRecordBuilder, protected ProductIndexBuilder $productIndexBuilder ) { parent::__construct($context); @@ -43,7 +45,7 @@ public function execute() /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */ $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT); $resultRedirect->setPath('*/*/index'); - $skus = preg_split("/(,|\r\n|\n|\r)/", $this->getRequest()->getParam('skus')); + $skus = preg_split("/(,|\r\n|\n|\r)/", (string) $this->getRequest()->getParam('skus')); $stores = $this->storeManager->getStores(); @@ -147,7 +149,7 @@ protected function checkAndReindex($product, $stores) try { $product = $this->productRepository->get($product->getSku(), false, $storeId); - $this->productHelper->canProductBeReindexed($product, $storeId); + $this->productRecordBuilder->canProductBeReindexed($product, $storeId); } catch (ProductDisabledException $e) { // Product status is a Website specific attribute $this->messageManager->addErrorMessage( diff --git a/Cron/ProcessQueue.php b/Cron/ProcessQueue.php new file mode 100644 index 000000000..a3af368ef --- /dev/null +++ b/Cron/ProcessQueue.php @@ -0,0 +1,31 @@ +configHelper->isQueueIndexerEnabled() || !$this->configHelper->useBuiltInCron()) { + return; + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class); + + return; + } + + $this->queue->runCron(); + } +} diff --git a/Exception/InvalidCronException.php b/Exception/InvalidCronException.php new file mode 100644 index 000000000..1bb09b315 --- /dev/null +++ b/Exception/InvalidCronException.php @@ -0,0 +1,7 @@ +objectManager->create('\Magento\CatalogPermissions\Model\ResourceModel\Permission\Index'); + return $this->objectManager->create(\Magento\CatalogPermissions\Model\ResourceModel\Permission\Index::class); } public function getCatalogPermissionsHelper() { - return $this->objectManager->create('\Magento\CatalogPermissions\Helper\Data'); + return $this->objectManager->create(\Magento\CatalogPermissions\Helper\Data::class); } public function getCatalogPermissionsConfig() { - return $this->objectManager->create('\Magento\CatalogPermissions\App\Config'); + return $this->objectManager->create(\Magento\CatalogPermissions\App\Config::class); } public function getCategoryPermissionsCollection() diff --git a/Factory/SharedCatalogFactory.php b/Factory/SharedCatalogFactory.php index faf6188d6..39b348f1c 100644 --- a/Factory/SharedCatalogFactory.php +++ b/Factory/SharedCatalogFactory.php @@ -115,7 +115,7 @@ public function getSharedProductItemCollection() $groups = $this->getSharedCatalogGroups(); foreach ($productItems as $productId => $permissions) { - $permissions = explode(',', $permissions); + $permissions = explode(',', (string) $permissions); $finalPermissions = []; foreach ($groups as $groupId) { $finalPermissions[] = $groupId . '_' . (in_array($groupId, $permissions) ? '1' : '0'); diff --git a/Helper/Adapter/FiltersHelper.php b/Helper/Adapter/FiltersHelper.php index 571d71989..66d034dd6 100644 --- a/Helper/Adapter/FiltersHelper.php +++ b/Helper/Adapter/FiltersHelper.php @@ -103,7 +103,7 @@ public function getLandingPageFilters($storeId) $landingPageFilter = []; $landingPage = $this->registry->registry('current_landing_page'); if ($landingPage) { - $landingPageConfiguration = json_decode($landingPage->getConfiguration(), true); + $landingPageConfiguration = json_decode((string) $landingPage->getConfiguration(), true); $landingPageFilter['facetFilters'] = $this->getFacetFilters($storeId, $landingPageConfiguration); $landingPageFilter = array_merge( $landingPageFilter, @@ -153,7 +153,7 @@ public function getFacetFilters($storeId, $parameters = null) $facetValues = is_array($parameters[$facet['attribute']]) ? $parameters[$facet['attribute']] : - explode('~', $parameters[$facet['attribute']]); + explode('~', (string) $parameters[$facet['attribute']]); // Backward compatibility with native Magento filtering if (!$this->config->isInstantEnabled($storeId)) { @@ -172,7 +172,7 @@ public function getFacetFilters($storeId, $parameters = null) } if ($facet['type'] === 'conjunctive') { - foreach ($facetValues as $key => $facetValue) { + foreach ($facetValues as $facetValue) { $facetFilters[] = $facet['attribute'] . ':' . $facetValue; } } diff --git a/Helper/AlgoliaHelper.php b/Helper/AlgoliaHelper.php old mode 100755 new mode 100644 index dcfa88e60..3d25ef3de --- a/Helper/AlgoliaHelper.php +++ b/Helper/AlgoliaHelper.php @@ -15,7 +15,7 @@ use Magento\Framework\Exception\NoSuchEntityException; /** - * @deprecated (will be removed in v3.16.0) + * @deprecated (will be removed from the codebase in v3.17.0) */ class AlgoliaHelper extends AbstractHelper { @@ -297,7 +297,7 @@ public function copyQueryRules(string $fromIndexName, string $toIndexName, ?int * * @throws AlgoliaException|NoSuchEntityException */ - public function searchRules(string $indexName, array $searchRulesParams = null, ?int $storeId = null) + public function searchRules(string $indexName, ?array $searchRulesParams = null, ?int $storeId = null) { $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName, $storeId); diff --git a/Helper/AnalyticsHelper.php b/Helper/AnalyticsHelper.php index ba199a358..6a15dcc68 100644 --- a/Helper/AnalyticsHelper.php +++ b/Helper/AnalyticsHelper.php @@ -200,7 +200,7 @@ public function getTopHits(array $params): array */ public function getTopHitsForSearch($search, array $params): array { - return $this->safeFetch(self::ANALYTICS_HITS_PATH . '?search=' . urlencode($search), $params); + return $this->safeFetch(self::ANALYTICS_HITS_PATH . '?search=' . urlencode((string) $search), $params); } /** diff --git a/Helper/ConfigHelper.php b/Helper/ConfigHelper.php index 2b33be882..a7d2e237e 100755 --- a/Helper/ConfigHelper.php +++ b/Helper/ConfigHelper.php @@ -3,25 +3,26 @@ namespace Algolia\AlgoliaSearch\Helper; use Algolia\AlgoliaSearch\Api\Product\ReplicaManagerInterface; +use Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper; +use Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper; use Algolia\AlgoliaSearch\Service\AlgoliaConnector; -use Magento; +use Algolia\AlgoliaSearch\Service\Serializer; use Magento\Cookie\Helper\Cookie as CookieHelper; +use Magento\Customer\Api\GroupExcludedWebsiteRepositoryInterface; +use Magento\Customer\Model\ResourceModel\Group\Collection as GroupCollection; use Magento\Directory\Model\Currency as DirCurrency; +use Magento\Framework\App\Config\ScopeConfigInterface; use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\DataObject; use Magento\Framework\Locale\Currency; -use Magento\Framework\Serialize\SerializerInterface; use Magento\Store\Model\ScopeInterface; use Magento\Store\Model\StoreManagerInterface; -use Magento\Customer\Api\GroupExcludedWebsiteRepositoryInterface; -use Magento\Customer\Model\ResourceModel\Group\Collection as GroupCollection; class ConfigHelper { + // --- Credentials & Basic Setup --- // + public const ENABLE_FRONTEND = 'algoliasearch_credentials/credentials/enable_frontend'; - public const ENABLE_BACKEND = 'algoliasearch_credentials/credentials/enable_backend'; - public const ENABLE_QUERY_SUGGESTIONS_INDEX = 'algoliasearch_credentials/credentials/enable_query_suggestions_index'; - public const ENABLE_PAGES_INDEX = 'algoliasearch_credentials/credentials/enable_pages_index'; public const LOGGING_ENABLED = 'algoliasearch_credentials/credentials/debug'; public const APPLICATION_ID = 'algoliasearch_credentials/credentials/application_id'; public const API_KEY = 'algoliasearch_credentials/credentials/api_key'; @@ -31,38 +32,16 @@ class ConfigHelper public const ALLOW_COOKIE_BUTTON_SELECTOR = 'algoliasearch_credentials/algolia_cookie_configuration/allow_cookie_button_selector'; public const ALGOLIA_COOKIE_DURATION = 'algoliasearch_credentials/algolia_cookie_configuration/cookie_duration'; - - public const IS_INSTANT_ENABLED = 'algoliasearch_instant/instant/is_instant_enabled'; - public const REPLACE_CATEGORIES = 'algoliasearch_instant/instant/replace_categories'; - public const INSTANT_SELECTOR = 'algoliasearch_instant/instant/instant_selector'; - public const NUMBER_OF_PRODUCT_RESULTS = 'algoliasearch_instant/instant/number_product_results'; - public const FACETS = 'algoliasearch_instant/instant_facets/facets'; - public const MAX_VALUES_PER_FACET = 'algoliasearch_instant/instant_facets/max_values_per_facet'; - public const SORTING_INDICES = 'algoliasearch_instant/instant_sorts/sorts'; - public const SEARCHBOX_ENABLE = 'algoliasearch_instant/instant_options/instantsearch_searchbox'; - public const SHOW_SUGGESTIONS_NO_RESULTS = 'algoliasearch_instant/instant_options/show_suggestions_on_no_result_page'; - public const XML_ADD_TO_CART_ENABLE = 'algoliasearch_instant/instant_options/add_to_cart_enable'; - public const INFINITE_SCROLL_ENABLE = 'algoliasearch_instant/instant_options/infinite_scroll_enable'; - public const HIDE_PAGINATION = 'algoliasearch_instant/instant_options/hide_pagination'; - - public const IS_POPUP_ENABLED = 'algoliasearch_autocomplete/autocomplete/is_popup_enabled'; - public const NB_OF_PRODUCTS_SUGGESTIONS = 'algoliasearch_autocomplete/autocomplete/nb_of_products_suggestions'; - public const NB_OF_CATEGORIES_SUGGESTIONS = 'algoliasearch_autocomplete/autocomplete/nb_of_categories_suggestions'; - public const NB_OF_QUERIES_SUGGESTIONS = 'algoliasearch_autocomplete/autocomplete/nb_of_queries_suggestions'; - public const AUTOCOMPLETE_SECTIONS = 'algoliasearch_autocomplete/autocomplete/sections'; - public const EXCLUDED_PAGES = 'algoliasearch_autocomplete/autocomplete/excluded_pages'; - public const MIN_POPULARITY = 'algoliasearch_autocomplete/autocomplete/min_popularity'; - public const MIN_NUMBER_OF_RESULTS = 'algoliasearch_autocomplete/autocomplete/min_number_of_results'; - public const RENDER_TEMPLATE_DIRECTIVES = 'algoliasearch_autocomplete/autocomplete/render_template_directives'; - public const AUTOCOMPLETE_MENU_DEBUG = 'algoliasearch_autocomplete/autocomplete/debug'; - public const AUTOCOMPLETE_DEBOUNCE_MILLISEC = 'algoliasearch_autocomplete/autocomplete/debounce_millisec'; - public const AUTOCOMPLETE_MINIMUM_CHAR_LENGTH = 'algoliasearch_autocomplete/autocomplete/minimum_char_length'; + // --- Products --- // public const PRODUCT_ATTRIBUTES = 'algoliasearch_products/products/product_additional_attributes'; public const PRODUCT_CUSTOM_RANKING = 'algoliasearch_products/products/custom_ranking_product_attributes'; public const USE_ADAPTIVE_IMAGE = 'algoliasearch_products/products/use_adaptive_image'; public const ENABLE_VISUAL_MERCHANDISING = 'algoliasearch_products/products/enable_visual_merchandising'; public const CATEGORY_PAGE_ID_ATTRIBUTE_NAME = 'algoliasearch_products/products/category_page_id_attribute_name'; + public const INCLUDE_NON_VISIBLE_PRODUCTS_IN_INDEX = 'algoliasearch_products/products/include_non_visible_products_in_index'; + + // --- Categories --- // public const CATEGORY_ATTRIBUTES = 'algoliasearch_categories/categories/category_additional_attributes'; public const CATEGORY_CUSTOM_RANKING = 'algoliasearch_categories/categories/custom_ranking_category_attributes'; @@ -70,33 +49,82 @@ class ConfigHelper public const INDEX_EMPTY_CATEGORIES = 'algoliasearch_categories/categories/index_empty_categories'; public const CATEGORY_SEPARATOR = 'algoliasearch_categories/categories/category_separator'; - public const IS_ACTIVE = 'algoliasearch_queue/queue/active'; - public const NUMBER_OF_JOB_TO_RUN = 'algoliasearch_queue/queue/number_of_job_to_run'; - public const RETRY_LIMIT = 'algoliasearch_queue/queue/number_of_retries'; + // --- Recommend Products Settings --- // + + public const IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED = 'algoliasearch_recommend/recommend/frequently_bought_together/is_frequently_bought_together_enabled'; + public const IS_RECOMMEND_RELATED_PRODUCTS_ENABLED = 'algoliasearch_recommend/recommend/related_product/is_related_products_enabled'; + public const IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED_ON_CART_PAGE = 'algoliasearch_recommend/recommend/frequently_bought_together/is_frequently_bought_together_enabled_in_cart_page'; + public const IS_RECOMMEND_RELATED_PRODUCTS_ENABLED_ON_CART_PAGE = 'algoliasearch_recommend/recommend/related_product/is_related_products_enabled_in_cart_page'; + protected const NUM_OF_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_PRODUCTS = 'algoliasearch_recommend/recommend/frequently_bought_together/num_of_frequently_bought_together_products'; + protected const NUM_OF_RECOMMEND_RELATED_PRODUCTS = 'algoliasearch_recommend/recommend/related_product/num_of_related_products'; + protected const IS_REMOVE_RELATED_PRODUCTS_BLOCK = 'algoliasearch_recommend/recommend/related_product/is_remove_core_related_products_block'; + protected const IS_REMOVE_UPSELL_PRODUCTS_BLOCK = 'algoliasearch_recommend/recommend/frequently_bought_together/is_remove_core_upsell_products_block'; + public const IS_RECOMMEND_TRENDING_ITEMS_ENABLED = 'algoliasearch_recommend/recommend/trends_item/is_trending_items_enabled'; + protected const IS_RECOMMEND_LOOKING_SIMILAR_ENABLED = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled'; + protected const NUM_OF_LOOKING_SIMILAR = 'algoliasearch_recommend/recommend/looking_similar/num_of_products'; + protected const NUM_OF_TRENDING_ITEMS = 'algoliasearch_recommend/recommend/trends_item/num_of_trending_items'; + protected const TREND_ITEMS_FACET_NAME = 'algoliasearch_recommend/recommend/trends_item/facet_name'; + protected const TREND_ITEMS_FACET_VALUE = 'algoliasearch_recommend/recommend/trends_item/facet_value'; + public const IS_TREND_ITEMS_ENABLED_IN_PDP = 'algoliasearch_recommend/recommend/trends_item/is_trending_items_enabled_on_pdp'; + public const IS_TREND_ITEMS_ENABLED_IN_SHOPPING_CART = 'algoliasearch_recommend/recommend/trends_item/is_trending_items_enabled_on_cart_page'; + protected const IS_ADDTOCART_ENABLED_IN_FREQUENTLY_BOUGHT_TOGETHER = 'algoliasearch_recommend/recommend/frequently_bought_together/is_addtocart_enabled'; + protected const IS_ADDTOCART_ENABLED_IN_RELATED_PRODUCTS = 'algoliasearch_recommend/recommend/related_product/is_addtocart_enabled'; + protected const IS_ADDTOCART_ENABLED_IN_TRENDS_ITEM = 'algoliasearch_recommend/recommend/trends_item/is_addtocart_enabled'; + protected const IS_ADDTOCART_ENABLED_IN_LOOKING_SIMILAR = 'algoliasearch_recommend/recommend/looking_similar/is_addtocart_enabled'; + public const IS_LOOKING_SIMILAR_ENABLED_IN_PDP = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled_on_pdp'; + public const IS_LOOKING_SIMILAR_ENABLED_IN_SHOPPING_CART = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled_on_cart_page'; + protected const LOOKING_SIMILAR_TITLE = 'algoliasearch_recommend/recommend/looking_similar/title'; + protected const FREQUENTLY_BOUGHT_TOGETHER_TITLE = 'algoliasearch_recommend/recommend/frequently_bought_together/title'; + protected const RELATED_PRODUCTS_TITLE = 'algoliasearch_recommend/recommend/related_product/title'; + protected const TRENDING_ITEMS_TITLE = 'algoliasearch_recommend/recommend/trends_item/title'; + + // --- Images --- // public const XML_PATH_IMAGE_WIDTH = 'algoliasearch_images/image/width'; public const XML_PATH_IMAGE_HEIGHT = 'algoliasearch_images/image/height'; public const XML_PATH_IMAGE_TYPE = 'algoliasearch_images/image/type'; + // --- Indexing Queue / Cron --- // + + public const IS_ACTIVE = 'algoliasearch_queue/queue/active'; + public const USE_BUILT_IN_CRON = 'algoliasearch_queue/queue/use_built_in_cron'; + public const NUMBER_OF_JOB_TO_RUN = 'algoliasearch_queue/queue/number_of_job_to_run'; + public const RETRY_LIMIT = 'algoliasearch_queue/queue/number_of_retries'; + + // --- Indexing Manager --- // + + public const ENABLE_INDEXING = 'algoliasearch_indexing_manager/algolia_indexing/enable_indexing'; + public const ENABLE_QUERY_SUGGESTIONS_INDEX = 'algoliasearch_indexing_manager/algolia_indexing/enable_query_suggestions_index'; + public const ENABLE_PAGES_INDEX = 'algoliasearch_indexing_manager/algolia_indexing/enable_pages_index'; + public const ENABLE_INDEXER_PRODUCTS = 'algoliasearch_indexing_manager/full_indexing/products'; + public const ENABLE_INDEXER_CATEGORIES = 'algoliasearch_indexing_manager/full_indexing/categories'; + public const ENABLE_INDEXER_PAGES = 'algoliasearch_indexing_manager/full_indexing/pages'; + public const ENABLE_INDEXER_SUGGESTIONS = 'algoliasearch_indexing_manager/full_indexing/suggestions'; + public const ENABLE_INDEXER_ADDITIONAL_SECTIONS = 'algoliasearch_indexing_manager/full_indexing/additional_sections'; + public const ENABLE_INDEXER_DELETE_PRODUCTS = 'algoliasearch_indexing_manager/full_indexing/delete_products'; + public const ENABLE_INDEXER_QUEUE = 'algoliasearch_indexing_manager/full_indexing/queue'; + + // --- Click & Conversion Analytics --- // + public const CC_ANALYTICS_ENABLE = 'algoliasearch_cc_analytics/cc_analytics_group/enable'; public const CC_ANALYTICS_IS_SELECTOR = 'algoliasearch_cc_analytics/cc_analytics_group/is_selector'; public const CC_CONVERSION_ANALYTICS_MODE = 'algoliasearch_cc_analytics/cc_analytics_group/conversion_analytics_mode'; public const CC_ADD_TO_CART_SELECTOR = 'algoliasearch_cc_analytics/cc_analytics_group/add_to_cart_selector'; - public const COOKIE_LIFETIME = 'web/cookie/cookie_lifetime'; + + // --- Google Analytics --- // public const GA_ENABLE = 'algoliasearch_analytics/analytics_group/enable'; public const GA_DELAY = 'algoliasearch_analytics/analytics_group/delay'; public const GA_TRIGGER_ON_UI_INTERACTION = 'algoliasearch_analytics/analytics_group/trigger_on_ui_interaction'; public const GA_PUSH_INITIAL_SEARCH = 'algoliasearch_analytics/analytics_group/push_initial_search'; + // --- Advanced --- // + public const REMOVE_IF_NO_RESULT = 'algoliasearch_advanced/advanced/remove_words_if_no_result'; public const PARTIAL_UPDATES = 'algoliasearch_advanced/advanced/partial_update'; public const CUSTOMER_GROUPS_ENABLE = 'algoliasearch_advanced/advanced/customer_groups_enable'; public const REMOVE_PUB_DIR_IN_URL = 'algoliasearch_advanced/advanced/remove_pub_dir_in_url'; - public const MAKE_SEO_REQUEST = 'algoliasearch_advanced/advanced/make_seo_request'; public const REMOVE_BRANDING = 'algoliasearch_advanced/advanced/remove_branding'; - public const AUTOCOMPLETE_SELECTOR = 'algoliasearch_autocomplete/autocomplete/autocomplete_selector'; - public const INCLUDE_NON_VISIBLE_PRODUCTS_IN_INDEX = 'algoliasearch_products/products/include_non_visible_products_in_index'; public const IDX_PRODUCT_ON_CAT_PRODUCTS_UPD = 'algoliasearch_advanced/advanced/index_product_on_category_products_update'; public const PREVENT_BACKEND_RENDERING = 'algoliasearch_advanced/advanced/prevent_backend_rendering'; public const PREVENT_BACKEND_RENDERING_DISPLAY_MODE = @@ -109,13 +137,16 @@ class ConfigHelper public const CONNECTION_TIMEOUT = 'algoliasearch_advanced/advanced/connection_timeout'; public const READ_TIMEOUT = 'algoliasearch_advanced/advanced/read_timeout'; public const WRITE_TIMEOUT = 'algoliasearch_advanced/advanced/write_timeout'; + protected const FORWARD_TO_REPLICAS = 'algoliasearch_advanced/advanced/forward_to_replicas'; public const AUTO_PRICE_INDEXING_ENABLED = 'algoliasearch_advanced/advanced/auto_price_indexing'; - public const PROFILER_ENABLED = 'algoliasearch_advanced/advanced/enable_profiler'; - public const SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock'; + // Indexing Queue advanced settings + public const ENHANCED_QUEUE_ARCHIVE = 'algoliasearch_advanced/queue/enhanced_archive'; + public const NUMBER_OF_ELEMENT_BY_PAGE = 'algoliasearch_advanced/queue/number_of_element_by_page'; + public const ARCHIVE_LOG_CLEAR_LIMIT = 'algoliasearch_advanced/queue/archive_clear_limit'; - public const USE_SECURE_IN_FRONTEND = 'web/secure/use_in_frontend'; + // --- Extra index settings --- // public const EXTRA_SETTINGS_PRODUCTS = 'algoliasearch_extra_settings/extra_settings/products_extra_settings'; public const EXTRA_SETTINGS_CATEGORIES = 'algoliasearch_extra_settings/extra_settings/categories_extra_settings'; @@ -123,146 +154,128 @@ class ConfigHelper public const EXTRA_SETTINGS_SUGGESTIONS = 'algoliasearch_extra_settings/extra_settings/suggestions_extra_settings'; public const EXTRA_SETTINGS_ADDITIONAL_SECTIONS = 'algoliasearch_extra_settings/extra_settings/additional_sections_extra_settings'; - public const MAGENTO_DEFAULT_CACHE_TIME = 'system/full_page_cache/ttl'; - public const IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED = 'algoliasearch_recommend/recommend/frequently_bought_together/is_frequently_bought_together_enabled'; - public const IS_RECOMMEND_RELATED_PRODUCTS_ENABLED = 'algoliasearch_recommend/recommend/related_product/is_related_products_enabled'; - public const IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED_ON_CART_PAGE = 'algoliasearch_recommend/recommend/frequently_bought_together/is_frequently_bought_together_enabled_in_cart_page'; - public const IS_RECOMMEND_RELATED_PRODUCTS_ENABLED_ON_CART_PAGE = 'algoliasearch_recommend/recommend/related_product/is_related_products_enabled_in_cart_page'; - protected const NUM_OF_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_PRODUCTS = 'algoliasearch_recommend/recommend/frequently_bought_together/num_of_frequently_bought_together_products'; - protected const NUM_OF_RECOMMEND_RELATED_PRODUCTS = 'algoliasearch_recommend/recommend/related_product/num_of_related_products'; - protected const IS_REMOVE_RELATED_PRODUCTS_BLOCK = 'algoliasearch_recommend/recommend/related_product/is_remove_core_related_products_block'; - protected const IS_REMOVE_UPSELL_PRODUCTS_BLOCK = 'algoliasearch_recommend/recommend/frequently_bought_together/is_remove_core_upsell_products_block'; - public const IS_RECOMMEND_TRENDING_ITEMS_ENABLED = 'algoliasearch_recommend/recommend/trends_item/is_trending_items_enabled'; - protected const IS_RECOMMEND_LOOKING_SIMILAR_ENABLED = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled'; - protected const NUM_OF_LOOKING_SIMILAR = 'algoliasearch_recommend/recommend/looking_similar/num_of_products'; - protected const NUM_OF_TRENDING_ITEMS = 'algoliasearch_recommend/recommend/trends_item/num_of_trending_items'; - protected const TREND_ITEMS_FACET_NAME = 'algoliasearch_recommend/recommend/trends_item/facet_name'; - protected const TREND_ITEMS_FACET_VALUE = 'algoliasearch_recommend/recommend/trends_item/facet_value'; - public const IS_TREND_ITEMS_ENABLED_IN_PDP = 'algoliasearch_recommend/recommend/trends_item/is_trending_items_enabled_on_pdp'; - public const IS_TREND_ITEMS_ENABLED_IN_SHOPPING_CART = 'algoliasearch_recommend/recommend/trends_item/is_trending_items_enabled_on_cart_page'; - protected const IS_ADDTOCART_ENABLED_IN_FREQUENTLY_BOUGHT_TOGETHER = 'algoliasearch_recommend/recommend/frequently_bought_together/is_addtocart_enabled'; - protected const IS_ADDTOCART_ENABLED_IN_RELATED_PRODUCTS = 'algoliasearch_recommend/recommend/related_product/is_addtocart_enabled'; - protected const IS_ADDTOCART_ENABLED_IN_TRENDS_ITEM = 'algoliasearch_recommend/recommend/trends_item/is_addtocart_enabled'; - protected const IS_ADDTOCART_ENABLED_IN_LOOKING_SIMILAR = 'algoliasearch_recommend/recommend/looking_similar/is_addtocart_enabled'; - public const IS_LOOKING_SIMILAR_ENABLED_IN_PDP = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled_on_pdp'; - public const IS_LOOKING_SIMILAR_ENABLED_IN_SHOPPING_CART = 'algoliasearch_recommend/recommend/looking_similar/is_looking_similar_enabled_on_cart_page'; - protected const LOOKING_SIMILAR_TITLE = 'algoliasearch_recommend/recommend/looking_similar/title'; - public const LEGACY_USE_VIRTUAL_REPLICA_ENABLED = 'algoliasearch_instant/instant/use_virtual_replica'; - protected const AUTOCOMPLETE_KEYBORAD_NAVIAGATION = 'algoliasearch_autocomplete/autocomplete/navigator'; - protected const FREQUENTLY_BOUGHT_TOGETHER_TITLE = 'algoliasearch_recommend/recommend/frequently_bought_together/title'; - protected const RELATED_PRODUCTS_TITLE = 'algoliasearch_recommend/recommend/related_product/title'; - protected const TRENDING_ITEMS_TITLE = 'algoliasearch_recommend/recommend/trends_item/title'; - // Indexing Queue Advanced settings - public const ENHANCED_QUEUE_ARCHIVE = 'algoliasearch_advanced/queue/enhanced_archive'; - public const NUMBER_OF_ELEMENT_BY_PAGE = 'algoliasearch_advanced/queue/number_of_element_by_page'; - public const ARCHIVE_LOG_CLEAR_LIMIT = 'algoliasearch_advanced/queue/archive_clear_limit'; + // --- Magento Core --- // + + public const SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock'; + public const USE_SECURE_IN_FRONTEND = 'web/secure/use_in_frontend'; + public const MAGENTO_DEFAULT_CACHE_TIME = 'system/full_page_cache/ttl'; + public const COOKIE_LIFETIME = 'web/cookie/cookie_lifetime'; public function __construct( - protected Magento\Framework\App\Config\ScopeConfigInterface $configInterface, - protected Magento\Framework\App\Config\Storage\WriterInterface $configWriter, - protected StoreManagerInterface $storeManager, - protected Currency $currency, - protected DirCurrency $dirCurrency, - protected DirectoryList $directoryList, - protected Magento\Framework\Module\ResourceInterface $moduleResource, - protected Magento\Framework\App\ProductMetadataInterface $productMetadata, - protected Magento\Framework\Event\ManagerInterface $eventManager, - protected SerializerInterface $serializer, - protected GroupCollection $groupCollection, - protected GroupExcludedWebsiteRepositoryInterface $groupExcludedWebsiteRepository, - protected CookieHelper $cookieHelper, + protected \Magento\Framework\App\Config\ScopeConfigInterface $configInterface, + protected \Magento\Framework\App\Config\Storage\WriterInterface $configWriter, + protected StoreManagerInterface $storeManager, + protected Currency $currency, + protected DirCurrency $dirCurrency, + protected DirectoryList $directoryList, + protected \Magento\Framework\Module\ResourceInterface $moduleResource, + protected \Magento\Framework\App\ProductMetadataInterface $productMetadata, + protected \Magento\Framework\Event\ManagerInterface $eventManager, + protected Serializer $serializer, + protected GroupCollection $groupCollection, + protected GroupExcludedWebsiteRepositoryInterface $groupExcludedWebsiteRepository, + protected CookieHelper $cookieHelper, + protected AutocompleteHelper $autocompleteConfig, + protected InstantSearchHelper $instantSearchConfig ) {} + // --- Credentials & Basic Setup --- // /** * @param $storeId * @return bool + * @deprecated Use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager instead */ - public function showCatsNotIncludedInNavigation($storeId = null) + public function credentialsAreConfigured($storeId = null): bool { - return $this->configInterface->isSetFlag( - self::SHOW_CATS_NOT_INCLUDED_IN_NAV, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->getApplicationID($storeId) && + $this->getAPIKey($storeId) && + $this->getSearchOnlyAPIKey($storeId); } /** * @param $storeId - * @return bool + * @return mixed' */ - public function shouldIndexEmptyCategories($storeId = null) + public function getApplicationID($storeId = null) { - return $this->configInterface->isSetFlag(self::INDEX_EMPTY_CATEGORIES, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue(self::APPLICATION_ID, ScopeInterface::SCOPE_STORE, $storeId); } /** - * @return string + * @param $storeId + * @return mixed */ - public function getMagentoVersion() + public function getAPIKey($storeId = null) { - return $this->productMetadata->getVersion(); + return $this->configInterface->getValue(self::API_KEY, ScopeInterface::SCOPE_STORE, $storeId); } /** - * @return string + * @param $storeId + * @return mixed */ - public function getMagentoEdition() + public function getSearchOnlyAPIKey($storeId = null) { - return $this->productMetadata->getEdition(); + return $this->configInterface->getValue(self::SEARCH_ONLY_API_KEY, ScopeInterface::SCOPE_STORE, $storeId); } /** - * @return false|string + * @param int|null $storeId + * @return string */ - public function getExtensionVersion() + public function getIndexPrefix(?int $storeId = null): string { - return $this->moduleResource->getDbVersion('Algolia_AlgoliaSearch'); + return (string) $this->configInterface->getValue(self::INDEX_PREFIX, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isDefaultSelector($storeId = null) + public function isEnabledFrontEnd($storeId = null): bool { - return '.algolia-search-input' === $this->getAutocompleteSelector($storeId); + return $this->configInterface->isSetFlag(self::ENABLE_FRONTEND, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return mixed + * @return bool */ - public function getAutocompleteSelector($storeId = null) + public function isLoggingEnabled($storeId = null): bool { - return $this->configInterface->getValue(self::AUTOCOMPLETE_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::LOGGING_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); } /** - * Returns config flag - * - * @param $storeId - * @return bool + * Used for front end search API key generation + * @param $groupId + * @return array */ - public function includeNonVisibleProductsInIndex($storeId = null): bool + public function getAttributesToFilter($groupId) { - return $this->configInterface->isSetFlag( - self::INCLUDE_NON_VISIBLE_PRODUCTS_IN_INDEX, - ScopeInterface::SCOPE_STORE, - $storeId + $transport = new DataObject(); + $this->eventManager->dispatch( + 'algolia_get_attributes_to_filter', + ['filter_object' => $transport, 'customer_group_id' => $groupId] ); + $attributes = $transport->getData(); + $attributes = array_unique($attributes); + $attributes = array_values($attributes); + return count($attributes) ? ['filters' => implode(' AND ', $attributes)] : []; } + // Algolia Cookie Configuration /** * @param $storeId * @return mixed */ - public function indexProductOnCategoryProductsUpdate($storeId = null) + public function getDefaultConsentCookieName($storeId = null) { return $this->configInterface->getValue( - self::IDX_PRODUCT_ON_CAT_PRODUCTS_UPD, + self::COOKIE_DEFAULT_CONSENT_COOKIE_NAME, ScopeInterface::SCOPE_STORE, $storeId ); @@ -270,12 +283,12 @@ public function indexProductOnCategoryProductsUpdate($storeId = null) /** * @param $storeId - * @return int + * @return mixed */ - public function getNumberOfQueriesSuggestions($storeId = null) + public function getAllowCookieButtonSelector($storeId = null) { - return (int)$this->configInterface->getValue( - self::NB_OF_QUERIES_SUGGESTIONS, + return $this->configInterface->getValue( + self::ALLOW_COOKIE_BUTTON_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId ); @@ -283,438 +296,572 @@ public function getNumberOfQueriesSuggestions($storeId = null) /** * @param $storeId - * @return int + * @return mixed */ - public function getNumberOfProductsSuggestions($storeId = null) + public function getAlgoliaCookieDuration($storeId = null) { - return (int)$this->configInterface->getValue( - self::NB_OF_PRODUCTS_SUGGESTIONS, + return $this->configInterface->getValue( + self::ALGOLIA_COOKIE_DURATION, ScopeInterface::SCOPE_STORE, $storeId ); } + // --- Products --- // + /** * @param $storeId - * @return int + * @return array */ - public function getNumberOfCategoriesSuggestions($storeId = null) + public function getProductAdditionalAttributes($storeId = null) { - return (int)$this->configInterface->getValue( - self::NB_OF_CATEGORIES_SUGGESTIONS, + $attributes = $this->serializer->unserialize($this->configInterface->getValue( + self::PRODUCT_ATTRIBUTES, ScopeInterface::SCOPE_STORE, $storeId - ); + )); + + $facets = $this->serializer->unserialize($this->configInterface->getValue( + self::FACETS, + ScopeInterface::SCOPE_STORE, + $storeId + )); + $attributes = $this->addIndexableAttributes($attributes, $facets, '0'); + + $sorts = $this->serializer->unserialize($this->configInterface->getValue( + self::SORTING_INDICES, + ScopeInterface::SCOPE_STORE, + $storeId + )); + $attributes = $this->addIndexableAttributes($attributes, $sorts, '0'); + + $customRankings = $this->serializer->unserialize($this->configInterface->getValue( + self::PRODUCT_CUSTOM_RANKING, + ScopeInterface::SCOPE_STORE, + $storeId + )); + $customRankings = $customRankings ?: []; + $customRankings = array_filter($customRankings, fn($customRanking) => $customRanking['attribute'] !== 'custom_attribute'); + $attributes = $this->addIndexableAttributes($attributes, $customRankings, '0', '0'); + if (is_array($attributes)) { + return $attributes; + } + return []; } /** - * @param $storeId - * @return bool + * @param $attributes + * @param $addedAttributes + * @param $searchable + * @param $retrievable + * @param $indexNoValue + * @return mixed */ - public function isEnabledFrontEnd($storeId = null) - { - return $this->configInterface->isSetFlag(self::ENABLE_FRONTEND, ScopeInterface::SCOPE_STORE, $storeId); + protected function addIndexableAttributes( + $attributes, + $addedAttributes, + $searchable = '1', + $retrievable = '1', + $indexNoValue = '1' + ) { + foreach ((array)$addedAttributes as $addedAttribute) { + foreach ((array)$attributes as $attribute) { + if ($addedAttribute['attribute'] === $attribute['attribute']) { + continue 2; + } + } + $attributes[] = [ + 'attribute' => $addedAttribute['attribute'], + 'searchable' => $searchable, + 'retrievable' => $retrievable, + 'index_no_value' => $indexNoValue, + ]; + } + return $attributes; } /** * @param $storeId - * @return bool + * @return array */ - public function isEnabledBackend($storeId = null) + public function getProductCustomRanking($storeId = null) { - return $this->configInterface->isSetFlag(self::ENABLE_BACKEND, ScopeInterface::SCOPE_STORE, $storeId); + $attrs = $this->serializer->unserialize($this->getRawProductCustomRanking($storeId)); + if (is_array($attrs)) { + return $attrs; + } + return []; } /** * @param $storeId - * @return bool + * @return mixed */ - public function makeSeoRequest($storeId = null) + public function getRawProductCustomRanking($storeId = null) { - return $this->configInterface->isSetFlag(self::MAKE_SEO_REQUEST, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue( + self::PRODUCT_CUSTOM_RANKING, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId * @return bool */ - public function isLoggingEnabled($storeId = null): bool + public function useAdaptiveImage($storeId = null): bool { - return $this->configInterface->isSetFlag(self::LOGGING_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::USE_ADAPTIVE_IMAGE, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isProfilerEnabled($storeId = null): bool + public function isVisualMerchEnabled($storeId = null): bool { - return $this->configInterface->isSetFlag(self::PROFILER_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::ENABLE_VISUAL_MERCHANDISING, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return bool + * @return string */ - public function getShowOutOfStock($storeId = null) + public function getCategoryPageIdAttributeName($storeId = null): string { - return $this->configInterface->isSetFlag(self::SHOW_OUT_OF_STOCK, ScopeInterface::SCOPE_STORE, $storeId); + return (string) $this->configInterface->getValue(self::CATEGORY_PAGE_ID_ATTRIBUTE_NAME, ScopeInterface::SCOPE_STORE, $storeId); } /** + * Returns config flag + * * @param $storeId * @return bool */ - public function useSecureUrlsInFrontend($storeId = null) + public function includeNonVisibleProductsInIndex($storeId = null): bool { return $this->configInterface->isSetFlag( - self::USE_SECURE_IN_FRONTEND, + self::INCLUDE_NON_VISIBLE_PRODUCTS_IN_INDEX, ScopeInterface::SCOPE_STORE, $storeId ); } /** - * @param $storeId - * @return int + * NOTE: This method is currently only used in integration tests and was removed from the general implementation + * TODO: Evaluate use cases with product permissions where we may need to restore this functionality + * @param $groupId + * @return array */ - public function getImageWidth($storeId = null) + public function getAttributesToRetrieve($groupId) { - $imageWidth = $this->configInterface->getValue( - self::XML_PATH_IMAGE_WIDTH, - ScopeInterface::SCOPE_STORE, - $storeId - ); - - if (!$imageWidth) { - return 265; + if (false === $this->isCustomerGroupsEnabled()) { + return []; } - - return (int)$imageWidth; - } - - /** - * @param $storeId - * @return int - */ - public function getImageHeight($storeId = null) - { - $imageHeight = $this->configInterface->getValue( - self::XML_PATH_IMAGE_HEIGHT, - ScopeInterface::SCOPE_STORE, - $storeId - ); - - if (!$imageHeight) { - return 265; + $attributes = []; + foreach ($this->getProductAdditionalAttributes() as $attribute) { + if ($attribute['attribute'] !== 'price' && $attribute['retrievable'] === '1') { + $attributes[] = $attribute['attribute']; + } } - - return (int)$imageHeight; - } - - /** - * @param $storeId - * @return mixed - */ - public function getImageType($storeId = null) - { - return $this->configInterface->getValue(self::XML_PATH_IMAGE_TYPE, ScopeInterface::SCOPE_STORE, $storeId); + foreach ($this->getCategoryAdditionalAttributes() as $attribute) { + if ($attribute['retrievable'] === '1') { + $attributes[] = $attribute['attribute']; + } + } + $attributes = array_merge($attributes, [ + AlgoliaConnector::ALGOLIA_API_OBJECT_ID, + 'name', + 'url', + 'visibility_search', + 'visibility_catalog', + 'categories', + 'categories_without_path', + 'thumbnail_url', + 'image_url', + 'images_data', + 'in_stock', + 'type_id', + 'value', + 'query', # suggestions + 'path', # categories + 'default_bundle_options', + ]); + $currencies = $this->dirCurrency->getConfigAllowCurrencies(); + foreach ($currencies as $currency) { + $attributes[] = 'price.' . $currency . '.default'; + $attributes[] = 'price.' . $currency . '.default_tier'; + $attributes[] = 'price.' . $currency . '.default_max'; + $attributes[] = 'price.' . $currency . '.default_formated'; + $attributes[] = 'price.' . $currency . '.default_original_formated'; + $attributes[] = 'price.' . $currency . '.default_tier_formated'; + $attributes[] = 'price.' . $currency . '.group_' . $groupId; + $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_tier'; + $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_max'; + $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_formated'; + $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_tier_formated'; + $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_original_formated'; + $attributes[] = 'price.' . $currency . '.special_from_date'; + $attributes[] = 'price.' . $currency . '.special_to_date'; + } + $transport = new DataObject($attributes); + $this->eventManager->dispatch('algolia_get_retrievable_attributes', ['attributes' => $transport]); + $attributes = $transport->getData(); + $attributes = array_unique($attributes); + $attributes = array_values($attributes); + return ['attributesToRetrieve' => $attributes]; } /** - * @param $storeId + * @param int|null $storeId * @return bool */ - public function shouldRemovePubDirectory($storeId = null) + public function useVirtualReplica(?int $storeId = null): bool { - return $this->configInterface->isSetFlag(self::REMOVE_PUB_DIR_IN_URL, ScopeInterface::SCOPE_STORE, $storeId); + return (bool) count(array_filter( + $this->getSorting($storeId), + fn($sort) => $sort[ReplicaManagerInterface::SORT_KEY_VIRTUAL_REPLICA] + )); } + // --- Categories --- // /** * @param $storeId - * @return bool + * @return array */ - public function isPartialUpdateEnabled($storeId = null) + public function getCategoryAdditionalAttributes($storeId = null) { - return $this->configInterface->isSetFlag(self::PARTIAL_UPDATES, ScopeInterface::SCOPE_STORE, $storeId); + $attributes = $this->serializer->unserialize($this->configInterface->getValue( + self::CATEGORY_ATTRIBUTES, + ScopeInterface::SCOPE_STORE, + $storeId + )); + $customRankings = $this->serializer->unserialize($this->configInterface->getValue( + self::CATEGORY_CUSTOM_RANKING, + ScopeInterface::SCOPE_STORE, + $storeId + )); + $customRankings = $customRankings ?: []; + $customRankings = array_filter($customRankings, fn($customRanking) => $customRanking['attribute'] !== 'custom_attribute'); + $attributes = $this->addIndexableAttributes($attributes, $customRankings, '0', '0'); + if (is_array($attributes)) { + return $attributes; + } + return []; } /** * @param $storeId * @return array */ - public function getAutocompleteSections($storeId = null) + public function getCategoryCustomRanking($storeId = null): array { - $attrs = $this->unserialize($this->configInterface->getValue( - self::AUTOCOMPLETE_SECTIONS, + $attrs = $this->serializer->unserialize($this->configInterface->getValue( + self::CATEGORY_CUSTOM_RANKING, ScopeInterface::SCOPE_STORE, $storeId )); - if (is_array($attrs)) { - return array_values($attrs); + return $attrs; } - return []; } - protected function serialize(array $value): string { - return $this->serializer->serialize($value) ?: ''; - } - /** - * @param $value - * @return array|bool|float|int|mixed|string|null + * @param $storeId + * @return bool */ - protected function unserialize($value) + public function showCatsNotIncludedInNavigation($storeId = null) { - if (false === $value || null === $value || '' === $value) { - return false; - } - $unserialized = json_decode($value, true); - if (json_last_error() === JSON_ERROR_NONE) { - return $unserialized; - } - return $this->serializer->unserialize($value); + return $this->configInterface->isSetFlag( + self::SHOW_CATS_NOT_INCLUDED_IN_NAV, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId - * @return int + * @return bool */ - public function getMinPopularity($storeId = null) + public function shouldIndexEmptyCategories($storeId = null): bool { - return (int)$this->configInterface->getValue(self::MIN_POPULARITY, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::INDEX_EMPTY_CATEGORIES, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return int + * @return string */ - public function getMinNumberOfResults($storeId = null) + public function getCategorySeparator($storeId = null): string { - return (int)$this->configInterface->getValue(self::MIN_NUMBER_OF_RESULTS, ScopeInterface::SCOPE_STORE, $storeId); + return (string) $this->configInterface->getValue(self::CATEGORY_SEPARATOR, ScopeInterface::SCOPE_STORE, $storeId); } + // --- Recommend Product Settings --- // + /** * @param $storeId * @return bool */ - public function isAddToCartEnable($storeId = null) + public function isRecommendFrequentlyBroughtTogetherEnabled($storeId = null): bool { - return $this->configInterface->isSetFlag( - self::XML_ADD_TO_CART_ENABLE, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->isSetFlag(self::IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isInfiniteScrollEnabled($storeId = null) + public function isRecommendRelatedProductsEnabled($storeId = null): bool { - return $this->isInstantEnabled($storeId) - && $this->configInterface->isSetFlag(self::INFINITE_SCROLL_ENABLE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_RECOMMEND_RELATED_PRODUCTS_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function hidePaginationInInstantSearchPage($storeId = null) + public function isRecommendFrequentlyBroughtTogetherEnabledOnCartPage($storeId = null): bool { - return $this->isInstantEnabled($storeId) - && $this->configInterface->isSetFlag(self::HIDE_PAGINATION, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED_ON_CART_PAGE, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isInstantSearchBoxEnabled($storeId = null) + public function isRecommendRelatedProductsEnabledOnCartPage($storeId = null): bool { - return $this->isInstantEnabled($storeId) - && $this->configInterface->isSetFlag(self::SEARCHBOX_ENABLE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_RECOMMEND_RELATED_PRODUCTS_ENABLED_ON_CART_PAGE, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isInstantEnabled($storeId = null) + public function isRemoveCoreRelatedProductsBlock($storeId = null): bool { - return $this->configInterface->isSetFlag(self::IS_INSTANT_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_REMOVE_RELATED_PRODUCTS_BLOCK, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isRemoveBranding($storeId = null) + public function isRemoveUpsellProductsBlock($storeId = null): bool { - return $this->configInterface->isSetFlag(self::REMOVE_BRANDING, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_REMOVE_UPSELL_PRODUCTS_BLOCK, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return int */ - public function getMaxValuesPerFacet($storeId = null) + public function getNumberOfRelatedProducts($storeId = null): int { - return (int)$this->configInterface->getValue(self::MAX_VALUES_PER_FACET, ScopeInterface::SCOPE_STORE, $storeId); + return (int) $this->configInterface->getValue( + self::NUM_OF_RECOMMEND_RELATED_PRODUCTS, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId * @return int */ - public function getNumberOfElementByPage($storeId = null) + public function getNumberOfFrequentlyBoughtTogetherProducts($storeId = null): int { - return (int)$this->configInterface->getValue(self::NUMBER_OF_ELEMENT_BY_PAGE, ScopeInterface::SCOPE_STORE, $storeId); + return (int) $this->configInterface->getValue( + self::NUM_OF_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_PRODUCTS, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** - * @param $storeId - * @return mixed + * @param int $storeId + * @return int */ - public function getNumberOfJobToRun($storeId = null) + public function isRecommendTrendingItemsEnabled($storeId = null) { - $nbJobs = (int)$this->configInterface->getValue(self::NUMBER_OF_JOB_TO_RUN, ScopeInterface::SCOPE_STORE, $storeId); - - return max($nbJobs, 1); + return (int)$this->configInterface->getValue( + self::IS_RECOMMEND_TRENDING_ITEMS_ENABLED, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId * @return int */ - public function getRetryLimit($storeId = null) + public function getNumberOfTrendingItems($storeId = null): int { - return (int)$this->configInterface->getValue(self::RETRY_LIMIT, ScopeInterface::SCOPE_STORE, $storeId); + return (int) $this->configInterface->getValue( + self::NUM_OF_TRENDING_ITEMS, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** + * Returns number of looking similar products to display + * * @param $storeId - * @return bool + * @return int */ - public function isQueueActive($storeId = null) + public function getNumberOfLookingSimilar($storeId = null): int { - return $this->configInterface->isSetFlag(self::IS_ACTIVE, ScopeInterface::SCOPE_STORE, $storeId); + return (int) $this->configInterface->getValue( + self::NUM_OF_LOOKING_SIMILAR, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId - * @return bool + * @return mixed */ - public function isEnhancedQueueArchiveEnabled($storeId = null) + public function getTrendingItemsFacetName($storeId = null) { - return $this->configInterface->isSetFlag(self::ENHANCED_QUEUE_ARCHIVE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue( + self::TREND_ITEMS_FACET_NAME, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId * @return mixed */ - public function getRemoveWordsIfNoResult($storeId = null) + public function getTrendingItemsFacetValue($storeId = null) { - return $this->configInterface->getValue(self::REMOVE_IF_NO_RESULT, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue( + self::TREND_ITEMS_FACET_VALUE, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** + * Determines whether Looking Similar enabled (for widgets)) + * * @param $storeId * @return int */ - public function getNumberOfProductResults($storeId = null) + public function isRecommendLookingSimilarEnabled($storeId = null) { return (int)$this->configInterface->getValue( - self::NUMBER_OF_PRODUCT_RESULTS, + self::IS_RECOMMEND_LOOKING_SIMILAR_ENABLED, ScopeInterface::SCOPE_STORE, $storeId ); } /** + * Determines whether Looking Similar enabled on PDP + * * @param $storeId - * @return bool + * @return int */ - public function replaceCategories($storeId = null) + public function isLookingSimilarEnabledInPDP($storeId = null) { - return $this->configInterface->isSetFlag(self::REPLACE_CATEGORIES, ScopeInterface::SCOPE_STORE, $storeId); + return (int)$this->configInterface->getValue( + self::IS_LOOKING_SIMILAR_ENABLED_IN_PDP, + ScopeInterface::SCOPE_STORE, + $storeId + ); } - /** - * @param $storeId - * @return bool - */ - public function isAutoCompleteEnabled($storeId = null) + public function getLookingSimilarTitle($storeId = null) { - return $this->configInterface->isSetFlag(self::IS_POPUP_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue( + self::LOOKING_SIMILAR_TITLE, + ScopeInterface::SCOPE_STORE, $storeId + ); } /** * @param $storeId - * @return bool + * @return int */ - public function isRecommendFrequentlyBroughtTogetherEnabled($storeId = null) + public function isLookingSimilarEnabledInShoppingCart($storeId = null) { - return $this->configInterface->isSetFlag(self::IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + return (int)$this->configInterface->getValue( + self::IS_LOOKING_SIMILAR_ENABLED_IN_SHOPPING_CART, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId - * @return bool + * @return int */ - public function isRecommendRelatedProductsEnabled($storeId = null) + public function isTrendItemsEnabledInPDP($storeId = null) { - return $this->configInterface->isSetFlag(self::IS_RECOMMEND_RELATED_PRODUCTS_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + return (int)$this->configInterface->getValue( + self::IS_TREND_ITEMS_ENABLED_IN_PDP, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId - * @return bool + * @return int */ - public function isRecommendFrequentlyBroughtTogetherEnabledOnCartPage($storeId = null) + public function isTrendItemsEnabledInShoppingCart($storeId = null) { - return $this->configInterface->isSetFlag(self::IS_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_ENABLED_ON_CART_PAGE, ScopeInterface::SCOPE_STORE, $storeId); + return (int)$this->configInterface->getValue( + self::IS_TREND_ITEMS_ENABLED_IN_SHOPPING_CART, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** * @param $storeId * @return bool */ - public function isRecommendRelatedProductsEnabledOnCartPage($storeId = null) + public function isAddToCartEnabledInFrequentlyBoughtTogether($storeId = null): bool { - return $this->configInterface->isSetFlag(self::IS_RECOMMEND_RELATED_PRODUCTS_ENABLED_ON_CART_PAGE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_ADDTOCART_ENABLED_IN_FREQUENTLY_BOUGHT_TOGETHER, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isRemoveCoreRelatedProductsBlock($storeId = null) + public function isAddToCartEnabledInRelatedProducts($storeId = null): bool { - return $this->configInterface->isSetFlag(self::IS_REMOVE_RELATED_PRODUCTS_BLOCK, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_ADDTOCART_ENABLED_IN_RELATED_PRODUCTS, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isRemoveUpsellProductsBlock($storeId = null) + public function isAddToCartEnabledInTrendsItem($storeId = null): bool { - return $this->configInterface->isSetFlag(self::IS_REMOVE_UPSELL_PRODUCTS_BLOCK, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::IS_ADDTOCART_ENABLED_IN_TRENDS_ITEM, ScopeInterface::SCOPE_STORE, $storeId); } /** + * Determines whether add to cart is enabled in Looking Similar + * * @param $storeId - * @return int + * @return bool */ - public function getNumberOfRelatedProducts($storeId = null) + public function isAddToCartEnabledInLookingSimilar($storeId = null): bool { - return (int)$this->configInterface->getValue( - self::NUM_OF_RECOMMEND_RELATED_PRODUCTS, + return $this->configInterface->isSetFlag( + self::IS_ADDTOCART_ENABLED_IN_LOOKING_SIMILAR, ScopeInterface::SCOPE_STORE, $storeId ); @@ -722,291 +869,254 @@ public function getNumberOfRelatedProducts($storeId = null) /** * @param $storeId - * @return int + * @return string */ - public function getNumberOfFrequentlyBoughtTogetherProducts($storeId = null) + public function getFBTTitle($storeId = null) { - return (int)$this->configInterface->getValue( - self::NUM_OF_RECOMMEND_FREQUENTLY_BOUGHT_TOGETHER_PRODUCTS, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->getValue(self::FREQUENTLY_BOUGHT_TOGETHER_TITLE, ScopeInterface::SCOPE_STORE, $storeId); } /** - * @param int $storeId - * @return int - */ - public function isRecommendTrendingItemsEnabled($storeId = null) + * @param $storeId + * @return string + */ + public function getRelatedProductsTitle($storeId = null) { - return (int)$this->configInterface->getValue( - self::IS_RECOMMEND_TRENDING_ITEMS_ENABLED, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->getValue(self::RELATED_PRODUCTS_TITLE, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return int + * @return string */ - public function getNumberOfTrendingItems($storeId = null) + public function getTrendingItemsTitle($storeId = null) { - return (int)$this->configInterface->getValue( - self::NUM_OF_TRENDING_ITEMS, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->getValue(self::TRENDING_ITEMS_TITLE, ScopeInterface::SCOPE_STORE, $storeId); } + // --- Images --- // + /** - * Returns number of looking similar products to display - * * @param $storeId * @return int */ - public function getNumberOfLookingSimilar($storeId = null) + public function getImageWidth($storeId = null) { - return (int)$this->configInterface->getValue( - self::NUM_OF_LOOKING_SIMILAR, + $imageWidth = $this->configInterface->getValue( + self::XML_PATH_IMAGE_WIDTH, ScopeInterface::SCOPE_STORE, $storeId ); + + if (!$imageWidth) { + return 265; + } + + return (int)$imageWidth; } /** * @param $storeId - * @return mixed + * @return int */ - public function getTrendingItemsFacetName($storeId = null) + public function getImageHeight($storeId = null) { - return $this->configInterface->getValue( - self::TREND_ITEMS_FACET_NAME, + $imageHeight = $this->configInterface->getValue( + self::XML_PATH_IMAGE_HEIGHT, ScopeInterface::SCOPE_STORE, $storeId ); + + if (!$imageHeight) { + return 265; + } + + return (int)$imageHeight; } /** * @param $storeId * @return mixed */ - public function getTrendingItemsFacetValue($storeId = null) + public function getImageType($storeId = null) { - return $this->configInterface->getValue( - self::TREND_ITEMS_FACET_VALUE, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->getValue(self::XML_PATH_IMAGE_TYPE, ScopeInterface::SCOPE_STORE, $storeId); } - /** - * Determines whether Looking Similar enabled (for widgets)) - * - * @param $storeId - * @return int - */ - public function isRecommendLookingSimilarEnabled($storeId = null) - { - return (int)$this->configInterface->getValue( - self::IS_RECOMMEND_LOOKING_SIMILAR_ENABLED, - ScopeInterface::SCOPE_STORE, - $storeId - ); - } + // --- Indexing Queue / Cron --- // /** - * Determines whether Looking Similar enabled on PDP - * * @param $storeId - * @return int + * @return mixed */ - public function isLookingSimilarEnabledInPDP($storeId = null) + public function getNumberOfJobToRun($storeId = null): int { - return (int)$this->configInterface->getValue( - self::IS_LOOKING_SIMILAR_ENABLED_IN_PDP, - ScopeInterface::SCOPE_STORE, - $storeId - ); - } + $nbJobs = (int) $this->configInterface->getValue(self::NUMBER_OF_JOB_TO_RUN, ScopeInterface::SCOPE_STORE, $storeId); - public function getLookingSimilarTitle($storeId = null) - { - return $this->configInterface->getValue( - self::LOOKING_SIMILAR_TITLE, - ScopeInterface::SCOPE_STORE, $storeId - ); + return (int) max($nbJobs, 1); } /** * @param $storeId * @return int */ - public function isLookingSimilarEnabledInShoppingCart($storeId = null) + public function getRetryLimit($storeId = null): int { - return (int)$this->configInterface->getValue( - self::IS_LOOKING_SIMILAR_ENABLED_IN_SHOPPING_CART, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return (int) $this->configInterface->getValue(self::RETRY_LIMIT, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return int + * @return bool */ - public function isTrendItemsEnabledInPDP($storeId = null) + public function isQueueActive($storeId = null): bool { - return (int)$this->configInterface->getValue( - self::IS_TREND_ITEMS_ENABLED_IN_PDP, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->isSetFlag(self::IS_ACTIVE, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return int + * @return bool */ - public function isTrendItemsEnabledInShoppingCart($storeId = null) + public function useBuiltInCron($storeId = null): bool { - return (int)$this->configInterface->getValue( - self::IS_TREND_ITEMS_ENABLED_IN_SHOPPING_CART, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->isSetFlag(self::USE_BUILT_IN_CRON, ScopeInterface::SCOPE_STORE, $storeId); } + // --- Indexing Manager --- // + /** * @param $storeId * @return bool */ - public function isAddToCartEnabledInFrequentlyBoughtTogether($storeId = null) + public function isIndexingEnabled($storeId = null): bool { - return $this->configInterface->isSetFlag(self::IS_ADDTOCART_ENABLED_IN_FREQUENTLY_BOUGHT_TOGETHER, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::ENABLE_INDEXING, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isAddToCartEnabledInRelatedProducts($storeId = null) + public function isQuerySuggestionsIndexEnabled($storeId = null): bool { - return $this->configInterface->isSetFlag(self::IS_ADDTOCART_ENABLED_IN_RELATED_PRODUCTS, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::ENABLE_QUERY_SUGGESTIONS_INDEX, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return bool */ - public function isAddToCartEnabledInTrendsItem($storeId = null) + public function isPagesIndexEnabled($storeId = null): bool { - return $this->configInterface->isSetFlag(self::IS_ADDTOCART_ENABLED_IN_TRENDS_ITEM, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::ENABLE_PAGES_INDEX, ScopeInterface::SCOPE_STORE, $storeId); } /** - * Determines whether add to cart is enabled in Looking Similar - * - * @param $storeId * @return bool */ - public function isAddToCartEnabledInLookingSimilar($storeId = null) + public function isProductsIndexerEnabled(): bool { return $this->configInterface->isSetFlag( - self::IS_ADDTOCART_ENABLED_IN_LOOKING_SIMILAR, - ScopeInterface::SCOPE_STORE, - $storeId + self::ENABLE_INDEXER_PRODUCTS, + ScopeInterface::SCOPE_STORE ); } /** - * @param $storeId - * @return string + * @return bool */ - public function getFBTTitle($storeId = null) + public function isCategoriesIndexerEnabled(): bool { - return $this->configInterface->getValue(self::FREQUENTLY_BOUGHT_TOGETHER_TITLE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag( + self::ENABLE_INDEXER_CATEGORIES, + ScopeInterface::SCOPE_STORE + ); } /** - * @param $storeId - * @return string + * @return bool */ - public function getRelatedProductsTitle($storeId = null) + public function isPagesIndexerEnabled(): bool { - return $this->configInterface->getValue(self::RELATED_PRODUCTS_TITLE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag( + self::ENABLE_INDEXER_PAGES, + ScopeInterface::SCOPE_STORE + ); } /** - * @param $storeId - * @return string + * @return bool */ - public function getTrendingItemsTitle($storeId = null) + public function isSuggestionsIndexerEnabled(): bool { - return $this->configInterface->getValue(self::TRENDING_ITEMS_TITLE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag( + self::ENABLE_INDEXER_SUGGESTIONS, + ScopeInterface::SCOPE_STORE + ); } /** - * @param $storeId * @return bool */ - public function useAdaptiveImage($storeId = null) + public function isAdditionalSectionsIndexerEnabled(): bool { - return $this->configInterface->isSetFlag(self::USE_ADAPTIVE_IMAGE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag( + self::ENABLE_INDEXER_ADDITIONAL_SECTIONS, + ScopeInterface::SCOPE_STORE + ); } /** - * @param $storeId * @return bool */ - public function isVisualMerchEnabled($storeId = null): bool + public function isDeleteProductsIndexerEnabled(): bool { - return $this->configInterface->isSetFlag(self::ENABLE_VISUAL_MERCHANDISING, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag( + self::ENABLE_INDEXER_DELETE_PRODUCTS, + ScopeInterface::SCOPE_STORE + ); } /** - * @param $storeId - * @return string + * @return bool */ - public function getCategoryPageIdAttributeName($storeId = null): string + public function isQueueIndexerEnabled(): bool { - return (string) $this->configInterface->getValue(self::CATEGORY_PAGE_ID_ATTRIBUTE_NAME, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag( + self::ENABLE_INDEXER_QUEUE, + ScopeInterface::SCOPE_STORE + ); } + // --- Click & Conversion Analytics --- // + /** * @param $storeId - * @return mixed + * @return bool */ - public function getInstantSelector($storeId = null) + public function isClickConversionAnalyticsEnabled($storeId = null): bool { - return $this->configInterface->getValue(self::INSTANT_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::CC_ANALYTICS_ENABLE, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return array + * @return mixed */ - public function getExcludedPages($storeId = null) + public function getClickConversionAnalyticsISSelector($storeId = null) { - $attrs = $this->unserialize($this->configInterface->getValue( - self::EXCLUDED_PAGES, - ScopeInterface::SCOPE_STORE, - $storeId - )); - if (is_array($attrs)) { - return $attrs; - } - return []; + return $this->configInterface->getValue(self::CC_ANALYTICS_IS_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return mixed */ - public function getRenderTemplateDirectives($storeId = null) + public function getConversionAnalyticsMode($storeId = null) { return $this->configInterface->getValue( - self::RENDER_TEMPLATE_DIRECTIVES, + self::CC_CONVERSION_ANALYTICS_MODE, ScopeInterface::SCOPE_STORE, $storeId ); @@ -1014,182 +1124,64 @@ public function getRenderTemplateDirectives($storeId = null) /** * @param $storeId - * @return bool + * @return mixed */ - public function isAutocompleteDebugEnabled($storeId = null) - { - return $this->configInterface->isSetFlag(self::AUTOCOMPLETE_MENU_DEBUG, ScopeInterface::SCOPE_STORE, $storeId); - } - - public function getAutocompleteDebounceMilliseconds($storeId = null): int + public function getConversionAnalyticsAddToCartSelector($storeId = null) { - return (int) $this->configInterface->getValue( - self::AUTOCOMPLETE_DEBOUNCE_MILLISEC, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->getValue(self::CC_ADD_TO_CART_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); } - public function getAutocompleteMinimumCharacterLength($storeId = null): int - { - return (int) $this->configInterface->getValue( - self::AUTOCOMPLETE_MINIMUM_CHAR_LENGTH, - ScopeInterface::SCOPE_STORE, - $storeId - ); - } + // --- Google Analytics --- // /** - * @param $originalIndexName * @param $storeId - * @param $currentCustomerGroupId - * @param $attrs * @return array - * @throws Magento\Framework\Exception\LocalizedException - * @throws Magento\Framework\Exception\NoSuchEntityException - * @deprecated This method has been deprecated and should no longer be used - * @see \Algolia\AlgoliaSearch\Service\Product\SortingTransformer */ - public function getSortingIndices($originalIndexName, $storeId = null, $currentCustomerGroupId = null, $attrs = null) + public function getAnalyticsConfig($storeId = null) { - if (!$attrs){ - $attrs = $this->getSorting($storeId); - } - - $currency = $this->getCurrencyCode($storeId); - $attributesToAdd = []; - foreach ($attrs as $key => $attr) { - $indexName = false; - $sortAttribute = false; - if ($this->isCustomerGroupsEnabled($storeId) && $attr['attribute'] === 'price') { - $websiteId = (int)$this->storeManager->getStore($storeId)->getWebsiteId(); - $groupCollection = $this->groupCollection; - if (!is_null($currentCustomerGroupId)) { - $groupCollection->addFilter('customer_group_id', $currentCustomerGroupId); - } - foreach ($groupCollection as $group) { - $customerGroupId = (int)$group->getData('customer_group_id'); - $excludedWebsites = $this->groupExcludedWebsiteRepository->getCustomerGroupExcludedWebsites($customerGroupId); - if (in_array($websiteId, $excludedWebsites)) { - continue; - } - $groupIndexNameSuffix = 'group_' . $customerGroupId; - $groupIndexName = - $originalIndexName . '_' . $attr['attribute'] . '_' . $groupIndexNameSuffix . '_' . $attr['sort']; - $groupSortAttribute = $attr['attribute'] . '.' . $currency . '.' . $groupIndexNameSuffix; - $newAttr = []; - $newAttr['name'] = $groupIndexName; - $newAttr['attribute'] = $attr['attribute']; - $newAttr['sort'] = $attr['sort']; - $newAttr['sortLabel'] = $attr['sortLabel']; - if (!array_key_exists('label', $newAttr) && array_key_exists('sortLabel', $newAttr)) { - $newAttr['label'] = $newAttr['sortLabel']; - } - $newAttr['ranking'] = [ - $newAttr['sort'] . '(' . $groupSortAttribute . ')', - 'typo', - 'geo', - 'words', - 'filters', - 'proximity', - 'attribute', - 'exact', - 'custom', - ]; - $attributesToAdd[$newAttr['sort']][] = $newAttr; - } - } elseif ($attr['attribute'] === 'price') { - $indexName = $originalIndexName . '_' . $attr['attribute'] . '_' . 'default' . '_' . $attr['sort']; - $sortAttribute = $attr['attribute'] . '.' . $currency . '.' . 'default'; - } else { - $indexName = $originalIndexName . '_' . $attr['attribute'] . '_' . $attr['sort']; - $sortAttribute = $attr['attribute']; - } - if ($indexName && $sortAttribute) { - $attrs[$key]['name'] = $indexName; - if (!array_key_exists('label', $attrs[$key]) && array_key_exists('sortLabel', $attrs[$key])) { - $attrs[$key]['label'] = $attrs[$key]['sortLabel']; - } - $attrs[$key]['ranking'] = [ - $attr['sort'] . '(' . $sortAttribute . ')', - 'typo', - 'geo', - 'words', - 'filters', - 'proximity', - 'attribute', - 'exact', - 'custom', - ]; - } - } - $attrsToReturn = []; - if (count($attributesToAdd) > 0) { - foreach ($attrs as $key => $attr) { - if ($attr['attribute'] == 'price' && isset($attributesToAdd[$attr['sort']])) { - $attrsToReturn = array_merge($attrsToReturn, $attributesToAdd[$attr['sort']]); - } else { - $attrsToReturn[] = $attr; - } - } - } - if (count($attrsToReturn) > 0) { - return $attrsToReturn; - } - if (is_array($attrs)) { - return $attrs; - } - return []; - } - - /*** - * @param int|null $storeId - * @return array>> - */ - public function getSorting(?int $storeId = null): array - { - return $this->unserialize($this->getRawSortingValue($storeId)); + return [ + 'enabled' => $this->isAnalyticsEnabled(), + 'delay' => $this->configInterface->getValue(self::GA_DELAY, ScopeInterface::SCOPE_STORE, $storeId), + 'triggerOnUiInteraction' => $this->configInterface->getValue( + self::GA_TRIGGER_ON_UI_INTERACTION, + ScopeInterface::SCOPE_STORE, + $storeId + ), + 'pushInitialSearch' => $this->configInterface->getValue( + self::GA_PUSH_INITIAL_SEARCH, + ScopeInterface::SCOPE_STORE, + $storeId + ), + ]; } /** - * @param int|null $storeId - * @return string + * @param $storeId + * @return bool */ - public function getRawSortingValue(?int $storeId = null): string + public function isAnalyticsEnabled($storeId = null): bool { - return (string) $this->configInterface->getValue( - self::SORTING_INDICES, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->configInterface->isSetFlag(self::GA_ENABLE, ScopeInterface::SCOPE_STORE, $storeId); } + // --- Advanced --- // + /** - * @param array $sorting - * @param string|null $scope - * @param int|null $scopeId - * @return void + * @param $storeId + * @return mixed */ - public function setSorting(array $sorting, string $scope = Magento\Framework\App\Config\ScopeConfigInterface::SCOPE_TYPE_DEFAULT, ?int $scopeId = null): void + public function getRemoveWordsIfNoResult($storeId = null) { - $this->configWriter->save( - self::SORTING_INDICES, - $this->serialize($sorting), - $scope, - $scopeId - ); + return $this->configInterface->getValue(self::REMOVE_IF_NO_RESULT, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return string - * @throws Magento\Framework\Exception\NoSuchEntityException + * @return bool */ - public function getCurrencyCode($storeId = null) + public function isPartialUpdateEnabled($storeId = null): bool { - /** @var Magento\Store\Model\Store $store */ - $store = $this->storeManager->getStore($storeId); - return $store->getCurrentCurrencyCode(); + return $this->configInterface->isSetFlag(self::PARTIAL_UPDATES, ScopeInterface::SCOPE_STORE, $storeId); } /** @@ -1214,49 +1206,134 @@ 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) + public function shouldRemovePubDirectory($storeId = null): bool { - return $this->getApplicationID($storeId) && - $this->getAPIKey($storeId) && - $this->getSearchOnlyAPIKey($storeId); + return $this->configInterface->isSetFlag(self::REMOVE_PUB_DIR_IN_URL, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return mixed' + * @return bool */ - public function getApplicationID($storeId = null) + public function isRemoveBranding($storeId = null): bool { - return $this->configInterface->getValue(self::APPLICATION_ID, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->isSetFlag(self::REMOVE_BRANDING, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId * @return mixed */ - public function getAPIKey($storeId = null) + public function indexProductOnCategoryProductsUpdate($storeId = null) { - return $this->configInterface->getValue(self::API_KEY, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue( + self::IDX_PRODUCT_ON_CAT_PRODUCTS_UPD, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + + /** + * @param $storeId + * @return bool + * @deprecated This feature is deprecated and will be replaced in an upcoming version + */ + public function preventBackendRendering($storeId = null): bool + { + $preventBackendRendering = $this->configInterface->isSetFlag( + self::PREVENT_BACKEND_RENDERING, + ScopeInterface::SCOPE_STORE, + $storeId + ); + if ($preventBackendRendering === false) { + return false; + } + if (!isset($_SERVER['HTTP_USER_AGENT'])) { + return false; + } + $userAgent = mb_strtolower((string) filter_input(INPUT_SERVER, 'HTTP_USER_AGENT', FILTER_SANITIZE_SPECIAL_CHARS), 'utf-8'); + + $allowedUserAgents = $this->configInterface->getValue( + self::BACKEND_RENDERING_ALLOWED_USER_AGENTS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + $allowedUserAgents = trim((string) $allowedUserAgents); + if ($allowedUserAgents === '') { + return true; + } + $allowedUserAgents = preg_split('/\n|\r\n?/', $allowedUserAgents); + $allowedUserAgents = array_filter($allowedUserAgents); + foreach ($allowedUserAgents as $allowedUserAgent) { + $allowedUserAgent = mb_strtolower($allowedUserAgent, 'utf-8'); + if (mb_strpos($userAgent, $allowedUserAgent) !== false) { + return false; + } + } + return true; } /** * @param $storeId * @return mixed */ - public function getSearchOnlyAPIKey($storeId = null) + public function getBackendRenderingDisplayMode($storeId = null) { - return $this->configInterface->getValue(self::SEARCH_ONLY_API_KEY, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue( + self::PREVENT_BACKEND_RENDERING_DISPLAY_MODE, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** - * @param int|null $storeId + * @param $storeId + * @return array + */ + public function getNonCastableAttributes($storeId = null) + { + $nonCastableAttributes = []; + $config = $this->serializer->unserialize($this->configInterface->getValue( + self::NON_CASTABLE_ATTRIBUTES, + ScopeInterface::SCOPE_STORE, + $storeId + )); + if (is_array($config)) { + foreach ($config as $attributeData) { + if (isset($attributeData['attribute'])) { + $nonCastableAttributes[] = $attributeData['attribute']; + } + } + } + return $nonCastableAttributes; + } + + /** + * @param $storeId + * @return int + */ + public function getMaxRecordSizeLimit($storeId = null) + { + return (int) $this->configInterface->getValue( + self::MAX_RECORD_SIZE_LIMIT, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + /** + * @param $storeId * @return string */ - public function getIndexPrefix(int $storeId = null): string + public function getAnalyticsRegion($storeId = null) { - return (string) $this->configInterface->getValue(self::INDEX_PREFIX, ScopeInterface::SCOPE_STORE, $storeId); + return $this->configInterface->getValue( + self::ANALYTICS_REGION, + ScopeInterface::SCOPE_STORE, + $storeId + ); } /** @@ -1286,6 +1363,15 @@ public function getWriteTimeout($storeId = null) return $this->configInterface->getValue(self::WRITE_TIMEOUT, ScopeInterface::SCOPE_STORE, $storeId); } + public function shouldForwardPrimaryIndexSettingsToReplicas(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag( + self::FORWARD_TO_REPLICAS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + public function isAutoPriceIndexingEnabled(?int $storeId = null): bool { return $this->configInterface->isSetFlag( @@ -1295,142 +1381,114 @@ public function isAutoPriceIndexingEnabled(?int $storeId = null): bool ); } + public function isProfilerEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag(self::PROFILER_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + // Indexing Queue advanced settings /** * @param $storeId - * @return array|bool|float|int|mixed|string + * @return int */ - public function getFacets($storeId = null) + public function getNumberOfElementByPage($storeId = null): int { - $attrs = $this->unserialize($this->configInterface->getValue( - self::FACETS, - ScopeInterface::SCOPE_STORE, - $storeId - )); - if ($attrs) { - foreach ($attrs as &$attr) { - if ($attr['type'] === 'other') { - $attr['type'] = $attr['other_type']; - } - } - if (is_array($attrs)) { - return array_values($attrs); - } - } - return []; + return (int) $this->configInterface->getValue(self::NUMBER_OF_ELEMENT_BY_PAGE, ScopeInterface::SCOPE_STORE, $storeId); } /** * @param $storeId - * @return array + * @return int */ - public function getCategoryCustomRanking($storeId = null) + public function getArchiveLogClearLimit($storeId = null) { - $attrs = $this->unserialize($this->configInterface->getValue( - self::CATEGORY_CUSTOM_RANKING, + return (int)$this->configInterface->getValue( + self::ARCHIVE_LOG_CLEAR_LIMIT, ScopeInterface::SCOPE_STORE, $storeId - )); - if (is_array($attrs)) { - return $attrs; - } - return []; + ); } /** * @param $storeId - * @return array + * @return bool */ - public function getProductCustomRanking($storeId = null) + public function isEnhancedQueueArchiveEnabled($storeId = null): bool { - $attrs = $this->unserialize($this->getRawProductCustomRanking($storeId)); - if (is_array($attrs)) { - return $attrs; - } - return []; + return $this->configInterface->isSetFlag(self::ENHANCED_QUEUE_ARCHIVE, ScopeInterface::SCOPE_STORE, $storeId); } + // --- Extra index settings --- // + /** + * @param $section * @param $storeId - * @return mixed + * @return string */ - public function getRawProductCustomRanking($storeId = null) + public function getExtraSettings($section, $storeId = null): string { - return $this->configInterface->getValue( - self::PRODUCT_CUSTOM_RANKING, - ScopeInterface::SCOPE_STORE, - $storeId - ); + $constant = 'EXTRA_SETTINGS_' . mb_strtoupper((string) $section); + $value = $this->configInterface->getValue(constant('self::' . $constant), ScopeInterface::SCOPE_STORE, $storeId); + return trim((string)$value); } + // --- Magento Core --- // + /** - * @param $section - * @param $storeId * @return string */ - public function getExtraSettings($section, $storeId = null) + public function getMagentoVersion() { - $constant = 'EXTRA_SETTINGS_' . mb_strtoupper($section); - $value = $this->configInterface->getValue(constant('self::' . $constant), ScopeInterface::SCOPE_STORE, $storeId); - return trim((string)$value); + return $this->productMetadata->getVersion(); } /** - * @param $storeId - * @return bool - * @deprecated This feature is deprecated and will be replaced in an upcoming version + * @return string */ - public function preventBackendRendering($storeId = null) + public function getMagentoEdition() { - $preventBackendRendering = $this->configInterface->isSetFlag( - self::PREVENT_BACKEND_RENDERING, - ScopeInterface::SCOPE_STORE, - $storeId - ); - if ($preventBackendRendering === false) { - return false; - } - if (!isset($_SERVER['HTTP_USER_AGENT'])) { - return false; - } - $userAgent = mb_strtolower($_SERVER['HTTP_USER_AGENT'], 'utf-8'); - $allowedUserAgents = $this->configInterface->getValue( - self::BACKEND_RENDERING_ALLOWED_USER_AGENTS, - ScopeInterface::SCOPE_STORE, - $storeId - ); - $allowedUserAgents = trim($allowedUserAgents); - if ($allowedUserAgents === '') { - return true; - } - $allowedUserAgents = preg_split('/\n|\r\n?/', $allowedUserAgents); - $allowedUserAgents = array_filter($allowedUserAgents); - foreach ($allowedUserAgents as $allowedUserAgent) { - $allowedUserAgent = mb_strtolower($allowedUserAgent, 'utf-8'); - if (mb_strpos($userAgent, $allowedUserAgent) !== false) { - return false; - } - } - return true; + return $this->productMetadata->getEdition(); } /** - * @param $storeId - * @return mixed + * @return false|string */ - public function getBackendRenderingDisplayMode($storeId = null) + public function getExtensionVersion() { - return $this->configInterface->getValue( - self::PREVENT_BACKEND_RENDERING_DISPLAY_MODE, - ScopeInterface::SCOPE_STORE, - $storeId + return $this->moduleResource->getDbVersion('Algolia_AlgoliaSearch'); + } + + /** + * @throws \Magento\Framework\Exception\NoSuchEntityException + */ + public function getCurrencyCode(?int $storeId = null): string + { + /** @var \Magento\Store\Model\Store $store */ + $store = $this->storeManager->getStore($storeId); + return $store->getCurrentCurrencyCode(); + } + + /** + * Obtain the store scoped currency configuration or fall back to all allowed currencies + * @return array + */ + public function getAllowedCurrencies(?int $storeId = null): array + { + $configured = explode( + ',', + $this->configInterface->getValue( + DirCurrency::XML_PATH_CURRENCY_ALLOW, + ScopeInterface::SCOPE_STORE, + $storeId + ) ?? '' ); + return $configured ?: $this->dirCurrency->getConfigAllowCurrencies(); } /** - * @return int - * @throws Magento\Framework\Exception\NoSuchEntityException + * @throws \Magento\Framework\Exception\NoSuchEntityException */ - public function getStoreId() + public function getStoreId(): int { return $this->storeManager->getStore()->getId(); } @@ -1451,11 +1509,11 @@ public function getStoreLocale($storeId) /** * @param $storeId * @return string|null - * @throws Magento\Framework\Exception\NoSuchEntityException + * @throws \Magento\Framework\Exception\NoSuchEntityException */ public function getCurrency($storeId = null) { - /** @var Magento\Store\Model\Store $store */ + /** @var \Magento\Store\Model\Store $store */ $store = $this->storeManager->getStore($storeId); return $this->currency->getCurrency($store->getCurrentCurrencyCode())->getSymbol(); } @@ -1464,446 +1522,592 @@ public function getCurrency($storeId = null) * @param $storeId * @return bool */ - public function showSuggestionsOnNoResultsPage($storeId = null) + public function getShowOutOfStock($storeId = null): bool + { + return $this->configInterface->isSetFlag(self::SHOW_OUT_OF_STOCK, ScopeInterface::SCOPE_STORE, $storeId); + } + + /** + * @param $storeId + * @return bool + */ + public function useSecureUrlsInFrontend($storeId = null): bool { return $this->configInterface->isSetFlag( - self::SHOW_SUGGESTIONS_NO_RESULTS, + self::USE_SECURE_IN_FRONTEND, ScopeInterface::SCOPE_STORE, $storeId ); } /** - * @param $groupId - * @return array + * @return bool */ - public function getAttributesToRetrieve($groupId) + public function isCookieRestrictionModeEnabled(): bool { - if (false === $this->isCustomerGroupsEnabled()) { - return []; - } - $attributes = []; - foreach ($this->getProductAdditionalAttributes() as $attribute) { - if ($attribute['attribute'] !== 'price' && $attribute['retrievable'] === '1') { - $attributes[] = $attribute['attribute']; - } - } - foreach ($this->getCategoryAdditionalAttributes() as $attribute) { - if ($attribute['retrievable'] === '1') { - $attributes[] = $attribute['attribute']; - } - } - $attributes = array_merge($attributes, [ - AlgoliaConnector::ALGOLIA_API_OBJECT_ID, - 'name', - 'url', - 'visibility_search', - 'visibility_catalog', - 'categories', - 'categories_without_path', - 'thumbnail_url', - 'image_url', - 'images_data', - 'in_stock', - 'type_id', - 'value', - 'query', # suggestions - 'path', # categories - 'default_bundle_options', - ]); - $currencies = $this->dirCurrency->getConfigAllowCurrencies(); - foreach ($currencies as $currency) { - $attributes[] = 'price.' . $currency . '.default'; - $attributes[] = 'price.' . $currency . '.default_tier'; - $attributes[] = 'price.' . $currency . '.default_max'; - $attributes[] = 'price.' . $currency . '.default_formated'; - $attributes[] = 'price.' . $currency . '.default_original_formated'; - $attributes[] = 'price.' . $currency . '.default_tier_formated'; - $attributes[] = 'price.' . $currency . '.group_' . $groupId; - $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_tier'; - $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_max'; - $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_formated'; - $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_tier_formated'; - $attributes[] = 'price.' . $currency . '.group_' . $groupId . '_original_formated'; - $attributes[] = 'price.' . $currency . '.special_from_date'; - $attributes[] = 'price.' . $currency . '.special_to_date'; - } - $transport = new DataObject($attributes); - $this->eventManager->dispatch('algolia_get_retrievable_attributes', ['attributes' => $transport]); - $attributes = $transport->getData(); - $attributes = array_unique($attributes); - $attributes = array_values($attributes); - return ['attributesToRetrieve' => $attributes]; + return (bool) $this->cookieHelper->isCookieRestrictionModeEnabled(); } /** * @param $storeId - * @return array + * @return mixed */ - public function getProductAdditionalAttributes($storeId = null) + public function getCookieLifetime($storeId = null) { - $attributes = $this->unserialize($this->configInterface->getValue( - self::PRODUCT_ATTRIBUTES, - ScopeInterface::SCOPE_STORE, - $storeId - )); + return $this->configInterface->getValue(self::COOKIE_LIFETIME, ScopeInterface::SCOPE_STORE, $storeId); + } - $facets = $this->unserialize($this->configInterface->getValue( - self::FACETS, + /** + * @param $storeId + * @return mixed + */ + public function getCacheTime($storeId = null) + { + return $this->configInterface->getValue( + self::MAGENTO_DEFAULT_CACHE_TIME, ScopeInterface::SCOPE_STORE, $storeId - )); - $attributes = $this->addIndexableAttributes($attributes, $facets, '0'); + ); + } - $sorts = $this->unserialize($this->configInterface->getValue( - self::SORTING_INDICES, - ScopeInterface::SCOPE_STORE, - $storeId - )); - $attributes = $this->addIndexableAttributes($attributes, $sorts, '0'); + /*************************************** + * DEPRECATED CONSTANTS & METHODS * + **************************************/ - $customRankings = $this->unserialize($this->configInterface->getValue( - self::PRODUCT_CUSTOM_RANKING, - ScopeInterface::SCOPE_STORE, - $storeId - )); - $customRankings = $customRankings ?: []; - $customRankings = array_filter($customRankings, function ($customRanking) { - return $customRanking['attribute'] !== 'custom_attribute'; - }); - $attributes = $this->addIndexableAttributes($attributes, $customRankings, '0', '0'); - if (is_array($attributes)) { - return $attributes; - } - return []; + /*** CONSTANTS ***/ + + // --- Autocomplete --- // + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::IS_ENABLED + */ + public const IS_POPUP_ENABLED = AutocompleteHelper::IS_ENABLED; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::DOM_SELECTOR + */ + public const AUTOCOMPLETE_SELECTOR = AutocompleteHelper::DOM_SELECTOR; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::ADDITIONAL_SECTIONS + */ + public const AUTOCOMPLETE_SECTIONS = AutocompleteHelper::ADDITIONAL_SECTIONS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::NB_OF_PRODUCTS_SUGGESTIONS + */ + public const NB_OF_PRODUCTS_SUGGESTIONS = AutocompleteHelper::NB_OF_PRODUCTS_SUGGESTIONS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::NB_OF_CATEGORIES_SUGGESTIONS + */ + public const NB_OF_CATEGORIES_SUGGESTIONS = AutocompleteHelper::NB_OF_CATEGORIES_SUGGESTIONS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::NB_OF_QUERIES_SUGGESTIONS + */ + public const NB_OF_QUERIES_SUGGESTIONS = AutocompleteHelper::NB_OF_QUERIES_SUGGESTIONS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::MIN_QUERY_POPULARITY + */ + public const MIN_POPULARITY = AutocompleteHelper::MIN_QUERY_POPULARITY; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::MIN_QUERY_NUMBER_OF_RESULTS + */ + public const MIN_NUMBER_OF_RESULTS = AutocompleteHelper::MIN_QUERY_NUMBER_OF_RESULTS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::EXCLUDED_PAGES + */ + public const EXCLUDED_PAGES = AutocompleteHelper::EXCLUDED_PAGES; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::RENDER_TEMPLATE_DIRECTIVES + */ + public const RENDER_TEMPLATE_DIRECTIVES = AutocompleteHelper::RENDER_TEMPLATE_DIRECTIVES; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::IS_DEBUG_ENABLED + */ + public const AUTOCOMPLETE_MENU_DEBUG = AutocompleteHelper::IS_DEBUG_ENABLED; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::DEBOUNCE_MILLISEC + */ + public const AUTOCOMPLETE_DEBOUNCE_MILLISEC = AutocompleteHelper::DEBOUNCE_MILLISEC; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::MINIMUM_CHAR_LENGTH + */ + public const AUTOCOMPLETE_MINIMUM_CHAR_LENGTH = AutocompleteHelper::MINIMUM_CHAR_LENGTH; + + // --- InstantSearch --- // + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::IS_ENABLED + */ + public const IS_INSTANT_ENABLED = InstantSearchHelper::IS_ENABLED; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::DOM_SELECTOR + */ + public const INSTANT_SELECTOR = InstantSearchHelper::DOM_SELECTOR; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::NUMBER_OF_PRODUCT_RESULTS + */ + public const NUMBER_OF_PRODUCT_RESULTS = InstantSearchHelper::NUMBER_OF_PRODUCT_RESULTS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::REPLACE_CATEGORIES + */ + public const REPLACE_CATEGORIES = InstantSearchHelper::REPLACE_CATEGORIES; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::FACETS + */ + public const FACETS = InstantSearchHelper::FACETS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::MAX_VALUES_PER_FACET + */ + public const MAX_VALUES_PER_FACET = InstantSearchHelper::MAX_VALUES_PER_FACET; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::IS_DYNAMIC_FACETS_ENABLED + */ + public const ENABLE_DYNAMIC_FACETS = InstantSearchHelper::IS_DYNAMIC_FACETS_ENABLED; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::SORTING_INDICES + */ + public const SORTING_INDICES = InstantSearchHelper::SORTING_INDICES; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::SHOW_SUGGESTIONS_NO_RESULTS + */ + public const SHOW_SUGGESTIONS_NO_RESULTS = InstantSearchHelper::SHOW_SUGGESTIONS_NO_RESULTS; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::IS_SEARCHBOX_ENABLED + */ + public const SEARCHBOX_ENABLE = InstantSearchHelper::IS_SEARCHBOX_ENABLED; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::IS_ADD_TO_CART_ENABLED + */ + public const XML_ADD_TO_CART_ENABLE = InstantSearchHelper::IS_ADD_TO_CART_ENABLED; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::IS_INFINITE_SCROLL_ENABLED + */ + public const INFINITE_SCROLL_ENABLE = InstantSearchHelper::IS_INFINITE_SCROLL_ENABLED; + + /** + * @deprecated This constant has been moved to a domain specific config helper and will be removed in a future release + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::HIDE_PAGINATION + */ + public const HIDE_PAGINATION = InstantSearchHelper::HIDE_PAGINATION; + + /** + * @deprecated This constant is retained purely for data patches to migrate from older versions + */ + public const LEGACY_USE_VIRTUAL_REPLICA_ENABLED = 'algoliasearch_instant/instant/use_virtual_replica'; + + // --- Indexing Manager --- // + + /** + * @deprecated This constant has been renamed to be more meaningful and to avoid confusion with "backend rendering" statements + * @see \Algolia\AlgoliaSearch\Helper\ConfigHelper::ENABLE_INDEXING + */ + public const ENABLE_BACKEND = self::ENABLE_INDEXING; + + // --- Advanced --- // + /** + * @deprecated This configuration is no longer being used and will be removed in a future release + */ + public const MAKE_SEO_REQUEST = 'algoliasearch_advanced/advanced/make_seo_request'; + + /*** METHODS ***/ + + // --- Autocomplete --- // + + /** + * @param $storeId + * @return bool + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::isEnabled + */ + public function isAutoCompleteEnabled($storeId = null) + { + return $this->autocompleteConfig->isEnabled($storeId); + } + + /** + * @param $storeId + * @return bool + * @internal This is an internal function only and should not be used by customizations + */ + public function isDefaultSelector($storeId = null) + { + return '.algolia-search-input' === $this->getAutocompleteSelector($storeId); } /** - * @param $attributes - * @param $addedAttributes - * @param $searchable - * @param $retrievable - * @param $indexNoValue + * @param $storeId * @return mixed + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getDomSelector() */ - protected function addIndexableAttributes( - $attributes, - $addedAttributes, - $searchable = '1', - $retrievable = '1', - $indexNoValue = '1' - ) { - foreach ((array)$addedAttributes as $addedAttribute) { - foreach ((array)$attributes as $attribute) { - if ($addedAttribute['attribute'] === $attribute['attribute']) { - continue 2; - } - } - $attributes[] = [ - 'attribute' => $addedAttribute['attribute'], - 'searchable' => $searchable, - 'retrievable' => $retrievable, - 'index_no_value' => $indexNoValue, - ]; - } - return $attributes; + public function getAutocompleteSelector($storeId = null) + { + return $this->autocompleteConfig->getDomSelector($storeId); } /** * @param $storeId * @return array + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getAdditionalSections() */ - public function getCategoryAdditionalAttributes($storeId = null) + public function getAutocompleteSections($storeId = null) { - $attributes = $this->unserialize($this->configInterface->getValue( - self::CATEGORY_ATTRIBUTES, - ScopeInterface::SCOPE_STORE, - $storeId - )); - $customRankings = $this->unserialize($this->configInterface->getValue( - self::CATEGORY_CUSTOM_RANKING, - ScopeInterface::SCOPE_STORE, - $storeId - )); - $customRankings = $customRankings ?: []; - $customRankings = array_filter($customRankings, function ($customRanking) { - return $customRanking['attribute'] !== 'custom_attribute'; - }); - $attributes = $this->addIndexableAttributes($attributes, $customRankings, '0', '0'); - if (is_array($attributes)) { - return $attributes; - } - return []; + return $this->autocompleteConfig->getAdditionalSections($storeId); } /** * @param $storeId - * @return string + * @return int + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getNumberOfProductsSuggestions() */ - public function getCategorySeparator($storeId = null): string + public function getNumberOfProductsSuggestions($storeId = null) { - return (string) $this->configInterface->getValue(self::CATEGORY_SEPARATOR, ScopeInterface::SCOPE_STORE, $storeId); + return $this->autocompleteConfig->getNumberOfProductsSuggestions($storeId); } /** - * @param $groupId - * @return array + * @param $storeId + * @return int + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getNumberOfCategoriesSuggestions() */ - public function getAttributesToFilter($groupId) + public function getNumberOfCategoriesSuggestions($storeId = null) { - $transport = new DataObject(); - $this->eventManager->dispatch( - 'algolia_get_attributes_to_filter', - ['filter_object' => $transport, 'customer_group_id' => $groupId] - ); - $attributes = $transport->getData(); - $attributes = array_unique($attributes); - $attributes = array_values($attributes); - return count($attributes) ? ['filters' => implode(' AND ', $attributes)] : []; + return $this->autocompleteConfig->getNumberOfCategoriesSuggestions($storeId); } /** * @param $storeId - * @return bool + * @return int + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getNumberOfQueriesSuggestions() */ - public function isClickConversionAnalyticsEnabled($storeId = null) + public function getNumberOfQueriesSuggestions($storeId = null) { - return $this->configInterface->isSetFlag(self::CC_ANALYTICS_ENABLE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->autocompleteConfig->getNumberOfQueriesSuggestions($storeId); } /** * @param $storeId - * @return mixed + * @return int + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getMinQueryPopularity() */ - public function getClickConversionAnalyticsISSelector($storeId = null) + public function getMinPopularity($storeId = null) { - return $this->configInterface->getValue(self::CC_ANALYTICS_IS_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); + return $this->autocompleteConfig->getMinQueryPopularity($storeId); } /** * @param $storeId - * @return mixed + * @return int + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getMinQueryNumberOfResults() */ - public function getConversionAnalyticsMode($storeId = null) + public function getMinNumberOfResults($storeId = null) { - return $this->configInterface->getValue( - self::CC_CONVERSION_ANALYTICS_MODE, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->autocompleteConfig->getMinQueryNumberOfResults($storeId); } /** * @param $storeId - * @return mixed + * @return array + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getExcludedPages() */ - public function getConversionAnalyticsAddToCartSelector($storeId = null) + public function getExcludedPages($storeId = null) { - return $this->configInterface->getValue(self::CC_ADD_TO_CART_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); + return $this->autocompleteConfig->getExcludedPages($storeId); } /** * @param $storeId * @return mixed + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::shouldRenderTemplateDirectives() */ - public function getDefaultConsentCookieName($storeId = null) + public function getRenderTemplateDirectives($storeId = null) { - return $this->configInterface->getValue( - self::COOKIE_DEFAULT_CONSENT_COOKIE_NAME, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->autocompleteConfig->shouldRenderTemplateDirectives($storeId); } /** * @param $storeId - * @return mixed + * @return bool + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::isDebugEnabled() */ - public function getAllowCookieButtonSelector($storeId = null) + public function isAutocompleteDebugEnabled($storeId = null) { - return $this->configInterface->getValue( - self::ALLOW_COOKIE_BUTTON_SELECTOR, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->autocompleteConfig->isDebugEnabled($storeId); } /** * @param $storeId * @return mixed + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::isKeyboardNavigationEnabled() */ - public function getAlgoliaCookieDuration($storeId = null) + public function isAutocompleteNavigatorEnabled($storeId = null) { - return $this->configInterface->getValue( - self::ALGOLIA_COOKIE_DURATION, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->autocompleteConfig->isKeyboardNavigationEnabled($storeId); } /** - * @param $storeId - * @return array + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getDebounceMilliseconds() */ - public function getAnalyticsConfig($storeId = null) + public function getAutocompleteDebounceMilliseconds($storeId = null): int { - return [ - 'enabled' => $this->isAnalyticsEnabled(), - 'delay' => $this->configInterface->getValue(self::GA_DELAY, ScopeInterface::SCOPE_STORE, $storeId), - 'triggerOnUiInteraction' => $this->configInterface->getValue( - self::GA_TRIGGER_ON_UI_INTERACTION, - ScopeInterface::SCOPE_STORE, - $storeId - ), - 'pushInitialSearch' => $this->configInterface->getValue( - self::GA_PUSH_INITIAL_SEARCH, - ScopeInterface::SCOPE_STORE, - $storeId - ), - ]; + return $this->autocompleteConfig->getDebounceMilliseconds($storeId); + } + + /** + * @deprecated This method has been moved to the Autocomplete config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper::getMinimumCharacterLength() + */ + public function getAutocompleteMinimumCharacterLength(?int $storeId = null): int + { + return $this->autocompleteConfig->getMinimumCharacterLength($storeId); } + // --- InstantSearch --- // + /** * @param $storeId * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::isEnabled() + * / */ - public function isAnalyticsEnabled($storeId = null) + public function isInstantEnabled($storeId = null) { - return $this->configInterface->isSetFlag(self::GA_ENABLE, ScopeInterface::SCOPE_STORE, $storeId); + return $this->instantSearchConfig->isEnabled($storeId); } /** * @param $storeId - * @return array + * @return mixed + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::getDomSelector() */ - public function getNonCastableAttributes($storeId = null) + public function getInstantSelector($storeId = null) { - $nonCastableAttributes = []; - $config = $this->unserialize($this->configInterface->getValue( - self::NON_CASTABLE_ATTRIBUTES, - ScopeInterface::SCOPE_STORE, - $storeId - )); - if (is_array($config)) { - foreach ($config as $attributeData) { - if (isset($attributeData['attribute'])) { - $nonCastableAttributes[] = $attributeData['attribute']; - } - } - } - return $nonCastableAttributes; + return $this->instantSearchConfig->getDomSelector($storeId); } /** * @param $storeId * @return int + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::getNumberOfProductResults() */ - public function getMaxRecordSizeLimit($storeId = null) + public function getNumberOfProductResults($storeId = null) { - return (int)$this->configInterface->getValue( - self::MAX_RECORD_SIZE_LIMIT, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->instantSearchConfig->getNumberOfProductResults($storeId); } /** * @param $storeId - * @return string + * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::shouldReplaceCategories() */ - public function getAnalyticsRegion($storeId = null) + public function replaceCategories($storeId = null) { - return $this->configInterface->getValue( - self::ANALYTICS_REGION, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->instantSearchConfig->shouldReplaceCategories($storeId); } /** * @param $storeId - * @return bool + * @return array|bool|float|int|mixed|string + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::getFacets() */ - public function isQuerySuggestionsIndexEnabled($storeId = null) + public function getFacets($storeId = null) { - return $this->configInterface->isSetFlag(self::ENABLE_QUERY_SUGGESTIONS_INDEX, ScopeInterface::SCOPE_STORE, $storeId); + return $this->instantSearchConfig->getFacets($storeId); } /** * @param $storeId + * @return int + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::getMaxValuesPerFacet() + */ + public function getMaxValuesPerFacet($storeId = null) + { + return $this->instantSearchConfig->getMaxValuesPerFacet($storeId); + } + + /** + * @param int|null $storeId * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::isDynamicFacetsEnabled() */ - public function isPagesIndexEnabled($storeId = null) + public function isDynamicFacetsEnabled(?int $storeId = null): bool { - return $this->configInterface->isSetFlag(self::ENABLE_PAGES_INDEX, ScopeInterface::SCOPE_STORE, $storeId); + return $this->instantSearchConfig->isDynamicFacetsEnabled($storeId); + } + + /*** + * @param int|null $storeId + * @return array>> + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::getSorting() + */ + public function getSorting(?int $storeId = null): array + { + return $this->instantSearchConfig->getSorting($storeId); + } + + /** + * @param int|null $storeId + * @return string + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::getRawSortingValue() + */ + public function getRawSortingValue(?int $storeId = null): string + { + return $this->instantSearchConfig->getRawSortingValue($storeId); + } + + /** + * @param array $sorting + * @param string|null $scope + * @param int|null $scopeId + * @return void + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::setSorting() + */ + public function setSorting(array $sorting, string $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, ?int $scopeId = null): void + { + $this->instantSearchConfig->setSorting($sorting, $scope, $scopeId); } /** * @param $storeId - * @return int + * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::isSearchBoxEnabled() */ - public function getArchiveLogClearLimit($storeId = null) + public function isInstantSearchBoxEnabled($storeId = null) { - return (int)$this->configInterface->getValue( - self::ARCHIVE_LOG_CLEAR_LIMIT, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->instantSearchConfig->isSearchBoxEnabled($storeId); } /** * @param $storeId - * @return mixed + * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::shouldShowSuggestionsOnNoResultsPage() */ - public function getCacheTime($storeId = null) + public function showSuggestionsOnNoResultsPage($storeId = null) { - return $this->configInterface->getValue( - self::MAGENTO_DEFAULT_CACHE_TIME, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->instantSearchConfig->shouldShowSuggestionsOnNoResultsPage($storeId); } /** - * @param int|null $storeId + * @param $storeId * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::isAddToCartEnabled() */ - public function useVirtualReplica(?int $storeId = null): bool + public function isAddToCartEnable($storeId = null) { - return (bool) count(array_filter( - $this->getSorting($storeId), - function ($sort) { - return $sort[ReplicaManagerInterface::SORT_KEY_VIRTUAL_REPLICA]; - } - )); + return $this->instantSearchConfig->isAddToCartEnabled($storeId); } /** * @param $storeId - * @return mixed + * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::isInfiniteScrollEnabled() */ - public function isAutocompleteNavigatorEnabled($storeId = null) + public function isInfiniteScrollEnabled($storeId = null) { - return $this->configInterface->isSetFlag(self::AUTOCOMPLETE_KEYBORAD_NAVIAGATION, - ScopeInterface::SCOPE_STORE, - $storeId - ); + return $this->instantSearchConfig->isInfiniteScrollEnabled($storeId); } /** + * @param $storeId * @return bool + * @deprecated This method has been moved to the InstantSearch config helper and will be removed in a future version + * @see \Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper::shouldHidePagination() */ - public function isCookieRestrictionModeEnabled() + public function hidePaginationInInstantSearchPage($storeId = null) { - return (bool)$this->cookieHelper->isCookieRestrictionModeEnabled(); + return $this->instantSearchConfig->shouldHidePagination($storeId); } + // --- Indexing Manager --- // + /** * @param $storeId - * @return mixed + * @return bool + * @deprecated This method has been renamed to be more meaningful and to avoid confusion with "backend rendering" statements + * @see \Algolia\AlgoliaSearch\Helper\ConfigHelper::isIndexingEnabled() */ - public function getCookieLifetime($storeId = null) + public function isEnabledBackend($storeId = null) { - return $this->configInterface->getValue(self::COOKIE_LIFETIME, ScopeInterface::SCOPE_STORE, $storeId); + return $this->isIndexingEnabled($storeId); + } + + // --- Advanced --- // + /** + * @deprecated This configuration is no longer being used and will be removed in a future release + */ + public function makeSeoRequest($storeId = null) + { + return $this->configInterface->isSetFlag(self::MAKE_SEO_REQUEST, ScopeInterface::SCOPE_STORE, $storeId); } } diff --git a/Helper/Configuration/AutocompleteHelper.php b/Helper/Configuration/AutocompleteHelper.php new file mode 100644 index 000000000..0b014440b --- /dev/null +++ b/Helper/Configuration/AutocompleteHelper.php @@ -0,0 +1,190 @@ +configInterface->isSetFlag(self::IS_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getDomSelector(?int $storeId = null): string + { + return $this->configInterface->getValue(self::DOM_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getAdditionalSections(?int $storeId = null): array + { + $attrs = $this->serializer->unserialize( + $this->configInterface->getValue( + self::ADDITIONAL_SECTIONS, + ScopeInterface::SCOPE_STORE, + $storeId + ) + ); + + if (is_array($attrs)) { + return array_values($attrs); + } + + return []; + } + + public function getNumberOfProductsSuggestions(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::NB_OF_PRODUCTS_SUGGESTIONS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function getNumberOfCategoriesSuggestions(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::NB_OF_CATEGORIES_SUGGESTIONS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function getNumberOfQueriesSuggestions(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::NB_OF_QUERIES_SUGGESTIONS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + /** Throttles query suggestions that are indexed from Magento to Algolia */ + public function getMinQueryPopularity(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::MIN_QUERY_POPULARITY, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + /** Throttles query suggestions that are indexed from Magento to Algolia */ + public function getMinQueryNumberOfResults(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::MIN_QUERY_NUMBER_OF_RESULTS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + /** + * Retrieve CMS pages to be excluded from the Autocomplete search + * Also impacts what pages are indexed + */ + public function getExcludedPages(?int $storeId = null): array + { + $attrs = $this->serializer->unserialize( + $this->configInterface->getValue( + self::EXCLUDED_PAGES, + ScopeInterface::SCOPE_STORE, + $storeId + ) + ); + + if (is_array($attrs)) { + return $attrs; + } + + return []; + } + + /** + * This setting impacts what content is indexed for CMS page search + */ + public function shouldRenderTemplateDirectives(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag( + self::RENDER_TEMPLATE_DIRECTIVES, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function isDebugEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag(self::IS_DEBUG_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function isKeyboardNavigationEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag(self::IS_KEYBOARD_NAV_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getDebounceMilliseconds($storeId = null): int + { + return (int) $this->configInterface->getValue(self::DEBOUNCE_MILLISEC, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getMinimumCharacterLength(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::MINIMUM_CHAR_LENGTH, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function isRedirectEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag(self::IS_REDIRECT_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getRedirectMode(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::REDIRECT_MODE, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function isRedirectInNewWindowEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag( + self::OPEN_REDIRECT_IN_NEW_WINDOW, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } +} diff --git a/Helper/Configuration/InstantSearchHelper.php b/Helper/Configuration/InstantSearchHelper.php new file mode 100644 index 000000000..3191dd50b --- /dev/null +++ b/Helper/Configuration/InstantSearchHelper.php @@ -0,0 +1,184 @@ +configInterface->isSetFlag(self::IS_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getDomSelector(?int $storeId = null): string + { + return (string) $this->configInterface->getValue(self::DOM_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getNumberOfProductResults(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::NUMBER_OF_PRODUCT_RESULTS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function shouldReplaceCategories(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag(self::REPLACE_CATEGORIES, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getFacets(?int $storeId = null): array + { + $attrs = $this->serializer->unserialize($this->configInterface->getValue( + self::FACETS, + ScopeInterface::SCOPE_STORE, + $storeId + )); + if ($attrs) { + foreach ($attrs as &$attr) { + if ($attr['type'] === 'other') { + $attr['type'] = $attr['other_type']; + } + } + if (is_array($attrs)) { + return array_values($attrs); + } + } + return []; + } + public function getMaxValuesPerFacet(?int $storeId = null): int + { + return (int) $this->configInterface->getValue( + self::MAX_VALUES_PER_FACET, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function isDynamicFacetsEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag( + self::IS_DYNAMIC_FACETS_ENABLED, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + /*** + * @return array>> + */ + public function getSorting(?int $storeId = null): array + { + return $this->serializer->unserialize($this->getRawSortingValue($storeId)); + } + + public function getRawSortingValue(?int $storeId = null): string + { + return (string) $this->configInterface->getValue( + self::SORTING_INDICES, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function setSorting( + array $sorting, + string $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, + ?int $scopeId = null + ): void + { + $this->configWriter->save( + self::SORTING_INDICES, + $this->serializer->serialize($sorting), + $scope, + $scopeId + ); + } + + public function shouldShowSuggestionsOnNoResultsPage(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag( + self::SHOW_SUGGESTIONS_NO_RESULTS, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function isSearchBoxEnabled(?int $storeId = null): bool + { + return $this->isEnabled($storeId) + && $this->configInterface->isSetFlag(self::IS_SEARCHBOX_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function isAddToCartEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag( + self::IS_ADD_TO_CART_ENABLED, + ScopeInterface::SCOPE_STORE, + $storeId + ); + } + + public function isInfiniteScrollEnabled(?int $storeId = null): bool + { + return $this->isEnabled($storeId) + && $this->configInterface->isSetFlag( + self::IS_INFINITE_SCROLL_ENABLED, + ScopeInterface::SCOPE_STORE, + $storeId); + } + + public function shouldHidePagination(?int $storeId = null): bool + { + return $this->isEnabled($storeId) + && $this->configInterface->isSetFlag(self::HIDE_PAGINATION, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function isInstantRedirectEnabled(?int $storeId = null): bool + { + return $this->configInterface->isSetFlag(self::IS_REDIRECT_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); + } + + public function getInstantRedirectOptions(?int $storeId = null): array + { + $value = $this->configInterface->getValue(self::REDIRECT_OPTIONS, ScopeInterface::SCOPE_STORE, $storeId); + return empty($value) ? [] : explode(',', (string) $value); + } +} diff --git a/Helper/Configuration/NoticeHelper.php b/Helper/Configuration/NoticeHelper.php index 9df27fcd6..d3541b638 100644 --- a/Helper/Configuration/NoticeHelper.php +++ b/Helper/Configuration/NoticeHelper.php @@ -236,7 +236,7 @@ protected function getPersonalizationNotice() switch ($personalizationStatus) { // Activated case 2: $warningContent = 'Personalization is based on actions a user has performed in the past. We help you collect some of the data automatically.
- After you\'ve collected a reasonable amount of data, Personlization can be applied.'; + After you\'ve collected a reasonable amount of data, Personalization can be applied.'; $icon = 'icon-warning'; break; @@ -262,7 +262,7 @@ protected function getPersonalizationNotice() ]; // Adding footer - $footerContent = '

Personlization preferences

+ $footerContent = '

Personalization preferences

Manage your Personalization further on the Algolia Dashboard

'; $this->notices[] = [ @@ -307,7 +307,7 @@ public function isMsiExternalModuleNeeded() } // Module installation is only needed if there's more than one source - $sourceCollection = $this->objectManager->create('\Magento\Inventory\Model\ResourceModel\Source\Collection'); + $sourceCollection = $this->objectManager->create(\Magento\Inventory\Model\ResourceModel\Source\Collection::class); if ($sourceCollection->getSize() <= 1) { return false; } diff --git a/Helper/Configuration/PersonalizationHelper.php b/Helper/Configuration/PersonalizationHelper.php index 2f6e68f1b..e6cdd05be 100644 --- a/Helper/Configuration/PersonalizationHelper.php +++ b/Helper/Configuration/PersonalizationHelper.php @@ -51,7 +51,7 @@ public function __construct( * * @return bool */ - public function isPersoEnabled(int $storeId = null): bool + public function isPersoEnabled(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::IS_PERSO_ENABLED, ScopeInterface::SCOPE_STORE, $storeId); } @@ -61,7 +61,7 @@ public function isPersoEnabled(int $storeId = null): bool * * @return void */ - public function disablePerso(int $storeId = null): void + public function disablePerso(?int $storeId = null): void { $this->configResourceInterface->saveConfig(self::IS_PERSO_ENABLED, 0, 'default', 0); } @@ -71,7 +71,7 @@ public function disablePerso(int $storeId = null): void * * @return bool */ - public function isViewProductTracked(int $storeId = null): bool + public function isViewProductTracked(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::VIEW_PRODUCT, ScopeInterface::SCOPE_STORE, $storeId); } @@ -81,7 +81,7 @@ public function isViewProductTracked(int $storeId = null): bool * * @return bool */ - public function isProductClickedTracked(int $storeId = null): bool + public function isProductClickedTracked(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::PRODUCT_CLICKED, ScopeInterface::SCOPE_STORE, $storeId); } @@ -91,7 +91,7 @@ public function isProductClickedTracked(int $storeId = null): bool * * @return string */ - public function getProductClickedSelector(int $storeId = null): string + public function getProductClickedSelector(?int $storeId = null): string { return $this->configInterface->getValue(self::PRODUCT_CLICKED_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); } @@ -101,7 +101,7 @@ public function getProductClickedSelector(int $storeId = null): string * * @return bool */ - public function isFilterClickedTracked(int $storeId = null): bool + public function isFilterClickedTracked(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::FILTER_CLICKED, ScopeInterface::SCOPE_STORE, $storeId); } @@ -111,7 +111,7 @@ public function isFilterClickedTracked(int $storeId = null): bool * * @return bool */ - public function isWishlistAddTracked(int $storeId = null): bool + public function isWishlistAddTracked(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::WISHLIST_ADD, ScopeInterface::SCOPE_STORE, $storeId); } @@ -121,7 +121,7 @@ public function isWishlistAddTracked(int $storeId = null): bool * * @return string */ - public function getWishlistAddSelector(int $storeId = null): string + public function getWishlistAddSelector(?int $storeId = null): string { return $this->configInterface->getValue(self::WISHLIST_ADD_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); } @@ -131,7 +131,7 @@ public function getWishlistAddSelector(int $storeId = null): string * * @return bool */ - public function isProductRecommendedTracked(int $storeId = null): bool + public function isProductRecommendedTracked(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::PRODUCT_RECOMMENDED, ScopeInterface::SCOPE_STORE, $storeId); } @@ -141,7 +141,7 @@ public function isProductRecommendedTracked(int $storeId = null): bool * * @return string */ - public function getProductRecommendedSelector(int $storeId = null): string + public function getProductRecommendedSelector(?int $storeId = null): string { return $this->configInterface->getValue(self::PRODUCT_RECOMMENDED_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); } @@ -151,7 +151,7 @@ public function getProductRecommendedSelector(int $storeId = null): string * * @return bool */ - public function isCartAddTracked(int $storeId = null): bool + public function isCartAddTracked(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::CART_ADD, ScopeInterface::SCOPE_STORE, $storeId); } @@ -161,7 +161,7 @@ public function isCartAddTracked(int $storeId = null): bool * * @return string */ - public function getCartAddSelector(int $storeId = null): string + public function getCartAddSelector(?int $storeId = null): string { return $this->configInterface->getValue(self::CART_ADD_SELECTOR, ScopeInterface::SCOPE_STORE, $storeId); } @@ -171,7 +171,7 @@ public function getCartAddSelector(int $storeId = null): string * * @return bool */ - public function isOrderPlacedTracked(int $storeId = null): bool + public function isOrderPlacedTracked(?int $storeId = null): bool { return $this->configInterface->isSetFlag(self::ORDER_PLACED, ScopeInterface::SCOPE_STORE, $storeId); } diff --git a/Helper/Data.php b/Helper/Data.php index 2b713e31d..bf1d9fa16 100755 --- a/Helper/Data.php +++ b/Helper/Data.php @@ -59,7 +59,7 @@ public function rebuildStoreAdditionalSectionsIndex(int $storeId): void * @deprecated * Use Algolia\AlgoliaSearch\Service\Page\IndexBuilder::buildIndexFull() instead */ - public function rebuildStorePageIndex($storeId, array $pageIds = null): void + public function rebuildStorePageIndex($storeId, ?array $pageIds = null): void { $this->pageIndexBuilder->buildIndexFull($storeId, ['entityIds' => $pageIds]); } @@ -189,7 +189,7 @@ public function getSearchResult(string $query, int $storeId, ?array $searchParam */ public function isIndexingEnabled($storeId = null): bool { - if ($this->configHelper->isEnabledBackend($storeId) === false) { + if ($this->configHelper->isIndexingEnabled($storeId) === false) { $this->logger->log('INDEXING IS DISABLED FOR ' . $this->logger->getStoreName($storeId)); return false; } @@ -203,7 +203,7 @@ public function isIndexingEnabled($storeId = null): bool * @return string * @throws NoSuchEntityException */ - public function getIndexName(string $indexSuffix, int $storeId = null, bool $tmp = false): string + public function getIndexName(string $indexSuffix, ?int $storeId = null, bool $tmp = false): string { return $this->indexNameFetcher->getIndexName($indexSuffix, $storeId, $tmp); } @@ -213,7 +213,7 @@ public function getIndexName(string $indexSuffix, int $storeId = null, bool $tmp * @return string * @throws NoSuchEntityException */ - public function getBaseIndexName(int $storeId = null): string + public function getBaseIndexName(?int $storeId = null): string { return $this->indexNameFetcher->getBaseIndexName($storeId); } @@ -237,7 +237,7 @@ public function getIndexDataByStoreIds(): array * @return array * @throws NoSuchEntityException */ - protected function buildIndexData(StoreInterface $store = null): array + protected function buildIndexData(?StoreInterface $store = null): array { $storeId = !is_null($store) ? $store->getStoreId() : null; $currencyCode = !is_null($store) ? diff --git a/Helper/Entity/CategoryHelper.php b/Helper/Entity/CategoryHelper.php index 57406cab0..e64179f2f 100755 --- a/Helper/Entity/CategoryHelper.php +++ b/Helper/Entity/CategoryHelper.php @@ -8,7 +8,6 @@ use Algolia\AlgoliaSearch\Service\Category\RecordBuilder as CategoryRecordBuilder; use Algolia\AlgoliaSearch\Service\IndexNameFetcher; use Magento\Catalog\Model\Category; -use Magento\Catalog\Model\Category as MagentoCategory; use Magento\Catalog\Model\CategoryRepository; use Magento\Catalog\Model\ResourceModel\Category\Collection as CategoryCollection; use Magento\Catalog\Model\ResourceModel\Category\CollectionFactory as CategoryCollectionFactory; @@ -197,18 +196,6 @@ public function getAllAttributes() return $this->categoryAttributes; } - /** - * @param MagentoCategory $category - * @return array|mixed|null - * @throws LocalizedException - * - * @deprecated (will be removed in v3.16.0) - */ - public function getObject(Category $category) - { - return $this->categoryRecordBuilder->buildRecord($category); - } - /** * @return int|mixed * @throws LocalizedException @@ -259,23 +246,9 @@ public function isCategoryActive($category, $storeId = null) * * @return string|null * - * @deprecated (will be removed in v3.16.0) */ public function getCategoryName($categoryId, $storeId = null) { return $this->categoryRecordBuilder->getCategoryName($categoryId, $storeId); } - - /** - * @param $filterNotIncludedCategories - * @param $storeId - * @return array - * @throws LocalizedException - * - * @deprecated (will be removed in v3.16.0) - */ - public function getCoreCategories($filterNotIncludedCategories = true, $storeId = null) - { - return $this->categoryRecordBuilder->getCoreCategories($filterNotIncludedCategories, $storeId); - } } diff --git a/Helper/Entity/PageHelper.php b/Helper/Entity/PageHelper.php index 5d7b9def0..fd39508fd 100755 --- a/Helper/Entity/PageHelper.php +++ b/Helper/Entity/PageHelper.php @@ -48,7 +48,7 @@ public function getIndexSettings(?int $storeId = null): array return $indexSettings; } - public function getPages($storeId, array $pageIds = null) + public function getPages($storeId, ?array $pageIds = null) { $magentoPages = $this->pageCollectionFactory->create() ->addStoreFilter($storeId) @@ -105,7 +105,7 @@ public function getStores($storeId = null) if ($storeId === null) { /** @var \Magento\Store\Model\Store $store */ foreach ($this->storeManager->getStores() as $store) { - if ($this->configHelper->isEnabledBackEnd($store->getId()) === false) { + if ($this->configHelper->isIndexingEnabled($store->getId()) === false) { continue; } diff --git a/Helper/Entity/Product/PriceManager/ProductWithChildren.php b/Helper/Entity/Product/PriceManager/ProductWithChildren.php index 2c1f52ac1..0cffb9690 100755 --- a/Helper/Entity/Product/PriceManager/ProductWithChildren.php +++ b/Helper/Entity/Product/PriceManager/ProductWithChildren.php @@ -20,7 +20,7 @@ abstract class ProductWithChildren extends ProductWithoutChildren */ protected function addAdditionalData($product, $withTax, $subProducts, $currencyCode, $field) { - list($min, $max, $minOriginal, $maxOriginal) = + [$min, $max, $minOriginal, $maxOriginal] = $this->getMinMaxPrices($product, $withTax, $subProducts, $currencyCode); $dashedFormat = $this->getDashedPriceFormat($min, $max, $currencyCode); if ($min !== $max) { diff --git a/Helper/Entity/Product/PriceManager/ProductWithoutChildren.php b/Helper/Entity/Product/PriceManager/ProductWithoutChildren.php index 5868da92c..4c5883b1c 100755 --- a/Helper/Entity/Product/PriceManager/ProductWithoutChildren.php +++ b/Helper/Entity/Product/PriceManager/ProductWithoutChildren.php @@ -126,7 +126,7 @@ public function addPriceData($customData, Product $product, $subProducts): array if (!$this->areCustomersGroupsEnabled) { $this->groups->addFieldToFilter('main_table.customer_group_id', 0); } else { - $excludedGroups = array(); + $excludedGroups = []; foreach ($this->groups as $group) { $groupId = (int)$group->getData('customer_group_id'); $excludedWebsites = $this->groupExcludedWebsiteRepository->getCustomerGroupExcludedWebsites($groupId); @@ -158,9 +158,9 @@ public function addPriceData($customData, Product $product, $subProducts): array $this->addCustomerGroupsPrices($product, $currencyCode, $withTax, $field); } $this->customData[$field][$currencyCode]['special_from_date'] = - (!empty($product->getSpecialFromDate())) ? strtotime($product->getSpecialFromDate()) : ''; + (!empty($product->getSpecialFromDate())) ? strtotime((string) $product->getSpecialFromDate()) : ''; $this->customData[$field][$currencyCode]['special_to_date'] = - (!empty($product->getSpecialToDate())) ? strtotime($product->getSpecialToDate()) : ''; + (!empty($product->getSpecialToDate())) ? strtotime((string) $product->getSpecialToDate()) : ''; $this->addSpecialPrices($specialPrice, $field, $currencyCode); $this->addTierPrices($tierPrice, $field, $currencyCode); $this->addAdditionalData($product, $withTax, $subProducts, $currencyCode, $field); @@ -258,9 +258,7 @@ protected function getSpecialPrice(Product $product, $currencyCode, $withTax, $s $specialPrices[$groupId][] = $this->getRulePrice($groupId, $product, $subProducts); // The price with applied catalog rules $specialPrices[$groupId][] = $product->getFinalPrice(); // The product's special price - $specialPrices[$groupId] = array_filter($specialPrices[$groupId], function ($price) { - return $price > 0; - }); + $specialPrices[$groupId] = array_filter($specialPrices[$groupId], fn($price) => $price > 0); $specialPrice[$groupId] = false; if ($specialPrices[$groupId] && $specialPrices[$groupId] !== []) { $specialPrice[$groupId] = min($specialPrices[$groupId]); diff --git a/Helper/Entity/ProductHelper.php b/Helper/Entity/ProductHelper.php index b2197a627..2a6dd34fe 100755 --- a/Helper/Entity/ProductHelper.php +++ b/Helper/Entity/ProductHelper.php @@ -2,15 +2,17 @@ namespace Algolia\AlgoliaSearch\Helper\Entity; +use Algolia\AlgoliaSearch\Api\Data\IndexOptionsInterface; use Algolia\AlgoliaSearch\Api\Product\ReplicaManagerInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Algolia\AlgoliaSearch\Service\AlgoliaConnector; use Algolia\AlgoliaSearch\Service\IndexNameFetcher; +use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder; +use Algolia\AlgoliaSearch\Service\Product\FacetBuilder; use Algolia\AlgoliaSearch\Service\Product\RecordBuilder as ProductRecordBuilder; +use Algolia\AlgoliaSearch\Service\IndexSettingsHandler; use Magento\Catalog\Api\Data\ProductInterfaceFactory; use Magento\Catalog\Model\Product; use Magento\Catalog\Model\Product\Attribute\Source\Status; @@ -20,9 +22,6 @@ use Magento\Catalog\Model\ResourceModel\Product\Collection as ProductCollection; use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory; use Magento\CatalogInventory\Helper\Stock; -use Magento\Customer\Api\GroupExcludedWebsiteRepositoryInterface; -use Magento\Customer\Model\ResourceModel\Group\Collection as GroupCollection; -use Magento\Directory\Model\Currency as CurrencyHelper; use Magento\Eav\Model\Config; use Magento\Framework\DataObject; use Magento\Framework\Event\ManagerInterface; @@ -73,23 +72,23 @@ class ProductHelper extends AbstractEntityHelper ]; public function __construct( - protected Config $eavConfig, - protected ConfigHelper $configHelper, - protected AlgoliaHelper $algoliaHelper, - protected DiagnosticsLogger $logger, - protected StoreManagerInterface $storeManager, - protected ManagerInterface $eventManager, - protected Visibility $visibility, - protected Stock $stockHelper, - protected CurrencyHelper $currencyManager, - protected Type $productType, - protected CollectionFactory $productCollectionFactory, - protected GroupCollection $groupCollection, - protected GroupExcludedWebsiteRepositoryInterface $groupExcludedWebsiteRepository, - protected IndexNameFetcher $indexNameFetcher, - protected ReplicaManagerInterface $replicaManager, - protected ProductInterfaceFactory $productFactory, - protected ProductRecordBuilder $productRecordBuilder, + protected Config $eavConfig, + protected ConfigHelper $configHelper, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, + protected DiagnosticsLogger $logger, + protected StoreManagerInterface $storeManager, + protected ManagerInterface $eventManager, + protected Visibility $visibility, + protected Stock $stockHelper, + protected Type $productType, + protected CollectionFactory $productCollectionFactory, + protected IndexNameFetcher $indexNameFetcher, + protected ReplicaManagerInterface $replicaManager, + protected ProductInterfaceFactory $productFactory, + protected ProductRecordBuilder $productRecordBuilder, + protected FacetBuilder $facetBuilder, + protected IndexSettingsHandler $indexSettingsHandler, ) { parent::__construct($indexNameFetcher); @@ -145,25 +144,11 @@ public function getAllAttributes(bool $addEmptyRow = false): array $attributes[''] = ''; } - uksort($attributes, function ($a, $b) { - return strcmp($a, $b); - }); + uksort($attributes, fn($a, $b) => strcmp((string) $a, (string) $b)); return $attributes; } - /** - * @param $additionalAttributes - * @param $attributeName - * @return bool - * - * @deprecated (will be removed in v3.16.0) - */ - public function isAttributeEnabled($additionalAttributes, $attributeName): bool - { - return $this->productRecordBuilder->isAttributeEnabled($additionalAttributes, $attributeName); - } - /** * @param int $storeId * @param string[]|null $productIds @@ -282,20 +267,19 @@ protected function getAdditionalAttributes(?int $storeId = null): array */ public function getIndexSettings(?int $storeId = null): array { - $searchableAttributes = $this->getSearchableAttributes($storeId); - $customRanking = $this->getCustomRanking($storeId); - $unretrievableAttributes = $this->getUnretrieveableAttributes($storeId); - $attributesForFaceting = $this->getAttributesForFaceting($storeId); - $indexSettings = [ - 'searchableAttributes' => $searchableAttributes, - 'customRanking' => $customRanking, - 'unretrievableAttributes' => $unretrievableAttributes, - 'attributesForFaceting' => $attributesForFaceting, + 'searchableAttributes' => $this->getSearchableAttributes($storeId), + 'customRanking' => $this->getCustomRanking($storeId), + 'unretrievableAttributes' => $this->getUnretrieveableAttributes($storeId), + 'attributesForFaceting' => $this->facetBuilder->getAttributesForFaceting($storeId), 'maxValuesPerFacet' => $this->configHelper->getMaxValuesPerFacet($storeId), 'removeWordsIfNoResults' => $this->configHelper->getRemoveWordsIfNoResult($storeId), ]; + if ($this->configHelper->isDynamicFacetsEnabled($storeId)) { + $indexSettings['renderingContent'] = $this->facetBuilder->getRenderingContent($storeId); + } + // Additional index settings from event observer $transport = new DataObject($indexSettings); // Only for backward compatibility @@ -317,8 +301,8 @@ public function getIndexSettings(?int $storeId = null): array } /** - * @param string $indexName - * @param string $indexNameTmp + * @param IndexOptionsInterface $indexOptions + * @param IndexOptionsInterface $indexTmpOptions * @param int $storeId * @param bool $saveToTmpIndicesToo * @return void @@ -326,57 +310,53 @@ public function getIndexSettings(?int $storeId = null): array * @throws LocalizedException * @throws NoSuchEntityException */ - public function setSettings(string $indexName, string $indexNameTmp, int $storeId, bool $saveToTmpIndicesToo = false): void - { + public function setSettings( + IndexOptionsInterface $indexOptions, + IndexOptionsInterface $indexTmpOptions, + int $storeId, + bool $saveToTmpIndicesToo = false + ): void { $indexSettings = $this->getIndexSettings($storeId); - $this->algoliaHelper->setSettings( - $indexName, - $indexSettings, - false, - true, - '', - $storeId - ); + $this->indexSettingsHandler->setSettings($indexOptions, $indexSettings); + $this->logger->log('Settings: ' . json_encode($indexSettings)); if ($saveToTmpIndicesToo) { - $this->algoliaHelper->setSettings( - $indexNameTmp, + $this->indexSettingsHandler->setSettings( + $indexTmpOptions, $indexSettings, - false, - true, - $indexName, - $storeId + $indexOptions->getIndexName() ); + $this->logger->log('Pushing the same settings to TMP index as well'); } - $this->setFacetsQueryRules($indexName, $storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->setFacetsQueryRules($indexOptions); + $this->algoliaConnector->waitLastTask($storeId); if ($saveToTmpIndicesToo) { - $this->setFacetsQueryRules($indexNameTmp, $storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->setFacetsQueryRules($indexTmpOptions); + $this->algoliaConnector->waitLastTask($storeId); } $this->replicaManager->syncReplicasToAlgolia($storeId, $indexSettings); if ($saveToTmpIndicesToo) { try { - $this->algoliaHelper->copySynonyms($indexName, $indexNameTmp, $storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->algoliaConnector->copySynonyms($indexOptions, $indexTmpOptions); + $this->algoliaConnector->waitLastTask($storeId); $this->logger->log(' - Copying synonyms from production index to "' . $indexNameTmp . '" to not erase them with the index move. + Copying synonyms from production index to "' . $indexTmpOptions->getIndexName() . '" to not erase them with the index move. '); } catch (AlgoliaException $e) { $this->logger->error('Error encountered while copying synonyms: ' . $e->getMessage()); } try { - $this->algoliaHelper->copyQueryRules($indexName, $indexNameTmp, $storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->algoliaConnector->copyQueryRules($indexOptions, $indexTmpOptions); + $this->algoliaConnector->waitLastTask($storeId); $this->logger->log(' - Copying query rules from production index to "' . $indexNameTmp . '" to not erase them with the index move. + Copying query rules from production index to "' . $indexTmpOptions->getIndexName() . '" to not erase them with the index move. '); } catch (AlgoliaException $e) { if ($e->getCode() !== 404) { @@ -386,18 +366,6 @@ public function setSettings(string $indexName, string $indexNameTmp, int $storeI } } - /** - * @param Product $product - * @return array|mixed|null - * @throws \Exception - * - * @deprecated (will be removed in v3.16.0) - */ - public function getObject(Product $product) - { - return $this->productRecordBuilder->buildRecord($product); - } - /** * Returns all parent product IDs, e.g. when simple product is part of configurable or bundle * @@ -443,7 +411,7 @@ protected function getCompositeTypes(): array * @param Product $product * @return mixed * - * @deprecated (will be removed in v3.16.0) + * @deprecated (will be removed in once MSI compatibility module will be added to this module) */ protected function addInStock($defaultData, $customData, Product $product) { @@ -512,77 +480,17 @@ protected function getUnretrieveableAttributes($storeId = null) } /** - * @param $storeId - * @return array - * @throws LocalizedException - * @throws NoSuchEntityException - */ - protected function getAttributesForFaceting($storeId) - { - $attributesForFaceting = []; - - $currencies = $this->currencyManager->getConfigAllowCurrencies(); - - $facets = $this->configHelper->getFacets($storeId); - $websiteId = (int)$this->storeManager->getStore($storeId)->getWebsiteId(); - foreach ($facets as $facet) { - if ($facet['attribute'] === 'price') { - foreach ($currencies as $currency_code) { - $facet['attribute'] = 'price.' . $currency_code . '.default'; - - if ($this->configHelper->isCustomerGroupsEnabled($storeId)) { - foreach ($this->groupCollection as $group) { - $groupId = (int)$group->getData('customer_group_id'); - $excludedWebsites = $this->groupExcludedWebsiteRepository->getCustomerGroupExcludedWebsites($groupId); - if (in_array($websiteId, $excludedWebsites)) { - continue; - } - $attributesForFaceting[] = 'price.' . $currency_code . '.group_' . $groupId; - } - } - - $attributesForFaceting[] = $facet['attribute']; - } - } else { - $attribute = $facet['attribute']; - if (array_key_exists('searchable', $facet)) { - if ($facet['searchable'] === '1') { - $attribute = 'searchable(' . $attribute . ')'; - } elseif ($facet['searchable'] === '3') { - $attribute = 'filterOnly(' . $attribute . ')'; - } - } - - $attributesForFaceting[] = $attribute; - } - } - - if ($this->configHelper->replaceCategories($storeId) && !in_array('categories', $attributesForFaceting, true)) { - $attributesForFaceting[] = 'categories'; - } - - // Used for merchandising - $attributesForFaceting[] = 'categoryIds'; - - if ($this->configHelper->isVisualMerchEnabled($storeId)) { - $attributesForFaceting[] = 'searchable(' . $this->configHelper->getCategoryPageIdAttributeName($storeId) . ')'; - } - - return $attributesForFaceting; - } - - /** - * @param string $indexName - * @param int|null $storeId + * @param IndexOptionsInterface $indexOptions * @return void * @throws AlgoliaException + * @throws NoSuchEntityException */ - protected function setFacetsQueryRules(string $indexName, int $storeId = null) + protected function setFacetsQueryRules(IndexOptionsInterface $indexOptions) { - $this->clearFacetsQueryRules($indexName, $storeId); + $this->clearFacetsQueryRules($indexOptions); $rules = []; - $facets = $this->configHelper->getFacets($storeId); + $facets = $this->configHelper->getFacets($indexOptions->getStoreId()); foreach ($facets as $facet) { if (!array_key_exists('create_rule', $facet) || $facet['create_rule'] !== '1') { continue; @@ -612,31 +520,31 @@ protected function setFacetsQueryRules(string $indexName, int $storeId = null) } if ($rules) { - $this->logger->log('Setting facets query rules to "' . $indexName . '" index: ' . json_encode($rules)); - $this->algoliaHelper->saveRules($indexName, $rules, true, $storeId); + $this->logger->log('Setting facets query rules to "' . $indexOptions->getIndexName() . '" index: ' . json_encode($rules)); + + $this->algoliaConnector->saveRules($indexOptions, $rules, true); } } /** - * @param $indexName - * @param int|null $storeId + * @param IndexOptionsInterface $indexOptions * @return void * @throws AlgoliaException + * @throws NoSuchEntityException */ - protected function clearFacetsQueryRules($indexName, int $storeId = null): void + protected function clearFacetsQueryRules(IndexOptionsInterface $indexOptions): void { try { $hitsPerPage = 100; $page = 0; do { - $fetchedQueryRules = $this->algoliaHelper->searchRules( - $indexName, + $fetchedQueryRules = $this->algoliaConnector->searchRules( + $indexOptions, [ 'context' => 'magento_filters', 'page' => $page, 'hitsPerPage' => $hitsPerPage, - ], - $storeId + ] ); if (!$fetchedQueryRules || !array_key_exists('hits', $fetchedQueryRules)) { @@ -644,11 +552,10 @@ protected function clearFacetsQueryRules($indexName, int $storeId = null): void } foreach ($fetchedQueryRules['hits'] as $hit) { - $this->algoliaHelper->deleteRule( - $indexName, + $this->algoliaConnector->deleteRule( + $indexOptions, $hit[AlgoliaConnector::ALGOLIA_API_OBJECT_ID], - true, - $storeId + true ); } @@ -661,22 +568,6 @@ protected function clearFacetsQueryRules($indexName, int $storeId = null): void } } - /** - * Check if product can be index on Algolia - * - * @param Product $product - * @param int $storeId - * @param bool $isChildProduct - * - * @return bool - * - * @deprecated (will be removed in v3.16.0) - */ - public function canProductBeReindexed($product, $storeId, $isChildProduct = false) - { - return $this->productRecordBuilder->canProductBeReindexed($product, $storeId, $isChildProduct); - } - /** * Returns is product in stock * @@ -720,54 +611,4 @@ function($sort) { $sortingIndices ); } - - /** - * Moving to ReplicaManager class - * @param string $indexName - * @param int $storeId - * @param array|bool $sortingAttribute - * @return void - * @throws AlgoliaException - * @throws ExceededRetriesException - * @throws LocalizedException - * @throws NoSuchEntityException - * @throws \Exception - * @deprecated This function will be removed in a future release - * @see Algolia::AlgoliaSearch::Api::Product::ReplicaManagerInterface - */ - public function handlingReplica(string $indexName, int $storeId, array|bool $sortingAttribute = false): void - { - $sortingIndices = $this->configHelper->getSortingIndices($indexName, $storeId, null, $sortingAttribute); - if ($this->configHelper->isInstantEnabled($storeId)) { - $newReplicas = $this->decorateReplicasSetting($sortingIndices); - - try { - $currentSettings = $this->algoliaHelper->getSettings($indexName, $storeId); - if (array_key_exists('replicas', $currentSettings)) { - $oldReplicas = $currentSettings['replicas']; - $replicasToDelete = array_diff($oldReplicas, $newReplicas); - $this->algoliaHelper->setSettings( - $indexName, - ['replicas' => $newReplicas], - false, - false, - '', - $storeId - ); - $setReplicasTaskId = $this->algoliaHelper->getLastTaskId($storeId); - $this->algoliaHelper->waitLastTask($storeId, $indexName, $setReplicasTaskId); - if (count($replicasToDelete) > 0) { - foreach ($replicasToDelete as $deletedReplica) { - $this->algoliaHelper->deleteIndex($deletedReplica, $storeId); - } - } - } - } catch (AlgoliaException $e) { - if ($e->getCode() !== 404) { - $this->logger->log($e->getMessage()); - throw $e; - } - } - } - } } diff --git a/Helper/Entity/SuggestionHelper.php b/Helper/Entity/SuggestionHelper.php index 6f4f3ebfd..cfc03a1f7 100755 --- a/Helper/Entity/SuggestionHelper.php +++ b/Helper/Entity/SuggestionHelper.php @@ -3,13 +3,11 @@ namespace Algolia\AlgoliaSearch\Helper\Entity; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Service\Suggestion\RecordBuilder as SuggestionRecordBuilder; use Algolia\AlgoliaSearch\Service\IndexNameFetcher; use Magento\Framework\App\Cache\Type\Config as ConfigCache; use Magento\Framework\DataObject; use Magento\Framework\Event\ManagerInterface; use Magento\Framework\Serialize\SerializerInterface; -use Magento\Search\Model\Query; use Magento\Search\Model\ResourceModel\Query\Collection as QueryCollection; use Magento\Search\Model\ResourceModel\Query\CollectionFactory as QueryCollectionFactory; @@ -29,7 +27,6 @@ public function __construct( protected ConfigCache $cache, protected ConfigHelper $configHelper, protected SerializerInterface $serializer, - protected SuggestionRecordBuilder $suggestionRecordBuilder, protected IndexNameFetcher $indexNameFetcher, ) { parent::__construct($indexNameFetcher); @@ -56,17 +53,6 @@ public function getIndexSettings(?int $storeId = null): array return $transport->getData(); } - /** - * @param Query $suggestion - * @return array - * - * @deprecated (will be removed in v3.16.0) - */ - public function getObject(Query $suggestion) - { - return $this->suggestionRecordBuilder->buildRecord($suggestion); - } - /** * @param $storeId * @return array|bool|float|int|string|null diff --git a/Helper/InsightsHelper.php b/Helper/InsightsHelper.php index 24d4bfeee..c79088f66 100644 --- a/Helper/InsightsHelper.php +++ b/Helper/InsightsHelper.php @@ -162,7 +162,7 @@ public function setAuthenticatedUserToken(Customer $customer): string|null * @param int|null $storeId * @return bool */ - public function isInsightsEnabled(int $storeId = null): bool + public function isInsightsEnabled(?int $storeId = null): bool { return $this->configHelper->isClickConversionAnalyticsEnabled($storeId) || $this->personalizationHelper->isPersoEnabled($storeId); @@ -174,7 +174,7 @@ public function isInsightsEnabled(int $storeId = null): bool * * @return bool */ - public function isOrderPlacedTracked(int $storeId = null): bool + public function isOrderPlacedTracked(?int $storeId = null): bool { return $this->personalizationHelper->isPersoEnabled($storeId) && $this->personalizationHelper->isOrderPlacedTracked($storeId) @@ -188,7 +188,7 @@ public function isOrderPlacedTracked(int $storeId = null): bool * @param int|null $storeId * @return bool */ - public function isConversionTrackedPlaceOrder(int $storeId = null): bool + public function isConversionTrackedPlaceOrder(?int $storeId = null): bool { return $this->configHelper->isClickConversionAnalyticsEnabled($storeId) && in_array($this->configHelper->getConversionAnalyticsMode($storeId), @@ -206,7 +206,7 @@ public function isConversionTrackedPlaceOrder(int $storeId = null): bool * * @return bool */ - public function isAddedToCartTracked(int $storeId = null): bool + public function isAddedToCartTracked(?int $storeId = null): bool { return $this->personalizationHelper->isPersoEnabled($storeId) && $this->personalizationHelper->isCartAddTracked($storeId) @@ -220,7 +220,7 @@ public function isAddedToCartTracked(int $storeId = null): bool * @param int|null $storeId * @return bool */ - public function isConversionTrackedAddToCart(int $storeId = null): bool + public function isConversionTrackedAddToCart(?int $storeId = null): bool { return $this->configHelper->isClickConversionAnalyticsEnabled($storeId) && in_array($this->configHelper->getConversionAnalyticsMode($storeId), diff --git a/Helper/MerchandisingHelper.php b/Helper/MerchandisingHelper.php index 02c96da63..e8bd00882 100755 --- a/Helper/MerchandisingHelper.php +++ b/Helper/MerchandisingHelper.php @@ -5,27 +5,16 @@ use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Service\AlgoliaConnector; +use Algolia\AlgoliaSearch\Service\Product\IndexOptionsBuilder; class MerchandisingHelper { - /** @var Data */ - private $coreHelper; - - /** @var ProductHelper */ - private $productHelper; - - /** @var AlgoliaHelper */ - private $algoliaHelper; - public function __construct( - Data $coreHelper, - ProductHelper $productHelper, - AlgoliaHelper $algoliaHelper - ) { - $this->coreHelper = $coreHelper; - $this->productHelper = $productHelper; - $this->algoliaHelper = $algoliaHelper; - } + protected Data $coreHelper, + protected ProductHelper $productHelper, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder + ) {} /** * @param int $storeId @@ -41,15 +30,13 @@ public function saveQueryRule(int $storeId, int $entityId, array $rawPositions, string $entityType, - string $query = null, - string $banner = null): void + ?string $query = null, + ?string $banner = null): void { if ($this->coreHelper->isIndexingEnabled($storeId) === false) { return; } - $productsIndexName = $this->productHelper->getIndexName($storeId); - $positions = $this->transformPositions($rawPositions); $condition = [ 'pattern' => '', @@ -86,7 +73,8 @@ 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->saveRule($rule, $productsIndexName, false, $storeId); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); + $this->algoliaConnector->saveRule($rule, $indexOptions); } /** @@ -102,12 +90,12 @@ public function deleteQueryRule(int $storeId, int $entityId, string $entityType) return; } - $productsIndexName = $this->productHelper->getIndexName($storeId); $ruleId = $this->getQueryRuleId($entityId, $entityType); // Not catching AlgoliaSearchException for disabled query rules on purpose // It displays correct error message and navigates user to pricing page - $this->algoliaHelper->deleteRule($productsIndexName, $ruleId, false, $storeId); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); + $this->algoliaConnector->deleteRule($indexOptions, $ruleId); } /** @@ -139,7 +127,7 @@ private function transformPositions(array $positions): array public function copyQueryRules(int $storeId, int $entityIdFrom, int $entityIdTo, string $entityType): void { $productsIndexName = $this->productHelper->getIndexName($storeId); - $client = $this->algoliaHelper->getClient($storeId); + $client = $this->algoliaConnector->getClient($storeId); $context = $this->getQueryRuleId($entityIdFrom, $entityType); $queryRulesToSet = []; diff --git a/Logger/AlgoliaLogger.php b/Logger/AlgoliaLogger.php new file mode 100644 index 000000000..f3df54d63 --- /dev/null +++ b/Logger/AlgoliaLogger.php @@ -0,0 +1,8 @@ +getValue(); + if (is_array($value)) { + $this->setValue(implode(',', $value)); + } + return parent::beforeSave(); + } +} diff --git a/Model/Backend/EnableCustomerGroups.php b/Model/Backend/EnableCustomerGroups.php index ca0d478cf..6e2add603 100644 --- a/Model/Backend/EnableCustomerGroups.php +++ b/Model/Backend/EnableCustomerGroups.php @@ -22,8 +22,8 @@ public function __construct( TypeListInterface $cacheTypeList, protected ReplicaState $replicaState, protected ConfigChecker $configChecker, - AbstractResource $resource = null, - AbstractDb $resourceCollection = null, + ?AbstractResource $resource = null, + ?AbstractDb $resourceCollection = null, array $data = [] ) { diff --git a/Model/Backend/ExtraSettings.php b/Model/Backend/ExtraSettings.php index e03d593b7..2b4145bd3 100755 --- a/Model/Backend/ExtraSettings.php +++ b/Model/Backend/ExtraSettings.php @@ -12,7 +12,7 @@ class ExtraSettings extends Value { public function beforeSave() { - $value = trim($this->getData('value')); + $value = trim((string) $this->getData('value')); if (!$value) { return parent::beforeSave(); diff --git a/Model/Backend/QueueCron.php b/Model/Backend/QueueCron.php new file mode 100644 index 000000000..50396fe40 --- /dev/null +++ b/Model/Backend/QueueCron.php @@ -0,0 +1,48 @@ + '0 0 1 1 *', + '@annually' => '0 0 1 1 *', + '@monthly' => '0 0 1 * *', + '@weekly' => '0 0 * * 0', + '@daily' => '0 0 * * *', + '@hourly' => '0 * * * *' + ]; + + public function beforeSave() + { + $value = trim((string) $this->getData('value')); + + if (isset($this->mappings[$value])) { + $value = $this->mappings[$value]; + $this->setValue($value); + } + + if (!preg_match(self::CRON_FORMAT_REGEX, $value)) { + // This use of preg_replace is safe — static regex without /e modifier. + // phpcs:ignore + $safeValue = preg_replace(self::CRON_DISALLOW_REGEX, '', (string) $value); + $msg = ($safeValue !== $value) + ? 'Cron expression is invalid.' + : sprintf( + 'Cron expression "%s" is not valid.', + htmlspecialchars($safeValue, ENT_QUOTES, 'UTF-8') + ); + // Content is already escaped at this point + // phpcs:ignore + throw new InvalidCronException($msg); + } + + return parent::beforeSave(); + } +} diff --git a/Model/Backend/Sorts.php b/Model/Backend/Sorts.php index 91b94f24b..3e476a800 100644 --- a/Model/Backend/Sorts.php +++ b/Model/Backend/Sorts.php @@ -24,10 +24,10 @@ public function __construct( TypeListInterface $cacheTypeList, protected ReplicaState $replicaState, protected ConfigChecker $configChecker, - AbstractResource $resource = null, - AbstractDb $resourceCollection = null, + ?AbstractResource $resource = null, + ?AbstractDb $resourceCollection = null, array $data = [], - Json $serializer = null + ?Json $serializer = null ) { $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class); diff --git a/Model/Config/AutomaticPriceIndexingComment.php b/Model/Config/AutomaticPriceIndexingComment.php index 89201fa71..92f72bc1d 100644 --- a/Model/Config/AutomaticPriceIndexingComment.php +++ b/Model/Config/AutomaticPriceIndexingComment.php @@ -15,7 +15,7 @@ public function getCommentText($elementValue) { $url = $this->urlInterface->getUrl('https://www.algolia.com/doc/integration/magento-2/how-it-works/indexing-queue/#configure-the-queue'); - $comment = array(); + $comment = []; $comment[] = 'Algolia relies on the core Magento Product Price index when serializing product data. If the price index is not up to date, Algolia will not be able to accurately determine what should be included in the search index.'; $comment[] = 'If you are experiencing problems with products not syncing to Algolia due to this issue, enabling this setting will allow Algolia to automatically update the price index as needed.'; $comment[] = 'NOTE: This can introduce a marginal amount of overhead to the indexing process so only enable if necessary. Be sure to optimize the indexing queue based on the impact of this operation.'; diff --git a/Model/Config/EnableQueueComment.php b/Model/Config/EnableQueueComment.php index e47ade770..a7863b89f 100644 --- a/Model/Config/EnableQueueComment.php +++ b/Model/Config/EnableQueueComment.php @@ -15,7 +15,7 @@ public function getCommentText($elementValue) { $url = $this->urlInterface->getUrl('algolia_algoliasearch/queue/index'); - return 'If enabled, all indexing operations (add, remove & update operations) will be done asynchronously using the CRON mechanism.

Go to Indexing Queue.

To schedule the run you need to add this in your crontab:
-*/5 * * * * php /absolute/path/to/magento/bin/magento indexer:reindex algolia_queue_runner

⚠ Enabling this option is recommended in production or if your store has a lot of products. '; + return 'If enabled, all indexing operations (add, remove & update operations) will be done asynchronously using the cron mechanism.

Go to Indexing Queue.
+⚠ Enabling this option is recommended in production or if your store has a lot of products. '; } } diff --git a/Model/ImageUploader.php b/Model/ImageUploader.php index 466864369..41ab49b31 100644 --- a/Model/ImageUploader.php +++ b/Model/ImageUploader.php @@ -172,7 +172,7 @@ public function moveFileFromTmp($imageName) $baseTmpImagePath, $baseImagePath ); - } catch (\Exception $e) { + } catch (\Exception) { throw new \Magento\Framework\Exception\LocalizedException( __('Something went wrong while saving the file(s).') ); diff --git a/Model/IndexMover.php b/Model/IndexMover.php index 5afc59828..42ba6add8 100644 --- a/Model/IndexMover.php +++ b/Model/IndexMover.php @@ -3,40 +3,25 @@ namespace Algolia\AlgoliaSearch\Model; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\Data; +use Algolia\AlgoliaSearch\Service\AlgoliaConnector; +use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder; +use Magento\Framework\Exception\NoSuchEntityException; class IndexMover { - /** @var Data */ - private $baseHelper; - - /** @var AlgoliaHelper */ - private $algoliaHelper; - - /** @var IndicesConfigurator */ - private $indicesConfigurator; - - /** - * @param Data $baseHelper - * @param AlgoliaHelper $algoliaHelper - * @param IndicesConfigurator $indicesConfigurator - */ public function __construct( - Data $baseHelper, - AlgoliaHelper $algoliaHelper, - IndicesConfigurator $indicesConfigurator - ) { - $this->baseHelper = $baseHelper; - $this->algoliaHelper = $algoliaHelper; - $this->indicesConfigurator = $indicesConfigurator; - } + protected Data $baseHelper, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, + protected IndicesConfigurator $indicesConfigurator + ){} /** * @param string $tmpIndexName * @param string $indexName * @param int $storeId - * @throws AlgoliaException + * @throws AlgoliaException|NoSuchEntityException */ public function moveIndex(string $tmpIndexName, string $indexName, int $storeId): void { @@ -44,7 +29,10 @@ public function moveIndex(string $tmpIndexName, string $indexName, int $storeId) return; } - $this->algoliaHelper->moveIndex($tmpIndexName, $indexName, $storeId); + $fromIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($tmpIndexName, $storeId); + $toIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName, $storeId); + + $this->algoliaConnector->moveIndex($fromIndexOptions, $toIndexOptions); } /** diff --git a/Model/Indexer/AdditionalSection.php b/Model/Indexer/AdditionalSection.php index abe6ac2cf..907dec74b 100755 --- a/Model/Indexer/AdditionalSection.php +++ b/Model/Indexer/AdditionalSection.php @@ -3,22 +3,20 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Helper\Data; -use Algolia\AlgoliaSearch\Model\Queue; -use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; -use Algolia\AlgoliaSearch\Service\AdditionalSection\IndexBuilder as AdditionalSectionIndexBuilder; +use Algolia\AlgoliaSearch\Service\AdditionalSection\BatchQueueProcessor as AdditionalSectionBatchQueueProcessor; use Magento\Store\Model\StoreManagerInterface; +/** + * This indexer is now disabled by default, prefer use the `bin/magento algolia:reindex:additional_sections` command instead + * If you want to re-enable it, you can do it in the Magento configuration ("Algolia Search > Indexing Manager" section) + */ class AdditionalSection implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { public function __construct( protected StoreManagerInterface $storeManager, - protected Data $dataHelper, - protected Queue $queue, protected ConfigHelper $configHelper, - protected AlgoliaCredentialsManager $algoliaCredentialsManager - ) - {} + protected AdditionalSectionBatchQueueProcessor $additionalSectionBatchQueueProcessor + ) {} public function execute($ids) { @@ -27,26 +25,12 @@ public function execute($ids) public function executeFull() { - $storeIds = array_keys($this->storeManager->getStores()); - - foreach ($storeIds as $storeId) { - if ($this->dataHelper->isIndexingEnabled($storeId) === false) { - continue; - } - - if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { - $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); - - return; - } - - /** @uses AdditionalSectionIndexBuilder::buildIndexFull() */ - $this->queue->addToQueue( - AdditionalSectionIndexBuilder::class, - 'buildIndexFull', - ['storeId' => $storeId], - 1 - ); + if (!$this->configHelper->isAdditionalSectionsIndexerEnabled()) { + return; + } + + foreach (array_keys($this->storeManager->getStores()) as $storeId) { + $this->additionalSectionBatchQueueProcessor->processBatch($storeId); } } diff --git a/Model/Indexer/Category.php b/Model/Indexer/Category.php index f08453599..2e15cc3cb 100755 --- a/Model/Indexer/Category.php +++ b/Model/Indexer/Category.php @@ -3,60 +3,34 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Helper\Data; -use Algolia\AlgoliaSearch\Helper\Entity\CategoryHelper; -use Algolia\AlgoliaSearch\Model\IndicesConfigurator; -use Algolia\AlgoliaSearch\Model\Queue; -use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; -use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder; -use Algolia\AlgoliaSearch\Service\Category\IndexBuilder as CategoryIndexBuilder; +use Algolia\AlgoliaSearch\Service\Category\BatchQueueProcessor as CategoryBatchQueueProcessor; use Magento\Store\Model\StoreManagerInterface; +/** + * This indexer is now disabled by default, prefer use the `bin/magento algolia:reindex:categories` command instead + * If you want to re-enable it, you can do it in the Magento configuration ("Algolia Search > Indexing Manager" section) + */ class Category implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - public static $affectedProductIds = []; - public function __construct( protected StoreManagerInterface $storeManager, - protected CategoryHelper $categoryHelper, - protected Data $dataHelper, - protected Queue $queue, protected ConfigHelper $configHelper, - protected AlgoliaCredentialsManager $algoliaCredentialsManager - ) - {} + protected CategoryBatchQueueProcessor $categoryBatchQueueProcessor + ) {} public function execute($categoryIds) { - $storeIds = array_keys($this->storeManager->getStores()); - - foreach ($storeIds as $storeId) { - if ($this->dataHelper->isIndexingEnabled($storeId) === false) { - continue; - } - - if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { - $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); - - return; - } - - $this->rebuildAffectedProducts($storeId); - - $categoriesPerPage = $this->configHelper->getNumberOfElementByPage(); - - if (is_array($categoryIds) && count($categoryIds) > 0) { - $this->processSpecificCategories($categoryIds, $categoriesPerPage, $storeId); - - continue; - } - - $this->processFullReindex($storeId, $categoriesPerPage); + foreach (array_keys($this->storeManager->getStores()) as $storeId) { + $this->categoryBatchQueueProcessor->processBatch($storeId, $categoryIds); } } public function executeFull() { + if (!$this->configHelper->isCategoriesIndexerEnabled()) { + return; + } + $this->execute(null); } @@ -69,87 +43,4 @@ public function executeRow($id) { $this->execute([$id]); } - - /** - * @param int $storeId - */ - private function rebuildAffectedProducts($storeId) - { - $affectedProducts = self::$affectedProductIds; - $affectedProductsCount = count($affectedProducts); - - if ($affectedProductsCount > 0 && $this->configHelper->indexProductOnCategoryProductsUpdate($storeId)) { - $productsPerPage = $this->configHelper->getNumberOfElementByPage(); - foreach (array_chunk($affectedProducts, $productsPerPage) as $chunk) { - /** @uses ProductIndexBuilder::buildIndexList() */ - $this->queue->addToQueue( - ProductIndexBuilder::class, - 'buildIndexList', - [ - 'storeId' => $storeId, - 'entityIds' => $chunk, - ], - count($chunk) - ); - } - } - } - - /** - * @param array $categoryIds - * @param int $categoriesPerPage - * @param int $storeId - */ - private function processSpecificCategories($categoryIds, $categoriesPerPage, $storeId) - { - foreach (array_chunk($categoryIds, $categoriesPerPage) as $chunk) { - /** @uses CategoryIndexBuilder::buildIndexList */ - $this->queue->addToQueue( - CategoryIndexBuilder::class, - 'buildIndexList', - [ - 'storeId' => $storeId, - 'entityIds' => $chunk, - ], - count($chunk) - ); - } - } - - /** - * @param int $storeId - * @param int $categoriesPerPage - * - * @throws Magento\Framework\Exception\LocalizedException - * @throws Magento\Framework\Exception\NoSuchEntityException - */ - private function processFullReindex($storeId, $categoriesPerPage) - { - /** @uses IndicesConfigurator::saveConfigurationToAlgolia() */ - $this->queue->addToQueue(IndicesConfigurator::class, 'saveConfigurationToAlgolia', ['storeId' => $storeId]); - - $collection = $this->categoryHelper->getCategoryCollectionQuery($storeId); - $size = $collection->getSize(); - - $pages = ceil($size / $categoriesPerPage); - - for ($i = 1; $i <= $pages; $i++) { - $data = [ - 'storeId' => $storeId, - 'options' => [ - 'page' => $i, - 'pageSize' => $categoriesPerPage, - ] - ]; - - /** @uses CategoryIndexBuilder::buildIndexFull() */ - $this->queue->addToQueue( - CategoryIndexBuilder::class, - 'buildIndexFull', - $data, - $categoriesPerPage, - true - ); - } - } } diff --git a/Model/Indexer/CategoryObserver.php b/Model/Indexer/CategoryObserver.php index c58ddee93..d82bc1448 100755 --- a/Model/Indexer/CategoryObserver.php +++ b/Model/Indexer/CategoryObserver.php @@ -2,13 +2,17 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; +use Algolia\AlgoliaSearch\Exception\DiagnosticsException; use Algolia\AlgoliaSearch\Model\Indexer\Category as CategoryIndexer; use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; +use Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor as ProductBatchQueueProcessor; use Magento\Catalog\Model\Category as CategoryModel; use Magento\Catalog\Model\ResourceModel\Category as CategoryResourceModel; use Magento\Catalog\Model\ResourceModel\Product\Collection as ProductCollection; use Magento\Framework\App\ResourceConnection; +use Magento\Framework\Exception\NoSuchEntityException; use Magento\Framework\Indexer\IndexerRegistry; +use Magento\Store\Model\StoreManagerInterface; class CategoryObserver { @@ -17,7 +21,9 @@ class CategoryObserver public function __construct( IndexerRegistry $indexerRegistry, + protected StoreManagerInterface $storeManager, protected ResourceConnection $resource, + protected ProductBatchQueueProcessor $productBatchQueueProcessor, protected AlgoliaCredentialsManager $algoliaCredentialsManager ) { $this->indexer = $indexerRegistry->get('algolia_categories'); @@ -52,8 +58,8 @@ public function afterSave( $changedProductIds = ($category->getChangedProductIds() !== null ? (array) $category->getChangedProductIds() : []); if (!$this->indexer->isScheduled()) { - CategoryIndexer::$affectedProductIds = array_unique(array_merge($changedProductIds, $collectionIds)); $this->indexer->reindexRow($category->getId()); + $this->reindexAffectedProducts(array_unique(array_merge($changedProductIds, $collectionIds))); } else { // missing logic, if scheduled, when category is saved w/out product, products need to be added to _cl if (count($changedProductIds) === 0 && count($collectionIds) > 0) { @@ -82,15 +88,29 @@ public function afterDelete( if (!$this->indexer->isScheduled()) { /* we are using products position because getProductCollection() doesn't use correct store */ $productCollection = $category->getProductsPosition(); - CategoryIndexer::$affectedProductIds = array_keys($productCollection); - $this->indexer->reindexRow($category->getId()); + $this->reindexAffectedProducts(array_keys($productCollection)); } }); return $result; } + /** + * @param array $affectedProductIds + * @return void + * @throws DiagnosticsException + * @throws NoSuchEntityException + */ + protected function reindexAffectedProducts(array $affectedProductIds): void + { + if (count($affectedProductIds) > 0) { + foreach (array_keys($this->storeManager->getStores()) as $storeId) { + $this->productBatchQueueProcessor->processBatch($storeId, $affectedProductIds); + } + } + } + /** * @param array $productIds */ diff --git a/Model/Indexer/DeleteProduct.php b/Model/Indexer/DeleteProduct.php index 55a9b8c9f..58fc11080 100755 --- a/Model/Indexer/DeleteProduct.php +++ b/Model/Indexer/DeleteProduct.php @@ -2,24 +2,21 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; -use Algolia\AlgoliaSearch\Helper\Data; -use Algolia\AlgoliaSearch\Model\Queue; -use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; -use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder; +use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor as ProductBatchQueueProcessor; use Magento\Store\Model\StoreManagerInterface; +/** + * This indexer is now disabled by default, prefer use the `bin/magento algolia:reindex:delete_products` command instead + * If you want to re-enable it, you can do it in the Magento configuration ("Algolia Search > Indexing Manager" section) + */ class DeleteProduct implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { public function __construct( protected StoreManagerInterface $storeManager, - protected Data $dataHelper, - protected AlgoliaHelper $algoliaHelper, - protected Queue $queue, - protected AlgoliaCredentialsManager $algoliaCredentialsManager, - protected ProductIndexBuilder $productIndexBuilder - ) - {} + protected ConfigHelper $configHelper, + protected ProductBatchQueueProcessor $productBatchQueueProcessor + ) {} public function execute($ids) { @@ -28,20 +25,12 @@ public function execute($ids) public function executeFull() { - $storeIds = array_keys($this->storeManager->getStores()); - - foreach ($storeIds as $storeId) { - if ($this->dataHelper->isIndexingEnabled($storeId) === false) { - continue; - } - - if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { - $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); - - return; - } + if (!$this->configHelper->isDeleteProductsIndexerEnabled()) { + return; + } - $this->productIndexBuilder->deleteInactiveProducts($storeId); + foreach (array_keys($this->storeManager->getStores()) as $storeId) { + $this->productBatchQueueProcessor->deleteInactiveProducts($storeId); } } diff --git a/Model/Indexer/Page.php b/Model/Indexer/Page.php index c480ffdde..041367d3f 100755 --- a/Model/Indexer/Page.php +++ b/Model/Indexer/Page.php @@ -2,27 +2,21 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Helper\Data; use Algolia\AlgoliaSearch\Helper\Entity\PageHelper; -use Algolia\AlgoliaSearch\Model\Queue; -use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; -use Algolia\AlgoliaSearch\Service\Page\IndexBuilder as PageIndexBuilder; -use Magento\Store\Model\StoreManagerInterface; +use Algolia\AlgoliaSearch\Service\Page\BatchQueueProcessor as PageBatchQueueProcessor; +/** + * This indexer is now disabled by default, prefer use the `bin/magento algolia:reindex:pages` command instead + * If you want to re-enable it, you can do it in the Magento configuration ("Algolia Search > Indexing Manager" section) + */ class Page implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { public function __construct( - protected StoreManagerInterface $storeManager, protected PageHelper $pageHelper, - protected Data $dataHelper, - protected AlgoliaHelper $algoliaHelper, - protected Queue $queue, protected ConfigHelper $configHelper, - protected AlgoliaCredentialsManager $algoliaCredentialsManager - ) - {} + protected PageBatchQueueProcessor $pageBatchQueueProcessor + ) {} /** * @param $ids @@ -30,33 +24,8 @@ public function __construct( */ public function execute($ids) { - $storeIds = $this->pageHelper->getStores(); - - foreach ($storeIds as $storeId) { - if ($this->dataHelper->isIndexingEnabled($storeId) === false) { - 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) { - $data['options'] = ['entityIds' => $ids]; - } - - /** @uses PageIndexBuilder::buildIndexFull() */ - $this->queue->addToQueue( - PageIndexBuilder::class, - 'buildIndexFull', - $data, - is_array($ids) ? count($ids) : 1 - ); - } + foreach ($this->pageHelper->getStores() as $storeId) { + $this->pageBatchQueueProcessor->processBatch($storeId, $ids); } } @@ -65,6 +34,10 @@ public function execute($ids) */ public function executeFull() { + if (!$this->configHelper->isPagesIndexerEnabled()) { + return; + } + $this->execute(null); } @@ -85,20 +58,4 @@ public function executeRow($id) { $this->execute([$id]); } - - /** - * @param $storeId - * @return bool - */ - protected function isPagesInAdditionalSections($storeId) - { - $sections = $this->configHelper->getAutocompleteSections($storeId); - foreach ($sections as $section) { - if ($section['name'] === 'pages') { - return true; - } - } - - return false; - } } diff --git a/Model/Indexer/Product.php b/Model/Indexer/Product.php index 309e4805b..860c8947e 100755 --- a/Model/Indexer/Product.php +++ b/Model/Indexer/Product.php @@ -2,124 +2,39 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Helper\Data; -use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; -use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; -use Algolia\AlgoliaSearch\Model\IndexMover; -use Algolia\AlgoliaSearch\Model\IndicesConfigurator; -use Algolia\AlgoliaSearch\Model\Queue; -use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; -use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder; +use Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor as ProductBatchQueueProcessor; use Magento\Framework\Exception\NoSuchEntityException; use Magento\Store\Model\StoreManagerInterface; +/** + * This indexer is now disabled by default, prefer use the `bin/magento algolia:reindex:products` command instead + * If you want to re-enable it, you can do it in the Magento configuration ("Algolia Search > Indexing Manager" section) + */ class Product implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { - public function __construct( - protected StoreManagerInterface $storeManager, - protected ProductHelper $productHelper, - protected Data $dataHelper, - protected AlgoliaHelper $algoliaHelper, - protected ConfigHelper $configHelper, - protected Queue $queue, - protected AlgoliaCredentialsManager $algoliaCredentialsManager, - protected DiagnosticsLogger $diag - ) - {} + protected StoreManagerInterface $storeManager, + protected ConfigHelper $configHelper, + protected ProductBatchQueueProcessor $productBatchQueueProcessor + ) {} /** * @throws NoSuchEntityException */ public function execute($productIds) { - $storeIds = array_keys($this->storeManager->getStores()); - $areParentsLoaded = false; - - foreach ($storeIds as $storeId) { - if ($this->dataHelper->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) { - foreach (array_chunk($productIds, $productsPerPage) as $chunk) { - /** @uses ProductIndexBuilder::buildIndexList() */ - $this->queue->addToQueue( - ProductIndexBuilder::class, - 'buildIndexList', - ['storeId' => $storeId, 'entityIds' => $chunk], - count($chunk) - ); - } - - continue; - } - - $useTmpIndex = $this->configHelper->isQueueActive($storeId); - $onlyVisible = !$this->configHelper->includeNonVisibleProductsInIndex(); - $collection = $this->productHelper->getProductCollectionQuery($storeId, $productIds, $onlyVisible); - - $timerName = __METHOD__ . ' (Get product collection size)'; - $this->diag->startProfiling($timerName); - $size = $collection->getSize(); - $this->diag->stopProfiling($timerName); - - $pages = ceil($size / $productsPerPage); - - /** @uses IndicesConfigurator::saveConfigurationToAlgolia() */ - $this->queue->addToQueue(IndicesConfigurator::class, 'saveConfigurationToAlgolia', [ - 'storeId' => $storeId, - 'useTmpIndex' => $useTmpIndex, - ], 1, true); - for ($i = 1; $i <= $pages; $i++) { - $data = [ - 'storeId' => $storeId, - 'options' => [ - 'entityIds' => $productIds, - 'page' => $i, - 'pageSize' => $productsPerPage, - 'useTmpIndex' => $useTmpIndex, - ] - ]; - - /** @uses ProductIndexBuilder::buildIndexFull() */ - $this->queue->addToQueue( - ProductIndexBuilder::class, - 'buildIndexFull', - $data, - $productsPerPage, - true - ); - } - - if ($useTmpIndex) { - /** @uses IndexMover::moveIndexWithSetSettings() */ - $this->queue->addToQueue(IndexMover::class, 'moveIndexWithSetSettings', [ - 'tmpIndexName' => $this->productHelper->getTempIndexName($storeId), - 'indexName' => $this->productHelper->getIndexName($storeId), - 'storeId' => $storeId, - ], 1, true); - } + foreach (array_keys($this->storeManager->getStores()) as $storeId) { + $this->productBatchQueueProcessor->processBatch($storeId, $productIds); } } public function executeFull() { + if (!$this->configHelper->isProductsIndexerEnabled()) { + return; + } + $this->execute(null); } diff --git a/Model/Indexer/ProductObserver.php b/Model/Indexer/ProductObserver.php index 3a2180cb2..2bc36db04 100755 --- a/Model/Indexer/ProductObserver.php +++ b/Model/Indexer/ProductObserver.php @@ -13,17 +13,9 @@ class ProductObserver /** @var Product */ private $indexer; - /** @var ConfigHelper */ - private $configHelper; - - /** - * @param IndexerRegistry $indexerRegistry - * @param ConfigHelper $configHelper - */ - public function __construct(IndexerRegistry $indexerRegistry, ConfigHelper $configHelper) + public function __construct(IndexerRegistry $indexerRegistry) { $this->indexer = $indexerRegistry->get('algolia_products'); - $this->configHelper = $configHelper; } /** @@ -31,9 +23,9 @@ public function __construct(IndexerRegistry $indexerRegistry, ConfigHelper $conf * @param ProductResource $result * @param ProductModel $product * - * @return ProductModel[] + * @return ProductResource */ - public function afterSave(ProductResource $productResource, ProductResource $result, ProductModel $product) + public function afterSave(ProductResource $productResource, ProductResource $result, ProductModel $product): ProductResource { $productResource->addCommitCallback(function () use ($product) { if (!$this->indexer->isScheduled()) { @@ -49,9 +41,9 @@ public function afterSave(ProductResource $productResource, ProductResource $res * @param ProductResource $result * @param ProductModel $product * - * @return ProductModel[] + * @return ProductResource */ - public function afterDelete(ProductResource $productResource, ProductResource $result, ProductModel $product) + public function afterDelete(ProductResource $productResource, ProductResource $result, ProductModel $product): ProductResource { $productResource->addCommitCallback(function () use ($product) { if (!$this->indexer->isScheduled()) { @@ -64,12 +56,12 @@ public function afterDelete(ProductResource $productResource, ProductResource $r /** * @param Action $subject - * @param Action|null $result + * @param Action $result * @param array $productIds * * @return Action */ - public function afterUpdateAttributes(Action $subject, Action $result = null, $productIds) + public function afterUpdateAttributes(Action $subject, Action $result, array $productIds): Action { if (!$this->indexer->isScheduled()) { $this->indexer->reindexList(array_unique($productIds)); @@ -80,17 +72,15 @@ public function afterUpdateAttributes(Action $subject, Action $result = null, $p /** * @param Action $subject - * @param Action|null $result + * @param null $result * @param array $productIds * - * @return mixed + * @return void */ - public function afterUpdateWebsites(Action $subject, Action $result = null, array $productIds) + public function afterUpdateWebsites(Action $subject, null $result, array $productIds): void { if (!$this->indexer->isScheduled()) { $this->indexer->reindexList(array_unique($productIds)); } - - return $result; } } diff --git a/Model/Indexer/QueueRunner.php b/Model/Indexer/QueueRunner.php index 8b7b02ee0..cb0606f2e 100644 --- a/Model/Indexer/QueueRunner.php +++ b/Model/Indexer/QueueRunner.php @@ -6,6 +6,10 @@ use Algolia\AlgoliaSearch\Model\Queue; use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; +/** + * This indexer is now disabled by default, prefer use the `bin/magento algolia:reindex:process_queue` command instead + * If you want to re-enable it, you can do it in the Magento configuration ("Algolia Search > Indexing Manager" section) + */ class QueueRunner implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { public const INDEXER_ID = 'algolia_queue_runner'; @@ -14,8 +18,7 @@ public function __construct( protected ConfigHelper $configHelper, protected Queue $queue, protected AlgoliaCredentialsManager $algoliaCredentialsManager - ) - {} + ) {} public function execute($ids) { @@ -24,6 +27,10 @@ public function execute($ids) public function executeFull() { + if (!$this->configHelper->isQueueIndexerEnabled()) { + return; + } + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey()) { $this->algoliaCredentialsManager->displayErrorMessage(self::class); diff --git a/Model/Indexer/Suggestion.php b/Model/Indexer/Suggestion.php index c1fd23d03..808c25fac 100755 --- a/Model/Indexer/Suggestion.php +++ b/Model/Indexer/Suggestion.php @@ -2,27 +2,21 @@ namespace Algolia\AlgoliaSearch\Model\Indexer; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Helper\Data; -use Algolia\AlgoliaSearch\Helper\Entity\SuggestionHelper; -use Algolia\AlgoliaSearch\Model\Queue; -use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; -use Algolia\AlgoliaSearch\Service\Suggestion\IndexBuilder as SuggestionIndexBuilder; +use Algolia\AlgoliaSearch\Service\Suggestion\BatchQueueProcessor as SuggestionBatchQueueProcessor; use Magento\Store\Model\StoreManagerInterface; +/** + * This indexer is now disabled by default, prefer use the `bin/magento algolia:reindex:suggestions` command instead + * If you want to re-enable it, you can do it in the Magento configuration ("Algolia Search > Indexing Manager" section) + */ class Suggestion implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface { public function __construct( protected StoreManagerInterface $storeManager, - protected SuggestionHelper $suggestionHelper, - protected Data $dataHelper, - protected AlgoliaHelper $algoliaHelper, - protected Queue $queue, protected ConfigHelper $configHelper, - protected AlgoliaCredentialsManager $algoliaCredentialsManager - ) - {} + protected SuggestionBatchQueueProcessor $suggestionBatchQueueProcessor + ) {} public function execute($ids) { @@ -30,26 +24,12 @@ public function execute($ids) public function executeFull() { - $storeIds = array_keys($this->storeManager->getStores()); - - foreach ($storeIds as $storeId) { - if ($this->dataHelper->isIndexingEnabled($storeId) === false) { - continue; - } - - if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { - $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); - - return; - } - - /** @uses SuggestionIndexBuilder::buildIndexFull() */ - $this->queue->addToQueue( - SuggestionIndexBuilder::class, - 'buildIndexFull', - ['storeId' => $storeId], - 1 - ); + if (!$this->configHelper->isSuggestionsIndexerEnabled()) { + return; + } + + foreach (array_keys($this->storeManager->getStores()) as $storeId) { + $this->suggestionBatchQueueProcessor->processBatch($storeId); } } diff --git a/Model/IndicesConfigurator.php b/Model/IndicesConfigurator.php index 93350d267..7ceb777c1 100644 --- a/Model/IndicesConfigurator.php +++ b/Model/IndicesConfigurator.php @@ -3,7 +3,6 @@ namespace Algolia\AlgoliaSearch\Model; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Data; use Algolia\AlgoliaSearch\Helper\Entity\AdditionalSectionHelper; @@ -12,23 +11,35 @@ use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Helper\Entity\SuggestionHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; +use Algolia\AlgoliaSearch\Service\AlgoliaConnector; use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; -use Algolia\AlgoliaSearch\Service\IndexNameFetcher; +use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder; +use Algolia\AlgoliaSearch\Service\Category\IndexOptionsBuilder as CategoryIndexOptionsBuilder; +use Algolia\AlgoliaSearch\Service\Page\IndexOptionsBuilder as PageIndexOptionsBuilder; +use Algolia\AlgoliaSearch\Service\Product\IndexOptionsBuilder as ProductIndexOptionsBuilder; +use Algolia\AlgoliaSearch\Service\IndexSettingsHandler; +use Algolia\AlgoliaSearch\Service\Suggestion\IndexOptionsBuilder as SuggestionIndexOptionsBuilder; use Magento\Framework\Exception\NoSuchEntityException; class IndicesConfigurator { public function __construct( - 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 DiagnosticsLogger $logger + protected Data $baseHelper, + protected IndexOptionsBuilder $indexOptionsBuilder, + protected CategoryIndexOptionsBuilder $categoryIndexOptionsBuilder, + protected PageIndexOptionsBuilder $pageIndexOptionsBuilder, + protected ProductIndexOptionsBuilder $productIndexOptionsBuilder, + protected SuggestionIndexOptionsBuilder $suggestionIndexOptionsBuilder, + protected AlgoliaConnector $algoliaConnector, + protected ConfigHelper $configHelper, + protected ProductHelper $productHelper, + protected CategoryHelper $categoryHelper, + protected PageHelper $pageHelper, + protected SuggestionHelper $suggestionHelper, + protected AdditionalSectionHelper $additionalSectionHelper, + protected AlgoliaCredentialsManager $algoliaCredentialsManager, + protected IndexSettingsHandler $indexSettingsHandler, + protected DiagnosticsLogger $logger ) {} /** @@ -58,12 +69,12 @@ public function saveConfigurationToAlgolia(int $storeId, bool $useTmpIndex = fal } $this->setCategoriesSettings($storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->algoliaConnector->waitLastTask($storeId); /* Check if we want to index CMS pages */ if ($this->configHelper->isPagesIndexEnabled($storeId)) { $this->setPagesSettings($storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->algoliaConnector->waitLastTask($storeId); } else { $this->logger->log('CMS Page Indexing is not enabled for the store.'); } @@ -71,13 +82,13 @@ public function saveConfigurationToAlgolia(int $storeId, bool $useTmpIndex = fal //Check if we want to index Query Suggestions if ($this->configHelper->isQuerySuggestionsIndexEnabled($storeId)) { $this->setQuerySuggestionsSettings($storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->algoliaConnector->waitLastTask($storeId); } else { $this->logger->log('Query Suggestions Indexing is not enabled for the store.'); } $this->setAdditionalSectionsSettings($storeId); - $this->algoliaHelper->waitLastTask($storeId); + $this->algoliaConnector->waitLastTask($storeId); $this->setProductsSettings($storeId, $useTmpIndex); @@ -96,19 +107,12 @@ protected function setCategoriesSettings(int $storeId): void $logEventName = 'Pushing settings for categories indices.'; $this->logger->start($logEventName, true); - $indexName = $this->categoryHelper->getIndexName($storeId); $settings = $this->categoryHelper->getIndexSettings($storeId); + $indexOptions = $this->categoryIndexOptionsBuilder->buildEntityIndexOptions($storeId); - $this->algoliaHelper->setSettings( - $indexName, - $settings, - false, - true, - '', - $storeId - ); + $this->indexSettingsHandler->setSettings($indexOptions, $settings); - $this->logger->log('Index name: ' . $indexName); + $this->logger->log('Index name: ' . $indexOptions->getIndexName()); $this->logger->log('Settings: ' . json_encode($settings)); $this->logger->stop($logEventName, true); } @@ -124,18 +128,11 @@ protected function setPagesSettings(int $storeId): void $this->logger->start($logEventName, true); $settings = $this->pageHelper->getIndexSettings($storeId); - $indexName = $this->pageHelper->getIndexName($storeId); - - $this->algoliaHelper->setSettings( - $indexName, - $settings, - false, - true, - '', - $storeId - ); - - $this->logger->log('Index name: ' . $indexName); + $indexOptions = $this->pageIndexOptionsBuilder->buildEntityIndexOptions($storeId); + + $this->indexSettingsHandler->setSettings($indexOptions, $settings); + + $this->logger->log('Index name: ' . $indexOptions->getIndexName()); $this->logger->log('Settings: ' . json_encode($settings)); $this->logger->stop($logEventName, true); } @@ -150,19 +147,12 @@ protected function setQuerySuggestionsSettings(int $storeId): void $logEventName = 'Pushing settings for query suggestions indices.'; $this->logger->start($logEventName, true); - $indexName = $this->suggestionHelper->getIndexName($storeId); $settings = $this->suggestionHelper->getIndexSettings($storeId); + $indexOptions = $this->suggestionIndexOptionsBuilder->buildEntityIndexOptions($storeId); - $this->algoliaHelper->setSettings( - $indexName, - $settings, - false, - true, - '', - $storeId - ); + $this->indexSettingsHandler->setSettings($indexOptions, $settings); - $this->logger->log('Index name: ' . $indexName); + $this->logger->log('Index name: ' . $indexOptions->getIndexName()); $this->logger->log('Settings: ' . json_encode($settings)); $this->logger->stop($logEventName, true); } @@ -187,15 +177,9 @@ protected function setAdditionalSectionsSettings(int $storeId): void $indexName = $indexName . '_' . $section['name']; $settings = $this->additionalSectionHelper->getIndexSettings($storeId); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName, $storeId); - $this->algoliaHelper->setSettings( - $indexName, - $settings, - false, - false, - '', - $storeId - ); + $this->indexSettingsHandler->setSettings($indexOptions, $settings); $this->logger->log('Index name: ' . $indexName); $this->logger->log('Settings: ' . json_encode($settings)); @@ -218,13 +202,13 @@ protected function setProductsSettings(int $storeId, bool $useTmpIndex): void $logEventName = 'Pushing settings for products indices.'; $this->logger->start($logEventName, true); - $indexName = $this->productHelper->getIndexName($storeId); - $indexNameTmp = $this->productHelper->getTempIndexName($storeId); + $indexOptions = $this->productIndexOptionsBuilder->buildEntityIndexOptions($storeId); + $indexTmpOptions = $this->productIndexOptionsBuilder->buildEntityIndexOptions($storeId, true); - $this->logger->log('Index name: ' . $indexName); - $this->logger->log('TMP Index name: ' . $indexNameTmp); + $this->logger->log('Index name: ' . $indexOptions->getIndexName()); + $this->logger->log('TMP Index name: ' . $indexTmpOptions->getIndexName()); - $this->productHelper->setSettings($indexName, $indexNameTmp, $storeId, $useTmpIndex); + $this->productHelper->setSettings($indexOptions, $indexTmpOptions, $storeId, $useTmpIndex); $this->logger->stop($logEventName, true); } @@ -248,39 +232,49 @@ protected function setExtraSettings(int $storeId, bool $saveToTmpIndicesToo): vo 'suggestions' => $this->suggestionHelper->getIndexName($storeId), 'additional_sections' => $this->additionalSectionHelper->getIndexName($storeId) ]; + $sections = [ + 'products', + 'categories', + 'pages', + 'suggestions', + 'additional_sections' + ]; $error = []; - foreach ($sections as $section => $indexName) { + foreach ($sections as $section) { try { $extraSettings = $this->configHelper->getExtraSettings($section, $storeId); if ($extraSettings) { $extraSettings = json_decode($extraSettings, true); - $this->logger->log('Index name: ' . $indexName); + $indexOptions = $this->indexOptionsBuilder->buildWithComputedIndex('_' . $section, $storeId); + + $this->logger->log('Index name: ' . $indexOptions->getIndexName()); $this->logger->log('Extra settings: ' . json_encode($extraSettings)); - $this->algoliaHelper->setSettings( - $indexName, + + $this->algoliaConnector->setSettings( + $indexOptions, $extraSettings, true, - false, - '', - $storeId + false ); - $this->algoliaHelper->waitLastTask($storeId); + $this->algoliaConnector->waitLastTask($storeId); if ($section === 'products' && $saveToTmpIndicesToo) { - $tempIndexName = $indexName . IndexNameFetcher::INDEX_TEMP_SUFFIX; - $this->logger->log('Index name: ' . $tempIndexName); + $indexTempOptions = $this->indexOptionsBuilder->buildWithComputedIndex( + ProductHelper::INDEX_NAME_SUFFIX, + $storeId, + true + ); + + $this->logger->log('Index name: ' . $indexTempOptions->getIndexName()); $this->logger->log('Extra settings: ' . json_encode($extraSettings)); - $this->algoliaHelper->setSettings( - $tempIndexName, + $this->algoliaConnector->setSettings( + $indexTempOptions, $extraSettings, - true, - false, - '', - $storeId + true ); } } diff --git a/Model/Job.php b/Model/Job.php index 2a30b6f21..645bef395 100644 --- a/Model/Job.php +++ b/Model/Job.php @@ -41,8 +41,8 @@ public function __construct( \Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\ObjectManagerInterface $objectManager, - \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null, - \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null, + ?\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null, + ?\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null, array $data = [] ) { parent::__construct($context, $registry, $resource, $resourceCollection, $data); @@ -90,7 +90,7 @@ public function prepare() } if ($this->getDecodedData() === null) { - $decodedData = json_decode($this->getData('data'), true); + $decodedData = json_decode((string) $this->getData('data'), true); $this->setDecodedData($decodedData); diff --git a/Model/Observer/CatalogPermissions/CategoryCollectionAddPermissions.php b/Model/Observer/CatalogPermissions/CategoryCollectionAddPermissions.php index 9a0bfe6d7..424135122 100644 --- a/Model/Observer/CatalogPermissions/CategoryCollectionAddPermissions.php +++ b/Model/Observer/CatalogPermissions/CategoryCollectionAddPermissions.php @@ -52,13 +52,13 @@ protected function addCatalogPermissionsData($collection, $categoryIds) $catalogPermissionsHelper = $this->permissionsFactory->getCatalogPermissionsHelper(); foreach ($permissionsCollection as $categoryId => $permissions) { - $permissions = explode(',', $permissions); + $permissions = explode(',', (string) $permissions); foreach ($permissions as $permission) { $permission = explode('_', $permission); if (count($permission) < 2) { // prevent undefined continue; } - list($customerGroupId, $level) = $permission; + [$customerGroupId, $level] = $permission; if ($category = $collection->getItemById($categoryId)) { $category->setData( 'customer_group_permission_' . $customerGroupId, @@ -83,13 +83,13 @@ protected function addSharedCatalogData($collection, $categoryIds, $storeId) } foreach ($sharedCollection as $categoryId => $permissions) { - $permissions = explode(',', $permissions); + $permissions = explode(',', (string) $permissions); foreach ($permissions as $permission) { $permission = explode('_', $permission); if (count($permission) < 2) { // prevent undefined continue; } - list($customerGroupId, $level) = $permission; + [$customerGroupId, $level] = $permission; if ($category = $collection->getItemById($categoryId)) { $category->setData('shared_catalog_permission_' . $customerGroupId, $level == -1 ? 1 : 0); } diff --git a/Model/Observer/CatalogPermissions/ProductCollectionAddPermissions.php b/Model/Observer/CatalogPermissions/ProductCollectionAddPermissions.php index 5e0f41479..43c5c42eb 100644 --- a/Model/Observer/CatalogPermissions/ProductCollectionAddPermissions.php +++ b/Model/Observer/CatalogPermissions/ProductCollectionAddPermissions.php @@ -61,13 +61,13 @@ protected function addProductPermissionsData($additionalData, $productIds, $stor $permissionsCollection = array_intersect_key($productPermissionsCollection, $productIds); $catalogPermissionsHelper = $this->permissionsFactory->getCatalogPermissionsHelper(); foreach ($permissionsCollection as $productId => $permissions) { - $permissions = explode(',', $permissions); + $permissions = explode(',', (string) $permissions); foreach ($permissions as $permission) { $permission = explode('_', $permission); if (count($permission) < 3) { // prevent undefined continue; } - list($permissionStoreId, $customerGroupId, $level) = $permission; + [$permissionStoreId, $customerGroupId, $level] = $permission; if ($permissionStoreId == $storeId) { $additionalData->addProductData($productId, [ 'customer_group_permission_' . $customerGroupId => ($level == -2 ? 0 : 1), @@ -90,13 +90,13 @@ protected function addSharedCatalogData($additionalData, $productIds) $sharedCollection = array_intersect_key($sharedCatalogCollection, $productIds); foreach ($sharedCollection as $productId => $permissions) { - $permissions = explode(',', $permissions); + $permissions = explode(',', (string) $permissions); foreach ($permissions as $permission) { $permission = explode('_', $permission); if (count($permission) < 2) { // prevent undefined continue; } - list($customerGroupId, $level) = $permission; + [$customerGroupId, $level] = $permission; $additionalData->addProductData($productId, [ 'shared_catalog_permission_' . $customerGroupId => $level, ]); diff --git a/Model/Observer/SaveSettings.php b/Model/Observer/SaveSettings.php index 082019250..a604e46e9 100755 --- a/Model/Observer/SaveSettings.php +++ b/Model/Observer/SaveSettings.php @@ -3,7 +3,6 @@ namespace Algolia\AlgoliaSearch\Model\Observer; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\Data; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Model\IndicesConfigurator; @@ -13,47 +12,12 @@ class SaveSettings implements ObserverInterface { - /** @var StoreManagerInterface */ - protected $storeManager; - - /** @var IndicesConfigurator */ - protected $indicesConfigurator; - - /** - * @var AlgoliaHelper - */ - protected $algoliaHelper; - - /** - * @var Data - */ - protected $helper; - - /** - * @var ProductHelper - */ - protected $productHelper; - - /** - * @param StoreManagerInterface $storeManager - * @param IndicesConfigurator $indicesConfigurator - * @param AlgoliaHelper $algoliaHelper - * @param Data $helper - * @param ProductHelper $productHelper - */ public function __construct( - StoreManagerInterface $storeManager, - IndicesConfigurator $indicesConfigurator, - AlgoliaHelper $algoliaHelper, - Data $helper, - ProductHelper $productHelper - ) { - $this->storeManager = $storeManager; - $this->indicesConfigurator = $indicesConfigurator; - $this->algoliaHelper = $algoliaHelper; - $this->helper = $helper; - $this->productHelper = $productHelper; - } + protected StoreManagerInterface $storeManager, + protected IndicesConfigurator $indicesConfigurator, + protected Data $helper, + protected ProductHelper $productHelper + ){} /** * @param Observer $observer diff --git a/Model/Queue.php b/Model/Queue.php index d4d4d8368..ca8e54f82 100644 --- a/Model/Queue.php +++ b/Model/Queue.php @@ -117,7 +117,7 @@ public function __construct( public function addToQueue($className, $method, array $data, $dataSize = 1, $isFullReindex = false) { if (is_object($className)) { - $className = get_class($className); + $className = $className::class; } if ($this->configHelper->isQueueActive()) { @@ -252,7 +252,7 @@ protected function handleFailedJob(Job $job, Exception $e): void { Parameters: ' . json_encode($job->getDecodedData()); $this->logger->log($logMessage); - $logMessage = date('c') . ' ERROR: ' . get_class($e) . ': + $logMessage = date('c') . ' ERROR: ' . $e::class . ': ' . $e->getMessage() . ' in ' . $e->getFile() . ':' . $e->getLine() . "\nStack trace:\n" . $e->getTraceAsString(); $this->logger->log($logMessage); @@ -571,7 +571,7 @@ protected function sortJobs(array $jobs) * * @return array */ - protected function stackSortedJobs(array $sortedJobs, array $tempSortableJobs, Job $job = null) + protected function stackSortedJobs(array $sortedJobs, array $tempSortableJobs, ?Job $job = null) { if ($tempSortableJobs && $tempSortableJobs !== []) { $tempSortableJobs = $this->jobSort( diff --git a/Model/QueueArchive.php b/Model/QueueArchive.php index dcb077fe2..c7bb645f9 100644 --- a/Model/QueueArchive.php +++ b/Model/QueueArchive.php @@ -11,7 +11,7 @@ class QueueArchive extends AbstractModel implements QueueArchiveInterface */ protected function _construct() { - $this->_init('Algolia\AlgoliaSearch\Model\ResourceModel\QueueArchive'); + $this->_init(\Algolia\AlgoliaSearch\Model\ResourceModel\QueueArchive::class); } /** diff --git a/Model/ResourceModel/Job/Grid/Collection.php b/Model/ResourceModel/Job/Grid/Collection.php index 4ae141837..8e8e542d2 100644 --- a/Model/ResourceModel/Job/Grid/Collection.php +++ b/Model/ResourceModel/Job/Grid/Collection.php @@ -36,9 +36,9 @@ public function __construct( $eventPrefix, $eventObject, $resourceModel, - $model = 'Magento\Framework\View\Element\UiComponent\DataProvider\Document', + $model = \Magento\Framework\View\Element\UiComponent\DataProvider\Document::class, $connection = null, - \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null + ?\Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null ) { parent::__construct( $entityFactory, @@ -97,7 +97,7 @@ public function getSearchCriteria() * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setSearchCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) + public function setSearchCriteria(?\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) { return $this; } @@ -127,7 +127,7 @@ public function setTotalCount($totalCount) * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setItems(array $items = null) + public function setItems(?array $items = null) { return $this; } diff --git a/Model/ResourceModel/LandingPage/Grid/Collection.php b/Model/ResourceModel/LandingPage/Grid/Collection.php index c623a0a49..0b4ca6881 100644 --- a/Model/ResourceModel/LandingPage/Grid/Collection.php +++ b/Model/ResourceModel/LandingPage/Grid/Collection.php @@ -35,9 +35,9 @@ public function __construct( $eventPrefix, $eventObject, $resourceModel, - $model = 'Magento\Framework\View\Element\UiComponent\DataProvider\Document', + $model = \Magento\Framework\View\Element\UiComponent\DataProvider\Document::class, $connection = null, - \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null + ?\Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null ) { parent::__construct( $entityFactory, @@ -82,7 +82,7 @@ public function getSearchCriteria() * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setSearchCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) + public function setSearchCriteria(?\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) { return $this; } @@ -112,7 +112,7 @@ public function setTotalCount($totalCount) * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setItems(array $items = null) + public function setItems(?array $items = null) { return $this; } diff --git a/Model/ResourceModel/NoteBuilder.php b/Model/ResourceModel/NoteBuilder.php index 18a46d500..04e3199e7 100644 --- a/Model/ResourceModel/NoteBuilder.php +++ b/Model/ResourceModel/NoteBuilder.php @@ -107,9 +107,7 @@ private function getQueueArchiveInfo() $headers = array_keys($firstRow); $noteText[] = implode(' || ', $headers); - $archiveRows = array_map(function ($row) { - return implode(' || ', $row); - }, $archiveRows); + $archiveRows = array_map(fn($row) => implode(' || ', $row), $archiveRows); $queueArchiveInfo = array_merge($queueArchiveInfo, $archiveRows); } @@ -252,9 +250,7 @@ private function get3rdPartyModules() $headers = array_keys($firstRow); $modulesText[] = implode(' || ', $headers); - $modules = array_map(function ($row) { - return implode(' || ', $row); - }, $modules); + $modules = array_map(fn($row) => implode(' || ', $row), $modules); $modulesText = array_merge($modulesText, $modules); } diff --git a/Model/ResourceModel/Query/Grid/Collection.php b/Model/ResourceModel/Query/Grid/Collection.php index aec716203..891e8e2b5 100644 --- a/Model/ResourceModel/Query/Grid/Collection.php +++ b/Model/ResourceModel/Query/Grid/Collection.php @@ -35,9 +35,9 @@ public function __construct( $eventPrefix, $eventObject, $resourceModel, - $model = 'Magento\Framework\View\Element\UiComponent\DataProvider\Document', + $model = \Magento\Framework\View\Element\UiComponent\DataProvider\Document::class, $connection = null, - \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null + ?\Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null ) { parent::__construct( $entityFactory, @@ -82,7 +82,7 @@ public function getSearchCriteria() * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setSearchCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) + public function setSearchCriteria(?\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) { return $this; } @@ -112,7 +112,7 @@ public function setTotalCount($totalCount) * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setItems(array $items = null) + public function setItems(?array $items = null) { return $this; } diff --git a/Model/ResourceModel/QueueArchive/Grid/Collection.php b/Model/ResourceModel/QueueArchive/Grid/Collection.php index 884380cf6..86f7b317b 100644 --- a/Model/ResourceModel/QueueArchive/Grid/Collection.php +++ b/Model/ResourceModel/QueueArchive/Grid/Collection.php @@ -42,9 +42,9 @@ public function __construct( $eventPrefix, $eventObject, $resourceModel, - $model = 'Magento\Framework\View\Element\UiComponent\DataProvider\Document', + $model = \Magento\Framework\View\Element\UiComponent\DataProvider\Document::class, $connection = null, - AbstractDb $resource = null + ?AbstractDb $resource = null ) { parent::__construct( $entityFactory, @@ -89,7 +89,7 @@ public function getSearchCriteria() * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setSearchCriteria(SearchCriteriaInterface $searchCriteria = null) + public function setSearchCriteria(?SearchCriteriaInterface $searchCriteria = null) { return $this; } @@ -119,7 +119,7 @@ public function setTotalCount($totalCount) * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setItems(array $items = null) + public function setItems(?array $items = null) { return $this; } diff --git a/Model/ResourceModel/Run/Grid/Collection.php b/Model/ResourceModel/Run/Grid/Collection.php index 42d59d995..26129bec2 100644 --- a/Model/ResourceModel/Run/Grid/Collection.php +++ b/Model/ResourceModel/Run/Grid/Collection.php @@ -35,9 +35,9 @@ public function __construct( $eventPrefix, $eventObject, $resourceModel, - $model = 'Magento\Framework\View\Element\UiComponent\DataProvider\Document', + $model = \Magento\Framework\View\Element\UiComponent\DataProvider\Document::class, $connection = null, - \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null + ?\Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null ) { parent::__construct( $entityFactory, @@ -82,7 +82,7 @@ public function getSearchCriteria() * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setSearchCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) + public function setSearchCriteria(?\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria = null) { return $this; } @@ -112,7 +112,7 @@ public function setTotalCount($totalCount) * * @SuppressWarnings(PHPMD.UnusedFormalParameter) */ - public function setItems(array $items = null) + public function setItems(?array $items = null) { return $this; } diff --git a/Model/Source/AutocompleteRedirectMode.php b/Model/Source/AutocompleteRedirectMode.php new file mode 100644 index 000000000..4c5a532bf --- /dev/null +++ b/Model/Source/AutocompleteRedirectMode.php @@ -0,0 +1,31 @@ + self::SUBMIT_ONLY, + 'label' => __('Do not display the redirect (handle on form submit only)'), + ], + [ + 'value' => self::SELECTABLE_REDIRECT, + 'label' => __('Display the redirect as a selectable item in place of search hits'), + ], + [ + 'value' => self::REDIRECT_WITH_HITS, + 'label' => __('Display both search hits and a selectable redirect'), + ] + ]; + } +} diff --git a/Model/Source/CustomRankingCategory.php b/Model/Source/CustomRankingCategory.php index bf922457c..dfca2dab4 100755 --- a/Model/Source/CustomRankingCategory.php +++ b/Model/Source/CustomRankingCategory.php @@ -17,7 +17,7 @@ protected function getTableData() $attributes = $categoryHelper->getAllAttributes(); foreach ($attributes as $key => $label) { - $options[$key] = $key ? $key : $label; + $options[$key] = $key ?: $label; } return $options; diff --git a/Model/Source/CustomRankingProduct.php b/Model/Source/CustomRankingProduct.php index ae40aab1c..d2d7d4946 100755 --- a/Model/Source/CustomRankingProduct.php +++ b/Model/Source/CustomRankingProduct.php @@ -17,7 +17,7 @@ protected function getTableData() $attributes = $productHelper->getAllAttributes(); foreach ($attributes as $key => $label) { - $options[$key] = $key ? $key : $label; + $options[$key] = $key ?: $label; } return $options; diff --git a/Model/Source/Facets.php b/Model/Source/Facets.php index 8a72e1d3e..d68d66e87 100755 --- a/Model/Source/Facets.php +++ b/Model/Source/Facets.php @@ -2,6 +2,8 @@ namespace Algolia\AlgoliaSearch\Model\Source; +use Algolia\AlgoliaSearch\Service\Product\FacetBuilder; + class Facets extends AbstractTable { protected function getTableData() @@ -17,7 +19,7 @@ protected function getTableData() $attributes = $productHelper->getAllAttributes(); foreach ($attributes as $key => $label) { - $options[$key] = $key ? $key : $label; + $options[$key] = $key ?: $label; } return $options; @@ -37,7 +39,11 @@ protected function getTableData() ], 'searchable' => [ 'label' => 'Options', - 'values' => ['1' => 'Searchable', '2' => 'Not Searchable', '3' => 'Filter Only'], + 'values' => [ + FacetBuilder::FACET_SEARCHABLE_SEARCHABLE => 'Searchable', + FacetBuilder::FACET_SEARCHABLE_NOT_SEARCHABLE => 'Not Searchable', + FacetBuilder::FACET_SEARCHABLE_FILTER_ONLY => 'Filter Only' + ], ], ]; diff --git a/Model/Source/InstantSearchRedirectOptions.php b/Model/Source/InstantSearchRedirectOptions.php new file mode 100644 index 000000000..b01d09de1 --- /dev/null +++ b/Model/Source/InstantSearchRedirectOptions.php @@ -0,0 +1,45 @@ + self::REDIRECT_ON_PAGE_LOAD, + 'label' => __('Redirect on page load'), + 'description' => __('If InstantSearch loads search results that include a redirect, immediately take the user to that URL.') + ], + [ + 'value' => self::REDIRECT_ON_SEARCH_AS_YOU_TYPE, + 'label' => __('Trigger redirect on "search as you type"'), + 'description' => + __( + 'As the user types their query in the %1 widget, matching hits will be retrieved automatically from %2. If a redirect is found for the entered query, this setting will immediately take the user to that URL.', + 'searchBox', + 'Algolia' + ) + ], + [ + 'value' => self::SELECTABLE_REDIRECT, + 'label' => __('Display redirect as a selectable item'), + 'description' => __('If a redirect is found for a search query, display a clickable link to that URL above the search result hits.') + ], + [ + 'value' => self::OPEN_IN_NEW_WINDOW, + 'label' => __('Open redirect URL in a new window'), + 'description' => __('This setting applies to clickable links only.') + ] + ]; + } +} diff --git a/Model/Source/JobClasses.php b/Model/Source/JobClasses.php index 4b99a1854..7d11c56bb 100644 --- a/Model/Source/JobClasses.php +++ b/Model/Source/JobClasses.php @@ -5,15 +5,15 @@ class JobClasses implements \Magento\Framework\Data\OptionSourceInterface { private $classes = [ - 'Algolia\AlgoliaSearch\Model\IndicesConfigurator' => 'Model\IndicesConfigurator', - 'Algolia\AlgoliaSearch\Model\IndexMover' => 'Model\IndexMover', - 'Algolia\AlgoliaSearch\Service\AdditionalSection\IndexBuilder' => 'AdditionalSection\IndexBuilder', - 'Algolia\AlgoliaSearch\Service\Category\IndexBuilder' => 'Category\IndexBuilder', - 'Algolia\AlgoliaSearch\Service\Page\IndexBuilder' => 'Page\IndexBuilder', - 'Algolia\AlgoliaSearch\Service\Product\IndexBuilder' => 'Product\IndexBuilder', - 'Algolia\AlgoliaSearch\Service\Suggestion\IndexBuilder' => 'Suggestion\IndexBuilder', + \Algolia\AlgoliaSearch\Model\IndicesConfigurator::class => 'Model\IndicesConfigurator', + \Algolia\AlgoliaSearch\Model\IndexMover::class => 'Model\IndexMover', + \Algolia\AlgoliaSearch\Service\AdditionalSection\IndexBuilder::class => 'AdditionalSection\IndexBuilder', + \Algolia\AlgoliaSearch\Service\Category\IndexBuilder::class => 'Category\IndexBuilder', + \Algolia\AlgoliaSearch\Service\Page\IndexBuilder::class => 'Page\IndexBuilder', + \Algolia\AlgoliaSearch\Service\Product\IndexBuilder::class => 'Product\IndexBuilder', + \Algolia\AlgoliaSearch\Service\Suggestion\IndexBuilder::class => 'Suggestion\IndexBuilder', // @deprecated - 'Algolia\AlgoliaSearch\Helper\Data' => 'Helper\Data', + \Algolia\AlgoliaSearch\Helper\Data::class => 'Helper\Data', ]; /** @return array */ diff --git a/Model/Source/ProductAttributes.php b/Model/Source/ProductAttributes.php index 526b61519..1450ac149 100755 --- a/Model/Source/ProductAttributes.php +++ b/Model/Source/ProductAttributes.php @@ -17,7 +17,7 @@ protected function getTableData() $attributes = $productHelper->getAllAttributes(); foreach ($attributes as $key => $label) { - $options[$key] = $key ? $key : $label; + $options[$key] = $key ?: $label; } return $options; diff --git a/Model/Source/Sections.php b/Model/Source/Sections.php index 1ac12a786..48a1d18fd 100755 --- a/Model/Source/Sections.php +++ b/Model/Source/Sections.php @@ -31,7 +31,7 @@ protected function getTableData() $sections[] = [ 'name' => $attribute['attribute'], - 'label' => $attribute['label'] ? $attribute['label'] : $attribute['attribute'], + 'label' => $attribute['label'] ?: $attribute['attribute'], ]; } diff --git a/Model/Source/SortOrderCategory.php b/Model/Source/SortOrderCategory.php index 05b6e40e1..0ecc6d4ee 100755 --- a/Model/Source/SortOrderCategory.php +++ b/Model/Source/SortOrderCategory.php @@ -16,7 +16,7 @@ protected function getTableData() $attributes = $categoryHelper->getAllAttributes(); foreach ($attributes as $key => $label) { - $options[$key] = $key ? $key : $label; + $options[$key] = $key ?: $label; } return $options; diff --git a/Model/Source/SortOrderProduct.php b/Model/Source/SortOrderProduct.php index b3957ae77..fac744247 100755 --- a/Model/Source/SortOrderProduct.php +++ b/Model/Source/SortOrderProduct.php @@ -16,7 +16,7 @@ protected function getTableData() $attributes = $productHelper->getAllAttributes(); foreach ($attributes as $key => $label) { - $options[$key] = $key ? $key : $label; + $options[$key] = $key ?: $label; } return $options; diff --git a/Model/Source/Sorts.php b/Model/Source/Sorts.php index 9e885b8cf..2420f1981 100755 --- a/Model/Source/Sorts.php +++ b/Model/Source/Sorts.php @@ -22,7 +22,7 @@ protected function getTableData() $attributes = $productHelper->getAllAttributes(); foreach ($attributes as $key => $label) { - $options[$key] = $key ? $key : $label; + $options[$key] = $key ?: $label; } return $options; diff --git a/Observer/Insights/CheckoutCartProductAddAfter.php b/Observer/Insights/CheckoutCartProductAddAfter.php index 7e9548464..c88f917ef 100644 --- a/Observer/Insights/CheckoutCartProductAddAfter.php +++ b/Observer/Insights/CheckoutCartProductAddAfter.php @@ -2,6 +2,7 @@ namespace Algolia\AlgoliaSearch\Observer\Insights; +use Algolia\AlgoliaSearch\Api\LoggerInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper; @@ -13,7 +14,6 @@ use Magento\Framework\Event\ObserverInterface; use Magento\Framework\Exception\LocalizedException; use Magento\Quote\Model\Quote\Item; -use Psr\Log\LoggerInterface; class CheckoutCartProductAddAfter implements ObserverInterface { diff --git a/Observer/Insights/CheckoutOnePageControllerSuccessAction.php b/Observer/Insights/CheckoutOnePageControllerSuccessAction.php index 11bd10e90..c08a20f38 100644 --- a/Observer/Insights/CheckoutOnePageControllerSuccessAction.php +++ b/Observer/Insights/CheckoutOnePageControllerSuccessAction.php @@ -2,6 +2,7 @@ namespace Algolia\AlgoliaSearch\Observer\Insights; +use Algolia\AlgoliaSearch\Api\LoggerInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Helper\InsightsHelper; @@ -11,7 +12,6 @@ use Magento\Framework\Exception\NoSuchEntityException; use Magento\Sales\Model\Order; use Magento\Sales\Model\OrderFactory; -use Psr\Log\LoggerInterface; class CheckoutOnePageControllerSuccessAction implements ObserverInterface { diff --git a/Observer/Insights/WishlistProductAddAfter.php b/Observer/Insights/WishlistProductAddAfter.php index 280a0ae4c..8081dd87a 100644 --- a/Observer/Insights/WishlistProductAddAfter.php +++ b/Observer/Insights/WishlistProductAddAfter.php @@ -2,13 +2,13 @@ namespace Algolia\AlgoliaSearch\Observer\Insights; +use Algolia\AlgoliaSearch\Api\LoggerInterface; use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Helper\InsightsHelper; use Magento\Framework\Event\Observer; use Magento\Framework\Event\ObserverInterface; use Magento\Wishlist\Model\Item; -use Psr\Log\LoggerInterface; class WishlistProductAddAfter implements ObserverInterface { @@ -36,9 +36,7 @@ public function execute(Observer $observer): void } $eventProcessor = $this->insightsHelper->getEventProcessor(); - $productIds = array_map(function (Item $item) { - return $item->getProductId(); - }, $items); + $productIds = array_map(fn(Item $item) => $item->getProductId(), $items); try { $eventProcessor->convertedObjectIDs( diff --git a/Observer/RecommendSettings.php b/Observer/RecommendSettings.php index f202268ea..874252eb5 100644 --- a/Observer/RecommendSettings.php +++ b/Observer/RecommendSettings.php @@ -3,6 +3,7 @@ namespace Algolia\AlgoliaSearch\Observer; +use Algolia\AlgoliaSearch\Api\LoggerInterface; use Algolia\AlgoliaSearch\Api\RecommendManagementInterface; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Magento\Catalog\Api\ProductRepositoryInterface; @@ -14,7 +15,6 @@ use Magento\Framework\Event\ObserverInterface; use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Message\ManagerInterface as MessageManagerInterface; -use Psr\Log\LoggerInterface; class RecommendSettings implements ObserverInterface { diff --git a/Plugin/AddToCartRedirectForInsights.php b/Plugin/AddToCartRedirectForInsights.php index df9f3b95f..3f2b47e40 100644 --- a/Plugin/AddToCartRedirectForInsights.php +++ b/Plugin/AddToCartRedirectForInsights.php @@ -41,7 +41,7 @@ public function __construct( * @throws LocalizedException * @throws NoSuchEntityException */ - public function beforeAddProduct(Cart $cartModel, int|Product $productInfo, array|int|DataObject $requestInfo = null) + public function beforeAddProduct(Cart $cartModel, int|Product $productInfo, array|int|DataObject|null $requestInfo) { // First, check is Insights are enabled if (!$this->configHelper->isClickConversionAnalyticsEnabled($this->storeManager->getStore()->getId())) { diff --git a/Plugin/RenderingCacheContextPlugin.php b/Plugin/RenderingCacheContextPlugin.php index 039c7079c..e3af640b0 100755 --- a/Plugin/RenderingCacheContextPlugin.php +++ b/Plugin/RenderingCacheContextPlugin.php @@ -3,6 +3,7 @@ namespace Algolia\AlgoliaSearch\Plugin; use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper; use Magento\Framework\App\Http\Context as HttpContext; use Magento\Framework\App\Request\Http; use Magento\Framework\Exception\NoSuchEntityException; @@ -25,7 +26,8 @@ class RenderingCacheContextPlugin public const CATEGORY_ROUTE = 'catalog/category/view'; public function __construct( - protected ConfigHelper $configHelper, + protected ConfigHelper $baseConfig, + protected InstantSearchHelper $isConfig, protected StoreManagerInterface $storeManager, protected Http $request, protected UrlFinderInterface $urlFinder @@ -50,7 +52,7 @@ public function afterGetData(HttpContext $subject, array $data): array { return $data; } - $context = $this->configHelper->preventBackendRendering() ? + $context = $this->baseConfig->preventBackendRendering() ? self::RENDERING_WITHOUT_BACKEND : self::RENDERING_WITH_BACKEND; @@ -89,6 +91,7 @@ protected function isCategoryRoute(string $path): bool { * * @param int $storeId * @return bool + * @deprecated This method will be removed in a future version */ protected function isCategoryPage(int $storeId): bool { @@ -104,6 +107,6 @@ protected function isCategoryPage(int $storeId): bool protected function shouldApplyCacheContext(): bool { $storeId = $this->storeManager->getStore()->getId(); - return $this->isCategoryPage($storeId) && $this->configHelper->replaceCategories($storeId); + return $this->isConfig->shouldReplaceCategories($storeId); } } diff --git a/Plugin/SetAdminCurrentCategory.php b/Plugin/SetAdminCurrentCategory.php index 53a2374c1..c05ddfad0 100644 --- a/Plugin/SetAdminCurrentCategory.php +++ b/Plugin/SetAdminCurrentCategory.php @@ -45,7 +45,7 @@ public function afterExecute(EditController $subject, $result) try { $currentCategory = $this->categoryRepository->get($categoryId); $this->currentCategory->set($currentCategory); - } catch (NoSuchEntityException $e) { + } catch (NoSuchEntityException) { return null; } diff --git a/Plugin/StockItemObserver.php b/Plugin/StockItemObserver.php index 94bc5fefb..8b83e20e8 100644 --- a/Plugin/StockItemObserver.php +++ b/Plugin/StockItemObserver.php @@ -38,13 +38,13 @@ public function beforeSave( /** * @param \Magento\CatalogInventory\Model\ResourceModel\Stock\Item $stockItemResource - * @param \Magento\CatalogInventory\Model\ResourceModel\Stock\Item|null $result + * @param \Magento\CatalogInventory\Model\ResourceModel\Stock\Item $result * @param \Magento\CatalogInventory\Api\Data\StockItemInterface $stockItem - * @return \Magento\CatalogInventory\Model\ResourceModel\Stock\Item|null + * @return \Magento\CatalogInventory\Model\ResourceModel\Stock\Item */ public function afterDelete( \Magento\CatalogInventory\Model\ResourceModel\Stock\Item $stockItemResource, - \Magento\CatalogInventory\Model\ResourceModel\Stock\Item $result = null, + \Magento\CatalogInventory\Model\ResourceModel\Stock\Item $result, \Magento\CatalogInventory\Api\Data\StockItemInterface $stockItem ) { $stockItemResource->addCommitCallback(function () use ($stockItem) { diff --git a/README.md b/README.md index 08bd51f84..d839f286d 100755 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ Algolia Search & Discovery extension for Magento 2 ================================================== -![Latest version](https://img.shields.io/badge/latest-3.15.1-green) -![Magento 2](https://img.shields.io/badge/Magento-2.4.6+-orange) +![Latest version](https://img.shields.io/badge/latest-3.16.0-green) +![Magento 2](https://img.shields.io/badge/Magento-2.4.7+-orange) -![PHP](https://img.shields.io/badge/PHP-8.1%2C8.2%2C8.3-blue) +![PHP](https://img.shields.io/badge/PHP-8.1%2C8.2%2C8.3%2C8.4-blue) -[![CircleCI](https://circleci.com/gh/algolia/algoliasearch-magento-2/tree/master.svg?style=svg)](https://circleci.com/gh/algolia/algoliasearch-magento-2/tree/master) +[![CircleCI](https://circleci.com/gh/algolia/algoliasearch-magento-2/tree/main.svg?style=svg)](https://circleci.com/gh/algolia/algoliasearch-magento-2/tree/main) ------- @@ -43,9 +43,10 @@ Version 3.x of our extension is compatible with Magento 2.4. Review the [Customi | v3.10.x | 12/12/2023 | `~2.4.6` | `~8.1.0\|\|~8.2.0` | | v3.11.x | 1/26/2024 | `~2.4.6` | `~8.1.0\|\|~8.2.0` | | v3.12.x | 8/2/2024 | `~2.4.6` | `~8.1.0\|\|~8.2.0` | -| v3.13.x | N/A | `~2.4.6` | `~8.1.0\|\|~8.2.0` | -| v3.14.x | N/A | `~2.4.6\|\|~2.4.7` | `~8.1.0\|\|~8.2.0\|\|~8.3.0` | +| v3.13.x | 4/9/2025 | `~2.4.6` | `~8.1.0\|\|~8.2.0` | +| v3.14.x | 9/1/2025 | `~2.4.6\|\|~2.4.7` | `~8.1.0\|\|~8.2.0\|\|~8.3.0` | | v3.15.x | N/A | `~2.4.6\|\|~2.4.7` | `~8.1.0\|\|~8.2.0\|\|~8.3.0` | +| v3.16.x | N/A | `~2.4.7\|\|~2.4.8` | `~8.2.0\|\|~8.3.0\|\|~8.4.0` | ## Documentation @@ -78,15 +79,16 @@ Please check our [Custom Extension](https://github.com/algolia/algoliasearch-cus Knowing the version of each Algolia JavaScript library will help you understand what is available for you to leverage in terms of customisation. This table will help you determine which documentation to reference when you start working on your customisation. -| Extension Version | autocomplete.js | instantsearch.js | search-insights.js | recommend-js.js | -|-----------------|--------------------------------------------------------------------|------------------------------------------------------------------------------------|----------------------------------------------------------------------|-------------------------------------------------------------| -| v3.x | [0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0)* | [4.15.0](https://github.com/algolia/instantsearch.js/tree/v4.15.0)* | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | NA | -| v3.9.1 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0)* | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.5.0](https://github.com/algolia/recommend/tree/v1.5.0) | -| v3.10.x | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0)* | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) | -| v3.11.0 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0)* | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) | -| v3.13.0 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.63.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.63.0)* | [2.11.0](https://github.com/algolia/search-insights.js/tree/v2.11.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) | -| v3.14.x | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.63.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.63.0)* | [2.11.0](https://github.com/algolia/search-insights.js/tree/v2.11.0) | [1.15.0](https://github.com/algolia/recommend/tree/v1.15.0) | -| v3.15.x | [1.17.9](https://github.com/algolia/autocomplete.js/tree/v1.17.9) | [4.77.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.77.0) | [2.17.3](https://github.com/algolia/search-insights.js/tree/v2.17.3) | [1.16.0](https://github.com/algolia/recommend/tree/v1.16.0) | +| Extension Version | autocomplete.js | instantsearch.js | search-insights.js | recommend-js.js | +|-------------------|--------------------------------------------------------------------|--------------------------------------------------------------------------------|----------------------------------------------------------------------|-------------------------------------------------------------| +| v3.x | [0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0)* | [4.15.0](https://github.com/algolia/instantsearch.js/tree/v4.15.0)* | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | NA | +| v3.9.1 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0)* | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.5.0](https://github.com/algolia/recommend/tree/v1.5.0) | +| v3.10.x | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0)* | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) | +| v3.11.0 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0)* | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) | +| v3.13.0 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.63.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.63.0)* | [2.11.0](https://github.com/algolia/search-insights.js/tree/v2.11.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) | +| v3.14.x | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3)* | [4.63.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.63.0)* | [2.11.0](https://github.com/algolia/search-insights.js/tree/v2.11.0) | [1.15.0](https://github.com/algolia/recommend/tree/v1.15.0) | +| v3.15.x | [1.17.9](https://github.com/algolia/autocomplete.js/tree/v1.17.9) | [4.77.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.77.0) | [2.17.3](https://github.com/algolia/search-insights.js/tree/v2.17.3) | [1.16.0](https://github.com/algolia/recommend/tree/v1.16.0) | +| v3.16.x | [1.18.1](https://github.com/algolia/autocomplete.js/tree/v1.18.1) | [4.78.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.78.0) | [2.17.3](https://github.com/algolia/search-insights.js/tree/v2.17.3) | [1.16.0](https://github.com/algolia/recommend/tree/v1.16.0) | * In earlier versions of the extension, the Autocomplete and InstantSearch libraries were accessible via the `algoliaBundle` global. This bundle was a prepackaged JavaScript file that contained dependencies for the frontend experience. What was included in this bundle can be seen here: https://github.com/algolia/algoliasearch-extensions-bundle/blob/ISv4/package.json diff --git a/Service/AbstractIndexBuilder.php b/Service/AbstractIndexBuilder.php index 9d031441e..7d355cdcb 100644 --- a/Service/AbstractIndexBuilder.php +++ b/Service/AbstractIndexBuilder.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Service; +use Algolia\AlgoliaSearch\Api\Data\IndexOptionsInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Magento\Framework\App\Area; @@ -16,11 +16,11 @@ abstract class AbstractIndexBuilder protected bool $emulationRuns = false; public function __construct( - protected ConfigHelper $configHelper, - protected DiagnosticsLogger $logger, - protected Emulation $emulation, - protected ScopeCodeResolver $scopeCodeResolver, - protected AlgoliaHelper $algoliaHelper + protected ConfigHelper $configHelper, + protected DiagnosticsLogger $logger, + protected Emulation $emulation, + protected ScopeCodeResolver $scopeCodeResolver, + protected AlgoliaConnector $algoliaConnector, ){} /** @@ -30,7 +30,7 @@ public function __construct( */ protected function isIndexingEnabled($storeId = null): bool { - if ($this->configHelper->isEnabledBackend($storeId) === false) { + if ($this->configHelper->isIndexingEnabled($storeId) === false) { $this->logger->log('INDEXING IS DISABLED FOR ' . $this->logger->getStoreName($storeId)); return false; } @@ -69,24 +69,25 @@ protected function stopEmulation(): void /** * @param array $objects - * @param string $indexName + * @param IndexOptionsInterface $indexOptions * @param int|null $storeId * @return void - * @throws \Exception + * @throws AlgoliaException + * @throws NoSuchEntityException */ - protected function saveObjects(array $objects, string $indexName, int $storeId = null): void + protected function saveObjects(array $objects, IndexOptionsInterface $indexOptions): void { - $this->algoliaHelper->saveObjects($indexName, $objects, $this->configHelper->isPartialUpdateEnabled(), $storeId); + $this->algoliaConnector->saveObjects($indexOptions, $objects, $this->configHelper->isPartialUpdateEnabled()); } /** - * @param $indexName - * @param $idsToRemove - * @param null $storeId - * @return array|mixed + * @param IndexOptionsInterface $indexOptions + * @param array $idsToRemove + * @param int|null $storeId + * @return array * @throws AlgoliaException */ - protected function getIdsToRealRemove($indexName, $idsToRemove, $storeId = null) + protected function getIdsToRealRemove(IndexOptionsInterface $indexOptions, array $idsToRemove, ?int $storeId = null) { if (count($idsToRemove) === 1) { return $idsToRemove; @@ -95,7 +96,7 @@ protected function getIdsToRealRemove($indexName, $idsToRemove, $storeId = null) $toRealRemove = []; $idsToRemove = array_map('strval', $idsToRemove); foreach (array_chunk($idsToRemove, 1000) as $chunk) { - $objects = $this->algoliaHelper->getObjects($indexName, $chunk, $storeId); + $objects = $this->algoliaConnector->getObjects($indexOptions, $chunk); foreach ($objects['results'] as $object) { if (isset($object[AlgoliaConnector::ALGOLIA_API_OBJECT_ID])) { $toRealRemove[] = $object[AlgoliaConnector::ALGOLIA_API_OBJECT_ID]; diff --git a/Service/AdditionalSection/BatchQueueProcessor.php b/Service/AdditionalSection/BatchQueueProcessor.php new file mode 100644 index 000000000..e5af62f37 --- /dev/null +++ b/Service/AdditionalSection/BatchQueueProcessor.php @@ -0,0 +1,39 @@ +dataHelper->isIndexingEnabled($storeId) === false) { + return; + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + /** @uses AdditionalSectionIndexBuilder::buildIndexFull() */ + $this->queue->addToQueue( + AdditionalSectionIndexBuilder::class, + 'buildIndexFull', + ['storeId' => $storeId], + 1 + ); + } +} diff --git a/Service/AdditionalSection/IndexBuilder.php b/Service/AdditionalSection/IndexBuilder.php index 384b613b8..ae643c190 100644 --- a/Service/AdditionalSection/IndexBuilder.php +++ b/Service/AdditionalSection/IndexBuilder.php @@ -5,12 +5,13 @@ use Algolia\AlgoliaSearch\Api\Builder\IndexBuilderInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\AdditionalSectionHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder; +use Algolia\AlgoliaSearch\Service\AlgoliaConnector; use Algolia\AlgoliaSearch\Service\IndexNameFetcher; +use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder; use Magento\Framework\App\Config\ScopeCodeResolver; use Magento\Framework\Exception\NoSuchEntityException; use Magento\Store\Model\App\Emulation; @@ -22,10 +23,17 @@ public function __construct( protected DiagnosticsLogger $logger, protected Emulation $emulation, protected ScopeCodeResolver $scopeCodeResolver, - protected AlgoliaHelper $algoliaHelper, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, protected AdditionalSectionHelper $additionalSectionHelper, ){ - parent::__construct($configHelper, $logger, $emulation, $scopeCodeResolver, $algoliaHelper); + parent::__construct( + $configHelper, + $logger, + $emulation, + $scopeCodeResolver, + $algoliaConnector + ); } /** @@ -36,7 +44,7 @@ public function __construct( * @throws ExceededRetriesException * @throws NoSuchEntityException */ - public function buildIndexFull(int $storeId, array $options = null): void + public function buildIndexFull(int $storeId, ?array $options = null): void { $this->buildIndex($storeId, null, null); } @@ -66,25 +74,23 @@ public function buildIndex(int $storeId, ?array $entityIds, ?array $options): vo $indexName = $this->additionalSectionHelper->getIndexName($storeId); $indexName = $indexName . '_' . $section['name']; + $tempIndexName = $indexName . IndexNameFetcher::INDEX_TEMP_SUFFIX; $attributeValues = $this->additionalSectionHelper->getAttributeValues($storeId, $section); - $tempIndexName = $indexName . IndexNameFetcher::INDEX_TEMP_SUFFIX; + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName, $storeId); + $tempIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($tempIndexName, $storeId); foreach (array_chunk($attributeValues, 100) as $chunk) { - $this->saveObjects($chunk, $tempIndexName, $storeId); + $this->saveObjects($chunk, $tempIndexOptions); } - $this->algoliaHelper->copyQueryRules($indexName, $tempIndexName, $storeId); - $this->algoliaHelper->moveIndex($tempIndexName, $indexName, $storeId); + $this->algoliaConnector->copyQueryRules($indexOptions, $tempIndexOptions); + $this->algoliaConnector->moveIndex($tempIndexOptions, $indexOptions); - $this->algoliaHelper->setSettings( - $indexName, - $this->additionalSectionHelper->getIndexSettings($storeId), - false, - false, - '', - $storeId + $this->algoliaConnector->setSettings( + $indexOptions, + $this->additionalSectionHelper->getIndexSettings($storeId) ); } } diff --git a/Service/AdditionalSection/IndexOptionsBuilder.php b/Service/AdditionalSection/IndexOptionsBuilder.php new file mode 100644 index 000000000..b86dfb915 --- /dev/null +++ b/Service/AdditionalSection/IndexOptionsBuilder.php @@ -0,0 +1,22 @@ +buildWithComputedIndex(AdditionalSectionHelper::INDEX_NAME_SUFFIX, $storeId, $isTmp); + } +} diff --git a/Service/AlgoliaConnector.php b/Service/AlgoliaConnector.php index 4b63b502c..cce5c48cc 100755 --- a/Service/AlgoliaConnector.php +++ b/Service/AlgoliaConnector.php @@ -61,17 +61,17 @@ class AlgoliaConnector /** * @var string|null */ - protected ?string $lastUsedIndexName; + protected ?string $lastUsedIndexName = null; /** * @var string|null */ - protected ?string $lastTaskId; + protected ?string $lastTaskId = null; /** * @var array|null */ - protected ?array $lastTaskInfoByStore; + protected ?array $lastTaskInfoByStore = null; public function __construct( protected ConfigHelper $config, @@ -149,16 +149,6 @@ public function getClient(?int $storeId = self::ALGOLIA_DEFAULT_SCOPE): SearchCl return $this->clients[$storeId]; } - /** - * @param string $name - * @throws AlgoliaException - * @deprecated This method has been completely removed from the Algolia PHP connector version 4 and should not be used. - */ - public function getIndex(string $name) - { - throw new AlgoliaException("This method is no longer supported for PHP client v4!"); - } - /** * @return ListIndicesResponse|array * @throws AlgoliaException @@ -211,12 +201,10 @@ public function getObjects(IndexOptionsInterface $indexOptions, array $objectIds $requests = array_values( array_map( - function($id) use ($indexName) { - return [ - self::ALGOLIA_API_INDEX_NAME => $indexName, - self::ALGOLIA_API_OBJECT_ID => $id - ]; - }, + fn($id) => [ + self::ALGOLIA_API_INDEX_NAME => $indexName, + self::ALGOLIA_API_OBJECT_ID => $id + ], $objectIds ) ); @@ -293,14 +281,12 @@ public function deleteObjects(array $ids, IndexOptionsInterface $indexOptions): { $requests = array_values( array_map( - function ($id) { - return [ - 'action' => 'deleteObject', - 'body' => [ - self::ALGOLIA_API_OBJECT_ID => $id - ] - ]; - }, + fn($id) => [ + 'action' => 'deleteObject', + 'body' => [ + self::ALGOLIA_API_OBJECT_ID => $id + ] + ], $ids ) ); @@ -311,13 +297,13 @@ function ($id) { /** * Warning: This method can't be performed across two different applications * - * @param IndexOptions $fromIndexOptions - * @param IndexOptions $toIndexOptions + * @param IndexOptionsInterface $fromIndexOptions + * @param IndexOptionsInterface $toIndexOptions * @return void * @throws AlgoliaException * @throws NoSuchEntityException */ - public function moveIndex(IndexOptions $fromIndexOptions, IndexOptions $toIndexOptions): void + public function moveIndex(IndexOptionsInterface $fromIndexOptions, IndexOptionsInterface $toIndexOptions): void { $fromIndexName = $fromIndexOptions->getIndexName(); $toIndexName = $toIndexOptions->getIndexName(); @@ -393,7 +379,7 @@ protected function mergeSettings( } $onlineSettings = $this->getClient($storeId)->getSettings($sourceIndex); - } catch (Exception $e) { + } catch (Exception) { } if (isset($settings['attributesToIndex'])) { @@ -466,12 +452,10 @@ public function saveObjects(IndexOptionsInterface $indexOptions, array $objects, $requests = array_values( array_map( - function ($object) use ($action) { - return [ - 'action' => $action, - 'body' => $object - ]; - }, + fn($object) => [ + 'action' => $action, + 'body' => $object + ], $objects ) ); @@ -628,7 +612,7 @@ public function copyQueryRules(IndexOptionsInterface $fromIndexOptions, IndexOpt * @throws AlgoliaException * @throws NoSuchEntityException */ - public function searchRules(IndexOptionsInterface $indexOptions, array$searchRulesParams = null) + public function searchRules(IndexOptionsInterface $indexOptions, ?array $searchRulesParams = null) { $indexName = $indexOptions->getIndexName(); @@ -840,7 +824,7 @@ public function castProductObject(&$productData): void if (is_array($data) === false) { if ($data != null) { - $data = explode('|', $data); + $data = explode('|', (string) $data); if (count($data) === 1) { $data = $data[0]; $data = $this->castAttribute($data); @@ -1016,8 +1000,8 @@ protected function getDisjunctiveQueries($queryParams): array foreach ($queryParams['disjunctiveFacets'] as $facetName) { $params = $queryParams; $params['facets'] = [$facetName]; - $facetFilters = isset($params['facetFilters']) ? $params['facetFilters'] : []; - $numericFilters = isset($params['numericFilters']) ? $params['numericFilters'] : []; + $facetFilters = $params['facetFilters'] ?? []; + $numericFilters = $params['numericFilters'] ?? []; $additionalParams = [ 'hitsPerPage' => 1, @@ -1050,7 +1034,7 @@ protected function getAlgoliaFiltersArrayWithoutCurrentRefinement($filters, $nee for ($i = 0; $i < count($filters); $i++) { if (is_array($filters[$i])) { foreach ($filters[$i] as $filter) { - if (mb_substr($filter, 0, mb_strlen($needle)) === $needle) { + if (mb_substr((string) $filter, 0, mb_strlen((string) $needle)) === $needle) { unset($filters[$i]); $filters = array_values($filters); $i--; @@ -1059,7 +1043,7 @@ protected function getAlgoliaFiltersArrayWithoutCurrentRefinement($filters, $nee } } } else { - if (mb_substr($filters[$i], 0, mb_strlen($needle)) === $needle) { + if (mb_substr((string) $filters[$i], 0, mb_strlen((string) $needle)) === $needle) { unset($filters[$i]); $filters = array_values($filters); $i--; diff --git a/Service/AlgoliaCredentialsManager.php b/Service/AlgoliaCredentialsManager.php index b3a171f59..16188b8c6 100644 --- a/Service/AlgoliaCredentialsManager.php +++ b/Service/AlgoliaCredentialsManager.php @@ -24,7 +24,7 @@ public function __construct( * @param int|null $storeId * @return bool */ - public function checkCredentials(int $storeId = null): bool + public function checkCredentials(?int $storeId = null): bool { return $this->configHelper->getApplicationID($storeId) && $this->configHelper->getAPIKey($storeId); } @@ -35,7 +35,7 @@ public function checkCredentials(int $storeId = null): bool * @param int|null $storeId * @return bool */ - public function checkCredentialsWithSearchOnlyAPIKey(int $storeId = null): bool + public function checkCredentialsWithSearchOnlyAPIKey(?int $storeId = null): bool { return $this->checkCredentials($storeId) && $this->configHelper->getSearchOnlyAPIKey($storeId); } diff --git a/Service/Category/BatchQueueProcessor.php b/Service/Category/BatchQueueProcessor.php new file mode 100644 index 000000000..bd193a276 --- /dev/null +++ b/Service/Category/BatchQueueProcessor.php @@ -0,0 +1,112 @@ +dataHelper->isIndexingEnabled($storeId) === false) { + return; + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + $categoriesPerPage = $this->configHelper->getNumberOfElementByPage(); + + if (is_array($entityIds) && count($entityIds) > 0) { + $this->processSpecificCategories($entityIds, $categoriesPerPage, $storeId); + + return; + } + + $this->processFullReindex($storeId, $categoriesPerPage); + } + + /** + * @param array $categoryIds + * @param int $categoriesPerPage + * @param int $storeId + */ + protected function processSpecificCategories(array $categoryIds, int $categoriesPerPage, int $storeId): void + { + foreach (array_chunk($categoryIds, $categoriesPerPage) as $chunk) { + /** @uses CategoryIndexBuilder::buildIndexList */ + $this->queue->addToQueue( + CategoryIndexBuilder::class, + 'buildIndexList', + [ + 'storeId' => $storeId, + 'entityIds' => $chunk, + ], + count($chunk) + ); + } + } + + /** + * @param int $storeId + * @param int $categoriesPerPage + * + * @throws NoSuchEntityException + * @throws LocalizedException + */ + protected function processFullReindex(int $storeId, int $categoriesPerPage): void + { + /** @uses IndicesConfigurator::saveConfigurationToAlgolia() */ + $this->queue->addToQueue(IndicesConfigurator::class, 'saveConfigurationToAlgolia', ['storeId' => $storeId]); + + $collection = $this->categoryHelper->getCategoryCollectionQuery($storeId); + $size = $collection->getSize(); + + $pages = ceil($size / $categoriesPerPage); + + for ($i = 1; $i <= $pages; $i++) { + $data = [ + 'storeId' => $storeId, + 'options' => [ + 'page' => $i, + 'pageSize' => $categoriesPerPage, + ] + ]; + + /** @uses CategoryIndexBuilder::buildIndexFull() */ + $this->queue->addToQueue( + CategoryIndexBuilder::class, + 'buildIndexFull', + $data, + $categoriesPerPage, + true + ); + } + } +} diff --git a/Service/Category/IndexBuilder.php b/Service/Category/IndexBuilder.php index 34c5a5c4c..17eddee9c 100644 --- a/Service/Category/IndexBuilder.php +++ b/Service/Category/IndexBuilder.php @@ -5,11 +5,12 @@ use Algolia\AlgoliaSearch\Api\Builder\UpdatableIndexBuilderInterface; use Algolia\AlgoliaSearch\Exception\CategoryReindexingException; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\CategoryHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder; +use Algolia\AlgoliaSearch\Service\AlgoliaConnector; +use Algolia\AlgoliaSearch\Service\Category\RecordBuilder as CategoryRecordBuilder; use Magento\Catalog\Model\ResourceModel\Category\Collection; use Magento\Framework\App\Config\ScopeCodeResolver; use Magento\Framework\Exception\LocalizedException; @@ -19,14 +20,22 @@ class IndexBuilder extends AbstractIndexBuilder implements UpdatableIndexBuilderInterface { public function __construct( - protected ConfigHelper $configHelper, - protected DiagnosticsLogger $logger, - protected Emulation $emulation, - protected ScopeCodeResolver $scopeCodeResolver, - protected AlgoliaHelper $algoliaHelper, - protected CategoryHelper $categoryHelper + protected ConfigHelper $configHelper, + protected DiagnosticsLogger $logger, + protected Emulation $emulation, + protected ScopeCodeResolver $scopeCodeResolver, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, + protected CategoryRecordBuilder $categoryRecordBuilder, + protected CategoryHelper $categoryHelper ){ - parent::__construct($configHelper, $logger, $emulation, $scopeCodeResolver, $algoliaHelper); + parent::__construct( + $configHelper, + $logger, + $emulation, + $scopeCodeResolver, + $algoliaConnector + ); } /** @@ -37,7 +46,7 @@ public function __construct( * @throws NoSuchEntityException * @throws AlgoliaException */ - public function buildIndexFull(int $storeId, array $options = null): void + public function buildIndexFull(int $storeId, ?array $options = null): void { $this->buildIndex($storeId, null, $options); } @@ -51,7 +60,7 @@ public function buildIndexFull(int $storeId, array $options = null): void * @throws LocalizedException * @throws NoSuchEntityException */ - public function buildIndexList(int $storeId, array $entityIds = null, array $options = null): void + public function buildIndexList(int $storeId, ?array $entityIds = null, ?array $options = null): void { $this->buildIndex($storeId, $entityIds, $options); } @@ -140,20 +149,20 @@ protected function buildIndexPage($storeId, $collection, $page, $pageSize, $cate } $collection->setCurPage($page)->setPageSize($pageSize); $collection->load(); - $indexName = $this->categoryHelper->getIndexName($storeId); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); $indexData = $this->getCategoryRecords($storeId, $collection, $categoryIds); if (!empty($indexData['toIndex'])) { $this->logger->start('ADD/UPDATE TO ALGOLIA'); - $this->saveObjects($indexData['toIndex'], $indexName, $storeId); + $this->saveObjects($indexData['toIndex'], $indexOptions); $this->logger->log('Product IDs: ' . implode(', ', array_keys($indexData['toIndex']))); $this->logger->stop('ADD/UPDATE TO ALGOLIA'); } if (!empty($indexData['toRemove'])) { - $toRealRemove = $this->getIdsToRealRemove($indexName, $indexData['toRemove'], $storeId); + $toRealRemove = $this->getIdsToRealRemove($indexOptions, $indexData['toRemove']); if (!empty($toRealRemove)) { $this->logger->start('REMOVE FROM ALGOLIA'); - $this->algoliaHelper->deleteObjects($toRealRemove, $indexName, $storeId); + $this->algoliaConnector->deleteObjects($toRealRemove, $indexOptions); $this->logger->log('Category IDs: ' . implode(', ', $toRealRemove)); $this->logger->stop('REMOVE FROM ALGOLIA'); } @@ -202,12 +211,12 @@ protected function getCategoryRecords($storeId, $collection, $potentiallyDeleted try { $this->categoryHelper->canCategoryBeReindexed($category, $storeId); - } catch (CategoryReindexingException $e) { + } catch (CategoryReindexingException) { $categoriesToRemove[$categoryId] = $categoryId; continue; } - $categoriesToIndex[$categoryId] = $this->categoryHelper->getObject($category); + $categoriesToIndex[$categoryId] = $this->categoryRecordBuilder->buildRecord($category); } if (is_array($potentiallyDeletedCategoriesIds)) { diff --git a/Service/Category/IndexOptionsBuilder.php b/Service/Category/IndexOptionsBuilder.php new file mode 100644 index 000000000..a3a6cc2c5 --- /dev/null +++ b/Service/Category/IndexOptionsBuilder.php @@ -0,0 +1,22 @@ +buildWithComputedIndex(CategoryHelper::INDEX_NAME_SUFFIX, $storeId, $isTmp); + } +} diff --git a/Service/Category/RecordBuilder.php b/Service/Category/RecordBuilder.php index cf40f3e13..d63ddc102 100644 --- a/Service/Category/RecordBuilder.php +++ b/Service/Category/RecordBuilder.php @@ -80,7 +80,7 @@ public function buildRecord(DataObject $entity): array try { $imageUrl = $category->getImageUrl(); - } catch (\Exception $e) { + } catch (\Exception) { /* no image, no default: not fatal */ } diff --git a/Service/IndexNameFetcher.php b/Service/IndexNameFetcher.php index 85f6210ea..f9974172b 100644 --- a/Service/IndexNameFetcher.php +++ b/Service/IndexNameFetcher.php @@ -56,7 +56,7 @@ public function getProductIndexName(int $storeId, bool $tmp = false): string public function isTempIndex($indexName): bool { - return str_ends_with($indexName, self::INDEX_TEMP_SUFFIX); + return str_ends_with((string) $indexName, self::INDEX_TEMP_SUFFIX); } /** @@ -69,7 +69,7 @@ public function isTempIndex($indexName): bool */ public function isQuerySuggestionsIndex($indexName): bool { - return str_ends_with($indexName, self::INDEX_QUERY_SUGGESTIONS_SUFFIX); + return str_ends_with((string) $indexName, self::INDEX_QUERY_SUGGESTIONS_SUFFIX); } } diff --git a/Service/IndexSettingsHandler.php b/Service/IndexSettingsHandler.php new file mode 100644 index 000000000..f17859674 --- /dev/null +++ b/Service/IndexSettingsHandler.php @@ -0,0 +1,83 @@ +config->shouldForwardPrimaryIndexSettingsToReplicas($indexOptions->getStoreId())) { + $this->connector->setSettings( + $indexOptions, + $indexSettings, + false, + true, + $mergeSettingsFrom + ); + return; + } + + [$forward, $noForward] = $this->splitSettings($indexSettings); + if ($forward) { + $this->connector->setSettings( + $indexOptions, + $forward, + true, + false + ); + } + if ($noForward) { + $this->connector->setSettings( + $indexOptions, + $noForward, + false, + true, + $mergeSettingsFrom + ); + } + } + + /** + * Split settings based on whether they should be forwarded to the replicas + * @return array Tuple of settings (to forward and not to forward) + */ + protected function splitSettings(array $settings): array + { + $excludedKeys = array_flip(self::FORWARDING_EXCLUDED_ATTRIBUTES); + return [ + array_diff_key($settings, $excludedKeys), + array_intersect_key($settings, $excludedKeys) + ]; + } + +} diff --git a/Service/Insights/EventProcessor.php b/Service/Insights/EventProcessor.php index 88adb9068..0c2bb2ba1 100644 --- a/Service/Insights/EventProcessor.php +++ b/Service/Insights/EventProcessor.php @@ -11,6 +11,7 @@ use Magento\Sales\Model\Order; use Magento\Sales\Model\Order\Item as OrderItem; use Magento\Store\Model\StoreManagerInterface; +use Magento\Tax\Model\Config as TaxConfig; class EventProcessor implements EventProcessorInterface { @@ -18,6 +19,7 @@ class EventProcessor implements EventProcessorInterface protected const NO_QUERY_ID_KEY = '__NO_QUERY_ID__'; public function __construct( + protected TaxConfig $taxConfig, protected ?InsightsClient $client = null, protected ?string $userToken = null, protected ?string $authenticatedUserToken = null, @@ -128,7 +130,7 @@ private function getCurrentCurrency(): string /** * @inheritDoc */ - public function convertAddToCart(string $eventName, string $indexName, Item $item, string $queryID = null): array + public function convertAddToCart(string $eventName, string $indexName, Item $item, ?string $queryID = null): array { $this->checkDependencies(); @@ -157,7 +159,7 @@ public function convertAddToCart(string $eventName, string $indexName, Item $ite /** * @inheritDoc */ - public function convertPurchaseForItems(string $eventName, string $indexName, array $items, string $queryID = null): array + public function convertPurchaseForItems(string $eventName, string $indexName, array $items, ?string $queryID = null): array { $this->checkDependencies(); @@ -236,9 +238,10 @@ protected function restrictMaxObjectsPerEvent(array $items): array */ protected function getTotalRevenueForEvent(array $objectData): float { - return array_reduce($objectData, function($carry, $item) { - return floatval($carry) + floatval($item['quantity']) * floatval($item['price']); - }); + return array_reduce( + $objectData, + fn($carry, $item) => floatval($carry) + floatval($item['quantity']) * floatval($item['price']) + ); } /** @@ -268,7 +271,9 @@ protected function getQuoteItemDiscount(Item $item): float */ protected function getOrderItemSalePrice(OrderItem $item): float { - return floatval($item->getPrice()) - $this->getOrderItemCartDiscount($item); + return $this->taxConfig->priceIncludesTax($this->storeManager->getStore()->getId()) ? + floatval($item->getPriceInclTax()) - $this->getOrderItemCartDiscount($item): + floatval($item->getPrice()) - $this->getOrderItemCartDiscount($item); } /** @@ -286,7 +291,9 @@ protected function getOrderItemCartDiscount(OrderItem $item): float */ protected function getOrderItemDiscount(OrderItem $item): float { - $itemDiscount = floatval($item->getOriginalPrice()) - floatval($item->getPrice()); + $itemDiscount = $this->taxConfig->priceIncludesTax($this->storeManager->getStore()->getId()) ? + floatval($item->getOriginalPrice()) - floatval($item->getPriceInclTax()) : + floatval($item->getOriginalPrice()) - floatval($item->getPrice()); return $itemDiscount + $this->getOrderItemCartDiscount($item); } @@ -300,13 +307,11 @@ protected function getOrderItemDiscount(OrderItem $item): float */ protected function getObjectDataForPurchase(array $items): array { - return array_map(function($item) { - return [ - 'price' => $this->getOrderItemSalePrice($item), - 'discount' => $this->getOrderItemDiscount($item), - 'quantity' => intval($item->getQtyOrdered()) - ]; - }, $items); + return array_map(fn($item) => [ + 'price' => $this->getOrderItemSalePrice($item), + 'discount' => max(0, $this->getOrderItemDiscount($item)), + 'quantity' => intval($item->getQtyOrdered()) + ], $items); } /** @@ -315,9 +320,7 @@ protected function getObjectDataForPurchase(array $items): array */ protected function getObjectIdsForPurchase(array $items): array { - return array_map(function($item) { - return $item->getProduct()->getId(); - }, $items); + return array_map(fn($item) => $item->getProduct()->getId(), $items); } diff --git a/Service/Page/BatchQueueProcessor.php b/Service/Page/BatchQueueProcessor.php new file mode 100644 index 000000000..6da81d2ee --- /dev/null +++ b/Service/Page/BatchQueueProcessor.php @@ -0,0 +1,71 @@ +dataHelper->isIndexingEnabled($storeId) === false) { + return; + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + if ($this->isPagesInAdditionalSections($storeId)) { + $data = ['storeId' => $storeId]; + if (is_array($entityIds) && count($entityIds) > 0) { + $data['options'] = ['entityIds' => $entityIds]; + } + + /** @uses PageIndexBuilder::buildIndexFull() */ + $this->queue->addToQueue( + PageIndexBuilder::class, + 'buildIndexFull', + $data, + is_array($entityIds) ? count($entityIds) : 1 + ); + } + } + + /** + * @param $storeId + * @return bool + */ + protected function isPagesInAdditionalSections($storeId): bool + { + $sections = $this->configHelper->getAutocompleteSections($storeId); + foreach ($sections as $section) { + if ($section['name'] === 'pages') { + return true; + } + } + + return false; + } +} diff --git a/Service/Page/IndexBuilder.php b/Service/Page/IndexBuilder.php index 3ed38ab80..66dcde8d4 100644 --- a/Service/Page/IndexBuilder.php +++ b/Service/Page/IndexBuilder.php @@ -5,12 +5,11 @@ use Algolia\AlgoliaSearch\Api\Builder\IndexBuilderInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\PageHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder; -use Algolia\AlgoliaSearch\Service\IndexNameFetcher; +use Algolia\AlgoliaSearch\Service\AlgoliaConnector; use Magento\Framework\App\Config\ScopeCodeResolver; use Magento\Framework\Exception\NoSuchEntityException; use Magento\Store\Model\App\Emulation; @@ -18,14 +17,21 @@ class IndexBuilder extends AbstractIndexBuilder implements IndexBuilderInterface { public function __construct( - protected ConfigHelper $configHelper, - protected DiagnosticsLogger $logger, - protected Emulation $emulation, - protected ScopeCodeResolver $scopeCodeResolver, - protected AlgoliaHelper $algoliaHelper, - protected PageHelper $pageHelper + protected ConfigHelper $configHelper, + protected DiagnosticsLogger $logger, + protected Emulation $emulation, + protected ScopeCodeResolver $scopeCodeResolver, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, + protected PageHelper $pageHelper ){ - parent::__construct($configHelper, $logger, $emulation, $scopeCodeResolver, $algoliaHelper); + parent::__construct( + $configHelper, + $logger, + $emulation, + $scopeCodeResolver, + $algoliaConnector + ); } /** @@ -36,7 +42,7 @@ public function __construct( * @throws ExceededRetriesException * @throws NoSuchEntityException */ - public function buildIndexFull(int $storeId, array $options = null): void + public function buildIndexFull(int $storeId, ?array $options = null): void { $this->buildIndex($storeId, $options['entityIds'] ?? null, null); } @@ -61,7 +67,7 @@ public function buildIndex($storeId, ?array $entityIds, ?array $options): void return; } - $indexName = $this->pageHelper->getIndexName($storeId); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); $this->startEmulation($storeId); @@ -74,11 +80,11 @@ public function buildIndex($storeId, ?array $entityIds, ?array $options): void if (isset($pages['toIndex']) && count($pages['toIndex'])) { $pagesToIndex = $pages['toIndex']; - $toIndexName = $indexName . ($isFullReindex ? IndexNameFetcher::INDEX_TEMP_SUFFIX : ''); + $toIndexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId, $isFullReindex); foreach (array_chunk($pagesToIndex, 100) as $chunk) { try { - $this->saveObjects($chunk, $toIndexName, $storeId); + $this->saveObjects($chunk, $toIndexOptions); } catch (\Exception $e) { $this->logger->log($e->getMessage()); continue; @@ -90,7 +96,7 @@ public function buildIndex($storeId, ?array $entityIds, ?array $options): void $pagesToRemove = $pages['toRemove']; foreach (array_chunk($pagesToRemove, 100) as $chunk) { try { - $this->algoliaHelper->deleteObjects($chunk, $indexName, $storeId); + $this->algoliaConnector->deleteObjects($chunk, $indexOptions); } catch (\Exception $e) { $this->logger->log($e->getMessage()); continue; @@ -99,17 +105,14 @@ public function buildIndex($storeId, ?array $entityIds, ?array $options): void } if ($isFullReindex) { - $tempIndexName = $this->pageHelper->getTempIndexName($storeId); - $this->algoliaHelper->copyQueryRules($indexName, $tempIndexName, $storeId); - $this->algoliaHelper->moveIndex($tempIndexName, $indexName, $storeId); + $tempIndexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId, true); + + $this->algoliaConnector->copyQueryRules($indexOptions, $tempIndexOptions); + $this->algoliaConnector->moveIndex($tempIndexOptions, $indexOptions); } - $this->algoliaHelper->setSettings( - $indexName, - $this->pageHelper->getIndexSettings($storeId), - false, - false, - '', - $storeId + $this->algoliaConnector->setSettings( + $indexOptions, + $this->pageHelper->getIndexSettings($storeId) ); } } diff --git a/Service/Page/IndexOptionsBuilder.php b/Service/Page/IndexOptionsBuilder.php new file mode 100644 index 000000000..328960aec --- /dev/null +++ b/Service/Page/IndexOptionsBuilder.php @@ -0,0 +1,22 @@ +buildWithComputedIndex(PageHelper::INDEX_NAME_SUFFIX, $storeId, $isTmp); + } +} diff --git a/Service/Page/RecordBuilder.php b/Service/Page/RecordBuilder.php index 81f03894e..054722058 100644 --- a/Service/Page/RecordBuilder.php +++ b/Service/Page/RecordBuilder.php @@ -71,7 +71,7 @@ protected function strip($s, $completeRemoveTags = []) if ($completeRemoveTags && $completeRemoveTags !== [] && $s) { $dom = new \DOMDocument(); libxml_use_internal_errors(true); - $encodedStr = mb_encode_numericentity($s, [0x80, 0x10fffff, 0, ~0]); + $encodedStr = mb_encode_numericentity((string) $s, [0x80, 0x10fffff, 0, ~0]); $dom->loadHTML($encodedStr); libxml_use_internal_errors(false); @@ -91,13 +91,13 @@ protected function strip($s, $completeRemoveTags = []) $s = $dom->saveHTML(); } - $s = html_entity_decode($s, 0, 'UTF-8'); + $s = html_entity_decode((string) $s, 0, 'UTF-8'); - $s = trim(preg_replace('/\s+/', ' ', $s)); + $s = trim((string) preg_replace('/\s+/', ' ', $s)); $s = preg_replace('/ /', ' ', $s); - $s = preg_replace('!\s+!', ' ', $s); - $s = preg_replace('/\{\{[^}]+\}\}/', ' ', $s); - $s = strip_tags($s); + $s = preg_replace('!\s+!', ' ', (string) $s); + $s = preg_replace('/\{\{[^}]+\}\}/', ' ', (string) $s); + $s = strip_tags((string) $s); $s = trim($s); return $s; diff --git a/Service/Product/BackendSearch.php b/Service/Product/BackendSearch.php index f3cc83219..bbd3dd099 100644 --- a/Service/Product/BackendSearch.php +++ b/Service/Product/BackendSearch.php @@ -3,7 +3,6 @@ namespace Algolia\AlgoliaSearch\Service\Product; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Service\AlgoliaConnector; @@ -14,7 +13,8 @@ class BackendSearch public function __construct( protected ConfigHelper $configHelper, protected ProductHelper $productHelper, - protected AlgoliaHelper $algoliaHelper, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, ){} /** @@ -29,9 +29,9 @@ public function __construct( */ public function getSearchResult(string $query, int $storeId, ?array $searchParams = null, ?string $targetedIndex = null): array { - $indexName = $targetedIndex !== null ? - $targetedIndex : - $this->productHelper->getIndexName($storeId); + $indexOptions = $targetedIndex !== null ? + $this->indexOptionsBuilder->buildWithEnforcedIndex($targetedIndex, $storeId) : + $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); $numberOfResults = 1000; if ($this->configHelper->isInstantEnabled()) { @@ -59,7 +59,7 @@ public function getSearchResult(string $query, int $storeId, ?array $searchParam $params = array_merge($params, $searchParams); } - $response = $this->algoliaHelper->query($indexName, $query, $params, $storeId); + $response = $this->algoliaConnector->query($indexOptions, $query, $params); $answer = reset($response['results']); $data = []; diff --git a/Service/Product/BatchQueueProcessor.php b/Service/Product/BatchQueueProcessor.php new file mode 100644 index 000000000..15462e5d3 --- /dev/null +++ b/Service/Product/BatchQueueProcessor.php @@ -0,0 +1,140 @@ +dataHelper->isIndexingEnabled($storeId) === false) { + return; + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + if ($entityIds && !$this->areParentsLoaded) { + $entityIds = array_unique(array_merge($entityIds, $this->productHelper->getParentProductIds($entityIds))); + $this->areParentsLoaded = true; + } + + $productsPerPage = $this->configHelper->getNumberOfElementByPage(); + + if (is_array($entityIds) && count($entityIds) > 0) { + foreach (array_chunk($entityIds, $productsPerPage) as $chunk) { + /** @uses ProductIndexBuilder::buildIndexList() */ + $this->queue->addToQueue( + ProductIndexBuilder::class, + 'buildIndexList', + ['storeId' => $storeId, 'entityIds' => $chunk], + count($chunk) + ); + } + + return; + } + + $useTmpIndex = $this->configHelper->isQueueActive($storeId); + $onlyVisible = !$this->configHelper->includeNonVisibleProductsInIndex(); + $collection = $this->productHelper->getProductCollectionQuery($storeId, $entityIds, $onlyVisible); + + $timerName = __METHOD__ . ' (Get product collection size)'; + $this->diag->startProfiling($timerName); + $size = $collection->getSize(); + $this->diag->stopProfiling($timerName); + + $pages = ceil($size / $productsPerPage); + + /** @uses IndicesConfigurator::saveConfigurationToAlgolia() */ + $this->queue->addToQueue(IndicesConfigurator::class, 'saveConfigurationToAlgolia', [ + 'storeId' => $storeId, + 'useTmpIndex' => $useTmpIndex, + ], 1, true); + for ($i = 1; $i <= $pages; $i++) { + $data = [ + 'storeId' => $storeId, + 'options' => [ + 'entityIds' => $entityIds, + 'page' => $i, + 'pageSize' => $productsPerPage, + 'useTmpIndex' => $useTmpIndex, + ] + ]; + + /** @uses ProductIndexBuilder::buildIndexFull() */ + $this->queue->addToQueue( + ProductIndexBuilder::class, + 'buildIndexFull', + $data, + $productsPerPage, + true + ); + } + + if ($useTmpIndex) { + /** @uses IndexMover::moveIndexWithSetSettings() */ + $this->queue->addToQueue(IndexMover::class, 'moveIndexWithSetSettings', [ + 'tmpIndexName' => $this->productHelper->getTempIndexName($storeId), + 'indexName' => $this->productHelper->getIndexName($storeId), + 'storeId' => $storeId, + ], 1, true); + } + } + + /** + * @param int $storeId + * @return void + * @throws NoSuchEntityException + * @throws AlgoliaException + */ + public function deleteInactiveProducts(int $storeId): void + { + if ($this->dataHelper->isIndexingEnabled($storeId) === false) { + return; + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + $this->productIndexBuilder->deleteInactiveProducts($storeId); + } +} diff --git a/Service/Product/FacetBuilder.php b/Service/Product/FacetBuilder.php new file mode 100644 index 000000000..244e464aa --- /dev/null +++ b/Service/Product/FacetBuilder.php @@ -0,0 +1,298 @@ + $this->decorateAttributeForFaceting($facet), + $this->addMerchandisingFacets($storeId, $this->getRawFacets($storeId)) + ); + } + + /** + * Return the configuration to be used for the store product index `renderingContent` + * @param int $storeId - The store ID for the index to be configured + * @return array|null + * @throws LocalizedException + * @throws NoSuchEntityException + */ + public function getRenderingContent(int $storeId): ?array + { + $facets = $this->getRawFacets($storeId); + if (empty($facets)) { + return null; + } + $attributes = $this->getRenderingContentAttributes($this->extractFacetAttributeNames($facets)); + return [ + 'facetOrdering' => [ + 'facets' => [ + 'order' => $attributes + ], + 'values' => $this->getRenderingContentValues($attributes) + ], + ]; + } + + /** + * For an array of facet data, return an array of attribute names only + * + * @param array> $facets + * @return string[] + */ + protected function extractFacetAttributeNames(array $facets): array + { + return array_map( + fn($facet) => $facet[self::FACET_KEY_ATTRIBUTE_NAME], + $facets + ); + } + + /** + * Format the facet data to be : renderingContent > facetOrdering > values + * @param string[] $attributes + * @return array - Array key is the attribute name and the value is an object containing a `sortRemainingBy` value + */ + protected function getRenderingContentValues(array $attributes): array + { + return array_combine( + $attributes, + array_fill(0, count($attributes), [ 'sortRemainingBy' => 'alpha' ]) + ); + } + + /** + * Take raw facet (common) attributes and convert to include attributes specifically needed for `renderingContent` + * @param string[] $facets + * @return string[] + */ + protected function getRenderingContentAttributes(array $facets): array + { + return array_map( + function(string $attribute) { + if ($attribute === self::FACET_ATTRIBUTE_CATEGORIES) { + $attribute = $this->getCategoryAttributeNameForRenderingContent(); + } + return $attribute; + }, + $facets + ); + } + + /** + * `renderingContent` cannot utilize the entire categories object but instead must reference a scalar value + * Obtaining the root level of the category data will enable it to become selectable in the Algolia Dashboard + * for "Facet Display" and "Order facets" within merchandising rules + * + * @return string + */ + protected function getCategoryAttributeNameForRenderingContent(): string + { + return self::FACET_ATTRIBUTE_CATEGORIES . '.level0'; + } + + /** + * Return an associative array for an attribute that mimics the minimum structure used by the Magento configuration + * + * @param string $attribute + * @param bool $searchable + * @return array{attribute: string, searchable: string} + */ + protected function getRawFacet(string $attribute, bool $searchable = false): array + { + return [ + self::FACET_KEY_ATTRIBUTE_NAME => $attribute, + self::FACET_KEY_SEARCHABLE => $searchable ? self::FACET_SEARCHABLE_SEARCHABLE : self::FACET_SEARCHABLE_NOT_SEARCHABLE, + ]; + } + + /** + * Generates common data to be used for both `attributesForFaceting` and `renderingContent` + * + * @return array> + * @throws NoSuchEntityException + * @throws LocalizedException + */ + protected function getRawFacets(int $storeId): array + { + if (isset($this->facets[$storeId])) { + return $this->facets[$storeId]; + } + + $rawFacets = []; + $configFacets = $this->configHelper->getFacets($storeId); + foreach ($configFacets as $configFacet) { + if ($configFacet[self::FACET_KEY_ATTRIBUTE_NAME] === self::FACET_ATTRIBUTE_PRICE) { + $rawFacets = array_merge($rawFacets, array_map( + fn(string $attribute) => $this->getRawFacet($attribute), + $this->getPricingAttributes($storeId) + )); + } else { + $rawFacets[] = $configFacet; + } + } + + $this->facets[$storeId] = $this->assertCategoryFacet($storeId, $rawFacets); + + return $this->facets[$storeId]; + } + + /** + * Does a given array of facets include a category facet? + * + * @param array> $facets + * @return bool + */ + protected function hasCategoryFacet(array $facets): bool + { + return !!array_filter($facets, fn($facet) => $facet['attribute'] === self::FACET_ATTRIBUTE_CATEGORIES); + } + + /** + * Applies the category facet if not manually configured but necessary for category functionality + * (The presence of the category facet drives logic for `attributesForFaceting` and `renderingContent`) + * + * @param int $storeId + * @param array> $facets + * @return array> + */ + protected function assertCategoryFacet(int $storeId, array $facets): array + { + if ($this->configHelper->replaceCategories($storeId) + && !$this->hasCategoryFacet($facets) + ) { + $facets[] = $this->getRawFacet(self::FACET_ATTRIBUTE_CATEGORIES); + } + + return $facets; + } + + /** + * Add merchandising facets as needed for `attributesForFaceting` + * + * @param int $storeId + * @param array> $facets + * @return array|string[] + */ + protected function addMerchandisingFacets(int $storeId, array $facets): array + { + if ($this->hasCategoryFacet($facets)) { + $facets[] = $this->getRawFacet($this->getCategoryAttributeNameForRenderingContent()); + } + + // Used for legacy merchandising features - always required! + $facets[] = $this->getRawFacet(self::FACET_ATTRIBUTES_CATEGORY_ID); + + if ($this->configHelper->isVisualMerchEnabled($storeId)) { + // Must be searchable per https://www.algolia.com/doc/guides/solutions/ecommerce/browse/tutorials/category-pages/#configure-your-index + $facets[] = $this->getRawFacet($this->configHelper->getCategoryPageIdAttributeName($storeId), true); + } + + return $facets; + } + + /** + * Get an array of pricing attribute names based on currency and customer group configuration + * + * @param int $storeId + * @return string[] + * @throws NoSuchEntityException + * @throws LocalizedException + */ + protected function getPricingAttributes(int $storeId): array + { + $pricingAttributes = []; + $currencies = $this->configHelper->getAllowedCurrencies($storeId); + foreach ($currencies as $currencyCode) { + $pricingAttributes[] = self::FACET_ATTRIBUTE_PRICE . '.' . $currencyCode . '.default'; + $pricingAttributes = array_merge($pricingAttributes, $this->getGroupPricingAttributes($storeId, $currencyCode)); + } + + return $pricingAttributes; + } + + /** + * Get an array of pricing attribute names based on customer group configuration + * + * @param int $storeId + * @param string $currencyCode + * @return string[] + * @throws NoSuchEntityException + * @throws LocalizedException + */ + protected function getGroupPricingAttributes(int $storeId, string $currencyCode): array + { + $groupPricingAttributes = []; + if ($this->configHelper->isCustomerGroupsEnabled($storeId)) { + $websiteId = (int) $this->storeManager->getStore($storeId)->getWebsiteId(); + foreach ($this->groupCollection as $group) { + $groupId = (int) $group->getData('customer_group_id'); + $excludedWebsites = $this->groupExcludedWebsiteRepository->getCustomerGroupExcludedWebsites($groupId); + if (in_array($websiteId, $excludedWebsites)) { + continue; + } + $groupPricingAttributes[] = self::FACET_ATTRIBUTE_PRICE . '.' . $currencyCode . '.group_' . $groupId; + } + } + return $groupPricingAttributes; + } + + + /** + * Format the `attributesForFaceting` values based on modifiers defined at: + * https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers + * @param array $facet + * @return string + */ + protected function decorateAttributeForFaceting(array $facet): string + { + $attribute = $facet[self::FACET_KEY_ATTRIBUTE_NAME]; + if (array_key_exists(self::FACET_KEY_SEARCHABLE, $facet)) { + if ($facet[self::FACET_KEY_SEARCHABLE] == self::FACET_SEARCHABLE_SEARCHABLE) { + $attribute = 'searchable(' . $attribute . ')'; + } elseif ($facet[self::FACET_KEY_SEARCHABLE] == self::FACET_SEARCHABLE_FILTER_ONLY) { + $attribute = 'filterOnly(' . $attribute . ')'; + } + } + return $attribute; + } + +} diff --git a/Service/Product/IndexBuilder.php b/Service/Product/IndexBuilder.php index ca0f0b748..231f79459 100644 --- a/Service/Product/IndexBuilder.php +++ b/Service/Product/IndexBuilder.php @@ -5,13 +5,13 @@ use Algolia\AlgoliaSearch\Api\Builder\UpdatableIndexBuilderInterface; use Algolia\AlgoliaSearch\Exception\ProductReindexingException; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Helper\ProductDataArray; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder; use Algolia\AlgoliaSearch\Service\AlgoliaConnector; +use Algolia\AlgoliaSearch\Service\Product\RecordBuilder as ProductRecordBuilder; use Magento\Catalog\Model\ResourceModel\Product\Collection; use Magento\Framework\App\Config\ScopeCodeResolver; use Magento\Framework\App\ResourceConnection; @@ -31,14 +31,22 @@ public function __construct( protected DiagnosticsLogger $logger, protected Emulation $emulation, protected ScopeCodeResolver $scopeCodeResolver, - protected AlgoliaHelper $algoliaHelper, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, protected ProductHelper $productHelper, + protected ProductRecordBuilder $productRecordBuilder, protected ResourceConnection $resource, protected ManagerInterface $eventManager, protected MissingPriceIndexHandler $missingPriceIndexHandler, IndexerRegistry $indexerRegistry ){ - parent::__construct($configHelper, $logger, $emulation, $scopeCodeResolver, $algoliaHelper); + parent::__construct( + $configHelper, + $logger, + $emulation, + $scopeCodeResolver, + $algoliaConnector + ); $this->priceIndexer = $indexerRegistry->get('catalog_product_price'); } @@ -50,7 +58,7 @@ public function __construct( * @throws LocalizedException * @throws NoSuchEntityException */ - public function buildIndexFull(int $storeId, array $options = null): void + public function buildIndexFull(int $storeId, ?array $options = null): void { $this->buildIndex($storeId, null, $options); } @@ -63,7 +71,7 @@ public function buildIndexFull(int $storeId, array $options = null): void * @throws LocalizedException * @throws NoSuchEntityException */ - public function buildIndexList(int $storeId, array $entityIds = null, array $options = null): void + public function buildIndexList(int $storeId, ?array $entityIds = null, ?array $options = null): void { $this->buildIndex($storeId, $entityIds, $options); } @@ -154,26 +162,26 @@ protected function rebuildEntityIds(int $storeId, array $productIds): void */ public function deleteInactiveProducts($storeId): void { - $indexName = $this->productHelper->getIndexName($storeId); - $client = $this->algoliaHelper->getClient($storeId); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); + $client = $this->algoliaConnector->getClient($storeId); $objectIds = []; $counter = 0; $browseOptions = [ 'query' => '', 'attributesToRetrieve' => [AlgoliaConnector::ALGOLIA_API_OBJECT_ID], ]; - $hits = $client->browseObjects($indexName, $browseOptions); + $hits = $client->browseObjects($indexOptions->getIndexName(), $browseOptions); foreach ($hits as $hit) { $objectIds[] = $hit[AlgoliaConnector::ALGOLIA_API_OBJECT_ID]; $counter++; if ($counter === 1000) { - $this->deleteInactiveIds($storeId, $objectIds, $indexName); + $this->deleteInactiveIds($storeId, $objectIds, $indexOptions); $objectIds = []; $counter = 0; } } if (!empty($objectIds)) { - $this->deleteInactiveIds($storeId, $objectIds, $indexName); + $this->deleteInactiveIds($storeId, $objectIds, $indexOptions); } } @@ -217,7 +225,7 @@ protected function buildIndexPage( $collection->addCategoryIds(); $collection->addUrlRewrite(); - if ($this->productHelper->isAttributeEnabled($additionalAttributes, 'rating_summary')) { + if ($this->productRecordBuilder->isAttributeEnabled($additionalAttributes, 'rating_summary')) { $reviewTableName = $this->resource->getTableName('review_entity_summary'); $collection ->getSelect() @@ -243,20 +251,20 @@ protected function buildIndexPage( $collection->load(); $this->logger->log('Loaded ' . count($collection) . ' products'); $this->logger->stop($logMessage); - $indexName = $this->productHelper->getIndexName($storeId, $useTmpIndex); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId, $useTmpIndex); $indexData = $this->getProductsRecords($storeId, $collection, $productIds); if (!empty($indexData['toIndex'])) { $this->logger->start('ADD/UPDATE TO ALGOLIA'); - $this->saveObjects($indexData['toIndex'], $indexName, $storeId); + $this->saveObjects($indexData['toIndex'], $indexOptions); $this->logger->log('Product IDs: ' . implode(', ', array_keys($indexData['toIndex']))); $this->logger->stop('ADD/UPDATE TO ALGOLIA'); } if (!empty($indexData['toRemove'])) { - $toRealRemove = $this->getIdsToRealRemove($indexName, $indexData['toRemove'], $storeId); + $toRealRemove = $this->getIdsToRealRemove($indexOptions, $indexData['toRemove']); if (!empty($toRealRemove)) { $this->logger->start('REMOVE FROM ALGOLIA'); - $this->algoliaHelper->deleteObjects($toRealRemove, $indexName, $storeId); + $this->algoliaConnector->deleteObjects($toRealRemove, $indexOptions); $this->logger->log('Product IDs: ' . implode(', ', $toRealRemove)); $this->logger->stop('REMOVE FROM ALGOLIA'); } @@ -323,8 +331,8 @@ protected function getProductsRecords($storeId, $collection, $potentiallyDeleted try { $this->logger->startProfiling("canProductBeReindexed"); - $this->productHelper->canProductBeReindexed($product, $storeId); - } catch (ProductReindexingException $e) { + $this->productRecordBuilder->canProductBeReindexed($product, $storeId); + } catch (ProductReindexingException) { $productsToRemove[$productId] = $productId; continue; } finally { @@ -342,7 +350,7 @@ protected function getProductsRecords($storeId, $collection, $potentiallyDeleted } } - $productsToIndex[$productId] = $this->productHelper->getObject($product); + $productsToIndex[$productId] = $this->productRecordBuilder->buildRecord($product); } if (is_array($potentiallyDeletedProductsIds)) { @@ -365,8 +373,8 @@ protected function getSalesData($storeId, Collection $collection): array { $this->logger->startProfiling(__METHOD__); $additionalAttributes = $this->configHelper->getProductAdditionalAttributes($storeId); - if ($this->productHelper->isAttributeEnabled($additionalAttributes, 'ordered_qty') === false - && $this->productHelper->isAttributeEnabled($additionalAttributes, 'total_ordered') === false) { + if ($this->productRecordBuilder->isAttributeEnabled($additionalAttributes, 'ordered_qty') === false + && $this->productRecordBuilder->isAttributeEnabled($additionalAttributes, 'total_ordered') === false) { return []; } @@ -376,7 +384,7 @@ protected function getSalesData($storeId, Collection $collection): array $ordersTableName = $this->resource->getTableName('sales_order_item'); try { $salesConnection = $this->resource->getConnectionByName('sales'); - } catch (\DomainException $e) { + } catch (\DomainException) { $salesConnection = $this->resource->getConnection(); } $select = $salesConnection->select() @@ -395,18 +403,18 @@ protected function getSalesData($storeId, Collection $collection): array /** * @param $storeId * @param $objectIds - * @param $indexName + * @param $indexOptions * @return void * @throws AlgoliaException */ - protected function deleteInactiveIds($storeId, $objectIds, $indexName): void + protected function deleteInactiveIds($storeId, $objectIds, $indexOptions): void { $onlyVisible = !$this->configHelper->includeNonVisibleProductsInIndex($storeId); $collection = $this->productHelper->getProductCollectionQuery($storeId, $objectIds, $onlyVisible); $dbIds = $collection->getAllIds(); $collection = null; $idsToDeleteFromAlgolia = array_diff($objectIds, $dbIds); - $this->algoliaHelper->deleteObjects($idsToDeleteFromAlgolia, $indexName, $storeId); + $this->algoliaConnector->deleteObjects($idsToDeleteFromAlgolia, $indexOptions); } /** diff --git a/Service/Product/RecordBuilder.php b/Service/Product/RecordBuilder.php index 78d046ad4..5c4a59e92 100644 --- a/Service/Product/RecordBuilder.php +++ b/Service/Product/RecordBuilder.php @@ -10,13 +10,13 @@ use Algolia\AlgoliaSearch\Exception\ProductOutOfStockException; use Algolia\AlgoliaSearch\Exception\ProductReindexingException; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\CategoryHelper; use Algolia\AlgoliaSearch\Helper\Entity\Product\PriceManager; use Algolia\AlgoliaSearch\Helper\Image as ImageHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Algolia\AlgoliaSearch\Service\AlgoliaConnector; +use Algolia\AlgoliaSearch\Service\Category\RecordBuilder as CategoryRecordBuilder; use Magento\Bundle\Model\Product\Type as BundleProductType; use Magento\Catalog\Api\Data\ProductInterface; use Magento\Catalog\Model\Product; @@ -49,7 +49,8 @@ public function __construct( protected StoreManagerInterface $storeManager, protected ConfigHelper $configHelper, protected CategoryHelper $categoryHelper, - protected AlgoliaHelper $algoliaHelper, + protected CategoryRecordBuilder $categoryRecordBuilder, + protected AlgoliaConnector $algoliaConnector, protected ImageHelper $imageHelper, protected StockRegistryInterface $stockRegistry, protected PriceManager $priceManager, @@ -134,7 +135,7 @@ public function buildRecord(DataObject $entity): array ); $customData = $transport->getData(); $customData = array_merge($customData, $defaultData); - $this->algoliaHelper->castProductObject($customData); + $this->algoliaConnector->castProductObject($customData); $transport = new DataObject($customData); $this->eventManager->dispatch( 'algolia_after_create_product_object', @@ -415,7 +416,7 @@ protected function buildCategoryData(Product $product): array public function getAllCategories($categoryIds, $storeId): array { $filterNotIncludedCategories = !$this->configHelper->showCatsNotIncludedInNavigation($storeId); - $categories = $this->categoryHelper->getCoreCategories($filterNotIncludedCategories, $storeId); + $categories = $this->categoryRecordBuilder->getCoreCategories($filterNotIncludedCategories, $storeId); $selectedCategories = []; foreach ($categoryIds as $id) { @@ -437,7 +438,7 @@ public function getAllCategories($categoryIds, $storeId): array */ protected function getValidCategoryName($category, $rootCat, $storeId): ?string { - $pathParts = explode('/', $category->getPath()); + $pathParts = explode('/', (string) $category->getPath()); if (isset($pathParts[1]) && $pathParts[1] !== $rootCat) { return null; } @@ -523,7 +524,7 @@ protected function autoAnchorParentCategories(array $paths): array { protected function flattenCategoryPaths(array $paths, int $storeId): array { return array_map( - function ($path) use ($storeId) { return implode($this->configHelper->getCategorySeparator($storeId), $path); }, + fn($path) => implode($this->configHelper->getCategorySeparator($storeId), $path), $paths ); } @@ -758,7 +759,7 @@ protected function getValues($valueText, Product $subProduct, AttributeResource */ protected function addSubProductImage($subProductImages, $attribute, $subProduct, $valueText) { - if (mb_strtolower($attribute['attribute'], 'utf-8') !== 'color') { + if (mb_strtolower((string) $attribute['attribute'], 'utf-8') !== 'color') { return $subProductImages; } @@ -775,7 +776,7 @@ protected function addSubProductImage($subProductImages, $attribute, $subProduct } try { - $textValueInLower = mb_strtolower($valueText, 'utf-8'); + $textValueInLower = mb_strtolower((string) $valueText, 'utf-8'); $subProductImages[$textValueInLower] = $image->getUrl(); } catch (\Exception $e) { $this->logger->log($e->getMessage()); diff --git a/Service/Product/ReplicaManager.php b/Service/Product/ReplicaManager.php index 3dcafc802..6121de3b5 100644 --- a/Service/Product/ReplicaManager.php +++ b/Service/Product/ReplicaManager.php @@ -168,9 +168,7 @@ protected function getMagentoReplicaSettings(string $baseIndexName, array $algol { return array_filter( $algoliaReplicas, - function ($algoliaReplicaSetting) use ($baseIndexName) { - return $this->isMagentoReplicaIndex($this->getBareIndexNameFromReplicaSetting($algoliaReplicaSetting), $baseIndexName); - } + fn($algoliaReplicaSetting) => $this->isMagentoReplicaIndex($this->getBareIndexNameFromReplicaSetting($algoliaReplicaSetting), $baseIndexName) ); } @@ -355,9 +353,7 @@ protected function revertReplicaConfig(int $storeId): bool protected function getBareIndexNamesFromReplicaSetting(array $replicas): array { return array_map( - function ($str) { - return $this->getBareIndexNameFromReplicaSetting($str); - }, + fn($str) => $this->getBareIndexNameFromReplicaSetting($str), $replicas ); } @@ -446,9 +442,7 @@ protected function removeReplicaFromReplicaSetting(array $replicaSetting, string return array_values( array_filter( $replicaSetting, - function ($replicaIndexSetting) use ($regex) { - return !preg_match($regex, $replicaIndexSetting); - } + fn($replicaIndexSetting) => !preg_match($regex, (string) $replicaIndexSetting) ) ); } @@ -468,9 +462,7 @@ protected function configureRanking(int $storeId, array $replicas, array $primar $sortingIndices = $this->sortingTransformer->getSortingIndices($storeId); $replicaDetails = array_filter( $sortingIndices, - function($replica) use ($replicas) { - return in_array($replica['name'], $replicas); - } + fn($replica) => in_array($replica['name'], $replicas) ); foreach ($replicaDetails as $replica) { $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($replica['name'], $storeId); @@ -494,7 +486,7 @@ function($replica) use ($replicas) { */ public function isReplicaSyncEnabled(int $storeId): bool { - return $this->configHelper->isInstantEnabled($storeId) && $this->configHelper->isEnabledBackend($storeId); + return $this->configHelper->isInstantEnabled($storeId) && $this->configHelper->isIndexingEnabled($storeId); } /** diff --git a/Service/Serializer.php b/Service/Serializer.php new file mode 100644 index 000000000..f9b2ffeaa --- /dev/null +++ b/Service/Serializer.php @@ -0,0 +1,52 @@ +serializer->serialize($value); + return is_string($result) ? $result : ''; + } + + /** + * This deserializes the argument by first attempting to perform a quick JSON decode + * before falling back to the Magento framework serializer object + * + * Note that if the argument value is falsey then it will return false + * (This is legacy behavior) + * + * @param $value + * @return mixed Returns false if argument supplied is falsey - otherwise returns the deserialized object + */ + public function unserialize($value): mixed + { + if (in_array($value, [false, null, ''], true)) { + return false; + } + + $unserialized = json_decode((string) $value, true); + if (json_last_error() === JSON_ERROR_NONE) { + return $unserialized; + } + return $this->serializer->unserialize($value); + } +} diff --git a/Service/StoreNameFetcher.php b/Service/StoreNameFetcher.php index de8b6f285..be959548e 100644 --- a/Service/StoreNameFetcher.php +++ b/Service/StoreNameFetcher.php @@ -34,9 +34,7 @@ public function getStoreName(int $storeId): string public function getStoreNames(array $storeIds): array { return array_map( - function($storeId) { - return $this->getStoreName($storeId); - }, + fn($storeId) => $this->getStoreName($storeId), $storeIds ); } diff --git a/Service/Suggestion/BatchQueueProcessor.php b/Service/Suggestion/BatchQueueProcessor.php new file mode 100644 index 000000000..132190ca7 --- /dev/null +++ b/Service/Suggestion/BatchQueueProcessor.php @@ -0,0 +1,39 @@ +dataHelper->isIndexingEnabled($storeId) === false) { + return; + } + + if (!$this->algoliaCredentialsManager->checkCredentialsWithSearchOnlyAPIKey($storeId)) { + $this->algoliaCredentialsManager->displayErrorMessage(self::class, $storeId); + + return; + } + + /** @uses SuggestionIndexBuilder::buildIndexFull() */ + $this->queue->addToQueue( + SuggestionIndexBuilder::class, + 'buildIndexFull', + ['storeId' => $storeId], + 1 + ); + } +} diff --git a/Service/Suggestion/IndexBuilder.php b/Service/Suggestion/IndexBuilder.php index c7c138757..779344683 100644 --- a/Service/Suggestion/IndexBuilder.php +++ b/Service/Suggestion/IndexBuilder.php @@ -5,11 +5,12 @@ use Algolia\AlgoliaSearch\Api\Builder\IndexBuilderInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\SuggestionHelper; use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger; use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder; +use Algolia\AlgoliaSearch\Service\AlgoliaConnector; +use Algolia\AlgoliaSearch\Service\Suggestion\RecordBuilder as SuggestionRecordBuilder; use Magento\Framework\App\Config\ScopeCodeResolver; use Magento\Framework\Exception\NoSuchEntityException; use Magento\Search\Model\Query; @@ -19,14 +20,22 @@ class IndexBuilder extends AbstractIndexBuilder implements IndexBuilderInterface { public function __construct( - protected ConfigHelper $configHelper, - protected DiagnosticsLogger $logger, - protected Emulation $emulation, - protected ScopeCodeResolver $scopeCodeResolver, - protected AlgoliaHelper $algoliaHelper, - protected SuggestionHelper $suggestionHelper + protected ConfigHelper $configHelper, + protected DiagnosticsLogger $logger, + protected Emulation $emulation, + protected ScopeCodeResolver $scopeCodeResolver, + protected AlgoliaConnector $algoliaConnector, + protected IndexOptionsBuilder $indexOptionsBuilder, + protected SuggestionHelper $suggestionHelper, + protected SuggestionRecordBuilder $suggestionRecordBuilder ){ - parent::__construct($configHelper, $logger, $emulation, $scopeCodeResolver, $algoliaHelper); + parent::__construct( + $configHelper, + $logger, + $emulation, + $scopeCodeResolver, + $algoliaConnector + ); } /** @@ -37,7 +46,7 @@ public function __construct( * @throws ExceededRetriesException * @throws NoSuchEntityException */ - public function buildIndexFull(int $storeId, array $options = null): void + public function buildIndexFull(int $storeId, ?array $options = null): void { $this->buildIndex($storeId, null, null); } @@ -102,19 +111,19 @@ protected function rebuildStoreSuggestionIndexPage(int $storeId, QueryCollection $collection = clone $collectionDefault; $collection->setCurPage($page)->setPageSize($pageSize); $collection->load(); - $indexName = $this->suggestionHelper->getTempIndexName($storeId); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); $indexData = []; /** @var Query $suggestion */ foreach ($collection as $suggestion) { $suggestion->setStoreId($storeId); - $suggestionObject = $this->suggestionHelper->getObject($suggestion); - if (mb_strlen($suggestionObject['query']) >= 3) { + $suggestionObject = $this->suggestionRecordBuilder->buildRecord($suggestion); + if (mb_strlen((string) $suggestionObject['query']) >= 3) { array_push($indexData, $suggestionObject); } } if (count($indexData) > 0) { - $this->saveObjects($indexData, $indexName, $storeId); + $this->saveObjects($indexData, $indexOptions); } unset($indexData); @@ -135,9 +144,11 @@ protected function moveStoreSuggestionIndex(int $storeId): void if ($this->isIndexingEnabled($storeId) === false) { return; } - $tmpIndexName = $this->suggestionHelper->getTempIndexName($storeId); - $indexName = $this->suggestionHelper->getIndexName($storeId); - $this->algoliaHelper->copyQueryRules($indexName, $tmpIndexName, $storeId); - $this->algoliaHelper->moveIndex($tmpIndexName, $indexName, $storeId); + + $tmpIndexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId, true); + $indexOptions = $this->indexOptionsBuilder->buildEntityIndexOptions($storeId); + + $this->algoliaConnector->copyQueryRules($indexOptions, $tmpIndexOptions); + $this->algoliaConnector->moveIndex($tmpIndexOptions, $indexOptions); } } diff --git a/Service/Suggestion/IndexOptionsBuilder.php b/Service/Suggestion/IndexOptionsBuilder.php new file mode 100644 index 000000000..054592b89 --- /dev/null +++ b/Service/Suggestion/IndexOptionsBuilder.php @@ -0,0 +1,22 @@ +buildWithComputedIndex(SuggestionHelper::INDEX_NAME_SUFFIX, $storeId, $isTmp); + } +} diff --git a/Service/Suggestion/RecordBuilder.php b/Service/Suggestion/RecordBuilder.php index 17c1184b4..a669b81db 100644 --- a/Service/Suggestion/RecordBuilder.php +++ b/Service/Suggestion/RecordBuilder.php @@ -26,7 +26,7 @@ public function buildRecord(DataObject $entity): array 'query' => $entity->getData('query_text'), 'number_of_results' => (int) $entity->getData('num_results'), 'popularity' => (int) $entity->getData('popularity'), - 'updated_at' => (int) strtotime($entity->getData('updated_at')), + 'updated_at' => (int) strtotime((string) $entity->getData('updated_at')), ]; $transport = new DataObject($suggestionObject); diff --git a/Setup/Patch/Data/MigrateConversionAnalyticsModePatch.php b/Setup/Patch/Data/MigrateConversionAnalyticsModePatch.php index b52ad9136..b7eac7826 100644 --- a/Setup/Patch/Data/MigrateConversionAnalyticsModePatch.php +++ b/Setup/Patch/Data/MigrateConversionAnalyticsModePatch.php @@ -40,7 +40,7 @@ public function apply(): PatchInterface { $this->moduleDataSetup->getConnection()->startSetup(); - $this->configChecker->checkAndApplyAllScopes(ConfigHelper::CC_CONVERSION_ANALYTICS_MODE, [$this, 'migrateSetting']); + $this->configChecker->checkAndApplyAllScopes(ConfigHelper::CC_CONVERSION_ANALYTICS_MODE, $this->migrateSetting(...)); $this->moduleDataSetup->getConnection()->endSetup(); diff --git a/Setup/Patch/Data/MigrateIndexingConfigPatch.php b/Setup/Patch/Data/MigrateIndexingConfigPatch.php new file mode 100644 index 000000000..172e749d0 --- /dev/null +++ b/Setup/Patch/Data/MigrateIndexingConfigPatch.php @@ -0,0 +1,65 @@ +moduleDataSetup->getConnection()->startSetup(); + + $this->moveIndexingSettings(); + + $this->moduleDataSetup->getConnection()->endSetup(); + + return $this; + } + + /** + * Migrate old Indexing configurations + * @return void + */ + protected function moveIndexingSettings(): void + { + $movedConfig = [ + 'algoliasearch_credentials/credentials/enable_backend' => ConfigHelper::ENABLE_INDEXING, + 'algoliasearch_credentials/credentials/enable_query_suggestions_index' => ConfigHelper::ENABLE_QUERY_SUGGESTIONS_INDEX, + 'algoliasearch_credentials/credentials/enable_pages_index' => ConfigHelper::ENABLE_PAGES_INDEX, + ]; + + $connection = $this->moduleDataSetup->getConnection(); + foreach ($movedConfig as $from => $to) { + $configDataTable = $this->moduleDataSetup->getTable('core_config_data'); + $whereConfigPath = $connection->quoteInto('path = ?', $from); + $connection->update($configDataTable, ['path' => $to], $whereConfigPath); + } + } + + /** + * @inheritDoc + */ + public static function getDependencies(): array + { + return []; + } + + /** + * @inheritDoc + */ + public function getAliases(): array + { + return []; + } +} diff --git a/Setup/Patch/Data/MigrateVirtualReplicaConfigPatch.php b/Setup/Patch/Data/MigrateVirtualReplicaConfigPatch.php index 6cd547f9d..9075c9032 100644 --- a/Setup/Patch/Data/MigrateVirtualReplicaConfigPatch.php +++ b/Setup/Patch/Data/MigrateVirtualReplicaConfigPatch.php @@ -48,7 +48,7 @@ public function apply(): PatchInterface { $this->moduleDataSetup->getConnection()->startSetup(); - $this->configChecker->checkAndApplyAllScopes(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, [$this, 'migrateSetting']); + $this->configChecker->checkAndApplyAllScopes(ConfigHelper::LEGACY_USE_VIRTUAL_REPLICA_ENABLED, $this->migrateSetting(...)); $this->scopeConfig->reinit(); diff --git a/Setup/Patch/Data/RebuildReplicasPatch.php b/Setup/Patch/Data/RebuildReplicasPatch.php index 06ac39278..1bb550784 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\Api\LoggerInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper; use Algolia\AlgoliaSearch\Registry\ReplicaState; use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager; @@ -16,7 +16,6 @@ use Magento\Framework\Setup\Patch\DataPatchInterface; use Magento\Framework\Setup\Patch\PatchInterface; use Magento\Store\Model\StoreManagerInterface; -use Psr\Log\LoggerInterface; class RebuildReplicasPatch implements DataPatchInterface { @@ -73,7 +72,7 @@ public function apply(): PatchInterface $this->replicaState->setChangeState(ReplicaState::REPLICA_STATE_CHANGED, $storeId); // avoids latency $this->replicaManager->syncReplicasToAlgolia($storeId, $this->productHelper->getIndexSettings($storeId)); } - } catch (AlgoliaException $e) { + } catch (AlgoliaException) { // Log the error but do not prevent setup:update $this->logger->error("Could not rebuild replicas - a full reindex may be required."); } diff --git a/Setup/Patch/Data/UpdateMviewPatch.php b/Setup/Patch/Data/UpdateMviewPatch.php index f206223d3..018b7f968 100644 --- a/Setup/Patch/Data/UpdateMviewPatch.php +++ b/Setup/Patch/Data/UpdateMviewPatch.php @@ -57,7 +57,7 @@ public function apply() ] ); $subscriptionInstance->remove(); - } catch (\Exception $e) { + } catch (\Exception) { // Skip } $this->moduleDataSetup->getConnection()->endSetup(); diff --git a/Setup/Patch/Schema/AutocompleteConfigPatch.php b/Setup/Patch/Schema/AutocompleteConfigPatch.php index cc879e439..d61e16411 100644 --- a/Setup/Patch/Schema/AutocompleteConfigPatch.php +++ b/Setup/Patch/Schema/AutocompleteConfigPatch.php @@ -41,7 +41,7 @@ public function apply() foreach ($movedConfigDirectives as $from => $to) { try { $connection->query('UPDATE ' . $table . ' SET path = "' . $to . '" WHERE path = "' . $from . '"'); - } catch (\Magento\Framework\DB\Adapter\DuplicateException $e) { + } catch (\Magento\Framework\DB\Adapter\DuplicateException) { // } } diff --git a/Setup/Patch/Schema/ConfigPatch.php b/Setup/Patch/Schema/ConfigPatch.php index 6450af8f7..564b3c6bc 100644 --- a/Setup/Patch/Schema/ConfigPatch.php +++ b/Setup/Patch/Schema/ConfigPatch.php @@ -30,7 +30,7 @@ class ConfigPatch implements SchemaPatchInterface * @var string[] */ protected $defaultConfigData = [ - 'algoliasearch_credentials/credentials/enable_backend' => '1', + 'algoliasearch_indexing_manager/algolia_indexing/enable_indexing' => '1', 'algoliasearch_credentials/credentials/enable_frontend' => '1', 'algoliasearch_credentials/credentials/application_id' => '', 'algoliasearch_credentials/credentials/search_only_api_key' => '', @@ -51,7 +51,6 @@ class ConfigPatch implements SchemaPatchInterface 'algoliasearch_instant/instant/instant_selector' => '.columns', 'algoliasearch_instant/instant/number_product_results' => '9', 'algoliasearch_instant/instant/max_values_per_facet' => '10', - 'algoliasearch_instant/instant/replace_categories' => '1', 'algoliasearch_instant/instant/show_suggestions_on_no_result_page' => '1', 'algoliasearch_instant/instant/add_to_cart_enable' => '1', 'algoliasearch_instant/instant/infinite_scroll_enable' => '0', @@ -85,7 +84,6 @@ class ConfigPatch implements SchemaPatchInterface 'algoliasearch_advanced/advanced/remove_words_if_no_result' => 'allOptional', 'algoliasearch_advanced/advanced/partial_update' => '0', 'algoliasearch_advanced/advanced/customer_groups_enable' => '0', - 'algoliasearch_advanced/advanced/make_seo_request' => '1', 'algoliasearch_advanced/advanced/remove_branding' => '0', 'algoliasearch_autocomplete/autocomplete/autocomplete_selector' => '.algolia-search-input', 'algoliasearch_advanced/advanced/index_product_on_category_products_update' => '1', @@ -311,7 +309,7 @@ public function apply() foreach ($movedConfigDirectives as $from => $to) { try { $connection->query('UPDATE ' . $table . ' SET path = "' . $to . '" WHERE path = "' . $from . '"'); - } catch (\Magento\Framework\DB\Adapter\DuplicateException $e) { + } catch (\Magento\Framework\DB\Adapter\DuplicateException) { // Skip } } diff --git a/Setup/Patch/Schema/RecommendConfigPatch.php b/Setup/Patch/Schema/RecommendConfigPatch.php index 47d002397..e0b2373e3 100644 --- a/Setup/Patch/Schema/RecommendConfigPatch.php +++ b/Setup/Patch/Schema/RecommendConfigPatch.php @@ -66,7 +66,7 @@ public function apply() foreach ($movedConfigDirectives as $from => $to) { try { $connection->query('UPDATE ' . $table . ' SET path = "' . $to . '" WHERE path = "' . $from . '"'); - } catch (\Magento\Framework\DB\Adapter\DuplicateException $e) { + } catch (\Magento\Framework\DB\Adapter\DuplicateException) { // } } diff --git a/Test/Integration/AssertValues/Magento24CE.php b/Test/Integration/AssertValues/Magento24CE.php index c548976ca..b7c2fdfb1 100644 --- a/Test/Integration/AssertValues/Magento24CE.php +++ b/Test/Integration/AssertValues/Magento24CE.php @@ -9,7 +9,7 @@ abstract class Magento24CE public $productsCountWithoutGiftcards = 181; public $lastJobDataSize = 13; public $expectedCategory = 16; - public $attributesForFaceting = 5; + public $attributesForFaceting = 6; public $automaticalSetOfCategoryAttributesForFaceting = 4; public $expectedPages = 6; public $expectedExcludePages = 4; diff --git a/Test/Integration/AssertValues/Magento24EE.php b/Test/Integration/AssertValues/Magento24EE.php index bf244633d..376557050 100644 --- a/Test/Integration/AssertValues/Magento24EE.php +++ b/Test/Integration/AssertValues/Magento24EE.php @@ -9,7 +9,7 @@ abstract class Magento24EE public $productsCountWithoutGiftcards = 181; public $lastJobDataSize = 13; public $expectedCategory = 17; - public $attributesForFaceting = 5; + public $attributesForFaceting = 6; public $automaticalSetOfCategoryAttributesForFaceting = 4; public $expectedPages = 9; public $expectedExcludePages = 7; diff --git a/Test/Integration/Frontend/Category/CategoryCacheTest.php b/Test/Integration/Frontend/Category/CategoryCacheTest.php index 2dd8bd589..3d6336c75 100644 --- a/Test/Integration/Frontend/Category/CategoryCacheTest.php +++ b/Test/Integration/Frontend/Category/CategoryCacheTest.php @@ -12,8 +12,8 @@ class CategoryCacheTest extends AbstractController { - protected ?CacheManager $cacheManager; - protected ?ScopeConfigInterface $config; + protected ?CacheManager $cacheManager = null; + protected ?ScopeConfigInterface $config = null; protected static $cacheResets = []; @@ -23,12 +23,12 @@ class CategoryCacheTest extends AbstractController public static function getCategoryProvider(): array { return [ - ['categoryId' => 20, 'name' => 'Women', 'hasProducts' => false], - ['categoryId' => 21, 'name' => 'Women > Tops', 'hasProducts' => true], - ['categoryId' => 22, 'name' => 'Women > Bottoms', 'hasProducts' => true], - ['categoryId' => 11, 'name' => 'Men', 'hasProducts' => false], - ['categoryId' => 12, 'name' => 'Men > Tops', 'hasProducts' => true], - ['categoryId' => 13, 'name' => 'Men > Bottoms', 'hasProducts' => true], + [20, 'Women', false], + [21, 'Women > Tops', true], + [22, 'Women > Bottoms', true], + [11, 'Men', false], + [12, 'Men > Tops', true], + [13, 'Men > Bottoms', true], ]; } @@ -102,7 +102,7 @@ public function testCategoryPlpMissBackendRenderOn(int $categoryId, string $name ); $this->assertContains( 'FPC', - explode(',', $response->getHeader('X-Magento-Tags')->getFieldValue()), + explode(',', (string) $response->getHeader('X-Magento-Tags')->getFieldValue()), "expected FPC tag on category {$name} id {$categoryId}" ); @@ -153,7 +153,7 @@ public function testCategoryPlpMissBackendRenderOff(int $categoryId, string $nam ); $this->assertContains( 'FPC', - explode(',', $response->getHeader('X-Magento-Tags')->getFieldValue()), + explode(',', (string) $response->getHeader('X-Magento-Tags')->getFieldValue()), "expected FPC tag on category {$name} id {$categoryId}" ); @@ -208,7 +208,7 @@ public function testCategoryPlpMissBackendRenderWhiteList(int $categoryId, strin ); $this->assertContains( 'FPC', - explode(',', $response->getHeader('X-Magento-Tags')->getFieldValue()), + explode(',', (string) $response->getHeader('X-Magento-Tags')->getFieldValue()), "expected FPC tag on category {$name} id {$categoryId}" ); diff --git a/Test/Integration/Frontend/Search/SearchTest.php b/Test/Integration/Frontend/Search/SearchTest.php index 4ae24d116..f1b7ef37d 100644 --- a/Test/Integration/Frontend/Search/SearchTest.php +++ b/Test/Integration/Frontend/Search/SearchTest.php @@ -25,7 +25,7 @@ public function setUp(): void $this->backendSearch = $this->objectManager->create(BackendSearch::class); $this->productIndexer->executeFull(); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); } public function testSearch() @@ -41,7 +41,7 @@ public function testSearch() // Result exists in DB $this->assertNotEmpty($product->getName(), "Query result item couldn't find in the DB"); // Query word exists title - $this->assertStringContainsString($query, strtolower($product->getName()), "Query word doesn't exist in product name"); + $this->assertStringContainsString($query, strtolower((string) $product->getName()), "Query word doesn't exist in product name"); } public function testSearchBySku() @@ -63,7 +63,7 @@ public function testSearchBySku() public function testCategorySearch() { // Get products by categoryId - list($results, $totalHits, $facetsFromAlgolia) = $this->search('', 1, [ + [$results, $totalHits, $facetsFromAlgolia] = $this->search('', 1, [ 'facetFilters' => ['categoryIds:' . self::BAGS_CATEGORY_ID] ]); // Category filter returns result @@ -86,7 +86,7 @@ public function testCategorySearch() */ protected function getFirstResult(array $results): array { - list($results, $totalHits, $facetsFromAlgolia) = $results; + [$results, $totalHits, $facetsFromAlgolia] = $results; return array_shift($results); } @@ -100,7 +100,7 @@ protected function search(string $query = '', int $storeId = 1, array $params = { try { return $this->backendSearch->getSearchResult($query, $storeId, $params); - } catch (NoSuchEntityException $e) { + } catch (NoSuchEntityException) { return []; } } diff --git a/Test/Integration/Indexing/Category/CategoriesIndexingTest.php b/Test/Integration/Indexing/Category/CategoriesIndexingTest.php index 91a1a7611..98e01b91c 100644 --- a/Test/Integration/Indexing/Category/CategoriesIndexingTest.php +++ b/Test/Integration/Indexing/Category/CategoriesIndexingTest.php @@ -2,16 +2,21 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing\Category; -use Algolia\AlgoliaSearch\Model\Indexer\Category; +use Algolia\AlgoliaSearch\Console\Command\Indexer\IndexCategoriesCommand; +use Algolia\AlgoliaSearch\Model\Indexer\Category as CategoryIndexer; +use Algolia\AlgoliaSearch\Service\Category\BatchQueueProcessor as CategoryBatchQueueProcessor; use Algolia\AlgoliaSearch\Test\Integration\Indexing\IndexingTestCase; class CategoriesIndexingTest extends IndexingTestCase { public function testCategories() { - /** @var Category $categoriesIndexer */ - $categoriesIndexer = $this->getObjectManager()->create(Category::class); - $this->processTest($categoriesIndexer, 'categories', $this->assertValues->expectedCategory); + $categoryBatchQueueProcessor = $this->objectManager->get(CategoryBatchQueueProcessor::class); + $this->processTest( + $categoryBatchQueueProcessor, + 'categories', + $this->assertValues->expectedCategory + ); } public function testDefaultIndexableAttributes() @@ -21,13 +26,12 @@ public function testDefaultIndexableAttributes() $this->getSerializer()->serialize([]) ); - /** @var Category $categoriesIndexer */ - $categoriesIndexer = $this->getObjectManager()->create(Category::class); - $categoriesIndexer->executeRow(3); - - $this->algoliaHelper->waitLastTask(); + $categoryBatchQueueProcessor = $this->objectManager->get(CategoryBatchQueueProcessor::class); + $categoryBatchQueueProcessor->processBatch(1, [3]); + $this->algoliaConnector->waitLastTask(); - $results = $this->algoliaHelper->getObjects($this->indexPrefix . 'default_categories', ['3']); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_categories'); + $results = $this->algoliaConnector->getObjects($indexOptions, ['3']); $hit = reset($results['results']); $defaultAttributes = [ @@ -43,12 +47,36 @@ public function testDefaultIndexableAttributes() 'product_count', ]; - foreach ($defaultAttributes as $key => $attribute) { - $this->assertTrue(key_exists($attribute, $hit), 'Category attribute "' . $attribute . '" should be indexed but it is not"'); + foreach ($defaultAttributes as $attribute) { + $this->assertTrue(array_key_exists($attribute, $hit), 'Category attribute "' . $attribute . '" should be indexed but it is not"'); unset($hit[$attribute]); } $extraAttributes = implode(', ', array_keys($hit)); $this->assertTrue(empty($hit), 'Extra category attributes (' . $extraAttributes . ') are indexed and should not be.'); } + + public function testIndexingCategoriesCommand() + { + $indexCategoriesCmd = $this->objectManager->get(IndexCategoriesCommand::class); + $this->processCommandTest($indexCategoriesCmd,'categories', $this->assertValues->expectedCategory); + } + + /** + * @magentoConfigFixture current_store algoliasearch_indexing_manager/full_indexing/categories 0 + */ + public function testDisabledOldIndexer() + { + $categoriesIndexer = $this->objectManager->create(CategoryIndexer::class); + $this->processOldIndexerTest($categoriesIndexer, 'categories', 0); + } + + /** + * @magentoConfigFixture current_store algoliasearch_indexing_manager/full_indexing/categories 1 + */ + public function testEnabledOldIndexer() + { + $categoriesIndexer = $this->objectManager->create(CategoryIndexer::class); + $this->processOldIndexerTest($categoriesIndexer, 'categories', $this->assertValues->expectedCategory); + } } diff --git a/Test/Integration/Indexing/Category/MultiStoreCategoriesTest.php b/Test/Integration/Indexing/Category/MultiStoreCategoriesTest.php index 177490c2d..70d5939b3 100644 --- a/Test/Integration/Indexing/Category/MultiStoreCategoriesTest.php +++ b/Test/Integration/Indexing/Category/MultiStoreCategoriesTest.php @@ -4,7 +4,7 @@ use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Model\Indexer\Category; +use Algolia\AlgoliaSearch\Service\Category\BatchQueueProcessor as CategoryBatchQueueProcessor; use Algolia\AlgoliaSearch\Test\Integration\Indexing\MultiStoreTestCase; use Magento\Catalog\Api\CategoryRepositoryInterface; use Magento\Catalog\Api\Data\CategoryInterface; @@ -19,15 +19,15 @@ */ class MultiStoreCategoriesTest extends MultiStoreTestCase { - /** @var Category */ - protected $categoriesIndexer; - /** @var CategoryRepositoryInterface */ protected $categoryRepository; /** @var CollectionFactory */ private $categoryCollectionFactory; + /** @var CategoryBatchQueueProcessor */ + protected $categoryBatchQueueProcessor; + const BAGS_CATEGORY_ID = 4; const BAGS_CATEGORY_NAME = "Bags"; const BAGS_CATEGORY_NAME_ALT = "Bags Alt"; @@ -36,13 +36,11 @@ protected function setUp():void { parent::setUp(); - $this->categoriesIndexer = $this->objectManager->get(Category::class); $this->categoryRepository = $this->objectManager->get(CategoryRepositoryInterface::class); $this->categoryCollectionFactory = $this->objectManager->get(CollectionFactory::class); - - $this->categoriesIndexer->executeFull(); - $this->algoliaHelper->waitLastTask(); + $this->categoryBatchQueueProcessor = $this->objectManager->get(CategoryBatchQueueProcessor::class); + $this->reindexToAllStores($this->categoryBatchQueueProcessor); } /** @@ -80,10 +78,7 @@ public function testMultiStoreCategoryIndices() $this->assertEquals(self::BAGS_CATEGORY_NAME, $bagsCategory->getName()); $this->assertEquals(self::BAGS_CATEGORY_NAME_ALT, $bagsCategoryAlt->getName()); - $this->categoriesIndexer->execute([self::BAGS_CATEGORY_ID]); - - $this->algoliaHelper->waitLastTask($defaultStore->getId()); - $this->algoliaHelper->waitLastTask($fixtureSecondStore->getId()); + $this->reindexToAllStores($this->categoryBatchQueueProcessor, [self::BAGS_CATEGORY_ID]); $this->assertAlgoliaRecordValues( $this->indexPrefix . 'default_categories', @@ -106,10 +101,7 @@ public function testMultiStoreCategoryIndices() ['is_active' => 0] ); - $this->categoriesIndexer->execute([self::BAGS_CATEGORY_ID]); - - $this->algoliaHelper->waitLastTask($defaultStore->getId()); - $this->algoliaHelper->waitLastTask($fixtureSecondStore->getId()); + $this->reindexToAllStores($this->categoryBatchQueueProcessor, [self::BAGS_CATEGORY_ID]); $this->assertNbOfRecordsPerStore( $defaultStore->getCode(), diff --git a/Test/Integration/Indexing/Config/ConfigTest.php b/Test/Integration/Indexing/Config/ConfigTest.php index cad6bc14b..d20367662 100644 --- a/Test/Integration/Indexing/Config/ConfigTest.php +++ b/Test/Integration/Indexing/Config/ConfigTest.php @@ -14,9 +14,10 @@ public function testFacets() $indicesConfigurator = $this->getObjectManager()->create(IndicesConfigurator::class); $indicesConfigurator->saveConfigurationToAlgolia(1); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); - $indexSettings = $this->algoliaHelper->getSettings($this->indexPrefix . 'default_products'); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_products'); + $indexSettings = $this->algoliaConnector->getSettings($indexOptions); $this->assertEquals($this->assertValues->attributesForFaceting, count($indexSettings['attributesForFaceting'])); } @@ -27,9 +28,9 @@ public function testQueryRules() $indicesConfigurator = $this->getObjectManager()->create(IndicesConfigurator::class); $indicesConfigurator->saveConfigurationToAlgolia(1); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); - $client = $this->algoliaHelper->getClient(); + $client = $this->algoliaConnector->getClient(); $matchedRules = []; @@ -58,64 +59,7 @@ public function testQueryRules() public function testAutomaticalSetOfCategoriesFacet() { - /** @var IndicesConfigurator $indicesConfigurator */ - $indicesConfigurator = $this->getObjectManager()->create(IndicesConfigurator::class); - - // Remove categories from facets - $facets = $this->configHelper->getFacets(); - foreach ($facets as $key => $facet) { - if ($facet['attribute'] === 'categories') { - unset($facets[$key]); - - break; - } - } - - $this->setConfig('algoliasearch_instant/instant_facets/facets', $this->getSerializer()->serialize($facets)); - - // Set don't replace category pages with Algolia - categories attribute shouldn't be included in facets - $this->setConfig('algoliasearch_instant/instant/replace_categories', '0'); - - $indicesConfigurator->saveConfigurationToAlgolia(1); - - $this->algoliaHelper->waitLastTask(); - - $indexSettings = $this->algoliaHelper->getSettings($this->indexPrefix . 'default_products'); - - $this->assertEquals($this->assertValues->automaticalSetOfCategoryAttributesForFaceting, count($indexSettings['attributesForFaceting'])); - - $categoriesAttributeIsIncluded = false; - foreach ($indexSettings['attributesForFaceting'] as $attribute) { - if ($attribute === 'categories') { - $categoriesAttributeIsIncluded = true; - - break; - } - } - - $this->assertFalse($categoriesAttributeIsIncluded, 'Categories attribute should not be included in facets, but it is'); - - // Set replace category pages with Algolia - categories attribute should be included in facets - $this->setConfig('algoliasearch_instant/instant/replace_categories', '1'); - - $indicesConfigurator->saveConfigurationToAlgolia(1); - - $this->algoliaHelper->waitLastTask(); - - $indexSettings = $this->algoliaHelper->getSettings($this->indexPrefix . 'default_products'); - - $this->assertEquals($this->assertValues->automaticalSetOfCategoryAttributesForFaceting + 1, count($indexSettings['attributesForFaceting'])); - - $categoriesAttributeIsIncluded = false; - foreach ($indexSettings['attributesForFaceting'] as $attribute) { - if ($attribute === 'categories') { - $categoriesAttributeIsIncluded = true; - - break; - } - } - - $this->assertTrue($categoriesAttributeIsIncluded, 'Categories attribute should be included in facets, but it is not'); + // Removed test, the addition/deletion of the "categories" attribute is now checked by the FacetBuilder unit test } public function testRetrievableAttributes() @@ -193,17 +137,16 @@ private function replicaCreationTest($withCustomerGroups = false) $indicesConfigurator = $this->getObjectManager()->create(IndicesConfigurator::class); $indicesConfigurator->saveConfigurationToAlgolia(1); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); - $indices = $this->algoliaHelper->listIndexes(); - $indicesNames = array_map(function ($indexData) { - return $indexData['name']; - }, $indices['items']); + $indices = $this->algoliaConnector->listIndexes(); + $indicesNames = array_map(fn($indexData) => $indexData['name'], $indices['items']); foreach ($sortingIndicesWithRankingWhichShouldBeCreated as $indexName => $firstRanking) { $this->assertContains($indexName, $indicesNames); - $settings = $this->algoliaHelper->getSettings($indexName); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName); + $settings = $this->algoliaConnector->getSettings($indexOptions); $this->assertEquals($firstRanking, reset($settings['ranking'])); } } @@ -214,20 +157,22 @@ public function testExtraSettings() $indicesConfigurator = $this->getObjectManager()->create(IndicesConfigurator::class); $indicesConfigurator->saveConfigurationToAlgolia(1); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); $sections = ['products', 'categories', 'pages', 'suggestions']; foreach ($sections as $section) { $indexName = $this->indexPrefix . 'default_' . $section; + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName); - $this->algoliaHelper->setSettings($indexName, ['exactOnSingleWordQuery' => 'attribute']); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->setSettings($indexOptions, ['exactOnSingleWordQuery' => 'attribute']); + $this->algoliaConnector->waitLastTask(); } foreach ($sections as $section) { $indexName = $this->indexPrefix . 'default_' . $section; - $currentSettings = $this->algoliaHelper->getSettings($indexName); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName); + $currentSettings = $this->algoliaConnector->getSettings($indexOptions); $this->assertArrayHasKey('exactOnSingleWordQuery', $currentSettings); $this->assertEquals('attribute', $currentSettings['exactOnSingleWordQuery']); @@ -238,12 +183,13 @@ public function testExtraSettings() } $indicesConfigurator->saveConfigurationToAlgolia(1); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); foreach ($sections as $section) { $indexName = $this->indexPrefix . 'default_' . $section; - $currentSettings = $this->algoliaHelper->getSettings($indexName); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName); + $currentSettings = $this->algoliaConnector->getSettings($indexOptions); $this->assertArrayHasKey('exactOnSingleWordQuery', $currentSettings); $this->assertEquals('word', $currentSettings['exactOnSingleWordQuery']); diff --git a/Test/Integration/Indexing/Config/MultiStoreConfigTest.php b/Test/Integration/Indexing/Config/MultiStoreConfigTest.php index 482cd7338..2e0f58327 100644 --- a/Test/Integration/Indexing/Config/MultiStoreConfigTest.php +++ b/Test/Integration/Indexing/Config/MultiStoreConfigTest.php @@ -88,15 +88,17 @@ public function testMultiStoreIndicesCreation() $this->indicesConfigurator->saveConfigurationToAlgolia($fixtureSecondStore->getId()); - $defaultCategoryIndexSettings = $this->algoliaHelper->getSettings( + $defaultCategoryIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( $this->indexPrefix . 'default_categories', $defaultStore->getId() ); + $defaultCategoryIndexSettings = $this->algoliaConnector->getSettings($defaultCategoryIndexOptions); - $fixtureCategoryIndexSettings = $this->algoliaHelper->getSettings( + $fixtureCategoryIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( $this->indexPrefix . 'fixture_second_store_categories', $fixtureSecondStore->getId() ); + $fixtureCategoryIndexSettings = $this->algoliaConnector->getSettings($fixtureCategoryIndexOptions); $attributeFromConfig = 'unordered(' . self::ADDITIONAL_ATTRIBUTE . ')'; $this->assertNotContains($attributeFromConfig, $defaultCategoryIndexSettings['searchableAttributes']); @@ -106,17 +108,17 @@ public function testMultiStoreIndicesCreation() $this->assertNotContains($rankingFromConfig, $defaultCategoryIndexSettings['customRanking']); $this->assertContains($rankingFromConfig, $fixtureCategoryIndexSettings['customRanking']); - $defaultProductIndexRules = $this->algoliaHelper->searchRules( + $defaultIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( $this->indexPrefix . 'default_products', - null, $defaultStore->getId() ); + $defaultProductIndexRules = $this->algoliaConnector->searchRules($defaultIndexOptions); - $fixtureProductIndexRules = $this->algoliaHelper->searchRules( + $fixtureIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( $this->indexPrefix . 'fixture_second_store_products', - null, $fixtureSecondStore->getId() ); + $fixtureProductIndexRules = $this->algoliaConnector->searchRules($fixtureIndexOptions); // Check that the Rule has only been created for the fixture store $this->assertEquals(0, $defaultProductIndexRules['nbHits']); diff --git a/Test/Integration/Indexing/Config/Traits/ConfigAssertionsTrait.php b/Test/Integration/Indexing/Config/Traits/ConfigAssertionsTrait.php index fb6e405a2..a15ef3843 100644 --- a/Test/Integration/Indexing/Config/Traits/ConfigAssertionsTrait.php +++ b/Test/Integration/Indexing/Config/Traits/ConfigAssertionsTrait.php @@ -12,16 +12,16 @@ trait ConfigAssertionsTrait * @return int * @throws AlgoliaException */ - protected function countStoreIndices(StoreInterface $store = null): int + protected function countStoreIndices(?StoreInterface $store = null): int { - $indices = $this->algoliaHelper->listIndexes($store->getId()); + $indices = $this->algoliaConnector->listIndexes($store->getId()); $indicesCreatedByTest = 0; foreach ($indices['items'] as $index) { $name = $index['name']; - if (mb_strpos($name, $this->indexPrefix . $store->getCode()) === 0) { + if (mb_strpos((string) $name, $this->indexPrefix . $store->getCode()) === 0) { $indicesCreatedByTest++; } } diff --git a/Test/Integration/Indexing/IndexingTestCase.php b/Test/Integration/Indexing/IndexingTestCase.php index 42728fcaf..f5a3be23a 100644 --- a/Test/Integration/Indexing/IndexingTestCase.php +++ b/Test/Integration/Indexing/IndexingTestCase.php @@ -2,9 +2,13 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing; +use Algolia\AlgoliaSearch\Api\Processor\BatchQueueProcessorInterface; +use Algolia\AlgoliaSearch\Console\Command\Indexer\AbstractIndexerCommand; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Test\Integration\TestCase; use Magento\Framework\Indexer\ActionInterface; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; abstract class IndexingTestCase extends TestCase { @@ -15,16 +19,69 @@ protected function setUp(): void $this->setConfig('algoliasearch_queue/queue/active', '0'); } - protected function processTest(ActionInterface $indexer, $indexSuffix, $expectedNbHits) + protected function processTest( + BatchQueueProcessorInterface $batchQueueProcessor, + $indexSuffix, + $expectedNbHits + ) { + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( + $this->indexPrefix . 'default_' . $indexSuffix + ); + + $this->algoliaConnector->clearIndex($indexOptions); + + $batchQueueProcessor->processBatch(1); + $this->algoliaConnector->waitLastTask(); + + $this->assertNumberofHits($indexSuffix, $expectedNbHits); + } + + protected function processOldIndexerTest(ActionInterface $indexer, $indexSuffix, $expectedNbHits) { - $this->algoliaHelper->clearIndex($this->indexPrefix . 'default_' . $indexSuffix); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( + $this->indexPrefix . 'default_' . $indexSuffix + ); + + $this->algoliaConnector->clearIndex($indexOptions); $indexer->executeFull(); + $this->algoliaConnector->waitLastTask(); + + $this->assertNumberofHits($indexSuffix, $expectedNbHits); + } + + protected function processCommandTest( + AbstractIndexerCommand $command, + $indexSuffix, + $expectedNbHits + ) { + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( + $this->indexPrefix . 'default_' . $indexSuffix + ); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->clearIndex($indexOptions); - $resultsDefault = $this->algoliaHelper->query($this->indexPrefix . 'default_' . $indexSuffix, '', []); + $this->mockProperty($command, 'output', OutputInterface::class); + $this->invokeMethod( + $command, + 'execute', + [ + $this->createMock(InputInterface::class), + $this->createMock(OutputInterface::class) + ] + ); + $this->algoliaConnector->waitLastTask(); + + $this->assertNumberofHits($indexSuffix, $expectedNbHits); + } + protected function assertNumberofHits($indexSuffix, $expectedNbHits) + { + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( + $this->indexPrefix . 'default_' . $indexSuffix + ); + + $resultsDefault = $this->algoliaConnector->query($indexOptions, '', []); $this->assertEquals($expectedNbHits, $resultsDefault['results'][0]['nbHits']); } @@ -40,9 +97,11 @@ public function assertAlgoliaRecordValues( string $indexName, string $recordId, array $expectedValues, - int $storeId = null + ?int $storeId = null ) : void { - $res = $this->algoliaHelper->getObjects($indexName, [$recordId], $storeId); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName, $storeId); + + $res = $this->algoliaConnector->getObjects($indexOptions, [$recordId]); $record = reset($res['results']); foreach ($expectedValues as $attribute => $expectedValue) { $this->assertEquals($expectedValue, $record[$attribute]); diff --git a/Test/Integration/Indexing/MultiStoreTestCase.php b/Test/Integration/Indexing/MultiStoreTestCase.php index b6eda6b2c..d00c75d34 100644 --- a/Test/Integration/Indexing/MultiStoreTestCase.php +++ b/Test/Integration/Indexing/MultiStoreTestCase.php @@ -2,6 +2,7 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing; +use Algolia\AlgoliaSearch\Api\Processor\BatchQueueProcessorInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; use Algolia\AlgoliaSearch\Helper\ConfigHelper; @@ -41,6 +42,17 @@ protected function setUp(): void } } + protected function reindexToAllStores( + BatchQueueProcessorInterface $batchQueueProcessor, + ?array $categoryIds = null + ): void + { + foreach (array_keys($this->storeManager->getStores()) as $storeId) { + $batchQueueProcessor->processBatch($storeId, $categoryIds); + $this->algoliaConnector->waitLastTask($storeId); + } + } + /** * @param string $storeCode * @param string $entity @@ -53,16 +65,16 @@ protected function assertNbOfRecordsPerStore( string $storeCode, string $entity, int $expectedNumber, - int $storeId = null + ?int $storeId = null ): void { - $resultsDefault = $this->algoliaHelper->query( + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex( $this->indexPrefix . $storeCode . '_' . $entity, - '', - [], $storeId ); + $resultsDefault = $this->algoliaConnector->query($indexOptions, '', []); + $this->assertEquals($expectedNumber, $resultsDefault['results'][0]['nbHits']); } @@ -126,23 +138,24 @@ protected function clearStoresIndices($wait = false) foreach ($this->storeManager->getStores() as $store) { $deletedStoreIndices = 0; - $indices = $this->algoliaHelper->listIndexes($store->getId()); + $indices = $this->algoliaConnector->listIndexes($store->getId()); foreach ($indices['items'] as $index) { $name = $index['name']; - if (mb_strpos($name, $this->indexPrefix) === 0) { + if (mb_strpos((string) $name, $this->indexPrefix) === 0) { try { - $this->algoliaHelper->deleteIndex($name, $store->getId()); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($name, $store->getId()); + $this->algoliaConnector->deleteIndex($indexOptions); $deletedStoreIndices++; - } catch (AlgoliaException $e) { + } catch (AlgoliaException) { // Might be a replica } } } if ($deletedStoreIndices > 0 && $wait) { - $this->algoliaHelper->waitLastTask($store->getId()); + $this->algoliaConnector->waitLastTask($store->getId()); } } } diff --git a/Test/Integration/Indexing/Page/MultiStorePagesTest.php b/Test/Integration/Indexing/Page/MultiStorePagesTest.php index 7daaedcae..6df8d1b35 100644 --- a/Test/Integration/Indexing/Page/MultiStorePagesTest.php +++ b/Test/Integration/Indexing/Page/MultiStorePagesTest.php @@ -5,7 +5,7 @@ use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Model\Indexer\Page; +use Algolia\AlgoliaSearch\Service\Page\BatchQueueProcessor as PageBatchQueueProcessor; use Algolia\AlgoliaSearch\Test\Integration\Indexing\MultiStoreTestCase; use Magento\Cms\Api\Data\PageInterface; use Magento\Cms\Api\PageRepositoryInterface; @@ -21,27 +21,26 @@ */ class MultiStorePagesTest extends MultiStoreTestCase { - /** @var Page */ - protected $pagesIndexer; - /** @var PageRepositoryInterface */ protected $pageRepository; /** @var CollectionFactory */ private $pageCollectionFactory; + /** @var PageBatchQueueProcessor */ + protected $pageBatchQueueProcessor; + const HOME_PAGE_ID = 2; public function setUp():void { parent::setUp(); - $this->pagesIndexer = $this->objectManager->get(Page::class); $this->pageRepository = $this->objectManager->get(PageRepositoryInterface::class); $this->pageCollectionFactory = $this->objectManager->get(CollectionFactory::class); - $this->pagesIndexer->executeFull(); - $this->algoliaHelper->waitLastTask(); + $this->pageBatchQueueProcessor = $this->objectManager->get(PageBatchQueueProcessor::class); + $this->reindexToAllStores($this->pageBatchQueueProcessor); } /*** @@ -69,7 +68,7 @@ public function testMultiStorePageIndices() try { $homePage = $this->loadPage(self::HOME_PAGE_ID); - } catch (\Exception $e) { + } catch (\Exception) { $this->markTestIncomplete('Page could not be found.'); } @@ -77,10 +76,7 @@ public function testMultiStorePageIndices() $homePage->setStores([$defaultStore->getId()]); $this->pageRepository->save($homePage); - $this->pagesIndexer->execute([self::HOME_PAGE_ID]); - - $this->algoliaHelper->waitLastTask($defaultStore->getId()); - $this->algoliaHelper->waitLastTask($fixtureSecondStore->getId()); + $this->reindexToAllStores($this->pageBatchQueueProcessor, [self::HOME_PAGE_ID]); $this->assertNbOfRecordsPerStore( $defaultStore->getCode(), diff --git a/Test/Integration/Indexing/Page/PagesIndexingTest.php b/Test/Integration/Indexing/Page/PagesIndexingTest.php index 1b3392720..0ee27f04e 100644 --- a/Test/Integration/Indexing/Page/PagesIndexingTest.php +++ b/Test/Integration/Indexing/Page/PagesIndexingTest.php @@ -2,8 +2,10 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing\Page; +use Algolia\AlgoliaSearch\Console\Command\Indexer\IndexPagesCommand; use Algolia\AlgoliaSearch\Helper\Entity\PageHelper; -use Algolia\AlgoliaSearch\Model\Indexer\Page; +use Algolia\AlgoliaSearch\Model\Indexer\Page as PageIndexer; +use Algolia\AlgoliaSearch\Service\Page\BatchQueueProcessor as PageBatchQueueProcessor; use Algolia\AlgoliaSearch\Test\Integration\Indexing\IndexingTestCase; use Magento\Cms\Model\PageFactory; @@ -16,10 +18,8 @@ public function testNoExcludedPages() $this->getSerializer()->serialize([]) ); - /** @var Page $indexer */ - $indexer = $this->getObjectManager()->create(Page::class); - - $this->processTest($indexer, 'pages', $this->assertValues->expectedPages); + $pageBatchQueueProcessor = $this->objectManager->get(PageBatchQueueProcessor::class); + $this->processTest($pageBatchQueueProcessor, 'pages', $this->assertValues->expectedPages); } public function testExcludedPages() @@ -33,11 +33,11 @@ public function testExcludedPages() $this->getSerializer()->serialize($excludedPages) ); - /** @var Page $indexer */ - $indexer = $this->getObjectManager()->create(Page::class); - $this->processTest($indexer, 'pages', $this->assertValues->expectedExcludePages); + $pageBatchQueueProcessor = $this->objectManager->get(PageBatchQueueProcessor::class); + $this->processTest($pageBatchQueueProcessor, 'pages', $this->assertValues->expectedExcludePages); - $response = $this->algoliaHelper->query($this->indexPrefix . 'default_pages', '', []); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_pages'); + $response = $this->algoliaConnector->query($indexOptions, '', []); $hits = reset($response['results'])['hits']; $noRoutePageExists = false; @@ -61,13 +61,12 @@ public function testExcludedPages() public function testDefaultIndexableAttributes() { - /** @var Page $indexer */ - $indexer = $this->getObjectManager()->create(Page::class); - $indexer->executeFull(); - - $this->algoliaHelper->waitLastTask(); + $pageBatchQueueProcessor = $this->objectManager->get(PageBatchQueueProcessor::class); + $pageBatchQueueProcessor->processBatch(1); + $this->algoliaConnector->waitLastTask(); - $response = $this->algoliaHelper->query($this->indexPrefix . 'default_pages', '', ['hitsPerPage' => 1]); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_pages'); + $response = $this->algoliaConnector->query($indexOptions, '', ['hitsPerPage' => 1]); $hits = reset($response['results']); $hit = reset($hits['hits']); @@ -82,8 +81,8 @@ public function testDefaultIndexableAttributes() '_snippetResult', ]; - foreach ($defaultAttributes as $key => $attribute) { - $this->assertTrue(key_exists($attribute, $hit), 'Pages attribute "' . $attribute . '" should be indexed but it is not"'); + foreach ($defaultAttributes as $attribute) { + $this->assertTrue(array_key_exists($attribute, $hit), 'Pages attribute "' . $attribute . '" should be indexed but it is not"'); unset($hit[$attribute]); } @@ -152,4 +151,38 @@ public function testUtf8() $testPage->delete(); } + + public function testIndexingPagesCommand() + { + $this->setConfig( + 'algoliasearch_autocomplete/autocomplete/excluded_pages', + $this->getSerializer()->serialize([]) + ); + + $indexPagesCmd = $this->objectManager->get(IndexPagesCommand::class); + $this->processCommandTest($indexPagesCmd, 'pages', $this->assertValues->expectedPages); + } + + /** + * @magentoConfigFixture current_store algoliasearch_indexing_manager/full_indexing/pages 0 + */ + public function testDisabledOldIndexer() + { + $pagesIndexer = $this->objectManager->create(PageIndexer::class); + $this->processOldIndexerTest($pagesIndexer, 'pages', 0); + } + + /** + * @magentoConfigFixture current_store algoliasearch_indexing_manager/full_indexing/pages 1 + */ + public function testEnabledOldIndexer() + { + $this->setConfig( + 'algoliasearch_autocomplete/autocomplete/excluded_pages', + $this->getSerializer()->serialize([]) + ); + + $pagesIndexer = $this->objectManager->create(PageIndexer::class); + $this->processOldIndexerTest($pagesIndexer, 'pages', $this->assertValues->expectedPages); + } } diff --git a/Test/Integration/Indexing/Product/MultiStoreProductsTest.php b/Test/Integration/Indexing/Product/MultiStoreProductsTest.php index 1f885e6c7..4ccc573f7 100644 --- a/Test/Integration/Indexing/Product/MultiStoreProductsTest.php +++ b/Test/Integration/Indexing/Product/MultiStoreProductsTest.php @@ -2,7 +2,7 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing\Product; -use Algolia\AlgoliaSearch\Model\Indexer\Product; +use Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor as ProductBatchQueueProcessor; use Algolia\AlgoliaSearch\Test\Integration\Indexing\MultiStoreTestCase; use Magento\Catalog\Api\Data\ProductInterface; use Magento\Catalog\Api\ProductRepositoryInterface; @@ -19,8 +19,8 @@ */ class MultiStoreProductsTest extends MultiStoreTestCase { - /** @var Product */ - protected $productsIndexer; + /** @var ProductBatchQueueProcessor */ + protected $productBatchQueueProcessor; /** @var ProductRepositoryInterface */ protected $productRepository; @@ -53,7 +53,7 @@ protected function setUp():void { parent::setUp(); - $this->productsIndexer = $this->objectManager->get(Product::class); + $this->productBatchQueueProcessor = $this->objectManager->get(ProductBatchQueueProcessor::class); $this->productRepository = $this->objectManager->get(ProductRepositoryInterface::class); $this->productCollectionFactory = $this->objectManager->get(CollectionFactory::class); $this->websiteRepository = $this->objectManager->get(WebsiteRepositoryInterface::class); @@ -62,8 +62,7 @@ protected function setUp():void $this->productPriceIndexer = $this->indexerRegistry->get('catalog_product_price'); $this->productPriceIndexer->reindexAll(); - $this->productsIndexer->executeFull(); - $this->algoliaHelper->waitLastTask(); + $this->reindexToAllStores($this->productBatchQueueProcessor); } public function testMultiStoreProductIndices() @@ -86,7 +85,7 @@ public function testMultiStoreProductIndices() try { $voyageYogaBag = $this->loadProduct(self::VOYAGE_YOGA_BAG_ID, $defaultStore->getId()); - } catch (\Exception $e) { + } catch (\Exception) { $this->markTestIncomplete('Product could not be found.'); } @@ -102,11 +101,7 @@ public function testMultiStoreProductIndices() $this->assertEquals(self::VOYAGE_YOGA_BAG_NAME, $voyageYogaBag->getName()); $this->assertEquals(self::VOYAGE_YOGA_BAG_NAME_ALT, $voyageYogaBagAlt->getName()); - $this->productsIndexer->execute([self::VOYAGE_YOGA_BAG_ID]); - - $this->algoliaHelper->waitLastTask($defaultStore->getId()); - $this->algoliaHelper->waitLastTask($fixtureSecondStore->getId()); - $this->algoliaHelper->waitLastTask($fixtureThirdStore->getId()); + $this->reindexToAllStores($this->productBatchQueueProcessor, [self::VOYAGE_YOGA_BAG_ID]); $this->assertAlgoliaRecordValues( $this->indexPrefix . 'default_products', @@ -131,11 +126,7 @@ public function testMultiStoreProductIndices() $this->productRepository->save($voyageYogaBag); $this->productPriceIndexer->reindexRow(self::VOYAGE_YOGA_BAG_ID); - $this->productsIndexer->execute([self::VOYAGE_YOGA_BAG_ID]); - - $this->algoliaHelper->waitLastTask($defaultStore->getId()); - $this->algoliaHelper->waitLastTask($fixtureSecondStore->getId()); - $this->algoliaHelper->waitLastTask($fixtureThirdStore->getId()); + $this->reindexToAllStores($this->productBatchQueueProcessor, [self::VOYAGE_YOGA_BAG_ID]); // default store should have the same number of products $this->assertNbOfRecordsPerStore( @@ -170,7 +161,7 @@ public function testMultiStoreProductIndices() * @return ProductInterface * @throws NoSuchEntityException */ - private function loadProduct(int $productId, int $storeId = null): ProductInterface + private function loadProduct(int $productId, ?int $storeId = null): ProductInterface { return $this->productRepository->getById($productId, true, $storeId); } diff --git a/Test/Integration/Indexing/Product/MultiStoreReplicaTest.php b/Test/Integration/Indexing/Product/MultiStoreReplicaTest.php index 2125916df..e04a75e51 100644 --- a/Test/Integration/Indexing/Product/MultiStoreReplicaTest.php +++ b/Test/Integration/Indexing/Product/MultiStoreReplicaTest.php @@ -6,7 +6,7 @@ use Algolia\AlgoliaSearch\Console\Command\ReplicaRebuildCommand; use Algolia\AlgoliaSearch\Console\Command\ReplicaSyncCommand; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Service\Product\IndexOptionsBuilder; +use Algolia\AlgoliaSearch\Service\Product\IndexOptionsBuilder as ProductIndexOptionsBuilder; use Algolia\AlgoliaSearch\Service\Product\SortingTransformer; use Algolia\AlgoliaSearch\Test\Integration\Indexing\Config\Traits\ConfigAssertionsTrait; use Algolia\AlgoliaSearch\Test\Integration\Indexing\MultiStoreTestCase; @@ -33,14 +33,14 @@ class MultiStoreReplicaTest extends MultiStoreTestCase protected ?SerializerInterface $serializer = null; - protected ?IndexOptionsBuilder $indexOptionsBuilder = null; + protected ?ProductIndexOptionsBuilder $productIndexOptionsBuilder = null; protected function setUp(): void { parent::setUp(); $this->replicaManager = $this->objectManager->get(ReplicaManagerInterface::class); $this->serializer = $this->objectManager->get(SerializerInterface::class); - $this->indexOptionsBuilder = $this->objectManager->get(IndexOptionsBuilder::class); + $this->productIndexOptionsBuilder = $this->objectManager->get(ProductIndexOptionsBuilder::class); $stores = $this->storeManager->getStores(); @@ -139,13 +139,11 @@ public function testReplicaCommands() $this->algoliaConnector->waitLastTask($fixtureSecondStore->getId()); // Executing commands - End - $currentDefaultSettings = $this->algoliaHelper->getSettings($defaultIndexName, $defaultStore->getId()); $currentDefaultSettings = $this->algoliaConnector->getSettings( - $this->indexOptionsBuilder->buildEntityIndexOptions($defaultStore->getId()) + $this->productIndexOptionsBuilder->buildEntityIndexOptions($defaultStore->getId()) ); - $currentFixtureSettings = $this->algoliaHelper->getSettings($fixtureIndexName, $fixtureSecondStore->getId()); $currentFixtureSettings = $this->algoliaConnector->getSettings( - $this->indexOptionsBuilder->buildEntityIndexOptions($fixtureSecondStore->getId()) + $this->productIndexOptionsBuilder->buildEntityIndexOptions($fixtureSecondStore->getId()) ); $this->assertArrayHasKey('replicas', $currentDefaultSettings); diff --git a/Test/Integration/Indexing/Product/PricingTest.php b/Test/Integration/Indexing/Product/PricingTest.php index ef26ac7a3..2aa09f337 100644 --- a/Test/Integration/Indexing/Product/PricingTest.php +++ b/Test/Integration/Indexing/Product/PricingTest.php @@ -54,14 +54,15 @@ protected function indexProducts(int|array $productIds): void if (!is_array($productIds)) { $productIds = [$productIds]; } - $this->productIndexer->execute($productIds); - $this->algoliaHelper->waitLastTask(); + $this->productBatchQueueProcessor->processBatch(1, $productIds); + $this->algoliaConnector->waitLastTask(); } protected function getAlgoliaObjectById(int $productId): ?array { - $res = $this->algoliaHelper->getObjects( - $this->indexName, + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexName); + $res = $this->algoliaConnector->getObjects( + $indexOptions, [(string) $productId] ); return reset($res['results']); @@ -121,7 +122,7 @@ public function testMagentoProductData(int $productId, float $expectedPrice): vo /** * @var Product $product */ - $product = $this->objectManager->get('Magento\Catalog\Model\ProductRepository')->getById($productId); + $product = $this->objectManager->get(\Magento\Catalog\Model\ProductRepository::class)->getById($productId); $this->assertTrue($product->isInStock(), "Product is not in stock"); $this->assertTrue($product->getIsSalable(), "Product is not salable"); $actualPrice = $product->getFinalPrice(); @@ -131,9 +132,7 @@ public function testMagentoProductData(int $productId, float $expectedPrice): vo public static function productProvider(): array { return array_map( - function ($key, $value) { - return [$key, $value]; - }, + fn($key, $value) => [$key, $value], array_keys(self::ASSERT_PRODUCT_PRICES), self::ASSERT_PRODUCT_PRICES ); @@ -141,12 +140,12 @@ function ($key, $value) { public function testSpecialPrice(): void { - $this->productIndexer->execute([self::SPECIAL_PRICE_TEST_PRODUCT_ID]); - $this->algoliaHelper->waitLastTask(); + $this->productBatchQueueProcessor->processBatch(1, [self::SPECIAL_PRICE_TEST_PRODUCT_ID]); + $this->algoliaConnector->waitLastTask(); - $res = $this->algoliaHelper->getObjects( - $this->indexPrefix . - 'default_products', + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_products'); + $res = $this->algoliaConnector->getObjects( + $indexOptions, [(string) self::SPECIAL_PRICE_TEST_PRODUCT_ID] ); $algoliaProduct = reset($res['results']); @@ -175,12 +174,12 @@ public function testSpecialPrice(): void ]); $product->save(); - $this->productIndexer->execute([self::SPECIAL_PRICE_TEST_PRODUCT_ID]); - $this->algoliaHelper->waitLastTask(); + $this->productBatchQueueProcessor->processBatch(1, [self::SPECIAL_PRICE_TEST_PRODUCT_ID]); + $this->algoliaConnector->waitLastTask(); - $res = $this->algoliaHelper->getObjects( - $this->indexPrefix . - 'default_products', + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_products'); + $res = $this->algoliaConnector->getObjects( + $indexOptions, [(string) self::SPECIAL_PRICE_TEST_PRODUCT_ID] ); $algoliaProduct = reset($res['results']); diff --git a/Test/Integration/Indexing/Product/ProductsIndexingTest.php b/Test/Integration/Indexing/Product/ProductsIndexingTest.php index f3f8348ba..2fe18435a 100644 --- a/Test/Integration/Indexing/Product/ProductsIndexingTest.php +++ b/Test/Integration/Indexing/Product/ProductsIndexingTest.php @@ -2,9 +2,11 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing\Product; +use Algolia\AlgoliaSearch\Console\Command\Indexer\IndexProductsCommand; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Model\Indexer\Product as ProductIndexer; use Magento\Catalog\Model\Product; use Magento\Framework\Exception\NoSuchEntityException; use Magento\Framework\Indexer\IndexerRegistry; @@ -19,8 +21,6 @@ class ProductsIndexingTest extends ProductsIndexingTestCase /*** @var IndexerRegistry */ protected $indexerRegistry; - protected $productPriceIndexer; - protected $testProductId; const OUT_OF_STOCK_PRODUCT_SKU = '24-MB01'; @@ -31,7 +31,7 @@ public function testOnlyOnStockProducts() $this->updateStockItem(self::OUT_OF_STOCK_PRODUCT_SKU, false); - $this->processTest($this->productIndexer, 'products', $this->assertValues->productsOnStockCount); + $this->processTest($this->productBatchQueueProcessor, 'products', $this->assertValues->productsOnStockCount); } public function testIncludingOutOfStock() @@ -40,7 +40,7 @@ public function testIncludingOutOfStock() $this->updateStockItem(self::OUT_OF_STOCK_PRODUCT_SKU, false); - $this->processTest($this->productIndexer, 'products', $this->assertValues->productsOutOfStockCount); + $this->processTest($this->productBatchQueueProcessor, 'products', $this->assertValues->productsOutOfStockCount); } public function testDefaultIndexableAttributes() @@ -52,10 +52,11 @@ public function testDefaultIndexableAttributes() $this->setConfig(ConfigHelper::SORTING_INDICES, $empty); $this->setConfig(ConfigHelper::PRODUCT_CUSTOM_RANKING, $empty); - $this->productIndexer->executeRow($this->getValidTestProduct()); - $this->algoliaHelper->waitLastTask(); + $this->productBatchQueueProcessor->processBatch(1, [$this->getValidTestProduct()]); + $this->algoliaConnector->waitLastTask(); - $results = $this->algoliaHelper->getObjects($this->indexPrefix . 'default_products', [$this->getValidTestProduct()]); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_products'); + $results = $this->algoliaConnector->getObjects($indexOptions, [$this->getValidTestProduct()]); $hit = reset($results['results']); $defaultAttributes = [ @@ -79,7 +80,7 @@ public function testDefaultIndexableAttributes() $this->markTestIncomplete('Hit was not returned correctly from Algolia. No Hit to run assetions on.'); } - foreach ($defaultAttributes as $key => $attribute) { + foreach ($defaultAttributes as $attribute) { $this->assertArrayHasKey($attribute, $hit, 'Products attribute "' . $attribute . '" should be indexed but it is not"'); unset($hit[$attribute]); } @@ -88,6 +89,38 @@ public function testDefaultIndexableAttributes() $this->assertEmpty($hit, 'Extra products attributes (' . $extraAttributes . ') are indexed and should not be.'); } + public function testIndexingProductsCommand() + { + $this->setConfig(ConfigHelper::SHOW_OUT_OF_STOCK, 0); + + $this->updateStockItem(self::OUT_OF_STOCK_PRODUCT_SKU, false); + + $indexProductsCmd = $this->objectManager->get(IndexProductsCommand::class); + $this->processCommandTest($indexProductsCmd, 'products', $this->assertValues->productsOnStockCount); + } + + /** + * @magentoConfigFixture current_store algoliasearch_indexing_manager/full_indexing/products 0 + */ + public function testDisabledOldIndexer() + { + $productsIndexer = $this->objectManager->create(ProductIndexer::class); + $this->processOldIndexerTest($productsIndexer, 'products', 0); + } + + /** + * @magentoConfigFixture current_store algoliasearch_indexing_manager/full_indexing/products 1 + */ + public function testEnabledOldIndexer() + { + $this->setConfig(ConfigHelper::SHOW_OUT_OF_STOCK, 0); + + $this->updateStockItem(self::OUT_OF_STOCK_PRODUCT_SKU, false); + + $productsIndexer = $this->objectManager->create(ProductIndexer::class); + $this->processOldIndexerTest($productsIndexer, 'products', $this->assertValues->productsOnStockCount); + } + private function getValidTestProduct() { if (!$this->testProductId) { diff --git a/Test/Integration/Indexing/Product/ProductsIndexingTestCase.php b/Test/Integration/Indexing/Product/ProductsIndexingTestCase.php index 4f8d2507b..41fe43c84 100644 --- a/Test/Integration/Indexing/Product/ProductsIndexingTestCase.php +++ b/Test/Integration/Indexing/Product/ProductsIndexingTestCase.php @@ -2,7 +2,7 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing\Product; -use Algolia\AlgoliaSearch\Model\Indexer\Product as ProductIndexer; +use Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor as ProductBatchQueueProcessor; use Algolia\AlgoliaSearch\Test\Integration\Indexing\IndexingTestCase; use Magento\CatalogInventory\Model\StockRegistry; use Magento\Framework\Exception\NoSuchEntityException; @@ -12,13 +12,13 @@ class ProductsIndexingTestCase extends IndexingTestCase { protected ?StockRegistry $stockRegistry = null; - protected ?ProductIndexer $productIndexer = null; + protected ?ProductBatchQueueProcessor $productBatchQueueProcessor = null; protected function setUp(): void { parent::setUp(); - $this->productIndexer = $this->objectManager->get(ProductIndexer::class); + $this->productBatchQueueProcessor = $this->objectManager->get(ProductBatchQueueProcessor::class); $this->stockRegistry = $this->objectManager->get(StockRegistry::class); $this->objectManager diff --git a/Test/Integration/Indexing/Product/ReplicaIndexingTest.php b/Test/Integration/Indexing/Product/ReplicaIndexingTest.php index fe61e0c01..af071f6bd 100644 --- a/Test/Integration/Indexing/Product/ReplicaIndexingTest.php +++ b/Test/Integration/Indexing/Product/ReplicaIndexingTest.php @@ -3,6 +3,7 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing\Product; use Algolia\AlgoliaSearch\Algolia; +use Algolia\AlgoliaSearch\Api\LoggerInterface; use Algolia\AlgoliaSearch\Api\Product\ReplicaManagerInterface; use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; @@ -25,7 +26,6 @@ use Magento\Framework\Setup\ModuleDataSetupInterface; use Magento\Store\Model\StoreManagerInterface; use PHPUnit\Framework\MockObject\MockObject; -use Psr\Log\LoggerInterface; class ReplicaIndexingTest extends TestCase { @@ -35,8 +35,6 @@ class ReplicaIndexingTest extends TestCase protected ?IndicesConfigurator $indicesConfigurator = null; - protected ?IndexOptionsBuilder $indexOptionsBuilder = null; - protected ?string $indexName = null; protected ?int $patchRetries = 3; @@ -194,7 +192,7 @@ public function testReplicaSync(): void } /** - * @magentoConfigFixture current_store algoliasearch_credentials/credentials/enable_backend 0 + * @magentoConfigFixture current_store algoliasearch_indexing_manager/algolia_indexing/enable_indexing 0 * @magentoConfigFixture current_store algoliasearch_instant/instant/is_instant_enabled 1 * @throws AlgoliaException * @throws ExceededRetriesException @@ -243,7 +241,7 @@ public function testReplicaDeleteUnreliable(): void /** * Test the RebuildReplicasPatch with API failures - * @magentoConfigFixture current_store algoliasearch_credentials/credentials/enable_backend 1 + * @magentoConfigFixture current_store algoliasearch_indexing_manager/algolia_indexing/enable_indexing 1 * @magentoConfigFixture current_store algoliasearch_instant/instant/is_instant_enabled 1 */ public function testReplicaRebuildPatch(): void @@ -340,7 +338,7 @@ function() use ($replicas) { return $mock; } - protected function getMockReplicaManager($mockedMethods = array()): MockObject & ReplicaManager + protected function getMockReplicaManager($mockedMethods = []): MockObject & ReplicaManager { $mockedClass = ReplicaManager::class; $mockedReplicaManager = $this->getMockBuilder($mockedClass) diff --git a/Test/Integration/Indexing/Product/Traits/ReplicaAssertionsTrait.php b/Test/Integration/Indexing/Product/Traits/ReplicaAssertionsTrait.php index 545d24ca6..3d4dcd1fe 100644 --- a/Test/Integration/Indexing/Product/Traits/ReplicaAssertionsTrait.php +++ b/Test/Integration/Indexing/Product/Traits/ReplicaAssertionsTrait.php @@ -38,7 +38,8 @@ protected function assertReplicaIndexExists( ?int $storeId = null ): array { - $replicaSettings = $this->algoliaHelper->getSettings($replicaIndexName, $storeId); + $replicaIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($replicaIndexName, $storeId); + $replicaSettings = $this->algoliaConnector->getSettings($replicaIndexOptions); $this->assertArrayHasKey('primary', $replicaSettings); $this->assertEquals($primaryIndexName, $replicaSettings['primary']); return $replicaSettings; @@ -46,7 +47,8 @@ protected function assertReplicaIndexExists( protected function assertIndexNotExists(string $indexName, ?int $storeId = null): void { - $indexSettings = $this->algoliaHelper->getSettings($indexName, $storeId); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($indexName, $storeId); + $indexSettings = $this->algoliaConnector->getSettings($indexOptions); $this->assertCount(0, $indexSettings, "Settings found for index that should not exist"); } @@ -87,9 +89,7 @@ protected function isVirtualReplica(array $replicaSetting, string $replicaIndexN { return (bool) array_filter( $replicaSetting, - function ($replica) use ($replicaIndexName) { - return str_contains($replica, "virtual($replicaIndexName)"); - } + fn($replica) => str_contains((string) $replica, "virtual($replicaIndexName)") ); } @@ -109,10 +109,8 @@ protected function hasSortingAttribute($sortAttr, $sortDir): bool $sorting = $this->configHelper->getSorting(); return (bool) array_filter( $sorting, - function($sort) use ($sortAttr, $sortDir) { - return $sort['attribute'] == $sortAttr - && $sort['sort'] == $sortDir; - } + fn($sort) => $sort['attribute'] == $sortAttr + && $sort['sort'] == $sortDir ); } @@ -133,9 +131,7 @@ protected function assertNoSortingAttribute($sortAttr, $sortDir): void protected function mockSortUpdate(string $sortAttr, string $sortDir, array $attr, ?StoreInterface $store = null): void { $sorting = $this->configHelper->getSorting(!is_null($store) ? $store->getId() : null); - $existing = array_filter($sorting, function ($item) use ($sortAttr, $sortDir) { - return $item['attribute'] === $sortAttr && $item['sort'] === $sortDir; - }); + $existing = array_filter($sorting, fn($item) => $item['attribute'] === $sortAttr && $item['sort'] === $sortDir); if ($existing) { $idx = array_key_first($existing); diff --git a/Test/Integration/Indexing/Queue/QueueTest.php b/Test/Integration/Indexing/Queue/QueueTest.php index dd33e9e79..c851b05cf 100644 --- a/Test/Integration/Indexing/Queue/QueueTest.php +++ b/Test/Integration/Indexing/Queue/QueueTest.php @@ -3,12 +3,12 @@ namespace Algolia\AlgoliaSearch\Test\Integration\Indexing\Queue; use Algolia\AlgoliaSearch\Helper\ConfigHelper; -use Algolia\AlgoliaSearch\Model\Indexer\Product; use Algolia\AlgoliaSearch\Model\Indexer\QueueRunner; use Algolia\AlgoliaSearch\Model\IndicesConfigurator; use Algolia\AlgoliaSearch\Model\Job; use Algolia\AlgoliaSearch\Model\Queue; use Algolia\AlgoliaSearch\Model\ResourceModel\Job\CollectionFactory as JobsCollectionFactory; +use Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor as ProductBatchQueueProcessor; use Algolia\AlgoliaSearch\Test\Integration\TestCase; use Magento\Framework\App\ResourceConnection; use Magento\Framework\DB\Adapter\AdapterInterface; @@ -19,8 +19,6 @@ */ class QueueTest extends TestCase { - private const INCOMPLETE_REASON = "Must revisit transaction handling across connections."; - /** @var JobsCollectionFactory */ private $jobsCollectionFactory; @@ -53,9 +51,8 @@ public function testFill() $this->setConfig(ConfigHelper::IS_ACTIVE, '1'); $this->connection->query('TRUNCATE TABLE algoliasearch_queue'); - /** @var Product $indexer */ - $indexer = $this->objectManager->get(Product::class); - $indexer->executeFull(); + $productBatchQueueProcessor = $this->objectManager->get(ProductBatchQueueProcessor::class); + $productBatchQueueProcessor->processBatch(1); $rows = $this->connection->query('SELECT * FROM algoliasearch_queue')->fetchAll(); $this->assertEquals(3, count($rows)); @@ -90,9 +87,8 @@ public function testExecute() $this->setConfig(ConfigHelper::IS_ACTIVE, '1'); $this->connection->query('TRUNCATE TABLE algoliasearch_queue'); - /** @var Product $indexer */ - $indexer = $this->objectManager->get(Product::class); - $indexer->executeFull(); + $productBatchQueueProcessor = $this->objectManager->get(ProductBatchQueueProcessor::class); + $productBatchQueueProcessor->processBatch(1); /** @var Queue $queue */ $queue = $this->objectManager->get(Queue::class); @@ -100,9 +96,9 @@ public function testExecute() // Run the first two jobs - saveSettings, batch $queue->runCron(2, true); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); - $indices = $this->algoliaHelper->listIndexes(); + $indices = $this->algoliaConnector->listIndexes(); $existsDefaultTmpIndex = false; foreach ($indices['items'] as $index) { @@ -116,9 +112,9 @@ public function testExecute() // Run the last move - move $queue->runCron(2, true); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); - $indices = $this->algoliaHelper->listIndexes(); + $indices = $this->algoliaConnector->listIndexes(); $existsDefaultProdIndex = false; $existsDefaultTmpIndex = false; @@ -154,11 +150,10 @@ public function testSettings() $this->connection->query('DELETE FROM algoliasearch_queue'); // Reindex products multiple times - /** @var Product $indexer */ - $indexer = $this->objectManager->get(Product::class); - $indexer->executeFull(); - $indexer->executeFull(); - $indexer->executeFull(); + $productBatchQueueProcessor = $this->objectManager->get(ProductBatchQueueProcessor::class); + $productBatchQueueProcessor->processBatch(1); + $productBatchQueueProcessor->processBatch(1); + $productBatchQueueProcessor->processBatch(1); $rows = $this->connection->query('SELECT * FROM algoliasearch_queue')->fetchAll(); $this->assertEquals(9, count($rows)); @@ -173,9 +168,10 @@ public function testSettings() $rows = $this->connection->query('SELECT * FROM algoliasearch_queue')->fetchAll(); $this->assertEquals(0, count($rows)); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); - $settings = $this->algoliaHelper->getSettings($this->indexPrefix . 'default_products'); + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_products'); + $settings = $this->algoliaConnector->getSettings($indexOptions); $this->assertFalse(empty($settings['attributesForFaceting']), 'AttributesForFacetting should be set, but they are not.'); $this->assertFalse(empty($settings['searchableAttributes']), 'SearchableAttributes should be set, but they are not.'); } @@ -188,34 +184,35 @@ public function testMergeSettings() $this->connection->query('DELETE FROM algoliasearch_queue'); - /** @var Product $productIndexer */ - $productIndexer = $this->objectManager->get(Product::class); - $productIndexer->executeFull(); + $productBatchQueueProcessor = $this->objectManager->get(ProductBatchQueueProcessor::class); + $productBatchQueueProcessor->processBatch(1); $rows = $this->connection->query('SELECT * FROM algoliasearch_queue')->fetchAll(); $this->assertCount(3, $rows); $productionIndexName = $this->indexPrefix . 'default_products'; - $res = $this->algoliaHelper->setSettings($productionIndexName, ['disableTypoToleranceOnAttributes' => ['sku']]); - $this->algoliaHelper->waitLastTask(); + $productionIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($productionIndexName); + $this->algoliaConnector->setSettings($productionIndexOptions, ['disableTypoToleranceOnAttributes' => ['sku']]); + $this->algoliaConnector->waitLastTask(); - $settings = $this->algoliaHelper->getSettings($productionIndexName); + $settings = $this->algoliaConnector->getSettings($productionIndexOptions); $this->assertEquals(['sku'], $settings['disableTypoToleranceOnAttributes']); /** @var QueueRunner $queueRunner */ $queueRunner = $this->objectManager->get(QueueRunner::class); $queueRunner->executeFull(); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); - $settings = $this->algoliaHelper->getSettings($this->indexPrefix . 'default_products_tmp'); + $tmpIndexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($this->indexPrefix . 'default_products_tmp'); + $settings = $this->algoliaConnector->getSettings($tmpIndexOptions); $this->assertEquals(['sku'], $settings['disableTypoToleranceOnAttributes']); $queueRunner->executeFull(); $queueRunner->executeFull(); - $settings = $this->algoliaHelper->getSettings($productionIndexName); + $settings = $this->algoliaConnector->getSettings($productionIndexOptions); $this->assertEquals(['sku'], $settings['disableTypoToleranceOnAttributes']); } @@ -884,9 +881,8 @@ public function testMaxSingleJobsSizeOnProductReindex() $this->connection->query('TRUNCATE TABLE algoliasearch_queue'); - /** @var Product $indexer */ - $indexer = $this->objectManager->get(Product::class); - $indexer->execute(range(1, 512)); + $productBatchQueueProcessor = $this->objectManager->get(ProductBatchQueueProcessor::class); + $productBatchQueueProcessor->processBatch(1, range(1, 512)); $dbJobs = $this->connection->query('SELECT * FROM algoliasearch_queue')->fetchAll(); $this->assertSame(6, count($dbJobs)); diff --git a/Test/Integration/TestCase.php b/Test/Integration/TestCase.php index 3f2c3a01d..7129d1981 100644 --- a/Test/Integration/TestCase.php +++ b/Test/Integration/TestCase.php @@ -4,11 +4,10 @@ use Algolia\AlgoliaSearch\Exceptions\AlgoliaException; use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException; -use Algolia\AlgoliaSearch\Helper\AlgoliaHelper; use Algolia\AlgoliaSearch\Helper\ConfigHelper; use Algolia\AlgoliaSearch\Service\AlgoliaConnector; use Algolia\AlgoliaSearch\Service\IndexNameFetcher; -use Algolia\AlgoliaSearch\Service\Product\IndexOptionsBuilder; +use Algolia\AlgoliaSearch\Service\IndexOptionsBuilder; use Algolia\AlgoliaSearch\Setup\Patch\Schema\ConfigPatch; use Algolia\AlgoliaSearch\Test\Integration\AssertValues\Magento246CE; use Algolia\AlgoliaSearch\Test\Integration\AssertValues\Magento246EE; @@ -17,17 +16,10 @@ use Magento\Framework\App\Config\ScopeConfigInterface; use Magento\Framework\App\ProductMetadataInterface; use Magento\Framework\ObjectManagerInterface; -use Magento\InventoryMultiDimensionalIndexerApi\Model\IndexName; use Magento\Store\Model\ScopeInterface; use Magento\TestFramework\Helper\Bootstrap; -if (class_exists('PHPUnit\Framework\TestCase')) { - class_alias('PHPUnit\Framework\TestCase', '\TC'); -} else { - class_alias('\PHPUnit_Framework_TestCase', '\TC'); -} - -abstract class TestCase extends \TC +abstract class TestCase extends \PHPUnit\Framework\TestCase { /** * @var ObjectManagerInterface @@ -40,9 +32,6 @@ abstract class TestCase extends \TC /** @var string */ protected $indexPrefix; - /** @var AlgoliaHelper */ - protected $algoliaHelper; - /** @var ConfigHelper */ protected $configHelper; @@ -54,6 +43,7 @@ abstract class TestCase extends \TC protected ?string $indexSuffix = null; + protected ?IndexOptionsBuilder $indexOptionsBuilder = null; protected ?AlgoliaConnector $algoliaConnector = null; protected ?IndexNameFetcher $indexNameFetcher = null; @@ -69,7 +59,7 @@ protected function setUp(): void protected function tearDown(): void { $this->clearIndices(); - $this->algoliaHelper->waitLastTask(); + $this->algoliaConnector->waitLastTask(); $this->clearIndices(); // Remaining replicas } @@ -153,9 +143,7 @@ protected function getBootstrapConfig(): array return array_combine( $bootstrap, array_map( - function($setting) use ($config) { - return $config->getValue($setting, ScopeInterface::SCOPE_STORE); - }, + fn($setting) => $config->getValue($setting, ScopeInterface::SCOPE_STORE), $bootstrap ) ); @@ -175,15 +163,16 @@ protected function setConfigFromArray(array $settings): void protected function clearIndices() { - $indices = $this->algoliaHelper->listIndexes(); + $indices = $this->algoliaConnector->listIndexes(); foreach ($indices['items'] as $index) { $name = $index['name']; - if (mb_strpos($name, $this->indexPrefix) === 0) { + if (mb_strpos((string) $name, $this->indexPrefix) === 0) { try { - $this->algoliaHelper->deleteIndex($name); - } catch (AlgoliaException $e) { + $indexOptions = $this->indexOptionsBuilder->buildWithEnforcedIndex($name); + $this->algoliaConnector->deleteIndex($indexOptions); + } catch (AlgoliaException) { // Might be a replica } } @@ -234,7 +223,7 @@ private function bootstrap() $this->setConfig('algoliasearch_credentials/credentials/api_key', getenv('ALGOLIA_API_KEY')); $this->setConfig('algoliasearch_credentials/credentials/index_prefix', $this->indexPrefix); - $this->algoliaHelper = $this->getObjectManager()->create(AlgoliaHelper::class); + $this->indexOptionsBuilder = $this->objectManager->get(IndexOptionsBuilder::class); $this->algoliaConnector = $this->objectManager->get(AlgoliaConnector::class); $this->indexNameFetcher = $this->objectManager->get(IndexNameFetcher::class); @@ -266,7 +255,7 @@ protected function mockProperty(object $object, string $propertyName, string $pr */ protected function invokeMethod(object $object, string $methodName, array $parameters = []) { - $reflection = new \ReflectionClass(get_class($object)); + $reflection = new \ReflectionClass($object::class); return $reflection->getMethod($methodName)->invokeArgs($object, $parameters); } @@ -291,7 +280,7 @@ protected function getSerializer() * @param string|null $key - a unique key for this operation - if null a unique key will be derived * @return mixed */ - function runOnce(callable $callback, string $key = null): mixed + function runOnce(callable $callback, ?string $key = null): mixed { static $executed = []; $key ??= is_string($callback) ? $callback : spl_object_hash((object) $callback); diff --git a/Test/Integration/_files/backend_render_user_agents.php b/Test/Integration/_files/backend_render_user_agents.php index dd06ab02f..0d3d4b1de 100644 --- a/Test/Integration/_files/backend_render_user_agents.php +++ b/Test/Integration/_files/backend_render_user_agents.php @@ -8,6 +8,6 @@ // Set complex configuration value $scopeConfig->setValue( 'algoliasearch_advanced/advanced/backend_rendering_allowed_user_agents', - join("\n", ["Googlebot", "Bingbot", "Foobot"]), + implode("\n", ["Googlebot", "Bingbot", "Foobot"]), \Magento\Store\Model\ScopeInterface::SCOPE_STORE ); 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 28c49ee0a..468512dfb 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 @@ -67,10 +67,10 @@ $configManager = $objectManager->get(\Magento\Framework\App\Config\MutableScopeConfigInterface::class); // Temporarily disable indexing during product assignment to stores -$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'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 0, 'store', 'admin'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 0, 'store', 'default'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 0, 'store', 'fixture_second_store'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 0, 'store', 'fixture_third_store'); $productSkus = MultiStoreProductsTest::SKUS; $productRepository = Bootstrap::getObjectManager() @@ -82,10 +82,10 @@ $productRepository->save($product); } -$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'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 1, 'store', 'admin'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 1, 'store', 'default'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 1, 'store', 'fixture_second_store'); +$configManager->setValue('algoliasearch_indexing_manager/algolia_indexing/enable_indexing', 1, 'store', 'fixture_third_store'); /* Refresh CatalogSearch index */ /** @var IndexerRegistry $indexerRegistry */ diff --git a/Test/Unit/Controller/Adminhtml/IndexingManager/ReindexTest.php b/Test/Unit/Controller/Adminhtml/IndexingManager/ReindexTest.php new file mode 100644 index 000000000..026860658 --- /dev/null +++ b/Test/Unit/Controller/Adminhtml/IndexingManager/ReindexTest.php @@ -0,0 +1,247 @@ + "foo", "2" => "bar"]; + + protected function setUp(): void + { + $this->request = $this->createMock(RequestInterface::class); + $this->messageManager = $this->createMock(ManagerInterface::class); + $this->resultFactory = $this->createMock(ResultFactory::class); + $resultInstance = $this->createMock(Redirect::class); + $resultInstance->method('setPath')->willReturn(''); + $this->resultFactory->method('create') + ->with(ResultFactory::TYPE_REDIRECT) + ->willReturn($resultInstance); + + $this->context = $this->createMock(Context::class); + $this->context->method('getRequest')->willReturn($this->request); + $this->context->method('getMessageManager')->willReturn($this->messageManager); + $this->context->method('getResultFactory')->willReturn($this->resultFactory); + + $this->storeManager = $this->createMock(StoreManagerInterface::class); + $this->storeManager->method('getStores')->willReturn($this->stores); + + $this->storeNameFetcher = $this->createMock(StoreNameFetcher::class); + $this->indexNameFetcher = $this->createMock(IndexNameFetcher::class); + $this->configHelper = $this->createMock(ConfigHelper::class); + $this->productBatchQueueProcessor = $this->createMock(ProductBatchQueueProcessor::class); + $this->categoryBatchQueueProcessor = $this->createMock(CategoryBatchQueueProcessor::class); + $this->pageBatchQueueProcessor = $this->createMock(PageBatchQueueProcessor::class); + + $this->reindexController = new ReindexTestable( + $this->context, + $this->storeManager, + $this->storeNameFetcher, + $this->indexNameFetcher, + $this->configHelper, + $this->productBatchQueueProcessor, + $this->categoryBatchQueueProcessor, + $this->pageBatchQueueProcessor + ); + } + + public function testExecuteFullIndexingAllEntitiesAllStores() + { + $this->request + ->expects($this->once()) + ->method('getParams') + ->willReturn([ + "store_id" => null, + "entity" => "all", + ]); + + $this->productBatchQueueProcessor + ->expects($this->exactly(2)) + ->method('processBatch'); + + $this->categoryBatchQueueProcessor + ->expects($this->exactly(2)) + ->method('processBatch'); + + $this->pageBatchQueueProcessor + ->expects($this->exactly(2)) + ->method('processBatch'); + + $this->reindexController->execute(); + } + + public function testExecuteFullIndexingPagesAllStores() + { + $this->request + ->expects($this->once()) + ->method('getParams') + ->willReturn([ + "store_id" => null, + "entity" => "pages", + ]); + + $this->productBatchQueueProcessor + ->expects($this->never()) + ->method('processBatch'); + + $this->categoryBatchQueueProcessor + ->expects($this->never()) + ->method('processBatch'); + + $this->pageBatchQueueProcessor + ->expects($this->exactly(2)) + ->method('processBatch'); + + $this->reindexController->execute(); + } + + public function testExecuteFullIndexingProductsOneStore() + { + $this->request + ->expects($this->once()) + ->method('getParams') + ->willReturn([ + "store_id" => "1", + "entity" => "products", + ]); + + $this->productBatchQueueProcessor + ->expects($this->once()) + ->method('processBatch'); + + $this->categoryBatchQueueProcessor + ->expects($this->never()) + ->method('processBatch'); + + $this->pageBatchQueueProcessor + ->expects($this->never()) + ->method('processBatch'); + + $this->reindexController->execute(); + } + + public function testExecuteProductsMassAction() + { + $selectedProducts = [2, 3, 4]; + + $this->request + ->expects($this->once()) + ->method('getParams') + ->willReturn([ + "store_id" => null, + "namespace" => "product_listing", + "selected" => $selectedProducts, + ]); + + $this->productBatchQueueProcessor + ->expects($this->exactly(2)) + ->method('processBatch') + ->with(1 || 2, $selectedProducts); + + $this->categoryBatchQueueProcessor + ->expects($this->never()) + ->method('processBatch'); + + $this->pageBatchQueueProcessor + ->expects($this->never()) + ->method('processBatch'); + + $this->reindexController->execute(); + } + + /** + * @dataProvider entityParamsProvider + */ + public function testEntityToIndex($params, $result) + { + $this->assertEquals($result, $this->reindexController->defineEntitiesToIndex($params)); + } + + public static function entityParamsProvider(): array + { + return [ + [ + 'params' => [], + 'result' => [], + ], + [ + 'params' => ['entity' => 'all'], + 'result' => ['products', 'categories', 'pages'], + ], + [ + 'params' => ['entity' => 'categories'], + 'result' => ['categories'], + ], + [ + 'params' => ['namespace' => 'product_listing'], + 'result' => ['products'], + ], + [ + 'params' => ['namespace' => 'cms_page_listing'], + 'result' => ['pages'], + ], + ]; + } + + /** + * @dataProvider redirectParamsProvider + */ + public function testRedirectPath($params, $result) + { + $this->assertEquals($result, $this->reindexController->defineRedirectPath($params)); + } + + public static function redirectParamsProvider(): array + { + return [ + [ + 'params' => [], + 'result' => '*/*/', + ], + [ + 'params' => ['foo' => 'bar'], + 'result' => '*/*/', + ], + [ + 'params' => ['redirect' => 'my/custom/url'], + 'result' => 'my/custom/url', + ], + [ + 'params' => ['namespace' => 'product_listing'], + 'result' => 'catalog/product/index', + ], + [ + 'params' => ['namespace' => 'cms_page_listing'], + 'result' => 'cms/page/index', + ], + ]; + } +} diff --git a/Test/Unit/Controller/Adminhtml/IndexingManager/ReindexTestable.php b/Test/Unit/Controller/Adminhtml/IndexingManager/ReindexTestable.php new file mode 100644 index 000000000..647a6ac90 --- /dev/null +++ b/Test/Unit/Controller/Adminhtml/IndexingManager/ReindexTestable.php @@ -0,0 +1,18 @@ +moduleResource = $this->createMock(ResourceInterface::class); $this->productMetadata = $this->createMock(ProductMetadataInterface::class); $this->eventManager = $this->createMock(ManagerInterface::class); - $this->serializer = $this->createMock(SerializerInterface::class); + $this->serializer = $this->createMock(Serializer::class); $this->groupCollection = $this->createMock(GroupCollection::class); $this->groupExcludedWebsiteRepository = $this->createMock(GroupExcludedWebsiteRepositoryInterface::class); $this->cookieHelper = $this->createMock(CookieHelper::class); + $this->autocompleteHelper = $this->createMock(AutocompleteHelper::class); + $this->instantSearchHelper = $this->createMock(InstantSearchHelper::class); $this->configHelper = new ConfigHelperTestable( $this->configInterface, @@ -63,7 +70,9 @@ protected function setUp(): void $this->serializer, $this->groupCollection, $this->groupExcludedWebsiteRepository, - $this->cookieHelper + $this->cookieHelper, + $this->autocompleteHelper, + $this->instantSearchHelper ); } @@ -78,22 +87,4 @@ public function testGetIndexPrefixWhenNull() { $this->configInterface->method('getValue')->willReturn(null); $this->assertEquals('', $this->configHelper->getIndexPrefix()); } - - public function testSerializerReturnsString() { - $this->serializer->method('serialize')->willReturn('{"foo":"bar"}'); - $array = [ - 'foo' => 'bar' - ]; - $result = $this->configHelper->serialize($array); - $this->assertEquals('{"foo":"bar"}', $result); - } - - public function testSerializerFailure() { - $this->serializer->method('serialize')->willReturn(false); - $array = [ - 'foo' => 'bar' - ]; - $result = $this->configHelper->serialize($array); - $this->assertEquals('', $result); - } } diff --git a/Test/Unit/Logger/AlgoliaLoggerTest.php b/Test/Unit/Logger/AlgoliaLoggerTest.php deleted file mode 100644 index a57d31eae..000000000 --- a/Test/Unit/Logger/AlgoliaLoggerTest.php +++ /dev/null @@ -1,61 +0,0 @@ -systemLoggerHandler = $this->createMock(SystemLoggerHandler::class); - $this->algoliaLoggerHandler = $this->createMock(AlgoliaLoggerHandler::class); - - $this->algoliaLogger = new Logger( - 'algolia', - [ $this->systemLoggerHandler, $this->algoliaLoggerHandler ] - ); - } - - public function testLog(): void - { - $expectedLogLevel = \Monolog\Logger::INFO; - $this->systemLoggerHandler - ->expects($this->once()) - ->method('isHandling') - ->with(['level' => $expectedLogLevel]) - ->willReturn(false); - $this->systemLoggerHandler->expects($this->never())->method('handle'); - $this->algoliaLoggerHandler - ->expects($this->once()) - ->method('isHandling') - ->with(['level' => $expectedLogLevel]) - ->willReturn(true); - $this->algoliaLoggerHandler->expects($this->once())->method('handle'); - $this->algoliaLogger->info("Test log message"); - } - - public function testError(): void - { - $expectedLogLevel = \Monolog\Logger::ERROR; - $this->systemLoggerHandler - ->expects($this->once()) - ->method('isHandling') - ->with(['level' => $expectedLogLevel]) - ->willReturn(true); - $this->systemLoggerHandler->expects($this->once())->method('handle'); - $this->algoliaLoggerHandler - ->expects($this->never()) - ->method('isHandling'); - $this->algoliaLoggerHandler->expects($this->once())->method('handle'); - $this->algoliaLogger->error("Test error message"); - } -} diff --git a/Test/Unit/Logger/DiagnosticLoggerTest.php b/Test/Unit/Logger/DiagnosticLoggerTest.php index 92111e7b3..570a9e48c 100644 --- a/Test/Unit/Logger/DiagnosticLoggerTest.php +++ b/Test/Unit/Logger/DiagnosticLoggerTest.php @@ -10,10 +10,10 @@ class DiagnosticLoggerTest extends TestCase { - protected ConfigHelper $configHelper; - protected TimedLogger $timedLogger; - protected StoreNameFetcher $storeNameFetcher; - protected DiagnosticsLogger $diagnosticsLogger; + protected ?ConfigHelper $configHelper; + protected ?TimedLogger $timedLogger; + protected ?StoreNameFetcher $storeNameFetcher; + protected ?DiagnosticsLogger $diagnosticsLogger; protected function setUp(): void { diff --git a/Test/Unit/Logger/Handler/AbstractHandlerTestCase.php b/Test/Unit/Logger/Handler/AbstractHandlerTestCase.php new file mode 100644 index 000000000..09ab41ef0 --- /dev/null +++ b/Test/Unit/Logger/Handler/AbstractHandlerTestCase.php @@ -0,0 +1,45 @@ +convertLevelToEnum($level); + return new \Monolog\LogRecord( + new \DateTimeImmutable(), + 'test', + $levelEnum, + $message + ); + } + + // Monolog v2 + return [ + 'message' => $message, + 'level' => $level + ]; + } + + protected function convertLevelToEnum(int $level): \Monolog\Level + { + if (class_exists(\Monolog\Level::class)) { + return \Monolog\Level::from($level); + } + + throw new \RuntimeException('Monolog v3 Level enum not available'); + } + +} diff --git a/Test/Unit/Logger/Handler/AlgoliaLoggerHandlerTest.php b/Test/Unit/Logger/Handler/AlgoliaLoggerHandlerTest.php new file mode 100644 index 000000000..3c8ff519a --- /dev/null +++ b/Test/Unit/Logger/Handler/AlgoliaLoggerHandlerTest.php @@ -0,0 +1,38 @@ +handler = new AlgoliaLoggerHandler( + $this->createMock(DriverInterface::class) + ); + } + + public function testAlgoliaHandlerLogsEverything(): void + { + $debugRecord = $this->makeLogRecord( + \Monolog\Logger::DEBUG, + 'Should log' + ); + + $infoRecord = $this->makeLogRecord( + \Monolog\Logger::INFO, + 'Should log' + ); + + $errorRecord = $this->makeLogRecord( + \Monolog\Logger::ERROR, + 'Should log' + ); + + $this->assertTrue($this->handler->isHandling($debugRecord), 'DEBUG should be handled'); + $this->assertTrue($this->handler->isHandling($infoRecord), 'INFO should be handled'); + $this->assertTrue($this->handler->isHandling($errorRecord), 'ERROR should be handled'); + } +} diff --git a/Test/Unit/Logger/Handler/SystemLoggerHandlerTest.php b/Test/Unit/Logger/Handler/SystemLoggerHandlerTest.php new file mode 100644 index 000000000..819b0ddd9 --- /dev/null +++ b/Test/Unit/Logger/Handler/SystemLoggerHandlerTest.php @@ -0,0 +1,37 @@ +handler = new SystemLoggerHandler( + $this->createMock(DriverInterface::class), + $this->createMock(ExceptionHandler::class), + ); + } + + public function testSystemHandlerFiltersBelowError(): void + { + $infoRecord = $this->makeLogRecord( + \Monolog\Logger::INFO, + 'Should not log' + ); + + $errorRecord = $this->makeLogRecord( + \Monolog\Logger::ERROR, + 'Should log' + ); + + $this->assertFalse($this->handler->isHandling($infoRecord), 'INFO should be ignored'); + $this->assertTrue($this->handler->isHandling($errorRecord), 'ERROR should be handled'); + } +} diff --git a/Test/Unit/Model/Backend/QueueCronTest.php b/Test/Unit/Model/Backend/QueueCronTest.php new file mode 100644 index 000000000..319bb354c --- /dev/null +++ b/Test/Unit/Model/Backend/QueueCronTest.php @@ -0,0 +1,109 @@ +createMock(Context::class); + $eventDispatcher = $this->createMock(ManagerInterface::class); + $context->method('getEventDispatcher')->willReturn($eventDispatcher); + + $registry = $this->createMock(Registry::class); + $config = $this->createMock(ScopeConfigInterface::class); + $cacheTypeList = $this->createMock(TypeListInterface::class); + + $this->queueCronModel = new QueueCron($context, $registry, $config, $cacheTypeList); + } + + /** + * @dataProvider valuesProvider + */ + public function testInput($value, $isValid, $canReplay = true): void + { + $this->queueCronModel->setValue($value); + + try { + $result = $this->queueCronModel->beforeSave(); + $this->assertIsObject($result); + } catch (InvalidCronException $exception) { + $this->assertEquals( + false, + $isValid, + "Cron expression \"$value\" is not valid but it should be." + ); + + $msg = $canReplay + ? "Cron expression \"$value\" is not valid." + : "Cron expression is invalid."; + $this->assertEquals( + $msg, + $exception->getMessage() + ); + } + } + + public static function valuesProvider(): array + { + return [ + [ + 'value' => '', + 'isValid' => false + ], + [ + 'value' => 'foo', + 'isValid' => false + ], + [ + 'value' => '*/5 * * * *', + 'isValid' => true + ], + [ + 'value' => '*/10 * * * *', + 'isValid' => true + ], + [ + 'value' => '0 0 1 1 *', + 'isValid' => true + ], + [ + 'value' => '0 0 * * 5', + 'isValid' => true + ], + [ + 'value' => '*/10 * * *', // One less property + 'isValid' => false + ], + [ + 'value' => '*/10 * * * * *', // One more property + 'isValid' => false + ], + [ + 'value' => '@daily', // Working alias + 'isValid' => true + ], + [ + 'value' => '@foo', // Not working alias + 'isValid' => false + ], + [ + 'value' => '">', + 'isValid' => false, + 'canReplay' => false + ] + ]; + } + +} diff --git a/Test/Unit/Plugin/RenderingCacheContextPluginTest.php b/Test/Unit/Plugin/RenderingCacheContextPluginTest.php index 6c795da0a..b88f24273 100644 --- a/Test/Unit/Plugin/RenderingCacheContextPluginTest.php +++ b/Test/Unit/Plugin/RenderingCacheContextPluginTest.php @@ -3,6 +3,7 @@ namespace Algolia\AlgoliaSearch\Test\Unit\Plugin; use Algolia\AlgoliaSearch\Helper\ConfigHelper; +use Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper; use Algolia\AlgoliaSearch\Plugin\RenderingCacheContextPlugin; use Magento\Framework\App\Http\Context as HttpContext; use Magento\Framework\App\Request\Http; @@ -10,24 +11,26 @@ use Magento\Store\Model\StoreManagerInterface; use Magento\UrlRewrite\Model\UrlFinderInterface; use PHPUnit\Framework\TestCase; - class RenderingCacheContextPluginTest extends TestCase { protected ?RenderingCacheContextPlugin $plugin; protected ?ConfigHelper $configHelper; + + protected ?InstantSearchHelper $instantSearchHelper; protected ?StoreManagerInterface $storeManager; protected ?Http $request; protected ?UrlFinderInterface $urlFinder; - protected function setUp(): void { $this->configHelper = $this->createMock(ConfigHelper::class); + $this->instantSearchHelper = $this->createMock(InstantSearchHelper::class); $this->storeManager = $this->createMock(StoreManagerInterface::class); $this->request = $this->createMock(Http::class); $this->urlFinder = $this->createMock(UrlFinderInterface::class); $this->plugin = new RenderingCacheContextPluginTestable( $this->configHelper, + $this->instantSearchHelper, $this->storeManager, $this->request, $this->urlFinder @@ -47,7 +50,7 @@ public function testAfterGetDataAddsRenderingContextNoBackendRender(): void $this->storeManager->method('getStore')->willReturn($this->getStoreMock()); $this->request->method('getControllerName')->willReturn('category'); - $this->configHelper->method('replaceCategories')->willReturn(true); + $this->instantSearchHelper->method('shouldReplaceCategories')->willReturn(true); $result = $this->plugin->afterGetData( $this->createMock(HttpContext::class), @@ -66,7 +69,7 @@ public function testAfterGetDataAddsRenderingContextWithBackendRender(): void $this->storeManager->method('getStore')->willReturn($this->getStoreMock()); $this->request->method('getControllerName')->willReturn('category'); - $this->configHelper->method('replaceCategories')->willReturn(true); + $this->instantSearchHelper->method('shouldReplaceCategories')->willReturn(true); $result = $this->plugin->afterGetData( $this->createMock(HttpContext::class), @@ -86,7 +89,7 @@ public function testAfterGetDataDoesNotModifyDataIfNotApplicable(): void $this->request->method('getControllerName')->willReturn('product'); $this->request->method('getRequestUri')->willReturn('some-product.html'); - $this->configHelper->method('replaceCategories')->willReturn(false); + $this->instantSearchHelper->method('shouldReplaceCategories')->willReturn(false); $data = ['existing_key' => 'existing_value']; $result = $this->plugin->afterGetData($subject, $data); @@ -121,7 +124,7 @@ public function testShouldApplyCacheContext(): void $this->storeManager->method('getStore')->willReturn($this->getStoreMock()); $this->request->method('getControllerName')->willReturn('category'); - $this->configHelper->method('replaceCategories')->willReturn(true); + $this->instantSearchHelper->method('shouldReplaceCategories')->willReturn(true); $this->assertTrue($this->plugin->shouldApplyCacheContext()); } diff --git a/Test/Unit/Service/EventProcessorTest.php b/Test/Unit/Service/EventProcessorTest.php new file mode 100644 index 000000000..b05ddec05 --- /dev/null +++ b/Test/Unit/Service/EventProcessorTest.php @@ -0,0 +1,188 @@ +client = $this->createMock(InsightsClient::class); + $this->userToken = 'foo'; + $this->authenticatedUserToken = 'authenticated-foo'; + $this->storeManager = $this->createMock(StoreManagerInterface::class); + + $store = $this->createMock(Store::class); + $store->method('getId')->willReturn(1); + $this->storeManager->method('getStore')->willReturn($store); + $this->taxConfig = $this->createMock(TaxConfig::class); + + $this->eventProcessor = new EventProcessorTestable( + $this->taxConfig, + $this->client, + $this->userToken, + $this->authenticatedUserToken, + $this->storeManager + ); + } + + /** + * @dataProvider orderItemsProvider + */ + public function testObjectDataForPurchase($priceIncludesTax, $orderItemsData, $expectedResult, $expectedTotalRevenue): void + { + $this->taxConfig->method('priceIncludesTax')->willReturn($priceIncludesTax); + + $orderItems = []; + + foreach ($orderItemsData as $orderItemData) { + $orderItem = $this->getMockBuilder(OrderItem::class) + ->disableOriginalConstructor() + ->getMock(); + + foreach ($orderItemData as $method => $value){ + $orderItem->method($method)->willReturn($value); + } + + $orderItems[] = $orderItem; + } + + $object = $this->eventProcessor->getObjectDataForPurchase($orderItems); + $this->assertEquals($expectedResult, $object); + + $totalRevenue = $this->eventProcessor->getTotalRevenueForEvent($object); + $this->assertEquals($expectedTotalRevenue, $totalRevenue); + } + + public static function orderItemsProvider(): array + { + return [ + [ // One item + 'priceIncludesTax' => true, + 'orderItemsData' => [ + [ + 'getPrice' => 32.00, + 'getPriceInclTax' => 32.00, + 'getOriginalPrice' => 32.00, + 'getDiscountAmount' => 0.00, + 'getQtyOrdered' => 1, + ] + ], + 'expectedResult' => [ + [ + 'price' => 32.00, + 'discount' => 0.00, + 'quantity' => 1, + ] + ], + 'expectedTotalRevenue' => 32.00 + ], + [ // One item (tax excluded) + 'priceIncludesTax' => false, + 'orderItemsData' => [ + [ + 'getPrice' => 25.00, + 'getPriceInclTax' => 32.00, + 'getOriginalPrice' => 25.00, + 'getDiscountAmount' => 0.00, + 'getQtyOrdered' => 1, + ] + ], + 'expectedResult' => [ + [ + 'price' => 25.00, + 'discount' => 0.00, + 'quantity' => 1, + ] + ], + 'expectedTotalRevenue' => 25.00 + ], + [ // One item with discount + 'priceIncludesTax' => true, + 'orderItemsData' => [ + [ + 'getPrice' => 32.00, + 'getPriceInclTax' => 32.00, + 'getOriginalPrice' => 32.00, + 'getDiscountAmount' => 7.00, + 'getQtyOrdered' => 1, + ] + ], + 'expectedResult' => [ + [ + 'price' => 25.00, + 'discount' => 7.00, + 'quantity' => 1, + ] + ], + 'expectedTotalRevenue' => 25.00 + ], + [ // One item with discount (tax excluded) + 'priceIncludesTax' => false, + 'orderItemsData' => [ + [ + 'getPrice' => 25.00, + 'getPriceInclTax' => 32.00, + 'getOriginalPrice' => 25.00, + 'getDiscountAmount' => 7.00, + 'getQtyOrdered' => 1, + ] + ], + 'expectedResult' => [ + [ + 'price' => 18.00, + 'discount' => 7.00, + 'quantity' => 1, + ] + ], + 'expectedTotalRevenue' => 18.00 + ], + [ // Two items + 'priceIncludesTax' => true, + 'orderItemsData' => [ + [ + 'getPrice' => 32.00, + 'getPriceInclTax' => 32.00, + 'getOriginalPrice' => 32.00, + 'getDiscountAmount' => 7.00, + 'getQtyOrdered' => 1, + ], + [ + 'getPrice' => 32.00, + 'getPriceInclTax' => 32.00, + 'getOriginalPrice' => 32.00, + 'getDiscountAmount' => 0.00, + 'getQtyOrdered' => 2, + ], + ], + 'expectedResult' => [ + [ + 'price' => 25.00, + 'discount' => 7.00, + 'quantity' => 1, + ], + [ + 'price' => 32.00, + 'discount' => 0.00, + 'quantity' => 2, + ] + ], + 'expectedTotalRevenue' => 89.00 // 25 + 32*2 + ], + ]; + } +} diff --git a/Test/Unit/Service/EventProcessorTestable.php b/Test/Unit/Service/EventProcessorTestable.php new file mode 100644 index 000000000..5a1e68493 --- /dev/null +++ b/Test/Unit/Service/EventProcessorTestable.php @@ -0,0 +1,18 @@ +connector = $this->createMock(AlgoliaConnector::class); + $this->config = $this->createMock(ConfigHelper::class); + $this->indexOptions = $this->createMock(IndexOptionsInterface::class); + + $this->handler = new IndexSettingsHandlerTestable($this->connector, $this->config); + } + + public function testSetSettingsWithForwardingEnabledAndMixedSettings(): void + { + $storeId = 1; + $settings = [ + 'customRanking' => ['desc(price)'], + 'attributesToRetrieve' => ['name', 'price'] + ]; + + $this->indexOptions->method('getStoreId')->willReturn($storeId); + $this->config->method('shouldForwardPrimaryIndexSettingsToReplicas') + ->with($storeId) + ->willReturn(true); + + $invocationCount = 0; + $this->connector->expects($this->exactly(2)) + ->method('setSettings') + ->willReturnCallback( + function($indexOptions, $indexSettings, $forwardToReplicas, $mergeSettings, $mergeFrom) use (&$invocationCount) { + $invocationCount++; + + switch ($invocationCount) { + case 1: + $this->assertEquals(['attributesToRetrieve' => ['name', 'price']], $indexSettings); + $this->assertTrue($forwardToReplicas); + $this->assertFalse($mergeSettings); + break; + case 2: + $this->assertEquals(['customRanking' => ['desc(price)']], $indexSettings); + $this->assertFalse($forwardToReplicas); + $this->assertTrue($mergeSettings); + break; + } + }); + + $this->handler->setSettings($this->indexOptions, $settings); + } + + public function testSetSettingsWithForwardingEnabledOnlyExcludedSettings(): void + { + $storeId = 1; + $settings = [ + 'ranking' => ['asc(name)'], + 'customRanking' => ['desc(price)'] + ]; + + $this->indexOptions->method('getStoreId')->willReturn($storeId); + $this->config->method('shouldForwardPrimaryIndexSettingsToReplicas') + ->willReturn(true); + + // Only one call expected (no forwarded settings since they are sorts) + $this->connector->expects($this->once()) + ->method('setSettings') + ->with( + $this->indexOptions, + $settings, + false, + true, + '' + ); + + $this->handler->setSettings($this->indexOptions, $settings); + } + + public function testSetSettingsWithForwardingEnabledOnlyForwardableSettings(): void + { + $storeId = 1; + $settings = [ + 'attributesToHighlight' => ['title'], + 'attributesToRetrieve' => ['name'] + ]; + + $this->indexOptions->method('getStoreId')->willReturn($storeId); + $this->config->method('shouldForwardPrimaryIndexSettingsToReplicas') + ->willReturn(true); + + // Only one call expected (all forwarded - no excluded settings) + $this->connector->expects($this->once()) + ->method('setSettings') + ->with( + $this->indexOptions, + $settings, + true, + false + ); + + $this->handler->setSettings($this->indexOptions, $settings); + } + + public function testSetSettingsWithForwardingDisabled(): void + { + $storeId = 1; + $settings = [ + 'customRanking' => ['desc(price)'], + 'attributesToRetrieve' => ['name', 'price'] + ]; + + $this->indexOptions->method('getStoreId')->willReturn($storeId); + $this->config->method('shouldForwardPrimaryIndexSettingsToReplicas') + ->willReturn(false); + + $this->connector->expects($this->once()) + ->method('setSettings') + ->with( + $this->indexOptions, + $settings, + false, + true, + '' + ); + + $this->handler->setSettings($this->indexOptions, $settings); + } + + public function testForwardSettingsWithEmptyInput(): void + { + $storeId = 1; + $settings = []; + + $this->indexOptions->method('getStoreId')->willReturn($storeId); + $this->config->method('shouldForwardPrimaryIndexSettingsToReplicas') + ->willReturn(true); + + // Connector should not be called + $this->connector->expects($this->never())->method('setSettings'); + + $this->handler->setSettings($this->indexOptions, $settings); + } + + + public function testSplitSettings(): void + { + $settings = [ + 'customRanking' => ['desc(price)'], + 'ranking' => ['asc(name)'], + 'attributesToRetrieve' => ['name'] + ]; + + [$forward, $noForward] = $this->handler->splitSettings($settings); + + $this->assertEquals(['attributesToRetrieve' => ['name']], $forward); + $this->assertEquals([ + 'customRanking' => ['desc(price)'], + 'ranking' => ['asc(name)'] + ], $noForward); + } +} diff --git a/Test/Unit/Service/IndexSettingsHandlerTestable.php b/Test/Unit/Service/IndexSettingsHandlerTestable.php new file mode 100644 index 000000000..197394636 --- /dev/null +++ b/Test/Unit/Service/IndexSettingsHandlerTestable.php @@ -0,0 +1,13 @@ +configHelper = $this->createMock(ConfigHelper::class); + $this->storeManager = $this->createMock(StoreManagerInterface::class); + $this->groupCollection = $this->createMock(GroupCollection::class); + $this->groupExcludedWebsiteRepository = $this->createMock(GroupExcludedWebsiteRepositoryInterface::class); + + $this->facetBuilder = new FacetBuilderTestable( + $this->configHelper, + $this->storeManager, + $this->groupCollection, + $this->groupExcludedWebsiteRepository + ); + } + + /** + * @throws NoSuchEntityException + * @throws LocalizedException + */ + public function testGetAttributesForFacetingReturnsCorrectFacets(): void + { + $storeId = 1; + $websiteId = 2; + + $this->mockFacets(); + $this->mockGroups(); + + $this->mockStoreConfig($storeId, $websiteId); + + $this->configHelper + ->method('isCustomerGroupsEnabled') + ->with($storeId) + ->willReturn(true); + + $this->groupExcludedWebsiteRepository + ->method('getCustomerGroupExcludedWebsites') + ->willReturn([]); + + $result = $this->facetBuilder->getAttributesForFaceting($storeId); + + $this->assertContains('brand', $result); + $this->assertContains('searchable(color)', $result); + $this->assertContains('price.EUR.group_1', $result); + $this->assertContains('price.USD.group_2', $result); + } + + public function testGetAttributesForFacetingRespectsGroupPriceSetting(): void + { + $storeId = 1; + $websiteId = 2; + + $this->mockFacets(); + $this->mockGroups(); + + $this->mockStoreConfig($storeId, $websiteId); + + $this->configHelper + ->method('isCustomerGroupsEnabled') + ->with($storeId) + ->willReturn(false); + + $result = $this->facetBuilder->getAttributesForFaceting($storeId); + + $this->assertContains('brand', $result); + $this->assertContains('searchable(color)', $result); + $this->assertNotContains('price.EUR.group_1', $result); + $this->assertNotContains('price.USD.group_2', $result); + } + + public function testGetAttributesForFacetingExcludesWebsites(): void + { + $storeId = 1; + $websiteId = 2; + + $this->mockFacets(); + $this->mockGroups(); + + $this->mockStoreConfig($storeId, $websiteId); + + $this->configHelper + ->method('isCustomerGroupsEnabled') + ->with($storeId) + ->willReturn(true); + + $this->groupExcludedWebsiteRepository + ->method('getCustomerGroupExcludedWebsites') + ->willReturn([$websiteId]); + + $result = $this->facetBuilder->getAttributesForFaceting($storeId); + + $this->assertContains('brand', $result); + $this->assertContains('searchable(color)', $result); + $this->assertNotContains('price.EUR.group_1', $result); + $this->assertNotContains('price.USD.group_2', $result); + } + + + /** + * attributesForFaceting must include level0 to be selectable via renderingContent/merch rule UI + * @return void + * @throws LocalizedException + * @throws NoSuchEntityException + */ + public function testGetAttributesForFacetingIncludesCategoryLevel0(): void + { + $storeId = 1; + $this->mockFacets(); + $this->mockCategoryConfig($storeId); + $result = $this->facetBuilder->getAttributesForFaceting($storeId); + $this->assertContains('categories.level0', $result); + } + + /** + * If category PLPs are supported then attributesForFaceting must contain category merch meta data + * @return void + * @throws LocalizedException + * @throws NoSuchEntityException + */ + public function testGetAttributesForFacetingIncludesMerchMetaData(): void + { + $storeId = 1; + $this->mockFacets(); + $this->mockCategoryConfig($storeId); + + $result = $this->facetBuilder->getAttributesForFaceting($storeId); + + $this->assertContains('categories', $result); + $this->assertContains('categoryIds', $result); + $this->assertNotContains('categoryPageId', $result); + } + + /* + * When visual merchandising is enabled through Merchandising Studio then a searchable + * category page ID (default categoryPageId) must be added to attributesForFaceting + * + * @return void + * @throws LocalizedException + * @throws NoSuchEntityException + */ + public function testGetAttributesForFacetingIncludesVisualMerchData(): void + { + $storeId = 1; + $this->mockFacets(); + $this->mockCategoryConfig($storeId); + $this->mockVisualMerchEnablement($storeId); + + $result = $this->facetBuilder->getAttributesForFaceting($storeId); + + $this->assertContains('searchable(categoryPageId)', $result); + } + + /** + * @throws NoSuchEntityException + * @throws LocalizedException + */ + public function testGetRenderingContentReturnsExpectedFormat(): void + { + $storeId = 1; + $websiteId = 2; + $this->mockFacets(); + $this->mockGroups(); + $this->mockStoreConfig($storeId, $websiteId); + + $this->configHelper + ->method('isCustomerGroupsEnabled') + ->with($storeId) + ->willReturn(true); + + $this->groupExcludedWebsiteRepository + ->method('getCustomerGroupExcludedWebsites') + ->willReturn([]); + + $result = $this->facetBuilder->getRenderingContent($storeId); + + $this->assertIsArray($result); + $this->assertArrayHasKey('facetOrdering', $result); + $this->assertArrayHasKey('facets', $result['facetOrdering']); + $this->assertArrayHasKey('order', $result['facetOrdering']['facets']); + $this->assertArrayHasKey('values', $result['facetOrdering']); + $this->assertArrayHasKey('brand', $result['facetOrdering']['values']); + $this->assertArrayHasKey('sortRemainingBy', $result['facetOrdering']['values']['brand']); + $this->assertContains('brand', $result['facetOrdering']['facets']['order']); + $this->assertContains('price.EUR.group_1', $result['facetOrdering']['facets']['order']); + $this->assertContains('price.USD.group_2', $result['facetOrdering']['facets']['order']); + $this->assertEquals(count($result['facetOrdering']['facets']['order']), count($result['facetOrdering']['values'])); + } + + /** + * Categories must be added to renderingContent as level0 + * `categories` Object attribute should not be added as it is not compatible for facet render + * + * @throws NoSuchEntityException + * @throws LocalizedException + */ + public function testGetRenderingContentFormatsCategoriesAttribute(): void + { + $storeId = 1; + $websiteId = 2; + $this->configHelper + ->method('getFacets') + ->willReturn([ + [FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => 'color'], + [FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => 'size'] + ]); + + $this->mockGroups(); + $this->mockStoreConfig($storeId, $websiteId); + $this->mockCategoryConfig($storeId); + + $result = $this->facetBuilder->getRenderingContent($storeId); + + $this->assertContains('categories.level0', $result['facetOrdering']['facets']['order']); + + $values = $result['facetOrdering']['values']; + $this->assertArrayHasKey('categories.level0', $values); + $this->assertArrayNotHasKey('categories', $values); + } + + + /** + * Category merch meta data should not be included with renderingContent + * @return void + * @throws LocalizedException + * @throws NoSuchEntityException + */ + public function testGetRenderingContentDoesNotIncludeMetaData(): void + { + $storeId = 1; + $this->mockFacets(); + $this->mockCategoryConfig($storeId); + $this->mockVisualMerchEnablement($storeId); + + $result = $this->facetBuilder->getRenderingContent($storeId); + + $facets = $result['facetOrdering']['facets']['order']; + $this->assertNotContains('categories', $facets); + $this->assertNotContains('categoryIds', $facets); + $this->assertNotContains('categoryPageId', $facets); + } + + /** + * @throws NoSuchEntityException + * @throws LocalizedException + */ + public function testGetRawFacetsReturnsCorrectStructure(): void + { + $storeId = 1; + $websiteId = 2; + + $this->configHelper + ->method('getFacets') + ->willReturn([ + [FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => 'size'], + [FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => FacetBuilder::FACET_ATTRIBUTE_PRICE] + ]); + + $this->mockStoreConfig($storeId, $websiteId); + + $result = $this->facetBuilder->getRawFacets($storeId); + $this->assertIsArray($result); + $this->assertNotEmpty($result); + $this->assertEquals('size', $result[0][FacetBuilder::FACET_KEY_ATTRIBUTE_NAME]); + } + + /** + * @throws NoSuchEntityException + * @throws LocalizedException + */ + public function testGetPricingAttributesReturnsCorrectValues(): void + { + $storeId = 1; + $websiteId = 2; + + $this->mockStoreConfig($storeId, $websiteId); + + $result = $this->facetBuilder->getPricingAttributes($storeId); + $this->assertContains('price.USD.default', $result); + $this->assertContains('price.EUR.default', $result); + } + + public function testDecorateAttributeForFacetingHandlesSearchableCorrectly(): void + { + $facet = [ + FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => 'brand', + FacetBuilder::FACET_KEY_SEARCHABLE => FacetBuilder::FACET_SEARCHABLE_SEARCHABLE + ]; + $result = $this->facetBuilder->decorateAttributeForFaceting($facet); + $this->assertEquals('searchable(brand)', $result); + } + + public function testDecorateAttributeForFacetingHandlesFilterOnlyCorrectly(): void + { + $facet = [ + FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => 'size', + FacetBuilder::FACET_KEY_SEARCHABLE => FacetBuilder::FACET_SEARCHABLE_FILTER_ONLY + ]; + $result = $this->facetBuilder->decorateAttributeForFaceting($facet); + $this->assertEquals('filterOnly(size)', $result); + } + + protected function mockFacets(): void + { + $this->configHelper + ->method('getFacets') + ->willReturn([ + [FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => 'brand', FacetBuilder::FACET_KEY_SEARCHABLE => FacetBuilder::FACET_SEARCHABLE_NOT_SEARCHABLE], + [FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => 'color', FacetBuilder::FACET_KEY_SEARCHABLE => FacetBuilder::FACET_SEARCHABLE_SEARCHABLE], + [FacetBuilder::FACET_KEY_ATTRIBUTE_NAME => FacetBuilder::FACET_ATTRIBUTE_PRICE] + ]); + } + + protected function mockStoreConfig(int $storeId, int $websiteId): void + { + $this->configHelper + ->method('getAllowedCurrencies') + ->willReturn(['EUR', 'USD']); + + $storeMock = $this->createMock(\Magento\Store\Api\Data\StoreInterface::class); + $storeMock->method('getWebsiteId')->willReturn($websiteId); + $this->storeManager->method('getStore')->with($storeId)->willReturn($storeMock); + } + + protected function mockCategoryConfig(int $storeId): void + { + $this->configHelper + ->method('replaceCategories') + ->with($storeId) + ->willReturn(true); + } + + protected function mockGroups(): void + { + $groupMock1 = $this->createMock(\Magento\Customer\Model\Group::class); + $groupMock1->method('getData')->with('customer_group_id')->willReturn(1); + + $groupMock2 = $this->createMock(\Magento\Customer\Model\Group::class); + $groupMock2->method('getData')->with('customer_group_id')->willReturn(2); + + $this->groupCollection->method('getIterator')->willReturn(new \ArrayIterator([$groupMock1, $groupMock2])); + } + + protected function mockVisualMerchEnablement(int $storeId): void + { + $this->configHelper + ->method('isVisualMerchEnabled') + ->with($storeId) + ->willReturn(true); + $this->configHelper + ->method('getCategoryPageIdAttributeName') + ->with($storeId) + ->willReturn('categoryPageId'); + } +} diff --git a/Test/Unit/Service/Product/FacetBuilderTestable.php b/Test/Unit/Service/Product/FacetBuilderTestable.php new file mode 100644 index 000000000..73fc131f8 --- /dev/null +++ b/Test/Unit/Service/Product/FacetBuilderTestable.php @@ -0,0 +1,24 @@ +serializerMock = $this->createMock(SerializerInterface::class); + + $this->serializer = new Serializer($this->serializerMock); + } + + /** + * Add data provider? + * @return void + */ + public function testSerializeReturnsString(): void + { + $unserialized = ['foo' => 'bar']; + $this->serializerMock + ->expects($this->once()) + ->method('serialize') + ->with($unserialized) + ->willReturn('{"foo":"bar"}'); + $result = $this->serializer->serialize($unserialized); + $this->assertEquals('{"foo":"bar"}', $result); + } + + public function testSerializeFailure(): void + { + $unserialized = []; + $this->serializerMock + ->expects($this->once()) + ->method('serialize') + ->with($unserialized) + ->willReturn(false); + $result = $this->serializer->serialize($unserialized); + $this->assertEquals('', $result); + } + + public function testUnserializeReturnsFalseOnEmptyValues(): void + { + $this->assertFalse($this->serializer->unserialize(null)); + $this->assertFalse($this->serializer->unserialize(false)); + $this->assertFalse($this->serializer->unserialize('')); + } + + public function testUnserializeHandlesValidJson(): void + { + $json = '{"key":"value"}'; + $this->assertEquals(['key' => 'value'], $this->serializer->unserialize($json)); + } + + public function testUnserializeFallsBackToSerializer(): void + { + $serialized = 'a:1:{s:3:"foo";s:3:"bar";}'; // PHP serialized data + + $this->serializerMock + ->expects($this->once()) + ->method('unserialize') + ->with($serialized) + ->willReturn(['foo' => 'bar']); + + $this->assertEquals(['foo' => 'bar'], $this->serializer->unserialize($serialized)); + } + + public function testUnserializeFailsBothJsonAndSerializer(): void + { + $badData = 'not_serialized_at_all'; + + $this->serializerMock + ->expects($this->once()) + ->method('unserialize') + ->with($badData) + ->willThrowException(new \InvalidArgumentException()); + + $this->expectException(\InvalidArgumentException::class); + + $this->serializer->unserialize($badData); + } +} diff --git a/Ui/Component/Listing/Column/Data.php b/Ui/Component/Listing/Column/Data.php index 2b9a5e3ba..2466a1b96 100644 --- a/Ui/Component/Listing/Column/Data.php +++ b/Ui/Component/Listing/Column/Data.php @@ -25,7 +25,7 @@ public function prepareDataSource(array $dataSource) $fieldName = $this->getData('name'); foreach ($dataSource['data']['items'] as &$item) { - $data = json_decode($item[$fieldName], true); + $data = json_decode((string) $item[$fieldName], true); $item[$fieldName] = is_array($data) ? $this->formatData($data) : '';; } diff --git a/Ui/Component/Listing/Column/QueueArchiveData.php b/Ui/Component/Listing/Column/QueueArchiveData.php index 5f9967ec8..9f7a4912c 100644 --- a/Ui/Component/Listing/Column/QueueArchiveData.php +++ b/Ui/Component/Listing/Column/QueueArchiveData.php @@ -22,7 +22,7 @@ public function prepareDataSource(array $dataSource) $fieldName = $this->getData('name'); foreach ($dataSource['data']['items'] as &$item) { - $data = json_decode($item[$fieldName], true); + $data = json_decode((string) $item[$fieldName], true); $formattedData = ''; if (is_array($data)) { foreach ($data as $key => $value) { diff --git a/ViewModel/Adminhtml/Analytics/Overview.php b/ViewModel/Adminhtml/Analytics/Overview.php index 749b362ce..f33e77896 100644 --- a/ViewModel/Adminhtml/Analytics/Overview.php +++ b/ViewModel/Adminhtml/Analytics/Overview.php @@ -107,7 +107,7 @@ protected function formatFormSubmittedDate(string $dateString): string * @return \DateTime * @throws NoSuchEntityException */ - protected function parseFormSubmittedDate(string $dateString = null, string $timezone = null): \DateTime + protected function parseFormSubmittedDate(?string $dateString = null, ?string $timezone = null): \DateTime { if (empty($timezone)) { $timezone = $this->getTimeZone(); @@ -229,7 +229,7 @@ public function getDailySearchData() $search['conversion'] = $this->getDateValue($conversion, $search['date'], 'rate'); } - $search['formatted'] = date('M, d', strtotime($search['date'])); + $search['formatted'] = date('M, d', strtotime((string) $search['date'])); } return $searches; @@ -262,7 +262,7 @@ public function getTopSearches() $this->getAnalyticsParams(['limit' => self::LIMIT_RESULTS]) ); - return isset($topSearches['searches']) ? $topSearches['searches'] : []; + return $topSearches['searches'] ?? []; } /** @@ -273,12 +273,10 @@ public function getTopSearches() public function getPopularResults() { $popular = $this->analyticsHelper->getTopHits($this->getAnalyticsParams(['limit' => self::LIMIT_RESULTS])); - $hits = isset($popular['hits']) ? $popular['hits'] : []; + $hits = $popular['hits'] ?? []; if (!empty($hits)) { - $objectIds = array_map(function ($arr) { - return $arr['hit']; - }, $hits); + $objectIds = array_map(fn($arr) => $arr['hit'], $hits); $storeId = $this->getStore()->getId(); diff --git a/ViewModel/Adminhtml/IndexingManager/Form.php b/ViewModel/Adminhtml/IndexingManager/Form.php new file mode 100644 index 000000000..f40734eb6 --- /dev/null +++ b/ViewModel/Adminhtml/IndexingManager/Form.php @@ -0,0 +1,91 @@ +backendView; + } + + /** + * @return string + */ + public function getFormAction() + { + return $this->getBackendView()->getUrlInterface()->getUrl('*/*/reindex'); + } + + /** + * + * @param $key + * + * @return string + */ + public function getFormValue($key) + { + $formData = $this->getBackendView()->getBackendSession()->getAlgoliaAnalyticsFormData(); + + return ($formData && isset($formData[$key])) ? $formData[$key] : ''; + } + + /** + * @return array + */ + public function getEntities(): array + { + return [ + 'all' => 'All', + 'products' => 'Products', + 'categories' => 'Categories', + 'pages' => 'Pages' + ]; + } + + /** + * @return string + */ + public function getConfirmMessage(): string + { + $message = 'You\'re about to perform an entity full reindexing to Algolia.\n'; + + if (!$this->configHelper->isQueueActive()) { + $message .= 'Warning : Your Indexing Queue is not activated. Depending on the size of the data you want to index, it may takes a lot of time and resources.\n'; + $message .= 'We highly suggest to turn it on if you\'re performing a full product reindexing with a large catalog.\n'; + } + + $message .= 'Do you want to proceed ?'; + + return $message; + } + + /** + * @return array + */ + public function getStores(): array + { + $stores = []; + $stores[0] = 'All'; + + foreach ($this->storeManager->getStores() as $store) { + $stores[$store->getId()] = $store->getName(); + } + + return $stores; + } + +} diff --git a/ViewModel/Adminhtml/IndexingManager/Section.php b/ViewModel/Adminhtml/IndexingManager/Section.php new file mode 100644 index 000000000..3ca0b044e --- /dev/null +++ b/ViewModel/Adminhtml/IndexingManager/Section.php @@ -0,0 +1,82 @@ +entity = $entity; + } + + /** + * @return string + */ + public function getEntity(): string + { + return $this->entity; + } + + /** + * @return string + */ + public function getSectionTitle(): string + { + return ucfirst(str_replace('_', ' ', $this->getEntity())); + } + + /** + * @return array + * @throws NoSuchEntityException + */ + public function getRelatedIndices(): array + { + $relatedIndices = []; + + foreach ($this->storeManager->getStores() as $store) { + $relatedIndices[$store->getId()] = [ + 'name' => $this->storeNameFetcher->getStoreName($store->getId()), + 'index' => $this->indexNameFetcher->getIndexName( + '_' . $this->getEntity(), + $store->getId() + ) + ]; + } + + return $relatedIndices; + } + + /** + * @param string $indexName + * @param int $storeId + * @return string + */ + public function getIndexUrl(string $indexName, int $storeId): string + { + $url = 'https://dashboard.algolia.com/apps/'; + $url .= $this->configHelper->getApplicationID($storeId); + $url .= '/explorer/browse/' . $indexName; + + return $url; + } +} diff --git a/composer.json b/composer.json index 34acc859f..f7809dc49 100755 --- a/composer.json +++ b/composer.json @@ -3,9 +3,9 @@ "description": "Algolia Search & Discovery extension for Magento 2", "type": "magento2-module", "license": ["MIT"], - "version": "3.15.1", + "version": "3.16.0", "require": { - "php": "~8.1|~8.2|~8.3", + "php": "~8.2|~8.3|~8.4", "magento/framework": "~103.0", "algolia/algoliasearch-client-php": "4.18.3", "guzzlehttp/guzzle": "^6.3.3|^7.3.0", @@ -24,7 +24,8 @@ } ], "require-dev": { - "phpcompatibility/php-compatibility": "^9.2" + "phpcompatibility/php-compatibility": "^9.2", + "phpunit/phpunit": "^9.5|^10.5" }, "autoload": { "files": [ "registration.php" ], diff --git a/dev/cloud/teardown.php b/dev/cloud/teardown.php index 6903c9c39..21a1dd21a 100644 --- a/dev/cloud/teardown.php +++ b/dev/cloud/teardown.php @@ -7,38 +7,42 @@ $bootstrap = Bootstrap::create(BP, $_SERVER); $objectManager = $bootstrap->getObjectManager(); -$algoliaHelper = $objectManager->get('\Algolia\AlgoliaSearch\Helper\AlgoliaHelper'); +$algoliaConnector = $objectManager->get(\Algolia\AlgoliaSearch\Service\AlgoliaConnector::class); +$indexOptionsBuilder = $objectManager->get(\Algolia\AlgoliaSearch\Service\IndexOptionsBuilder::class); $indexNamePrefix = getenv('MAGENTO_CLOUD_ENVIRONMENT'); /** - * @param $algoliaHelper Algolia\AlgoliaSearch\Helper\AlgoliaHelper + * @param $algoliaConnector Algolia\AlgoliaSearch\Service\AlgoliaConnector + * @param $indexOptionsBuilder Algolia\AlgoliaSearch\Service\IndexOptionsBuilder * @param array $indices + * @param $indexNamePrefix */ -function deleteIndexes($algoliaHelper, array $indices, $indexNamePrefix) +function deleteIndexes($algoliaConnector, $indexOptionsBuilder, array $indices, $indexNamePrefix) { foreach ($indices['items'] as $index) { $name = $index['name']; - if (mb_strpos($name, $indexNamePrefix) === 0) { + if (mb_strpos((string) $name, (string) $indexNamePrefix) === 0) { try { - $algoliaHelper->deleteIndex($name); + $indexOptions = $indexOptionsBuilder->buildWithEnforcedIndex($name); + $algoliaConnector->deleteIndex($name); echo 'Index "' . $name . '" has been deleted.'; echo "\n"; - } catch (Exception $e) { + } catch (Exception) { // Might be a replica } } } } -if ($algoliaHelper) { - $indices = $algoliaHelper->listIndexes(); +if ($algoliaConnector) { + $indices = $algoliaConnector->listIndexes(); if (count($indices) > 0) { - deleteIndexes($algoliaHelper, $indices, $indexNamePrefix); + deleteIndexes($algoliaConnector, $indexOptionsBuilder, $indices, $indexNamePrefix); } - $replicas = $algoliaHelper->listIndexes(); + $replicas = $algoliaConnector->listIndexes(); if (count($replicas) > 0) { - deleteIndexes($algoliaHelper, $replicas, $indexNamePrefix); + deleteIndexes($algoliaConnector, $indexOptionsBuilder, $replicas, $indexNamePrefix); } } diff --git a/etc/adminhtml/menu.xml b/etc/adminhtml/menu.xml index ab3b0cf84..ab0c2ef1c 100644 --- a/etc/adminhtml/menu.xml +++ b/etc/adminhtml/menu.xml @@ -60,6 +60,16 @@ action="algolia_algoliasearch/reindex/index" resource="Algolia_AlgoliaSearch::manage" /> + - +
@@ -53,43 +53,6 @@ ]]> - - - Magento\Config\Model\Config\Source\Yesno - - - The benefit here is that Algolia will manage to keep your data up to date. - If you choose "No", you will need to push and manage your data in a different way. - ]]> - - - - - Magento\Config\Model\Config\Source\Yesno - - - If you choose "No", _suggestion indexes will not be created. - ]]> - - - 1 - - - - - Magento\Config\Model\Config\Source\Yesno - - - If you choose "No", _pages indexes will not be created. - ]]> - - - 1 - - Magento\Config\Model\Config\Source\Yesno @@ -327,6 +290,47 @@ + + + + + Algolia allows you to redirect users + to a specific page of your website or mobile app based on a query or a set of conditions. +

+ ]]> + + 1 + + + Magento\Config\Model\Config\Source\Yesno + + + + + + + Algolia\AlgoliaSearch\Model\Source\AutocompleteRedirectMode + + + + 1 + + + + Magento\Config\Model\Config\Source\Yesno + + + + 1,2 + +
@@ -362,9 +366,6 @@ DOM selector of block in which the search results page will be displayed using JavaScript. ]]> - - 1 - @@ -375,9 +376,6 @@ The number of products displayed on the InstantSearch results page. Default value is 9. ]]> - - 1 - @@ -388,9 +386,6 @@ Do you want to replace default Magento category pages (PLPs) with the InstantSearch results page? ]]> - - 1 - Algolia\AlgoliaSearch\Model\Backend\Facets -   - Disjunctive allows a selection of different values per facet (e.g. hotels with 4 OR 5 stars).
-   - Conjunctive allows a selection of only one value per facet (e.g. only "Size M"). + Specify the filtering options you want to offer on a search results page.
+   - Disjunctive facets filter your results on any match (e.g. hotels with 4 OR 5 stars).
+   - Conjunctive facets filter your results on all matches (e.g. shirts that come in "Size M" AND "Size L"). +

Set facet as searchable if you want your customers to be able to search for facet values. It's handy when a facet has a lot of values.

@@ -433,9 +429,26 @@ ]]> - - 1 - + + + Magento\Config\Model\Config\Source\Yesno + +
+ This feature utilizes the "Facet display" configuration in the Algolia Dashboard (a.k.a. renderingContent). + If you have customized this setting in the Dashboard for your products index, please note that enabling this option will allow Magento to overwrite your configuration. +

+ ⚠ + IMPORTANT! Do not enable dynamic facets unless you have the "renderingContent" feature enabled on your Algolia application. Otherwise this configuration + can cause your indexing to fail. + + ]]> + + @@ -459,9 +472,6 @@ ]]> - - 1 - @@ -516,9 +526,34 @@ ]]> - - 1 - + + + + + Algolia allows you to redirect users + to a specific page of your website or mobile app based on a query or a set of conditions. +

+ ]]> + + + 1 + + + Magento\Config\Model\Config\Source\Yesno + + + + + + + Algolia\AlgoliaSearch\Block\Adminhtml\System\Config\Form\Field\Checkboxes + Algolia\AlgoliaSearch\Model\Backend\Checkboxes + Algolia\AlgoliaSearch\Model\Source\InstantSearchRedirectOptions + 1 +
@@ -580,13 +615,6 @@ ]]> - - - Magento\Config\Model\Config\Source\Yesno - - Include non visible products in index. Default value is No - - @@ -599,6 +627,13 @@ 1 + + + Magento\Config\Model\Config\Source\Yesno + + Include non visible products in index. Default value is No + +
@@ -960,6 +995,31 @@ Algolia\AlgoliaSearch\Model\Config\EnableQueueComment + + + Magento\Config\Model\Config\Source\Yesno + + algolia_queue_process jobs to the Magento cron_schedule table according to the specified cron expression. + ]]> + + + 1 + + + + Algolia\AlgoliaSearch\Model\Backend\QueueCron + + + */5 * * * * to process the queue every 5 minutes. You can also use aliases like @hourly. + ]]> + + + 1 + 1 + + validate-digits @@ -984,6 +1044,129 @@
+
+ + algolia + Algolia_AlgoliaSearch::algolia_algoliasearch + + + 1 + + + Magento\Config\Model\Config\Source\Yesno + + + The benefit here is that Algolia will manage to keep your data up to date. + If you choose "No", you will need to push and manage your data in a different way. + ]]> + + + + + Magento\Config\Model\Config\Source\Yesno + + + If you choose "No", _suggestion indexes will not be created. + ]]> + + + 1 + + + + + Magento\Config\Model\Config\Source\Yesno + + + If you choose "No", _pages indexes will not be created. + ]]> + + + 1 + + + + + + + 1 + + 1 + + ⚠ Since version 3.16.0, the following Magento indexers can be disabled for full indexing. + The extension will continue to rely on them for reindexing specific entities with Magento materialized views or entity save events if you do so.

+

If you want to perform full reindexing, we highly suggest to turn this configuration off and run the newly created CLI commands instead (this will become the default behavior in a future version).

+ ]]> + + + + Magento\Config\Model\Config\Source\Yesno + + bin/magento algolia:reindex:products instead + ]]> + + + + + Magento\Config\Model\Config\Source\Yesno + + bin/magento algolia:reindex:categories instead + ]]> + + + + + Magento\Config\Model\Config\Source\Yesno + + bin/magento algolia:reindex:pages instead + ]]> + + + + + Magento\Config\Model\Config\Source\Yesno + + bin/magento algolia:reindex:suggestions instead + ]]> + + + + + Magento\Config\Model\Config\Source\Yesno + + bin/magento algolia:reindex:additional_sections instead + ]]> + + + + + Magento\Config\Model\Config\Source\Yesno + + bin/magento algolia:reindex:delete_products instead + ]]> + + + + + Magento\Config\Model\Config\Source\Yesno + + bin/magento algolia:reindex:process_queue instead + ]]> + + + +
algolia @@ -1339,15 +1522,23 @@ + + + Magento\Config\Model\Config\Source\Yesno + +
+ The ability to disable this behavior is retained for legacy implementations, but it is highly recommended that you leave this setting enabled especially if you are using dynamic facets. + ]]> + + Magento\Config\Model\Config\Source\Yesno Algolia\AlgoliaSearch\Model\Config\AutomaticPriceIndexingComment - - 1 - diff --git a/etc/config.xml b/etc/config.xml index 8fd858c33..6ba636ca3 100644 --- a/etc/config.xml +++ b/etc/config.xml @@ -8,10 +8,6 @@ - - 1 - 1 - user_allowed_save_cookie #btn-cookie-allow @@ -26,11 +22,20 @@ 300 0 + + 1 + 1 + 0 + + + 0 + 10 + 0 @@ -39,6 +44,10 @@ 1 0 + + 0 + 1,3 + @@ -56,6 +65,28 @@ /// + + + 0 + */5 * * * * + + + + + 1 + 1 + 1 + + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + + @@ -94,6 +125,7 @@ 2 30 30 + 1 0 0 diff --git a/etc/cron_groups.xml b/etc/cron_groups.xml new file mode 100644 index 000000000..172b69c7f --- /dev/null +++ b/etc/cron_groups.xml @@ -0,0 +1,12 @@ + + + + 15 + 20 + 15 + 10 + 60 + 4320 + 0 + + diff --git a/etc/crontab.xml b/etc/crontab.xml new file mode 100644 index 000000000..bd3282625 --- /dev/null +++ b/etc/crontab.xml @@ -0,0 +1,8 @@ + + + + + algoliasearch_queue/queue/cron_expr + + + diff --git a/etc/di.xml b/etc/di.xml index 177c4fd6a..c494e3115 100755 --- a/etc/di.xml +++ b/etc/di.xml @@ -153,6 +153,15 @@ Algolia\AlgoliaSearch\Console\Command\ReplicaRebuildCommand Algolia\AlgoliaSearch\Console\Command\ReplicaDisableVirtualCommand Algolia\AlgoliaSearch\Console\Command\SynonymDeduplicateCommand + + Algolia\AlgoliaSearch\Console\Command\Indexer\IndexProductsCommand + Algolia\AlgoliaSearch\Console\Command\Indexer\IndexCategoriesCommand + Algolia\AlgoliaSearch\Console\Command\Indexer\IndexPagesCommand + Algolia\AlgoliaSearch\Console\Command\Indexer\IndexSuggestionsCommand + Algolia\AlgoliaSearch\Console\Command\Indexer\IndexAdditionalSectionsCommand + Algolia\AlgoliaSearch\Console\Command\Indexer\DeleteProductsCommand + Algolia\AlgoliaSearch\Console\Command\Indexer\ProcessQueueCommand + Algolia\AlgoliaSearch\Console\Command\Indexer\IndexAllCommand @@ -192,24 +201,65 @@ - + + - algolia - - Algolia\AlgoliaSearch\Logger\Handler\SystemLoggerHandler - Algolia\AlgoliaSearch\Logger\Handler\AlgoliaLoggerHandler - + Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor\Proxy + Algolia\AlgoliaSearch\Service\StoreNameFetcher\Proxy - - + + + + Algolia\AlgoliaSearch\Service\Category\BatchQueueProcessor\Proxy + Algolia\AlgoliaSearch\Service\StoreNameFetcher\Proxy + + + + + Algolia\AlgoliaSearch\Service\Page\BatchQueueProcessor\Proxy + Algolia\AlgoliaSearch\Service\StoreNameFetcher\Proxy + + + + + Algolia\AlgoliaSearch\Service\Suggestion\BatchQueueProcessor\Proxy + Algolia\AlgoliaSearch\Service\StoreNameFetcher\Proxy + + + - Algolia\AlgoliaSearch\Logger\AlgoliaLogger + Algolia\AlgoliaSearch\Service\AdditionalSection\BatchQueueProcessor\Proxy + Algolia\AlgoliaSearch\Service\StoreNameFetcher\Proxy + + + Algolia\AlgoliaSearch\Service\Product\BatchQueueProcessor\Proxy + Algolia\AlgoliaSearch\Service\StoreNameFetcher\Proxy + + + + + Algolia\AlgoliaSearch\Helper\ConfigHelper\Proxy + Algolia\AlgoliaSearch\Model\Queue\Proxy + Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager\Proxy + + + + + Algolia\AlgoliaSearch\Service\StoreNameFetcher\Proxy + + + - + - Algolia\AlgoliaSearch\Logger\AlgoliaLogger + algolia + + Algolia\AlgoliaSearch\Logger\Handler\SystemLoggerHandler + Algolia\AlgoliaSearch\Logger\Handler\AlgoliaLoggerHandler + + diff --git a/etc/module.xml b/etc/module.xml index bb857ca35..26870a9f1 100755 --- a/etc/module.xml +++ b/etc/module.xml @@ -1,6 +1,6 @@ - + diff --git a/view/adminhtml/layout/algolia_algoliasearch_indexingmanager_index.xml b/view/adminhtml/layout/algolia_algoliasearch_indexingmanager_index.xml new file mode 100644 index 000000000..5af22d51c --- /dev/null +++ b/view/adminhtml/layout/algolia_algoliasearch_indexingmanager_index.xml @@ -0,0 +1,38 @@ + + + + + + + + + + Algolia\AlgoliaSearch\ViewModel\Adminhtml\IndexingManager\Form + + + + + + + + Algolia\AlgoliaSearch\ViewModel\Adminhtml\IndexingManager\Section + products + + + + + Algolia\AlgoliaSearch\ViewModel\Adminhtml\IndexingManager\Section + categories + + + + + Algolia\AlgoliaSearch\ViewModel\Adminhtml\IndexingManager\Section + pages + + + + + + diff --git a/view/adminhtml/templates/analytics/form.phtml b/view/adminhtml/templates/analytics/form.phtml index cc3d42988..43f79b708 100644 --- a/view/adminhtml/templates/analytics/form.phtml +++ b/view/adminhtml/templates/analytics/form.phtml @@ -1,35 +1,36 @@ getViewModel(); ?> isAnalyticsApiEnabled() ? ' disabled' : '' ?>
-
- + +
- > + getSections() as $key => $section): ?> +
- + class="admin__control-text input-text date-range-analytics-from" - placeholder="escapeHtmlAttr(__('Start Date')) ?>" value="getFormValue('from') ?>"/> + placeholder="escapeHtmlAttr(__('Start Date')) ?>" value="escapeHtmlAttr($form->getFormValue('from')) ?>"/>
-
- + class="admin__control-text input-text validate-date-range date-range-analytics-to" - placeholder="escapeHtmlAttr(__('End Date')) ?>" value="getFormValue('to') ?>"/> + placeholder="escapeHtmlAttr(__('End Date')) ?>" value="escapeHtmlAttr($form->getFormValue('to')) ?>"/>
-
@@ -70,4 +71,4 @@ $form = $block->getViewModel(); } }); }); - \ No newline at end of file + diff --git a/view/adminhtml/templates/analytics/graph.phtml b/view/adminhtml/templates/analytics/graph.phtml index a19583b8b..185f25739 100644 --- a/view/adminhtml/templates/analytics/graph.phtml +++ b/view/adminhtml/templates/analytics/graph.phtml @@ -1,7 +1,8 @@ -getAnalytics())) : ?> +getAnalytics())): ?>
- +
- escapeHtml(__('No Data Found')) ?> + escapeHtml(__('No Data Found')) ?>
- \ No newline at end of file + diff --git a/view/adminhtml/templates/analytics/overview.phtml b/view/adminhtml/templates/analytics/overview.phtml index f8f871807..4b8673a64 100644 --- a/view/adminhtml/templates/analytics/overview.phtml +++ b/view/adminhtml/templates/analytics/overview.phtml @@ -1,94 +1,94 @@ getViewModel(); ?> -getMessagesHtml(); ?> +getMessagesHtml(); ?>
- escapeHtml(__('Viewing index:')); ?> getIndexName() ?> + escapeHtml(__('Viewing index:')); ?> escapeHtml($view->getIndexName())?>
-

escapeHtml(__('Total searches')) ?> - getTooltipHtml(__('How many searches were performed. As-you-type searches are aggregated (the queries i, ip, ipa, ipad count as one search).')) ?> +

escapeHtml(__('Total searches')) ?> + getTooltipHtml(__('How many searches were performed. As-you-type searches are aggregated (the queries i, ip, ipa, ipad count as one search).')) ?>

-
getTotalCountOfSearches() ?>
+
escapeHtml($view->getTotalCountOfSearches()) ?>
-

escapeHtml(__('Users')) ?> - getTooltipHtml(__('How many unique users performed a search.')); ?> +

escapeHtml(__('Users')) ?> + getTooltipHtml(__('How many unique users performed a search.')); ?>

-
getTotalUsersCount() ?>
+
escapeHtml($view->getTotalUsersCount()) ?>
-

escapeHtml(__('No results rate')) ?> - getTooltipHtml(__('Percentage of searches that retrieved 0 results. A lower percentage is better.')); ?> +

escapeHtml(__('No results rate')) ?> + getTooltipHtml(__('Percentage of searches that retrieved 0 results. A lower percentage is better.')); ?>

-
getTotalResultRates() ?>
+
escapeHtml($view->getTotalResultRates()) ?>
- isClickAnalyticsEnabled()) : ?> + isClickAnalyticsEnabled()): ?>
-

escapeHtml(__('Conversion rate')) ?> - getTooltipHtml(__('Percentage of tracked searches (searches with clickAnalytics=true) where you signaled to us that it led to a successful conversion. Settings to determine conversion can be found in your Magento Algolia Configuration for Click Analytics.', $view->getAnalyticsConfigurationUrl())) ?> +

escapeHtml(__('Conversion rate')) ?> + getTooltipHtml(__('Percentage of tracked searches (searches with clickAnalytics=true) where you signaled to us that it led to a successful conversion. Settings to determine conversion can be found in your Magento Algolia Configuration for Click Analytics.', $view->getAnalyticsConfigurationUrl())) ?>

getConversionRate() ?> -
-
escapeHtml(__('from %1 tracked searches', $conversion['trackedSearchCount'])) ?>
+
escapeHtml(($conversion['rate'] ? round($conversion['rate'] * 100, 2) : 0) . '%'); ?>
+
escapeHtml(__('from %1 tracked searches', $conversion['trackedSearchCount'])) ?>

- escapeHtml(__('Conversion - Add To Cart')) ?> - getTooltipHtml(__('Percentage of tracked searches (searches with clickAnalytics=true) where you signaled to us that it led to a successful add to cart. Settings to determine conversion can be found in your Magento Algolia Configuration for Click Analytics.', $view->getAnalyticsConfigurationUrl())) ?> + escapeHtml(__('Conversion - Add To Cart')) ?> + getTooltipHtml(__('Percentage of tracked searches (searches with clickAnalytics=true) where you signaled to us that it led to a successful add to cart. Settings to determine conversion can be found in your Magento Algolia Configuration for Click Analytics.', $view->getAnalyticsConfigurationUrl())) ?>

getConversionRateAddToCart() ?> -
-
escapeHtml(__('from %1 tracked searches', $conversion['trackedSearchCount'])) ?>
+
escapeHtml(($conversion['rate'] ? round($conversion['rate'] * 100, 2) : 0) . '%'); ?>
+
escapeHtml(__('from %1 tracked searches', $conversion['trackedSearchCount'])) ?>

- escapeHtml(__('Conversion - Place Order')) ?> - getTooltipHtml(__('Percentage of tracked searches (searches with clickAnalytics=true) where you signaled to us that it led to a successful purchase. Settings to determine conversion can be found in your Magento Algolia Configuration for Click Analytics.', $view->getAnalyticsConfigurationUrl())) ?> + escapeHtml(__('Conversion - Place Order')) ?> + getTooltipHtml(__('Percentage of tracked searches (searches with clickAnalytics=true) where you signaled to us that it led to a successful purchase. Settings to determine conversion can be found in your Magento Algolia Configuration for Click Analytics.', $view->getAnalyticsConfigurationUrl())) ?>

getConversionRatePlaceOrder() ?> -
-
escapeHtml(__('from %1 tracked searches', $conversion['trackedSearchCount'])) ?>
+
escapeHtml(($conversion['rate'] ? round($conversion['rate'] * 100, 2) : 0) . '%'); ?>
+
escapeHtml(__('from %1 tracked searches', $conversion['trackedSearchCount'])) ?>
-

escapeHtml(__('CTR')) ?> - getTooltipHtml(__('Click-Through Rate: percentage of tracked searches (searches with clickAnalytics=true) where at least one results was clicked on by the user.')) ?> +

escapeHtml(__('CTR')) ?> + getTooltipHtml(__('Click-Through Rate: percentage of tracked searches (searches with clickAnalytics=true) where at least one results was clicked on by the user.')) ?>

getClickThroughRate() ?> -
-
escapeHtml(__('from %1 tracked searches', $ctr['trackedSearchCount'])) ?>
+
escapeHtml(($ctr['rate'] ? round($ctr['rate'] * 100, 2) : 0) . '%'); ?>
+
escapeHtml(__('from %1 tracked searches', $ctr['trackedSearchCount'])) ?>
-

escapeHtml(__('Click position')) ?> - getTooltipHtml(__('Average position of the clicks performed on the search results. A value of one would mean all users clicked on the first results. Smaller values are better.')) ?> +

escapeHtml(__('Click position')) ?> + getTooltipHtml(__('Average position of the clicks performed on the search results. A value of one would mean all users clicked on the first results. Smaller values are better.')) ?>

getClickPosition() ?> -
-
escapeHtml(__('from %1 tracked clicks', $click['clickCount'])) ?>
+
escapeHtml($click['average'] ? round($click['average'], 2) : 0); ?>
+
escapeHtml(__('from %1 tracked clicks', $click['clickCount'])) ?>
@@ -96,120 +96,120 @@ $view = $block->getViewModel();
-

escapeHtml(__('Daily searches')) ?>

-
escapeHtml(__('Total searches')) ?> getTotalCountOfSearches() ?>
+

escapeHtml(__('Daily searches')) ?>

+
escapeHtml(__('Total searches')) ?> escapeHtml($view->getTotalCountOfSearches()) ?>
- getDailyChartHtml(); ?> + getDailyChartHtml(); ?>
-

escapeHtml(__('Popular searches')) ?> - getTooltipHtml(__('Searches performed the more often by your users.')) ?> +

escapeHtml(__('Popular searches')) ?> + getTooltipHtml(__('Searches performed the more often by your users.')) ?>

- getTopSearches())) : ?> + getTopSearches())): ?> - - + + - getTopSearches() as $search) : ?> + getTopSearches() as $search): ?> - - + +
escapeHtml(__('Query')) ?>escapeHtml(__('Count')) ?>escapeHtml(__('Query')) ?>escapeHtml(__('Count')) ?>
' . $block->escapeHtml(__('empty search')) . ''; ?>' . $escaper->escapeHtml(__('empty search')) . ''; ?>escapeHtml($search['count']) ?>
- -

escapeHtml(__('No searches yet!')); ?>

+ +

escapeHtml(__('No searches yet!')); ?>

- escapeHtml(__('See more searches')) ?> + escapeHtml(__('See more searches')) ?>
-

escapeHtml(__('Popular results')) ?> - getTooltipHtml(__('Results the most often displayed on the results list after a search.')) ?> +

escapeHtml(__('Popular results')) ?> + getTooltipHtml(__('Results the most often displayed on the results list after a search.')) ?>

- getPopularResults())) : ?> + getPopularResults())): ?> - - + + - getPopularResults() as $search) : ?> + getPopularResults() as $search): ?> - +
escapeHtml(__('Results')) ?>escapeHtml(__('Impressions')) ?>escapeHtml(__('Results')) ?>escapeHtml(__('Impressions')) ?>
getTypeEditUrl($search); ?> - $url) : ?> - > - + $url): ?> + > + escapeHtml(ucfirst($type)); ?> | - + escapeHtml(isset($search['name']) ? $search['name'] : $search['hit']) ?> escapeHtml($search['count']) ?>
- -

escapeHtml(__('No results yet!')); ?>

+ +

escapeHtml(__('No results yet!')); ?>

- escapeHtml(__('See more results')) ?> + escapeHtml(__('See more results')) ?>
-

escapeHtml(__('No result searches')) ?> - getTooltipHtml(__("Searches that retrieved 0 results, either because a word didn't match, or because some filters excluded all of the matching results.

A search with no results can often be optimized by improving keywords used in the dataset, or by adding synonyms.")); ?> +

escapeHtml(__('No result searches')) ?> + getTooltipHtml(__("Searches that retrieved 0 results, either because a word didn't match, or because some filters excluded all of the matching results.

A search with no results can often be optimized by improving keywords used in the dataset, or by adding synonyms.")); ?>

- getNoResultSearches())) : ?> + getNoResultSearches())): ?> - - + + - getNoResultSearches() as $search) : ?> + getNoResultSearches() as $search): ?> - - + +
<escapeHtml(__('Query')) ?>escapeHtml(__('Count')) ?><escapeHtml(__('Query')) ?>escapeHtml(__('Count')) ?>
' . $block->escapeHtml(__('empty search')) . ''; ?>' . $escaper->escapeHtml(__('empty search')) . ''; ?>escapeHtml($search['count']) ?>
- -

escapeHtml(__('No results yet!')); ?>

+ +

escapeHtml(__('No results yet!')); ?>

- escapeHtml(__('See more no results searches')) ?> + escapeHtml(__('See more no results searches')) ?>
-isClickAnalyticsEnabled()) : ?> +isClickAnalyticsEnabled()): ?>
Enhance your Analytics with Algolia Click Analytics that provide you even more insights like Click-through Rate, Conversion Rate from searches and average click position. diff --git a/view/adminhtml/templates/catalog/category/edit/merchandising.phtml b/view/adminhtml/templates/catalog/category/edit/merchandising.phtml index ed3194c94..4d14c209f 100644 --- a/view/adminhtml/templates/catalog/category/edit/merchandising.phtml +++ b/view/adminhtml/templates/catalog/category/edit/merchandising.phtml @@ -1,6 +1,7 @@ getConfigHelper(); @@ -14,7 +15,7 @@ $configHelper = $block->getConfigHelper(); Find out more about Algolia Merchandising, please refer to documentation.
-isRootCategory()) : ?> +isRootCategory()): ?>
@@ -22,16 +23,17 @@ $configHelper = $block->getConfigHelper(); To merchandise products, please select any sub-category.
- + -isInstantEnabled() || !$configHelper->replaceCategories()) : +isInstantEnabled() || !$configHelper->replaceCategories()): $instantSearchLink = $block->getUrl('adminhtml/system_config/edit/section/algoliasearch_instant'); ?>
To merchandise products using Algolia you need to enable Instant search with Replace category pages feature. - You can do it in Algolia's Instant Search configuration. + You can do it in Algolia's Instant Search configuration.

Instant search with enabled Replace category pages feature gives your customers a great experience while browsing your catalog. It enables your customers to search and filter for products at real time resulting @@ -39,9 +41,10 @@ $configHelper = $block->getConfigHelper(); and enjoy the shopping on your store(s).
- + -
canDisplayProducts() ?: 'style="display:none;"' ?>> +
canDisplayProducts() ?: 'style="display:none;"' ?>>

Products are not displayed for this category

Please note that you've selected "Static block only" in Display Settings. Since no products are shown on the page, changes you make with Algolia Merchandising won't be visible to your customers.

@@ -193,7 +196,7 @@ $isConfig = [ diff --git a/view/adminhtml/templates/indexing-manager/form.phtml b/view/adminhtml/templates/indexing-manager/form.phtml new file mode 100644 index 000000000..b5362a79e --- /dev/null +++ b/view/adminhtml/templates/indexing-manager/form.phtml @@ -0,0 +1,50 @@ +getViewModel(); +?> + +
+
+ +
+

Reindex your entities in one click:

+
+
+ Store(s): +
+
+ Entities: +
+ +
+
+ + diff --git a/view/adminhtml/templates/indexing-manager/overview.phtml b/view/adminhtml/templates/indexing-manager/overview.phtml new file mode 100644 index 000000000..df9cab129 --- /dev/null +++ b/view/adminhtml/templates/indexing-manager/overview.phtml @@ -0,0 +1,14 @@ + +
+
+

Here is a list of all the main indices (excluding replicas) created by the extension on the Algolia Dashboard.

+

Those indices are listed by store for each entity section. You can click on them to directly open the Algolia Dashboard.

+
+ + + getChildHtml('indexing_manager_products') ?> + getChildHtml('indexing_manager_categories') ?> + getChildHtml('indexing_manager_pages') ?> +
diff --git a/view/adminhtml/templates/indexing-manager/section.phtml b/view/adminhtml/templates/indexing-manager/section.phtml new file mode 100644 index 000000000..de27df3e6 --- /dev/null +++ b/view/adminhtml/templates/indexing-manager/section.phtml @@ -0,0 +1,17 @@ +getViewModel(); +$view->setEntity($block->getData('entity')); +$relatedIndices = $view->getRelatedIndices(); +?> + +
+

escapeHtml($view->getSectionTitle()) ?>

+ 0): ?> + $relatedIndex): ?> +

escapeHtml($relatedIndex['name']) ?> : escapeHtml($relatedIndex['index']) ?>

+ + +
diff --git a/view/adminhtml/templates/job/view.phtml b/view/adminhtml/templates/job/view.phtml index 792a0b6de..2d5613318 100644 --- a/view/adminhtml/templates/job/view.phtml +++ b/view/adminhtml/templates/job/view.phtml @@ -7,96 +7,96 @@ $job = $block->getCurrentJob();
- escapeHtml(__('Job Informations')); ?> + escapeHtml(__('Job Informations')); ?>
- +
- escapeHtml($job->getId()); ?> + escapeHtml($job->getId()); ?>
- +
- escapeHtml($job->getPid()); ?> + escapeHtml($job->getPid()); ?>
- +
- escapeHtml($job->getCreated()); ?> + escapeHtml($job->getCreated()); ?>
- +
- escapeHtml($job->getStatus()); ?> + escapeHtml($job->getStatus()); ?>
- +
- escapeHtml($job->getClass()); ?> + escapeHtml($job->getClass()); ?>
- +
- escapeHtml($job->getMethod()); ?> + escapeHtml($job->getMethod()); ?>
- +
- escapeHtml($job->getData('data')); ?> + escapeHtml($job->getData('data')); ?>
- +
- escapeHtml($job->getMaxRetries()); ?> + escapeHtml($job->getMaxRetries()); ?>
- +
- escapeHtml($job->getRetries()); ?> + escapeHtml($job->getRetries()); ?>
- +
- escapeHtml($job->getDataSize()); ?> + escapeHtml($job->getDataSize()); ?>
- +
- escapeHtml($job->getErrorLog()); ?> + escapeHtml($job->getErrorLog()); ?>
diff --git a/view/adminhtml/templates/landingpage/cms-notice.phtml b/view/adminhtml/templates/landingpage/cms-notice.phtml index 6fd9bf41b..f06eb3a52 100644 --- a/view/adminhtml/templates/landingpage/cms-notice.phtml +++ b/view/adminhtml/templates/landingpage/cms-notice.phtml @@ -4,7 +4,7 @@ $bookIllustration = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/icon-b
x
- +

The CMS editor allows you to customize header of your landing page.

The final result depends on your Magento template and CSS customizations.

diff --git a/view/adminhtml/templates/landingpage/page-settings-notice.phtml b/view/adminhtml/templates/landingpage/page-settings-notice.phtml index 0658b08bb..c596ce9c0 100644 --- a/view/adminhtml/templates/landingpage/page-settings-notice.phtml +++ b/view/adminhtml/templates/landingpage/page-settings-notice.phtml @@ -4,7 +4,7 @@ $bookIllustration = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/icon-b
x
- +

Basics of a landing page - its URL, title, meta description and meta keywords are used to improve your SEO.

You may also set a timeframe on your landing page.

diff --git a/view/adminhtml/templates/landingpage/search-configuration.phtml b/view/adminhtml/templates/landingpage/search-configuration.phtml index 67937b490..6a7dcf360 100644 --- a/view/adminhtml/templates/landingpage/search-configuration.phtml +++ b/view/adminhtml/templates/landingpage/search-configuration.phtml @@ -1,5 +1,5 @@ getConfigHelper(); @@ -28,8 +28,8 @@ $isConfig = [ ?> - - + +
@@ -41,7 +41,7 @@ $isConfig = [

2. Pre-select applicable filters, for example a price range that is interesting to your customers.

- +

3. You can see which products (and in what order) will be shown on the final landing page. If you're on Algolia's higher plans, you may manually set specific order of products, promote or demote as desired.

@@ -117,7 +117,7 @@ $isConfig = [ {{/_highlightResult.sku.0}} {{{ _highlightResult.name.value }}} - {{ price.getCurrencyCode() ?>.default_formated }} + {{ price.escapeHtml($configHelper->getCurrencyCode()) ?>.default_formated }}
@@ -182,7 +182,7 @@ $isConfig = [ {{/_highlightResult.sku.0}} {{{ _highlightResult.name.value }}} - {{ price.getCurrencyCode() ?>.default_formated }} + {{ price.escapeHtml($configHelper->getCurrencyCode()) ?>.default_formated }}
@@ -223,7 +223,7 @@ $isConfig = [ {{/sku.0}} {{{ name }}} - {{ price.getCurrencyCode() ?>.default_formated }} + {{ price.escapeHtml($configHelper->getCurrencyCode()) ?>.default_formated }}
@@ -250,7 +250,7 @@ $isConfig = [
{{{ _highlightResult.name.value }}}
- {{ price.getCurrencyCode() ?>.default_formated }} + {{ price.escapeHtml($configHelper->getCurrencyCode()) ?>.default_formated }}
@@ -308,7 +308,7 @@ $isConfig = [ algoliaAdminBundle.$(function ($) { var storeId = $('select[name="store_id"]').val(); - var config = ; + var config = JSON.parse('escapeJs(json_encode($isConfig)) ?>'); config.appId = config.indexDataByStoreIds[storeId].appId; config.apiKey = config.indexDataByStoreIds[storeId].apiKey; diff --git a/view/adminhtml/templates/landingpage/suggestions.phtml b/view/adminhtml/templates/landingpage/suggestions.phtml index 11a1be2f0..dd7b569f7 100644 --- a/view/adminhtml/templates/landingpage/suggestions.phtml +++ b/view/adminhtml/templates/landingpage/suggestions.phtml @@ -8,22 +8,22 @@ $emptyStateIllustration = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/ $bookIllustration = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/icon-book.svg'); ?> -getNbOfLandingPages() > 0) : ?> +getNbOfLandingPages() > 0): ?>
x
- +

The Landing Page Builder allows you to easily create customised landing pages out of search queries.

It is a powerful marketing tool to promote products, with a strong focus on SEO. To find out more about the Landing Page Builder, please see our documentation.

- +

No landing page yet!

- +

The Landing Page Builder allows you to easily create customised landing pages out of search queries.

It is a powerful marketing tool to promote products, with a strong focus on SEO. To find out more about the Landing Page Builder, please see our documentation.

-

Create a new landing page

+

Create a new landing page

\ No newline at end of file diff --git a/view/adminhtml/templates/merchandising/page.phtml b/view/adminhtml/templates/merchandising/page.phtml index 203b9742e..46af59ffb 100644 --- a/view/adminhtml/templates/merchandising/page.phtml +++ b/view/adminhtml/templates/merchandising/page.phtml @@ -1,68 +1,70 @@ +/** @var \Magento\Backend\Block\Template $block */ +/** @var \Magento\Framework\Escaper $escaper */ +?>

- <?php echo $block->escapeHtmlAttr(__('Merchandising features')) ?> - escapeHtml(__('Merchandising features')) ?> + <?= $escaper->escapeHtmlAttr(__('Merchandising features')) ?> + escapeHtml(__('Merchandising features')) ?>

- <?php echo $block->escapeHtmlAttr(__('Merchandising Studio')) ?> - escapeHtml(__('Merchandising Studio')) ?> + <?= $escaper->escapeHtmlAttr(__('Merchandising Studio')) ?> + escapeHtml(__('Merchandising Studio')) ?>

- escapeHtml(__('Related video:')) ?> + escapeHtml(__('Related video:')) ?> - escapeHtml(__('Merchandising features')) ?> + escapeHtml(__('Merchandising features')) ?>

- escapeHtml(__('We recommend using ')) ?>escapeHtml(__('Merchandising Studio ')) ?> - escapeHtml(__('if you’re on a ')) ?>escapeHtml(__('Premium plan.')) ?> - escapeHtml(__('While the legacy merchandising capabilities within the Magento extension shall remain for now, we strongly advice that users ')) ?>escapeHtml(__('become familiar with this powerful new tool')) ?> - escapeHtml(__('to truly unlock the potential of Algolia.')) ?> + escapeHtml(__('We recommend using ')) ?>escapeHtml(__('Merchandising Studio ')) ?> + escapeHtml(__('if you’re on a ')) ?>escapeHtml(__('Premium plan.')) ?> + escapeHtml(__('While the legacy merchandising capabilities within the Magento extension shall remain for now, we strongly advice that users ')) ?>escapeHtml(__('become familiar with this powerful new tool')) ?> + escapeHtml(__('to truly unlock the potential of Algolia.')) ?>
- <?php echo $block->escapeHtmlAttr(__('Query Merchandiser')) ?> + <?= $escaper->escapeHtmlAttr(__('Query Merchandiser')) ?>
-

escapeHtml(__('Query Merchandiser')) ?>

+

escapeHtml(__('Query Merchandiser')) ?>

-

escapeHtml(__('Easily promote or demote products for a search. Based on Algolia\'s Query rules, the Query merchandiser allows you to enhance the ranking behavior for specific search queries.')) ?>

+

escapeHtml(__('Easily promote or demote products for a search. Based on Algolia\'s Query rules, the Query merchandiser allows you to enhance the ranking behavior for specific search queries.')) ?>

- escapeHtml(__('Merchandise search results')) ?> + escapeHtml(__('Merchandise search results')) ?>
- <?php echo $block->escapeHtmlAttr(__('Category Merchandiser')) ?> + <?= $escaper->escapeHtmlAttr(__('Category Merchandiser')) ?>
-

escapeHtml(__('Category Merchandiser')) ?>

+

escapeHtml(__('Category Merchandiser')) ?>

-

escapeHtml(__('Give more visibility to specific products within a category page. Promote or demote displayed items by using a simple drag and drop mechanism.')) ?>

+

escapeHtml(__('Give more visibility to specific products within a category page. Promote or demote displayed items by using a simple drag and drop mechanism.')) ?>

- escapeHtml(__('Promote products within a category')) ?> + escapeHtml(__('Promote products within a category')) ?>
- <?php echo $block->escapeHtmlAttr(__('Landing Page Builder')) ?> + <?= $escaper->escapeHtmlAttr(__('Landing Page Builder')) ?>
-

escapeHtml(__('Landing Page Builder')) ?>

+

escapeHtml(__('Landing Page Builder')) ?>

-

escapeHtml(__('The Landing Page Builder allows you to easily create customised landing pages out of search queries. It is a powerful marketing tool to promote products, with a strong focus on SEO.')) ?>

+

escapeHtml(__('The Landing Page Builder allows you to easily create customised landing pages out of search queries. It is a powerful marketing tool to promote products, with a strong focus on SEO.')) ?>

- escapeHtml(__('Create a new landing page')) ?> + escapeHtml(__('Create a new landing page')) ?>
diff --git a/view/adminhtml/templates/query/banner-notice.phtml b/view/adminhtml/templates/query/banner-notice.phtml index 1def491dc..fb81c349a 100644 --- a/view/adminhtml/templates/query/banner-notice.phtml +++ b/view/adminhtml/templates/query/banner-notice.phtml @@ -4,7 +4,7 @@ $bookIllustration = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/icon-b
x
- +

Depending on what users search for, you may want to display ads or promotional banners.

diff --git a/view/adminhtml/templates/query/edit/merchandising.phtml b/view/adminhtml/templates/query/edit/merchandising.phtml index b6f10bd01..c0eeb8d5b 100644 --- a/view/adminhtml/templates/query/edit/merchandising.phtml +++ b/view/adminhtml/templates/query/edit/merchandising.phtml @@ -1,13 +1,9 @@ getConfigHelper(); - -?> - -getCoreHelper()->getBaseIndexName(); $currencyCode = $configHelper->getCurrencyCode(); @@ -86,7 +82,7 @@ $isConfig = [ {{/_highlightResult.sku.0}} {{{ _highlightResult.name.value }}} - {{ price..default_formated }} + {{ price.escapeHtml($currencyCode) ?>.default_formated }}
@@ -136,7 +132,7 @@ $isConfig = [ {{/sku.0}} {{{ name }}} - {{ price..default_formated }} + {{ price.escapeHtml($currencyCode) ?>.default_formated }}
@@ -163,8 +159,8 @@ $isConfig = [
{{{ _highlightResult.name.value }}}
- {{ price..default_formated }} -
+ {{ price.escapeHtml($currencyCode) ?>.default_formated }} +
@@ -194,7 +190,7 @@ $isConfig = [ var initInstantSearch = function() { algoliaAdminBundle.$(function ($) { var storeId = $('select[name="store_id"]').val(); - var config = ; + var config = JSON.parse('escapeJs(json_encode($isConfig)) ?>'); config.appId = config.indexDataByStoreIds[storeId].appId; config.apiKey = config.indexDataByStoreIds[storeId].apiKey; @@ -297,7 +293,7 @@ $isConfig = [ source: algoliaAdminBundle.autocomplete.sources.hits(index, options), name: 'products', templates: { - header: '
Press enter to select, ↑ or ↓ to navigate, esc to dismiss
', + header: '
Press enter to select, ↑ or ↓ to navigate, esc to dismiss
', suggestion: function (hit) { return template.render(hit); } @@ -307,19 +303,19 @@ $isConfig = [ $('#algolia_merchandising_autocomplete') .autocomplete({ debug: false, hint: false }, sources) .on('autocomplete:selected', function (e, suggestion) { - var $existingRow = $('.algolia_merchandising_items_table tbody tr[data-objectid="' + suggestion.objectID + '"]'); + var $existingRow = $('.algolia_merchandising_items_table tbody tr[data-objectid="' + suggestion.objectID + '"]'); - if ($existingRow.length > 0) { - var $firstRow = $('.algolia_merchandising_items_table tbody tr').first(); - $existingRow.insertBefore($firstRow); + if ($existingRow.length > 0) { + var $firstRow = $('.algolia_merchandising_items_table tbody tr').first(); + $existingRow.insertBefore($firstRow); } else { - var newRowTemplateHtml = $('#algolia_merchandisign_table_row').html(), - newRowTemplate = algoliaAdminBundle.Hogan.compile(newRowTemplateHtml), - rowHtml = newRowTemplate.render(suggestion); + var newRowTemplateHtml = $('#algolia_merchandisign_table_row').html(), + newRowTemplate = algoliaAdminBundle.Hogan.compile(newRowTemplateHtml), + rowHtml = newRowTemplate.render(suggestion); - $('.algolia_merchandising_items_table tbody').prepend(rowHtml); - $('.algolia_merchandising_items_table tbody tr').last().remove(); + $('.algolia_merchandising_items_table tbody').prepend(rowHtml); + $('.algolia_merchandising_items_table tbody tr').last().remove(); } var $firstRow = $('.algolia_merchandising_items_table tbody tr').first(); diff --git a/view/adminhtml/templates/query/suggestions.phtml b/view/adminhtml/templates/query/suggestions.phtml index d8e8b2bda..9103f246a 100644 --- a/view/adminhtml/templates/query/suggestions.phtml +++ b/view/adminhtml/templates/query/suggestions.phtml @@ -8,22 +8,22 @@ $emptyStateIllustration = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/ $bookIllustration = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/icon-book.svg'); ?> -getNbOfQueries() > 0) : ?> +getNbOfQueries() > 0): ?>
x
- +

Easily promote or demote products for a search. Based on Algolia's Query rules, the Query Merchandiser allows you to enchance the ranking behaviour for specific search queries.

Merchandising a query will create a new query rule (which are part of your Algolia plan). To find out more about the Query Merchandiser, please see our documentation.

- +

No merchandised query yet!

- +

Easily promote or demote products for a search. Based on Algolia's Query rules, the Query Merchandiser allows you to enchance the ranking behaviour for specific search queries.

Merchandising a query will create a new query rule (which are part of your Algolia plan). To find out more about the Query Merchandiser, please see our documentation.

-

Merchandise a new query

+

Merchandise a new query

\ No newline at end of file diff --git a/view/adminhtml/templates/queue/status.phtml b/view/adminhtml/templates/queue/status.phtml index c8d8cc664..4f260146c 100644 --- a/view/adminhtml/templates/queue/status.phtml +++ b/view/adminhtml/templates/queue/status.phtml @@ -1,46 +1,47 @@

- - escapeHtml(__('Indexing queue documentation')) ?> + + escapeHtml(__('Indexing queue documentation')) ?>

- - escapeHtml(__('Indexing troubleshooting guide')) ?> + + escapeHtml(__('Indexing troubleshooting guide')) ?>

- escapeHtml(__('Related video:')) ?> + escapeHtml(__('Related video:')) ?> - escapeHtml(__('The indexing queue')) ?> + escapeHtml(__('The indexing queue')) ?>

-isQueueActive()) : ?> +isQueueActive()): ?>
- %1.', $block->getQueueRunnerStatus()); ?> -

%1.', $block->getLastQueueUpdate()); ?>

+ escapeHtml(__('Status of the queue : %1.', $block->getQueueRunnerStatus())); ?> +

escapeHtml(__('Last Update : %1.', $block->getLastQueueUpdate())); ?>

getNotices() ?> - -

+ +

escapeHtml($notice) ?>

-

getUrl('*/*/log') . '">indexing queue run logs') ?>

-

getUrl('*/queuearchive/index') . '">Queue Archive') ?>

+

escapeHtml(__('See how well your indexing queue is performing by viewing your %1.', 'indexing queue run logs')) ?>

+

escapeHtml(__('Access the %1.', 'Queue Archive')) ?>

diff --git a/view/adminhtml/templates/queuearchive/links.phtml b/view/adminhtml/templates/queuearchive/links.phtml index bb2344741..4b99bb4be 100644 --- a/view/adminhtml/templates/queuearchive/links.phtml +++ b/view/adminhtml/templates/queuearchive/links.phtml @@ -6,8 +6,8 @@

- - escapeHtml(__('Indexing queue archives documentation')) ?> + + escapeHtml(__('Indexing queue archives documentation')) ?>

diff --git a/view/adminhtml/templates/support/components/legacy-version.phtml b/view/adminhtml/templates/support/components/legacy-version.phtml index 6542d087f..670c23974 100644 --- a/view/adminhtml/templates/support/components/legacy-version.phtml +++ b/view/adminhtml/templates/support/components/legacy-version.phtml @@ -2,7 +2,7 @@ /** @var \Magento\Backend\Block\Template $block */ ?>
diff --git a/view/adminhtml/templates/support/overview.phtml b/view/adminhtml/templates/support/overview.phtml index 55d4f8dbc..b658a5586 100644 --- a/view/adminhtml/templates/support/overview.phtml +++ b/view/adminhtml/templates/support/overview.phtml @@ -1,7 +1,7 @@ getViewModel(); @@ -16,13 +16,13 @@ $videoFeatures = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/video-fea ?> -getLegacyVersionHtml(); ?> +getLegacyVersionHtml(); ?>
@@ -31,9 +31,8 @@ $videoFeatures = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/video-fea
-
@@ -44,11 +43,11 @@ $videoFeatures = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/video-fea
- escapeHtml(__('Documentation')) ?> + escapeHtml(__('Documentation')) ?>
- escapeHtml(__('The official Algolia for Magento documentation')) ?> + escapeHtml(__('The official Algolia for Magento documentation')) ?>
@@ -63,11 +62,11 @@ $videoFeatures = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/video-fea
- escapeHtml(__('Community Forum')) ?> + escapeHtml(__('Community Forum')) ?>
- escapeHtml(__('Questions and answers from the Algolia community')) ?> + escapeHtml(__('Questions and answers from the Algolia community')) ?>
@@ -82,165 +81,165 @@ $videoFeatures = $block->getViewFileUrl('Algolia_AlgoliaSearch::images/video-fea
- <?php echo $block->escapeHtmlAttr(__('Documentation')) ?> + <?= $escaper->escapeHtmlAttr(__('Documentation')) ?>
- escapeHtml(__('Documentation')) ?> + escapeHtml(__('Documentation')) ?>
- escapeHtml(__('Documentation for all things Algolia for Magento')) ?> + escapeHtml(__('Documentation for all things Algolia for Magento')) ?>
- escapeHtml(__('Indexing')) ?> + escapeHtml(__('Indexing')) ?> - escapeHtml(__('In order to provide fast and relevant search, Algolia restructures your data in a special way, via Indexing.')) ?> + escapeHtml(__('In order to provide fast and relevant search, Algolia restructures your data in a special way, via Indexing.')) ?> - escapeHtml(__('Indexing Queue')) ?> + escapeHtml(__('Indexing Queue')) ?> - escapeHtml(__('The index queue manages all uploads to Algolia. Before your data can be searched, it must be uploaded to Algolia. This process is called indexing, which the extension does automatically - via the queue.')) ?> + escapeHtml(__('The index queue manages all uploads to Algolia. Before your data can be searched, it must be uploaded to Algolia. This process is called indexing, which the extension does automatically - via the queue.')) ?> - escapeHtml(__('Autocomplete menu')) ?> + escapeHtml(__('Autocomplete menu')) ?> - escapeHtml(__('Customize the autocomplete drop-down menu which appears underneath the search bar on your Magento site.')) ?> + escapeHtml(__('Customize the autocomplete drop-down menu which appears underneath the search bar on your Magento site.')) ?> - escapeHtml(__('Customize the extension')) ?> + escapeHtml(__('Customize the extension')) ?> - escapeHtml(__('In this guide you’ll learn how to attach hooks to the events fired by the Algolia extension. It should only take a few minutes. Let’s get started!')) ?> + escapeHtml(__('In this guide you’ll learn how to attach hooks to the events fired by the Algolia extension. It should only take a few minutes. Let’s get started!')) ?> - escapeHtml(__('Troubleshooting')) ?> + escapeHtml(__('Troubleshooting')) ?> - escapeHtml(__('Let\'s say you\'re getting an error with your data or search results. It may be an error that other Magento/Algolia users experience.')) ?> + escapeHtml(__('Let\'s say you\'re getting an error with your data or search results. It may be an error that other Magento/Algolia users experience.')) ?>
- escapeHtml(__('Go to documentation homepage ...')) ?> + escapeHtml(__('Go to documentation homepage ...')) ?>
- <?php echo $block->escapeHtmlAttr('Community Forum') ?> + <?= $escaper->escapeHtmlAttr('Community Forum') ?>
- escapeHtml(__('Community Forum')) ?> + escapeHtml(__('Community Forum')) ?>
- escapeHtml(__('Questions and answers from the Algolia community')) ?> + escapeHtml(__('Questions and answers from the Algolia community')) ?>
- escapeHtml(__('Autocomplete results configurable product prices showing £0.00')) ?> + escapeHtml(__('Autocomplete results configurable product prices showing £0.00')) ?> - escapeHtml(__('We are using the official Algolia extension 1.7.0 on Magento 2.2.4 CE. For some reason our Magento 2 store’s autocomplete search results (the dropdown box below the search input field) is now showing zero prices for some Configurable products (where until the day before yesterday) it would show a range from lowest to highest.')) ?> + escapeHtml(__('We are using the official Algolia extension 1.7.0 on Magento 2.2.4 CE. For some reason our Magento 2 store’s autocomplete search results (the dropdown box below the search input field) is now showing zero prices for some Configurable products (where until the day before yesterday) it would show a range from lowest to highest.')) ?> - escapeHtml(__('Custom Searchable attributes')) ?> + escapeHtml(__('Custom Searchable attributes')) ?> - escapeHtml(__('As per instructions found at Algolia we\'ve tried to set a list of Indexable attributes to sent from Magento 2.1.7 to Algolia.')) ?> + escapeHtml(__('As per instructions found at Algolia we\'ve tried to set a list of Indexable attributes to sent from Magento 2.1.7 to Algolia.')) ?> - escapeHtml(__('M2.1.7 JS Error on Clean install')) ?> + escapeHtml(__('M2.1.7 JS Error on Clean install')) ?> - escapeHtml(__('Just installed Algolia for Magento 2 via composer, run setup:upgrade and deployed files and cleared caches (site is still in developer mode).')) ?> + escapeHtml(__('Just installed Algolia for Magento 2 via composer, run setup:upgrade and deployed files and cleared caches (site is still in developer mode).')) ?> - escapeHtml(__('Layered Navigation on search result pages')) ?> + escapeHtml(__('Layered Navigation on search result pages')) ?> - escapeHtml(__('I have an issue with layered navigation (Filters) on Search result pages within Magento where Instant search is not being used.')) ?> + escapeHtml(__('I have an issue with layered navigation (Filters) on Search result pages within Magento where Instant search is not being used.')) ?> - escapeHtml(__('Magento in the URL')) ?> + escapeHtml(__('Magento in the URL')) ?> - escapeHtml(__('My Algolia dashboard indexed URL\'s not updated after 6 hours - still contain ref to “bad” URL\'s. Have performed magento indexer:reindex.')) ?> + escapeHtml(__('My Algolia dashboard indexed URL\'s not updated after 6 hours - still contain ref to “bad” URL\'s. Have performed magento indexer:reindex.')) ?>
- escapeHtml(__('Browse more forum topics ...')) ?> + escapeHtml(__('Browse more forum topics ...')) ?>
- <?php echo $block->escapeHtmlAttr(__('Video Tutorials')) ?> + <?= $escaper->escapeHtmlAttr(__('Video Tutorials')) ?>
- escapeHtml(__('Video Tutorials')) ?> + escapeHtml(__('Video Tutorials')) ?>
- escapeHtml(__('An introduction to the Magento extension in video')) ?> + escapeHtml(__('An introduction to the Magento extension in video')) ?>
- <?php echo $block->escapeHtmlAttr(__('Discover the extension')) ?> + <?= $escaper->escapeHtmlAttr(__('Discover the extension')) ?>
- escapeHtml(__('Discover the extension')) ?> + escapeHtml(__('Discover the extension')) ?>
- <?php echo $block->escapeHtmlAttr(__('Understand Indexing queue')) ?> + <?= $escaper->escapeHtmlAttr(__('Understand Indexing queue')) ?>
- escapeHtml(__('Understand Indexing Queue')) ?> + escapeHtml(__('Understand Indexing Queue')) ?>
- <?php echo $block->escapeHtmlAttr(__('See all extra features')) ?> + <?= $escaper->escapeHtmlAttr(__('See all extra features')) ?>
- escapeHtml(__('See all extra features')) ?> + escapeHtml(__('See all extra features')) ?>
- escapeHtml(__('View more tutorials ...')) ?> + escapeHtml(__('View more tutorials ...')) ?>
diff --git a/view/adminhtml/templates/ui/tooltip.phtml b/view/adminhtml/templates/ui/tooltip.phtml index 4da16e7a5..380ded190 100644 --- a/view/adminhtml/templates/ui/tooltip.phtml +++ b/view/adminhtml/templates/ui/tooltip.phtml @@ -1,6 +1,8 @@ +
- getMessage() ?> + escapeHtml($block->getMessage()) ?>
diff --git a/view/adminhtml/ui_component/cms_page_listing.xml b/view/adminhtml/ui_component/cms_page_listing.xml new file mode 100644 index 000000000..edbb54ae4 --- /dev/null +++ b/view/adminhtml/ui_component/cms_page_listing.xml @@ -0,0 +1,23 @@ + ++ + + diff --git a/view/adminhtml/ui_component/product_listing.xml b/view/adminhtml/ui_component/product_listing.xml new file mode 100644 index 000000000..cf456a1fb --- /dev/null +++ b/view/adminhtml/ui_component/product_listing.xml @@ -0,0 +1,23 @@ + ++ + + diff --git a/view/adminhtml/web/css/common.css b/view/adminhtml/web/css/common.css index 5b512ea11..6c5c83dd6 100644 --- a/view/adminhtml/web/css/common.css +++ b/view/adminhtml/web/css/common.css @@ -317,23 +317,6 @@ } } -.aa-dropdown-menu .aa-dataset-products .aa-suggestion { - display: inline-block; - width: 100%; -} - -@media (min-width: 768px) { - .aa-dropdown-menu .aa-dataset-products .aa-suggestion { - display: inline-block; - } -} - -.aa-dataset-products .aa-suggestions:after { - content:''; - display:block; - clear: both; -} - .aa-dropdown-menu .algoliasearch-autocomplete-hit { display: block; position: relative; diff --git a/view/adminhtml/web/css/indexing-manager.css b/view/adminhtml/web/css/indexing-manager.css new file mode 100644 index 000000000..0bccd78f3 --- /dev/null +++ b/view/adminhtml/web/css/indexing-manager.css @@ -0,0 +1,30 @@ +.algolia-indexing-manager-overview { + margin-bottom: 1.2rem; + padding: 1.5rem 0; +} + +.algolia-indexing-manager-section { + border: 1px solid #e3e3e3; + margin: 1.5rem 0; + padding: 1.5rem 3rem; +} + +.algolia-actions-buttons { + text-align: right; +} + +.algolia-indexing-manager-form { + margin-top: .7rem; + float: right; +} + +.algolia-indexing-manager-form .inline-field { + display: inline-block; + vertical-align: top; +} +.algolia-indexing-manager-form .inline-field select, +.algolia-indexing-manager-form .inline-field p { + padding-top: 0.6rem; + padding-bottom: 0.6rem; + margin-right: 1.5rem; +} diff --git a/view/adminhtml/web/css/landing-page.css b/view/adminhtml/web/css/landing-page.css index d6e0a0f53..07d64e93c 100644 --- a/view/adminhtml/web/css/landing-page.css +++ b/view/adminhtml/web/css/landing-page.css @@ -346,23 +346,6 @@ input::-ms-clear { } } -.aa-dropdown-menu .aa-dataset-products .aa-suggestion { - display: inline-block; - width: 100%; -} - -@media (min-width: 768px) { - .aa-dropdown-menu .aa-dataset-products .aa-suggestion { - display: inline-block; - } -} - -.aa-dataset-products .aa-suggestions:after { - content:''; - display:block; - clear: both; -} - .aa-dropdown-menu .algoliasearch-autocomplete-hit { display: block; position: relative; diff --git a/view/adminhtml/web/js/config.js b/view/adminhtml/web/js/config.js index daac7ee0c..8942b9479 100644 --- a/view/adminhtml/web/js/config.js +++ b/view/adminhtml/web/js/config.js @@ -11,7 +11,8 @@ require( // rows const rowIds = [ '#row_algoliasearch_instant_instant_facets_facets', - '#row_algoliasearch_instant_instant_facets_max_values_per_facet' + '#row_algoliasearch_instant_instant_facets_max_values_per_facet', + '#row_algoliasearch_instant_instant_facets_enable_dynamic_facets' ]; let rowWarning = '
'; @@ -38,6 +39,7 @@ require( pageWarning += '
'; let pageWarningSynonyms = '
'; + pageWarningSynonyms += '

Configurations related to indexing have been moved to the "Indexing Manager" section.

'; pageWarningSynonyms += '

Configurations related to Synonyms have been removed from the Magento dashboard. We advise you to configure synonyms from the Algolia dashboard.

'; pageWarningSynonyms += '
'; @@ -68,7 +70,7 @@ require( const searchableSelect = $('select[name="groups[instant_facets][fields][facets][value][' + rowId + '][searchable]"]'); searchableSelect.on('change', function(){ - configQrFromSearchableSelect($(this)); + configQrFromSearchableSelect($(this)); }); configQrFromSearchableSelect(searchableSelect); @@ -92,4 +94,4 @@ require( } } -); +); diff --git a/view/frontend/layout/algolia_search_handle.xml b/view/frontend/layout/algolia_search_handle.xml index 01b68e5ae..2de95730d 100755 --- a/view/frontend/layout/algolia_search_handle.xml +++ b/view/frontend/layout/algolia_search_handle.xml @@ -4,7 +4,7 @@ - + @@ -22,9 +22,8 @@ - - + Algolia_AlgoliaSearch::autocomplete.phtml diff --git a/view/frontend/requirejs-config.js b/view/frontend/requirejs-config.js index 7236ce1ac..10bc141dc 100644 --- a/view/frontend/requirejs-config.js +++ b/view/frontend/requirejs-config.js @@ -28,15 +28,16 @@ const config = { 'algoliaSearchLib' : 'Algolia_AlgoliaSearch/js/lib/algolia-search.min', 'algoliaSearchHelperLib' : 'Algolia_AlgoliaSearch/js/lib/algolia-search-helper.min', 'algoliaInstantSearchLib': 'Algolia_AlgoliaSearch/js/lib/algolia-instantsearch.min', - 'algoliaAutocompleteLib' : 'Algolia_AlgoliaSearch/js/lib/algolia-autocomplete.min', + 'algoliaAutocompleteLib' : 'Algolia_AlgoliaSearch/js/lib/autocomplete/algolia-autocomplete.min', 'algoliaAnalyticsLib' : 'Algolia_AlgoliaSearch/js/lib/search-insights.min', 'algoliaRecommendLib' : 'Algolia_AlgoliaSearch/js/lib/recommend.min', 'algoliaRecommendJsLib' : 'Algolia_AlgoliaSearch/js/lib/recommend-js.min', // Autocomplete plugins - 'algoliaQuerySuggestionsPluginLib' : 'Algolia_AlgoliaSearch/js/lib/query-suggestions-plugin.min', - 'algoliaInsightsPluginLib' : 'Algolia_AlgoliaSearch/js/lib/insights-plugin.min', - 'algoliaRecentSearchesPluginLib' : 'Algolia_AlgoliaSearch/js/lib/recent-searches-plugin.min', + 'algoliaQuerySuggestionsPluginLib': 'Algolia_AlgoliaSearch/js/lib/autocomplete/query-suggestions-plugin.min', + 'algoliaInsightsPluginLib' : 'Algolia_AlgoliaSearch/js/lib/autocomplete/insights-plugin.min', + 'algoliaRecentSearchesPluginLib' : 'Algolia_AlgoliaSearch/js/lib/autocomplete/recent-searches-plugin.min', + 'algoliaRedirectUrlPluginLib' : 'Algolia_AlgoliaSearch/js/lib/autocomplete/redirect-url-plugin.min', // Autocomplete templates 'algoliaAutocompleteProductsHtml' : 'Algolia_AlgoliaSearch/js/template/autocomplete/products', diff --git a/view/frontend/templates/autocomplete.phtml b/view/frontend/templates/autocomplete.phtml index b0978a48a..77a19c157 100755 --- a/view/frontend/templates/autocomplete.phtml +++ b/view/frontend/templates/autocomplete.phtml @@ -6,7 +6,7 @@ $config = $blockInstance->getConfigHelper(); $catalogSearchHelper = $blockInstance->getCatalogSearchHelper(); // Render form with autocomplete input -if ($config->isAutoCompleteEnabled()) : ?> +if ($config->isAutoCompleteEnabled()): ?> \ No newline at end of file + var algoliaOrderConversionJson = JSON.parse('escapeJs($orderItemsJson) ?>'); + diff --git a/view/frontend/templates/instant/hit.phtml b/view/frontend/templates/instant/hit.phtml index ecd3f3e0c..6eedb47d7 100644 --- a/view/frontend/templates/instant/hit.phtml +++ b/view/frontend/templates/instant/hit.phtml @@ -1,14 +1,14 @@ getPriceKey(); $currencyCode = $block->getCurrencyCode(); -$baseVar = $block->escapeHtml('price' . $priceKey); -$maxVar = $block->escapeHtml('price' . $priceKey . '_max'); -$baseFormatedVar = $block->escapeHtml('price' . $priceKey . '_formated'); -$origFormatedVar = $block->escapeHtml('price' . $priceKey . '_original_formated'); +$baseVar = $escaper->escapeHtml('price' . $priceKey); +$maxVar = $escaper->escapeHtml('price' . $priceKey . '_max'); +$baseFormatedVar = $escaper->escapeHtml('price' . $priceKey . '_formated'); +$origFormatedVar = $escaper->escapeHtml('price' . $priceKey . '_original_formated'); ?> @@ -40,7 +40,7 @@ $origFormatedVar = $block->escapeHtml('price' . $priceKey . '_original_formated'
- : + escapeHtml(__('Rating')) ?>:
{{rating_summary}}% @@ -50,30 +50,30 @@ $origFormatedVar = $block->escapeHtml('price' . $priceKey . '_original_formated'
- {{^}} + {{^escapeHtml($maxVar) ?>}}
- - {{/}} - {{#}} + + {{/escapeHtml($maxVar); ?>}} + {{#escapeHtml($maxVar); ?>}}
- - - {{/}} - + + + {{/escapeHtml($maxVar); ?>}} +
- {{}} + {{/escapeHtml($origFormatedVar); ?>}}"> + {{escapeHtml($baseFormatedVar); ?>}} - {{#}} + {{#escapeHtml($origFormatedVar); ?>}} - {{}} + {{escapeHtml($origFormatedVar); ?>}} - {{/}} + {{/escapeHtml($origFormatedVar); ?>}}
@@ -90,13 +90,13 @@ $origFormatedVar = $block->escapeHtml('price' . $priceKey . '_original_formated' {{#_highlightResult.default_bundle_options}}{{/_highlightResult.default_bundle_options}} - {{/isAddToCartEnabled}} diff --git a/view/frontend/templates/instant/refinements.phtml b/view/frontend/templates/instant/refinements.phtml deleted file mode 100644 index 82dbdf969..000000000 --- a/view/frontend/templates/instant/refinements.phtml +++ /dev/null @@ -1,15 +0,0 @@ - \ No newline at end of file diff --git a/view/frontend/templates/instant/stats.phtml b/view/frontend/templates/instant/stats.phtml index 65c246220..850ed915b 100644 --- a/view/frontend/templates/instant/stats.phtml +++ b/view/frontend/templates/instant/stats.phtml @@ -1,15 +1,15 @@ diff --git a/view/frontend/templates/instant/wrapper.phtml b/view/frontend/templates/instant/wrapper.phtml index c5586cdf4..d8648af7e 100644 --- a/view/frontend/templates/instant/wrapper.phtml +++ b/view/frontend/templates/instant/wrapper.phtml @@ -2,16 +2,12 @@ -canLoadInstantSearch()) : ?> +canLoadInstantSearch()): ?> - + diff --git a/view/frontend/templates/layer/filter/category.phtml b/view/frontend/templates/layer/filter/category.phtml index 9be32312d..6b1db145b 100644 --- a/view/frontend/templates/layer/filter/category.phtml +++ b/view/frontend/templates/layer/filter/category.phtml @@ -1,21 +1,22 @@ +
  1. getCount() > 0): ?> - - getLabel() ?> - helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> - getCount() ?> - getCount() == 1):?> + + escapeHtml($filterItem->getLabel()) ?> + helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> + escapeHtml($filterItem->getCount()) ?> + getCount() == 1):?> escapeHtml(__('item')) ?> escapeHtml(__('items')) ?> - getLabel() ?> - helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> - getCount() ?> - getCount() == 1):?> + escapeHtml($filterItem->getLabel()) ?> + helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> + escapeHtml($filterItem->getCount()) ?> + getCount() == 1):?>escapeHtml(__('item')) ?>escapeHtml(__('items')) ?>
    2. -
\ No newline at end of file + diff --git a/view/frontend/templates/layer/filter/default.phtml b/view/frontend/templates/layer/filter/default.phtml index 9be32312d..f0d98ea8d 100644 --- a/view/frontend/templates/layer/filter/default.phtml +++ b/view/frontend/templates/layer/filter/default.phtml @@ -1,21 +1,24 @@ +
  1. getCount() > 0): ?> - - getLabel() ?> - helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> - getCount() ?> - getCount() == 1):?> + + escapeHtml($filterItem->getLabel()) ?> + helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> + escapeHtml($filterItem->getCount()) ?> + getCount() == 1):?> escapeHtml(__('item')) ?> + escapeHtml(__('items')) ?> - getLabel() ?> - helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> - getCount() ?> - getCount() == 1):?> + escapeHtml($filterItem->getLabel()) ?> + helper('\Magento\Catalog\Helper\Data')->shouldDisplayProductCountOnLayer()): ?> + escapeHtml($filterItem->getCount()) ?> + getCount() == 1):?>escapeHtml(__('item')) ?> + escapeHtml(__('items')) ?>
    2. -
\ No newline at end of file + diff --git a/view/frontend/templates/layer/filter/js-default.phtml b/view/frontend/templates/layer/filter/js-default.phtml index 015214517..b818affae 100644 --- a/view/frontend/templates/layer/filter/js-default.phtml +++ b/view/frontend/templates/layer/filter/js-default.phtml @@ -1,13 +1,14 @@ getFilter()->getRequestVar() . 'Filter'; +/** @var \Magento\Backend\Block\Template $block */ +/** @var \Magento\Framework\Escaper $escaper */ + +$datascope = $block->getFilter()->getRequestVar() . 'Filter'; ?> - -
+ +
- - - \ No newline at end of file + diff --git a/view/frontend/templates/layer/filter/slider.phtml b/view/frontend/templates/layer/filter/slider.phtml index f17f9461e..792dc41b2 100644 --- a/view/frontend/templates/layer/filter/slider.phtml +++ b/view/frontend/templates/layer/filter/slider.phtml @@ -1,16 +1,21 @@ -
+ +
- +
- + + diff --git a/view/frontend/templates/layer/view.phtml b/view/frontend/templates/layer/view.phtml index fed6c8e61..bec577c40 100644 --- a/view/frontend/templates/layer/view.phtml +++ b/view/frontend/templates/layer/view.phtml @@ -1,36 +1,39 @@ -canShowBlock()) : ?> +canShowBlock()): ?>
getLayer()->getState()->getFilters()) ?> -
- +
+ escapeHtml(__('Shop By')) ?>
- getLayer()->getState()->getFilters()) : ?> + getLayer()->getState()->getFilters()): ?>
- +
- getChildHtml('state') ?> + getChildHtml('state') ?> getFilters()))); ?> - getFilters() as $filter) : ?> - getItemsCount()) : ?> - -
+ getFilters() as $filter): ?> + getItemsCount()): ?> + +
-
getName()) ?>
-
getChildBlock('renderer')->render($filter) ?>
+
escapeHtml(__($filter->getName())) ?>
+
escapeHtml($block->getChildBlock('renderer')->render($filter)) ?>
- +
- - + + renderTag('script', [], $scriptString, false); ?> - +