Skip to content

Commit 52d5a4b

Browse files
author
Sam Stevens
committed
implement custom callbacks and refactor the user setting code into a callback
1 parent 8a2fc2e commit 52d5a4b

File tree

13 files changed

+360
-93
lines changed

13 files changed

+360
-93
lines changed

‎BugsnagBundle.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
namespace Bugsnag\BugsnagBundle;
44

5+
use Bugsnag\BugsnagBundle\DependencyInjection\Compiler\CallbackRegisteringPass;
6+
use Symfony\Component\DependencyInjection\ContainerBuilder;
57
use Symfony\Component\HttpKernel\Bundle\Bundle;
68

79
class BugsnagBundle extends Bundle
@@ -12,4 +14,16 @@ class BugsnagBundle extends Bundle
1214
* @return string
1315
*/
1416
const VERSION = '1.0.0';
17+
18+
/**
19+
* {@inheritdoc}
20+
*
21+
* @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
22+
*
23+
* @return void
24+
*/
25+
public function build(ContainerBuilder $container)
26+
{
27+
$container->addCompilerPass(new CallbackRegisteringPass());
28+
}
1529
}

‎Callbacks/UserSettingCallback.php‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?php
2+
3+
namespace Bugsnag\BugsnagBundle\Callbacks;
4+
5+
use Bugsnag\Report;
6+
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
7+
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
8+
use Symfony\Component\Security\Core\User\UserInterface;
9+
10+
class UserSettingCallback
11+
{
12+
/**
13+
* The token resolver.
14+
*
15+
* @var \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|null
16+
*/
17+
protected $tokens;
18+
19+
/**
20+
* The auth checker.
21+
*
22+
* @var \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|null
23+
*/
24+
protected $checker;
25+
26+
/**
27+
* @var bool
28+
*/
29+
protected $setUser;
30+
31+
/**
32+
* @param null|\Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokens
33+
* @param null|\Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $checker
34+
* @param bool $setUser
35+
*/
36+
public function __construct(
37+
TokenStorageInterface $tokens = null,
38+
AuthorizationCheckerInterface $checker = null,
39+
$setUser = true
40+
) {
41+
$this->tokens = $tokens;
42+
$this->checker = $checker;
43+
$this->setUser = $setUser;
44+
}
45+
46+
/**
47+
* @param \Bugsnag\Report $report
48+
*
49+
* @return void
50+
*/
51+
public function registerCallback(Report $report)
52+
{
53+
// If told to not set the user, or the security services were not passed in
54+
// (not registered in the container), then exit early
55+
if (!$this->setUser || is_null($this->tokens) || is_null($this->checker)) {
56+
return;
57+
}
58+
59+
$token = $this->tokens->getToken();
60+
61+
if (!$token || !$this->checker->isGranted('IS_AUTHENTICATED_REMEMBERED')) {
62+
return;
63+
}
64+
65+
$user = $token->getUser();
66+
67+
if ($user instanceof UserInterface) {
68+
$bugsnagUser = ['id' => $user->getUsername()];
69+
} else {
70+
$bugsnagUser = ['id' => (string) $user];
71+
}
72+
73+
$report->setUser($bugsnagUser);
74+
}
75+
}

‎DependencyInjection/ClientFactory.php‎

Lines changed: 15 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,8 @@
44

55
use Bugsnag\BugsnagBundle\BugsnagBundle;
66
use Bugsnag\BugsnagBundle\Request\SymfonyResolver;
7-
use Bugsnag\Callbacks\CustomUser;
87
use Bugsnag\Client;
98
use Bugsnag\Configuration as Config;
10-
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
11-
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
12-
use Symfony\Component\Security\Core\User\UserInterface;
139

