bug #57345 [DependencyInjection] Fix regression in ordering service locators by priority (longwave)

nicolas-grekas · nicolas-grekas · commit c9c823923ef3 · 2024-06-28T12:02:36.000+02:00
This PR was submitted for the 7.1 branch but it was merged into the 7.0 branch instead. Discussion ---------- [DependencyInjection] Fix regression in ordering service locators by priority | Q | A | ------------- | --- | Branch? | 7.0 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #57344 | License | MIT Fixes a regression in Symfony 7.0 where service locators are no longer ordered by priority. Commits ------- d4b812c Allow service locators to be ordered by priority.
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ServiceLocatorTagPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ServiceLocatorTagPass.php
@@ -131,7 +131,6 @@ public static function map(array $services): array
 
             $services[$k] = new ServiceClosureArgument($v);
         }
-        ksort($services);
 
         return $services;
     }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php
@@ -623,7 +623,7 @@ public function testTaggedLocatorWithDefaultPriorityMethodConfiguredViaAttribute
         // We need to check priority of instances in the factories
         $factories = (new \ReflectionClass($locator))->getProperty('factories');
 
-        self::assertSame([BarTagClass::class, FooTagClass::class], array_keys($factories->getValue($locator)));
+        self::assertSame([FooTagClass::class, BarTagClass::class], array_keys($factories->getValue($locator)));
     }
 
     public function testTaggedLocatorWithDefaultIndexMethodAndWithDefaultPriorityMethodConfiguredViaAttribute()
@@ -652,7 +652,7 @@ public function testTaggedLocatorWithDefaultIndexMethodAndWithDefaultPriorityMet
         // We need to check priority of instances in the factories
         $factories = (new \ReflectionClass($locator))->getProperty('factories');
 
-        self::assertSame(['bar_tag_class', 'foo_tag_class'], array_keys($factories->getValue($locator)));
+        self::assertSame(['foo_tag_class', 'bar_tag_class'], array_keys($factories->getValue($locator)));
         self::assertSame($container->get(BarTagClass::class), $locator->get('bar_tag_class'));
         self::assertSame($container->get(FooTagClass::class), $locator->get('foo_tag_class'));
     }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterServiceSubscribersPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterServiceSubscribersPassTest.php
@@ -462,7 +462,7 @@ public static function getSubscribedServices(): array
             'autowired' => new ServiceClosureArgument(new TypedReference('service.id', 'stdClass', ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, 'autowired', [new Autowire(service: 'service.id')])),
             'autowired.nullable' => new ServiceClosureArgument(new TypedReference('service.id', 'stdClass', ContainerInterface::IGNORE_ON_INVALID_REFERENCE, 'autowired.nullable', [new Autowire(service: 'service.id')])),
             'autowired.parameter' => new ServiceClosureArgument('foobar'),
-            'autowire.decorated' => new ServiceClosureArgument(new Reference('.service_locator.oO4rxCy.inner', ContainerInterface::NULL_ON_INVALID_REFERENCE)),
+            'autowire.decorated' => new ServiceClosureArgument(new Reference('.service_locator.0tSxobl.inner', ContainerInterface::NULL_ON_INVALID_REFERENCE)),
             'target' => new ServiceClosureArgument(new TypedReference('stdClass', 'stdClass', ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, 'target', [new Target('someTarget')])),
         ];
         $this->assertEquals($expected, $container->getDefinition((string) $locator->getFactory()[0])->getArgument(0));
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ServiceLocatorTagPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ServiceLocatorTagPassTest.php
@@ -214,7 +214,7 @@ public function testDefinitionOrderIsTheSame()
         $locator = $container->getDefinition($locator);
         $factories = $locator->getArguments()[0];
 
