Merge branch 'api-platform:main' into main

Author: SebLevDev

CHANGELOG.md

@@ -1,12 +1,36 @@
 # Changelog
 
+## v4.0.13
+
+### Bug fixes
+
+* [3a694624b](https://github.com/api-platform/core/commit/3a694624bdd6c82df756ff04682b5f90fd625f59) fix(laravel): eloquent BelongsToMany relation (#6862)
+* [c8db7aef0](https://github.com/api-platform/core/commit/c8db7aef05557675940c3e610c94c6a2184d90ba) fix(laravel): jsonapi query parameters (page, sort, fields and include) (#6876)
+* [f2c998158](https://github.com/api-platform/core/commit/f2c998158a70632a26efcdd29a17d7f3a2cb859c) fix(jsonld): anonymous context hydra_prefix value (#6873)
+
+Also contains [v3.4.10 changes](#v3410).
+
+### Features
+
+## v4.0.12
+
+### Bug fixes
+
+* [4db72f55f](https://github.com/api-platform/core/commit/4db72f55fa9dcd48518dc62b5bf472895b6a966b) fix: filter may not use FilterInterface (#6858)
+* [c899a3da1](https://github.com/api-platform/core/commit/c899a3da14eb2dff49095d28855ef8f2a1c4072a) fix(laravel): use tagged resolvers as graphql resolvers
+ (#6855)
+* [e0f8c38b9](https://github.com/api-platform/core/commit/e0f8c38b98a05f29ad36b37725e54a036209a859) fix(laravel): graphql currentPage (#6857)
+
+Also contains [v3.4.9 changes](#v349).
+
+### Features
+
 ## v4.0.11
 
 ### Bug fixes
 
 * [af66075fd](https://github.com/api-platform/core/commit/af66075fdd6b83bdebc1c4ca33cc0ab7e1a7f8af) fix(laravel): fix foregin keys (relations) beeing in attributes (#6843)
 
-
 ### Features
 
 * [2d59c6369](https://github.com/api-platform/core/commit/2d59c63699b4602cfe4d62504896c6d4121c1be4) feat(laravel): belongs to many relations (#6818)
@@ -224,6 +248,27 @@ Notes:
 
 * [0d5f35683](https://github.com/api-platform/core/commit/0d5f356839eb6aa9f536044abe4affa736553e76) feat(laravel): laravel component (#5882)
 
+## v3.4.10
+
+### Bug fixes
+
+* [2ee5eb496](https://github.com/api-platform/core/commit/2ee5eb4967f507d04ae07280914bea3c712d8cad) fix(symfony): mercure exception formatting by calling array_keys() (#6879)
+
+## v3.4.9
+
+### Bug fixes
+
+* [22cbd0147](https://github.com/api-platform/core/commit/22cbd0147ef6f817093533d62dc8279add67a647) fix(metadata): various parameter improvements (#6867)
+* [978975ef0](https://github.com/api-platform/core/commit/978975ef01d7b9d230291676527aa1140a7e552f) fix(jsonschema): hashmaps produces invalid openapi schema (#6830)
+* [a209dd440](https://github.com/api-platform/core/commit/a209dd440957176099247acf35b82611073352b1) fix: add missing error normalizer trait and remove deprecated interface (#6853)
+* [abbc031ee](https://github.com/api-platform/core/commit/abbc031eece83b54781502cd6373b47a09e109f4) fix: test empty parameter against null (#6852)
+
+### Notes
+
+- `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
+
 ## v3.4.8
 
 ### Bug fixes

src/Doctrine/Common/State/LinksHandlerLocatorTrait.php

@@ -35,10 +35,33 @@ private function getLinksHandler(Operation $operation): ?callable
             return $handleLinks;
         }
 
+        if (\is_array($handleLinks) && 2 === \count($handleLinks) && class_exists($handleLinks[0])) {
+            [$className, $methodName] = $handleLinks;
+
+            if (method_exists($className, $methodName)) {
+                return $handleLinks;
+            }
+
+            $suggestedMethod = $this->findSimilarMethod($className, $methodName);
+
+            throw new RuntimeException(\sprintf('Method "%s" does not exist in class "%s".%s', $methodName, $className, $suggestedMethod ? \sprintf(' Did you mean "%s"?', $suggestedMethod) : ''));
+        }
+
         if ($this->handleLinksLocator && \is_string($handleLinks) && $this->handleLinksLocator->has($handleLinks)) {
             return [$this->handleLinksLocator->get($handleLinks), 'handleLinks'];
         }
 
         throw new RuntimeException(\sprintf('Could not find handleLinks service "%s"', $handleLinks));
     }
+
+    private function findSimilarMethod(string $className, string $methodName): ?string
+    {
+        $methods = get_class_methods($className);
+
+        $similarMethods = array_filter($methods, function ($method) use ($methodName) {
+            return levenshtein($methodName, $method) <= 3;
+        });
+
+        return $similarMethods ? reset($similarMethods) : null;
+    }
 }

src/GraphQl/Executor.php

@@ -18,6 +18,8 @@
 use GraphQL\Type\Schema;
 use GraphQL\Validator\DocumentValidator;
 use GraphQL\Validator\Rules\DisableIntrospection;
+use GraphQL\Validator\Rules\QueryComplexity;
+use GraphQL\Validator\Rules\QueryDepth;
 
 /**
  * Wrapper for the GraphQL facade.
@@ -26,13 +28,19 @@
  */
 final class Executor implements ExecutorInterface
 {
-    public function __construct(private readonly bool $graphQlIntrospectionEnabled = true)
+    public function __construct(private readonly bool $graphQlIntrospectionEnabled = true, private readonly int $maxQueryComplexity = 500, private readonly int $maxQueryDepth = 20)
     {
         DocumentValidator::addRule(
             new DisableIntrospection(
                 $this->graphQlIntrospectionEnabled ? DisableIntrospection::DISABLED : DisableIntrospection::ENABLED
             )
         );
+
+        $queryComplexity = new QueryComplexity($this->maxQueryComplexity);
+        DocumentValidator::addRule($queryComplexity);
+
+        $queryDepth = new QueryDepth($this->maxQueryDepth);
+        DocumentValidator::addRule($queryDepth);
     }
 
     /**

src/GraphQl/State/Processor/NormalizeProcessor.php

@@ -213,6 +213,12 @@ private function serializePageBasedPaginatedCollection(iterable $collection, arr
                 }
                 $data['paginationInfo']['totalCount'] = $collection->getTotalItems();
             }
+            if (isset($selection['paginationInfo']['currentPage'])) {
+                if (!($collection instanceof PartialPaginatorInterface)) {
+                    throw new \LogicException(\sprintf('Collection returned by the collection data provider must implement %s to return currentPage field.', PartialPaginatorInterface::class));
+                }
+                $data['paginationInfo']['currentPage'] = $collection->getCurrentPage();
+            }
             if (isset($selection['paginationInfo']['lastPage'])) {
                 if (!($collection instanceof PaginatorInterface)) {
                     throw new \LogicException(\sprintf('Collection returned by the collection data provider must implement %s to return lastPage field.', PaginatorInterface::class));

src/GraphQl/Tests/ExecutorTest.php

@@ -16,6 +16,8 @@
 use ApiPlatform\GraphQl\Executor;
 use GraphQL\Validator\DocumentValidator;
 use GraphQL\Validator\Rules\DisableIntrospection;
+use GraphQL\Validator\Rules\QueryComplexity;
+use GraphQL\Validator\Rules\QueryDepth;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -38,4 +40,20 @@ public function testDisableIntrospectionQuery(): void
         $expected = new DisableIntrospection(DisableIntrospection::ENABLED);
         $this->assertEquals($expected, DocumentValidator::getRule(DisableIntrospection::class));
     }
+
+    public function testChangeValueOfMaxQueryDepth(): void
+    {
+        $executor = new Executor(true, 20);
+
+        $expected = new QueryComplexity(20);
+        $this->assertEquals($expected, DocumentValidator::getRule(QueryComplexity::class));
+    }
+
+    public function testChangeValueOfMaxQueryComplexity(): void
+    {
+        $executor = new Executor(true, maxQueryDepth: 20);
+
+        $expected = new QueryDepth(20);
+        $this->assertEquals($expected, DocumentValidator::getRule(QueryDepth::class));
+    }
 }

src/GraphQl/Type/TypeBuilder.php

@@ -278,6 +278,7 @@ private function getPageBasedPaginationFields(GraphQLType $resourceType): array
                 'itemsPerPage' => GraphQLType::nonNull(GraphQLType::int()),
                 'lastPage' => GraphQLType::nonNull(GraphQLType::int()),
                 'totalCount' => GraphQLType::nonNull(GraphQLType::int()),
+                'currentPage' => GraphQLType::nonNull(GraphQLType::int()),
                 'hasNextPage' => GraphQLType::nonNull(GraphQLType::boolean()),
             ],
         ];

src/Hydra/Serializer/DocumentationNormalizer.php

@@ -75,6 +75,10 @@ public function normalize(mixed $object, ?string $format = null, array $context
                 continue;
             }
 
+            if (true === $resourceMetadata->getHideHydraOperation()) {
+                continue;
+            }
+
             $shortName = $resourceMetadata->getShortName();
 
             $prefixedShortName = $resourceMetadata->getTypes()[0] ?? "#$shortName";
@@ -243,6 +247,10 @@ private function getHydraOperations(bool $collection, ?ResourceMetadataCollectio
         $hydraOperations = [];
         foreach ($resourceMetadataCollection as $resourceMetadata) {
             foreach ($resourceMetadata->getOperations() as $operation) {
+                if (true === $operation->getHideHydraOperation()) {
+                    continue;
+                }
+
                 if (('POST' === $operation->getMethod() || $operation instanceof CollectionOperationInterface) !== $collection) {
                     continue;
                 }

src/Hydra/Serializer/EntrypointNormalizer.php

@@ -56,7 +56,7 @@ public function normalize(mixed $object, ?string $format = null, array $context
 
                 foreach ($resource->getOperations() as $operation) {
                     $key = lcfirst($resource->getShortName());
-                    if (!$operation instanceof CollectionOperationInterface || isset($entrypoint[$key])) {
+                    if (true === $operation->getHideHydraOperation() || !$operation instanceof CollectionOperationInterface || isset($entrypoint[$key])) {
                         continue;
                     }
 

src/JsonApi/Filter/SparseFieldset.php

@@ -0,0 +1,52 @@
+<?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\Filter;
+
+use ApiPlatform\Metadata\JsonSchemaFilterInterface;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Parameter as MetadataParameter;
+use ApiPlatform\Metadata\ParameterProviderFilterInterface;
+use ApiPlatform\Metadata\PropertiesAwareInterface;
+use ApiPlatform\Metadata\QueryParameter;
+use ApiPlatform\OpenApi\Model\Parameter;
+
+final class SparseFieldset implements OpenApiParameterFilterInterface, JsonSchemaFilterInterface, ParameterProviderFilterInterface, PropertiesAwareInterface
+{
+    public function getSchema(MetadataParameter $parameter): array
+    {
+        return [
+            'type' => 'array',
+            'items' => [
+                'type' => 'string',
+            ],
+        ];
+    }
+
+    public function getOpenApiParameters(MetadataParameter $parameter): Parameter|array|null
+    {
+        return new Parameter(
+            name: ($k = $parameter->getKey()).'[]',
+            in: $parameter instanceof QueryParameter ? 'query' : 'header',
+            description: 'Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: '.\sprintf(
+                '%1$s[]={propertyName}&%1$s[]={anotherPropertyName}',
+                $k
+            )
+        );
+    }
+
+    public static function getParameterProvider(): string
+    {
+        return SparseFieldsetParameterProvider::class;
+    }
+}

src/JsonApi/Filter/SparseFieldsetParameterProvider.php

@@ -0,0 +1,62 @@
+<?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\Filter;
+
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\State\ParameterProviderInterface;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+
+final readonly class SparseFieldsetParameterProvider implements ParameterProviderInterface
+{
+    public function provide(Parameter $parameter, array $parameters = [], array $context = []): ?Operation
+    {
+        if (!($operation = $context['operation'] ?? null)) {
+            return null;
+        }
+
+        $allowedProperties = $parameter->getExtraProperties()['_properties'] ?? [];
+        $value = $parameter->getValue();
+        $normalizationContext = $operation->getNormalizationContext();
+
+        if (!\is_array($value)) {
+            return null;
+        }
+
+        $properties = [];
+        $shortName = strtolower($operation->getShortName());
+        foreach ($value as $resource => $fields) {
+            if (strtolower($resource) === $shortName) {
+                $p = &$properties;
+            } else {
+                $properties[$resource] = [];
+                $p = &$properties[$resource];
+            }
+
+            foreach (explode(',', $fields) as $f) {
+                if (\array_key_exists($f, $allowedProperties)) {
+                    $p[] = $f;
+                }
+            }
+        }
+
+        if (isset($normalizationContext[AbstractNormalizer::ATTRIBUTES])) {
+            $properties = array_merge_recursive((array) $normalizationContext[AbstractNormalizer::ATTRIBUTES], $properties);
+        }
+
+        $normalizationContext[AbstractNormalizer::ATTRIBUTES] = $properties;
+
+        return $operation->withNormalizationContext($normalizationContext);
+    }
+}