refactor the user setting code into a callback

Author: Sam Stevens

Callbacks/UserSettingCallback.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Bugsnag\BugsnagBundle\Callbacks;
+
+use Bugsnag\Report;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+class UserSettingCallback
+{
+    /**
+     * The token resolver.
+     *
+     * @var \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|null
+     */
+    protected $tokens;
+
+    /**
+     * The auth checker.
+     *
+     * @var \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|null
+     */
+    protected $checker;
+
+    /**
+     * @var bool
+     */
+    protected $setUser;
+
+    /**
+     * @param null|\Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokens
+     * @param null|\Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $checker
+     * @param bool $setUser
+     */
+    public function __construct(
+        TokenStorageInterface $tokens = null,
+        AuthorizationCheckerInterface $checker = null,
+        $setUser = true
+    ) {
+        $this->tokens = $tokens;
+        $this->checker = $checker;
+        $this->setUser = $setUser;
+    }
+
+    /**
+     * @param \Bugsnag\Report $report
+     */
+    public function registerCallback(Report $report)
+    {
+        // If told to not set the user, or the security services were not passed in
+        // (not registered in the container), then exit early
+        if (! $this->setUser || is_null($this->tokens) || is_null($this->checker)) {
+            return;
+        }
+
+        $token = $this->tokens->getToken();
+
+        if (!$token || !$this->checker->isGranted('IS_AUTHENTICATED_REMEMBERED')) {
+            return;
+        }
+
+        $user = $token->getUser();
+
+        if ($user instanceof UserInterface) {
+            $bugsnagUser = ['id' => $user->getUsername()];
+        } else {
+            $bugsnagUser = ['id' => (string) $user];
+        }
+
+        $report->setUser($bugsnagUser);
+    }
+}

DependencyInjection/ClientFactory.php

@@ -4,12 +4,8 @@
 
 use Bugsnag\BugsnagBundle\BugsnagBundle;
 use Bugsnag\BugsnagBundle\Request\SymfonyResolver;
-use Bugsnag\Callbacks\CustomUser;
 use Bugsnag\Client;
 use Bugsnag\Configuration as Config;
-use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
-use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
-use Symfony\Component\Security\Core\User\UserInterface;
 
 class ClientFactory
 {
@@ -20,20 +16,6 @@ class ClientFactory
      */
     protected $resolver;
 
-    /**
-     * The token resolver.
-     *
-     * @var \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|null
-     */
-    protected $tokens;
-
-    /**
-     * The auth checker.
-     *
-     * @var \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|null
-     */
-    protected $checker;
-
     /**
      * The api key.
      *
@@ -55,13 +37,6 @@ class ClientFactory
      */
     protected $callbacks;
 
-    /**
-     * User detection enabled.
-     *
-     * @var bool
-     */
-    protected $user;
-
     /**
      * The type.
      *
@@ -150,12 +125,9 @@ class ClientFactory
      * Create a new client factory instance.
      *
      * @param \Bugsnag\BugsnagBundle\Request\SymfonyResolver                                           $resolver
-     * @param \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|null $tokens
-     * @param \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|null        $checker
      * @param string|null                                                                              $key
      * @param string|null                                                                              $endpoint
      * @param bool                                                                                     $callbacks
-     * @param bool                                                                                     $user
      * @param string|null                                                                              $type
      * @param string|null                                                                              $version
      * @param bool                                                                                     $batch
@@ -172,12 +144,9 @@ class ClientFactory
      */
     public function __construct(
         SymfonyResolver $resolver,
-        TokenStorageInterface $tokens = null,
-        AuthorizationCheckerInterface $checker = null,
         $key = null,
         $endpoint = null,
         $callbacks = true,
-        $user = true,
         $type = null,
         $version = true,
         $batch = null,
@@ -191,12 +160,9 @@ public function __construct(
         array $filters = null
     ) {
         $this->resolver = $resolver;
-        $this->tokens = $tokens;
-        $this->checker = $checker;
         $this->key = $key;
         $this->endpoint = $endpoint;
         $this->callbacks = $callbacks;
-        $this->user = $user;
         $this->type = $type;
         $this->version = $version;
         $this->batch = $batch;
@@ -245,10 +211,6 @@ public function make()
             $client->registerDefaultCallbacks();
         }
 
-        if ($this->tokens && $this->checker && $this->user) {
-            $this->setupUserDetection($client, $this->tokens, $this->checker);
-        }
-
         $this->setupPaths($client, $this->strip, $this->project, $this->root);
 
         $client->setReleaseStage($this->stage === 'prod' ? 'production' : $this->stage);
@@ -282,34 +244,6 @@ public function make()
         return $client;
     }
 
-    /**
-     * Setup user detection.
-     *
-     * @param \Bugsnag\Client                                                                     $client
-     * @param \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokens
-     * @param \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface        $checker
-     *
-     * @return void
-     */
-    protected function setupUserDetection(Client $client, TokenStorageInterface $tokens, AuthorizationCheckerInterface $checker)
-    {
-        $client->registerCallback(new CustomUser(function () use ($tokens, $checker) {
-            $token = $tokens->getToken();
-
-            if (!$token || !$checker->isGranted('IS_AUTHENTICATED_REMEMBERED')) {
-                return;
-            }
-
-            $user = $token->getUser();
-
-            if ($user instanceof UserInterface) {
-                return ['id' => $user->getUsername()];
-            }
-
-            return ['id' => (string) $user];
-        }));
-    }
-
     /**
      * Setup the client paths.
      *

Resources/config/services.yml

@@ -6,12 +6,9 @@ services:
         class: '%bugsnag.factory%'
         arguments:
           - '@bugsnag.resolver'
-          - '@?security.token_storage'
-          - '@?security.authorization_checker'
           - '%bugsnag.api_key%'
           - '%bugsnag.endpoint%'
           - '%bugsnag.callbacks%'
-          - '%bugsnag.user%'
           - '%bugsnag.app_type%'
           - '%bugsnag.app_version%'
           - '%bugsnag.batch_sending%'
@@ -38,3 +35,12 @@ services:
             - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 256 }
             - { name: kernel.event_listener, event: kernel.exception, method: onKernelException, priority: 128 }
             - { name: kernel.event_listener, event: console.exception, method: onConsoleException, priority: 128 }
+
+    bugsnag.callbacks.user_setting:
+        class: Bugsnag\BugsnagBundle\Callbacks\UserSettingCallback
+        arguments:
+            - '@?security.token_storage'
+            - '@?security.authorization_checker'
+            - '%bugsnag.user%'
+        tags:
+            - { name: 'bugsnag.callback' }