-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1662 from algolia/feat/MAGE-1122-intentional-pric…
…e-indexing MAGE-1122 intentional price indexing
- Loading branch information
Showing
7 changed files
with
264 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <?php | ||
|
|
||
| namespace Algolia\AlgoliaSearch\Model\Config; | ||
|
|
||
| use Magento\Config\Model\Config\CommentInterface; | ||
| use Magento\Framework\UrlInterface; | ||
|
|
||
| class AutomaticPriceIndexingComment implements CommentInterface | ||
| { | ||
| public function __construct( | ||
| protected UrlInterface $urlInterface | ||
| ) { } | ||
|
|
||
| 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[] = '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 <a href="' . $url . '" target="_blank">optimize the indexing queue</a> based on the impact of this operation.'; | ||
| return implode('<br><br>', $comment); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| <?php | ||
|
|
||
| namespace Algolia\AlgoliaSearch\Service\Product; | ||
|
|
||
| use Algolia\AlgoliaSearch\Helper\Logger; | ||
| use Magento\Catalog\Model\ResourceModel\Product\Collection as ProductCollection; | ||
| use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory; | ||
| use Magento\Framework\App\ResourceConnection; | ||
| use Magento\Framework\DB\Select; | ||
| use Magento\Framework\Indexer\IndexerInterface; | ||
| use Magento\Framework\Indexer\IndexerRegistry; | ||
| use Magento\Framework\Indexer\StateInterface; | ||
| use Zend_Db_Select; | ||
|
|
||
| class MissingPriceIndexHandler | ||
| { | ||
| public const PRICE_INDEX_TABLE = 'catalog_product_index_price'; | ||
| public const PRICE_INDEX_TABLE_ALIAS = 'price_index'; | ||
| public const MAIN_TABLE_ALIAS = 'e'; | ||
|
|
||
| protected array $_indexedProducts = []; | ||
|
|
||
| protected IndexerInterface $indexer; | ||
| public function __construct( | ||
| protected CollectionFactory $productCollectionFactory, | ||
| protected ResourceConnection $resourceConnection, | ||
| protected Logger $logger, | ||
| IndexerRegistry $indexerRegistry | ||
| ) | ||
| { | ||
| $this->indexer = $indexerRegistry->get('catalog_product_price'); | ||
| } | ||
|
|
||
| /** | ||
| * @param string[]|ProductCollection $products | ||
| * @return string[] Array of product IDs that were reindexed by this repair operation | ||
| */ | ||
| public function refreshPriceIndex(array|ProductCollection $products): array | ||
| { | ||
| $reindexIds = $this->getProductIdsToReindex($products); | ||
| if (empty($reindexIds)) { | ||
| return []; | ||
| } | ||
|
|
||
| $this->logger->log(__("Pricing records missing or invalid for %1 product(s)", count($reindexIds))); | ||
| $this->logger->log(__("Reindexing product ID(s): %1", implode(', ', $reindexIds))); | ||
|
|
||
| $this->indexer->reindexList($reindexIds); | ||
|
|
||
| return $reindexIds; | ||
| } | ||
|
|
||
| /** | ||
| * Analyzes a product collection and determines which (if any) records should have their prices reindexed | ||
| * @param string[]|ProductCollection $products - either an explicit list of product ids or a product collection | ||
| * @return string[] IDs of products that require price reindexing (will be empty if no indexing is required) | ||
| */ | ||
| protected function getProductIdsToReindex(array|ProductCollection $products): array | ||
| { | ||
| $productIds = $products instanceof ProductCollection | ||
| ? $this->getProductIdsFromCollection($products) | ||
| : $products; | ||
|
|
||
| if (empty($productIds)) { | ||
| return []; | ||
| } | ||
|
|
||
| $state = $this->indexer->getState()->getStatus(); | ||
| if ($state === StateInterface::STATUS_INVALID) { | ||
| return $this->filterProductIdsNotYetProcessed($productIds); | ||
| } | ||
|
|
||
| $productIds = $this->filterProductIdsMissingPricing($productIds); | ||
| if (empty($productIds)) { | ||
| return []; | ||
| } | ||
|
|
||
| return $this->filterProductIdsNotYetProcessed($productIds); | ||
| } | ||
|
|
||
| protected function filterProductIdsMissingPricing(array $productIds): array | ||
| { | ||
| $collection = $this->productCollectionFactory->create(); | ||
|
|
||
| $collection->addAttributeToSelect(['name', 'price']); | ||
|
|
||
| $collection->getSelect()->joinLeft( | ||
| [self::PRICE_INDEX_TABLE_ALIAS => self::PRICE_INDEX_TABLE], | ||
| self::MAIN_TABLE_ALIAS . '.entity_id = ' . self::PRICE_INDEX_TABLE_ALIAS . '.entity_id', | ||
| [] | ||
| ); | ||
|
|
||
| $collection->getSelect() | ||
| ->where(self::PRICE_INDEX_TABLE_ALIAS . '.entity_id IS NULL') | ||
| ->where(self::MAIN_TABLE_ALIAS . '.entity_id IN (?)', $productIds); | ||
|
|
||
| return $collection->getAllIds(); | ||
| } | ||
|
|
||
| protected function filterProductIdsNotYetProcessed(array $productIds): array { | ||
| $pendingProcessing = array_fill_keys($productIds, true); | ||
|
|
||
| $notProcessed = array_diff_key($pendingProcessing, $this->_indexedProducts); | ||
|
|
||
| if (empty($notProcessed)) { | ||
| return []; | ||
| } | ||
|
|
||
| $this->_indexedProducts += $notProcessed; | ||
|
|
||
| return array_keys($notProcessed); | ||
| } | ||
|
|
||
| /** | ||
| * Expand the query for product ids from the collection regardless of price index status | ||
| * @return string[] An array of indices to be evaluated - array will be empty if no price index join found | ||
| */ | ||
| protected function getProductIdsFromCollection(ProductCollection $collection): array | ||
| { | ||
|
|
||
| $select = clone $collection->getSelect(); | ||
| try { | ||
| $joins = $select->getPart(Zend_Db_Select::FROM); | ||
| } catch (\Zend_Db_Select_Exception $e) { | ||
| $this->logger->error("Unable to build query for missing product prices: " . $e->getMessage()); | ||
| return []; | ||
| } | ||
|
|
||
| $priceIndexJoin = $this->getPriceIndexJoinAlias($joins); | ||
|
|
||
| if (!$priceIndexJoin) { | ||
| // no price index on query - keep calm and carry on | ||
| return []; | ||
| } | ||
|
|
||
| $this->expandPricingJoin($joins, $priceIndexJoin); | ||
| $this->rebuildJoins($select, $joins); | ||
|
|
||
| return $this->resourceConnection->getConnection()->fetchCol($select); | ||
| } | ||
|
|
||
| protected function expandPricingJoin(array &$joins, string $priceIndexJoin): void | ||
| { | ||
| $modifyJoin = &$joins[$priceIndexJoin]; | ||
| $modifyJoin['joinType'] = Zend_Db_Select::LEFT_JOIN; | ||
| } | ||
|
|
||
| protected function rebuildJoins(Select $select, array $joins): void | ||
| { | ||
| $select->reset(Zend_Db_Select::COLUMNS); | ||
| $select->reset(Zend_Db_Select::FROM); | ||
| foreach ($joins as $alias => $joinData) { | ||
| if ($joinData['joinType'] === Zend_Db_Select::FROM) { | ||
| $select->from( | ||
| [$alias => $joinData['tableName']], | ||
| 'entity_id' | ||
| ); | ||
| } elseif ($joinData['joinType'] === Zend_Db_Select::LEFT_JOIN) { | ||
| $select->joinLeft( | ||
| [$alias => $joinData['tableName']], | ||
| $joinData['joinCondition'], | ||
| [], | ||
| $joinData['schema'] | ||
| ); | ||
| } else { | ||
| $select->join( | ||
| [$alias => $joinData['tableName']], | ||
| $joinData['joinCondition'], | ||
| [], | ||
| $joinData['schema'] | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param array<string, array> $joins | ||
| * @return string | ||
| */ | ||
| protected function getPriceIndexJoinAlias(array $joins): string | ||
| { | ||
| if (isset($joins[self::PRICE_INDEX_TABLE_ALIAS])) { | ||
| return self::PRICE_INDEX_TABLE_ALIAS; | ||
| } | ||
| else { | ||
| foreach ($joins as $alias => $joinData) { | ||
| if ($joinData['tableName'] === self::PRICE_INDEX_TABLE) { | ||
| return $alias; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return ""; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters