Skip to content

Commit

Permalink
Use references for connection middlewares
Browse files Browse the repository at this point in the history
This ensures created child definitions for connection specific middlewares inherit props like tags from parent and their definitions are set in root of the container, so that they are visible for other compiler passes that look for things through stuff like tags
  • Loading branch information
ostrolucky committed Aug 31, 2024
1 parent d84aadb commit e4316cf
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 17 deletions.
36 changes: 19 additions & 17 deletions src/DependencyInjection/Compiler/MiddlewaresPass.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;

use function array_key_exists;
use function array_keys;
Expand Down Expand Up @@ -44,20 +45,21 @@ public function process(ContainerBuilder $container): void
}

foreach (array_keys($container->getParameter('doctrine.connections')) as $name) {
$middlewareDefs = [];
$middlewareRefs = [];
$i = 0;
foreach ($middlewareAbstractDefs as $id => $abstractDef) {
if (isset($middlewareConnections[$id]) && ! array_key_exists($name, $middlewareConnections[$id])) {
continue;
}

$middlewareDefs[$id] = [
$childDef = $container->setDefinition(
sprintf('%s.%s', $id, $name),
new ChildDefinition($id),
),
++$i,
];
$childDef = $container->setDefinition(

Check failure on line 55 in src/DependencyInjection/Compiler/MiddlewaresPass.php

View workflow job for this annotation

GitHub Actions / Coding Standards / Coding Standards (8.3)

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space
$childId = sprintf('%s.%s', $id, $name),
(new ChildDefinition($id))
->setTags($abstractDef->getTags())->clearTag('doctrine.middleware')
->setAutoconfigured($abstractDef->isAutoconfigured())
->setAutowired($abstractDef->isAutowired()),
);
$middlewareRefs[$id] = [new Reference($childId), ++$i];

if (! is_subclass_of($abstractDef->getClass(), ConnectionNameAwareInterface::class)) {
continue;
Expand All @@ -66,21 +68,21 @@ public function process(ContainerBuilder $container): void
$childDef->addMethodCall('setConnectionName', [$name]);
}

$middlewareDefs = array_map(
static fn ($id, $def) => [
$middlewareRefs = array_map(
static fn (string $id, array $ref) => [
$middlewareConnections[$id][$name] ?? $middlewarePriorities[$id] ?? 0,
$def[1],
$def[0],
$ref[1],
$ref[0],
],
array_keys($middlewareDefs),
array_values($middlewareDefs),
array_keys($middlewareRefs),
array_values($middlewareRefs),
);
uasort($middlewareDefs, static fn ($a, $b) => $b[0] <=> $a[0] ?: $a[1] <=> $b[1]);
$middlewareDefs = array_map(static fn ($value) => $value[2], $middlewareDefs);
uasort($middlewareRefs, static fn (array $a, array $b): int => $b[0] <=> $a[0] ?: $a[1] <=> $b[1]);
$middlewareRefs = array_map(static fn (array $value): Reference => $value[2], $middlewareRefs);

$container
->getDefinition(sprintf('doctrine.dbal.%s_connection.configuration', $name))
->addMethodCall('setMiddlewares', [$middlewareDefs]);
->addMethodCall('setMiddlewares', [$middlewareRefs]);
}
}
}
27 changes: 27 additions & 0 deletions tests/DependencyInjection/Compiler/MiddlewarePassTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;

use Symfony\Component\DependencyInjection\Reference;

Check failure on line 17 in tests/DependencyInjection/Compiler/MiddlewarePassTest.php

View workflow job for this annotation

GitHub Actions / Coding Standards / Coding Standards (8.3)

Expected 0 lines between same types of use statement, found 1.
use function array_map;

Check failure on line 18 in tests/DependencyInjection/Compiler/MiddlewarePassTest.php

View workflow job for this annotation

GitHub Actions / Coding Standards / Coding Standards (8.3)

Expected 1 line between different types of use statement, found 0.
use function implode;
use function sprintf;
Expand Down Expand Up @@ -296,6 +297,29 @@ public function testAddMiddlewareOrderingWithInheritedPriorityPerConnection(): v
$this->assertMiddlewareOrdering($container, 'conn2', [PHP7Middleware::class, 'some_middleware_class']);
}

public function testInjectedMiddlewaresPreserveParentDefinition(): void
{
$container = $this->createContainer(static function (ContainerBuilder $container): void {
$container
->register('middleware', PHP7Middleware::class)
->setPublic(true)
->setAutowired(true)
->setAutoconfigured(true)
->addTag('doctrine.middleware')->addTag('custom.tag');
$container
->setAlias('conf_conn', 'doctrine.dbal.conn1_connection.configuration')
->setPublic(true); // Avoid removal and inlining
});
$this->assertMiddlewareInjected($container, 'conn', PHP7Middleware::class);
$this->assertNotNull($definition = $container->getDefinition('middleware.conn1'));
$this->assertCount(1, $middlewares = $this->getMiddlewaresForConn($container, 'conn', PHP7Middleware::class));
$this->assertSame(true, $definition->isAutowired());
$this->assertSame(true, $definition->isAutoconfigured());
$this->assertSame(['custom.tag' => [[]]], $definition->getTags());
$this->assertSame($middlewares[0], $definition);

}

Check failure on line 321 in tests/DependencyInjection/Compiler/MiddlewarePassTest.php

View workflow job for this annotation

GitHub Actions / Coding Standards / Coding Standards (8.3)

Function closing brace must go on the next line following the body; found 1 blank lines before brace

/** @requires PHP 8 */
public function testAddMiddlewareOrderingWithAttributeForAutoconfiguration(): void
{
Expand Down Expand Up @@ -443,6 +467,9 @@ private function getMiddlewaresForConn(ContainerBuilder $container, string $conn
}

foreach ($call[1][0] as $middlewareDef) {
if ($middlewareDef instanceof Reference) {

Check failure on line 470 in tests/DependencyInjection/Compiler/MiddlewarePassTest.php

View workflow job for this annotation

GitHub Actions / Coding Standards / Coding Standards (8.3)

Expected 1 line after "if", found 0.
$middlewareDef = $container->getDefinition($middlewareDef->__toString());
}
if (isset($middlewareClass) && $middlewareDef->getClass() !== $middlewareClass) {
continue;
}
Expand Down

0 comments on commit e4316cf

Please sign in to comment.