chore: move resource access checker to metadata

soyuka · soyuka · commit b68e33f3518f · 2024-01-04T09:32:44.000+01:00
GraphQl and Serializer have no dependency on our symfony component anymore
diff --git a/src/GraphQl/Resolver/Stage/SecurityPostDenormalizeStage.php b/src/GraphQl/Resolver/Stage/SecurityPostDenormalizeStage.php
@@ -14,7 +14,8 @@
 namespace ApiPlatform\GraphQl\Resolver\Stage;
 
 use ApiPlatform\Metadata\GraphQl\Operation;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
+use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface as LegacyResourceAccessCheckerInterface;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 
 /**
@@ -24,8 +25,17 @@
  */
 final class SecurityPostDenormalizeStage implements SecurityPostDenormalizeStageInterface
 {
-    public function __construct(private readonly ?ResourceAccessCheckerInterface $resourceAccessChecker)
+    /**
+     * @var LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface
+     */
+    private $resourceAccessChecker;
+
+    /**
+     * @param LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface|null $resourceAccessChecker
+     */
+    public function __construct($resourceAccessChecker)
     {
+        $this->resourceAccessChecker = $resourceAccessChecker;
     }
 
     /**
diff --git a/src/GraphQl/Resolver/Stage/SecurityPostValidationStage.php b/src/GraphQl/Resolver/Stage/SecurityPostValidationStage.php
@@ -14,19 +14,31 @@
 namespace ApiPlatform\GraphQl\Resolver\Stage;
 
 use ApiPlatform\Metadata\GraphQl\Operation;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
+use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface as LegacyResourceAccessCheckerInterface;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 
 /**
  * Security post validation stage of GraphQL resolvers.
  *
+ * @deprecated use providers instead of stages
+ *
  * @author Vincent Chalamon <vincentchalamon@gmail.com>
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  */
 final class SecurityPostValidationStage implements SecurityPostValidationStageInterface
 {
-    public function __construct(private readonly ?ResourceAccessCheckerInterface $resourceAccessChecker)
+    /**
+     * @var LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface
+     */
+    private $resourceAccessChecker;
+
+    /**
+     * @param LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface|null $resourceAccessChecker
+     */
+    public function __construct($resourceAccessChecker)
     {
+        $this->resourceAccessChecker = $resourceAccessChecker;
     }
 
     /**
diff --git a/src/GraphQl/Resolver/Stage/SecurityStage.php b/src/GraphQl/Resolver/Stage/SecurityStage.php
@@ -14,7 +14,8 @@
 namespace ApiPlatform\GraphQl\Resolver\Stage;
 
 use ApiPlatform\Metadata\GraphQl\Operation;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
+use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface as LegacyResourceAccessCheckerInterface;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 
 /**
@@ -24,8 +25,17 @@
  */
 final class SecurityStage implements SecurityStageInterface
 {
-    public function __construct(private readonly ?ResourceAccessCheckerInterface $resourceAccessChecker)
+    /**
+     * @var LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface
+     */
+    private $resourceAccessChecker;
+
+    /**
+     * @param LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface|null $resourceAccessChecker
+     */
+    public function __construct($resourceAccessChecker)
     {
+        $this->resourceAccessChecker = $resourceAccessChecker;
     }
 
     /**
diff --git a/src/GraphQl/Serializer/Exception/ValidationExceptionNormalizer.php b/src/GraphQl/Serializer/Exception/ValidationExceptionNormalizer.php
@@ -14,6 +14,7 @@
 namespace ApiPlatform\GraphQl\Serializer\Exception;
 
 use ApiPlatform\Symfony\Validator\Exception\ValidationException;
+use ApiPlatform\Validator\Exception\ConstraintViolationListAwareExceptionInterface;
 use GraphQL\Error\Error;
 use GraphQL\Error\FormattedError;
 use Symfony\Component\HttpFoundation\Response;
@@ -37,7 +38,7 @@ public function __construct(private readonly array $exceptionToStatus = [])
      */
     public function normalize(mixed $object, string $format = null, array $context = []): array
     {
-        /** @var ValidationException */
+        /** @var ConstraintViolationListAwareExceptionInterface */
         $validationException = $object->getPrevious();
         $error = FormattedError::createFromException($object);
         $error['message'] = $validationException->getMessage();
@@ -75,7 +76,10 @@ public function normalize(mixed $object, string $format = null, array $context =
      */
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
-        return $data instanceof Error && $data->getPrevious() instanceof ValidationException;
+        return $data instanceof Error && (
+            $data->getPrevious() instanceof ConstraintViolationListAwareExceptionInterface
+            || $data->getPrevious() instanceof ValidationException
+        );
     }
 
     public function getSupportedTypes($format): array
diff --git a/src/GraphQl/Serializer/ItemNormalizer.php b/src/GraphQl/Serializer/ItemNormalizer.php
@@ -20,11 +20,12 @@
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\Util\ClassInfoTrait;
 use ApiPlatform\Serializer\CacheKeyTrait;
 use ApiPlatform\Serializer\ItemNormalizer as BaseItemNormalizer;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface as LegacyResourceAccessCheckerInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
@@ -48,7 +49,10 @@ final class ItemNormalizer extends BaseItemNormalizer
 
     private array $safeCacheKeysCache = [];
 
-    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, private readonly IdentifiersExtractorInterface $identifiersExtractor, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, LoggerInterface $logger = null, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
+    /**
+     * @param LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface $resourceAccessChecker
+     */
+    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, private readonly IdentifiersExtractorInterface $identifiersExtractor, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, LoggerInterface $logger = null, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, $resourceAccessChecker = null)
     {
         parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $logger ?: new NullLogger(), $resourceMetadataCollectionFactory, $resourceAccessChecker);
     }
diff --git a/src/GraphQl/Tests/Resolver/Stage/SecurityPostDenormalizeStageTest.php b/src/GraphQl/Tests/Resolver/Stage/SecurityPostDenormalizeStageTest.php
@@ -16,7 +16,7 @@
 use ApiPlatform\GraphQl\Resolver\Stage\SecurityPostDenormalizeStage;
 use ApiPlatform\Metadata\GraphQl\Operation;
 use ApiPlatform\Metadata\GraphQl\Query;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
 use GraphQL\Type\Definition\ResolveInfo;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
diff --git a/src/GraphQl/Tests/Resolver/Stage/SecurityPostValidationStageTest.php b/src/GraphQl/Tests/Resolver/Stage/SecurityPostValidationStageTest.php
@@ -16,7 +16,7 @@
 use ApiPlatform\GraphQl\Resolver\Stage\SecurityPostValidationStage;
 use ApiPlatform\Metadata\GraphQl\Operation;
 use ApiPlatform\Metadata\GraphQl\Query;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
 use GraphQL\Type\Definition\ResolveInfo;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
diff --git a/src/GraphQl/Tests/Resolver/Stage/SecurityStageTest.php b/src/GraphQl/Tests/Resolver/Stage/SecurityStageTest.php
@@ -16,7 +16,7 @@
 use ApiPlatform\GraphQl\Resolver\Stage\SecurityStage;
 use ApiPlatform\Metadata\GraphQl\Operation;
 use ApiPlatform\Metadata\GraphQl\Query;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
 use GraphQL\Type\Definition\ResolveInfo;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
diff --git a/src/GraphQl/Tests/Serializer/Exception/ValidationExceptionNormalizerTest.php b/src/GraphQl/Tests/Serializer/Exception/ValidationExceptionNormalizerTest.php
@@ -14,11 +14,12 @@
 namespace ApiPlatform\GraphQl\Tests\Serializer\Exception;
 
 use ApiPlatform\GraphQl\Serializer\Exception\ValidationExceptionNormalizer;
-use ApiPlatform\Symfony\Validator\Exception\ValidationException;
+use ApiPlatform\Validator\Exception\ConstraintViolationListAwareExceptionInterface;
 use GraphQL\Error\Error;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Validator\ConstraintViolation;
 use Symfony\Component\Validator\ConstraintViolationList;
+use Symfony\Component\Validator\ConstraintViolationListInterface;
 
 /**
  * @author Mahmood Bazdar<mahmood@bazdar.me>
@@ -38,10 +39,15 @@ protected function setUp(): void
     public function testNormalize(): void
     {
         $exceptionMessage = 'exception message';
-        $exception = new ValidationException(new ConstraintViolationList([
-            new ConstraintViolation('message 1', '', [], '', 'field 1', 'invalid'),
-            new ConstraintViolation('message 2', '', [], '', 'field 2', 'invalid'),
-        ]), $exceptionMessage);
+        $exception = new class($exceptionMessage) extends \Exception implements ConstraintViolationListAwareExceptionInterface {
+            public function getConstraintViolationList(): ConstraintViolationListInterface
+            {
+                return new ConstraintViolationList([
+                    new ConstraintViolation('message 1', '', [], '', 'field 1', 'invalid'),
+                    new ConstraintViolation('message 2', '', [], '', 'field 2', 'invalid'),
+                ]);
+            }
+        };
         $error = new Error('test message', null, null, [], null, $exception);
 
         $normalizedError = $this->validationExceptionNormalizer->normalize($error);
@@ -66,7 +72,8 @@ public function testNormalize(): void
 
     public function testSupportsNormalization(): void
     {
-        $exception = new ValidationException(new ConstraintViolationList([]));
+        $exception = $this->createStub(ConstraintViolationListAwareExceptionInterface::class);
+        $exception->method('getConstraintViolationList')->willReturn(new ConstraintViolationList([]));
         $error = new Error('test message', null, null, [], null, $exception);
 
         $this->assertTrue($this->validationExceptionNormalizer->supportsNormalization($error));
diff --git a/src/GraphQl/Tests/Serializer/ItemNormalizerTest.php b/src/GraphQl/Tests/Serializer/ItemNormalizerTest.php
@@ -22,9 +22,9 @@
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Metadata\Property\PropertyNameCollection;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
diff --git a/src/GraphQl/composer.json b/src/GraphQl/composer.json
@@ -31,7 +31,6 @@
     },
     "require-dev": {
         "phpspec/prophecy-phpunit": "^2.0",
-        "api-platform/symfony": "*@dev || ^3.1",
         "api-platform/validator": "*@dev || ^3.1",
         "twig/twig": "^3.7",
         "symfony/mercure-bundle": "*",
@@ -55,7 +54,8 @@
         "sort-packages": true,
         "allow-plugins": {
             "composer/package-versions-deprecated": true,
-            "phpstan/extension-installer": true
+            "phpstan/extension-installer": true,
+            "php-http/discovery": false
         }
     },
     "extra": {
@@ -79,10 +79,6 @@
             "type": "path",
             "url": "../Serializer"
         },
-        {
-            "type": "path",
-            "url": "../Symfony"
-        },
         {
             "type": "path",
             "url": "../Validator"
diff --git a/src/Metadata/ResourceAccessCheckerInterface.php b/src/Metadata/ResourceAccessCheckerInterface.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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;
+
+interface ResourceAccessCheckerInterface
+{
+    /**
+     * Checks if the given item can be accessed by the current user.
+     *
+     * @param array{object?: mixed, previous_object?: mixed, request?: \Symfony\Component\HttpFoundation\Request} $extraVariables
+     */
+    public function isGranted(string $resourceClass, string $expression, array $extraVariables = []): bool;
+}
diff --git a/src/Serializer/AbstractItemNormalizer.php b/src/Serializer/AbstractItemNormalizer.php
@@ -62,15 +62,20 @@ abstract class AbstractItemNormalizer extends AbstractObjectNormalizer
     protected PropertyAccessorInterface $propertyAccessor;
     protected array $localCache = [];
     protected array $localFactoryOptionsCache = [];
+    protected $resourceAccessChecker;
 
-    public function __construct(protected PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, protected PropertyMetadataFactoryInterface $propertyMetadataFactory, protected LegacyIriConverterInterface|IriConverterInterface $iriConverter, protected LegacyResourceClassResolverInterface|ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, protected ?ResourceAccessCheckerInterface $resourceAccessChecker = null, protected ?TagCollectorInterface $tagCollector = null)
+    /**
+     * @param LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface $resourceAccessChecker
+     */
+    public function __construct(protected PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, protected PropertyMetadataFactoryInterface $propertyMetadataFactory, protected LegacyIriConverterInterface|IriConverterInterface $iriConverter, protected LegacyResourceClassResolverInterface|ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, $resourceAccessChecker = null, protected ?TagCollectorInterface $tagCollector = null)
     {
         if (!isset($defaultContext['circular_reference_handler'])) {
             $defaultContext['circular_reference_handler'] = fn ($object): ?string => $this->iriConverter->getIriFromResource($object);
         }
 
         parent::__construct($classMetadataFactory, $nameConverter, null, null, \Closure::fromCallable($this->getObjectClass(...)), $defaultContext);
         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
+        $this->resourceAccessChecker = $resourceAccessChecker;
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
     }
 
diff --git a/src/Serializer/ItemNormalizer.php b/src/Serializer/ItemNormalizer.php
@@ -20,9 +20,10 @@
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
+use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface as LegacyResourceAccessCheckerInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
@@ -39,7 +40,10 @@ class ItemNormalizer extends AbstractItemNormalizer
 {
     private readonly LoggerInterface $logger;
 
-    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, LoggerInterface $logger = null, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null, array $defaultContext = [], protected ?TagCollectorInterface $tagCollector = null)
+    /**
+     * @param LegacyResourceAccessCheckerInterface|ResourceAccessCheckerInterface $resourceAccessChecker
+     */
+    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, LoggerInterface $logger = null, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null, $resourceAccessChecker = null, array $defaultContext = [], protected ?TagCollectorInterface $tagCollector = null)
     {
         parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $defaultContext, $resourceMetadataFactory, $resourceAccessChecker, $tagCollector);
 
