Merge pull request #4851 from vincentchalamon/chore/symfony-versions

Fix Symfony components compatibility to ^6.1 + migrate code to PHP 8.1 + clean code

Author: vincentchalamon

composer.json

@@ -12,23 +12,30 @@
             "homepage": "https://dunglas.fr"
         }
     ],
+    "repositories": [
+        {
+            "type": "git",
+            "url": "[email protected]:cdaguerre/contexts.git"
+        }
+    ],
     "require": {
         "php": ">=8.1",
         "doctrine/inflector": "^1.0 || ^2.0",
         "fig/link-util": "^1.0",
         "psr/cache": "^1.0 || ^2.0 || ^3.0",
         "psr/container": "^1.0 || ^2.0",
-        "symfony/http-foundation": "^4.4 || ^5.1 || ^6.0",
-        "symfony/http-kernel": "^4.4 || ^5.1 || ^6.0",
-        "symfony/property-access": "^3.4.19 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/property-info": "^3.4 || ^4.4 || ^5.2.1 || ^6.0",
-        "symfony/serializer": "^4.4 || ^5.1 || ^6.0",
-        "symfony/web-link": "^4.4 || ^5.1 || ^6.0",
+        "symfony/http-foundation": "^6.1",
+        "symfony/http-kernel": "^6.1",
+        "symfony/property-access": "^6.1",
+        "symfony/property-info": "^6.1",
+        "symfony/serializer": "^6.1",
+        "symfony/web-link": "^6.1",
         "willdurand/negotiation": "^2.0.3 || ^3.0"
     },
     "require-dev": {
         "behat/behat": "^3.1",
         "behat/mink": "^1.9@dev",
+        "behatch/contexts": "dev-patch-1",
         "doctrine/cache": "^1.11 || ^2.1",
         "doctrine/common": "^2.11 || ^3.0",
         "doctrine/data-fixtures": "^1.2.2",
@@ -54,37 +61,37 @@
         "psr/log": "^1.0 || ^2.0 || ^3.0",
         "ramsey/uuid": "^3.7 || ^4.0",
         "ramsey/uuid-doctrine": "^1.4",
-        "soyuka/contexts": "dev-main",
+        "rector/rector": "^0.13.9",
         "soyuka/stubs-mongodb": "^1.0",
-        "symfony/asset": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/browser-kit": "^4.4 || ^5.1 || ^6.0",
-        "symfony/cache": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/config": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/console": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/css-selector": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/debug": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/dependency-injection": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/doctrine-bridge": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/dom-crawler": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/event-dispatcher": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/expression-language": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/finder": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/form": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/framework-bundle": "^4.4 || ^5.1 || ^6.0",
-        "symfony/http-client": "^4.4 || ^5.1 || ^6.0",
-        "symfony/intl": "^4.4 || ^5.3 || ^6.0",
+        "symfony/asset": "^6.1",
+        "symfony/browser-kit": "^6.1",
+        "symfony/cache": "^6.1",
+        "symfony/config": "^6.1",
+        "symfony/console": "^6.1",
+        "symfony/css-selector": "^6.1",
+        "symfony/dependency-injection": "^6.1",
+        "symfony/doctrine-bridge": "^6.1",
+        "symfony/dom-crawler": "^6.1",
+        "symfony/error-handler": "^6.1",
+        "symfony/event-dispatcher": "^6.1",
+        "symfony/expression-language": "^6.1",
+        "symfony/finder": "^6.1",
+        "symfony/form": "^6.1",
+        "symfony/framework-bundle": "^6.1",
+        "symfony/http-client": "^6.1",
+        "symfony/intl": "^6.1",
         "symfony/maker-bundle": "^1.24",
         "symfony/mercure-bundle": "*",
-        "symfony/messenger": "^4.4 || ^5.1 || ^6.0",
-        "symfony/phpunit-bridge": "^5.4 || ^6.0",
-        "symfony/routing": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/security-bundle": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/security-core": "^4.4 || ^5.1 || ^6.0",
-        "symfony/twig-bundle": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/uid": "^5.1 || ^6.0",
-        "symfony/validator": "^3.4 || ^4.4 || ^5.1 || ^6.0",
-        "symfony/web-profiler-bundle": "^4.4 || ^5.1 || ^6.0",
-        "symfony/yaml": "^3.4 || ^4.4 || ^5.1 || ^6.0",
+        "symfony/messenger": "^6.1",
+        "symfony/phpunit-bridge": "^6.1",
+        "symfony/routing": "^6.1",
+        "symfony/security-bundle": "^6.1",
+        "symfony/security-core": "^6.1",
+        "symfony/twig-bundle": "^6.1",
+        "symfony/uid": "^6.1",
+        "symfony/validator": "^6.1",
+        "symfony/web-profiler-bundle": "^6.1",
+        "symfony/yaml": "^6.1",
         "twig/twig": "^1.42.3 || ^2.12 || ^3.0",
         "webonyx/graphql-php": "^14.0"
     },
