Merge pull request #21 from Clearfacts/CLEARFACTS-10616

[CLEARFACTS-10616] symfony http client decorator for correlation id

composer.json

@@ -23,11 +23,13 @@
     "require-dev": {
         "phpunit/phpunit": "^9.1",
         "clearfacts/cf-codestyle": "^3.1",
-        "symfony/messenger": "^5.4 || ^6"
+        "symfony/messenger": "^5.4 || ^6",
+        "symfony/http-client": "^5.4 || ^6"
     },
     "suggest": {
         "symfony/security": "If you want to log user-id's",
-        "symfony/messenger": "If you want to use the message serializer for correlation id's"
+        "symfony/messenger": "If you want to use the message serializer for correlation id's",
+        "symfony/http-client": "If you want to use the http client decorator for correlation id's"
     },
     "scripts": {
         "set-up": [

src/Correlation/Http/CorrelationHttpClientDecorator.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Datalog\Correlation\Http;
+
+use Datalog\Correlation\Correlation;
+use Symfony\Component\HttpClient\DecoratorTrait;
+use Symfony\Component\HttpClient\HttpClient;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+class CorrelationHttpClientDecorator implements HttpClientInterface
+{
+    use DecoratorTrait;
+
+    private Correlation $correlation;
+
+    public function __construct(
+        Correlation $correlation,
+        ?HttpClientInterface $client = null,
+    ) {
+        $this->correlation = $correlation;
+        $this->client = $client ?? HttpClient::create();
+    }
+
+    public function request(string $method, string $url, array $options = []): ResponseInterface
+    {
+        if (!isset($options['headers']) || !array_key_exists('correlation_id', $options['headers'])) {
+            $options['headers']['correlation_id'] = $this->correlation->getId();
+        }
+
+        return $this->client->request($method, $url, $options);
+    }
+}

tests/Correlation/Http/CorrelationHttpClientDecoratorTest.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace Tests\Datalog\Correlation\Http;
+
+use Datalog\Correlation\Correlation;
+use Datalog\Correlation\Http\CorrelationHttpClientDecorator;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\MockResponse;
+
+class CorrelationHttpClientDecoratorTest extends TestCase
+{
+    public function testAddsHeader(): void
+    {
+        Correlation::setId('test-id');
+
+        $client = new MockHttpClient(function ($method, $url, $options) {
+            $this->assertSame(['correlation_id: test-id'], $options['normalized_headers']['correlation_id'] ?? null);
+
+            return new MockResponse();
+        });
+
+        $decorator = new CorrelationHttpClientDecorator(new Correlation(), $client);
+
+        $decorator->request('GET', 'http://example.com');
+    }
+}