Magento 2.3.0: getSize call on configurable collection leads to exception, if no product filters are applied

[jhruehl]

Preconditions (*)

1. Magento 2.3.0
2. NewRelic module enabled (and configured)
   (you can cheat around enabling the module, if set the newrelic enabled setting to true in the core_config_table and flush the cache afterwards)

Steps to reproduce (*)

1. Run magento_newrelicreporting_cron cron job

Expected result (*)

1. magento_newrelicreporting_cron cron job successful

Actual result (*)

1. magento_newrelicreporting_cron throws error "Warning: Invalid argument supplied for foreach() in /var/www/shop_test/src/www/vendor/magento/module-configurable-product/Model/ResourceModel/Product/Type/Configurable/Product/Collection.php on line 83"

Explanation

The newrelic cron tries to get the amount of configurable products (or at least the given children) calling the getCount function of the ConfigurableProductManagementInterface.
In this process a configurable collection object is created (magento/module-configurable-product/Model/ResourceModel/Product/Type/Configurable/Product/Collection.php).
There the getSize function (in AbstractDB parent class) is called and as a consequence the _renderFilters function in the magento/module-configurable-product/Model/ResourceModel/Product/Type/Configurable/Product/Collection.php class.

Since 2.3.0 the product filter functionality seems to have been partly moved there with the probable intention to enable several product filters to be applicable at the same time.

Here the _renderFilters() function code:

protected function _renderFilters()
    {
        parent::_renderFilters();
        $metadata = $this->getProductEntityMetadata();
        $parentIds = [];
        foreach ($this->products as $product) {
            $parentIds[] = $product->getData($metadata->getLinkField());
        }

        $this->getSelect()->where('link_table.parent_id in (?)', $parentIds);

        return $this;
    }

The cause of the problem should be quite clear, if you look at the code. If no product filter is applied to the configurable product collection $this-products is null, but without any checks it is used in the given foreach-loop.

Proposed fix:

protected function _renderFilters()
    {
        parent::_renderFilters();
        if ($this->products) {
            $metadata = $this->getProductEntityMetadata();
            $parentIds = [];
            foreach ($this->products as $product) {
                $parentIds[] = $product->getData($metadata->getLinkField());
            }
            $this->getSelect()->where('link_table.parent_id in (?)', $parentIds);
        }
        return $this;
    }

A simple and reasonable if-clause does the trick without touching the changed (or "enhanced") product filter functionality.

[m2-assistant]

Hi @jhruehl. 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-engcom-team give me 2.3-develop instance - upcoming 2.3.x release

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

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

• yes
• no

[jhruehl]

Sadly the insert-code functionality here doesn't do what I wanted or does strange stuff, but I think it should be still clear.

[jhruehl]

Sorry. Don't have the time to reproduce in vanilla, but a developer, who looks at the currently given code, should see the problem with it anyway. Basically it is impossible to reproduce in vanilla, if no newrelic account is set up for it, except cheating around the enabling by manipulating the enabled-value in the core_config_table.

[orlangur]

@jhruehl this is just a bot :) Could you create a PR via GitHub UI maybe? Fix seems to be pretty trivial.

[jhruehl]

Sadly gitHub doesn't create my patch-branch despite stating so on the pull request creation (or giving me the option). So comitting it fails due to a non existing patch branch, which should be created automatically beforehand.

[m2-assistant]

Hi @shikhamis11. 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-engcom-team 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. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

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

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