Creating a preference for category product indexer breaks setup:di:compile

[mbijnsdorp]

Summary

When you create a preference for the category product indexer, code compilation breaks. This is because of the definition of the category product indexer execute method: https://github.com/magento/magento2/blob/2.3.1/app/code/Magento/Catalog/Model/Indexer/Category/Product/Action/Full.php#L155:

public function execute(): self
{
    $this->createTables();
    $this->clearReplicaTables();
    $this->reindex();
    $this->switchTables();
    return $this;
}

Due to the preference, the generated interceptor (Magento already has a plugin defined for the execute method), returns the preferenced class instead of the the Magento indexer, which then doesn't match : self.

Preconditions (*)

1. Magento version: 2.3.1
2. PHP 7.2.12

Steps to reproduce (*)

1. Create a preference for \Magento\Catalog\Model\Indexer\Category\Product\Action\Full in a custom module
2. Run bin/magento setup:di:compile

Expected result (*)

1. Code is compiled

Actual result (*)

1. Fatal error: Declaration of Vendor\Module\Model\Indexer\Category\Product\Action\Full\Interceptor::execute(): Vendor\Module\Model\Indexer\Category\Product\Action\Full must be compatible with Magento\Catalog\Model\Indexer\Category\Product\Action\Full::execute(): Magento\Catalog\Model\Indexer\Category\Product\Action\Full in /var/www/html/generated/code/Vendor/Module/Model/Indexer/Category/Product/Action/Full/Interceptor.php on line 7

/**
 * {@inheritdoc}
 */
public function execute() : \Vendor\Module\Model\Indexer\Category\Product\Action\Full
{
    $pluginInfo = $this->pluginList->getNext($this->subjectType, 'execute');
    if (!$pluginInfo) {
        return parent::execute();
    } else {
        return $this->___callPlugins('execute', func_get_args(), $pluginInfo);
    }
}

[m2-assistant]

Hi @mbijnsdorp. 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.

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

• yes
• no

[orlangur]

Hi @mbijnsdorp, how is that different from #11905?

[mbijnsdorp]

Hi @orlangur, that issue only mentions Magento's code generation not being able to process self in general, which got fixed as the generated code resolves self to a class. However, the following scenario is not covered:

1. Class A contains a public method that returns self and this method has a plugin attached: public function execute(): self
2. Create a preference for class A, class B. This class doesn't extend the execute method.
3. The interceptor that Magento generates now results in public function execute(): B, which is not compatible with the self definition of class A.

[m2-assistant]

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

  Details

  - Add the comment @magento 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.

[magento-engcom-team]

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

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