[HttpClient][Messenger] add PingWebhook and PingWebhookHandler

kbond · kbond · commit c6a488512507 · 2023-07-28T07:57:46.000-04:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -83,6 +83,7 @@
 use Symfony\Component\HtmlSanitizer\HtmlSanitizer;
 use Symfony\Component\HtmlSanitizer\HtmlSanitizerConfig;
 use Symfony\Component\HtmlSanitizer\HtmlSanitizerInterface;
+use Symfony\Component\HttpClient\Messenger\PingWebhookHandler;
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\HttpClient\Retry\GenericRetryStrategy;
 use Symfony\Component\HttpClient\RetryableHttpClient;
@@ -2455,6 +2456,10 @@ private function registerHttpClientConfiguration(array $config, ContainerBuilder
         unset($options['vars']);
         $container->getDefinition('http_client.transport')->setArguments([$options, $config['max_host_connections'] ?? 6]);
 
+        if (!class_exists(PingWebhookHandler::class)) {
+            $container->removeDefinition('http_client.messenger.ping_webhook_handler');
+        }
+
         if (!$hasPsr18 = ContainerBuilder::willBeAvailable('psr/http-client', ClientInterface::class, ['symfony/framework-bundle', 'symfony/http-client'])) {
             $container->removeDefinition('psr18.http_client');
             $container->removeAlias(ClientInterface::class);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/http_client.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/http_client.php
@@ -17,6 +17,7 @@
 use Psr\Http\Message\StreamFactoryInterface;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\HttpClient\HttplugClient;
+use Symfony\Component\HttpClient\Messenger\PingWebhookHandler;
 use Symfony\Component\HttpClient\Psr18Client;
 use Symfony\Component\HttpClient\Retry\GenericRetryStrategy;
 use Symfony\Component\HttpClient\UriTemplateHttpClient;
@@ -90,5 +91,11 @@
             ->args([
                 [inline_service(\Rize\UriTemplate::class), 'expand'],
             ])
+
+        ->set('http_client.messenger.ping_webhook_handler', PingWebhookHandler::class)
+            ->args([
+                service('http_client'),
+            ])
+            ->tag('messenger.message_handler')
     ;
 };
diff --git a/src/Symfony/Component/HttpClient/CHANGELOG.md b/src/Symfony/Component/HttpClient/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add `HarFileResponseFactory` testing utility, allow to replay responses from `.har` files
  * Add `max_retries` option to `RetryableHttpClient` to adjust the retry logic on a per request level
+ * Add `PingWehook` and `PingWebhookHandler`
 
 6.3
 ---
diff --git a/src/Symfony/Component/HttpClient/Messenger/PingWebhook.php b/src/Symfony/Component/HttpClient/Messenger/PingWebhook.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpClient\Messenger;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class PingWebhook implements \Stringable
+{
+    public function __construct(
+        public readonly string $method,
+        public readonly string $url,
+        public readonly array $options = [],
+        public readonly bool $throw = true,
+    ) {
+    }
+
+    public function __toString(): string
+    {
+        return "[{$this->method}] {$this->url}";
+    }
+}
diff --git a/src/Symfony/Component/HttpClient/Messenger/PingWebhookHandler.php b/src/Symfony/Component/HttpClient/Messenger/PingWebhookHandler.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpClient\Messenger;
+
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class PingWebhookHandler
+{
+    public function __construct(private readonly HttpClientInterface $httpClient)
+    {
+    }
+
+    public function __invoke(PingWebhook $message): ResponseInterface
+    {
+        $response = $this->httpClient->request($message->method, $message->url, $message->options);
+        $response->getHeaders($message->throw);
+
+        return $response;
+    }
+}
diff --git a/src/Symfony/Component/HttpClient/Tests/Messenger/PingWebhookHandlerTest.php b/src/Symfony/Component/HttpClient/Tests/Messenger/PingWebhookHandlerTest.php
@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpClient\Tests\Messenger;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpClient\Exception\ClientException;
+use Symfony\Component\HttpClient\Exception\ServerException;
+use Symfony\Component\HttpClient\Messenger\PingWebhook;
+use Symfony\Component\HttpClient\Messenger\PingWebhookHandler;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\MockResponse;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class PingWebhookHandlerTest extends TestCase
+{
+    public function testSuccessfulPing()
+    {
+        $client = new MockHttpClient([
+            function ($method, $url) {
+                $this->assertSame('POST', $method);
+                $this->assertSame('https://endpoint.com/key', $url);
+
+                return new MockResponse('a response');
+            },
+        ]);
+        $handler = new PingWebhookHandler($client);
+        $response = $handler(new PingWebhook('POST', 'https://endpoint.com/key'));
+
+        $this->assertSame(200, $response->getStatusCode());
+        $this->assertSame('a response', $response->getContent());
+        $this->assertSame('https://endpoint.com/key', $response->getInfo('url'));
+    }
+
+    public function testPingErrorThrowsException()
+    {
+        $client = new MockHttpClient([
+            function ($method, $url) {
+                $this->assertSame('POST', $method);
+                $this->assertSame('https://endpoint.com/key', $url);
+
+                return new MockResponse('a response', ['http_code' => 404]);
+            },
+        ]);
+
+        $handler = new PingWebhookHandler($client);
+
+        $this->expectException(ClientException::class);
+
+        $handler(new PingWebhook('POST', 'https://endpoint.com/key'));
+    }
+
+    public function testPingErrorDoesNotThrowException()
+    {
+        $client = new MockHttpClient([
+            function ($method, $url) {
+                $this->assertSame('POST', $method);
+                $this->assertSame('https://endpoint.com/key', $url);
+
+                return new MockResponse('a response', ['http_code' => 404]);
+            },
+        ]);
+
+        $handler = new PingWebhookHandler($client);
+        $response = $handler(new PingWebhook('POST', 'https://endpoint.com/key', throw: false));
+
+        $this->assertSame(404, $response->getStatusCode());
+        $this->assertSame('a response', $response->getContent(false));
+        $this->assertSame('https://endpoint.com/key', $response->getInfo('url'));
+    }
+}
diff --git a/src/Symfony/Component/HttpClient/composer.json b/src/Symfony/Component/HttpClient/composer.json
@@ -39,6 +39,7 @@
         "psr/http-client": "^1.0",
         "symfony/dependency-injection": "^5.4|^6.0|^7.0",
         "symfony/http-kernel": "^5.4|^6.0|^7.0",
+        "symfony/messenger": "^5.4|^6.0|^7.0",
         "symfony/process": "^5.4|^6.0|^7.0",
         "symfony/stopwatch": "^5.4|^6.0|^7.0"
     },
