Merge branch '2.5' into patch/dto-output-class-same-as-original

Author: silverbackdan

.github/workflows/ci.yml

@@ -2008,7 +2008,7 @@ jobs:
       fail-fast: false
     timeout-minutes: 20
     env:
-      SYMFONY_DEPRECATIONS_HELPER: max[total]=5 # 5 deprecation notices from FOSUserBundle
+      SYMFONY_DEPRECATIONS_HELPER: max[total]=5
     steps:
       - name: Checkout
         uses: actions/checkout@v1

CHANGELOG.md

@@ -1,29 +1,30 @@
 # Changelog
 
 ## 2.5.x-dev
+
 * JSON Schema: Missing LD context from Data Transformers #3479
 
 ## 2.5.5
 
-* GraphQL: Do not allow empty cursor values on `before` or `after`
-* Filter: Improve the RangeFilter query in case the values are equals using the between operator
-* Pagination: Fix bug with large values, 
+* Filter: Improve the RangeFilter query in case the values are equals using the between operator #3488
+* Pagination: Fix bug with large values #3451
 * Doctrine: use the correct type within `setParameter` of the SearchFilter #3331
-* Allow \Traversable resources #3463
+* Allow `\Traversable` resources #3463
 * Hydra: `hydra:writable` => `hydra:writeable` #3481
 * Hydra: Show `hydra:next` only when it's available #3457
-* DX: Improve contributing by adding a stub package for ext-mongodb #3431
-* Swagger: Missing default context argument #3443
-* Swagger: Fix API docs path in swagger ui #3475
+* Swagger UI: Missing default context argument #3443
+* Swagger UI: Fix API docs path in swagger ui #3475
 * OpenAPI: Export with unescaped slashes #3368
 * OpenAPI: OAuth flows fix #3333
 * JSON Schema: Fix metadata options #3425
 * JSON Schema: Allow decoration #3417
 * JSON Schema: Add DateInterval type #3351
 * JSON Schema: Correct schema generation for many types #3402
-* Validation: Use our `ValidationException` instead of symfony's #3414
+* Validation: Use API Platform's `ValidationException` instead of Symfony's #3414
+* Validation: Fix a bug preventing to serialize validator's payload #3375
 * Subresources: Improve queries when there's only one level #3396
 * HTTP: Location header is only set on POST with a 201 or between 300 and 400 #3497
+* GraphQL: Do not allow empty cursor values on `before` or `after` #3360
 
 ## 2.5.4
 

composer.json

@@ -42,7 +42,7 @@
         "doctrine/mongodb-odm-bundle": "^4.0",
         "doctrine/orm": "^2.6.4",
         "elasticsearch/elasticsearch": "^6.0",
-        "friendsofsymfony/user-bundle": "^2.2@dev",
+        "friendsofsymfony/user-bundle": "2.2.x-dev#157b53bd7d6c347148a90e723981a43f9c897bf5",
         "guzzlehttp/guzzle": "^6.0",
         "jangregor/phpstan-prophecy": "^0.6",
         "justinrainbow/json-schema": "^5.2.1",
