Plugins in \Magento\Framework namespace

[lbajsarowicz]

Preconditions (*)

One of Magento Architects contacted me in private message blaming me for introducing Plugin to the Core that is not allowed in Magento and couldn't have been done by Magento Employees due to Quality Standards.

magento2/lib/internal/Magento/Framework/App/Action/Plugin/Design.php

Lines 6 to 10 in 5f3b86a

	namespace Magento\Framework\App\Action\Plugin;
	use Magento\Framework\Message\MessageInterface;
	class Design

lol.

As I've introduced another 2 plugins and renamed existing one to follow the naming convention, there are 3 plugins in the \Magento\Framework namespace. As the architect wasn't so nice to tell me where outside \Magento\Framework` I should put these plugins, I create issue to satisfy "Quality Standards" of Magento.

The plugins to be moved:
https://github.com/magento/magento2/tree/2.4-develop/lib/internal/Magento/Framework/App/Action/Plugin

Before you continue, please remember that plugins in \Magento\Framework were never allowed!

🤦 🤦‍♂️ 🤦‍♀️ 🤦 🤦‍♂️ 🤦‍♀️ 🤦 🤦‍♂️ 🤦‍♀️ 🤦 🤦‍♂️ 🤦‍♀️

magento2/lib/internal/Magento/Framework/Module/Plugin/DbStatusValidator.php

Lines 6 to 18 in 5f3b86a

	namespace Magento\Framework\Module\Plugin;
	use Magento\Framework\Cache\FrontendInterface as FrontendCacheInterface;
	use Magento\Framework\Module\DbVersionInfo;
	use Magento\Framework\App\FrontController;
	use Magento\Framework\App\RequestInterface;
	use Magento\Framework\Exception\LocalizedException;
	use Magento\Framework\Phrase;
	/**
	* Validation of DB up to date state
	*/
	class DbStatusValidator

magento2/app/etc/di.xml

Lines 1805 to 1807 in 892dee4

	<type name="Magento\Framework\DB\Adapter\AdapterInterface">
	<plugin name="execute_commit_callbacks" type="Magento\Framework\Model\ExecuteCommitCallbacks" />
	</type>

https://github.com/magento/partners-magento2ee/blob/6d49dacca99f5276f09bbddd50866440f3d3fccc/app/code/Magento/ScalableCheckout/etc/di.xml#L34-L36

magento2/app/code/Magento/Amqp/etc/di.xml

Lines 9 to 17 in ae99625

	<type name="Magento\Framework\MessageQueue\Consumer\Config\CompositeReader">
	<plugin name="queueConfigPlugin" type="Magento\Framework\MessageQueue\Config\Consumer\ConfigReaderPlugin" />
	</type>
	<type name="Magento\Framework\MessageQueue\Publisher\Config\CompositeReader">
	<plugin name="queueConfigPlugin" type="Magento\Framework\MessageQueue\Config\Publisher\ConfigReaderPlugin" />
	</type>
	<type name="Magento\Framework\MessageQueue\Topology\Config\CompositeReader">
	<plugin name="queueConfigPlugin" type="Magento\Framework\MessageQueue\Config\Topology\ConfigReaderPlugin" />
	</type>

magento2/app/code/Magento/Eav/etc/di.xml

Lines 108 to 110 in 4b66b00

	<type name="Magento\Eav\Model\Entity\AbstractEntity">
	<plugin name="clean_cache" type="Magento\Framework\App\Cache\FlushCacheByTags" />
	</type>

magento2/app/code/Magento/Store/etc/di.xml

Lines 36 to 38 in d938e7b

	<type name="Magento\Framework\App\Response\Http">
	<plugin name="genericHeaderPlugin" type="Magento\Framework\App\Response\HeaderManager"/>
	</type>

Steps to reproduce (*)

N/A

Expected result (*)

Magento Framework shouldn't contain any plugins

Actual result (*)

1. Magento Framework contains plugins, that should be misplaced in different modules, see description

[m2-assistant]

Hi @lbajsarowicz. 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.4-develop instance - upcoming 2.4.x release

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

@lbajsarowicz 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 @ihor-sviziev. 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.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.

[magento-engcom-team]

@ihor-sviziev Thank you for verifying the issue.

Unfortunately, not enough information was provided to acknowledge ticket. Please consider adding the following:

• Add "Reproduced on " label(s) to this ticket based on verification result

Once all required information is added, please add label "Issue: Confirmed" again.
Thanks!

[magento-engcom-team]

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

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

[m2-assistant]

Hi @maghamed. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if you want to validate it one more time, please, go though the following instruction:

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

• 2. 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!

• 3. If the issue is not relevant or is not reproducible any more, feel free to close it.

---

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

[lbajsarowicz]

Fixed the ActionInterface plugins. If you @maghamed care about the other plugins - assign it internally, otherwise close the ticket.

[magento-engcom-team]

Hi @lbajsarowicz. Thank you for your report.
The issue has been fixed in #27965 by @lbajsarowicz in 2.4-develop branch
Related commit(s):

• d938e7bcab3f4620d5d0facb23a05ab81304e988
• ae58f560edad58b8c9b6fd01f9460b7c37fd2895
• 02aae13792fc648c00f6f8e153e208dc0d00c67d
• a84633e0b01bb2778418274d97d22758f534b008
• 7ff60630b48733141b471bc5c9eeb5c8412fc7b5

The fix will be available with the upcoming 2.4.1 release.

[DmitryFurs]

I also found 2 plugins in the commerce edition, and they are exactly the same

vendor/magento/module-scalable-checkout/etc/di.xml

<type name="Magento\Framework\Model\ResourceModel\Db\ObjectRelationProcessor">
    <plugin name="object_constraints_resolver" type="Magento\Framework\ForeignKey\ObjectRelationProcessor\Plugin" />
</type>

vendor/magento/module-scalable-oms/etc/di.xml

<type name="Magento\Framework\Model\ResourceModel\Db\ObjectRelationProcessor">
    <plugin name="object_constraints_resolver" type="Magento\Framework\ForeignKey\ObjectRelationProcessor\Plugin" />
</type>

[ihor-sviziev]

@DmitryFurs feel free to fill the separate issue in corresponding repository and / or create Pull Request

[DmitryFurs]

@ihor-sviziev this applies to commerce edition. Is this the right place to create a issue?

[ihor-sviziev]

@sidolov @gabrieldagama could you help with reporting issue to Commerce version?

[lbajsarowicz]

@DmitryFurs As long as you are Magento partner, you are able to access:

• https://github.com/magento/partners-magento2ee
• https://github.com/magento/partners-magento2b2b

If you don't have access, working with Magento partner, please reach out to @magento/community-engineering-team