Add service definition to ServiceWiringObserver (#257)

Author: cspray

known-issues.xml

@@ -1,5 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="4.27.0@faf106e717c37b8c81721845dba9de3d8deed8ff">
+  <file src="src/Bootstrap/ServiceWiringObserver.php">
+    <LessSpecificReturnStatement occurrences="1">
+      <code>$services</code>
+    </LessSpecificReturnStatement>
+    <MoreSpecificReturnType occurrences="1">
+      <code>array</code>
+    </MoreSpecificReturnType>
+  </file>
   <file src="src/Cli/Command/BuildCommand.php">
     <MixedArrayAccess occurrences="1">
       <code>$composer['extra']['annotatedContainer']['configFile']</code>

src/Bootstrap/ServiceFromServiceDefinition.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Cspray\AnnotatedContainer\Bootstrap;
+
+use Cspray\AnnotatedContainer\Definition\ServiceDefinition;
+
+/**
+ * @template Service
+ */
+interface ServiceFromServiceDefinition {
+
+    /**
+     * @return Service
+     */
+    public function getService() : object;
+
+    public function getDefinition() : ServiceDefinition;
+
+}

src/Bootstrap/ServiceGatherer.php

@@ -3,13 +3,13 @@
 namespace Cspray\AnnotatedContainer\Bootstrap;
 
 /**
- * @template Service
+ * @template T
  */
 interface ServiceGatherer {
 
     /**
-     * @param class-string<Service> $type
-     * @return Service[]
+     * @param class-string<T> $type
+     * @return ServiceFromServiceDefinition<T>[]
      */
     public function getServicesForType(string $type) : array;
 

src/Bootstrap/ServiceWiringObserver.php

@@ -4,6 +4,7 @@
 
 use Cspray\AnnotatedContainer\AnnotatedContainer;
 use Cspray\AnnotatedContainer\Definition\ContainerDefinition;
+use Cspray\AnnotatedContainer\Definition\ServiceDefinition;
 
 abstract class ServiceWiringObserver implements Observer {
 
@@ -40,7 +41,21 @@ public function getServicesForType(string $type) : array {
                     if (is_a($serviceType, $type, true)) {
                         $service = $this->container->get($serviceType);
                         assert($service instanceof $type);
-                        $services[] = $service;
+                        $services[] = new class($service, $serviceDefinition) implements ServiceFromServiceDefinition {
+
+                            public function __construct(
+                                private readonly object $service,
+                                private readonly ServiceDefinition $definition
+                            ) {}
+
+                            public function getService() : object {
+                                return $this->service;
+                            }
+
+                            public function getDefinition() : ServiceDefinition {
+                                return $this->definition;
+                            }
+                        };
                     }
                 }
 

test/BootstrapTest.php

@@ -5,6 +5,7 @@
 use Cspray\AnnotatedContainer\Bootstrap\Bootstrap;
 use Cspray\AnnotatedContainer\Bootstrap\ContainerDefinitionBuilderContextConsumerFactory;
 use Cspray\AnnotatedContainer\Bootstrap\ParameterStoreFactory;
+use Cspray\AnnotatedContainer\Bootstrap\ServiceFromServiceDefinition;
 use Cspray\AnnotatedContainer\Bootstrap\ServiceGatherer;
 use Cspray\AnnotatedContainer\Bootstrap\ServiceWiringObserver;
 use Cspray\AnnotatedContainer\Helper\FixtureBootstrappingDirectoryResolver;
@@ -506,14 +507,16 @@ protected function wireServices(AnnotatedContainer $container, ServiceGatherer $
 
         $actual = $observer->getServices();
 
-        usort($actual, fn($a, $b) => $a::class <=> $b::class);
+        $actualServices = array_map(fn(ServiceFromServiceDefinition $fromServiceDefinition) => $fromServiceDefinition->getService(), $actual);
+
+        usort($actualServices, fn($a, $b) => $a::class <=> $b::class);
 
         self::assertSame($container, $observer->getAnnotatedContainer());
         self::assertSame([
             $container->get(Fixtures::ambiguousAliasedServices()->barImplementation()->getName()),
             $container->get(Fixtures::ambiguousAliasedServices()->bazImplementation()->getName()),
             $container->get(Fixtures::ambiguousAliasedServices()->quxImplementation()->getName()),
-        ], $actual);
+        ], $actualServices);
     }
 
 }