Skip to content

Extract the ArgumentResolver system to its own component #59794

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

Open
wants to merge 3 commits into
base: 7.3
Choose a base branch
from
+2,619 −473
Open

Extract the ArgumentResolver system to its own component #59794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fbfae9a
Adding the ArgumentResolver component
chalasr Jan 9, 2025
d29f355
Rework
chalasr Feb 21, 2025
f28fb52
Experimenting ways to abstract the input source
chalasr Mar 5, 2025
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
18 changes: 17 additions & 1 deletion src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
use Symfony\Component\HttpKernel\Attribute\AsTargetedValueResolver;
use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ControllerValueResolverInterface;
use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
Expand Down Expand Up @@ -246,12 +247,14 @@ public function load(array $configs, ContainerBuilder $container): void
$container->setParameter('validator.translation_domain', 'validators');
}

$loader->load('argument_resolver.php');
$loader->load('web.php');
$loader->load('services.php');
$loader->load('fragment_renderer.php');
$loader->load('error_renderer.php');

if (!ContainerBuilder::willBeAvailable('symfony/clock', ClockInterface::class, ['symfony/framework-bundle'])) {
$container->removeDefinition('clock');
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
$container->removeDefinition('clock');

$container->removeDefinition('clock');
$container->removeAlias(ClockInterface::class);
$container->removeAlias(PsrClockInterface::class);
Expand Down Expand Up @@ -425,6 +428,7 @@ public function load(array $configs, ContainerBuilder $container): void

$this->registerSerializerConfiguration($config['serializer'], $container, $loader);
} else {
// @deprecated since Symfony 7.3
$container->getDefinition('argument_resolver.request_payload')
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can leverage setDeprecated as well?

->setArguments([])
->addError('You can neither use "#[MapRequestPayload]" nor "#[MapQueryString]" since the Serializer component is not '
Expand All @@ -433,6 +437,14 @@ public function load(array $configs, ContainerBuilder $container): void
->addTag('container.error')
->clearTag('kernel.event_subscriber');

/*$container->getDefinition('argument_resolver.controller.request_payload')
->setArguments([])
->addError('You can neither use "#[MapRequestPayload]" nor "#[MapQueryString]" since the Serializer component is not '
.(class_exists(Serializer::class) ? 'enabled. Try setting "framework.serializer.enabled" to true.' : 'installed. Try running "composer require symfony/serializer-pack".')
)
->addTag('container.error')
->clearTag('kernel.event_subscriber');
*/
$container->removeDefinition('console.command.serializer_debug');
}

Expand Down Expand Up @@ -483,7 +495,8 @@ public function load(array $configs, ContainerBuilder $container): void

$this->registerUidConfiguration($config['uid'], $container, $loader);
} else {
$container->removeDefinition('argument_resolver.uid');
$container->removeDefinition('argument_resolver.uid'); // @deprecated since Symfony 7.3
$container->removeDefinition('argument_resolver.controller.uid');
}

// register cache before session so both can share the connection services
Expand Down Expand Up @@ -644,6 +657,9 @@ public function load(array $configs, ContainerBuilder $container): void
->addTag('container.service_locator');
$container->registerForAutoconfiguration(ServiceSubscriberInterface::class)
->addTag('container.service_subscriber');
$container->registerForAutoconfiguration(ControllerValueResolverInterface::class)
->addTag('controller.argument_value_resolver');
// @deprecated since Symfony 7.3
$container->registerForAutoconfiguration(ValueResolverInterface::class)
->addTag('controller.argument_value_resolver');
$container->registerForAutoconfiguration(AbstractController::class)
Expand Down
24 changes: 24 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/argument_resolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\ArgumentResolver\ArgumentMetadata\ArgumentMetadataFactory;
use Symfony\Component\ArgumentResolver\ValueResolver\DefaultValueResolver;

return static function (ContainerConfigurator $container) {
$container->services()
->set('argument_resolver.argument_metadata_factory', ArgumentMetadataFactory::class)

->set('argument_resolver.default', DefaultValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => -100, 'name' => DefaultValueResolver::class])
;
};
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Resources/config/debug.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
])