@@ -138,7 +145,7 @@
             "dev-main": "3.0.x-dev"
         },
         "symfony": {
-            "require": "^3.4 || ^4.4 || ^5.1 || ^6.0"
+            "require": "^6.1"
         }
     }
 }

features/main/operation_resource.feature

@@ -26,7 +26,6 @@ Feature: Resource operations
     """
     {"name": "Patched"}
     """
-    Then print last JSON response
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"

phpstan.neon.dist

@@ -39,6 +39,11 @@ parameters:
 			- handleNotFound
 	ignoreErrors:
 		# False positives
+		-
+			message: '#but database expects#'
+			paths:
+				- tests/Fixtures/TestBundle/Entity/
+		- '#Cannot call method add\(\) on iterable.#'
 		-
 			message: '#is never read, only written.#'
 			paths:
@@ -49,14 +54,20 @@ parameters:
 			message: '#is never written, only read.#'
 			paths:
 				- tests/Fixtures/TestBundle/Document/
-				- tests/Fixtures/TestBundle/Entity/
+		-
+			message: '#Parameter \#1 \$constraint of method#'
+			paths:
+				- tests/Symfony/Validator/Metadata/Property/Restriction/
+		-
+			message: '#expects ApiPlatform\\Metadata\\GraphQl\\Operation\|null, ApiPlatform\\Metadata\\Operation given#'
+			paths:
+				- tests/GraphQl/Resolver/Factory/
 		- '#Access to an undefined property Prophecy\\Prophecy\\ObjectProphecy<(\\?[a-zA-Z0-9_]+)+>::\$[a-zA-Z0-9_]+#'
 		# https://github.com/willdurand/Negotiation/issues/89#issuecomment-513283286
 		-
 			message: '#Call to an undefined method Negotiation\\AcceptHeader::getType\(\)\.#'
 			path: src/Symfony/EventListener/AddFormatListener.php
 		- '#Parameter \#1 \$vars of class GraphQL\\Language\\AST\\(IntValue|ObjectField|ObjectValue|BooleanValue|ListValue|StringValue)Node constructor expects array<bool\|float\|GraphQL\\Language\\AST\\Location\|GraphQL\\Language\\AST\\NameNode\|GraphQL\\Language\\AST\\NodeList\|GraphQL\\Language\\AST\\SelectionSetNode\|int\|string\|null>, array<string, .+> given\.#'
-		- '#Parameter \#1 \$defaultContext of class Symfony\\Component\\Serializer\\Encoder\\Json(De|En)code constructor expects array, (int|true) given\.#'
 		-
 			message: '#Parameter \#1 \$objectValue of method GraphQL\\Type\\Definition\\InterfaceType::resolveType\(\) expects object, array(<string, string>)? given.#'
 			path: tests/GraphQl/Type/TypeBuilderTest.php
@@ -74,23 +85,10 @@ parameters:
 		-
 			message: "#Call to function method_exists\\(\\) with ApiPlatform\\\\JsonApi\\\\Serializer\\\\ItemNormalizer and 'setCircularReferenc…' will always evaluate to false\\.#"
 			path: tests/JsonApi/Serializer/ItemNormalizerTest.php
