Ensure the server negotiator has a response factory

Author: mbabker

composer.json

@@ -28,6 +28,7 @@
         "doctrine/dbal": "^3.4 || ^4.0",
         "doctrine/doctrine-bundle": "^2.7",
         "fig/log-test": "^1.1",
+        "guzzlehttp/psr7": "^2.4",
         "matthiasnoback/symfony-config-test": "^5.1",
         "matthiasnoback/symfony-dependency-injection-test": "^5.1",
         "phpstan/extension-installer": "^1.2",
@@ -37,6 +38,7 @@
         "phpunit/phpunit": "9.6.22",
         "psr/cache": "^1.0 || ^2.0 || ^3.0",
         "psr/container": "^1.0 || ^2.0",
+        "psr/http-message": "^1.0 || ^2.0",
         "psr/log": "^1.0 || ^2.0 || ^3.0",
         "ratchet/rfc6455": "^0.4",
         "react/event-loop": "^1.5",
@@ -50,6 +52,7 @@
         "doctrine/doctrine-bundle": "<2.7 || >=3.0",
         "psr/cache": ">=4.0",
         "psr/container": ">=3.0",
+        "psr/http-message": ">=3.0",
         "psr/log": ">=4.0",
         "ratchet/rfc6455": "<0.4 || >=0.5",
         "react/event-loop": "<1.5 || >=2.0",

config/services.php

@@ -164,6 +164,7 @@
     $services->set('babdev_websocket_server.rfc6455.server_negotiator', ServerNegotiator::class)
         ->args([
             inline_service(RequestVerifier::class),
+            abstract_arg('response factory'),
         ])
     ;
 

src/BabDevWebSocketBundle.php

@@ -4,6 +4,7 @@
 
 use BabDev\WebSocketBundle\DependencyInjection\BabDevWebSocketExtension;
 use BabDev\WebSocketBundle\DependencyInjection\Compiler\BuildMiddlewareStackCompilerPass;
+use BabDev\WebSocketBundle\DependencyInjection\Compiler\ConfigureHttpFactoriesCompilerPass;
 use BabDev\WebSocketBundle\DependencyInjection\Compiler\PingDBALConnectionsCompilerPass;
 use BabDev\WebSocketBundle\DependencyInjection\Compiler\RoutingResolverCompilerPass;
 use BabDev\WebSocketBundle\DependencyInjection\Factory\Authentication\SessionAuthenticationProviderFactory;
@@ -16,6 +17,7 @@ final class BabDevWebSocketBundle extends Bundle
     public function build(ContainerBuilder $container): void
     {
         $container->addCompilerPass(new BuildMiddlewareStackCompilerPass());
+        $container->addCompilerPass(new ConfigureHttpFactoriesCompilerPass());
         $container->addCompilerPass(new PingDBALConnectionsCompilerPass());
         $container->addCompilerPass(new RoutingResolverCompilerPass());
 

src/DependencyInjection/Compiler/ConfigureHttpFactoriesCompilerPass.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace BabDev\WebSocketBundle\DependencyInjection\Compiler;
+
+use GuzzleHttp\Psr7\HttpFactory;
+use Psr\Http\Message\ResponseFactoryInterface;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * Configures PSR-17 factories for services which require one.
+ *
+ * @internal
+ */
+final class ConfigureHttpFactoriesCompilerPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        $this->processServerNegotiator($container);
+    }
+
+    private function processServerNegotiator(ContainerBuilder $container): void
+    {
+        if (!$container->hasDefinition('babdev_websocket_server.rfc6455.server_negotiator')) {
+            return;
+        }
+
+        // Based on the Flex recipes, if the application already has a response factory service, we'll prefer that
+        if ($container->has(ResponseFactoryInterface::class)) {
+            $container->getDefinition('babdev_websocket_server.rfc6455.server_negotiator')
+                ->replaceArgument(1, new Reference(ResponseFactoryInterface::class));
+
+            return;
+        }
+
+        // Since the `guzzle/psr7` package is a hard requirement of the server library, we'll use that as a fallback
+        $container->getDefinition('babdev_websocket_server.rfc6455.server_negotiator')
+            ->replaceArgument(1, $container->register('.babdev_websocket_server.psr17_response_factory', HttpFactory::class));
+    }
+}

tests/DependencyInjection/Compiler/ConfigureHttpFactoriesCompilerPassTest.php

@@ -0,0 +1,56 @@
+<?php declare(strict_types=1);
+
+namespace BabDev\WebSocketBundle\Tests\DependencyInjection\Compiler;
+
+use BabDev\WebSocketBundle\DependencyInjection\Compiler\ConfigureHttpFactoriesCompilerPass;
+use GuzzleHttp\Psr7\HttpFactory;
+use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractCompilerPassTestCase;
+use Psr\Http\Message\ResponseFactoryInterface;
+use Ratchet\RFC6455\Handshake\RequestVerifier;
+use Ratchet\RFC6455\Handshake\ServerNegotiator;
+use Symfony\Component\DependencyInjection\Argument\AbstractArgument;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+final class ConfigureHttpFactoriesCompilerPassTest extends AbstractCompilerPassTestCase
+{
+    /**
+     * @testdox Uses the PSR-17 factory defined by the application
+     */
+    public function testUsesThePsr17FactoryDefinedByTheApplication(): void
+    {
+        $this->container->register('babdev_websocket_server.rfc6455.server_negotiator', ServerNegotiator::class)
+            ->setArguments([
+                new Definition(RequestVerifier::class),
+                new AbstractArgument('response factory'),
+            ])
+        ;
+
+        $this->container->setAlias(ResponseFactoryInterface::class, HttpFactory::class);
+
+        $this->compile();
+
+        $this->assertContainerBuilderHasServiceDefinitionWithArgument('babdev_websocket_server.rfc6455.server_negotiator', 1, new Reference(ResponseFactoryInterface::class));
+    }
+
+    public function testUsesTheGuzzleFactoryWhenNoFactoryIsDefinedByTheApplication(): void
+    {
+        $this->container->register('babdev_websocket_server.rfc6455.server_negotiator', ServerNegotiator::class)
+            ->setArguments([
+                new Definition(RequestVerifier::class),
+                new AbstractArgument('response factory'),
+            ])
+        ;
+
+        $this->compile();
+
+        $this->assertContainerBuilderHasService('.babdev_websocket_server.psr17_response_factory');
+        $this->assertContainerBuilderHasServiceDefinitionWithArgument('babdev_websocket_server.rfc6455.server_negotiator', 1, $this->container->getDefinition('.babdev_websocket_server.psr17_response_factory'));
+    }
+
+    protected function registerCompilerPass(ContainerBuilder $container): void
+    {
+        $container->addCompilerPass(new ConfigureHttpFactoriesCompilerPass());
+    }
+}