turn RoutesServiceFactory into a startup hook to avoid container compilation problems

Author: mlebkowski

Readme.md

@@ -18,6 +18,7 @@ composer require wondernetwork/slim-kernel
 ```php
 use WonderNetwork\SlimKernel\KernelBuilder;
 use WonderNetwork\SlimKernel\ServiceFactory\SymfonyConsoleServiceFactory;
+use WonderNetwork\SlimKernel\StartupHook\RoutesStartupHook;
 
 // configure the container:
 $container = KernelBuilder::start(
@@ -43,6 +44,10 @@ $container = KernelBuilder::start(
             __DIR__.'/../src/Cli/**/*Command.php',
         ),
     )
+    ->onStartup(
+        // automatically add routes
+        new RoutesStartupHook(__DIR__.'/../app/routes/*.php'),
+    )
     // only pass a path for prod environments, null otherwise
     ->useCache(__DIR__.'/../.cache')
     ->build();
@@ -89,6 +94,33 @@ of a CLI command. This is best place to setup some global error handlers, boot s
 static properties, etc. To do so, pass an object implementing `StartupHook` to the
 `onStartup()` method
 
+### Routes Startup Hook
+
+`WonderNetwork\SlimKernel\StartupHook\RouteStartupHook`
+
+If you would like to get your routes registered in a declarative manner,
+use this startup hook to point to files containing your route definitions.
+Each of the files matched by the glob pattern **needs to return** a closure,
+which takes `Slim\App`, or more precisely `Slim\Interfaces\RouteCollectorProxyInterface`.
+This means you can use it for more than routes: for example global middlewares.
+The closures will be evaluated on a Slim Application fetched from the container.
+
+```php
+$kernelBuilder->onStartup(
+    new \WonderNetwork\SlimKernel\StartupHook\RoutesStartupHook(
+        __DIR__.'/../routes/*.php',
+    ),
+);
+// app/routes/some.php
+use Psr\Http\Message\ResponseInterface;
+return static function (Slim\App $app) {
+  $app->get('/hello/{message}', function (ResponseInterface $response, string $message) {
+    return $response->withHeader("X-Hello", $message);
+  });
+}
+```
+
+
 ## Error handling
 
 The default error handling middleware is added. It’s configured to silently log
@@ -147,29 +179,3 @@ return new WonderNetwork\SlimKernel\ServiceFactory\SymfonyConsoleServiceFactory(
     'acme v1.0', 
 );
 ```
-
-### Routes Service Factory
-
-`WonderNetwork\SlimKernel\ServiceFactory\RouteServiceFactory`
-
-If you would like to get your routes registered in a declarative manner,
-use this service factory to point to files containing your route definitions.
-Each of the files matched by the glob pattern **needs to return** a closure,
-which takes `Slim\App`, or more precisely `Slim\Interfaces\RouteCollectorProxyInterface`.
-This means you can use it for more than routes: for example global middlewares.
-The closures will be evaluated whenever the Slim Application is fetched from
-the container.
-
-```php
-// app/services/routes.php
-return new WonderNetwork\SlimKernel\ServiceFactory\RoutesServiceFactory(
-    __DIR__.'/../routes/*.php',
-);
-// app/routes/some.php
-use Psr\Http\Message\ResponseInterface;
-return static function (Slim\App $app) {
-  $app->get('/hello/{message}', function (ResponseInterface $response, string $message) {
-    return $response->withHeader("X-Hello", $message);
-  });
-}
-```

src/HookCollection.php

