Skip to content

[DependencyInjection] fixes validation of non-scalar attribute values #48958

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

Merged
nicolas-grekas merged 1 commit into from
Jan 13, 2023
Merged

[DependencyInjection] fixes validation of non-scalar attribute values #48958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 13 additions & 5 deletions src/Symfony/Component/DependencyInjection/Compiler/CheckDefinitionValidityPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,7 @@ public function process(ContainerBuilder $container)
// tag attribute values must be scalars
foreach ($definition->getTags() as $name => $tags) {
foreach ($tags as $attributes) {
foreach ($attributes as $attribute => $value) {
if (!\is_scalar($value) && null !== $value) {
throw new RuntimeException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s", attribute "%s".', $id, $name, $attribute));
}
}
$this->validateAttributes($id, $name, $attributes);
}
}

Expand All @@ -87,4 +83,16 @@ public function process(ContainerBuilder $container)
}
}
}

private function validateAttributes(string $id, string $tag, array $attributes, array $path = []): void
{
foreach ($attributes as $name => $value) {
if (\is_array($value)) {
$this->validateAttributes($id, $tag, $value, [...$path, $name]);
} elseif (!\is_scalar($value) && null !== $value) {
$name = implode('.', [...$path, $name]);
throw new RuntimeException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s", attribute "%s".', $id, $tag, $name));
}
}
}
}
9 changes: 5 additions & 4 deletions src/Symfony/Component/DependencyInjection/Loader/Configurator/DefaultsConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,14 @@ final public function instanceof(string $fqcn): InstanceofConfigurator
return $this->parent->instanceof($fqcn);
}

private function validateAttributes(string $tagName, array $attributes, string $prefix = ''): void
private function validateAttributes(string $tag, array $attributes, array $path = []): void
{
foreach ($attributes as $attribute => $value) {
foreach ($attributes as $name => $value) {
if (\is_array($value)) {
$this->validateAttributes($tagName, $value, $attribute.'.');
$this->validateAttributes($tag, $value, [...$path, $name]);
} elseif (!\is_scalar($value ?? '')) {
throw new InvalidArgumentException(sprintf('Tag "%s", attribute "%s" in "_defaults" must be of a scalar-type or an array of scalar-type.', $tagName, $prefix.$attribute));
$name = implode('.', [...$path, $name]);
throw new InvalidArgumentException(sprintf('Tag "%s", attribute "%s" in "_defaults" must be of a scalar-type or an array of scalar-type.', $tag, $name));
}
}
}
Expand Down
9 changes: 5 additions & 4 deletions src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/TagTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,14 @@ final public function tag(string $name, array $attributes = []): static
return $this;
}

private function validateAttributes(string $tagName, array $attributes, string $prefix = ''): void
private function validateAttributes(string $tag, array $attributes, array $path = []): void
{
foreach ($attributes as $attribute => $value) {
foreach ($attributes as $name => $value) {
if (\is_array($value)) {
$this->validateAttributes($tagName, $value, $attribute.'.');
$this->validateAttributes($tag, $value, [...$path, $name]);
} elseif (!\is_scalar($value ?? '')) {
throw new InvalidArgumentException(sprintf('A tag attribute must be of a scalar-type or an array of scalar-types for service "%s", tag "%s", attribute "%s".', $this->id, $tagName, $prefix.$attribute));
$name = implode('.', [...$path, $name]);
throw new InvalidArgumentException(sprintf('A tag attribute must be of a scalar-type or an array of scalar-types for service "%s", tag "%s", attribute "%s".', $this->id, $tag, $name));
}
}
}
Expand Down
9 changes: 5 additions & 4 deletions src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,13 +937,14 @@ private function checkDefinition(string $id, array $definition, string $file)
}
}

private function validateAttributes(string $message, array $attributes, string $prefix = ''): void
private function validateAttributes(string $message, array $attributes, array $path = []): void
{
foreach ($attributes as $attribute => $value) {
foreach ($attributes as $name => $value) {
if (\is_array($value)) {
$this->validateAttributes($message, $value, $attribute.'.');
$this->validateAttributes($message, $value, [...$path, $name]);
} elseif (!\is_scalar($value ?? '')) {
throw new InvalidArgumentException(sprintf($message, $prefix.$attribute));
$name = implode('.', [...$path, $name]);
throw new InvalidArgumentException(sprintf($message, $name));
}
}
}
Expand Down
31 changes: 28 additions & 3 deletions src/Symfony/Component/DependencyInjection/Tests/Compiler/CheckDefinitionValidityPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,21 +80,46 @@ public function testValidTags()
$container->register('b', 'class')->addTag('foo', ['bar' => null]);
$container->register('c', 'class')->addTag('foo', ['bar' => 1]);
$container->register('d', 'class')->addTag('foo', ['bar' => 1.1]);
$container->register('d', 'class')->addTag('foo', ['bar' => ['baz' => 'baz']]);
$container->register('e', 'class')->addTag('foo', ['deep' => ['foo' => ['bar' => 'baz']]]);

$this->process($container);

$this->addToAssertionCount(1);
}

public function testInvalidTags()
/**
* @dataProvider provideInvalidTags
*/
public function testInvalidTags(string $name, array $attributes, string $message)
{
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage($message);
$container = new ContainerBuilder();
$container->register('a', 'class')->addTag('foo', ['bar' => ['baz' => 'baz']]);

$container->register('a', 'class')->addTag($name, $attributes);
$this->process($container);
}

public static function provideInvalidTags(): iterable
{
$message = 'A "tags" attribute must be of a scalar-type for service "a", tag "%s", attribute "%s".';
yield 'object attribute value' => [
'foo',
['bar' => new class() {}],
sprintf($message, 'foo', 'bar'),
];
yield 'nested object attribute value' => [
'foo',
['bar' => ['baz' => new class() {}]],
sprintf($message, 'foo', 'bar.baz'),
];
yield 'deeply nested object attribute value' => [
'foo',
['bar' => ['baz' => ['qux' => new class() {}]]],
sprintf($message, 'foo', 'bar.baz.qux'),
];
}

public function testDynamicPublicServiceName()
{
$this->expectException(EnvParameterException::class);
Expand Down