feat: get-version-from-composer-and-pass-it-in-headers (#112)

Author: Zaimwa9

src/Flagsmith.php

@@ -18,6 +18,7 @@
 use Flagsmith\Utils\IdentitiesGenerator;
 use Flagsmith\Utils\Mappers;
 use Flagsmith\Utils\Retry;
+use Flagsmith\Utils\UserAgent;
 use JsonException;
 use ValueError;
 use Psr\Http\Client\ClientInterface;
@@ -621,7 +622,8 @@ private function call(string $method, string $uri, array $body = [])
             ->createRequest($method, rtrim($this->host, '/') . '/' . $uri)
             ->withHeader('Accept', 'application/json')
             ->withHeader('Content-Type', 'application/json')
-            ->withHeader('X-Environment-Key', $this->apiKey);
+            ->withHeader('X-Environment-Key', $this->apiKey)
+            ->withHeader('User-Agent', UserAgent::get());
 
         if (!empty($this->customHeaders)) {
             foreach ($this->customHeaders as $name => $value) {

src/Utils/AnalyticsProcessor.php

@@ -67,6 +67,7 @@ public function flush()
             ->withHeader('Accept', 'application/json')
             ->withHeader('Content-Type', 'application/json')
             ->withHeader('X-Environment-Key', $this->environment_key)
+            ->withHeader('User-Agent', UserAgent::get())
             ->withBody($stream);
 
         try {

src/Utils/UserAgent.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Flagsmith\Utils;
+
+/**
+ * UserAgent utility class for generating SDK user agent strings.
+ */
+class UserAgent
+{
+    /**
+     * Get the user agent string for the SDK.
+     *
+     * @return string The user agent string in the format "flagsmith-php-sdk/{version}"
+     */
+    public static function get(): string
+    {
+        try {
+            $composerPath = __DIR__ . '/../../composer.json';
+            $content = file_get_contents($composerPath);
+            $data = json_decode($content, true);
+            $version = $data['version'] ?? null;
+
+            if ($version) {
+                return "flagsmith-php-sdk/{$version}";
+            }
+        } catch (\Exception $e) {
+            // Silently fall through to default
+        }
+
+        return 'flagsmith-php-sdk/unknown';
+    }
+}

tests/AnalyticsTest.php

@@ -30,14 +30,27 @@ public function testAnalyticsProcessorFlushClearsAnalyticsData()
 
     public function testAnalyticsProcessorFlushPostRequestDataMatchAnanlyticsData()
     {
+        $capturedRequest = null;
         $client = $this->createMock(ClientInterface::class);
 
         $analyticsProcessor = ClientFixtures::analyticsProcessor($client);
         $client->expects($this->once())
-            ->method('sendRequest');
+            ->method('sendRequest')
+            ->with($this->callback(function ($request) use (&$capturedRequest) {
+                $capturedRequest = $request;
+                return true;
+            }));
 
         $analyticsProcessor->trackFeature('my_feature');
         $analyticsProcessor->flush();
+
+        $this->assertNotNull($capturedRequest);
+        $this->assertTrue($capturedRequest->hasHeader('User-Agent'));
+        $userAgent = $capturedRequest->getHeaderLine('User-Agent');
+        $composerData = json_decode(file_get_contents(__DIR__ . '/../composer.json'), true);
+        $expectedVersion = $composerData['version'] ?? 'unknown';
+        $expectedUserAgent = "flagsmith-php-sdk/{$expectedVersion}";
+        $this->assertEquals($expectedUserAgent, $userAgent);
     }
 
     public function testAnalyticsProcessorFlushEarlyExitIfAnalyticsDataIsEmpty()

tests/FlagsmithClientTest.php

@@ -8,6 +8,7 @@
 use FlagsmithTest\Offline\FakeOfflineHandler;
 use GuzzleHttp\Psr7\Response;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\StreamFactoryInterface;
 
 class FlagsmithClientTest extends TestCase
@@ -449,4 +450,32 @@ public function testOfflineHandlerUsedAsFallbackForLocalEvaluation()
         $this->assertEquals($identityFlags->getFlag('some_feature')->enabled, true);
         $this->assertEquals($identityFlags->getFlag('some_feature')->value, 'some-value');
     }
+
+    public function testApiRequestsIncludeUserAgentHeader()
+    {
+        $capturedRequest = null;
+        $mockClient = $this->createMock(ClientInterface::class);
+        $mockClient->expects($this->once())
+            ->method('sendRequest')
+            ->with($this->callback(function ($request) use (&$capturedRequest) {
+                $capturedRequest = $request;
+                return true;
+            }))
+            ->willReturn(
+                new Response(200, ['Content-Type' => 'application/json'], file_get_contents(__DIR__ . '/Data/flags.json'))
+            );
+
+        $flagsmith = (new Flagsmith('api_key'))
+            ->withClient($mockClient);
+
+        $flagsmith->getEnvironmentFlags();
+
+        $this->assertNotNull($capturedRequest);
+        $this->assertTrue($capturedRequest->hasHeader('User-Agent'));
+        $userAgent = $capturedRequest->getHeaderLine('User-Agent');
+        $composerData = json_decode(file_get_contents(__DIR__ . '/../composer.json'), true);
+        $expectedVersion = $composerData['version'] ?? 'unknown';
+        $expectedUserAgent = "flagsmith-php-sdk/{$expectedVersion}";
+        $this->assertEquals($expectedUserAgent, $userAgent);
+    }
 }

tests/UserAgentTest.php

@@ -0,0 +1,18 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+use Flagsmith\Utils\UserAgent;
+
+class UserAgentTest extends TestCase
+{
+    public function testGetUserAgentReturnsVersionFromComposerJson()
+    {
+        $userAgent = UserAgent::get();
+
+        $composerPath = __DIR__ . '/../composer.json';
+        $composerData = json_decode(file_get_contents($composerPath), true);
+        $expectedVersion = $composerData['version'] ?? 'unknown';
+
+        $this->assertEquals("flagsmith-php-sdk/{$expectedVersion}", $userAgent);
+    }
+}