fix(metadata): parameter cast to array flag (#7160)

Author: soyuka

src/Metadata/Parameter.php

@@ -50,6 +50,7 @@ public function __construct(
         protected ?array $extraProperties = [],
         protected array|string|null $filterContext = null,
         protected ?Type $nativeType = null,
+        protected ?bool $castToArray = null,
     ) {
     }
 
@@ -312,4 +313,17 @@ public function withNativeType(Type $nativeType): self
 
         return $self;
     }
+
+    public function getCastToArray(): ?bool
+    {
+        return $this->castToArray;
+    }
+
+    public function withCastToArray(bool $castToArray): self
+    {
+        $self = clone $this;
+        $self->castToArray = $castToArray;
+
+        return $self;
+    }
 }

src/State/Util/ParameterParserTrait.php

@@ -92,9 +92,11 @@ private function extractParameterValues(Parameter $parameter, array $values): st
             }
         }
 
-        if ($isCollection) {
-            $value = \is_array($value) ? $value : [$value];
-        } elseif ($parameter instanceof HeaderParameter && \is_array($value) && array_is_list($value) && 1 === \count($value)) {
+        if ($isCollection && true === $parameter->getCastToArray() && !\is_array($value)) {
+            $value = [$value];
+        }
+
+        if (!$isCollection && $parameter instanceof HeaderParameter && \is_array($value) && array_is_list($value) && 1 === \count($value)) {
             $value = $value[0];
         }
 

tests/Fixtures/TestBundle/ApiResource/WithParameter.php

@@ -29,7 +29,9 @@
 use Symfony\Component\Serializer\Attribute\Groups;
 use Symfony\Component\TypeInfo\Type\BuiltinType;
 use Symfony\Component\TypeInfo\TypeIdentifier;
+use Symfony\Component\Validator\Constraints\All;
 use Symfony\Component\Validator\Constraints as Assert;
+use Symfony\Component\Validator\Constraints\Country;
 
 #[Get(
     uriTemplate: 'with_parameters/{id}{._format}',
@@ -56,6 +58,20 @@
     ],
     provider: [self::class, 'collectionProvider']
 )]
+#[GetCollection(
+    uriTemplate: 'with_parameters_country{._format}',
+    parameters: [
+        'country' => new QueryParameter(schema: ['type' => 'string'], constraints: [new Country()]),
+    ],
+    provider: [self::class, 'collectionProvider']
+)]
+#[GetCollection(
+    uriTemplate: 'with_parameters_countries{._format}',
+    parameters: [
+        'country' => new QueryParameter(constraints: [new All([new Country()])], castToArray: true),
+    ],
+    provider: [self::class, 'collectionProvider'],
+)]
 #[GetCollection(
     uriTemplate: 'validate_parameters{._format}',
     parameters: [
@@ -105,7 +121,6 @@
     parameters: new Parameters([
         new QueryParameter(
             key: 'q',
-            nativeType: new BuiltinType(TypeIdentifier::STRING),
         ),
         new HeaderParameter(
             key: 'q',

tests/Functional/Parameters/ParameterTest.php

@@ -102,6 +102,15 @@ public function testHeaderAndQuery(): void
         ]);
     }
 
+    public function testHeaderAndQueryWithArray(): void
+    {
+        $response = self::createClient()->request('GET', 'with_parameters_header_and_query?q[]=blabla', ['headers' => ['q' => '(complex stuff)']]);
+        $this->assertEquals($response->toArray(), [
+            '(complex stuff)',
+            ['blabla'],
+        ]);
+    }
+
     public function testHeaderParameterRequired(): void
     {
         self::createClient()->request('GET', 'header_required', ['headers' => ['req' => 'blabla']]);
@@ -125,4 +134,30 @@ public static function provideHeaderValues(): iterable
         yield 'too low' => ['0', 422];
         yield 'invalid integer' => ['string', 422];
     }
+
+    #[DataProvider('provideCountryValues')]
+    public function testIssue7157(string $queryParameter, int $expectedStatusCode): void
+    {
+        self::createClient()->request('GET', 'with_parameters_country?'.$queryParameter);
+        $this->assertResponseStatusCodeSame($expectedStatusCode);
+    }
+
+    public static function provideCountryValues(): iterable
+    {
+        yield 'valid country' => ['country=FR', 200];
+        yield 'array of countries' => ['country[]=FR', 422];
+    }
+
+    #[DataProvider('provideCountriesValues')]
+    public function testIssue7157WithCountries(string $queryParameter, int $expectedStatusCode): void
+    {
+        self::createClient()->request('GET', 'with_parameters_countries?'.$queryParameter);
+        $this->assertResponseStatusCodeSame($expectedStatusCode);
+    }
+
+    public static function provideCountriesValues(): iterable
+    {
+        yield 'valid country' => ['country=FR', 200];
+        yield 'array of countries' => ['country[]=FR', 200];
+    }
 }