Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,17 @@ composer require dragon-code/request-tracker
### Using Default Header Names

```php
use DragonCode\RequestTracker\TrackerHeader;
use DragonCode\RequestTracker\TrackerRequest;
use Symfony\Component\HttpFoundation\Request;

/** @var Request $request */
$request = /* ... */;

$tracker = new TrackerRequest($request, new TrackerHeader);
$tracker = new TrackerRequest($request);

function tracker(Request $request, ?int $userId = null): Request
{
return (new TrackerRequest($request, new TrackerHeader))
return (new TrackerRequest($request))
->userId($userId)
->ip()
->traceId()
Expand All @@ -52,18 +51,17 @@ tracker($request);
### Custom Headers

```php
use DragonCode\RequestTracker\TrackerHeader;
use DragonCode\RequestTracker\TrackerRequest;
use Symfony\Component\HttpFoundation\Request;

/** @var Request $request */
$request = /* ... */;

$tracker = new TrackerRequest($request, new TrackerHeader);
$tracker = new TrackerRequest($request);

function tracker(Request $request, ?int $userId = null): Request
{
return (new TrackerRequest($request, new TrackerHeader))
return (new TrackerRequest($request))
->userId($userId)
->ip()
->traceId()
Expand All @@ -90,12 +88,17 @@ return $item->headers->get('Some-Header'); // qwerty

```php
use DragonCode\RequestTracker\TrackerHeader;
use DragonCode\RequestTracker\TrackerRequest;
use Symfony\Component\HttpFoundation\Request;

return new TrackerHeader(
$headers = new TrackerHeader(
userId: 'Some-User-Id',
ip: 'Some-IP',
traceId: 'Some-Trace-Id',
);

/** @var Request $request */
return new TrackerRequest($request, $headers);
```

## License
Expand Down
2 changes: 1 addition & 1 deletion src/TrackerRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class TrackerRequest
{
public function __construct(
protected Request $request,
protected TrackerHeader $header,
protected TrackerHeader $header = new TrackerHeader,
protected TrackerUuid $uuid = new TrackerUuid,
) {}

Expand Down
7 changes: 2 additions & 5 deletions tests/Unit/Request/CustomTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@

declare(strict_types=1);

use DragonCode\RequestTracker\TrackerHeader;
use DragonCode\RequestTracker\TrackerRequest;
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 TrackerHeader;
$telemetry = new TrackerRequest($request, $header);
$telemetry = new TrackerRequest($request);

$telemetry->custom($headerName, function (Request $req) {
expect($req)->toBeInstanceOf(Request::class);
Expand All @@ -28,8 +26,7 @@
$request = makeRequest([$headerName => 'qwerty']);

$called = false;
$header = new TrackerHeader;
$telemetry = new TrackerRequest($request, $header);
$telemetry = new TrackerRequest($request);

$telemetry->custom($headerName, function () use (&$called) {
$called = true;
Expand Down
4 changes: 1 addition & 3 deletions tests/Unit/Request/GetRequestTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@

declare(strict_types=1);

use DragonCode\RequestTracker\TrackerHeader;
use DragonCode\RequestTracker\TrackerRequest;

it('returns the same Request instance via getRequest()', function () {
$header = new TrackerHeader;
$request = makeRequest();
$telemetry = new TrackerRequest($request, $header);
$telemetry = new TrackerRequest($request);

expect($telemetry->getRequest())->toBe($request);
});
8 changes: 2 additions & 6 deletions tests/Unit/Request/IpTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,16 @@
});

test('HTTP_X_REAL_IP (non-standard header name checked by the class)', function () {
$header = new TrackerHeader;

$request = makeRequest();
$request->headers->set('HTTP_X_REAL_IP', '198.51.100.20');
$telemetry = new TrackerRequest($request, $header);
$telemetry = new TrackerRequest($request);

expect($telemetry->getIp())->toBe('198.51.100.20');
});

test('client ip (REMOTE_ADDR)', function () {
$header = new TrackerHeader;

$request = makeRequest([], ['REMOTE_ADDR' => '192.0.2.30']);
$telemetry = new TrackerRequest($request, $header);
$telemetry = new TrackerRequest($request);

expect($telemetry->getIp())->toBe('192.0.2.30');
});
Expand Down
4 changes: 1 addition & 3 deletions tests/Unit/Request/TraceIdTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,8 @@
});

test('When absent, generate UUID', function () {
$header = new TrackerHeader;

$request = makeRequest();
$telemetry = new TrackerRequest($request, $header);
$telemetry = new TrackerRequest($request);
$generated = $telemetry->getTraceId();

expect(Uuid::isValid($generated))->toBeTrue()
Expand Down
4 changes: 1 addition & 3 deletions tests/Unit/Request/UserIdTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,8 @@
});

test('getUserId() returns 0 when nothing present', function () {
$header = new TrackerHeader;

$request = makeRequest();
$telemetry = new TrackerRequest($request, $header);
$telemetry = new TrackerRequest($request);
expect($telemetry->getUserId())->toBeNull();
});

Expand Down