ParamConverterManager lazy services are broken and should use a service locator

By adding logging to Container::get():

    file_put_contents('/tmp/container.log', str_repeat('>', count($this->loading)) . " $id\n", FILE_APPEND);
    $this->loading[$id] = TRUE;

    try {
      $service = $this->createService($definition, $id);
    }

we can see the chains of services that are created:

>>> route_enhancer.param_conversion
>>>> paramconverter_manager
>>>>> drupal.proxy_original_service.paramconverter.views_ui
>>>>>> entity_type.manager
>>>>>>> string_translation
>>>>>>>> string_translator.custom_strings
>>>>>>> entity.last_installed_schema.repository
>>>>>> tempstore.shared
>>>>>>> keyvalue.expirable
>>>>>> router.admin_context
>>>>>> entity.repository
>>>>>>> context.repository
>>>>> drupal.proxy_original_service.paramconverter.configentity_admin
>>>>> paramconverter.entity
>>>>> paramconverter.entity_revision
>>>>> drupal.proxy_original_service.paramconverter.menu_link
>>>>>> plugin.manager.menu.link
>>>>>>> Drupal\Core\Menu\MenuTreeStorageInterface
>>>>>>> menu_link.static.overrides
>>>>> drupal.proxy_original_service.node_preview
>>>>>> tempstore.private

If we lazily instantiate paramconverter_manager's services properly then we remove all the direct children and perhaps some of the other children from being required on almost all page loads.

It appears that #[AutowireLocator] does not support ordering services by priority. This means that the services in the wrong order when iterating through all of them, and this causes bugs and the tests to fail. I traced through the compiler builder and in PriorityTaggedServiceTrait::findAndSortTaggedServices() the services are initially correctly sorted but when the final array is built the services are indexed by service name and the ordering is lost.

https://github.com/symfony/symfony/issues/42506 implies this did work at some point - at least when using !tagged_locator instead of autowiring maybe - but it doesn't appear to here.

In fact, PriorityTaggedServiceTrait::findAndSortTaggedServices() does sort services correctly, but then later on ServiceLocatorTagPass::map() calls ksort($services) which destroys the order.

Opened https://github.com/symfony/symfony/issues/57344 with a fix in https://github.com/symfony/symfony/pull/57345

Upstream bug is fixed in Symfony 7.0.9

https://github.com/symfony/symfony/pull/57581

The existing MR was too difficult to rebase, so I started again.

Thanks for the review and suggestions, I applied them. Then I cleaned up the tests so we don't have addConverter() any more, and added an explicit test for lazy instantiation.

Exceptions are only caught after they have been expected.

If I swap the order:

-    $this->expectExceptionMessage('ErrorConverter was instantiated');
     $manager->convert($defaults);
+    $this->expectExceptionMessage('ErrorConverter was instantiated');

then it fails:

$ ddev test core/tests/Drupal/Tests/Core/ParamConverter/ParamConverterManagerTest.php
Disabled xdebug
PHPUnit 11.5.44 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.5.1
Configuration: /var/www/html/drupal/core/phpunit.xml.dist

............E..                                                   15 / 15 (100%)

Time: 00:00.021, Memory: 6.00 MB

There was 1 error:

1) Drupal\Tests\Core\ParamConverter\ParamConverterManagerTest::testLazyInstantiation
Exception: ErrorConverter was instantiated

/var/www/html/drupal/core/tests/Drupal/Tests/Core/ParamConverter/ParamConverterManagerTest.php:243
/var/www/html/drupal/core/tests/Drupal/Tests/Core/ParamConverter/ParamConverterManagerTest.php:162

Having said that using exceptions for control flow isn't ideal, but perhaps it's okay in a test?

Improved the test as per the suggestion, we can reuse the existing converter as well to make the test shorter.