Merge pull request #6 from TheDragonCode/1.x

Added tests

Author: andrey-helldar

.github/workflows/tests.yml

@@ -11,8 +11,9 @@ jobs:
             fail-fast: true
             matrix:
                 php: [ "8.2", "8.3", "8.4" ]
+                laravel: [ "11.0", "12.0" ]
 
-        name: PHP ${{ matrix.php }}
+        name: PHP ${{ matrix.php }}, Laravel ${{ matrix.laravel }}
 
         steps:
             -   name: Checkout code
@@ -26,7 +27,7 @@ jobs:
                     coverage: xdebug
 
             -   name: Install dependencies
-                run: composer update
+                run: composer require --dev laravel/framework:^${{ matrix.laravel }}
 
             -   name: Execute tests
                 run: composer test

composer.json

@@ -12,27 +12,50 @@
     "require": {
         "php": "^8.2",
         "dragon-code/telemetry": "^1.0",
-        "illuminate/http": "^10.0 || ^11.0 || ^12.0",
-        "illuminate/support": "^10.0 || ^11.0 || ^12.0"
+        "illuminate/http": "^11.0 || ^12.0",
+        "illuminate/support": "^11.0 || ^12.0"
     },
     "require-dev": {
         "dragon-code/codestyler": "^6.3",
-        "orchestra/testbench": "^10.6",
-        "pestphp/pest": "^4.0",
-        "pestphp/pest-plugin-type-coverage": "^4.0",
-        "symfony/var-dumper": "^7.3"
+        "orchestra/testbench": "^9.0 || ^10.0",
+        "pestphp/pest": "^3.0 || ^4.0",
+        "pestphp/pest-plugin-type-coverage": "^3.0 || ^4.0",
+        "symfony/var-dumper": "^6.0 || ^7.3"
     },
     "minimum-stability": "stable",
     "autoload": {
         "psr-4": {
             "DragonCode\\LaravelTracker\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
     "config": {
         "allow-plugins": {
             "ergebnis/composer-normalize": true,
             "laravel/pint": true,
             "pestphp/pest-plugin": true
         }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "DragonCode\\LaravelTracker\\LaravelTelemetryServiceProvider"
+            ]
+        }
+    },
+    "scripts": {
+        "post-update-cmd": [
+            "@php vendor/bin/codestyle pint 8.2 --ansi",
+            "@php vendor/bin/codestyle editorconfig --ansi",
+            "composer normalize --ansi"
+        ],
+        "style": "@php vendor/bin/pint",
+        "test": "vendor/bin/pest",
+        "test:coverage": "vendor/bin/pest --coverage",
+        "test:type": "vendor/bin/pest --type-coverage --compact --min=95"
     }
 }

tests/Feature/TelemetryMiddlewareTest.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\LaravelTracker\Http\Middleware\TelemetryMiddleware;
+use Illuminate\Http\Request;
+use Illuminate\Support\Str;
+use Symfony\Component\HttpFoundation\Response;
+
+it('sets headers and context for guest user', function () {
+    $middleware = new TelemetryMiddleware;
+
+    $captured = null;
+
+    $response = $middleware->handle(
+        makeRequest(ip: '198.51.100.42'),
+        function (Request $request) use (&$captured): Response {
+            $captured = $request;
+
+            return new Response('OK', 200);
+        }
+    );
+
+    expect($response->getStatusCode())->toBe(200);
+
+    $userId = $captured->headers->get('X-Telemetry-User-Id');
+    $ip     = $captured->headers->get('X-Telemetry-Ip');
+    $trace  = $captured->headers->get('X-Telemetry-Trace-Id');
+
+    expect($userId)->toBe('0');
+    expect($ip)->toBe('198.51.100.42');
+    expect($trace)->not()->toBeEmpty()->and(Str::isUuid($trace))->toBeTrue();
+
+    // context('telemetry') is added by middleware
+    $context = context('telemetry');
+
+    expect($context)
+        ->toBeArray()
+        ->toHaveKeys(['userId', 'ip', 'traceId']);
+
+    expect($context['userId'])->toBe('0');
+    expect($context['ip'])->toBe('198.51.100.42');
+    expect($context['traceId'])->toBe($trace);
+});
+
+it('uses authenticated user id when available', function () {
+    $middleware = new TelemetryMiddleware;
+
+    $user = new class {
+        public function getKey(): int
+        {
+            return 123;
+        }
+    };
+
+    $captured = null;
+
+    $middleware->handle(
+        makeRequest(userResolver: fn () => $user),
+        function (Request $request) use (&$captured): Response {
+            $captured = $request;
+
+            return new Response('OK', 200);
+        }
+    );
+
+    $userId = $captured->headers->get('X-Telemetry-User-Id');
+
+    expect($userId)->toBe('123');
+
+    $context = context('telemetry');
+
+    expect($context['userId'])->toBe('123');
+});
+
+it('respects existing telemetry headers', function () {
+    $middleware = new TelemetryMiddleware;
+
+    $existing = [
+        'X-Telemetry-User-Id'  => '777',
+        'X-Telemetry-Ip'       => '192.0.2.55',
+        'X-Telemetry-Trace-Id' => (string) Str::uuid(),
+    ];
+
+    $captured = null;
+
+    $middleware->handle(
+        makeRequest(headers: $existing),
+        function (Request $request) use (&$captured): Response {
+            $captured = $request;
+
+            return new Response('OK', 200);
+        }
+    );
+
+    foreach ($existing as $key => $value) {
+        expect($captured->headers->get($key))->toBe($value);
+    }
+
+    $context = context('telemetry');
+
+    expect($context['userId'])->toBe('777');
+    expect($context['ip'])->toBe('192.0.2.55');
+    expect($context['traceId'])->toBe($existing['X-Telemetry-Trace-Id']);
+});

tests/Helpers/request.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Http\Request;
+
+function makeRequest(string $ip = '203.0.113.10', ?callable $userResolver = null, array $headers = []): Request
+{
+    $request = Request::create(uri: '/', server: [
+        'REMOTE_ADDR' => $ip,
+    ]);
+
+    foreach ($headers as $key => $value) {
+        $request->headers->set($key, $value);
+    }
+
+    if ($userResolver) {
+        $request->setUserResolver($userResolver);
+    }
+
+    return $request;
+}

tests/Pest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Orchestra\Testbench\TestCase;
+use Tests\TestCase;
 
 pest()
     ->printer()

tests/TestCase.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests;
+
+use DragonCode\LaravelTracker\LaravelTelemetryServiceProvider;
+use Orchestra\Testbench\TestCase as BaseTestCase;
+
+abstract class TestCase extends BaseTestCase
+{
+    protected function getPackageProviders($app): array
+    {
+        return [
+            LaravelTelemetryServiceProvider::class,
+        ];
+    }
+}