Skip to content

[HttpKernel] Renamed "pinned" to "targeted" for value resolvers #49636

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.

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

Merged
merged 1 commit into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +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\Attribute\AsTargetedValueResolver;
use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\BackedEnumValueResolver;
Expand Down Expand Up @@ -692,8 +692,8 @@ 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] : []);
$container->registerAttributeForAutoconfiguration(AsTargetedValueResolver::class, static function (ChildDefinition $definition, AsTargetedValueResolver $attribute): void {
$definition->addTag('controller.targeted_value_resolver', $attribute->name ? ['name' => $attribute->name] : []);
});

if (!$container->getParameter('kernel.debug')) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
->args([
service('argument_metadata_factory'),
abstract_arg('argument value resolvers'),
abstract_arg('pinned value resolvers'),
abstract_arg('targeted value resolvers'),
])

->set('argument_resolver.backed_enum_resolver', BackedEnumValueResolver::class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
namespace Symfony\Component\HttpKernel\Attribute;

/**
* Service tag to autoconfigure pinned value resolvers.
* Service tag to autoconfigure targeted value resolvers.
*/
#[\Attribute(\Attribute::TARGET_CLASS)]
class AsPinnedValueResolver
class AsTargetedValueResolver
{
public function __construct(
public readonly ?string $name = null,
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/HttpKernel/Attribute/ValueResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
class ValueResolver
{
/**
* @param class-string<ValueResolverInterface>|string $name
* @param class-string<ValueResolverInterface>|string $resolver
*/
public function __construct(
public string $name,
public string $resolver,
public bool $disabled = false,
) {
}
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/HttpKernel/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ CHANGELOG
* Use an instance of `Psr\Clock\ClockInterface` to generate the current date time in `DateTimeValueResolver`
* Add `#[WithLogLevel]` for defining log levels for exceptions
* Add `skip_response_headers` to the `HttpCache` options
* Introduce pinnable value resolvers with `#[ValueResolver]` and `#[AsPinnedValueResolver]`
* Introduce targeted value resolvers with `#[ValueResolver]` and `#[AsTargetedValueResolver]`

6.2
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ public function getArguments(Request $request, callable $controller, \Reflection
$resolverName = null;
foreach ($attributes as $attribute) {
if ($attribute->disabled) {
$disabledResolvers[$attribute->name] = true;
$disabledResolvers[$attribute->resolver] = true;
} elseif ($resolverName) {
throw new \LogicException(sprintf('You can only pin one resolver per argument, but argument "$%s" of "%s()" has more.', $metadata->getName(), $this->getPrettyName($controller)));
} else {
$resolverName = $attribute->name;
$resolverName = $attribute->resolver;
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ public function process(ContainerBuilder $container)
}

$definitions = $container->getDefinitions();
$namedResolvers = $this->findAndSortTaggedServices(new TaggedIteratorArgument('controller.pinned_value_resolver', 'name', needsIndexes: true), $container);
$namedResolvers = $this->findAndSortTaggedServices(new TaggedIteratorArgument('controller.targeted_value_resolver', 'name', needsIndexes: true), $container);
$resolvers = $this->findAndSortTaggedServices(new TaggedIteratorArgument('controller.argument_value_resolver', 'name', needsIndexes: true), $container);

foreach ($resolvers as $name => $resolverReference) {
$id = (string) $resolverReference;

if ($definitions[$id]->hasTag('controller.pinned_value_resolver')) {
if ($definitions[$id]->hasTag('controller.targeted_value_resolver')) {
unset($resolvers[$name]);
} else {
$namedResolvers[$name] ??= clone $resolverReference;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,13 +285,13 @@ public function testGetSessionMissMatchOnNull()
self::getResolver()->getArguments($request, $controller);
}

public function testPinnedResolver()
public function testTargetedResolver()
{
$resolver = self::getResolver([], [DefaultValueResolver::class => new DefaultValueResolver()]);

$request = Request::create('/');
$request->attributes->set('foo', 'bar');
$controller = $this->controllerPinningResolver(...);
$controller = $this->controllerTargetingResolver(...);

$this->assertSame([1], $resolver->getArguments($request, $controller));
}
Expand All @@ -307,23 +307,23 @@ public function testDisabledResolver()
$this->assertSame([1], $resolver->getArguments($request, $controller));
}

public function testManyPinnedResolvers()
public function testManyTargetedResolvers()
{
$resolver = self::getResolver(namedResolvers: []);

$request = Request::create('/');
$controller = $this->controllerPinningManyResolvers(...);
$controller = $this->controllerTargetingManyResolvers(...);

$this->expectException(\LogicException::class);
$resolver->getArguments($request, $controller);
}

public function testUnknownPinnedResolver()
public function testUnknownTargetedResolver()
{
$resolver = self::getResolver(namedResolvers: []);

$request = Request::create('/');
$controller = $this->controllerPinningUnknownResolver(...);
$controller = $this->controllerTargetingUnknownResolver(...);

$this->expectException(ResolverNotFoundException::class);
$resolver->getArguments($request, $controller);
Expand Down Expand Up @@ -369,22 +369,22 @@ public function controllerWithExtendingSession(ExtendingSession $session)
{
}

public function controllerPinningResolver(#[ValueResolver(DefaultValueResolver::class)] int $foo = 1)
public function controllerTargetingResolver(#[ValueResolver(DefaultValueResolver::class)] int $foo = 1)
{
}

public function controllerDisablingResolver(#[ValueResolver(RequestAttributeValueResolver::class, disabled: true)] int $foo = 1)
{
}

public function controllerPinningManyResolvers(
public function controllerTargetingManyResolvers(
#[ValueResolver(RequestAttributeValueResolver::class)]
#[ValueResolver(DefaultValueResolver::class)]
int $foo
) {
}

public function controllerPinningUnknownResolver(
public function controllerTargetingUnknownResolver(
#[ValueResolver('foo')]
int $bar
) {
Expand Down