Try to extract a few more common attributes from the authenticated user (#577)

Author: stayallive

CHANGELOG.md

@@ -6,6 +6,7 @@
 - Fix status code not populated on transaction if response did not inherit from `Illuminate\Http\Response` like `Illuminate\Http\JsonResponse` (#573)
 - Align Span Operations with new spec (#574)
 - Fix broken `SetRequestMiddleware` on Laravel < 6.0 (#575)
+- Also extract the authenticated user `email` and `username` attributes if available (#577)
 
 ## 2.13.0
 

src/Sentry/Laravel/EventHandler.php

@@ -6,9 +6,11 @@
 use Illuminate\Auth\Events\Authenticated;
 use Illuminate\Console\Events\CommandFinished;
 use Illuminate\Console\Events\CommandStarting;
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Events\QueryExecuted;
 use Illuminate\Http\Request;
 use Illuminate\Log\Events\MessageLogged;
@@ -421,9 +423,7 @@ private function addLogBreadcrumb(string $level, ?string $message, array $contex
      */
     protected function authenticatedHandler(Authenticated $event)
     {
-        $this->configureUserScopeWithRequest([
-            'id' => $event->user->getAuthIdentifier(),
-        ]);
+        $this->configureUserScopeFromModel($event->user);
     }
 
     /**
@@ -433,20 +433,31 @@ protected function authenticatedHandler(Authenticated $event)
      */
     protected function sanctumTokenAuthenticatedHandler(Sanctum\TokenAuthenticated $event)
     {
-        $this->configureUserScopeWithRequest([
-            'id' => $event->token->tokenable->getAuthIdentifier(),
-        ]);
+        $this->configureUserScopeFromModel($event->token->tokenable);
     }
 
     /**
      * Configures the user scope with the user data and values from the HTTP request.
      *
-     * @param array $userData
+     * @param mixed $authUser
      *
      * @return void
      */
-    private function configureUserScopeWithRequest(array $userData): void
+    private function configureUserScopeFromModel($authUser): void
     {
+        $userData = [];
+
+        // If the user is a Laravel Eloquent model we try to extract some common fields from it
+        if ($authUser instanceof Model) {
+            $userData = [
+                'id' => $authUser instanceof Authenticatable
+                    ? $authUser->getAuthIdentifier()
+                    : $authUser->getKey(),
+                'email' => $authUser->getAttribute('email') ?? $authUser->getAttribute('mail'),
+                'username' => $authUser->getAttribute('username'),
+            ];
+        }
+
         try {
             /** @var \Illuminate\Http\Request $request */
             $request = $this->container->make('request');
@@ -463,7 +474,7 @@ private function configureUserScopeWithRequest(array $userData): void
         }
 
         Integration::configureScope(static function (Scope $scope) use ($userData): void {
-            $scope->setUser($userData);
+            $scope->setUser(array_filter($userData));
         });
     }