diff --git a/src/Symfony/Security/ResourceAccessCheckerInterface.php b/src/Symfony/Security/ResourceAccessCheckerInterface.php
@@ -13,17 +13,15 @@
 
 namespace ApiPlatform\Symfony\Security;
 
+use ApiPlatform\Metadata\ResourceAccessCheckerInterface as MetadataResourceAccessCheckerInterface;
+
 /**
  * Checks if the logged user has sufficient permissions to access the given resource.
  *
+ * @deprecated use \ApiPlatform\Metadata\ResourceAccessCheckerInterface instead
+ *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-interface ResourceAccessCheckerInterface
+interface ResourceAccessCheckerInterface extends MetadataResourceAccessCheckerInterface
 {
-    /**
-     * Checks if the given item can be accessed by the current user.
-     *
-     * @param array{object?: mixed, previous_object?: mixed, request?: \Symfony\Component\HttpFoundation\Request} $extraVariables
-     */
-    public function isGranted(string $resourceClass, string $expression, array $extraVariables = []): bool;
 }
diff --git a/src/Validator/Exception/ConstraintViolationListAwareExceptionInterface.php b/src/Validator/Exception/ConstraintViolationListAwareExceptionInterface.php
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\Validator\Exception;
+
+use ApiPlatform\Metadata\Exception\ExceptionInterface;
+use Symfony\Component\Validator\ConstraintViolationListInterface;
+
+/**
+ * An exception which has a constraint violation list.
+ */
+interface ConstraintViolationListAwareExceptionInterface extends ExceptionInterface
+{
+    /**
+     * Gets constraint violations related to this exception.
+     */
+    public function getConstraintViolationList(): ConstraintViolationListInterface;
+}
