Skip to content

Commit

Permalink
fix: attribute validation groups not passed (#2189)
Browse files Browse the repository at this point in the history 
* fix: attribute validation groups not passed

* add test cases

* fix baseline
  • Loading branch information
@DjordyKoert
DjordyKoert committed Jan 15, 2024
1 parent 9b642df commit 2360674
Show file tree
Hide file tree
Showing 5 changed files with 150 additions and 0 deletions.
26 changes: 26 additions & 0 deletions RouteDescriber/RouteArgumentDescriber/SymfonyMapQueryStringDescriber.php
View file
Expand Up @@ -11,6 +11,7 @@
use Symfony\Component\HttpKernel\Attribute\MapQueryString;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\Validator\Constraints\GroupSequence;

final class SymfonyMapQueryStringDescriber implements RouteArgumentDescriberInterface, ModelRegistryAwareInterface
{
Expand All @@ -28,10 +29,35 @@ public function describe(ArgumentMetadata $argumentMetadata, OA\Operation $opera

$modelRef = $this->modelRegistry->register(new Model(
new Type(Type::BUILTIN_TYPE_OBJECT, $argumentMetadata->isNullable(), $argumentMetadata->getType()),
groups: $this->getGroups($attribute),
serializationContext: $attribute->serializationContext,
));

$operation->_context->{self::CONTEXT_ARGUMENT_METADATA} = $argumentMetadata;
$operation->_context->{self::CONTEXT_MODEL_REF} = $modelRef;
}

/**
* @return string[]|null
*/
private function getGroups(MapQueryString $attribute): ?array
{
if (null === $attribute->validationGroups) {
return null;
}

if (is_string($attribute->validationGroups)) {
return [$attribute->validationGroups];
}

if (is_array($attribute->validationGroups)) {
return $attribute->validationGroups;
}

if ($attribute->validationGroups instanceof GroupSequence) {
return $attribute->validationGroups->groups;
}

return null;
}
}
26 changes: 26 additions & 0 deletions RouteDescriber/RouteArgumentDescriber/SymfonyMapRequestPayloadDescriber.php
View file
Expand Up @@ -11,6 +11,7 @@
use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\Validator\Constraints\GroupSequence;

final class SymfonyMapRequestPayloadDescriber implements RouteArgumentDescriberInterface, ModelRegistryAwareInterface
{
Expand All @@ -28,10 +29,35 @@ public function describe(ArgumentMetadata $argumentMetadata, OA\Operation $opera

$modelRef = $this->modelRegistry->register(new Model(
new Type(Type::BUILTIN_TYPE_OBJECT, false, $argumentMetadata->getType()),
groups: $this->getGroups($attribute),
serializationContext: $attribute->serializationContext,
));

$operation->_context->{self::CONTEXT_ARGUMENT_METADATA} = $argumentMetadata;
$operation->_context->{self::CONTEXT_MODEL_REF} = $modelRef;
}

/**
* @return string[]|null
*/
private function getGroups(MapRequestPayload $attribute): ?array
{
if (null === $attribute->validationGroups) {
return null;
}

if (is_string($attribute->validationGroups)) {
return [$attribute->validationGroups];
}

if (is_array($attribute->validationGroups)) {
return $attribute->validationGroups;
}

if ($attribute->validationGroups instanceof GroupSequence) {
return $attribute->validationGroups->groups;
}

return null;
}
}
14 changes: 14 additions & 0 deletions Tests/Functional/Controller/ApiController81.php
View file
Expand Up @@ -478,6 +478,13 @@ public function fetchArticleFromMapQueryStringNullable(
) {
}

#[Route('/article_map_query_string_passes_validation_groups')]
#[OA\Response(response: '200', description: '')]
public function fetchArticleFromMapQueryStringHandlesValidationGroups(
#[MapQueryString(validationGroups: ['test'])] SymfonyConstraintsWithValidationGroups $symfonyConstraintsWithValidationGroups,
) {
}

#[Route('/article_map_query_string_overwrite_parameters')]
#[OA\Parameter(
name: 'id',
Expand Down Expand Up @@ -590,4 +597,11 @@ public function createArticleFromMapRequestPayloadHandlesAlreadySetContent(
#[MapRequestPayload] Article81 $article81,
) {
}

#[Route('/article_map_request_payload_validation_groups', methods: ['POST'])]
#[OA\Response(response: '200', description: '')]
public function createArticleFromMapRequestPayloadPassedValidationGroups(
#[MapRequestPayload(validationGroups: ['test'])] SymfonyConstraintsWithValidationGroups $symfonyConstraintsWithValidationGroups,
) {
}
}
54 changes: 54 additions & 0 deletions Tests/Functional/SymfonyFunctionalTest.php
View file
Expand Up @@ -488,4 +488,58 @@ public function testMapRequestPayloadHandlesAlreadySetContent(): void
],
], json_decode($this->getOperation('/api/article_map_request_payload_handles_already_set_content', 'post')->toJson(), true));
}

