feat: tracer can use custom resolver for user ID (#37)

Allow changing config('xray.user-resolver') with a custom class

config/xray.php

@@ -16,6 +16,17 @@
     */
     'submitter' => \Napp\Xray\Submission\APISegmentSubmitter::class,
 
+    /*
+    |--------------------------------------------------------------------------
+    | User resolver method
+    |--------------------------------------------------------------------------
+    |
+    | Here you can set a class to find the logged-in user identifier.
+    | Supported classes: "AuthIdentifier"
+    |
+    */
+    'user-resolver' => \Napp\Xray\Resolvers\AuthIdentifier::class,
+
     /*
     |--------------------------------------------------------------------------
     | Enable Database Query

src/Collectors/SegmentCollector.php

@@ -4,7 +4,7 @@
 
 namespace Napp\Xray\Collectors;
 
-use Illuminate\Support\Facades\Auth;
+use Napp\Xray\Resolvers\AuthIdentifier;
 use Napp\Xray\Segments\TimeSegment;
 use Napp\Xray\Segments\Trace;
 use Pkerrigan\Xray\Segment;
@@ -126,9 +126,10 @@ public function submitHttpTracer($response): void
     {
         $submitterClass = config('xray.submitter');
         $tracer = $this->tracer();
+        $user = $this->getUser();
 
-        if (app()->bound('auth') && Auth::check()) {
-            $tracer->setUser((string) Auth::user()->getAuthIdentifier());
+        if ($user) {
+            $tracer->setUser($user);
         }
         $tracer->end()
             ->setResponseCode($response->getStatusCode())
@@ -139,12 +140,24 @@ public function submitCliTracer(): void
     {
         $submitterClass = config('xray.submitter');
         $tracer = $this->tracer();
+        $user = $this->getUser();
 
-        if (app()->bound(Auth::class) && Auth::check()) {
-            $tracer->setUser((string) Auth::user()->getAuthIdentifier());
+        if ($user) {
+            $tracer->setUser($user);
         }
         $tracer->end()->submit(new $submitterClass());
 
         $tracer::flush();
     }
+
+    public function getUser(): ?string
+    {
+        $resolver = config('xray.user-resolver', AuthIdentifier::class);
+
+        if ($resolver) {
+            return app($resolver)->getUser();
+        }
+
+        return null;
+    }
 }

src/Resolvers/AuthIdentifier.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Napp\Xray\Resolvers;
+
+use Illuminate\Support\Facades\Auth;
+use Napp\Xray\Resolvers\Contracts\ResolvesUser;
+
+class AuthIdentifier implements ResolvesUser
+{
+    public function getUser(): ?string
+    {
+        if (app()->bound('auth') && Auth::check()) {
+            return (string) Auth::user()->getAuthIdentifier();
+        }
+
+        return null;
+    }
+}

src/Resolvers/Contracts/ResolvesUser.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Napp\Xray\Resolvers\Contracts;
+
+interface ResolvesUser
+{
+    public function getUser(): ?string;
+}

tests/SegmentCollectorTest.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Napp\Xray\Tests;
+
+use Illuminate\Support\Facades\Auth;
+use Napp\Xray\Tests\Stubs\CustomUserResolver;
+use Napp\Xray\Tests\Stubs\User;
+use Napp\Xray\Collectors\SegmentCollector;
+use Napp\Xray\XrayServiceProvider;
+use Orchestra\Testbench\TestCase;
+
+class SegmentCollectorTest extends TestCase
+{
+    /**
+     * @param \Illuminate\Foundation\Application $app
+     * @return string[]
+     */
+    protected function getPackageProviders($app)
+    {
+        return [
+            XrayServiceProvider::class,
+        ];
+    }
+
+    public function test_get_user_when_logged_in()
+    {
+        Auth::login(new User());
+
+        $collector = new SegmentCollector();
+
+        $this->assertSame('1', $collector->getUser());
+    }
+
+    public function test_get_user_when_guest()
+    {
+        $collector = new SegmentCollector();
+
+        $this->assertNull($collector->getUser());
+    }
+
+    public function test_get_user_when_config_is_missing()
+    {
+        $config = config('xray');
+        unset($config['user-resolver']);
+        config()->set('xray', $config);
+
+        Auth::login(new User());
+
+        $collector = new SegmentCollector();
+
+        $this->assertSame('1', $collector->getUser());
+    }
+
+    public function test_get_user_when_custom_resolver_is_configured()
+    {
+        config()->set('xray.user-resolver', CustomUserResolver::class);
+
+        $collector = new SegmentCollector();
+
+        $this->assertSame('foo', $collector->getUser());
+    }
+}

tests/Stubs/CustomUserResolver.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Napp\Xray\Tests\Stubs;
+
+use Napp\Xray\Resolvers\Contracts\ResolvesUser;
+
+class CustomUserResolver implements ResolvesUser
+{
+    public function getUser(): ?string
+    {
+        return 'foo';
+    }
+}

tests/Stubs/User.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Napp\Xray\Tests\Stubs;
+
+use Illuminate\Contracts\Auth\Authenticatable;
+
+class User implements Authenticatable
+{
+    public function getAuthIdentifierName(): string
+    {
+        return 'id';
+    }
+
+    public function getAuthIdentifier(): int
+    {
+        return 1;
+    }
+
+    public function getAuthPassword(): string
+    {
+        return 'foo';
+    }
+
+    public function getRememberToken(): string
+    {
+        return 'bar';
+    }
+
+    public function setRememberToken($value): void
+    {
+    }
+
+    public function getRememberTokenName(): string
+    {
+        return 'baz';
+    }
+}