fix(symfony): provider can throw validation exception (#5586)

fixes #5585

Author: soyuka

features/main/attribute_resource.feature

@@ -103,8 +103,17 @@ Feature: Resource attributes
 
  Scenario: Uri variables with Post operation
  When I add "Content-Type" header equal to "application/ld+json"
- And I send a "POST" request to "/post_with_uri_variables/{id}" with body:
+ And I send a "POST" request to "/post_with_uri_variables_and_no_provider/{id}" with body:
  """
  {}
  """
  Then the response status code should be 201
+
+ Scenario: Throw validation exception in a provider
+ When I add "Content-Type" header equal to "application/ld+json"
+ And I send a "POST" request to "/post_with_uri_variables/{id}" with body:
+ """
+ {}
+ """
+ Then the response status code should be 422
+

src/State/CallableProvider.php

@@ -13,8 +13,8 @@
 
 namespace ApiPlatform\State;
 
-use ApiPlatform\Exception\RuntimeException;
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\Exception\ProviderNotFoundException;
 use Psr\Container\ContainerInterface;
 
 final class CallableProvider implements ProviderInterface
@@ -34,7 +34,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
  if (\is_string($provider)) {
  if (!$this->locator->has($provider)) {
- throw new RuntimeException(sprintf('Provider "%s" not found on operation "%s"', $provider, $operation->getName()));
+ throw new ProviderNotFoundException(sprintf('Provider "%s" not found on operation "%s"', $provider, $operation->getName()));
  }
 
  /** @var ProviderInterface $providerInstance */
@@ -43,6 +43,6 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
  return $providerInstance->provide($operation, $uriVariables, $context);
  }
 
- throw new RuntimeException(sprintf('Provider not found on operation "%s"', $operation->getName()));
+ throw new ProviderNotFoundException(sprintf('Provider not found on operation "%s"', $operation->getName()));
  }
 }

src/State/Exception/ProviderNotFoundException.php

@@ -0,0 +1,20 @@
+<?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\State\Exception;
+
+use ApiPlatform\Metadata\Exception\RuntimeException;
+
+final class ProviderNotFoundException extends RuntimeException
+{
+}

src/Symfony/EventListener/ReadListener.php

@@ -16,11 +16,11 @@
 use ApiPlatform\Api\UriVariablesConverterInterface;
 use ApiPlatform\Exception\InvalidIdentifierException;
 use ApiPlatform\Exception\InvalidUriVariableException;
-use ApiPlatform\Exception\RuntimeException;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Put;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Serializer\SerializerContextBuilderInterface;
+use ApiPlatform\State\Exception\ProviderNotFoundException;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\UriVariablesResolverTrait;
 use ApiPlatform\Util\CloneTrait;
@@ -93,7 +93,7 @@ public function onKernelRequest(RequestEvent $event): void
  $data = $this->provider->provide($operation, $uriVariables, $context);
  } catch (InvalidIdentifierException|InvalidUriVariableException $e) {
  throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
- } catch (RuntimeException $e) {
+ } catch (ProviderNotFoundException $e) {
  $data = null;
  }
 

tests/Fixtures/TestBundle/ApiResource/PostWithUriVariables.php

@@ -16,9 +16,12 @@
 use ApiPlatform\Metadata\NotExposed;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Post;
+use ApiPlatform\Symfony\Validator\Exception\ValidationException as ExceptionValidationException;
+use Symfony\Component\Validator\ConstraintViolationList;
 
 #[NotExposed(uriTemplate: '/post_with_uri_variables/{id}')]
-#[Post(uriTemplate: '/post_with_uri_variables/{id}', uriVariables: ['id'], processor: [PostWithUriVariables::class, 'process'])]
+#[Post(uriTemplate: '/post_with_uri_variables_and_no_provider/{id}', uriVariables: ['id'], processor: [PostWithUriVariables::class, 'process'])]
+#[Post(uriTemplate: '/post_with_uri_variables/{id}', uriVariables: ['id'], provider: [PostWithUriVariables::class, 'provide'])]
 final class PostWithUriVariables
 {
  public function __construct(public readonly ?int $id = null)
@@ -29,4 +32,9 @@ public static function process(mixed $data, Operation $operation, array $uriVari
  {
  return new self(id: 1);
  }
+
+ public static function provide(Operation $operation, array $uriVariables = [], array $context = []): void
+ {
+ throw new ExceptionValidationException(new ConstraintViolationList());
+ }
 }