-		-
-			message: "#Dead catch - JsonException is never thrown in the try block.#"
-			path: src/Symfony/Bundle/Test/Response.php
 		# See https://github.com/phpstan/phpstan-symfony/issues/27
 		-
 			message: '#^Service "[^"]+" is private.$#'
 			path: src
 		-
 			message: '#^Property .+ is unused.$#'
 			path: tests/Doctrine/Odm/PropertyInfo/Fixtures/DoctrineDummy.php
-		-
-			message: '#Call to an undefined method Symfony\\Component\\PropertyInfo\\Type::getCollectionValueType\(\)#'
-			path: src
-		-
-			message: '#Call to an undefined method Symfony\\Component\\PropertyInfo\\Type::getCollectionKeyType\(\)#'
-			path: src
-		# Skipped tests, we do this on purpose
-		-
-			message: "#Access to an undefined static property static\\([^)]+\\)::\\$container.$#"
-			path: tests

rector.php

@@ -0,0 +1,69 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector;
+use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
+use Rector\Php81\Rector\Property\ReadOnlyPropertyRector;
+use Rector\PHPUnit\Rector\Class_\AddSeeTestAnnotationRector;
+use Rector\PHPUnit\Rector\MethodCall\AssertEqualsToSameRector;
+use Rector\PHPUnit\Set\PHPUnitSetList;
+use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Set\ValueObject\SetList;
+use Rector\TypeDeclaration\Rector\ClassMethod\ArrayShapeFromConstantArrayReturnRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ]);
+    $rectorConfig->skip([
+        __DIR__.'/tests/Fixtures/app/var',
+        AddSeeTestAnnotationRector::class,
+        ArrayShapeFromConstantArrayReturnRector::class,
+        NullToStrictStringFuncCallArgRector::class,
+        ReadOnlyPropertyRector::class => [
+            __DIR__.'/tests/Fixtures/TestBundle/Document',
+            __DIR__.'/tests/Fixtures/TestBundle/Entity',
+        ],
+        RemoveParentCallWithoutParentRector::class => [
+            __DIR__.'/tests/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaChoiceRestrictionTest.php',
+        ],
+        RenameMethodRector::class => [
+            __DIR__.'/tests/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaChoiceRestrictionTest.php',
+        ],
+        AssertEqualsToSameRector::class,
+    ]);
+    $rectorConfig->phpstanConfig(__DIR__.'/phpstan.neon.dist');
+    $rectorConfig->importNames();
+    $rectorConfig->importShortClasses(false);
+
+    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_81,
+        SetList::TYPE_DECLARATION_STRICT,
+    ]);
+
+    // PHPUnit
+    $rectorConfig->sets([
+        PHPUnitSetList::PHPUNIT_91,
+        PHPUnitSetList::PHPUNIT_CODE_QUALITY,
+        PHPUnitSetList::PHPUNIT_EXCEPTION,
+        PHPUnitSetList::REMOVE_MOCKS,
+        PHPUnitSetList::PHPUNIT_SPECIFIC_METHOD,
+        PHPUnitSetList::PHPUNIT_YIELD_DATA_PROVIDER,
+    ]);
+};

src/Action/EntrypointAction.php

@@ -23,11 +23,8 @@
  */
 final class EntrypointAction
 {
-    private $resourceNameCollectionFactory;
-
-    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory)
+    public function __construct(private readonly ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory)
     {
-        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
     }
 
     public function __invoke(): Entrypoint

src/Action/ExceptionAction.php

@@ -19,14 +19,13 @@
 use ApiPlatform\Util\ErrorFormatGuesser;
 use ApiPlatform\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\Util\RequestAttributesExtractor;
-use Symfony\Component\Debug\Exception\FlattenException as LegacyFlattenException;
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**
- * Renders a normalized exception for a given {@see FlattenException} or {@see LegacyFlattenException}.
+ * Renders a normalized exception for a given {@see FlattenException}.
  *
  * @author Baptiste Meyer <[email protected]>
  * @author Kévin Dunglas <[email protected]>