1410
class ClientFactory
1511
{
@@ -20,20 +16,6 @@ class ClientFactory
2016
*/
2117
protected $resolver;
2218

23-
/**
24-
* The token resolver.
25-
*
26-
* @var \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|null
27-
*/
28-
protected $tokens;
29-
30-
/**
31-
* The auth checker.
32-
*
33-
* @var \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|null
34-
*/
35-
protected $checker;
36-
3719
/**
3820
* The api key.
3921
*
@@ -55,13 +37,6 @@ class ClientFactory
5537
*/
5638
protected $callbacks;
5739

58-
/**
59-
* User detection enabled.
60-
*
61-
* @var bool
62-
*/
63-
protected $user;
64-
6540
/**
6641
* The type.
6742
*
@@ -142,35 +117,29 @@ class ClientFactory
142117
/**
143118
* Create a new client factory instance.
144119
*
145-
* @param \Bugsnag\BugsnagBundle\Request\SymfonyResolver $resolver
146-
* @param \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|null $tokens
147-
* @param \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface|null $checker
148-
* @param string|null $key
149-
* @param string|null $endpoint
150-
* @param bool $callbacks
151-
* @param bool $user
152-
* @param string|null $type
153-
* @param string|null $version
154-
* @param bool $batch
155-
* @param string|null $hostname
156-
* @param bool $code
157-
* @param string|null $strip
158-
* @param string|null $project
159-
* @param string|null $root
160-
* @param string|null $stage
161-
* @param string[]|null $stages
162-
* @param string[]|null $filters
120+
* @param \Bugsnag\BugsnagBundle\Request\SymfonyResolver $resolver
121+
* @param string|null $key
122+
* @param string|null $endpoint
123+
* @param bool $callbacks
124+
* @param string|null $type
125+
* @param string|null $version
126+
* @param bool $batch
127+
* @param string|null $hostname
128+
* @param bool $code
129+
* @param string|null $strip
130+
* @param string|null $project
131+
* @param string|null $root
132+
* @param string|null $stage
133+
* @param string[]|null $stages
134+
* @param string[]|null $filters
163135
*
164136
* @return void
165137
*/
166138
public function __construct(
167139
SymfonyResolver $resolver,
168-
TokenStorageInterface $tokens = null,
169-
AuthorizationCheckerInterface $checker = null,
170140
$key = null,
171141
$endpoint = null,
172142
$callbacks = true,
173-
$user = true,
174143
$type = null,
175144
$version = true,
176145
$batch = null,
@@ -184,12 +153,9 @@ public function __construct(
184153
array $filters = null
185154
) {
186155
$this->resolver = $resolver;
187-
$this->tokens = $tokens;
188-
$this->checker = $checker;
189156
$this->key = $key;
190157
$this->endpoint = $endpoint;
191158
$this->callbacks = $callbacks;
192-
$this->user = $user;
193159
$this->type = $type;
194160
$this->version = $version;
195161
$this->batch = $batch;
@@ -218,10 +184,6 @@ public function make()
218184
$client->registerDefaultCallbacks();
219185
}
220186

221-
if ($this->tokens && $this->checker && $this->user) {
222-
$this->setupUserDetection($client, $this->tokens, $this->checker);
223-
}
224-
225187
$this->setupPaths($client, $this->strip, $this->project, $this->root);
226188

227189
$client->setReleaseStage($this->stage === 'prod' ? 'production' : $this->stage);
@@ -251,34 +213,6 @@ public function make()
251213
return $client;
252214
}
253215

254-
/**
255-
* Setup user detection.
256-
*
257-
* @param \Bugsnag\Client $client
258-
* @param \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokens
259-
* @param \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $checker
260-
*
261-
* @return void
262-
*/
263-
protected function setupUserDetection(Client $client, TokenStorageInterface $tokens, AuthorizationCheckerInterface $checker)
264-
{
265-
$client->registerCallback(new CustomUser(function () use ($tokens, $checker) {
266-
$token = $tokens->getToken();
267-
268-
if (!$token || !$checker->isGranted('IS_AUTHENTICATED_REMEMBERED')) {
269-
return;
270-
}
271-
272-
$user = $token->getUser();
273-
274-
if ($user instanceof UserInterface) {
275-
return ['id' => $user->getUsername()];
276-
}
277-
278-
return ['id' => (string) $user];
279-
}));
280-
}
281-
282216
/**
283217
* Setup the client paths.
284218
*

‎DependencyInjection/Compiler/CallbackRegisteringPass.php‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?php
2+
3+
namespace Bugsnag\BugsnagBundle\DependencyInjection\Compiler;
4+
5+
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
6+
use Symfony\Component\DependencyInjection\ContainerBuilder;
7+
use Symfony\Component\DependencyInjection\Reference;
8+
9+
class CallbackRegisteringPass implements CompilerPassInterface
10+
{
11+
const BUGSNAG_SERVICE_NAME = 'bugsnag';
12+
const TAG_NAME = 'bugsnag.callback';
13+
14+
/**
15+
* @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
16+
*
17+
* @return void
18+
*/
19+
public function process(ContainerBuilder $container)
20+
{
21+
if (!$container->has(self::BUGSNAG_SERVICE_NAME)) {
22+
return;
23+
}
24+
25+
// Get the Bugsnag service
26+
$bugsnag = $container->findDefinition(self::BUGSNAG_SERVICE_NAME);
27+
28+
// Get all services tagged as a callback
29+
$callbackServices = $container->findTaggedServiceIds(self::TAG_NAME);
30+
31+
// Register each callback on the bugsnag service
32+
foreach ($callbackServices as $id => $tags) {
33+
foreach ($tags as $attributes) {
34+
// Get the method name to call on the service from the tag definition,
35+
// defaulting to registerCallback
36+
$method = isset($attributes['method']) ? $attributes['method'] : 'registerCallback';
37+
$bugsnag->addMethodCall('registerCallback', [[new Reference($id), $method]]);
38+
}
39+
}
40+
}
41+
}

‎Resources/config/services.yml‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,9 @@ services:
66
class: '%bugsnag.factory%'
77
arguments:
88
- '@bugsnag.resolver'
9-
- '@?security.token_storage'
10-
- '@?security.authorization_checker'
119
- '%bugsnag.api_key%'
1210
- '%bugsnag.endpoint%'
1311
- '%bugsnag.callbacks%'
14-
- '%bugsnag.user%'
1512
- '%bugsnag.app_type%'
1613
- '%bugsnag.app_version%'
1714
- '%bugsnag.batch_sending%'
@@ -38,3 +35,12 @@ services:
3835
- { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 256 }
3936
- { name: kernel.event_listener, event: kernel.exception, method: onKernelException, priority: 128 }
4037
- { name: kernel.event_listener, event: console.exception, method: onConsoleException, priority: 128 }
38+
39+
bugsnag.callbacks.user_setting:
40+
class: Bugsnag\BugsnagBundle\Callbacks\UserSettingCallback
41+
arguments:
42+
- '@?security.token_storage'
43+
- '@?security.authorization_checker'
44+
- '%bugsnag.user%'
45+
tags:
46+
- { name: 'bugsnag.callback' }

0 commit comments

Comments
 (0)