->set('debug.argument_resolver', TraceableArgumentResolver::class)
->decorate('argument_resolver')
->decorate('controller.argument_resolver')
->args([
service('debug.argument_resolver.inner'),
service('debug.stopwatch'),
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class_exists(WorkflowEvents::class) ? WorkflowEvents::ALIASES : []
service('event_dispatcher'),
service('controller_resolver'),
service('request_stack'),
service('argument_resolver'),
service('controller.argument_resolver'),
false,
])
->tag('container.hot_path')
Expand Down
147 changes: 114 additions & 33 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 @@ -14,18 +14,29 @@
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver;
use Symfony\Bundle\FrameworkBundle\Controller\TemplateController;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\BackedEnumValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DateTimeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\QueryParameterValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestPayloadValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\UidValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver;
use Symfony\Component\ArgumentResolver\ValueResolver\DefaultValueResolver;
use Symfony\Component\ArgumentResolver\ValueResolver\ServiceValueResolver;
use Symfony\Component\ArgumentResolver\ValueResolver\UidValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\BackedEnumValueResolver as LegacyBackedEnumValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DateTimeValueResolver as LegacyDateTimeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver as LegacyDefaultValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\QueryParameterValueResolver as LegacyQueryParameterValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver as LegacyRequestAttributeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestPayloadValueResolver as LegacyRequestPayloadValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver as LegacyRequestValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver as LegacyServiceValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver as LegacySessionValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\UidValueResolver as LegacyUidValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\BackedEnumValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\DateTimeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\QueryParameterValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\RequestAttributeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\RequestPayloadValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\RequestValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\SessionValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ValueResolver\VariadicValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver as LegacyVariadicValueResolver;
use Symfony\Component\HttpKernel\Controller\ControllerArgumentResolver;
use Symfony\Component\HttpKernel\Controller\ErrorController;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory;
use Symfony\Component\HttpKernel\EventListener\CacheAttributeListener;
Expand All @@ -45,28 +56,97 @@
->call('allowControllers', [[AbstractController::class, TemplateController::class]])
->tag('monolog.logger', ['channel' => 'request'])

# Deprecated Argument Resolver and Value Resolvers
->set('argument_metadata_factory', ArgumentMetadataFactory::class)
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.argument_metadata_factory" instead.')

->set('argument_resolver', ArgumentResolver::class)
->set('argument_resolver', \Symfony\Component\HttpKernel\Controller\ArgumentResolver::class)
->args([
service('argument_metadata_factory'),
abstract_arg('argument value resolvers'),
abstract_arg('targeted value resolvers'),
])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller" instead.')

->set('argument_resolver.backed_enum_resolver', BackedEnumValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => BackedEnumValueResolver::class])
->set('argument_resolver.backed_enum_resolver', LegacyBackedEnumValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => LegacyBackedEnumValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.backed_enum" instead.')

->set('argument_resolver.uid', UidValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => UidValueResolver::class])
->set('argument_resolver.uid', LegacyUidValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => LegacyUidValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.uid" instead.')

->set('argument_resolver.datetime', DateTimeValueResolver::class)
->set('argument_resolver.datetime', LegacyDateTimeValueResolver::class)
->args([
service('clock')->nullOnInvalid(),
])
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => DateTimeValueResolver::class])
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => LegacyDateTimeValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.datetime" instead.')

->set('argument_resolver.request_payload', RequestPayloadValueResolver::class)
->set('argument_resolver.request_payload', LegacyRequestPayloadValueResolver::class)
->args([
service('serializer'),
service('validator')->nullOnInvalid(),
service('translator')->nullOnInvalid(),
param('validator.translation_domain'),
])
->tag('controller.targeted_value_resolver', ['name' => LegacyRequestPayloadValueResolver::class])
->tag('kernel.event_subscriber')
->lazy()

