Merge pull request #12 from Naoray/feat/add-tracing-capabilities

Naoray · web-flow · commit b2ce67fde38e · 2025-03-21T14:01:22.000+01:00
feat: add tracing capabilities
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ Automatically create GitHub issues from your Laravel exceptions & logs. Perfect
 - 🎯 Smart deduplication to prevent issue spam
 - ⚡️ Buffered logging for better performance
 - 📝 Customizable issue templates
+- 🕵🏻‍♂️ Tracing Support (Request & User)
 
 ## Showcase
 
@@ -168,6 +169,42 @@ When buffering is active:
   - With `flush_on_overflow = true`: All records are flushed
   - With `flush_on_overflow = false`: Only the oldest record is removed
 
+### Tracing
+
+The package includes optional tracing capabilities that allow you to track requests and user data in your logs. Enable this feature through your configuration:
+
+```php
+'tracing' => [
+    'enabled' => true,    // Master switch for all tracing
+    'requests' => true,   // Enable request tracing
+    'user' => true,      // Enable user tracing
+]
+```
+
+#### Request Tracing
+When request tracing is enabled, the following data is automatically logged:
+- URL
+- HTTP Method
+- Route information
+- Headers (filtered to remove sensitive data)
+- Request body
+
+#### User Tracing
+By default, user tracing only logs the user identifier to comply with GDPR regulations. However, you can customize the user data being logged by setting your own resolver:
+
+```php
+use Naoray\LaravelGithubMonolog\Tracing\UserDataCollector;
+
+UserDataCollector::setUserDataResolver(function ($user) {
+    return [
+        'username' => $user->username,
+        // Add any other user fields you want to log
+    ];
+});
+```
+
+> **Note:** When customizing user data collection, ensure you comply with relevant privacy regulations and only collect necessary information.
+
 ### Signature Generator
 
 Control how errors are grouped by customizing the signature generator. By default, the package uses a generator that creates signatures based on exception details or log message content.
