ENGCOM-1290: Catalog price rule save is too slow, ignore on demand reindex #14704

Author: Stanislav Idolov

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

@@ -6,10 +6,33 @@
 namespace Magento\CatalogRule\Model;
 
 use Magento\Catalog\Model\Product;
+use Magento\Catalog\Model\ProductFactory;
+use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
+use Magento\CatalogRule\Api\Data\RuleExtensionInterface;
 use Magento\CatalogRule\Api\Data\RuleInterface;
+use Magento\CatalogRule\Helper\Data;
+use Magento\CatalogRule\Model\Data\Condition\Converter;
+use Magento\CatalogRule\Model\Indexer\Rule\RuleProductProcessor;
+use Magento\CatalogRule\Model\ResourceModel\Rule as RuleResourceModel;
+use Magento\CatalogRule\Model\Rule\Action\CollectionFactory as RuleCollectionFactory;
+use Magento\CatalogRule\Model\Rule\Condition\CombineFactory;
+use Magento\Customer\Model\Session;
 use Magento\Framework\Api\AttributeValueFactory;
 use Magento\Framework\Api\ExtensionAttributesFactory;
+use Magento\Framework\App\Cache\TypeListInterface;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Data\Collection\AbstractDb;
+use Magento\Framework\Data\FormFactory;
+use Magento\Framework\DataObject;
 use Magento\Framework\DataObject\IdentityInterface;
+use Magento\Framework\Model\Context;
+use Magento\Framework\Model\ResourceModel\AbstractResource;
+use Magento\Framework\Model\ResourceModel\Iterator;
+use Magento\Framework\Registry;
+use Magento\Framework\Serialize\Serializer\Json;
+use Magento\Framework\Stdlib\DateTime;
+use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
+use Magento\Store\Model\StoreManagerInterface;
 
 /**
  * Catalog Rule data model
@@ -136,6 +159,11 @@ class Rule extends \Magento\Rule\Model\AbstractModel implements RuleInterface, I
      */
     protected $ruleConditionConverter;
 
+    /**
+     * @var RuleResourceModel
+     */
+    private $ruleResourceModel;
+
     /**
      * Rule constructor
      *
@@ -161,32 +189,33 @@ class Rule extends \Magento\Rule\Model\AbstractModel implements RuleInterface, I
      * @param ExtensionAttributesFactory|null $extensionFactory
      * @param AttributeValueFactory|null $customAttributeFactory
      * @param \Magento\Framework\Serialize\Serializer\Json $serializer
-     *
+     * @param \Magento\CatalogRule\Model\ResourceModel\RuleResourceModel|null $ruleResourceModel
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
-        \Magento\Framework\Model\Context $context,
-        \Magento\Framework\Registry $registry,
-        \Magento\Framework\Data\FormFactory $formFactory,
-        \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
-        \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory,
-        \Magento\Store\Model\StoreManagerInterface $storeManager,
-        \Magento\CatalogRule\Model\Rule\Condition\CombineFactory $combineFactory,
-        \Magento\CatalogRule\Model\Rule\Action\CollectionFactory $actionCollectionFactory,
-        \Magento\Catalog\Model\ProductFactory $productFactory,
-        \Magento\Framework\Model\ResourceModel\Iterator $resourceIterator,
-        \Magento\Customer\Model\Session $customerSession,
-        \Magento\CatalogRule\Helper\Data $catalogRuleData,
-        \Magento\Framework\App\Cache\TypeListInterface $cacheTypesList,
-        \Magento\Framework\Stdlib\DateTime $dateTime,
-        \Magento\CatalogRule\Model\Indexer\Rule\RuleProductProcessor $ruleProductProcessor,
-        \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
-        \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
+        Context $context,
+        Registry $registry,
+        FormFactory $formFactory,
+        TimezoneInterface $localeDate,
+        CollectionFactory $productCollectionFactory,
+        StoreManagerInterface $storeManager,
+        CombineFactory $combineFactory,
+        RuleCollectionFactory $actionCollectionFactory,
+        ProductFactory $productFactory,
+        Iterator $resourceIterator,
+        Session $customerSession,
+        Data $catalogRuleData,
+        TypeListInterface $cacheTypesList,
+        DateTime $dateTime,
+        RuleProductProcessor $ruleProductProcessor,
+        AbstractResource $resource = null,
+        AbstractDb $resourceCollection = null,
         array $relatedCacheTypes = [],
         array $data = [],
         ExtensionAttributesFactory $extensionFactory = null,
         AttributeValueFactory $customAttributeFactory = null,
-        \Magento\Framework\Serialize\Serializer\Json $serializer = null
+        Json $serializer = null,
+        RuleResourceModel $ruleResourceModel = null
     ) {
         $this->_productCollectionFactory = $productCollectionFactory;
         $this->_storeManager = $storeManager;
@@ -200,6 +229,7 @@ public function __construct(
         $this->_relatedCacheTypes = $relatedCacheTypes;
         $this->dateTime = $dateTime;
         $this->_ruleProductProcessor = $ruleProductProcessor;
+        $this->ruleResourceModel = $ruleResourceModel ?: ObjectManager::getInstance()->get(RuleResourceModel::class);
 
         parent::__construct(
             $context,
@@ -223,7 +253,7 @@ public function __construct(
     protected function _construct()
     {
         parent::_construct();
-        $this->_init(\Magento\CatalogRule\Model\ResourceModel\Rule::class);
+        $this->_init(RuleResourceModel::class);
         $this->setIdFieldName('rule_id');
     }
 
@@ -255,7 +285,7 @@ public function getActionsInstance()
     public function getCustomerGroupIds()
     {
         if (!$this->hasCustomerGroupIds()) {
-            $customerGroupIds = $this->_getResource()->getCustomerGroupIds($this->getId());
+            $customerGroupIds = $this->ruleResourceModel->getCustomerGroupIds($this->getId());
             $this->setData('customer_group_ids', (array)$customerGroupIds);
         }
         return $this->_getData('customer_group_ids');
@@ -269,7 +299,7 @@ public function getCustomerGroupIds()
     public function getNow()
     {
         if (!$this->_now) {
-            return (new \DateTime())->format(\Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT);
+            return (new \DateTime())->format(DateTime::DATETIME_PHP_FORMAT);
         }
         return $this->_now;
     }
@@ -363,7 +393,7 @@ protected function _getWebsitesMap()
     /**
      * {@inheritdoc}
      */
