Merge 3.4 (#6869)

* fix(jsonschema): hashmaps produces invalid openapi schema (#6830)

* fix(jsonschema): hashmaps produces invalid openapi schema

* fix

---------

Co-authored-by: soyuka <[email protected]>

* fix: add missing error normalizer trait and remove deprecated interface (#6853)

* fix: test empty parameter against null (#6852)

fixes #6844

* Fix deprecation symfony/dependency-injection

* cs: run php-cs-fixer

* ci: use problem error normalizer trait

* fix(metadata): various parameter improvements (#6867)


- `Parameter::getValue()` now takes a default value as argument `getValue(mixed $default = new ParameterNotFound()): mixed`
- `Parametes::get(string $key, string $parameterClass = QueryParameter::class)` (but also `has` and `remove`) now has a default value as second argument to `QueryParameter::class`
- Constraint violation had the wrong message when using `property`, fixed by using the `key` instead:

---------

Co-authored-by: Vincent Amstoutz <[email protected]>
Co-authored-by: mladencosa <[email protected]>
Co-authored-by: Michiel Kalle <[email protected]>

Author: 4 people

features/filter/filter_validation.feature

@@ -25,15 +25,15 @@ Feature: Validate filters based upon filter description
   Scenario: Required filter should throw an error if not set
     When I am on "/array_filter_validators"
     Then the response status code should be 422
-    And the JSON node "detail" should be equal to 'arrayRequired: This value should not be blank.\nindexedArrayRequired: This value should not be blank.'
+    And the JSON node "detail" should be equal to 'arrayRequired[]: This value should not be blank.\nindexedArrayRequired[foo]: This value should not be blank.'
 
     When I am on "/array_filter_validators?arrayRequired[foo]=foo"
     Then the response status code should be 422
-    And the JSON node "detail" should be equal to 'indexedArrayRequired: This value should not be blank.'
+    And the JSON node "detail" should be equal to 'indexedArrayRequired[foo]: This value should not be blank.'
 
     When I am on "/array_filter_validators?arrayRequired[]=foo"
     Then the response status code should be 422
-    And the JSON node "detail" should be equal to 'indexedArrayRequired: This value should not be blank.'
+    And the JSON node "detail" should be equal to 'indexedArrayRequired[foo]: This value should not be blank.'
 
   Scenario: Test filter bounds: maximum
     When I am on "/filter_validators?required=foo&required-allow-empty&maximum=10"
@@ -49,7 +49,7 @@ Feature: Validate filters based upon filter description
 
     When I am on "/filter_validators?required=foo&required-allow-empty&exclusiveMaximum=10"
     Then the response status code should be 422
-    And the JSON node "detail" should be equal to 'maximum: This value should be less than 10.'
+    And the JSON node "detail" should be equal to 'exclusiveMaximum: This value should be less than 10.'
 
   Scenario: Test filter bounds: minimum
     When I am on "/filter_validators?required=foo&required-allow-empty&minimum=5"

src/Doctrine/Odm/Extension/ParameterExtension.php

@@ -36,7 +36,7 @@ public function __construct(private readonly ContainerInterface $filterLocator)
     private function applyFilter(Builder $aggregationBuilder, ?string $resourceClass = null, ?Operation $operation = null, array &$context = []): void
     {
         foreach ($operation->getParameters() ?? [] as $parameter) {
-            if (!($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
+            if (null === ($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
                 continue;
             }
 

src/Doctrine/Orm/Extension/ParameterExtension.php

@@ -41,7 +41,7 @@ public function __construct(private readonly ContainerInterface $filterLocator)
     private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
     {
         foreach ($operation?->getParameters() ?? [] as $parameter) {
-            if (!($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
+            if (null === ($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
                 continue;
             }
 

src/JsonApi/Serializer/ErrorNormalizerTrait.php

@@ -0,0 +1,57 @@
+<?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);
+
+namespace ApiPlatform\JsonApi\Serializer;
+
+use ApiPlatform\Exception\ErrorCodeSerializableInterface;
+use Symfony\Component\ErrorHandler\Exception\FlattenException;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @deprecated
+ */
+trait ErrorNormalizerTrait
+{
+    private function getErrorMessage($object, array $context, bool $debug = false): string
+    {
+        $message = $object->getMessage();
+
+        if ($debug) {
+            return $message;
+        }
+
+        if ($object instanceof FlattenException) {
+            $statusCode = $context['statusCode'] ?? $object->getStatusCode();
+            if ($statusCode >= 500 && $statusCode < 600) {
+                $message = Response::$statusTexts[$statusCode] ?? Response::$statusTexts[Response::HTTP_INTERNAL_SERVER_ERROR];
+            }
+        }
+
+        return $message;
+    }
+
+    private function getErrorCode(object $object): ?string
+    {
+        if ($object instanceof FlattenException) {
+            $exceptionClass = $object->getClass();
+        } else {
+            $exceptionClass = $object::class;
+        }
+
+        if (is_a($exceptionClass, ErrorCodeSerializableInterface::class, true)) {
+            return $exceptionClass::getErrorCode();
+        }
+
+        return null;
+    }
+}

src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php

@@ -34,8 +34,10 @@ final class SchemaPropertyMetadataFactory implements PropertyMetadataFactoryInte
 
     public const JSON_SCHEMA_USER_DEFINED = 'user_defined_schema';
 
-    public function __construct(ResourceClassResolverInterface $resourceClassResolver, private readonly ?PropertyMetadataFactoryInterface $decorated = null)
-    {
+    public function __construct(
+        ResourceClassResolverInterface $resourceClassResolver,
+        private readonly ?PropertyMetadataFactoryInterface $decorated = null,
+    ) {
         $this->resourceClassResolver = $resourceClassResolver;
     }
 
@@ -198,6 +200,8 @@ private function typeToArray(Type $type, ?bool $readableLink = null): array
      * Gets the JSON Schema document which specifies the data type corresponding to the given PHP class, and recursively adds needed new schema to the current schema if provided.
      *
      * Note: if the class is not part of exceptions listed above, any class is considered as a resource.
+     *
+     * @throws PropertyNotFoundException
      */
     private function getClassType(?string $className, bool $nullable, ?bool $readableLink): array
     {
@@ -240,7 +244,8 @@ private function getClassType(?string $className, bool $nullable, ?bool $readabl
             ];
         }
 
-        if (!$this->isResourceClass($className) && is_a($className, \BackedEnum::class, true)) {
+        $isResourceClass = $this->isResourceClass($className);
+        if (!$isResourceClass && is_a($className, \BackedEnum::class, true)) {
             $enumCases = array_map(static fn (\BackedEnum $enum): string|int => $enum->value, $className::cases());
 
             $type = \is_string($enumCases[0] ?? '') ? 'string' : 'integer';
@@ -255,15 +260,14 @@ private function getClassType(?string $className, bool $nullable, ?bool $readabl
             ];
         }
 
-        if (true !== $readableLink && $this->isResourceClass($className)) {
+        if (true !== $readableLink && $isResourceClass) {
             return [
                 'type' => 'string',
                 'format' => 'iri-reference',
                 'example' => 'https://example.com/',
             ];
         }
 
-        // TODO: add propertyNameCollectionFactory and recurse to find the underlying schema? Right now SchemaFactory does the job so we don't compute anything here.
         return ['type' => Schema::UNKNOWN_TYPE];
     }
 

src/JsonSchema/SchemaFactory.php

@@ -179,7 +179,8 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
         $propertySchemaType = $propertySchema['type'] ?? false;
 
         $isUnknown = Schema::UNKNOWN_TYPE === $propertySchemaType
-            || ('array' === $propertySchemaType && Schema::UNKNOWN_TYPE === ($propertySchema['items']['type'] ?? null));
+            || ('array' === $propertySchemaType && Schema::UNKNOWN_TYPE === ($propertySchema['items']['type'] ?? null))
+            || ('object' === $propertySchemaType && Schema::UNKNOWN_TYPE === ($propertySchema['additionalProperties']['type'] ?? null));
 
         if (
             !$isUnknown && (
@@ -231,8 +232,9 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
             }
 
             if ($isCollection) {
-                $propertySchema['items']['$ref'] = $subSchema['$ref'];
-                unset($propertySchema['items']['type']);
+                $key = ($propertySchema['type'] ?? null) === 'object' ? 'additionalProperties' : 'items';
+                $propertySchema[$key]['$ref'] = $subSchema['$ref'];
+                unset($propertySchema[$key]['type']);
                 break;
             }
 

src/Metadata/Parameter.php

@@ -124,9 +124,9 @@ public function getSecurityMessage(): ?string
      *
      * @readonly
      */
-    public function getValue(): mixed
+    public function getValue(mixed $default = new ParameterNotFound()): mixed
     {
-        return $this->extraProperties['_api_values'] ?? new ParameterNotFound();
+        return $this->extraProperties['_api_values'] ?? $default;
     }
 
     /**

src/Metadata/Parameters.php

@@ -70,7 +70,7 @@ public function add(string $key, Parameter $value): self
     /**
      * @param class-string $parameterClass
      */
-    public function remove(string $key, string $parameterClass): self
+    public function remove(string $key, string $parameterClass = QueryParameter::class): self
     {
         foreach ($this->parameters as $i => [$parameterName, $parameter]) {
             if ($parameterName === $key && $parameterClass === $parameter::class) {
@@ -86,7 +86,7 @@ public function remove(string $key, string $parameterClass): self
     /**
      * @param class-string $parameterClass
      */
-    public function get(string $key, string $parameterClass): ?Parameter
+    public function get(string $key, string $parameterClass = QueryParameter::class): ?Parameter
     {
         foreach ($this->parameters as [$parameterName, $parameter]) {
             if ($parameterName === $key && $parameterClass === $parameter::class) {
@@ -100,7 +100,7 @@ public function get(string $key, string $parameterClass): ?Parameter
     /**
      * @param class-string $parameterClass
      */
-    public function has(string $key, string $parameterClass): bool
+    public function has(string $key, string $parameterClass = QueryParameter::class): bool
     {
         foreach ($this->parameters as [$parameterName, $parameter]) {
             if ($parameterName === $key && $parameterClass === $parameter::class) {

src/Metadata/Tests/ParameterTest.php

@@ -0,0 +1,28 @@
+<?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);
+
+namespace ApiPlatform\Metadata\Tests;
+
+use ApiPlatform\Metadata\QueryParameter;
+use ApiPlatform\State\ParameterNotFound;
+use PHPUnit\Framework\TestCase;
+
+class ParameterTest extends TestCase
+{
+    public function testDefaultValue(): void
+    {
+        $parameter = new QueryParameter();
+        $this->assertSame('test', $parameter->getValue('test'));
+        $this->assertInstanceOf(ParameterNotFound::class, $parameter->getValue());
+    }
+}

src/Metadata/Tests/ParametersTest.php

@@ -0,0 +1,28 @@
+<?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);
+
+namespace ApiPlatform\Metadata\Tests;
+
+use ApiPlatform\Metadata\Parameters;
+use ApiPlatform\Metadata\QueryParameter;
+use PHPUnit\Framework\TestCase;
+
+class ParametersTest extends TestCase
+{
+    public function testDefaultValue(): void
+    {
+        $r = new QueryParameter();
+        $parameters = new Parameters(['a' => $r]);
+        $this->assertSame($r, $parameters->get('a'));
+    }
+}

src/Symfony/Bundle/Resources/config/elasticsearch.xml

@@ -86,7 +86,7 @@
             <argument type="service" id="api_platform.elasticsearch.client" />
             <argument type="service" id="serializer" />
             <argument type="service" id="api_platform.pagination" />
-            <argument type="tagged" tag="api_platform.elasticsearch.request_body_search_extension.collection" />
+            <argument type="tagged_iterator" tag="api_platform.elasticsearch.request_body_search_extension.collection" />
             <argument type="service" id="api_platform.inflector" on-invalid="null" />
 
             <tag name="api_platform.state_provider" priority="-100" key="ApiPlatform\Elasticsearch\State\CollectionProvider"/>

src/Symfony/Validator/State/ParameterValidatorProvider.php

@@ -14,12 +14,14 @@
 namespace ApiPlatform\Symfony\Validator\State;
 
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
 use ApiPlatform\State\ParameterNotFound;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\Util\ParameterParserTrait;
 use ApiPlatform\Validator\Exception\ValidationException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Validator\ConstraintViolation;
+use Symfony\Component\Validator\ConstraintViolationInterface;
 use Symfony\Component\Validator\ConstraintViolationList;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 
@@ -55,7 +57,6 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
                 continue;
             }
 
-            $key = $parameter->getKey();
             $value = $parameter->getValue();
             if ($value instanceof ParameterNotFound) {
                 $value = null;
@@ -68,9 +69,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
                     $violation->getMessageTemplate(),
                     $violation->getParameters(),
                     $violation->getRoot(),
-                    $parameter->getProperty() ?? (
-                        str_contains($key, ':property') ? str_replace('[:property]', $violation->getPropertyPath(), $key) : $key.$violation->getPropertyPath()
-                    ),
+                    $this->getProperty($parameter, $violation),
                     $violation->getInvalidValue(),
                     $violation->getPlural(),
                     $violation->getCode(),
@@ -86,4 +85,24 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         return $this->decorated->provide($operation, $uriVariables, $context);
     }
+
+    // There's a `property` inside Parameter but it's used for hydra:search only as here we want the parameter name instead
+    private function getProperty(Parameter $parameter, ConstraintViolationInterface $violation): string
+    {
+        $key = $parameter->getKey();
+
+        if (str_contains($key, '[:property]')) {
+            return str_replace('[:property]', $violation->getPropertyPath(), $key);
+        }
+
+        if (str_contains($key, ':property')) {
+            return str_replace(':property', $violation->getPropertyPath(), $key);
+        }
+
+        if ($p = $violation->getPropertyPath()) {
+            return $p;
+        }
+
+        return $key;
+    }
 }

tests/Fixtures/TestBundle/ApiResource/Issue6800/Foo.php

@@ -0,0 +1,20 @@
+<?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);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6800;
+
+class Foo
+{
+    public string $bar;
+    public int $baz;
+}

tests/Fixtures/TestBundle/ApiResource/Issue6800/TestApiDocHashmapArrayObjectIssue.php

@@ -0,0 +1,29 @@
+<?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);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6800;
+
+use ApiPlatform\Metadata\Get;
+
+#[Get]
+class TestApiDocHashmapArrayObjectIssue
+{
+    /** @var array<Foo> */
+    public array $foos;
+
+    /** @var Foo[] */
+    public array $fooOtherSyntax;
+
+    /** @var array<string, Foo> */
+    public array $fooHashmaps;
+}