Skip to content

Fix registering traceable voters, argument resolvers and normalizers #50158

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
May 2, 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 @@ -56,7 +56,7 @@ public function process(ContainerBuilder $container)
}

if ($debug) {
$voterServices[] = new Reference($debugVoterServiceId = 'debug.security.voter.'.$voterServiceId);
$voterServices[] = new Reference($debugVoterServiceId = '.debug.security.voter.'.$voterServiceId);

$container
->register($debugVoterServiceId, TraceableVoter::class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,11 @@ public function testThatVotersAreTraceableInDebugMode()
$compilerPass = new AddSecurityVotersPass();
$compilerPass->process($container);

$def1 = $container->getDefinition('debug.security.voter.voter1');
$def1 = $container->getDefinition('.debug.security.voter.voter1');
$this->assertNull($def1->getDecoratedService(), 'voter1: should not be decorated');
$this->assertEquals(new Reference('voter1'), $def1->getArgument(0), 'voter1: wrong argument');

$def2 = $container->getDefinition('debug.security.voter.voter2');
$def2 = $container->getDefinition('.debug.security.voter.voter2');
$this->assertNull($def2->getDecoratedService(), 'voter2: should not be decorated');
$this->assertEquals(new Reference('voter2'), $def2->getArgument(0), 'voter2: wrong argument');

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,30 +43,30 @@ public function process(ContainerBuilder $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.targeted_value_resolver')) {
foreach ($resolvers as $name => $resolver) {
if ($definitions[(string) $resolver]->hasTag('controller.targeted_value_resolver')) {
unset($resolvers[$name]);
} else {
$namedResolvers[$name] ??= clone $resolverReference;
$namedResolvers[$name] ??= clone $resolver;
}
}

$resolvers = array_values($resolvers);

if ($container->getParameter('kernel.debug') && class_exists(Stopwatch::class) && $container->has('debug.stopwatch')) {
foreach ($resolvers + $namedResolvers as $resolverReference) {
$id = (string) $resolverReference;
$container->register("debug.$id", TraceableValueResolver::class)
->setDecoratedService($id)
->setArguments([new Reference("debug.$id.inner"), new Reference('debug.stopwatch')]);
foreach ($resolvers as $name => $resolver) {
$resolvers[$name] = new Reference('.debug.value_resolver.'.$resolver);
$container->register('.debug.value_resolver.'.$resolver, TraceableValueResolver::class)
->setArguments([$resolver, new Reference('debug.stopwatch')]);
}
foreach ($namedResolvers as $name => $resolver) {
$namedResolvers[$name] = new Reference('.debug.value_resolver.'.$resolver);
$container->register('.debug.value_resolver.'.$resolver, TraceableValueResolver::class)
->setArguments([$resolver, new Reference('debug.stopwatch')]);
}
}

$container
->getDefinition('argument_resolver')
->replaceArgument(1, new IteratorArgument($resolvers))
->replaceArgument(1, new IteratorArgument(array_values($resolvers)))
->setArgument(2, new ServiceLocatorArgument($namedResolvers))
;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ public function testInDebugWithStopWatchDefinition()
];

$expected = [
new Reference('n1'),
new Reference('n2'),
new Reference('n3'),
new Reference('.debug.value_resolver.n1'),
new Reference('.debug.value_resolver.n2'),
new Reference('.debug.value_resolver.n3'),
];

$definition = new Definition(ArgumentResolver::class, [null, []]);
Expand All @@ -81,9 +81,9 @@ public function testInDebugWithStopWatchDefinition()
(new ControllerArgumentValueResolverPass())->process($container);
$this->assertEquals($expected, $definition->getArgument(1)->getValues());

$this->assertTrue($container->hasDefinition('debug.n1'));
$this->assertTrue($container->hasDefinition('debug.n2'));
$this->assertTrue($container->hasDefinition('debug.n3'));
$this->assertTrue($container->hasDefinition('.debug.value_resolver.n1'));
$this->assertTrue($container->hasDefinition('.debug.value_resolver.n2'));
$this->assertTrue($container->hasDefinition('.debug.value_resolver.n3'));

$this->assertTrue($container->hasDefinition('n1'));
$this->assertTrue($container->hasDefinition('n2'));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,45 +40,38 @@ public function process(ContainerBuilder $container)
return;
}

if (!$normalizers = $container->findTaggedServiceIds('serializer.normalizer')) {
if (!$normalizers = $this->findAndSortTaggedServices('serializer.normalizer', $container)) {
throw new RuntimeException('You must tag at least one service as "serializer.normalizer" to use the "serializer" service.');
}

if ($container->getParameter('kernel.debug') && $container->hasDefinition('serializer.data_collector')) {
foreach (array_keys($normalizers) as $normalizer) {
$container->register('debug.'.$normalizer, TraceableNormalizer::class)
->setDecoratedService($normalizer)
->setArguments([new Reference('debug.'.$normalizer.'.inner'), new Reference('serializer.data_collector')]);
}
if (!$encoders = $this->findAndSortTaggedServices('serializer.encoder', $container)) {
throw new RuntimeException('You must tag at least one service as "serializer.encoder" to use the "serializer" service.');
}

$serializerDefinition = $container->getDefinition('serializer');
$serializerDefinition->replaceArgument(0, $this->findAndSortTaggedServices('serializer.normalizer', $container));
if ($container->hasParameter('serializer.default_context')) {
$defaultContext = $container->getParameter('serializer.default_context');
foreach (array_merge($normalizers, $encoders) as $service) {
$definition = $container->getDefinition($service);
$definition->setBindings(['array $defaultContext' => new BoundArgument($defaultContext, false)] + $definition->getBindings());
}

if (!$encoders = $container->findTaggedServiceIds('serializer.encoder')) {
throw new RuntimeException('You must tag at least one service as "serializer.encoder" to use the "serializer" service.');
$container->getParameterBag()->remove('serializer.default_context');
}

if ($container->getParameter('kernel.debug') && $container->hasDefinition('serializer.data_collector')) {
foreach (array_keys($encoders) as $encoder) {
$container->register('debug.'.$encoder, TraceableEncoder::class)
->setDecoratedService($encoder)
->setArguments([new Reference('debug.'.$encoder.'.inner'), new Reference('serializer.data_collector')]);
foreach ($normalizers as $i => $normalizer) {
$normalizers[$i] = $container->register('.debug.serializer.normalizer.'.$normalizer, TraceableNormalizer::class)
->setArguments([$normalizer, new Reference('serializer.data_collector')]);
}
}

$serializerDefinition->replaceArgument(1, $this->findAndSortTaggedServices('serializer.encoder', $container));

if (!$container->hasParameter('serializer.default_context')) {
return;
}

$defaultContext = $container->getParameter('serializer.default_context');
foreach (array_keys(array_merge($container->findTaggedServiceIds('serializer.normalizer'), $container->findTaggedServiceIds('serializer.encoder'))) as $service) {
$definition = $container->getDefinition($service);
$definition->setBindings(['array $defaultContext' => new BoundArgument($defaultContext, false)] + $definition->getBindings());
foreach ($encoders as $i => $encoder) {
$encoders[$i] = $container->register('.debug.serializer.encoder.'.$encoder, TraceableEncoder::class)
->setArguments([$encoder, new Reference('serializer.data_collector')]);
}
}

$container->getParameterBag()->remove('serializer.default_context');
$serializerDefinition = $container->getDefinition('serializer');
$serializerDefinition->replaceArgument(0, $normalizers);
$serializerDefinition->replaceArgument(1, $encoders);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,15 @@ public function testNormalizersAndEncodersAreDecoredAndOrderedWhenCollectingData
$serializerPass = new SerializerPass();
$serializerPass->process($container);

$traceableNormalizerDefinition = $container->getDefinition('debug.n');
$traceableEncoderDefinition = $container->getDefinition('debug.e');
$traceableNormalizerDefinition = $container->getDefinition('.debug.serializer.normalizer.n');
$traceableEncoderDefinition = $container->getDefinition('.debug.serializer.encoder.e');

$this->assertEquals(TraceableNormalizer::class, $traceableNormalizerDefinition->getClass());
$this->assertEquals(['n', null, 0], $traceableNormalizerDefinition->getDecoratedService());
$this->assertEquals(new Reference('debug.n.inner'), $traceableNormalizerDefinition->getArgument(0));
$this->assertEquals(new Reference('n'), $traceableNormalizerDefinition->getArgument(0));
$this->assertEquals(new Reference('serializer.data_collector'), $traceableNormalizerDefinition->getArgument(1));

$this->assertEquals(TraceableEncoder::class, $traceableEncoderDefinition->getClass());
$this->assertEquals(['e', null, 0], $traceableEncoderDefinition->getDecoratedService());
$this->assertEquals(new Reference('debug.e.inner'), $traceableEncoderDefinition->getArgument(0));
$this->assertEquals(new Reference('e'), $traceableEncoderDefinition->getArgument(0));
$this->assertEquals(new Reference('serializer.data_collector'), $traceableEncoderDefinition->getArgument(1));
}
}