-    public function validateData(\Magento\Framework\DataObject $dataObject)
+    public function validateData(DataObject $dataObject)
     {
         $result = parent::validateData($dataObject);
         if ($result === true) {
@@ -470,7 +500,7 @@ public function calcProductPriceRule(Product $product, $price)
      */
     protected function _getRulesFromProduct($dateTs, $websiteId, $customerGroupId, $productId)
     {
-        return $this->_getResource()->getRulesFromProduct($dateTs, $websiteId, $customerGroupId, $productId);
+        return $this->ruleResourceModel->getRulesFromProduct($dateTs, $websiteId, $customerGroupId, $productId);
     }
 
     /**
@@ -516,10 +546,10 @@ protected function _invalidateCache()
      */
     public function afterSave()
     {
-        if ($this->isObjectNew()) {
-            $this->getMatchingProductIds();
-            if (!empty($this->_productIds) && is_array($this->_productIds)) {
-                $this->_getResource()->addCommitCallback([$this, 'reindex']);
+        if ($this->isObjectNew() && !$this->_ruleProductProcessor->isIndexerScheduled()) {
+            $productIds = $this->getMatchingProductIds();
+            if (!empty($productIds) && is_array($productIds)) {
+                $this->ruleResourceModel->addCommitCallback([$this, 'reindex']);
             }
         } else {
             $this->_ruleProductProcessor->getIndexer()->invalidate();
@@ -778,7 +808,7 @@ public function getExtensionAttributes()
      * @param \Magento\CatalogRule\Api\Data\RuleExtensionInterface $extensionAttributes
      * @return $this
      */
-    public function setExtensionAttributes(\Magento\CatalogRule\Api\Data\RuleExtensionInterface $extensionAttributes)
+    public function setExtensionAttributes(RuleExtensionInterface $extensionAttributes)
     {
         return $this->_setExtensionAttributes($extensionAttributes);
     }
@@ -790,8 +820,8 @@ public function setExtensionAttributes(\Magento\CatalogRule\Api\Data\RuleExtensi
     private function getRuleConditionConverter()
     {
         if (null === $this->ruleConditionConverter) {
-            $this->ruleConditionConverter = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(\Magento\CatalogRule\Model\Data\Condition\Converter::class);
+            $this->ruleConditionConverter = ObjectManager::getInstance()
+                ->get(Converter::class);
         }
         return $this->ruleConditionConverter;
     }

dev/tests/integration/testsuite/Magento/CatalogRule/Model/RuleTest.php

@@ -33,7 +33,7 @@ protected function setUp()
 
         $this->_object = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
             \Magento\CatalogRule\Model\Rule::class,
-            ['resource' => $resourceMock]
+            ['ruleResourceModel' => $resourceMock]
         );
     }