ENGCOM-5543: Avoid reindexing inactive catalog rules #23859

Author: VladimirZaets

app/code/Magento/CatalogRule/Model/Rule.php

@@ -46,6 +46,7 @@
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @SuppressWarnings(PHPMD.ExcessivePublicCount)
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class Rule extends \Magento\Rule\Model\AbstractModel implements RuleInterface, IdentityInterface
 {
@@ -433,7 +434,7 @@ protected function _getWebsitesMap()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function validateData(DataObject $dataObject)
     {
@@ -582,12 +583,16 @@ protected function _invalidateCache()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      *
      * @return $this
      */
     public function afterSave()
     {
+        if (!$this->getIsActive()) {
+            return parent::afterSave();
+        }
+
         if ($this->isObjectNew() && !$this->_ruleProductProcessor->isIndexerScheduled()) {
             $productIds = $this->getMatchingProductIds();
             if (!empty($productIds) && is_array($productIds)) {
@@ -606,14 +611,19 @@ public function afterSave()
      */
     public function reindex()
     {
-        $productIds = $this->_productIds ? array_keys(array_filter($this->_productIds, function (array $data) {
-            return array_filter($data);
-        })) : [];
+        $productIds = $this->_productIds ? array_keys(
+            array_filter(
+                $this->_productIds,
+                function (array $data) {
+                    return array_filter($data);
+                }
+            )
+        ) : [];
         $this->_ruleProductProcessor->reindexList($productIds);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      *
      * @return $this
      */
@@ -643,6 +653,7 @@ public function isRuleBehaviorChanged()
 
     /**
      * Get array with data differences
+     *
      * @param array $array1
      * @param array $array2
      *
@@ -664,6 +675,8 @@ protected function dataDiff($array1, $array2)
     }
 
     /**
+     * Getter for conditions field set ID
+     *
      * @param string $formName
      * @return string
      */
@@ -672,82 +685,80 @@ public function getConditionsFieldSetId($formName = '')
         return $formName . 'rule_conditions_fieldset_' . $this->getId();
     }
 
-    //@codeCoverageIgnoreStart
-
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getRuleId()
     {
         return $this->getData(self::RULE_ID);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setRuleId($ruleId)
     {
         return $this->setData(self::RULE_ID, $ruleId);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getName()
     {
         return $this->getData(self::NAME);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setName($name)
     {
         return $this->setData(self::NAME, $name);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getDescription()
     {
         return $this->getData(self::DESCRIPTION);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setDescription($description)
     {
         return $this->setData(self::DESCRIPTION, $description);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getIsActive()
     {
         return $this->getData(self::IS_ACTIVE);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setIsActive($isActive)
     {
         return $this->setData(self::IS_ACTIVE, $isActive);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getRuleCondition()
     {
         return $this->getRuleConditionConverter()->arrayToDataModel($this->getConditions()->asArray());
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setRuleCondition($condition)
     {
@@ -758,70 +769,72 @@ public function setRuleCondition($condition)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getStopRulesProcessing()
     {
         return $this->getData(self::STOP_RULES_PROCESSING);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setStopRulesProcessing($isStopProcessing)
     {
         return $this->setData(self::STOP_RULES_PROCESSING, $isStopProcessing);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getSortOrder()
     {
         return $this->getData(self::SORT_ORDER);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setSortOrder($sortOrder)
     {
         return $this->setData(self::SORT_ORDER, $sortOrder);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getSimpleAction()
     {
         return $this->getData(self::SIMPLE_ACTION);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setSimpleAction($action)
     {
         return $this->setData(self::SIMPLE_ACTION, $action);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getDiscountAmount()
     {
         return $this->getData(self::DISCOUNT_AMOUNT);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function setDiscountAmount($amount)
     {
         return $this->setData(self::DISCOUNT_AMOUNT, $amount);
     }
 
     /**
+     * Get from date
+     *
      * @return string
      */
     public function getFromDate()
@@ -830,6 +843,8 @@ public function getFromDate()
     }
 
     /**
+     * Get to date
+     *
      * @return string
      */
     public function getToDate()
@@ -838,7 +853,7 @@ public function getToDate()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      *
      * @return \Magento\CatalogRule\Api\Data\RuleExtensionInterface|null
      */
@@ -848,7 +863,7 @@ public function getExtensionAttributes()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      *
      * @param \Magento\CatalogRule\Api\Data\RuleExtensionInterface $extensionAttributes
      * @return $this
@@ -859,6 +874,8 @@ public function setExtensionAttributes(RuleExtensionInterface $extensionAttribut
     }
 
     /**
+     * Getter for the rule condition converter
+     *
      * @return Data\Condition\Converter
      * @deprecated 100.1.0
      */
@@ -871,8 +888,6 @@ private function getRuleConditionConverter()
         return $this->ruleConditionConverter;
     }
 
-    //@codeCoverageIgnoreEnd
-
     /**
      * @inheritDoc
      */

app/code/Magento/CatalogRule/Test/Unit/Model/RuleTest.php

@@ -311,13 +311,27 @@ public function testAfterDelete()
     }
 
     /**
-     * Test after update action
+     * Test after update action for inactive rule
      *
      * @return void
      */
-    public function testAfterUpdate()
+    public function testAfterUpdateInactive()
     {
         $this->rule->isObjectNew(false);
+        $this->rule->setIsActive(0);
+        $this->_ruleProductProcessor->expects($this->never())->method('getIndexer');
+        $this->rule->afterSave();
+    }
+
+    /**
+     * Test after update action for active rule
+     *
+     * @return void
+     */
+    public function testAfterUpdateActive()
+    {
+        $this->rule->isObjectNew(false);
+        $this->rule->setIsActive(1);
         $indexer = $this->createMock(\Magento\Framework\Indexer\IndexerInterface::class);
         $indexer->expects($this->once())->method('invalidate');
         $this->_ruleProductProcessor->expects($this->once())->method('getIndexer')->will($this->returnValue($indexer));