Improve user guard resolution (#217)

Author: timacdonald

src/UserProvider.php

@@ -42,37 +42,73 @@ public function __construct(
      */
     public function id(): LazyValue|string
     {
-        try {
+        if (! $this->auth->hasResolvedGuards()) {
+            return $this->lazyUserId();
+        }
+
+        if ($this->auth->hasUser()) {
+            return $this->currentUserId();
+        }
+
+        if ($this->rememberedUser) {
+            return $this->rememberedUserId();
+        }
+
+        return '';
+    }
+
+    /**
+     * @return LazyValue<string>
+     */
+    private function lazyUserId(): LazyValue
+    {
+        return new LazyValue(function () {
+            if (! $this->auth->hasResolvedGuards()) {
+                return '';
+            }
+
             if ($this->auth->hasUser()) {
-                return Str::tinyText((string) $this->auth->id());
+                return $this->currentUserId();
+            }
+
+            if ($this->rememberedUser) {
+                return $this->rememberedUserId();
             }
+
+            return '';
+        });
+    }
+
+    private function currentUserId(): string
+    {
+        try {
+            return Str::tinyText((string) $this->auth->id());
         } catch (Throwable $e) {
             $this->reportResolvingUserIdException($e);
 
             return '';
         }
+    }
 
-        return new LazyValue(function () {
-            try {
-                if ($this->auth->hasUser()) {
-                    return Str::tinyText((string) $this->auth->id());
-                } else {
-                    return Str::tinyText((string) $this->rememberedUser?->getAuthIdentifier());  // @phpstan-ignore cast.string
-                }
-            } catch (Throwable $e) {
-                $this->reportResolvingUserIdException($e);
+    private function rememberedUserId(): string
+    {
+        try {
+            return Str::tinyText((string) $this->rememberedUser?->getAuthIdentifier());  // @phpstan-ignore cast.string
+        } catch (Throwable $e) {
+            $this->reportResolvingUserIdException($e);
 
-                return '';
-            }
-        });
+            return '';
+        }
     }
 
     /**
      * @return array{ id: mixed, name?: mixed, username?: mixed }|null
      */
     public function details(): ?array
     {
-        $user = $this->auth->user() ?? $this->rememberedUser;
+        $user = $this->auth->hasResolvedGuards()
+            ? $this->auth->user() ?? $this->rememberedUser
+            : $this->rememberedUser;
 
         if ($user === null) {
             return null;

tests/Feature/Sensors/UserSensorTest.php

@@ -248,4 +248,14 @@ public function test_it_gracefully_handles_exceptions_while_resolving_user_ids()
         $ingest->assertLatestWrite('query:1.user', '');
         $ingest->assertLatestWrite('request:0.user', '');
     }
+
+    public function test_it_does_not_actively_resolve_guards(): void
+    {
+        Route::get('/test', fn () => 'ok');
+
+        $response = $this->get('/test');
+
+        $response->assertOk();
+        $this->assertFalse(Auth::hasResolvedGuards());
+    }
 }

tests/Unit/UserProviderTest.php

@@ -2,6 +2,7 @@
 
 namespace Tests\Unit;
 
+use App\Models\User;
 use Illuminate\Auth\GenericUser;
 use Illuminate\Support\Facades\Auth;
 use Laravel\Nightwatch\UserProvider;
@@ -15,6 +16,13 @@
 
 class UserProviderTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        $this->forceRequestExecutionState();
+
+        parent::setUp();
+    }
+
     public function test_it_limits_the_length_of_the_user_identifier(): void
     {
         Auth::login(new GenericUser([
@@ -41,12 +49,12 @@ public function test_it_can_lazily_retrieve_the_user(): void
 
     public function test_it_can_remember_an_authenticated_user_and_limits_the_length_of_their_identifier(): void
     {
-        $provider = new UserProvider($this->app['auth'], fn () => [], fn () => fn () => null);
-        $provider->remember($user = new GenericUser([
+        Auth::login((new User([
             'id' => str_repeat('x', 1000),
-        ]));
+        ]))->setKeyType('string'));
+        Auth::logout();
 
-        $this->assertSame(str_repeat('x', 255), $provider->id()->jsonSerialize());
+        $this->assertSame(str_repeat('x', 255), $this->core->executionState->user->id());
     }
 
     public function test_it_only_reports_exceptions_occurring_while_resolving_user_ids_once_before_user_is_available(): void