@@ -35,28 +34,19 @@ final class ExceptionAction
 {
     use OperationRequestInitiatorTrait;
 
-    private $serializer;
-    private $errorFormats;
-    private $exceptionToStatus;
-
     /**
      * @param array $errorFormats      A list of enabled error formats
      * @param array $exceptionToStatus A list of exceptions mapped to their HTTP status code
      */
-    public function __construct(SerializerInterface $serializer, array $errorFormats, array $exceptionToStatus = [], ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
+    public function __construct(private readonly SerializerInterface $serializer, private readonly array $errorFormats, private readonly array $exceptionToStatus = [], ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
     {
-        $this->serializer = $serializer;
-        $this->errorFormats = $errorFormats;
-        $this->exceptionToStatus = $exceptionToStatus;
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
     }
 
     /**
      * Converts an exception to a JSON response.
-     *
-     * @param FlattenException|LegacyFlattenException $exception
      */
-    public function __invoke($exception, Request $request): Response
+    public function __invoke(FlattenException $exception, Request $request): Response
     {
         $operation = $this->initializeOperation($request);
         $exceptionClass = $exception->getClass();

src/Api/Entrypoint.php

@@ -22,11 +22,8 @@
  */
 final class Entrypoint
 {
-    private $resourceNameCollection;
-
-    public function __construct(ResourceNameCollection $resourceNameCollection)
+    public function __construct(private readonly ResourceNameCollection $resourceNameCollection)
     {
-        $this->resourceNameCollection = $resourceNameCollection;
     }
 
     public function getResourceNameCollection(): ResourceNameCollection

src/Api/FilterLocatorTrait.php

@@ -25,7 +25,7 @@
  */
 trait FilterLocatorTrait
 {
-    private ?ContainerInterface $filterLocator;
+    private ?ContainerInterface $filterLocator = null;
 
     /**
      * Sets a filter locator with a backward compatibility.

src/Api/FormatMatcher.php

@@ -23,7 +23,7 @@ final class FormatMatcher
     /**
      * @var array<string, string[]>
      */
-    private $formats;
+    private readonly array $formats;
 
     /**
      * @param array<string, string[]|string> $formats

src/Api/IdentifiersExtractor.php

@@ -33,17 +33,12 @@
 final class IdentifiersExtractor implements IdentifiersExtractorInterface
 {
     use ResourceClassInfoTrait;
+    private readonly PropertyAccessorInterface $propertyAccessor;
 
-    private $propertyNameCollectionFactory;
-    private $propertyMetadataFactory;
-    private $propertyAccessor;
-
-    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, PropertyAccessorInterface $propertyAccessor = null)
+    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, PropertyAccessorInterface $propertyAccessor = null)
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->resourceClassResolver = $resourceClassResolver;
-        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
-        $this->propertyMetadataFactory = $propertyMetadataFactory;
         $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
     }
 
@@ -61,7 +56,7 @@ public function getIdentifiersFromItem($item, Operation $operation = null, array
         }
 
         $resourceClass = $this->getResourceClass($item, true);
-        $operation = $operation ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation(null, false, true);
+        $operation ??= $this->resourceMetadataFactory->create($resourceClass)->getOperation(null, false, true);
 
         if ($operation instanceof HttpOperation) {
             $links = $operation->getUriVariables();
@@ -70,7 +65,7 @@ public function getIdentifiersFromItem($item, Operation $operation = null, array
         }
 
         foreach ($links ?? [] as $link) {
-            if (1 < \count($link->getIdentifiers())) {
+            if (1 < (is_countable($link->getIdentifiers()) ? \count($link->getIdentifiers()) : 0)) {
                 $compositeIdentifiers = [];
                 foreach ($link->getIdentifiers() as $identifier) {
                     $compositeIdentifiers[$identifier] = $this->getIdentifierValue($item, $link->getFromClass() ?? $resourceClass, $identifier, $link->getParameterName());