Simplify DI using configurator

Author: GromNaN

config/services.php

@@ -20,10 +20,9 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
-use MongoDB\Bundle\Client;
 use MongoDB\Bundle\Command\DebugCommand;
-use MongoDB\Bundle\DataCollector\DriverEventSubscriber;
 use MongoDB\Bundle\DataCollector\MongoDBDataCollector;
+use MongoDB\Client;
 
 return static function (ContainerConfigurator $container): void {
     // default configuration for services in *this* file
@@ -46,15 +45,9 @@
         ->arg('$driverOptions', abstract_arg('Should be defined by pass'))
         ->abstract();
 
-    $services
-        ->set('mongodb.abstract.driver_event_subscriber', DriverEventSubscriber::class)
-        ->arg('$clientName', abstract_arg('Should be defined by pass'))
-        ->arg('$dataCollector', service('mongodb.data_collector'))
-        ->arg('$stopwatch', service('debug.stopwatch')->nullOnInvalid())
-        ->abstract();
-
     $services
         ->set('mongodb.data_collector', MongoDBDataCollector::class)
+        ->arg('$stopwatch', service('debug.stopwatch')->nullOnInvalid())
         ->arg('$clients', tagged_iterator('mongodb.client', 'name'))
         ->tag('data_collector', [
             'template' => '@MongoDB/Collector/mongodb.html.twig',

src/Client.php

@@ -39,7 +39,7 @@ final class DriverEventSubscriber implements CommandSubscriber
     private array $stopwatchEvents = [];
 
     public function __construct(
-        private readonly string $clientName,
+        private readonly int $clientId,
         private readonly MongoDBDataCollector $dataCollector,
         private readonly ?Stopwatch $stopwatch = null,
     ) {
@@ -52,8 +52,7 @@ public function commandStarted(CommandStartedEvent $event): void
         $command = (array) $event->getCommand();
         unset($command['lsid'], $command['$clusterTime']);
 
-        $this->dataCollector->collectCommandEvent($this->clientName, $requestId, [
-            'clientName' => $this->clientName,
+        $this->dataCollector->collectCommandEvent($this->clientId, $requestId, [
             'databaseName' => $event->getDatabaseName(),
             'commandName' => $event->getCommandName(),
             'command' => $command,
@@ -63,7 +62,7 @@ public function commandStarted(CommandStartedEvent $event): void
         ]);
 
         $this->stopwatchEvents[$requestId] = $this->stopwatch?->start(
-            'mongodb.' . $this->clientName . '.' . $event->getCommandName(),
+            'mongodb.' . $event->getCommandName(),
             'mongodb',
         );
     }
@@ -75,8 +74,7 @@ public function commandSucceeded(CommandSucceededEvent $event): void
         $this->stopwatchEvents[$requestId]?->stop();
         unset($this->stopwatchEvents[$requestId]);
 
-        $this->dataCollector->collectCommandEvent($this->clientName, $requestId, [
-            'clientName' => $this->clientName,
+        $this->dataCollector->collectCommandEvent($this->clientId, $requestId, [
             'durationMicros' => $event->getDurationMicros(),
         ]);
     }
@@ -88,8 +86,7 @@ public function commandFailed(CommandFailedEvent $event): void
         $this->stopwatchEvents[$requestId]?->stop();
         unset($this->stopwatchEvents[$requestId]);
 
-        $this->dataCollector->collectCommandEvent($this->clientName, $requestId, [
-            'clientName' => $this->clientName,
+        $this->dataCollector->collectCommandEvent($this->clientId, $requestId, [
             'durationMicros' => $event->getDurationMicros(),
             'error' => $event->getError(),
         ]);

src/DataCollector/DriverEventSubscriber.php

@@ -20,15 +20,18 @@
 
 namespace MongoDB\Bundle\DataCollector;
 
+use LogicException;
 use MongoDB\Client;
 use MongoDB\Driver\Command;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
+use Symfony\Component\Stopwatch\Stopwatch;
 use Throwable;
 
 use function array_diff_key;
+use function spl_object_id;
 
 /** @internal */
 final class MongoDBDataCollector extends DataCollector implements LateDataCollectorInterface
@@ -41,17 +44,23 @@ final class MongoDBDataCollector extends DataCollector implements LateDataCollec
     private array $requests = [];
 
     public function __construct(
+        private readonly ?Stopwatch $stopwatch = null,
         /** @var iterable<string, Client> */
         private readonly iterable $clients = [],
     ) {
     }
 
-    public function collectCommandEvent(string $clientName, string $requestId, array $data): void
+    public function configureClient(Client $client): void
     {
-        if (isset($this->requests[$clientName][$requestId])) {
-            $this->requests[$clientName][$requestId] += $data;
+        $client->getManager()->addSubscriber(new DriverEventSubscriber(spl_object_id($client), $this, $this->stopwatch));
+    }
+
+    public function collectCommandEvent(int $clientId, string $requestId, array $data): void
+    {
+        if (isset($this->requests[$clientId][$requestId])) {
+            $this->requests[$clientId][$requestId] += $data;
         } else {
-            $this->requests[$clientName][$requestId] = $data;
+            $this->requests[$clientId][$requestId] = $data;
         }
     }
 
@@ -61,21 +70,14 @@ public function collect(Request $request, Response $response, ?Throwable $except
 
     public function lateCollect(): void
     {
-        $requests = $this->requests;
         $requestCount = 0;
         $errorCount = 0;
         $durationMicros = 0;
 
-        foreach ($requests as $clientName => $requestsByClient) {
-            foreach ($requestsByClient as $requestId => $request) {
-                $requestCount++;
-                $durationMicros += $request['durationMicros'] ?? 0;
-                $errorCount += isset($request['error']) ? 1 : 0;
-            }
-        }
-
         $clients = [];
+        $clientIdMap = [];
         foreach ($this->clients as $name => $client) {
+            $clientIdMap[spl_object_id($client)] = $name;
             $clients[$name] = [
                 'serverBuildInfo' => array_diff_key(
                     (array) $client->getManager()->executeCommand('admin', new Command(['buildInfo' => 1]))->toArray()[0],
@@ -85,6 +87,17 @@ public function lateCollect(): void
             ];
         }
 
+        $requests = [];
+        foreach ($this->requests as $clientId => $requestsByClientId) {
+            $clientName = $clientIdMap[$clientId] ?? throw new LogicException('Client not found');
+            foreach ($requestsByClientId as $requestId => $request) {
+                $requests[$clientName][$requestId] = $request;
+                $requestCount++;
+                $durationMicros += $request['durationMicros'] ?? 0;
+                $errorCount += isset($request['error']) ? 1 : 0;
+            }
+        }
+
         $this->data = [
             'clients' => $clients,
             'requests' => $requests,

src/DataCollector/MongoDBDataCollector.php

@@ -20,13 +20,10 @@
 
 namespace MongoDB\Bundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-use function sprintf;
-
 /** @internal */
 final class DataCollectorPass implements CompilerPassInterface
 {
@@ -38,11 +35,7 @@ public function process(ContainerBuilder $container): void
 
         // Add a subscriber to each client to collect driver events, and register the client to the data collector.
         foreach ($container->findTaggedServiceIds('mongodb.client', true) as $clientId => $attributes) {
-            $subscriberId = sprintf('%s.subscriber', $clientId);
-            $subscriber = new ChildDefinition('mongodb.abstract.driver_event_subscriber');
-            $subscriber->replaceArgument('$clientName', $attributes[0]['name'] ?? $clientId);
-            $container->setDefinition($subscriberId, $subscriber);
-            $container->getDefinition($clientId)->addMethodCall('addSubscriber', [new Reference($subscriberId)]);
+            $container->getDefinition($clientId)->setConfigurator([new Reference('mongodb.data_collector'), 'configureClient']);
         }
     }
 }

src/DependencyInjection/Compiler/DataCollectorPass.php

@@ -70,7 +70,7 @@ public function testLoadWithSingleClient(): void
         // Check service definition
         $definition = $container->getDefinition('mongodb.client.default');
         $this->assertSame('mongodb://localhost:27017', $definition->getArgument('$uri'));
-        $this->assertTrue($definition->hasMethodCall('addSubscriber'));
+        $this->assertNotNull($definition->getConfigurator());
         $this->assertInstanceOf(ChildDefinition::class, $definition);
         $this->assertSame('mongodb.abstract.client', $definition->getParent());
         $parentDefinition = $container->getDefinition($definition->getParent());
@@ -132,20 +132,14 @@ public function testLoadWithMultipleClients(): void
         $this->assertSame('mongodb.abstract.client', $definition->getParent());
         $this->assertSame('mongodb://localhost:27017', $definition->getArgument('$uri'));
         $this->assertSame(['readPreference' => 'primary'], $definition->getArgument('$uriOptions'));
-        $this->assertTrue($definition->hasMethodCall('addSubscriber'));
+        $this->assertNotNull($definition->getConfigurator());
 
         $definition = $container->getDefinition('mongodb.client.secondary');
         $this->assertInstanceOf(ChildDefinition::class, $definition);
         $this->assertSame('mongodb.abstract.client', $definition->getParent());
         $this->assertSame('mongodb://localhost:27018', $definition->getArgument('$uri'));
         $this->assertEquals(['serverApi' => new ServerApi((string) ServerApi::V1)], $definition->getArgument('$driverOptions'));
-        $this->assertTrue($definition->hasMethodCall('addSubscriber'));
-
-        // Check data collector
-        $definition = $container->getDefinition('mongodb.data_collector');
-        $this->assertCount(2, $definition->getMethodCalls());
-        $this->assertTrue($definition->hasMethodCall('addClient'));
-        $this->assertSame(['default', 'secondary'], array_column(array_column($definition->getMethodCalls(), 1), 0));
+        $this->assertNotNull($definition->getConfigurator());
     }
 
     private function getContainer(array $config = [], array $thirdPartyDefinitions = []): ContainerBuilder