feature #49815 [HttpClient][Messenger] add PingWebhookMessage and PingWebhookMessageHandler (kbond)

fabpot · fabpot · commit 4bc2e94333e9 · 2023-07-30T11:34:28.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [HttpClient][Messenger] add `PingWebhookMessage` and `PingWebhookMessageHandler` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | todo With symfony/scheduler, it could be useful to ping some kind of uptime monitoring service like [ohdearapp](https://ohdear.app/). ## Usage ```php use Symfony\Component\HttpClient\Messenger\PingWebhookMessage; $bus->dispatch(new PingWebhookMessage('GET', 'https://example.com')); // simple ping, throws HttpExceptionInterface on 3xx/4xx/5xx $bus->dispatch(new PingWebhookMessage('GET', 'https://example.com', throw: false)); // ping, but does not throw HttpExceptionInterface on 3xx/4xx/5xx $bus->dispatch(new PingWebhookMessage('GET', 'https://example.com', [ 'headers' => ['X-FOO => 'bar'], // any HttpClientInterface options ])); ``` TODO: - [x] wire up - [x] tests Commits ------- f0644d9f25 [HttpClient][Messenger] add `PingWebhookMessage` and `PingWebhookMessageHandler`
diff --git a/DependencyInjection/FrameworkExtension.php b/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\PingWebhookMessageHandler;
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\HttpClient\Retry\GenericRetryStrategy;
 use Symfony\Component\HttpClient\RetryableHttpClient;
@@ -2462,6 +2463,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(PingWebhookMessageHandler::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/Resources/config/http_client.php b/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\PingWebhookMessageHandler;
 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', PingWebhookMessageHandler::class)
+            ->args([
+                service('http_client'),
+            ])
+            ->tag('messenger.message_handler')
     ;
 };
