Use class name as type hint instead of self.

[dcabrejas]

Description (*)

Use class name as type hint instead of self. self breaks code generator when a preference is defined.

Fixed Issues (if relevant)

1. Creating a preference for category product indexer breaks setup:di:compile #22769: "Creating a preference for category product indexer breaks setup:di:compile"

Manual testing scenarios (*)

1. Create a preference for \Magento\Catalog\Model\Indexer\Category\Product\Action\Full in a custom module
2. Run bin/magento setup:di:compile
3. There is no PHP fatal error anymore.

Questions or comments

I am going to try and work out a solution to the real problem here which should allow us to still use the self keyword and use preferences/code generation at the same time. That would be in a different PR though.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @dcabrejas. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.3-develop instance - deploy vanilla Magento instance

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

[magento-engcom-team]

Hi @aleron75, thank you for the review.
ENGCOM-5309 has been created to process this Pull Request
✳️ @aleron75, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[magento-engcom-team]

@dcabrejas thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

[orlangur]

This class is perfectly valid, interception mechanism must be fixed instead.

[dcabrejas]

Hi @orlangur

Please see my comment on the PR description about this being just a fix to the issue users have reported. While I agree more thought is required to provide a generic fix that allows code to typehint self as a return parameter. I believe that can be done as a separate PR.

[orlangur]

@dcabrejas sure.

That would be in a different PR though.

Please work on such PR and this change is not needed actually.

[m2-assistant]

Hi @dcabrejas, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

[dcabrejas]

Hi @sivaschenko

What is your opinion about this? We discussed this at meet Magento and it was decided this should be fixed in this way.

[orlangur]

Similar poor attempt of "fix" was performed in #21775 (comment).

Again: indexer code MUST NOT be changed, interception mechanism is what actually needs to be fixed.

[DrewML]

Technical disagreements are fine, but suggesting that another contributor's work is a waste of time is completely out of line.

[orlangur]

@DrewML, sorry, I wasn't specific enough and my English may sound not how it was intended to sound to native speaker. I just tried to guide contributor in a right direction to avoid waste of efforts by doing a temporary fix, then a proper one, then reverting initial unneeded change. This can be even a bigger trouble if release occur between such connected pull requests. #23300 (comment) is a good example where we faced with similar changes and elaborated a more universal fix.

I do appreciate every contributor work and trying to help to not waste contributor efforts on changes which could be avoided, this is what I meant by "our wasted time" - we are all on the same boat, there is no distinction between contributors, maintainers or even EngCom team members on this aspect.

Thanks for pointing out, I'll take an additional look into Code of Conduct and do my best to avoid such situations in the future.

@dcabrejas sorry that I didn't pick the right words to convey my point and could decrease your enjoyment of contributing to Magento Open Source. I'm taking part in the Magento Contribution Day today and will reach out to @sivaschenko directly.

[sivaschenko]

@orlangur we have discussed this issue with @dcabrejas at the Meet Magento UK contribution day. As there is no proved solution for generator fix, and such fix may require a substantial amount of time to implement and tests, we decided to apply a local fix to this file and postpone the generator fix.

In case a pull request will be created, tested and delivered within the current release with the fix described in #23300 (comment) - that solution looks more preferable for me.

[orlangur]

@sivaschenko thanks, seems we are on the same page taking into consideration there is a bunch of time till 2.3.3 contributions freeze. I'll try the patch in action.

[magento-engcom-team]

Hi @sidolov, thank you for the review.
ENGCOM-5624 has been created to process this Pull Request
✳️ @sidolov, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[YevSent]

As @orlangur mentioned, the fix should be on the code generation level (internal ticket MC-17251) but should not change Magento\Catalog\Model\Indexer\Category\Product\Action\Full as it's a valid class.

Another note, preferences should not be used for classes, only for interfaces.

[m2-assistant]

Hi @dcabrejas, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.