->set('argument_resolver.request_attribute', LegacyRequestAttributeValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => LegacyRequestAttributeValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.request_attribute" instead.')

->set('argument_resolver.request', LegacyRequestValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 50, 'name' => LegacyRequestValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.request" instead.')

->set('argument_resolver.session', LegacySessionValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 50, 'name' => LegacySessionValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.session" instead.')

->set('argument_resolver.service', LegacyServiceValueResolver::class)
->args([
abstract_arg('service locator, set in RegisterControllerArgumentLocatorsPass'),
])
->tag('controller.argument_value_resolver', ['priority' => -50, 'name' => LegacyServiceValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.service" instead.')

->set('argument_resolver.default', LegacyDefaultValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => -100, 'name' => LegacyDefaultValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.default" instead.')

->set('argument_resolver.variadic', LegacyVariadicValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => -150, 'name' => LegacyVariadicValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.variadic" instead.')

->set('argument_resolver.query_parameter_value_resolver', LegacyQueryParameterValueResolver::class)
->tag('controller.targeted_value_resolver', ['name' => LegacyQueryParameterValueResolver::class])
->deprecate('symfony/framework-bundle', '7.3', 'The "%service_id%" service is deprecated, use "argument_resolver.controller.query_parameter" instead.')

# Controller Argument Resolver and Value Resolvers
->set('controller.argument_resolver', ControllerArgumentResolver::class)
->args([
service('argument_resolver.argument_metadata_factory'),
abstract_arg('argument value resolvers'),
abstract_arg('targeted value resolvers'),
])

/*
->set('argument_resolver.controller.backed_enum', BackedEnumValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => 100, 'name' => BackedEnumValueResolver::class])

->set('argument_resolver.controller.uid', UidValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => 100, 'name' => UidValueResolver::class])

->set('argument_resolver.controller.datetime', DateTimeValueResolver::class)
->args([
service('clock')->nullOnInvalid(),
])
->tag('argument_resolver.controller.value_resolver', ['priority' => 100, 'name' => DateTimeValueResolver::class])

->set('argument_resolver.controller.request_payload', RequestPayloadValueResolver::class)
->args([
service('serializer'),
service('validator')->nullOnInvalid(),
Expand All @@ -77,29 +157,30 @@
->tag('kernel.event_subscriber')
->lazy()

->set('argument_resolver.request_attribute', RequestAttributeValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => RequestAttributeValueResolver::class])
->set('argument_resolver.controller.request_attribute', RequestAttributeValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => 100, 'name' => RequestAttributeValueResolver::class])

->set('argument_resolver.request', RequestValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 50, 'name' => RequestValueResolver::class])
->set('argument_resolver.controller.request', RequestValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => 50, 'name' => RequestValueResolver::class])

->set('argument_resolver.session', SessionValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 50, 'name' => SessionValueResolver::class])
->set('argument_resolver.controller.session', SessionValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => 50, 'name' => SessionValueResolver::class])

->set('argument_resolver.service', ServiceValueResolver::class)
->set('argument_resolver.controller.service', ServiceValueResolver::class)
->args([
abstract_arg('service locator, set in RegisterControllerArgumentLocatorsPass'),
])
->tag('controller.argument_value_resolver', ['priority' => -50, 'name' => ServiceValueResolver::class])
->tag('argument_resolver.controller.value_resolver', ['priority' => -50, 'name' => ServiceValueResolver::class])

->set('argument_resolver.default', DefaultValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => -100, 'name' => DefaultValueResolver::class])
->set('argument_resolver.controller.default', DefaultValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => -100, 'name' => DefaultValueResolver::class])

->set('argument_resolver.variadic', VariadicValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => -150, 'name' => VariadicValueResolver::class])
->set('argument_resolver.controller.variadic', VariadicValueResolver::class)
->tag('argument_resolver.controller.value_resolver', ['priority' => -150, 'name' => VariadicValueResolver::class])

->set('argument_resolver.query_parameter_value_resolver', QueryParameterValueResolver::class)
->set('argument_resolver.controller.query_parameter_value_resolver', QueryParameterValueResolver::class)
->tag('controller.targeted_value_resolver', ['name' => QueryParameterValueResolver::class])
*/

->set('response_listener', ResponseListener::class)
->args([
Expand Down
3 changes: 3 additions & 0 deletions src/Symfony/Component/ArgumentResolver/.gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/Tests export-ignore
/phpunit.xml.dist export-ignore
/.git* export-ignore
8 changes: 8 additions & 0 deletions src/Symfony/Component/ArgumentResolver/.github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading