Merge 4.0

Author: soyuka

CHANGELOG.md

@@ -120,6 +120,17 @@ On write operations, we added the [expectsHeader](https://www.hydra-cg.com/spec/
 * [d0a442786](https://github.com/api-platform/core/commit/d0a44278630d201b91cbba0774a09f4eeaac88f7) feat(doctrine): enhance getLinksHandler with method validation and typo suggestions (#6874)
 * [f67f6f1ac](https://github.com/api-platform/core/commit/f67f6f1acb6476182c18a3503f2a8bc80ae89a0b)  feat(doctrine): doctrine filters like laravel eloquent filters  (#6775)
 
+## v4.0.21
+
+### Bug fixes
+
+* [7cb5a6db8](https://github.com/api-platform/core/commit/7cb5a6db87241d95e6c324318fe861bd4f1820cf) fix: allow parameter provider as object (#7032)
+* [bb83e9a03](https://github.com/api-platform/core/commit/bb83e9a034c511156aa20a8555bf367374ef5458) fix(symfony): allow to merge array with string in global defaults (#7037)
+* [da2e86809](https://github.com/api-platform/core/commit/da2e86809d4a8dec294dc2fc148d92406f1f7fd1) fix: header parameter should be case insensitive (#7031)
+
+
+### Features
+
 ## v4.0.20
 
 ### Bug fixes

src/Metadata/Resource/Factory/OperationDefaultsTrait.php

@@ -63,6 +63,10 @@ private function addGlobalDefaults(ApiResource|Operation $operation): ApiResourc
             $currentValue = $operation->{$getter}();
 
             if (\is_array($currentValue) && $currentValue) {
+                if (\is_string($value)) {
+                    $value = [$value];
+                }
+
                 $operation = $operation->{'with'.$upperKey}(array_merge($value, $currentValue));
             }
 

src/State/Provider/ParameterProvider.php

@@ -18,7 +18,6 @@
 use ApiPlatform\State\Exception\ParameterNotSupportedException;
 use ApiPlatform\State\Exception\ProviderNotFoundException;
 use ApiPlatform\State\ParameterNotFound;
-use ApiPlatform\State\ParameterProviderInterface;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\Util\ParameterParserTrait;
 use ApiPlatform\State\Util\RequestParser;
@@ -99,13 +98,15 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
                 continue;
             }
 
-            if (!\is_string($provider) || !$this->locator->has($provider)) {
-                throw new ProviderNotFoundException(\sprintf('Provider "%s" not found on operation "%s"', $provider, $operation->getName()));
+            if (\is_string($provider)) {
+                if (!$this->locator->has($provider)) {
+                    throw new ProviderNotFoundException(\sprintf('Provider "%s" not found on operation "%s"', $provider, $operation->getName()));
+                }
+
+                $provider = $this->locator->get($provider);
             }
 
-            /** @var ParameterProviderInterface $providerInstance */
-            $providerInstance = $this->locator->get($provider);
-            if (($op = $providerInstance->provide($parameter, $values, $context)) instanceof Operation) {
+            if (($op = $provider->provide($parameter, $values, $context)) instanceof Operation) {
                 $operation = $op;
             }
         }

src/State/Util/ParameterParserTrait.php

@@ -50,6 +50,10 @@ private function extractParameterValues(Parameter $parameter, array $values): st
             throw new \RuntimeException('A Parameter should have a key.');
         }
 
+        if ($parameter instanceof HeaderParameterInterface) {
+            $key = strtolower($key);
+        }
+
         $parsedKey = explode('[:property]', $key);
         if (isset($parsedKey[0]) && isset($values[$parsedKey[0]])) {
             $key = $parsedKey[0];

tests/Fixtures/TestBundle/ApiResource/WithParameter.php

@@ -39,6 +39,7 @@
         'group' => new QueryParameter(provider: [self::class, 'provideGroup']),
         'properties' => new QueryParameter(filter: 'my_dummy.property'),
         'service' => new QueryParameter(provider: CustomGroupParameterProvider::class),
+        'object' => new QueryParameter(provider: new CustomGroupParameterProvider()),
         'auth' => new HeaderParameter(provider: [self::class, 'restrictAccess']),
         'priority' => new QueryParameter(provider: [self::class, 'assertSecond'], priority: 10),
         'priorityb' => new QueryParameter(provider: [self::class, 'assertFirst'], priority: 20),
@@ -79,6 +80,13 @@
     parameters: new Parameters([new QueryParameter(key: 'q'), new HeaderParameter(key: 'q')]),
     provider: [self::class, 'headerAndQueryProvider']
 )]
+#[GetCollection(
+    uriTemplate: 'header_required',
+    parameters: [
+        'Req' => new HeaderParameter(required: true, schema: ['type' => 'string']),
+    ],
+    provider: [self::class, 'headerProvider']
+)]
 #[QueryParameter(key: 'everywhere')]
 class WithParameter
 {
@@ -127,7 +135,7 @@ public static function restrictAccess(): void
         throw new AccessDeniedHttpException();
     }
 
-    public static function headerAndQueryProvider(Operation $operation, array $uriVariables = [], array $context = [])
+    public static function headerAndQueryProvider(Operation $operation, array $uriVariables = [], array $context = []): JsonResponse
     {
         $parameters = $operation->getParameters();
         $values = [$parameters->get('q', HeaderParameter::class)->getValue(), $parameters->get('q', QueryParameter::class)->getValue()];
@@ -154,4 +162,12 @@ public static function toInt(Parameter $parameter, array $parameters = [], array
 
         return $operation->withParameters($parameters);
     }
+
+    public static function headerProvider(Operation $operation, array $uriVariables = [], array $context = []): JsonResponse
+    {
+        $parameters = $operation->getParameters();
+        $values = [$parameters->get('Req', HeaderParameter::class)->getValue()];
+
+        return new JsonResponse($values);
+    }
 }

tests/Functional/Parameters/ParameterTest.php

@@ -57,6 +57,12 @@ public function testWithServiceProvider(): void
         $this->assertArrayNotHasKey('a', $response->toArray());
     }
 
+    public function testWithObjectProvider(): void
+    {
+        $response = self::createClient()->request('GET', 'with_parameters/1?service=blabla');
+        $this->assertArrayNotHasKey('a', $response->toArray());
+    }
+
     public function testWithHeader(): void
     {
         self::createClient()->request('GET', 'with_parameters/1?service=blabla', ['headers' => ['auth' => 'foo']]);
@@ -93,4 +99,13 @@ public function testHeaderAndQuery(): void
             'blabla',
         ]);
     }
+
+    public function testHeaderParameterRequired(): void
+    {
+        self::createClient()->request('GET', 'header_required', ['headers' => ['req' => 'blabla']]);
+        $this->assertResponseStatusCodeSame(200);
+
+        self::createClient()->request('GET', 'header_required', ['headers' => []]);
+        $this->assertResponseStatusCodeSame(422);
+    }
 }