@@ -11,13 +11,15 @@ final class HookCollection {
     public function __construct() {
     }
 
-    public function add(StartupHook $hook): void {
-        $this->hooks[] = $hook;
+    public function add(StartupHook ...$hooks): void {
+        foreach ($hooks as $hook) {
+            $this->hooks[] = $hook;
+        }
     }
 
-    public function boot(ContainerInterface $container): ContainerInterface {
+    public function boot(ServicesBuilder $builder, ContainerInterface $container): ContainerInterface {
         foreach ($this->hooks as $hook) {
-            $hook($container);
+            $hook($builder, $container);
         }
         return $container;
     }

src/KernelBuilder.php

@@ -6,6 +6,7 @@
 use DI\ContainerBuilder;
 use Exception;
 use Psr\Container\ContainerInterface;
+use function WonderNetwork\SlimKernel\Collection\map;
 use function WonderNetwork\SlimKernel\Collection\toArray;
 
 final class KernelBuilder {
@@ -22,7 +23,6 @@ private function __construct(ServicesBuilder $servicesBuilder) {
         $this->builder = new ContainerBuilder();
         $this->startupHook = new HookCollection();
         $this->register(new ServiceFactory\SlimServiceFactory());
-        $this->onStartup(new StartupHook\ErrorHandlingHook());
     }
 
     /** @param array<string|mixed> $definitions */
@@ -31,13 +31,19 @@ public function add(array $definitions): self {
         return $this;
     }
 
-    public function register(ServiceFactory $serviceFactory): self {
-        $this->builder->addDefinitions(toArray($serviceFactory($this->servicesBuilder)));
+    public function register(ServiceFactory ...$serviceFactories): self {
+        $this->builder->addDefinitions(
+            ...
+            map(
+                $serviceFactories,
+                fn (ServiceFactory $serviceFactory) => toArray($serviceFactory($this->servicesBuilder)),
+            ),
+        );
         return $this;
     }
 
-    public function onStartup(StartupHook $hook): self {
-        $this->startupHook->add($hook);
+    public function onStartup(StartupHook ...$hooks): self {
+        $this->startupHook->add(...$hooks);
         return $this;
     }
 
@@ -59,6 +65,7 @@ public function useCache(?string $path): self {
      * @throws Exception
      */
     public function build(): ContainerInterface {
-        return $this->startupHook->boot($this->builder->build());
+        $this->onStartup(new StartupHook\ErrorHandlingHook());
+        return $this->startupHook->boot($this->servicesBuilder, $this->builder->build());
     }
 }

src/StartupHook.php

@@ -6,5 +6,5 @@
 use Psr\Container\ContainerInterface;
 
 interface StartupHook {
-    public function __invoke(ContainerInterface $container): void;
+    public function __invoke(ServicesBuilder $builder, ContainerInterface $container): void;
 }

src/StartupHook/ErrorHandlingHook.php

@@ -6,17 +6,17 @@
 use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
-use RuntimeException;
 use Slim\App;
 use Slim\Middleware\ErrorMiddleware;
+use WonderNetwork\SlimKernel\ServicesBuilder;
 use WonderNetwork\SlimKernel\StartupHook;
 
 final class ErrorHandlingHook implements StartupHook {
     /**
      * @throws ContainerExceptionInterface
      * @throws NotFoundExceptionInterface
      */
-    public function __invoke(ContainerInterface $container): void {
+    public function __invoke(ServicesBuilder $builder, ContainerInterface $container): void {
         $container->get(App::class)->add($container->get(ErrorMiddleware::class));
     }
 }

src/ServiceFactory/RoutesServiceFactory.php src/StartupHook/RoutesStartupHook.php

@@ -1,24 +1,25 @@
 <?php
 declare(strict_types=1);
 
-namespace WonderNetwork\SlimKernel\ServiceFactory;
+namespace WonderNetwork\SlimKernel\StartupHook;
 
+use Psr\Container\ContainerInterface;
 use Slim\App;
-use WonderNetwork\SlimKernel\ServiceFactory;
 use WonderNetwork\SlimKernel\ServicesBuilder;
 use WonderNetwork\SlimKernel\SlimExtension\SlimClosuresCollection;
-use function DI\decorate;
+use WonderNetwork\SlimKernel\StartupHook;
 
-final class RoutesServiceFactory implements ServiceFactory {
+final class RoutesStartupHook implements StartupHook {
     private string $path;
 
     public function __construct(string $path) {
         $this->path = $path;
     }
 
-    public function __invoke(ServicesBuilder $builder): iterable {
+    public function __invoke(ServicesBuilder $builder, ContainerInterface $container): void {
         $closures = SlimClosuresCollection::of(...$builder->files()->glob($this->path));
 
-        yield App::class => decorate(static fn (App $previous) => $closures->applyTo($previous));
+        $app = $container->get(App::class);
+        $closures->applyTo($app);
     }
 }

tests/StartupHook/ErrorHandlingHookTest.php

@@ -9,14 +9,15 @@
 use Slim\Psr7\Factory\ServerRequestFactory;
 use Throwable;
 use WonderNetwork\SlimKernel\KernelBuilder;
-use WonderNetwork\SlimKernel\ServiceFactory\RoutesServiceFactory;
 
 class ErrorHandlingHookTest extends TestCase {
     public function testCustomMiddlewaresTakePrecedence() {
         $container = KernelBuilder::start(__DIR__.'/../Resources/ErrorMiddleware')
             ->glob('app/services/*.php')
-            ->register(new RoutesServiceFactory('app/middlewares/*.php'))
-            ->register(new RoutesServiceFactory('app/routes/*.php'))
+            ->onStartup(
+                new RoutesStartupHook('app/middlewares/*.php'),
+                new RoutesStartupHook('app/routes/*.php'),
+            )
             ->build();
 
         /** @var App $app */

tests/ServiceFactory/RoutesServiceFactoryTest.php tests/StartupHook/RoutesStartupHookTest.php

@@ -1,20 +1,22 @@
 <?php
 declare(strict_types=1);
 
-namespace WonderNetwork\SlimKernel\ServiceFactory;
+namespace WonderNetwork\SlimKernel\StartupHook;
 
 use PHPUnit\Framework\TestCase;
 use Slim\App;
 use Slim\Psr7\Factory\ServerRequestFactory;
 use WonderNetwork\SlimKernel\KernelBuilder;
 
-class RoutesServiceFactoryTest extends TestCase {
+class RoutesStartupHookTest extends TestCase {
     public function test(): void {
         /** @var App $app */
         $app = KernelBuilder::start(__DIR__.'/../Resources/App')
             ->glob('app/services/*.php')
-            ->register(new RoutesServiceFactory('app/routes/*.php'))
-            ->register(new RoutesServiceFactory('app/middlewares/*.php'))
+            ->onStartup(
+                new RoutesStartupHook('app/routes/*.php'),
+                new RoutesStartupHook('app/middlewares/*.php'),
+            )
             ->build()
             ->get(App::class);
         $factory = new ServerRequestFactory();

tests/StartupHookSpy.php

@@ -8,7 +8,7 @@
 final class StartupHookSpy implements StartupHook {
     public ?ContainerInterface $container = null;
 
-    public function __invoke(ContainerInterface $container): void {
+    public function __invoke(ServicesBuilder $builder, ContainerInterface $container): void {
         $this->container = $container;
     }
 }