symfony/archived-symfony
1
0
Fork 0
mirror of https://github.com/symfony/symfony.git synced 2026-03-24 00:32:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

[HttpKernel] Add argument $mapWhenEmpty to MapQueryString and MapRequestPayload for always attempting denormalization with empty query and request payload

Browse Source
This commit is contained in:
Jeroeny
2023-10-18 11:34:36 +02:00
committed by Nicolas Grekas
parent e467d6bfc9
commit 5117bb6f17
5 changed files with 72 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Symfony/Component/HttpKernel/Attribute/MapQueryString.php
View File

@@ -41,6 +41,7 @@ class MapQueryString extends ValueResolver
string $resolver = RequestPayloadValueResolver::class,
public readonly int $validationFailedStatusCode = Response::HTTP_NOT_FOUND,
public readonly ?string $key = null,
public bool $mapWhenEmpty = false,
) {
parent::__construct($resolver);
}

1
src/Symfony/Component/HttpKernel/Attribute/MapRequestPayload.php
View File

@@ -44,6 +44,7 @@ class MapRequestPayload extends ValueResolver
string $resolver = RequestPayloadValueResolver::class,
public readonly int $validationFailedStatusCode = Response::HTTP_UNPROCESSABLE_ENTITY,
public readonly ?string $type = null,
public bool $mapWhenEmpty = false,
) {
parent::__construct($resolver);
}

1
src/Symfony/Component/HttpKernel/CHANGELOG.md
View File

@@ -23,6 +23,7 @@ CHANGELOG
* Deprecate passing a `ControllerArgumentsEvent` to the `ViewEvent` constructor; pass a `ControllerArgumentsMetadata` instead
* Support variadic argument with `#[MapRequestPayload]`
* Add `#[Serialize]` to serialize values returned by controllers
* Add argument `$mapWhenEmpty` to `MapQueryString` and `MapRequestPayload` for always attempting denormalization with empty query and request payload
8.0
---

10
src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php
View File

@@ -202,7 +202,7 @@ class RequestPayloadValueResolver implements ValueResolverInterface, EventSubscr
private function mapQueryString(Request $request, ArgumentMetadata $argument, MapQueryString $attribute): ?object
{
if (!($data = $request->query->all($attribute->key)) && ($argument->isNullable() || $argument->hasDefaultValue())) {
if (!($data = $request->query->all($attribute->key)) && ($argument->isNullable() || $argument->hasDefaultValue()) && !$attribute->mapWhenEmpty) {
return null;
}
@@ -211,8 +211,12 @@ class RequestPayloadValueResolver implements ValueResolverInterface, EventSubscr
private function mapRequestPayload(Request $request, ArgumentMetadata $argument, MapRequestPayload $attribute): object|array|null
{
if ('' === ($data = $request->request->all() ?: $request->getContent()) && ($argument->isNullable() || $argument->hasDefaultValue())) {
return null;
if ('' === $data = $request->request->all() ?: $request->getContent()) {
if ($attribute->mapWhenEmpty) {
$data = [];
} elseif ($argument->isNullable() || $argument->hasDefaultValue()) {
return null;
}
}
if (null === $format = $request->getContentTypeFormat()) {

62
src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/RequestPayloadValueResolverTest.php
View File

@@ -165,6 +165,46 @@ class RequestPayloadValueResolverTest extends TestCase
$this->assertSame([null], $event->getArguments());
}
public function testMapQueryStringEmpty()
{
$payload = new RequestPayload(50);
$denormalizer = new RequestPayloadDenormalizer($payload);
$serializer = new Serializer([$denormalizer]);
$resolver = new RequestPayloadValueResolver($serializer);
$argument = new ArgumentMetadata('valid', RequestPayload::class, false, false, null, false, [
MapQueryString::class => new MapQueryString(mapWhenEmpty: true),
]);
$request = Request::create('/', 'GET');
$kernel = $this->createStub(HttpKernelInterface::class);
$arguments = $resolver->resolve($request, $argument);
$event = new ControllerArgumentsEvent($kernel, static fn () => null, $arguments, $request, HttpKernelInterface::MAIN_REQUEST);
$resolver->onKernelControllerArguments($event);
$this->assertSame([$payload], $event->getArguments());
}
public function testMapRequestPayloadEmpty()
{
$payload = new RequestPayload(50);
$denormalizer = new RequestPayloadDenormalizer($payload);
$serializer = new Serializer([$denormalizer]);
$resolver = new RequestPayloadValueResolver($serializer);
$argument = new ArgumentMetadata('valid', RequestPayload::class, false, false, null, false, [
MapRequestPayload::class => new MapRequestPayload(mapWhenEmpty: true),
]);
$request = Request::create('/', 'POST');
$kernel = $this->createStub(HttpKernelInterface::class);
$arguments = $resolver->resolve($request, $argument);
$event = new ControllerArgumentsEvent($kernel, static fn () => null, $arguments, $request, HttpKernelInterface::MAIN_REQUEST);
$resolver->onKernelControllerArguments($event);
$this->assertSame([$payload], $event->getArguments());
}
public function testNullPayloadAndNotDefaultOrNullableArgument()
{
$validator = $this->createMock(ValidatorInterface::class);
@@ -1415,3 +1455,25 @@ class FormPayloadWithBool
{
}
}
class RequestPayloadDenormalizer implements DenormalizerInterface
{
public function __construct(private RequestPayload $payload)
{
}
public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): mixed
{
return $this->payload;
}
public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []): bool
{
return RequestPayload::class === $type;
}
public function getSupportedTypes(?string $format = null): array
{
return [RequestPayload::class => true];
}
}