IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists

[alongosz]

Caution

• Requires dependencies updating core extension point usage to be merged together

🎫 Issue	IBX-8138

Related PRs:

1. Follow-ups to ibexa/core:

   • [Tests] Refactored various unit tests to make them DRY #408
   • Extracted common code for Binary and Media field type #407
   • Extracted common base for TextBlock and TextLine field types #406
   • Extracted redundant TextLine and ISBN SearchField into a common base #422
   • Extracted abstract for redundant Host & URI text matchers #424
   • Refactored Float and Integer field types to use external validators #425

2. IBX-8138 rector changes for the other packages:

   • ibexa/activity-log#97
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists admin-ui#1294
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists automated-translation#14
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists behat#118
   • ibexa/calendar#59
   • ibexa/cdp#26
   • ibexa/checkout#189
   • ibexa/collaborative-edit#2
   • ibexa/connect#19
   • ibexa/connector-actito#12
   • ibexa/connector-dam#55
   • ibexa/connector-payum#17
   • ibexa/connector-unsplash#16
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists content-forms#71
   • ibexa/corporate-account#252
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists cron#18
   • ibexa/dashboard#131
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists design-engine#30
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists doctrine-schema#26
   • ibexa/fastly#32
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists fieldtype-matrix#49
   • ibexa/fieldtype-page#135
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists fieldtype-query#29
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists fieldtype-richtext#172
   • ibexa/form-builder#142
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists graphql#70
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists http-cache#51
   • ibexa/image-editor#95
   • ibexa/measurement#94
   • ibexa/migrations#396
   • ibexa/oauth2-client#29
   • ibexa/order-management#123
   • ibexa/page-builder#385
   • ibexa/payment#149
   • ibexa/personalization#354
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists post-install#80
   • ibexa/product-catalog#1170
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists rest#118
   • ibexa/scheduler#109
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists search#48
   • ibexa/segmentation#104
   • ibexa/shipping#79
   • ibexa/site-context#55
   • ibexa/site-factory#100
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists solr#73
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists standard-design#24
   • ibexa/storefront#172
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists system-info#56
   • ibexa/taxonomy#284
   • ibexa/test-fixtures#66
   • IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists user#85
   • ibexa/version-comparison#80
   • ibexa/visual-testing#48
   • ibexa/workflow#111

Description:

Applied rules from the Symfony 5 Rector set lists.

This is just one milestone on the way towards Symfony 6. Some Rectors address code quality. Not all deprecations are covered by the Symfony-provided Rectors. Additionally, not all deprecations are related to PHP code, which is out of scope for Rector. Moreover, some deprecations can be resolved via Symfony 6 Rectors, but only some can be applied without upgrading to Symfony 6.

This PR also includes necessary fixes to align changes with the PHPStan baseline and to address return type bugs.

The applied Rectors are as follows:

• SF 5.0 AddParamTypeDeclarationRector adding parameter types for chosen set of Symfony methods, if used by 1st party,

• SF 5.1 CommandConstantReturnCodeRector - e.g.: return self::SUCCESS instead of a literal int,

• SF 5.2 RenameMethodRector renaming calls to \Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken::getProviderKey to getFirewallName (however there's no rector for e.g. deprecated getCredentials method of the same class),

• SF 5.3 RenameMethodRector:

  • RequestStack::getMasterRequest() -> RequestStack::getMainRequest(),

• SF 5.3 RenameClassConstFetchRector:

  • HttpKernelInterface::MASTER_REQUEST -> HttpKernelInterface::MAIN_REQUEST,

• SF 5.3 RenameClassRector:

  • Symfony\Component\Security\Core\Exception\UsernameNotFoundException -> Symfony\Component\Security\Core\Exception\UserNotFoundException,

• SF 5.4 AddReturnTypeDeclarationRector - adding return type ?\Symfony\Component\DependencyInjection\Extension\ExtensionInterface for classes implementing \Symfony\Component\HttpKernel\Bundle\BundleInterface::getContainerExtension() method

• SF 6.0 AddReturnTypeDeclarationRector - adding return types added by Symfony in 6. It was mostly possible to do this on SF 5 for our extension points as those type didn't change, they were just hinted in PHPDoc. Still, required some manual fixes afterwards (see also a few points below - the ReturnTypeFrom*Rector remarks,

• general code quality rector sets:

  • MakeCommandLazyRector - replacing setName() and setDescription() with $defaultName and $defaultDescription properties in Commands. Note that this rule however is deprecated, to be replaced with attributes in SF 6.1. For now this is just a "dead middle step" as Symfony itself states in the deprecation message,
  • LiteralGetToRequestClassConstantRector replacing 'GET' with Request::GET constant,
  • ResponseStatusCodeRector replacing e.g. 302 with Response::HTTP_FOUND constant in relavant places,
  • ReturnTypeFrom*Rector and AddReturnTypeDeclarationBasedOnParentClassMethodRector - a set of rectors applying return types based on either inferred method body or parent declaration, if feasible - this one has been proved to be quite risky as the returned type didn't always strictly follow what it should return.

CI Status

I've spent quite some time trying to rectify code duplication issues. Sadly this is not doable fully in a reasonable time as the entire codebase contains copy-pasted code since 2012. Since the Rector touched many places, all of them pop up now as new code, which makes quality gate fail. I have a set of changes fixing some of those WET code parts, however the scope of this PR is too big. I'll make follow ups.

For QA:

No QA needed. Regression tests should be enough.

Regression run: ibexa/commerce#930

Documentation:

This is code refactoring without behavior change. No documentation changes needed.

[adamwojs]

Well done! 🚀

[sonarcloud]

Quality Gate failed

Failed conditions
3.1% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud