Split TelemetryRequest tests into dedicated files for better organization and added new test cases for custom header, IP, user ID, track ID, and request retrieval behavior.

Author: andrey-helldar

tests/Helpers/request.php

@@ -7,6 +7,7 @@
 function makeRequest(array $headers = [], array $server = []): Request
 {
     $serverFromHeaders = [];
+
     foreach ($headers as $key => $value) {
         $serverKey = 'HTTP_' . str_replace('-', '_', strtoupper($key));
 

tests/Unit/CustomTest.php

@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+// Custom tests have been moved to tests/Unit/Request/CustomTest.php.

tests/Unit/Request/CustomTest.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\Telemetry\TelemetryHeader;
+use DragonCode\Telemetry\TelemetryRequest;
+use Symfony\Component\HttpFoundation\Request;
+
+it('sets header from callback when header is absent and casts ints to strings', function () {
+    $headerName = 'Some-Header';
+
+    $request   = makeRequest();
+    $header    = new TelemetryHeader;
+    $telemetry = new TelemetryRequest($request, $header);
+
+    $telemetry->custom($headerName, function (Request $req) {
+        expect($req)->toBeInstanceOf(Request::class);
+
+        return 1234; // will be cast to string by TelemetryRequest::set
+    });
+
+    expect($request->headers->get($headerName))->toBe('1234');
+});
+
+it('preserves existing header and does not call the callback when header is present', function () {
+    $headerName = 'Some-Header';
+
+    $request = makeRequest([$headerName => 'qwerty']);
+
+    $called    = false;
+    $header    = new TelemetryHeader;
+    $telemetry = new TelemetryRequest($request, $header);
+
+    $telemetry->custom($headerName, function () use (&$called) {
+        $called = true; // must remain false if existing header is used
+
+        return 'should-not-be-used';
+    });
+
+    expect($called)->toBeFalse()
+        ->and($request->headers->get($headerName))->toBe('qwerty');
+});

tests/Unit/Request/GetRequestTest.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\Telemetry\TelemetryHeader;
+use DragonCode\Telemetry\TelemetryRequest;
+
+it('returns the same Request instance via getRequest()', function () {
+    $header    = new TelemetryHeader;
+    $request   = makeRequest();
+    $telemetry = new TelemetryRequest($request, $header);
+
+    expect($telemetry->getRequest())->toBe($request);
+});

tests/Unit/Request/IpTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\Telemetry\TelemetryHeader;
+use DragonCode\Telemetry\TelemetryRequest;
+
+it('gets ip with correct precedence and sets header via ip()', function () {
+    $header = new TelemetryHeader;
+
+    // 1) If telemetry header exists, it wins
+    $request   = makeRequest([$header->ip => '203.0.113.10']);
+    $telemetry = new TelemetryRequest($request, $header);
+    expect($telemetry->getIp())->toBe('203.0.113.10');
+
+    // 2) Else HTTP_X_REAL_IP (non-standard header name checked by the class)
+    $request = makeRequest();
+    $request->headers->set('HTTP_X_REAL_IP', '198.51.100.20');
+    $telemetry = new TelemetryRequest($request, $header);
+    expect($telemetry->getIp())->toBe('198.51.100.20');
+
+    // 3) Else client ip (REMOTE_ADDR)
+    $request   = makeRequest([], ['REMOTE_ADDR' => '192.0.2.30']);
+    $telemetry = new TelemetryRequest($request, $header);
+    expect($telemetry->getIp())->toBe('192.0.2.30');
+
+    // 4) ip() without argument sets header from getIp()
+    $telemetry->ip();
+    expect($request->headers->get($header->ip))->toBe('192.0.2.30');
+
+    // 5) ip() with value overrides and sets header
+    $telemetry->ip('10.0.0.1');
+    expect($request->headers->get($header->ip))->toBe('10.0.0.1');
+});

tests/Unit/Request/TrackIdTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\Telemetry\TelemetryHeader;
+use DragonCode\Telemetry\TelemetryRequest;
+use Ramsey\Uuid\Uuid;
+
+it('gets or sets track id, generating a UUID v4 when absent', function () {
+    $header = new TelemetryHeader;
+
+    // 1) If header exists, return it
+    $request   = makeRequest([$header->trackId => 'track-123']);
+    $telemetry = new TelemetryRequest($request, $header);
+    expect($telemetry->getTrackId())->toBe('track-123');
+
+    // 2) When absent, generate UUID v4
+    $request   = makeRequest();
+    $telemetry = new TelemetryRequest($request, $header);
+    $generated = $telemetry->getTrackId();
+    expect(Uuid::isValid($generated))->toBeTrue()
+        ->and(Uuid::fromString($generated)->getVersion())->toBe(4);
+
+    // 3) trackId() without param sets header using getTrackId()
+    $telemetry->trackId();
+    expect($request->headers->has($header->trackId))->toBeTrue()
+        ->and(Uuid::isValid($request->headers->get($header->trackId)))->toBeTrue();
+
+    // 4) trackId() with explicit value sets header
+    $telemetry->trackId('manual-id');
+    expect($request->headers->get($header->trackId))->toBe('manual-id');
+});

tests/Unit/Request/UserIdTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\Telemetry\TelemetryHeader;
+use DragonCode\Telemetry\TelemetryRequest;
+
+it('sets and gets user id with string and int, falling back to existing header or 0', function () {
+    $header = new TelemetryHeader;
+
+    // 1) Explicit string
+    $request   = makeRequest();
+    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry->userId('42');
+    expect($request->headers->get($header->userId))->toBe('42')
+        ->and($telemetry->getUserId())->toBe('42');
+
+    // 2) Explicit int should be cast to string
+    $request   = makeRequest();
+    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry->userId(7);
+    expect($request->headers->get($header->userId))->toBe('7');
+
+    // 3) Fallback to existing header when null
+    $request   = makeRequest([$header->userId => '555']);
+    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry->userId(null);
+    expect($request->headers->get($header->userId))->toBe('555')
+        ->and($telemetry->getUserId())->toBe('555');
+
+    // 4) getUserId() returns '0' when nothing present
+    $request   = makeRequest();
+    $telemetry = new TelemetryRequest($request, $header);
+    expect($telemetry->getUserId())->toBe('0');
+});

tests/Unit/RequestTest.php

@@ -2,96 +2,4 @@
 
 declare(strict_types=1);
 
-use DragonCode\Telemetry\TelemetryHeader;
-use DragonCode\Telemetry\TelemetryRequest;
-use Ramsey\Uuid\Uuid;
-
-it('sets and gets user id with string and int, falling back to existing header or 0', function () {
-    $header = new TelemetryHeader;
-
-    // 1) Explicit string
-    $request   = makeRequest();
-    $telemetry = new TelemetryRequest($request, $header);
-    $telemetry->userId('42');
-    expect($request->headers->get($header->userId))->toBe('42')
-        ->and($telemetry->getUserId())->toBe('42');
-
-    // 2) Explicit int should be cast to string
-    $request   = makeRequest();
-    $telemetry = new TelemetryRequest($request, $header);
-    $telemetry->userId(7);
-    expect($request->headers->get($header->userId))->toBe('7');
-
-    // 3) Fallback to existing header when null
-    $request   = makeRequest([$header->userId => '555']);
-    $telemetry = new TelemetryRequest($request, $header);
-    $telemetry->userId(null);
-    expect($request->headers->get($header->userId))->toBe('555')
-        ->and($telemetry->getUserId())->toBe('555');
-
-    // 4) getUserId() returns '0' when nothing present
-    $request   = makeRequest();
-    $telemetry = new TelemetryRequest($request, $header);
-    expect($telemetry->getUserId())->toBe('0');
-});
-
-it('gets ip with correct precedence and sets header via ip()', function () {
-    $header = new TelemetryHeader;
-
-    // 1) If telemetry header exists, it wins
-    $request   = makeRequest([$header->ip => '203.0.113.10']);
-    $telemetry = new TelemetryRequest($request, $header);
-    expect($telemetry->getIp())->toBe('203.0.113.10');
-
-    // 2) Else HTTP_X_REAL_IP (non-standard header name checked by the class)
-    $request = makeRequest();
-    $request->headers->set('HTTP_X_REAL_IP', '198.51.100.20');
-    $telemetry = new TelemetryRequest($request, $header);
-    expect($telemetry->getIp())->toBe('198.51.100.20');
-
-    // 3) Else client ip (REMOTE_ADDR)
-    $request   = makeRequest([], ['REMOTE_ADDR' => '192.0.2.30']);
-    $telemetry = new TelemetryRequest($request, $header);
-    expect($telemetry->getIp())->toBe('192.0.2.30');
-
-    // 4) ip() without argument sets header from getIp()
-    $telemetry->ip();
-    expect($request->headers->get($header->ip))->toBe('192.0.2.30');
-
-    // 5) ip() with value overrides and sets header
-    $telemetry->ip('10.0.0.1');
-    expect($request->headers->get($header->ip))->toBe('10.0.0.1');
-});
-
-it('gets or sets track id, generating a UUID v4 when absent', function () {
-    $header = new TelemetryHeader;
-
-    // 1) If header exists, return it
-    $request   = makeRequest([$header->trackId => 'track-123']);
-    $telemetry = new TelemetryRequest($request, $header);
-    expect($telemetry->getTrackId())->toBe('track-123');
-
-    // 2) When absent, generate UUID v4
-    $request   = makeRequest();
-    $telemetry = new TelemetryRequest($request, $header);
-    $generated = $telemetry->getTrackId();
-    expect(Uuid::isValid($generated))->toBeTrue()
-        ->and(Uuid::fromString($generated)->getVersion())->toBe(4);
-
-    // 3) trackId() without param sets header using getTrackId()
-    $telemetry->trackId();
-    expect($request->headers->has($header->trackId))->toBeTrue()
-        ->and(Uuid::isValid($request->headers->get($header->trackId)))->toBeTrue();
-
-    // 4) trackId() with explicit value sets header
-    $telemetry->trackId('manual-id');
-    expect($request->headers->get($header->trackId))->toBe('manual-id');
-});
-
-it('returns the same Request instance via getRequest()', function () {
-    $header    = new TelemetryHeader;
-    $request   = makeRequest();
-    $telemetry = new TelemetryRequest($request, $header);
-
-    expect($telemetry->getRequest())->toBe($request);
-});
+// Tests for TelemetryRequest have been split into grouped files under tests/Unit/Request.