8000 [HttpKernel] Customise error code on validation error occurred in #[MapRequestPayload] by siketyan · Pull Request #50993 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[HttpKernel] Customise error code on validation error occurred in #[MapRequestPayload] #50993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

[HttpKernel] Customise error code on validation error occurred in #[MapRequestPayload] #50993

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6358b2
feat: Support customising status code for MapRequestPayload on error
siketyan Jul 16, 2023
767a4b9
feat: Global configuration for the status code on error
siketyan Jul 16, 2023
685758c
test: Add tests for customising error status codes
siketyan Jul 16, 2023
91cfc83
docs: Update changelog
siketyan Jul 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat: Global configuration for the status code on error 
Signed-off-by: Natsuki Ikeguchi <me@s6n.jp>
  • Loading branch information
@siketyan
siketyan committed Jul 16, 2023
commit 767a4b9020ffb9f593be6aeba73b18071118b2e3
9 changes: 9 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,15 @@ public function getConfigTreeBuilder(): TreeBuilder
->defaultValue('error_controller')
->end()
->booleanNode('handle_all_throwables')->info('HttpKernel will handle all kinds of \Throwable')->end()
->arrayNode('map_request_payload')
->addDefaultsIfNotSet()
->children()
->scalarNode('status_code_on_error')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a usecase that requires a different default?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in #50992, sometimes we want use 400 instead of 422 in application-global. So this configuration node supports to change the HTTP status code on error globally.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, this is actually dupe of #50767, so I'll close this pull request now.

->info('HTTP status code to be returned on error occurred while parsing the request payload.')
->defaultNull()
->end()
->end()
->end()
->end()
;

Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ public function load(array $configs, ContainerBuilder $container)
$container->getDefinition('locale_listener')->replaceArgument(3, $config['set_locale_from_accept_language']);
$container->getDefinition('response_listener')->replaceArgument(1, $config['set_content_language_from_locale']);
$container->getDefinition('http_kernel')->replaceArgument(4, $config['handle_all_throwables'] ?? false);
$container->getDefinition('argument_resolver.request_payload')->replaceArgument(3, $config['map_request_payload']['status_code_on_error']);

// If the slugger is used but the String component is not available, we should throw an error
if (!ContainerBuilder::willBeAvailable('symfony/string', SluggerInterface::class, ['symfony/framework-bundle'])) {
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
service('serializer'),
service('validator')->nullOnInvalid(),
service('translator')->nullOnInvalid(),
abstract_arg('The "map_request_payload.status_code_on_error" config value'),
])
->tag('controller.targeted_value_resolver', ['name' => RequestPayloadValueResolver::class])
->tag('kernel.event_subscriber')
Expand Down
5 changes: 4 additions & 1 deletion src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ public function __construct(
private readonly SerializerInterface&DenormalizerInterface $serializer,
private readonly ?ValidatorInterface $validator = null,
private readonly ?TranslatorInterface $translator = null,
private readonly ?int $statusCodeOnError = null,
) {
}

Expand Down Expand Up @@ -91,7 +92,9 @@ public function onKernelControllerArguments(ControllerArgumentsEvent $event): vo
$validationFailedCode = Response::HTTP_NOT_FOUND;
} elseif ($argument instanceof MapRequestPayload) {
$payloadMapper = 'mapRequestPayload';
$validationFailedCode = $argument->statusCodeOnError ?? Response::HTTP_UNPROCESSABLE_ENTITY;
$validationFailedCode = $argument->statusCodeOnError
?? $this->statusCodeOnError
?? Response::HTTP_UNPROCESSABLE_ENTITY;
} else {
continue;
}
Expand Down
0