public function testMapRequestPayloadPassesValidationGroups(): void
{
if (!class_exists(MapRequestPayload::class)) {
self::markTestSkipped('Symfony 6.3 MapRequestPayload attribute not found');
}

self::assertEquals([
'operationId' => 'post_api_nelmio_apidoc_tests_functional_api_createarticlefrommaprequestpayloadpassedvalidationgroups',
'responses' => [
'200' => [
'description' => '',
],
],
'requestBody' => [
'content' => [
'application/json' => [
'schema' => [
'$ref' => '#/components/schemas/SymfonyConstraintsTestGroup',
],
],
],
'required' => true,
],
], json_decode($this->getOperation('/api/article_map_request_payload_validation_groups', 'post')->toJson(), true));
}

public function testMapQueryStringPassesValidationGroups(): void
{
if (!class_exists(MapQueryString::class)) {
self::markTestSkipped('Symfony 6.3 MapQueryString attribute not found');
}

self::assertEquals([
'operationId' => 'post_api_nelmio_apidoc_tests_functional_api_fetcharticlefrommapquerystringhandlesvalidationgroups',
'responses' => [
'200' => [
'description' => '',
],
],
'parameters' => [
[
'name' => 'property',
'in' => 'query',
'required' => true,
'schema' => [
'type' => 'integer',
'maximum' => 100,
'minimum' => 1,
],
],
],
], json_decode($this->getOperation('/api/article_map_query_string_passes_validation_groups', 'post')->toJson(), true));
}
}
30 changes: 30 additions & 0 deletions phpunit-baseline.json
View file
Expand Up @@ -7143,5 +7143,35 @@
"location": "Nelmio\\ApiDocBundle\\Tests\\Functional\\SymfonyFunctionalTest::testMapRequestPayloadHandlesAlreadySetContent",
"message": "Since sensio/framework-extra-bundle 5.2: The \"sensio_framework_extra.routing.loader.annot_file\" service is deprecated since version 5.2",
"count": 1
},
{
"location": "Nelmio\\ApiDocBundle\\Tests\\Functional\\SymfonyFunctionalTest::testMapRequestPayloadPassesValidationGroups",
"message": "Since sensio/framework-extra-bundle 5.2: The \"sensio_framework_extra.routing.loader.annot_class\" service is deprecated since version 5.2",
"count": 1
},
{
"location": "Nelmio\\ApiDocBundle\\Tests\\Functional\\SymfonyFunctionalTest::testMapRequestPayloadPassesValidationGroups",
"message": "Since sensio/framework-extra-bundle 5.2: The \"sensio_framework_extra.routing.loader.annot_dir\" service is deprecated since version 5.2",
"count": 1
},
{
"location": "Nelmio\\ApiDocBundle\\Tests\\Functional\\SymfonyFunctionalTest::testMapRequestPayloadPassesValidationGroups",
"message": "Since sensio/framework-extra-bundle 5.2: The \"sensio_framework_extra.routing.loader.annot_file\" service is deprecated since version 5.2",
"count": 1
},
{
"location": "Nelmio\\ApiDocBundle\\Tests\\Functional\\SymfonyFunctionalTest::testMapQueryStringPassesValidationGroups",
"message": "Since sensio/framework-extra-bundle 5.2: The \"sensio_framework_extra.routing.loader.annot_class\" service is deprecated since version 5.2",
"count": 1
},
{
"location": "Nelmio\\ApiDocBundle\\Tests\\Functional\\SymfonyFunctionalTest::testMapQueryStringPassesValidationGroups",
"message": "Since sensio/framework-extra-bundle 5.2: The \"sensio_framework_extra.routing.loader.annot_dir\" service is deprecated since version 5.2",
"count": 1
},
{
"location": "Nelmio\\ApiDocBundle\\Tests\\Functional\\SymfonyFunctionalTest::testMapQueryStringPassesValidationGroups",
"message": "Since sensio/framework-extra-bundle 5.2: The \"sensio_framework_extra.routing.loader.annot_file\" service is deprecated since version 5.2",
"count": 1
}
]

0 comments on commit 2360674

Please sign in to comment.