feat: detect user from sanctum token (#542)

Co-authored-by: Alex Bouma <[email protected]>

Author: ankurk91

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 - Add support for normalized route names when using Lumen (#449)
+- Add support for adding the user ID to the user scope when using Laravel Sanctum (#542)
 
 ## 2.11.1
 

src/Sentry/Laravel/EventHandler.php

@@ -17,9 +17,10 @@
 use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Queue\Events\WorkerStopping;
 use Illuminate\Queue\QueueManager;
-use Laravel\Octane\Events as Octane;
 use Illuminate\Routing\Events\RouteMatched;
 use Illuminate\Routing\Route;
+use Laravel\Octane\Events as Octane;
+use Laravel\Sanctum\Events as Sanctum;
 use RuntimeException;
 use Sentry\Breadcrumb;
 use Sentry\SentrySdk;
@@ -33,14 +34,14 @@ class EventHandler
      * @var array
      */
     protected static $eventHandlerMap = [
-        'router.matched'                         => 'routerMatched',                         // Until Laravel 5.1
-        'Illuminate\Routing\Events\RouteMatched' => 'routeMatched',  // Since Laravel 5.2
+        'router.matched' => 'routerMatched',                              // Until Laravel 5.1
+        'Illuminate\Routing\Events\RouteMatched' => 'routeMatched',       // Since Laravel 5.2
 
-        'illuminate.query'                         => 'query',                                 // Until Laravel 5.1
-        'Illuminate\Database\Events\QueryExecuted' => 'queryExecuted', // Since Laravel 5.2
+        'illuminate.query' => 'query',                                    // Until Laravel 5.1
+        'Illuminate\Database\Events\QueryExecuted' => 'queryExecuted',    // Since Laravel 5.2
 
-        'illuminate.log'                      => 'log',                                // Until Laravel 5.3
-        'Illuminate\Log\Events\MessageLogged' => 'messageLogged', // Since Laravel 5.4
+        'illuminate.log' => 'log',                                        // Until Laravel 5.3
+        'Illuminate\Log\Events\MessageLogged' => 'messageLogged',         // Since Laravel 5.4
 
         'Illuminate\Console\Events\CommandStarting' => 'commandStarting', // Since Laravel 5.5
         'Illuminate\Console\Events\CommandFinished' => 'commandFinished', // Since Laravel 5.5
@@ -52,7 +53,8 @@ class EventHandler
      * @var array
      */
     protected static $authEventHandlerMap = [
-        'Illuminate\Auth\Events\Authenticated' => 'authenticated', // Since Laravel 5.3
+        'Illuminate\Auth\Events\Authenticated' => 'authenticated',                  // Since Laravel 5.3
+        'Laravel\Sanctum\Events\TokenAuthenticated' => 'sanctumTokenAuthenticated', // Since Sanctum 2.13
     ];
 
     /**
@@ -61,10 +63,10 @@ class EventHandler
      * @var array
      */
     protected static $queueEventHandlerMap = [
-        'Illuminate\Queue\Events\JobProcessing'        => 'queueJobProcessing',        // Since Laravel 5.2
-        'Illuminate\Queue\Events\JobProcessed'         => 'queueJobProcessed',         // Since Laravel 5.2
+        'Illuminate\Queue\Events\JobProcessed' => 'queueJobProcessed',                 // Since Laravel 5.2
+        'Illuminate\Queue\Events\JobProcessing' => 'queueJobProcessing',               // Since Laravel 5.2
+        'Illuminate\Queue\Events\WorkerStopping' => 'queueWorkerStopping',             // Since Laravel 5.2
         'Illuminate\Queue\Events\JobExceptionOccurred' => 'queueJobExceptionOccurred', // Since Laravel 5.2
-        'Illuminate\Queue\Events\WorkerStopping'       => 'queueWorkerStopping',       // Since Laravel 5.2
     ];
 
     /**
@@ -73,17 +75,17 @@ class EventHandler
      * @var array
      */
     protected static $octaneEventHandlerMap = [
-        'Laravel\Octane\Events\RequestReceived'   => 'octaneRequestReceived',
+        'Laravel\Octane\Events\RequestReceived' => 'octaneRequestReceived',
         'Laravel\Octane\Events\RequestTerminated' => 'octaneRequestTerminated',
 
-        'Laravel\Octane\Events\TaskReceived'   => 'octaneTaskReceived',
+        'Laravel\Octane\Events\TaskReceived' => 'octaneTaskReceived',
         'Laravel\Octane\Events\TaskTerminated' => 'octaneTaskTerminated',
 
-        'Laravel\Octane\Events\TickReceived'   => 'octaneTickReceived',
+        'Laravel\Octane\Events\TickReceived' => 'octaneTickReceived',
         'Laravel\Octane\Events\TickTerminated' => 'octaneTickTerminated',
 
         'Laravel\Octane\Events\WorkerErrorOccurred' => 'octaneWorkerErrorOccurred',
-        'Laravel\Octane\Events\WorkerStopping'      => 'octaneWorkerStopping',
+        'Laravel\Octane\Events\WorkerStopping' => 'octaneWorkerStopping',
     ];
 
     /**
@@ -166,11 +168,11 @@ public function __construct(Container $container, array $config)
     {
         $this->container = $container;
 
-        $this->recordSqlQueries     = ($config['breadcrumbs.sql_queries'] ?? $config['breadcrumbs']['sql_queries'] ?? true) === true;
-        $this->recordSqlBindings    = ($config['breadcrumbs.sql_bindings'] ?? $config['breadcrumbs']['sql_bindings'] ?? false) === true;
-        $this->recordLaravelLogs    = ($config['breadcrumbs.logs'] ?? $config['breadcrumbs']['logs'] ?? true) === true;
-        $this->recordQueueInfo      = ($config['breadcrumbs.queue_info'] ?? $config['breadcrumbs']['queue_info'] ?? true) === true;
-        $this->recordCommandInfo    = ($config['breadcrumbs.command_info'] ?? $config['breadcrumbs']['command_info'] ?? true) === true;
+        $this->recordSqlQueries = ($config['breadcrumbs.sql_queries'] ?? $config['breadcrumbs']['sql_queries'] ?? true) === true;
+        $this->recordSqlBindings = ($config['breadcrumbs.sql_bindings'] ?? $config['breadcrumbs']['sql_bindings'] ?? false) === true;
+        $this->recordLaravelLogs = ($config['breadcrumbs.logs'] ?? $config['breadcrumbs']['logs'] ?? true) === true;
+        $this->recordQueueInfo = ($config['breadcrumbs.queue_info'] ?? $config['breadcrumbs']['queue_info'] ?? true) === true;
+        $this->recordCommandInfo = ($config['breadcrumbs.command_info'] ?? $config['breadcrumbs']['command_info'] ?? true) === true;
         $this->recordOctaneTickInfo = ($config['breadcrumbs.octane_tick_info'] ?? $config['breadcrumbs']['octane_tick_info'] ?? true) === true;
         $this->recordOctaneTaskInfo = ($config['breadcrumbs.octane_task_info'] ?? $config['breadcrumbs']['octane_task_info'] ?? true) === true;
     }
@@ -419,10 +421,32 @@ private function addLogBreadcrumb(string $level, ?string $message, array $contex
      */
     protected function authenticatedHandler(Authenticated $event)
     {
-        $userData = [
+        $this->configureUserScopeWithRequest([
             'id' => $event->user->getAuthIdentifier(),
-        ];
+        ]);
+    }
 
+    /**
+     * Since Sanctum 2.13
+     *
+     * @param \Laravel\Sanctum\Events\TokenAuthenticated $event
+     */
+    protected function sanctumTokenAuthenticatedHandler(Sanctum\TokenAuthenticated $event)
+    {
+        $this->configureUserScopeWithRequest([
+            'id' => $event->token->tokenable->getAuthIdentifier(),
+        ]);
+    }
+
+    /**
+     * Configures the user scope with the user data and values from the HTTP request.
+     *
+     * @param array $userData
+     *
+     * @return void
+     */
+    private function configureUserScopeWithRequest(array $userData): void
+    {
         try {
             /** @var \Illuminate\Http\Request $request */
             $request = $this->container->make('request');
@@ -461,9 +485,9 @@ protected function queueJobProcessingHandler(JobProcessing $event)
         }
 
         $job = [
-            'job'        => $event->job->getName(),
-            'queue'      => $event->job->getQueue(),
-            'attempts'   => $event->job->attempts(),
+            'job' => $event->job->getName(),
+            'queue' => $event->job->getQueue(),
+            'attempts' => $event->job->attempts(),
             'connection' => $event->connectionName,
         ];