Core code quality issues may not be noticed by code quality auditing tools

[ericmorand]

Preconditions (*)

None. This issue applies to every Magento 2 release since its creation.
Magento 2.4-develop

Steps to reproduce (*)

Execute a global search of @SuppressWarnings in the packages located under the magento vendor.

Using PHPStorm to perform the search, I get 8462 (eight thousand four hundred and sixty two) occurences of @SuppressWarnings.

Expected result (*)

There should be zero occurence of @SuppressWarnings in the Core source code of Magento 2.

Actual result (*)

There are lots of @SuppressWarnings in the Core source code of Magento 2.

What does it mean?

It means that the Core maintainers are deliberately hiding potential code quality issues from the Core source code by using directives that make the code quality audit tools ignoring some issues.

For example, the Magento\Framework\View\Result\Page class alone is plagued by four potential quality code violations that would never be noticed by the code quality auditing tool:

 * @SuppressWarnings(PHPMD.TooManyFields)
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.DepthOfInheritance)
 * @SuppressWarnings(PHPMD.ExcessiveParameterList)

In other words: Magento 2 code quality may be a a fraud, and a deliberate one.

I'm not saying that it is. Magento 2 code quality may be absolutely perfect, but these directives that suppress code quality warnings cast a shadow of doubt over the honesty of the maintainers. Magento 2 Core maintainers should seriously consider removing all these @SuppressWarnings directives, run their code quality audit and publish the result. This is the only way to remove the doubts.

[m2-assistant]

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

Please, add a comment to assign the issue: @magento I am working on this

---

• 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, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[ericmorand]

It seems like @SupressWarnings is not the only code quality override that is present in Magento 2.

• @codingstandardsIgnoreFile is used 55 times.
• @codingstandardsIgnoreLine is used 24 times.

[ihor-sviziev]

Hi @ericmorand,
You're totally right! Unfortunately we have quite a lot of code that was written when coding standards weren't enforced by static tests and a lot of pieces of Magento 2 have to be improved. Unfortunately fixing all these parts together isn't really possible, each specific case should be revisited and fixed.

We're welcoming you to create Pull Requests that will fix such cases in order to fix this issue.

[m2-assistant]

Hi @engcom-Bravo. 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.