Catalog Rule Product index time increases exponentially as new rules are added

[rossmitchell]

Preconditions (*)

1. Magento 2.3.3

Steps to reproduce (*)

1. Install Magento
2. Copy setup/performance-toolkit/profiles/ce/small.xml to a new file
3. Update the file to have 2000 simple products and 2000 categories
4. Generate fixtures using the file
5. Run the Catalog Rule Product index php bin/magento indexer:reindex catalogrule_rule
6. Repeat steps 1 - 5 increasing the number of rules from 20 to 100, 500, 1,000, 5,000, 10,000, and 25,000

Expected result (*)

1. The index time should increase in a roughly linear manner as the number of rules increases

Actual result (*)

1. The index takes longer and longer to complete as the number of rules increase

# With 20 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:00:01
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:11

# With 100 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:00:02
Product Price index has been rebuilt successfully in 00:00:01
Catalog Search index has been rebuilt successfully in 00:00:12

# With 500 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:00:13
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:11

# With 1,000 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:00:28
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:11

# With 5,000 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:03:11
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:11

# With 10,000 catalog price rules
$php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:11:19
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:11

# With 25,000 catalog price rules
$php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 01:06:46
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:12

Explanation

The rules are generated using the \Magento\CatalogRule\Model\Indexer\IndexBuilder::doReindexFull function which fetches a RuleCollection and then calls foreach on it.

This triggers the getIterator method on the Collection which loads everything before passing the collection to an ArrayIterator. As the size of the collection increases this step takes more and more time before any of the processing can be started

Proposed Solution

Replacing the foreach loop with a while loop like so

    protected function doReindexFull()
    {
        $collection = $this->getAllRules();
        while ($rule = $collection->fetchItem()) {
            $this->reindexRuleProduct->execute($rule, $this->batchCount, true);
        }
        /* Rest of function unchanged */
    }

This means that each rule gets loaded individually, which cuts the time needed to index significantly when there are a large number of rules, without impacting the time when there are a small number.

Re-indexing times with the change in place

# With 20 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:00:01
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:11

# With 5,000 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:00:23
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:11

# With 25,000 catalog price rules
$ php bin/magento indexer:reindex catalogrule_rule
Catalog Rule Product index has been rebuilt successfully in 00:03:58
Product Price index has been rebuilt successfully in 00:00:02
Catalog Search index has been rebuilt successfully in 00:00:12

[m2-assistant]

Hi @rossmitchell. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

For more details, please, review the Magento Contributor Assistant documentation.

@rossmitchell do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[m2-assistant]

Hi @engcom-Echo. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Echo]

Hello @rossmitchell

Thank you for your report and collaboration!
Could you please submit pull request?

Thank you!

[magento-engcom-team]

✅ Confirmed by @engcom-Echo
Thank you for verifying the issue. Based on the provided information internal tickets MC-29386 were created

Issue Available: @engcom-Echo, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.