Merge pull request #1838 from algolia/release/3.16.1-dev

3.16.1-dev => main

Author: damcou

.circleci/config.yml

@@ -159,7 +159,7 @@ jobs:
           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
@@ -173,6 +173,10 @@ jobs:
 
 workflows:
   magento-build-and-test-workflow:
+    when:
+      matches:
+        pattern: "^(feat|fix|chore)/MAGE.*"
+        value: << pipeline.git.branch >>
     jobs:
       - magento-build:
           matrix:

.codacy.yml

@@ -0,0 +1,5 @@
+---
+exclude_paths:
+  - ".php-cs-fixer.php"
+  - "dev/**"
+  - "Test/**"

.gitignore

@@ -5,3 +5,4 @@ vendor/
 .php_cs.cache
 .vscode
 .idea
+node_modules

Api/Insights/EventProcessorInterface.php

@@ -43,6 +43,7 @@ public function setAuthenticatedUserToken(string $token): EventProcessorInterfac
 
     public function setAnonymousUserToken(string $token): EventProcessorInterface;
 
+    /** @deprecated Store Manager now handled as injected dependency */
     public function setStoreManager(StoreManagerInterface $storeManager): EventProcessorInterface;
 
     /**

CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGE LOG
 
+## 3.16.1
+
+### Updates
+- Add checks on configuration migration processed on data patch
+- `EventProcessor` now calculates decimal precision on currency based on `Magento\Framework\Locale\FormatInterface`
+- Updated various unit/integration tests
+
+### Bug fixes 
+- Fixed Indexing Queue display in backend templates.
+- Fixed Indexing Queue merging mechanism, it should now have way better performances with delta indexing (updates) jobs.
+- Fixed implicit nullable types for PHP 8.4
+- Ensure that only non-redirect URL rewrites are considered when generating product URLs - thank you @fasimana
+- Apply rounding to insight events revenue values to avoid floating point precision errors - thank you @PromInc
+- Fix issue where double conversion occurred during price indexing in case of multi currency stores - thank you @natedawg92
+- Fix issue where non-clickable links where rendered on InstantSearch - thank you @PromInc
+- Fixed some Codacy issues
+
 ## 3.16.0
 
 ### Features

Helper/Configuration/NoticeHelper.php

@@ -99,6 +99,8 @@ protected function getQueueNotice()
                                 in approx. ' . $eta . '.
                                 You may want to <a href="' . $indexingQueuePageUrl . '">clear the queue</a> or <a href="' . $indexingQueueConfigUrl . '">configure indexing queue</a>.
                                 <br><br>
+                                Depending on your configuration set on "Advanced > Maximum number of records processed per indexing job" and if the jobs can be merged into batches, you can expect higher performances.
+                                <br><br>
                                 Find out more about Indexing Queue in <a href="https://www.algolia.com/doc/integration/magento-2/how-it-works/indexing-queue/?utm_source=magento&utm_medium=extension&utm_campaign=magento_2&utm_term=shop-owner&utm_content=doc-link" target="_blank">documentation</a>.';
         }
 

Helper/Entity/Product/PriceManager/ProductWithChildren.php

@@ -58,8 +58,17 @@ protected function getMinMaxPrices(Product $product, $withTax, $subProducts, $cu
                 } else {
                     $minPrice = $specialPrice[0];
                 }
-                $price     = $minPrice ?? $this->getTaxPrice($product, $subProduct->getFinalPrice(), $withTax);
-                $basePrice = $this->getTaxPrice($product, $subProduct->getPrice(), $withTax);
+
+                $finalPrice = $subProduct->getFinalPrice();
+                $basePrice  = $subProduct->getPrice();
+
+                if ($currencyCode !== $this->baseCurrencyCode) {
+                    $finalPrice = $this->convertPrice($finalPrice, $currencyCode);
+                    $basePrice  = $this->convertPrice($basePrice, $currencyCode);
+                }
+
+                $price     = $minPrice ?? $this->getTaxPrice($product, $finalPrice, $withTax);
+                $basePrice = $this->getTaxPrice($product, $basePrice, $withTax);
                 $min = min($min, $price);
                 $original = min($original, $basePrice);
                 $max = max($max, $price);
@@ -68,14 +77,7 @@ protected function getMinMaxPrices(Product $product, $withTax, $subProducts, $cu
         } else {
             $originalMax = $original = $min = $max;
         }
-        if ($currencyCode !== $this->baseCurrencyCode) {
-            $min      = $this->convertPrice($min, $currencyCode);
-            $original = $this->convertPrice($original, $currencyCode);
-            if ($min !== $max) {
-                $max = $this->convertPrice($max, $currencyCode);
-                $originalMax = $this->convertPrice($originalMax, $currencyCode);
-            }
-        }
+
         return [$min, $max, $original, $originalMax];
     }
 

Helper/InsightsHelper.php

@@ -91,8 +91,7 @@ public function getEventProcessor(): EventProcessorInterface
             $this->eventProcessor = $this->eventProcessorFactory->create([
                 'client'                 => $this->getInsightsClient(),
                 'userToken'              => $this->getAnonymousUserToken(),
-                'authenticatedUserToken' => $this->getAuthenticatedUserToken(),
-                'storeManager'           => $this->storeManager
+                'authenticatedUserToken' => $this->getAuthenticatedUserToken()
             ]);
         }
         return $this->eventProcessor;

Model/Job.php

@@ -3,6 +3,12 @@
 namespace Algolia\AlgoliaSearch\Model;
 
 use Algolia\AlgoliaSearch\Api\Data\JobInterface;
+use Magento\Framework\Data\Collection\AbstractDb;
+use Magento\Framework\Exception\AlreadyExistsException;
+use Magento\Framework\Model\Context;
+use Magento\Framework\Model\ResourceModel\AbstractResource;
+use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Registry;
 
 /**
  * @api
@@ -26,46 +32,33 @@ class Job extends \Magento\Framework\Model\AbstractModel implements JobInterface
 {
     protected $_eventPrefix = 'algoliasearch_queue_job';
 
-    /** @var \Magento\Framework\ObjectManagerInterface */
-    protected $objectManager;
-
-    /**
-     * @param \Magento\Framework\Model\Context                        $context
-     * @param \Magento\Framework\Registry                             $registry
-     * @param \Magento\Framework\ObjectManagerInterface               $objectManager
-     * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
-     * @param \Magento\Framework\Data\Collection\AbstractDb           $resourceCollection
-     * @param array                                                   $data
-     */
     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,