-        static::assertSame(['service-1', 'service-2'], array_keys($factories));
+        static::assertSame(['service-2', 'service-1'], array_keys($factories));
     }
 
     public function testBindingsAreProcessed()
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_subscriber.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_subscriber.php
@@ -43,9 +43,9 @@ public function isCompiled(): bool
     public function getRemovedIds(): array
     {
         return [
-            '.service_locator.2hyyc9y' => true,
-            '.service_locator.KGUGnmw' => true,
-            '.service_locator.KGUGnmw.foo_service' => true,
+            '.service_locator.0H1ht0q' => true,
+            '.service_locator.0H1ht0q.foo_service' => true,
+            '.service_locator.tfSHZa1' => true,
             'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition' => true,
         ];
     }
@@ -68,14 +68,14 @@ protected static function getTestServiceSubscriberService($container)
     protected static function getFooServiceService($container)
     {
         return $container->services['foo_service'] = new \Symfony\Component\DependencyInjection\Tests\Fixtures\TestServiceSubscriber((new \Symfony\Component\DependencyInjection\Argument\ServiceLocator($container->getService ??= $container->getService(...), [
-            'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition' => ['privates', 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition', 'getCustomDefinitionService', false],
             'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\TestServiceSubscriber' => ['services', 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\TestServiceSubscriber', 'getTestServiceSubscriberService', false],
+            'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition' => ['privates', 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition', 'getCustomDefinitionService', false],
             'bar' => ['services', 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\TestServiceSubscriber', 'getTestServiceSubscriberService', false],
             'baz' => ['privates', 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition', 'getCustomDefinitionService', false],
             'late_alias' => ['services', 'late_alias', 'getLateAliasService', false],
         ], [
-            'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition' => 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition',
             'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\TestServiceSubscriber' => 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\TestServiceSubscriber',
+            'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition' => 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition',
             'bar' => 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition',
             'baz' => 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition',
             'late_alias' => 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\TestDefinition1',

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,6 @@ public static function map(array $services): array`
`131`	`131`
`132`	`132`	`$services[$k] = new ServiceClosureArgument($v);`
`133`	`133`	`}`
`134`		`- ksort($services);`
`135`	`134`
`136`	`135`	`return $services;`
`137`	`136`	`}`
Original file line number	Diff line number	Diff line change
`@@ -623,7 +623,7 @@ public function testTaggedLocatorWithDefaultPriorityMethodConfiguredViaAttribute`
`623`	`623`	`// We need to check priority of instances in the factories`
`624`	`624`	`$factories = (new \ReflectionClass($locator))->getProperty('factories');`
`625`	`625`
`626`		`- self::assertSame([BarTagClass::class, FooTagClass::class], array_keys($factories->getValue($locator)));`
	`626`	`+ self::assertSame([FooTagClass::class, BarTagClass::class], array_keys($factories->getValue($locator)));`
`627`	`627`	`}`
`628`	`628`
`629`	`629`	`public function testTaggedLocatorWithDefaultIndexMethodAndWithDefaultPriorityMethodConfiguredViaAttribute()`
`@@ -652,7 +652,7 @@ public function testTaggedLocatorWithDefaultIndexMethodAndWithDefaultPriorityMet`
`652`	`652`	`// We need to check priority of instances in the factories`
`653`	`653`	`$factories = (new \ReflectionClass($locator))->getProperty('factories');`
`654`	`654`
`655`		`- self::assertSame(['bar_tag_class', 'foo_tag_class'], array_keys($factories->getValue($locator)));`
	`655`	`+ self::assertSame(['foo_tag_class', 'bar_tag_class'], array_keys($factories->getValue($locator)));`
`656`	`656`	`self::assertSame($container->get(BarTagClass::class), $locator->get('bar_tag_class'));`
`657`	`657`	`self::assertSame($container->get(FooTagClass::class), $locator->get('foo_tag_class'));`
`658`	`658`	`}`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ public function testDefinitionOrderIsTheSame()`
`214`	`214`	`$locator = $container->getDefinition($locator);`
`215`	`215`	`$factories = $locator->getArguments()[0];`
`216`	`216`
`217`		`- static::assertSame(['service-1', 'service-2'], array_keys($factories));`
	`217`	`+ static::assertSame(['service-2', 'service-1'], array_keys($factories));`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`public function testBindingsAreProcessed()`