@@ -97,7 +97,6 @@
     "suggest": {
         "doctrine/mongodb-odm-bundle": "To support MongoDB. Only versions 4.0 and later are supported.",
         "elasticsearch/elasticsearch": "To support Elasticsearch.",
-        "friendsofsymfony/user-bundle": "To use the FOSUserBundle bridge.",
         "guzzlehttp/guzzle": "To use the HTTP cache invalidation system.",
         "phpdocumentor/reflection-docblock": "To support extracting metadata from PHPDoc.",
         "psr/cache-implementation": "To use metadata caching.",

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -94,7 +94,7 @@ public function getConfigTreeBuilder()
                 ->arrayNode('validator')
                     ->addDefaultsIfNotSet()
                     ->children()
-                        ->variableNode('serialize_payload_fields')->defaultValue([])->info('Enable the serialization of payload fields when a validation error is thrown.')->end()
+                        ->variableNode('serialize_payload_fields')->defaultValue([])->info('Set to null to serialize all payload fields when a validation error is thrown, or set the fields you want to include explicitly.')->end()
                     ->end()
                 ->end()
                 ->arrayNode('eager_loading')

src/Serializer/AbstractConstraintViolationListNormalizer.php

@@ -35,7 +35,7 @@ abstract class AbstractConstraintViolationListNormalizer implements NormalizerIn
     public function __construct(array $serializePayloadFields = null, NameConverterInterface $nameConverter = null)
     {
         $this->nameConverter = $nameConverter;
-        $this->serializePayloadFields = $serializePayloadFields;
+        $this->serializePayloadFields = null === $serializePayloadFields ? null : array_flip($serializePayloadFields);
     }
 
     /**
@@ -66,10 +66,14 @@ protected function getMessagesAndViolations(ConstraintViolationListInterface $co
             ];
 
             $constraint = $violation->getConstraint();
-            if ($this->serializePayloadFields && $constraint && $constraint->payload) {
+            if (
+                [] !== $this->serializePayloadFields &&
+                $constraint &&
+                $constraint->payload &&
                 // If some fields are whitelisted, only them are added
-                $payloadFields = null === $this->serializePayloadFields ? $constraint->payload : array_intersect_key($constraint->payload, array_flip($this->serializePayloadFields));
-                $payloadFields && $violationData['payload'] = $payloadFields;
+                $payloadFields = null === $this->serializePayloadFields ? $constraint->payload : array_intersect_key($constraint->payload, $this->serializePayloadFields)
+            ) {
+                $violationData['payload'] = $payloadFields;
             }
 
             $violations[] = $violationData;

tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -289,7 +289,7 @@ public function invalidHttpStatusCodeValueProvider()
     public function testExceptionToStatusConfigWithInvalidHttpStatusCodeValue($invalidHttpStatusCodeValue)
     {
         $this->expectException(InvalidTypeException::class);
-        $this->expectExceptionMessageRegExp('/Invalid type for path "api_platform\\.exception_to_status\\.Exception". Expected int, but got .+\\./');
+        $this->expectExceptionMessageRegExp('/Invalid type for path "api_platform\\.exception_to_status\\.Exception". Expected "?int"?, but got .+\\./');
 
         $this->processor->processConfiguration($this->configuration, [
             'api_platform' => [

tests/Hydra/Serializer/ConstraintViolationNormalizerTest.php

@@ -40,7 +40,10 @@ public function testSupportNormalization()
         $this->assertTrue($normalizer->hasCacheableSupportsMethod());
     }
 
-    public function testNormalize()
+    /**
+     * @dataProvider payloadFieldsProvider
+     */
+    public function testNormalize(?array $fields, array $result)
     {
         $urlGeneratorProphecy = $this->prophesize(UrlGeneratorInterface::class);
         $nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
@@ -50,7 +53,7 @@ public function testNormalize()
             return '_'.$args[0];
         });
 
-        $normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), ['severity', 'anotherField1'], $nameConverterProphecy->reveal());
+        $normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), $fields, $nameConverterProphecy->reveal());
 
         // Note : we use NotNull constraint and not Constraint class because Constraint is abstract
         $constraint = new NotNull();
@@ -70,16 +73,24 @@ public function testNormalize()
                 [
                     'propertyPath' => '_d',
                     'message' => 'a',
-                    'payload' => [
-                        'severity' => 'warning',
-                    ],
                 ],
                 [
                     'propertyPath' => '_4',
                     'message' => '1',
                 ],
             ],
         ];
+        if ([] !== $result) {
+            $expected['violations'][0]['payload'] = $result;
+        }
+
         $this->assertEquals($expected, $normalizer->normalize($list));
     }
+
+    public function payloadFieldsProvider(): iterable
+    {
+        yield [['severity', 'anotherField1'], ['severity' => 'warning']];
+        yield [null, ['severity' => 'warning', 'anotherField2' => 'aValue']];
+        yield [[], []];
+    }
 }