diff --git a/src/GithubMonologServiceProvider.php b/src/GithubMonologServiceProvider.php
@@ -2,54 +2,20 @@
 
 namespace Naoray\LaravelGithubMonolog;
 
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider;
-use Naoray\LaravelGithubMonolog\Issues\Formatters\ExceptionFormatter;
-use Naoray\LaravelGithubMonolog\Issues\Formatters\IssueFormatter;
-use Naoray\LaravelGithubMonolog\Issues\Formatters\PreviousExceptionFormatter;
-use Naoray\LaravelGithubMonolog\Issues\Formatters\StackTraceFormatter;
-use Naoray\LaravelGithubMonolog\Issues\StubLoader;
-use Naoray\LaravelGithubMonolog\Issues\TemplateRenderer;
-use Naoray\LaravelGithubMonolog\Issues\TemplateSectionCleaner;
+use Naoray\LaravelGithubMonolog\Tracing\EventHandler;
 
 class GithubMonologServiceProvider extends ServiceProvider
 {
-    public function register(): void
+    public function boot(): void
     {
-        $this->app->bind(StackTraceFormatter::class);
-        $this->app->bind(StubLoader::class);
-        $this->app->bind(TemplateSectionCleaner::class);
-
-        $this->app->bind(ExceptionFormatter::class, function ($app) {
-            return new ExceptionFormatter(
-                stackTraceFormatter: $app->make(StackTraceFormatter::class),
-            );
-        });
-
-        $this->app->bind(PreviousExceptionFormatter::class, function ($app) {
-            return new PreviousExceptionFormatter(
-                exceptionFormatter: $app->make(ExceptionFormatter::class),
-                stubLoader: $app->make(StubLoader::class),
-            );
-        });
-
-        $this->app->singleton(TemplateRenderer::class, function ($app) {
-            return new TemplateRenderer(
-                exceptionFormatter: $app->make(ExceptionFormatter::class),
-                previousExceptionFormatter: $app->make(PreviousExceptionFormatter::class),
-                sectionCleaner: $app->make(TemplateSectionCleaner::class),
-                stubLoader: $app->make(StubLoader::class),
-            );
-        });
+        $config = config('logging.channels.github.tracing');
 
-        $this->app->singleton(IssueFormatter::class, function ($app) {
-            return new IssueFormatter(
-                templateRenderer: $app->make(TemplateRenderer::class),
-            );
-        });
-    }
+        if (isset($config['enabled']) && $config['enabled']) {
+            Event::subscribe(EventHandler::class);
+        }
 
-    public function boot(): void
-    {
         if ($this->app->runningInConsole()) {
             $this->publishes([
                 __DIR__.'/../resources/views' => resource_path('views/vendor/github-monolog'),
diff --git a/src/Tracing/EventHandler.php b/src/Tracing/EventHandler.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Naoray\LaravelGithubMonolog\Tracing;
+
+use Illuminate\Auth\Events\Authenticated;
+use Illuminate\Events\Dispatcher;
+use Illuminate\Routing\Events\RouteMatched;
+
+class EventHandler
+{
+    public function subscribe(Dispatcher $events)
+    {
+        $config = config('logging.channels.github.tracing');
+
+        if (isset($config['requests']) && $config['requests']) {
+            $events->listen(RouteMatched::class, RequestDataCollector::class);
+        }
+
+        if (isset($config['user']) && $config['user']) {
+            $events->listen(Authenticated::class, UserDataCollector::class);
+        }
+    }
+}
diff --git a/src/Tracing/RequestDataCollector.php b/src/Tracing/RequestDataCollector.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace Naoray\LaravelGithubMonolog\Tracing;
+
+use Illuminate\Routing\Events\RouteMatched;
+use Illuminate\Support\Facades\Context;
+use Illuminate\Support\Str;
+
+class RequestDataCollector
+{
+    public function __invoke(RouteMatched $event): void
+    {
+        $route = $event->route;
+        $request = $event->request;
+
+        Context::add('request', [
+            'url' => $request->url(),
+            'method' => $request->method(),
+            'route' => $route->getName(),
+            'headers' => $this->filterSensitiveHeaders($request->headers->all()),
+            'body' => $request->all(),
+        ]);
+    }
+
+    private function filterSensitiveHeaders(array $headers): array
+    {
+        $sensitiveHeaders = $this->getSensitiveHeaders();
+
+        return collect($headers)
+            ->map(function ($value, $key) use ($sensitiveHeaders) {
+                if (Str::is($sensitiveHeaders, $key, true)) {
+                    return ['[FILTERED]'];
+                }
+
+                return $value;
+            })
+            ->toArray();
+    }
+
+    private function getSensitiveHeaders(): array
+    {
+        $sensitiveHeaders = [
+            config('session.cookie'),
+            'remember_*',
+            'XSRF-TOKEN',
+            'cookie',
+        ];
+
+        return collect($sensitiveHeaders)
+            ->merge(collect($sensitiveHeaders)->map(fn ($header) => str($header)->replace('_', '-'))->toArray())
+            ->unique()
+            ->toArray();
+    }
+}
diff --git a/src/Tracing/UserDataCollector.php b/src/Tracing/UserDataCollector.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Naoray\LaravelGithubMonolog\Tracing;
+
+use Illuminate\Auth\Events\Authenticated;
+use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Support\Facades\Context;
+
+class UserDataCollector
+{
+    private static $userDataResolver = null;
+
+    public static function setUserDataResolver(callable $resolver): void
+    {
+        self::$userDataResolver = $resolver;
+    }
+
+    public function __invoke(Authenticated $event): void
+    {
+        Context::add(
+            'user',
+            $this->getUserDataResolver()($event->user)
+        );
+    }
+
+    public function getUserDataResolver(): ?callable
+    {
+        return self::$userDataResolver
+            ?? fn (Authenticatable $user) => ['id' => $user->getAuthIdentifier()];
+    }
+}
diff --git a/tests/Tracing/RequestDataCollectorTest.php b/tests/Tracing/RequestDataCollectorTest.php
@@ -0,0 +1,83 @@
+<?php
+
+use Illuminate\Http\Request;
+use Illuminate\Routing\Events\RouteMatched;
+use Illuminate\Routing\Route;
+use Illuminate\Support\Facades\Context;
+use Naoray\LaravelGithubMonolog\Tracing\RequestDataCollector;
+use Symfony\Component\HttpFoundation\HeaderBag;
+
+beforeEach(function () {
+    $this->collector = new RequestDataCollector;
+});
+
+afterEach(function () {
+    Context::flush();
+});
+
+it('collects request data', function () {
+    // Arrange
+    $request = Mockery::mock(Request::class);
+    $route = Mockery::mock(Route::class);
+    $headers = new HeaderBag([
+        'accept' => ['application/json'],
+        'cookie' => ['sensitive-cookie'],
+        'x-custom' => ['custom-value'],
+    ]);
+
+    $request->headers = $headers;
+    $request->shouldReceive('url')->once()->andReturn('https://example.com/test');
+    $request->shouldReceive('method')->once()->andReturn('POST');
+    $request->shouldReceive('all')->once()->andReturn(['key' => 'value']);
+    $route->shouldReceive('getName')->once()->andReturn('test.route');
+
+    $event = new RouteMatched($route, $request);
+
+    // Act
+    ($this->collector)($event);
+
+    // Assert
+    expect(Context::get('request'))->toBe([
+        'url' => 'https://example.com/test',
+        'method' => 'POST',
+        'route' => 'test.route',
+        'headers' => [
+            'accept' => ['application/json'],
+            'cookie' => ['[FILTERED]'],
+            'x-custom' => ['custom-value'],
+        ],
+        'body' => ['key' => 'value'],
+    ]);
+});
+
+it('filters sensitive headers', function () {
+    // Arrange
+    $request = Mockery::mock(Request::class);
+    $route = Mockery::mock(Route::class);
+    $headers = new HeaderBag([
+        'XSRF-TOKEN' => ['token123'],
+        'remember_web_123' => ['sensitive'],
+        'laravel_session' => ['session123'],
+        'safe-header' => ['value'],
+    ]);
+
+    $request->headers = $headers;
+    $request->shouldReceive('url')->once()->andReturn('https://example.com/test');
+    $request->shouldReceive('method')->once()->andReturn('GET');
+    $request->shouldReceive('all')->once()->andReturn([]);
+    $route->shouldReceive('getName')->once()->andReturn('test.route');
+
+    config(['session.cookie' => 'laravel_session']);
+    $event = new RouteMatched($route, $request);
+
+    // Act
+    ($this->collector)($event);
+
+    // Assert
+    expect(Context::get('request')['headers'])->toBe([
+        'xsrf-token' => ['[FILTERED]'],
+        'remember-web-123' => ['[FILTERED]'],
+        'laravel-session' => ['[FILTERED]'],
+        'safe-header' => ['value'],
+    ]);
+});
diff --git a/tests/Tracing/UserDataCollectorTest.php b/tests/Tracing/UserDataCollectorTest.php
@@ -0,0 +1,44 @@
+<?php
+
+use Illuminate\Auth\Events\Authenticated;
+use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Support\Facades\Context;
+use Naoray\LaravelGithubMonolog\Tracing\UserDataCollector;
+
+beforeEach(function () {
+    $this->collector = new UserDataCollector;
+});
+
+afterEach(function () {
+    // Reset to default resolver
+    UserDataCollector::setUserDataResolver(fn (Authenticatable $user) => ['id' => $user->getAuthIdentifier()]);
+    Context::flush();
+});
+
+it('collects default user data', function () {
+    // Arrange
+    $user = Mockery::mock(Authenticatable::class);
+    $user->shouldReceive('getAuthIdentifier')->once()->andReturn(1);
+    $event = new Authenticated('web', $user);
+
+    // Act
+    ($this->collector)($event);
+
+    // Assert
+    expect(Context::get('user'))->toBe(['id' => 1]);
+});
+
+it('uses custom user data resolver', function () {
+    // Arrange
+    $user = Mockery::mock(Authenticatable::class);
+    $user->shouldReceive('getAuthIdentifier')->never();
+    $event = new Authenticated('web', $user);
+
+    UserDataCollector::setUserDataResolver(fn ($user) => ['custom' => 'data']);
+
+    // Act
+    ($this->collector)($event);
+
+    // Assert
+    expect(Context::get('user'))->toBe(['custom' => 'data']);
+});