-        array $data = []
+        Context                          $context,
+        Registry                         $registry,
+        protected ObjectManagerInterface $objectManager,
+        ?AbstractResource                $resource = null,
+        ?AbstractDb                      $resourceCollection = null,
+        array                            $data = []
     ) {
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
-
-        $this->objectManager = $objectManager;
     }
 
     /**
      * Magento Constructor
      *
      * @return void
      */
-    protected function _construct()
+    protected function _construct(): void
     {
-        $this->_init(\Algolia\AlgoliaSearch\Model\ResourceModel\Job::class);
+        $this->_init(ResourceModel\Job::class);
     }
 
     /**
-     * @throws \Magento\Framework\Exception\AlreadyExistsException
-     *
      * @return $this
+     * @throws AlreadyExistsException|\Exception
+     *
      */
-    public function execute()
+    public function execute(): Job
     {
         $model = $this->objectManager->get($this->getClass());
         $method = $this->getMethod();
@@ -83,7 +76,7 @@ public function execute()
     /**
      * @return $this
      */
-    public function prepare()
+    public function prepare(): Job
     {
         if ($this->getMergedIds() === null) {
             $this->setMergedIds([$this->getId()]);
@@ -94,8 +87,8 @@ public function prepare()
 
             $this->setDecodedData($decodedData);
 
-            if (isset($decodedData['store_id'])) {
-                $this->setStoreId($decodedData['store_id']);
+            if (isset($decodedData['storeId'])) {
+                $this->setStoreId($decodedData['storeId']);
             }
         }
 
@@ -108,7 +101,7 @@ public function prepare()
      *
      * @return bool
      */
-    public function canMerge(Job $job, $maxJobDataSize)
+    public function canMerge(Job $job, $maxJobDataSize): bool
     {
         if ($this->getClass() !== $job->getClass()) {
             return false;
@@ -124,44 +117,17 @@ public function canMerge(Job $job, $maxJobDataSize)
 
         $decodedData = $this->getDecodedData();
 
-        // @todo Remove legacy checks on 3.16.0
-        if ((!isset($decodedData['product_ids']) || count($decodedData['product_ids']) <= 0)
-            && (!isset($decodedData['category_ids']) || count($decodedData['category_ids']) < 0)
-            && (!isset($decodedData['entity_ids']) || count($decodedData['entity_ids']) < 0)
-            && (!isset($decodedData['page_ids']) || count($decodedData['page_ids']) < 0)) {
+        if (!isset($decodedData['entityIds']) || count($decodedData['entityIds']) <= 0) {
             return false;
         }
 
         $candidateDecodedData = $job->getDecodedData();
 
-        // @todo Remove legacy checks on 3.16.0
-        if ((!isset($candidateDecodedData['product_ids']) || count($candidateDecodedData['product_ids']) <= 0)
-            && (!isset($candidateDecodedData['category_ids']) || count($candidateDecodedData['category_ids']) < 0)
-            && (!isset($candidateDecodedData['entity_ids']) || count($candidateDecodedData['entity_ids']) < 0)
-            && (!isset($candidateDecodedData['page_ids']) || count($candidateDecodedData['page_ids']) < 0)) {
+        if (!isset($candidateDecodedData['entityIds']) || count($candidateDecodedData['entityIds']) <= 0) {
             return false;
         }
 
-        // @todo Remove on 3.16.0
-        if (isset($decodedData['product_ids'])
-            && count($decodedData['product_ids']) + count($candidateDecodedData['product_ids']) > $maxJobDataSize) {
-            return false;
-        }
-
-        // @todo Remove on 3.16.0
-        if (isset($decodedData['category_ids'])
-            && count($decodedData['category_ids']) + count($candidateDecodedData['category_ids']) > $maxJobDataSize) {
-            return false;
-        }
-
-        // @todo Remove on 3.16.0
-        if (isset($decodedData['page_ids'])
-            && count($decodedData['page_ids']) + count($candidateDecodedData['page_ids']) > $maxJobDataSize) {
-            return false;
-        }
-
-        if (isset($decodedData['entity_ids'])
-            && count($decodedData['entity_ids']) + count($candidateDecodedData['entity_ids']) > $maxJobDataSize) {
+        if (count($decodedData['entityIds']) + count($candidateDecodedData['entityIds']) > $maxJobDataSize) {
             return false;
         }
 
@@ -173,7 +139,7 @@ public function canMerge(Job $job, $maxJobDataSize)
      *
      * @return Job
      */
-    public function merge(Job $mergedJob)
+    public function merge(Job $mergedJob): Job
     {
         $mergedIds = $this->getMergedIds();
         array_push($mergedIds, $mergedJob->getId());
@@ -185,35 +151,13 @@ public function merge(Job $mergedJob)
 
         $dataSize = $this->getDataSize();
 
-        // @todo Remove useless code on 3.16.0
-        if (isset($decodedData['product_ids'])) {
-            $decodedData['product_ids'] = array_unique(array_merge(
-                $decodedData['product_ids'],
-                $mergedJobDecodedData['product_ids']
-            ));
-
-            $dataSize = count($decodedData['product_ids']);
-        } elseif (isset($decodedData['category_ids'])) {
-            $decodedData['category_ids'] = array_unique(array_merge(
-                $decodedData['category_ids'],
-                $mergedJobDecodedData['category_ids']
-            ));
-
-            $dataSize = count($decodedData['category_ids']);
-        } elseif (isset($decodedData['page_ids'])) {
-            $decodedData['page_ids'] = array_unique(array_merge(
-                $decodedData['page_ids'],
-                $mergedJobDecodedData['page_ids']
-            ));
-
-            $dataSize = count($decodedData['page_ids']);
-        } elseif (isset($decodedData['entity_ids'])) {
-            $decodedData['entity_ids'] = array_unique(array_merge(
-                $decodedData['entity_ids'],
-                $mergedJobDecodedData['entity_ids']
+        if (isset($decodedData['entityIds'])) {
+            $decodedData['entityIds'] = array_unique(array_merge(
+                $decodedData['entityIds'],
+                $mergedJobDecodedData['entityIds']
             ));
 
-            $dataSize = count($decodedData['entity_ids']);
+            $dataSize = count($decodedData['entityIds']);
         }
 
         $this->setDecodedData($decodedData);
@@ -225,7 +169,7 @@ public function merge(Job $mergedJob)
     /**
      * @return array
      */
-    public function getDefaultValues()
+    public function getDefaultValues(): array
     {
         $values = [];
 
@@ -235,7 +179,7 @@ public function getDefaultValues()
     /**
      * @return string
      */
-    public function getStatus()
+    public function getStatus(): string
     {
         $status = JobInterface::STATUS_PROCESSING;
 
@@ -253,11 +197,11 @@ public function getStatus()
     /**
      * @param \Exception $e
      *
-     * @throws \Magento\Framework\Exception\AlreadyExistsException
+     * @throws AlreadyExistsException
      *
      * @return Job
      */
-    public function saveError(\Exception $e)
+    public function saveError(\Exception $e): Job
     {
         $this->setErrorLog($e->getMessage());
         $this->getResource()->save($this);

Model/Product/Url.php

@@ -67,6 +67,7 @@ public function getUrl(Product $product, $params = [])
                     UrlRewrite::ENTITY_ID   => $product->getId(),
                     UrlRewrite::ENTITY_TYPE => ProductUrlRewriteGenerator::ENTITY_TYPE,
                     UrlRewrite::STORE_ID    => $storeId,
+                    UrlRewrite::REDIRECT_TYPE => 0,
                 ];
                 if ($categoryId) {
                     $filterData[UrlRewrite::METADATA]['category_id'] = $categoryId;