Proxy the router cache warmer to the framework bundle

Author: mbabker

config/services.php

@@ -53,6 +53,7 @@
 use Ratchet\RFC6455\Handshake\ServerNegotiator;
 use React\EventLoop\Loop;
 use React\EventLoop\LoopInterface;
+use Symfony\Bundle\FrameworkBundle\CacheWarmer\RouterCacheWarmer as BaseRouterCacheWarmer;
 use Symfony\Bundle\FrameworkBundle\Command\RouterDebugCommand;
 use Symfony\Bundle\FrameworkBundle\Routing\Router;
 use Symfony\Component\Config\Loader\DelegatingLoader;
@@ -73,6 +74,8 @@
 use Symfony\Component\Routing\RequestContext;
 
 return static function (ContainerConfigurator $container): void {
+    $websocketRouterFolder = 'websocket-router';
+
     $services = $container->services();
 
     $services->set('babdev_websocket_server.authentication.authenticator', DefaultAuthenticator::class)
@@ -198,7 +201,7 @@
             service(PsrContainerInterface::class),
             abstract_arg('routing resource'),
             [
-                'cache_dir' => param('kernel.cache_dir') . '/websocket-router',
+                'cache_dir' => param('kernel.build_dir') . '/' . $websocketRouterFolder,
                 'debug' => param('kernel.debug'),
                 'generator_class' => CompiledUrlGenerator::class,
                 'generator_dumper_class' => CompiledUrlGeneratorDumper::class,
@@ -217,12 +220,18 @@
         ->tag('container.service_subscriber', ['key' => 'routing.loader', 'id' => 'babdev_websocket_server.routing.loader'])
     ;
 
-    $services->set('babdev_websocket_server.router.cache_warmer', RouterCacheWarmer::class)
+    $services->set('babdev_websocket_server.router.cache_warmer.inner', BaseRouterCacheWarmer::class)
         ->args([
             service(PsrContainerInterface::class),
-            param('kernel.cache_dir') . '/websocket-router',
         ])
-        ->tag('container.service_subscriber', ['id' => 'babdev_websocket_server.router'])
+        ->tag('container.service_subscriber', ['key' => 'router', 'id' => 'babdev_websocket_server.router'])
+    ;
+
+    $services->set('babdev_websocket_server.router.cache_warmer', RouterCacheWarmer::class)
+        ->args([
+            service('babdev_websocket_server.router.cache_warmer.inner'),
+            $websocketRouterFolder,
+        ])
         ->tag('kernel.cache_warmer')
     ;
 

src/CacheWarmer/RouterCacheWarmer.php

@@ -2,42 +2,28 @@
 
 namespace BabDev\WebSocketBundle\CacheWarmer;
 
-use Psr\Container\ContainerInterface;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
-use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
-use Symfony\Component\Routing\RouterInterface;
-use Symfony\Contracts\Service\ServiceSubscriberInterface;
 
 /**
- * Generates the websocket router matcher and generator classes.
+ * Decorator for the FrameworkBundle's router cache warmer to ensure the websocket router matcher and generator classes are generated in a unique cache path.
  */
-final readonly class RouterCacheWarmer implements CacheWarmerInterface, ServiceSubscriberInterface
+final readonly class RouterCacheWarmer implements CacheWarmerInterface
 {
     public function __construct(
-        private ContainerInterface $container,
-        private string $routerCacheDir,
+        private CacheWarmerInterface $cacheWarmer,
+        private string $websocketRouterFolder,
     ) {}
 
     public function warmUp(string $cacheDir, ?string $buildDir = null): array
     {
-        $router = $this->container->get('babdev_websocket_server.router');
-
-        if ($router instanceof WarmableInterface) {
-            return (array) $router->warmUp($this->routerCacheDir, $buildDir);
-        }
-
-        throw new \LogicException(sprintf('The router "%s" cannot be warmed up because it does not implement "%s".', get_debug_type($router), WarmableInterface::class));
+        return $this->cacheWarmer->warmUp(
+            $cacheDir.'/'.ltrim($this->websocketRouterFolder, '/'),
+            null === $buildDir ? null : $buildDir.'/'.ltrim($this->websocketRouterFolder, '/'),
+        );
     }
 
     public function isOptional(): bool
     {
         return true;
     }
-
-    public static function getSubscribedServices(): array
-    {
-        return [
-            'babdev_websocket_server.router' => RouterInterface::class,
-        ];
-    }
 }

tests/CacheWarmer/RouterCacheWarmerTest.php

@@ -5,60 +5,54 @@
 use BabDev\WebSocketBundle\CacheWarmer\RouterCacheWarmer;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use Psr\Container\ContainerInterface;
-use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 use Symfony\Component\Routing\Generator\UrlGenerator;
 use Symfony\Component\Routing\Matcher\UrlMatcher;
-use Symfony\Component\Routing\RouterInterface;
 
 final class RouterCacheWarmerTest extends TestCase
 {
-    public function testWarmUpWithWarmableInterface(): void
+    public function testWarmUpWithNoBuildDir(): void
     {
-        $cachePath = '/tmp/cache';
+        $cacheDir = '/tmp/cache';
+        $cacheFolder = 'websocket-router';
 
-        /** @var MockObject&testRouterInterfaceWithWarmableInterface $router */
-        $router = $this->createMock(testRouterInterfaceWithWarmableInterface::class);
+        /** @var MockObject&CacheWarmerInterface $innerCacheWarmer */
+        $innerCacheWarmer = $this->createMock(CacheWarmerInterface::class);
 
-        $router->expects(self::once())
+        $innerCacheWarmer->expects(self::once())
             ->method('warmUp')
-            ->with($cachePath)
-            ->willReturn(
-                [
-                    UrlGenerator::class,
-                    UrlMatcher::class,
-                ]
-            );
-
-        /** @var MockObject&ContainerInterface $container */
-        $container = $this->createMock(ContainerInterface::class);
-        $container->method('get')
-            ->with('babdev_websocket_server.router')
-            ->willReturn($router);
+            ->with(sprintf('%s/%s', $cacheDir, $cacheFolder), null)
+            ->willReturn([
+                UrlGenerator::class,
+                UrlMatcher::class,
+            ]);
 
         self::assertSame([
             UrlGenerator::class,
             UrlMatcher::class,
-        ], (new RouterCacheWarmer($container, $cachePath))->warmUp('/tmp'));
+        ], (new RouterCacheWarmer($innerCacheWarmer, $cacheFolder))->warmUp($cacheDir, null));
     }
 
-    public function testWarmUpWithoutWarmableInterface(): void
+    public function testWarmUpWithBuildDir(): void
     {
-        $this->expectException(\LogicException::class);
+        $buildDir = '/tmp/build';
+        $cacheDir = '/tmp/cache';
+        $cacheFolder = 'websocket-router';
 
-        /** @var MockObject&testRouterInterfaceWithoutWarmableInterface $router */
-        $router = $this->createMock(testRouterInterfaceWithoutWarmableInterface::class);
+        /** @var MockObject&CacheWarmerInterface $innerCacheWarmer */
+        $innerCacheWarmer = $this->createMock(CacheWarmerInterface::class);
 
-        /** @var MockObject&ContainerInterface $container */
-        $container = $this->createMock(ContainerInterface::class);
-        $container->method('get')
-            ->with('babdev_websocket_server.router')
-            ->willReturn($router);
+        $innerCacheWarmer->expects(self::once())
+            ->method('warmUp')
+            ->with(sprintf('%s/%s', $cacheDir, $cacheFolder), sprintf('%s/%s', $buildDir, $cacheFolder))
+            ->willReturn([
+                UrlGenerator::class,
+                UrlMatcher::class,
+            ]);
 
-        (new RouterCacheWarmer($container, '/tmp/cache'))->warmUp('/tmp');
+        self::assertSame([
+            UrlGenerator::class,
+            UrlMatcher::class,
+        ], (new RouterCacheWarmer($innerCacheWarmer, $cacheFolder))->warmUp($cacheDir, $buildDir));
     }
 }
-
-interface testRouterInterfaceWithWarmableInterface extends RouterInterface, WarmableInterface {}
-
-interface testRouterInterfaceWithoutWarmableInterface extends RouterInterface {}