Sort services in service locator according to priority

BoShurik · BoShurik · commit c67c2df2362a · 2021-09-09T18:22:08.000+03:00
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ServiceLocatorTagPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ServiceLocatorTagPass.php
@@ -102,7 +102,6 @@ public static function register(ContainerBuilder $container, array $refMap, stri
             }
             $refMap[$id] = new ServiceClosureArgument($ref);
         }
-        ksort($refMap);
 
         $locator = (new Definition(ServiceLocator::class))
             ->addArgument($refMap)
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php
@@ -174,9 +174,9 @@ function tagged_iterator(string $tag, string $indexAttribute = null, string $def
 /**
  * Creates a service locator by tag name.
  */
-function tagged_locator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): ServiceLocatorArgument
+function tagged_locator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null, string $defaultPriorityMethod = null): ServiceLocatorArgument
 {
-    return new ServiceLocatorArgument(new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, true));
+    return new ServiceLocatorArgument(new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, true, $defaultPriorityMethod));
 }
 
 /**
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ServiceLocatorTagPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ServiceLocatorTagPassTest.php
@@ -177,6 +177,22 @@ public function testIndexedByServiceIdWithDecoration()
         static::assertFalse($locator->has(Decorated::class));
         static::assertInstanceOf(Decorated::class, $locator->get(Service::class));
     }
+
+    public function testDefinitionOrderIsTheSame()
+    {
+        $container = new ContainerBuilder();
+        $container->register('service-1');
+        $container->register('service-2');
+
+        $locator = ServiceLocatorTagPass::register($container, [
+            'service-2' => new Reference('service-2'),
+            'service-1' => new Reference('service-1'),
+        ]);
+        $locator = $container->getDefinition($locator);
+        $factories = $locator->getArguments()[0];
+
+        static::assertSame(['service-2', 'service-1'], array_keys($factories));
+    }
 }
 
 class Locator
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_subscriber.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_subscriber.php
@@ -44,9 +44,9 @@ public function isCompiled(): bool
     public function getRemovedIds(): array
     {
         return [
-            '.service_locator.DlIAmAe' => true,
-            '.service_locator.DlIAmAe.foo_service' => true,
             '.service_locator.t5IGRMW' => true,
+            '.service_locator.zFfA7ng' => true,
+            '.service_locator.zFfA7ng.foo_service' => true,
             'Psr\\Container\\ContainerInterface' => true,
             'Symfony\\Component\\DependencyInjection\\ContainerInterface' => true,
             'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition' => true,
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
@@ -249,7 +249,7 @@ public function testNoExceptionOnNonExistentTypeHintOptionalArg()
         $pass->process($container);
 
         $locator = $container->getDefinition((string) $resolver->getArgument(0))->getArgument(0);
-        $this->assertSame(['foo::barAction', 'foo::fooAction'], array_keys($locator));
+        $this->assertEqualsCanonicalizing(['foo::barAction', 'foo::fooAction'], array_keys($locator));
     }
 
     public function testArgumentWithNoTypeHintIsOk()
@@ -396,7 +396,10 @@ public function testAlias()
         $pass->process($container);
 
         $locator = $container->getDefinition((string) $resolver->getArgument(0))->getArgument(0);
-        $this->assertSame([RegisterTestController::class.'::fooAction', 'foo::fooAction'], array_keys($locator));
+
+        $services = array_keys($locator);
+        sort($services);
+        $this->assertSame([RegisterTestController::class.'::fooAction', 'foo::fooAction'], $services);
     }
 
     /**
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RemoveEmptyControllerArgumentLocatorsPassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RemoveEmptyControllerArgumentLocatorsPassTest.php
@@ -57,7 +57,7 @@ public function testProcess()
             'Symfony\Component\HttpKernel\DependencyInjection\RemoveEmptyControllerArgumentLocatorsPass: Removing method "setTestCase" of service "c2" from controller candidates: the method is called at instantiation, thus cannot be an action.',
         ];
 
-        $this->assertSame($expectedLog, $container->getCompiler()->getLog());
+        $this->assertEqualsCanonicalizing($expectedLog, $container->getCompiler()->getLog());
     }
 
     public function testInvoke()

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,6 @@ public static function register(ContainerBuilder $container, array $refMap, stri`
`102`	`102`	`}`
`103`	`103`	`$refMap[$id] = new ServiceClosureArgument($ref);`
`104`	`104`	`}`
`105`		`- ksort($refMap);`
`106`	`105`
`107`	`106`	`$locator = (new Definition(ServiceLocator::class))`
`108`	`107`	`->addArgument($refMap)`
Original file line number	Diff line number	Diff line change
`@@ -174,9 +174,9 @@ function tagged_iterator(string $tag, string $indexAttribute = null, string $def`
`174`	`174`	`/**`
`175`	`175`	`* Creates a service locator by tag name.`
`176`	`176`	`*/`
`177`		`-function tagged_locator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): ServiceLocatorArgument`
	`177`	`+function tagged_locator(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null, string $defaultPriorityMethod = null): ServiceLocatorArgument`
`178`	`178`	`{`
`179`		`- return new ServiceLocatorArgument(new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, true));`
	`179`	`+ return new ServiceLocatorArgument(new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod, true, $defaultPriorityMethod));`
`180`	`180`	`}`
`181`	`181`
`182`	`182`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function testProcess()`
`57`	`57`	`'Symfony\Component\HttpKernel\DependencyInjection\RemoveEmptyControllerArgumentLocatorsPass: Removing method "setTestCase" of service "c2" from controller candidates: the method is called at instantiation, thus cannot be an action.',`
`58`	`58`	`];`
`59`	`59`
`60`		`- $this->assertSame($expectedLog, $container->getCompiler()->getLog());`
	`60`	`+ $this->assertEqualsCanonicalizing($expectedLog, $container->getCompiler()->getLog());`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`public function testInvoke()`