feature #48992 [HttpKernel] Introduce pinnable value resolvers with #[ValueResolver] and #[AsPinnedValueResolver] (MatTheCat)

This PR was merged into the 6.3 branch.

Discussion
----------

[HttpKernel] Introduce pinnable value resolvers with `#[ValueResolver]` and `#[AsPinnedValueResolver]`

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | Fix #48927
| License       | MIT
| Doc PR        | symfony/symfony-docs#17763

Introducing a new `ValueResolver` attribute, which allows to
- “pin” a value resolver to an argument, meaning only said resolver will be called
- prevent a resolver to be called for an argument

Every existing resolver-related attribute (`MapEntity`, `CurrentUser`…) now extends `ValueResolver`.

Each `controller.argument_value_resolver` tag is added a `name` attribute, which is the resolver’s FQCN. This is the first argument `ValueResolver` expects.

A new  `AsPinnedValueResolver` attribute is added for autoconfiguration, adding the `controller.pinned_value_resolver` tag. Such resolvers can only be “pinned”, meaning they won’t ever be called for an argument missing the `ValueResolver` attribute.

Commits
-------

245485c2a7 [HttpKernel] Introduce pinnable value resolvers with `#[ValueResolver]` and `#[AsPinnedValueResolver]`

Author: nicolas-grekas

DependencyInjection/FrameworkExtension.php

@@ -83,6 +83,7 @@
 use Symfony\Component\HttpClient\UriTemplateHttpClient;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Attribute\AsController;
+use Symfony\Component\HttpKernel\Attribute\AsPinnedValueResolver;
 use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\BackedEnumValueResolver;
@@ -691,6 +692,10 @@ public function load(array $configs, ContainerBuilder $container)
             $definition->addTag('messenger.message_handler', $tagAttributes);
         });
 
+        $container->registerAttributeForAutoconfiguration(AsPinnedValueResolver::class, static function (ChildDefinition $definition, AsPinnedValueResolver $attribute): void {
+            $definition->addTag('controller.pinned_value_resolver', $attribute->name ? ['name' => $attribute->name] : []);
+        });
+
         if (!$container->getParameter('kernel.debug')) {
             // remove tagged iterator argument for resource checkers
             $container->getDefinition('config_cache_factory')->setArguments([]);

Resources/config/web.php

@@ -46,40 +46,41 @@
             ->args([
                 service('argument_metadata_factory'),
                 abstract_arg('argument value resolvers'),
+                abstract_arg('pinned value resolvers'),
             ])
 
         ->set('argument_resolver.backed_enum_resolver', BackedEnumValueResolver::class)
-            ->tag('controller.argument_value_resolver', ['priority' => 100])
+            ->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => BackedEnumValueResolver::class])
 
         ->set('argument_resolver.uid', UidValueResolver::class)
-            ->tag('controller.argument_value_resolver', ['priority' => 100])
+            ->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => UidValueResolver::class])
 
         ->set('argument_resolver.datetime', DateTimeValueResolver::class)
             ->args([
                 service('clock')->nullOnInvalid(),
             ])
-            ->tag('controller.argument_value_resolver', ['priority' => 100])
+            ->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => DateTimeValueResolver::class])
 
         ->set('argument_resolver.request_attribute', RequestAttributeValueResolver::class)
-            ->tag('controller.argument_value_resolver', ['priority' => 100])
+            ->tag('controller.argument_value_resolver', ['priority' => 100, 'name' => RequestAttributeValueResolver::class])
 
         ->set('argument_resolver.request', RequestValueResolver::class)
-            ->tag('controller.argument_value_resolver', ['priority' => 50])
+            ->tag('controller.argument_value_resolver', ['priority' => 50, 'name' => RequestValueResolver::class])
 
         ->set('argument_resolver.session', SessionValueResolver::class)
-            ->tag('controller.argument_value_resolver', ['priority' => 50])
+            ->tag('controller.argument_value_resolver', ['priority' => 50, 'name' => SessionValueResolver::class])
 
         ->set('argument_resolver.service', ServiceValueResolver::class)
             ->args([
                 abstract_arg('service locator, set in RegisterControllerArgumentLocatorsPass'),
             ])
-            ->tag('controller.argument_value_resolver', ['priority' => -50])
+            ->tag('controller.argument_value_resolver', ['priority' => -50, 'name' => ServiceValueResolver::class])
 
         ->set('argument_resolver.default', DefaultValueResolver::class)
-            ->tag('controller.argument_value_resolver', ['priority' => -100])
+            ->tag('controller.argument_value_resolver', ['priority' => -100, 'name' => DefaultValueResolver::class])
 
         ->set('argument_resolver.variadic', VariadicValueResolver::class)
-            ->tag('controller.argument_value_resolver', ['priority' => -150])
+            ->tag('controller.argument_value_resolver', ['priority' => -150, 'name' => VariadicValueResolver::class])
 
         ->set('response_listener', ResponseListener::class)
             ->args([