Backward compatibility has been lost on Magento\Catalog\Model\ProductRepository class

[davidmolinacano]

Summary

I've a module that have a ProductRepository class which extends from the core Magento\Catalog\Model\ProductRepository class. We were calling the parent::__construct passing the Magento\Catalog\Controller\Adminhtml\Product\Initialization\Helper class which was required before Magento 2.4.7 as the 2nd parameter of the constructor, but now it has been removed and the second parameter must be Magento\Catalog\Api\Data\ProductSearchResultsInterfaceFactory class instead, thus losing the backward compatibility.

Examples

(Tested on Magento 2.4.3 after having removed the initialization helper from the parent::__construct)

Proposed solution

My proposal is to restore the Magento\Catalog\Controller\Adminhtml\Product\Initialization\Helper class as the second parameter. Although it's unused as you stated on the changelog, in my opinion it's required to guarantee the backward compatibility.

This bug can be reproduced by installing our module (version 0.13.13) on a Magento 2.4.7 and then executing a bin/magento setup:di:compile

Release note

Release Line: 2.4.7

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @davidmolinacano. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

• @magento give me 2.4-develop instance - upcoming 2.4.x release
• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[hostep]

Issue was caused by #37868, which actually fixed a bug by removing the dependency. Not sure if it will be easy to keep this fix and not break backwards compatibility.
The class is also not marked with @api, which means BC can be broken (even though we should really try to avoid it as much as we can)

Just my 2 cents, others are free to give their own opinions though 🙂

[davidmolinacano]

Thank you very much for the explanation @hostep ! Unfortunately, if this fix cannot be reverted we would need a proper solution for our specific case, because we must keep BC in our module since most of our customers are still using versions lower than 2.4.7, but a few of them are currently using the 2.4.7 too. If someone has any proposal about this issue, I'll be glad to hear it (well, in this case to read it).

[hostep]

So doofinder/doofinder-magento2@f9da4d2 is not fixing it?

We did use a solution like this in the past to be compatible with various magento versions with constructors that don't take the same amount of arguments: #30684 (comment)
It's a bit ugly, but it works and doesn't cause issues.

[davidmolinacano]

Unfortunately it didn't work as expected. Even with this fix, the setup:di:compile was still complaining about this. But thank you very much for pointing it, just in case.

[m2-assistant]

Hi @engcom-Hotel. 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).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.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-Hotel]

Hello @davidmolinacano,

Thanks for the report and collaboration!

By looking into the codebase we are confirming this issue. The changes are Backward incompatible.

Thanks