Missing info about event deprecations between 2.3 and 3.0

[mbabker]

In my app, I had been using the SentrySymfonyEvents::SET_USER_CONTEXT event to add my user context info to Sentry. When updating to 3.0, I found this event is no longer present with no mention of this B/C break in the upgrade guide. I can work around this, but I think it'd be helpful if the upgrade docs at least noted the SentrySymfonyEvents::PRE_CAPTURE and SentrySymfonyEvents::SET_USER_CONTEXT events were removed so there's less surprise for users of the bundle.

[Jean85]

You're right! As a code example, the basic user data set by the bundle should be enough, we just have to point that in the doc.

[Jean85]

I've opened #218, WDYT?

[mbabker]

Works for me, thanks!

[Stoakes]

Hello,

Do these removals explain why with sentry-symfony 3.0.0, instead of having username of affected user I now just have his IP address ?

[mbabker]

The default RequestListener only processes the IP address, if you need more info you'll need your own listener. I opted to replace the RequestListener::onKernelRequest() listener with my own listener for this purpose:

<?php declare(strict_types=1);

namespace App\EventListener;

use App\Entity\User;
use Sentry\State\Hub;
use Sentry\State\HubInterface;
use Sentry\State\Scope;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;

final class SentryContextListener
{
    /**
     * @var HubInterface
     */
    private $hub;

    /**
     * @var TokenStorageInterface|null
     */
    private $tokenStorage;

    /**
     * @var AuthorizationCheckerInterface|null
     */
    private $authorizationChecker;

    public function __construct(HubInterface $hub, TokenStorageInterface $tokenStorage, AuthorizationCheckerInterface $authorizationChecker)
    {
        $this->hub                  = $hub; // not used, needed to trigger instantiation (copied from SentryBundle's RequestListener)
        $this->tokenStorage         = $tokenStorage;
        $this->authorizationChecker = $authorizationChecker;
    }

    public function onKernelRequest(GetResponseEvent $event): void
    {
        if (!$event->isMasterRequest()) {
            return;
        }

        $currentClient = Hub::getCurrent()->getClient();

        if ($currentClient === null || !$currentClient->getOptions()->shouldSendDefaultPii()) {
            return;
        }

        $token = $this->tokenStorage->getToken();

        if (!$token) {
            return;
        }

        /** @var User|string $user */
        $user = $token->getUser();

        $data = [
            'ip_address' => $event->getRequest()->getClientIp(),
        ];

        if ($user instanceof User) {
            $data['id']    = $user->getId();
            $data['email'] = $user->getEmail();
            $data['name']  = $user->getFullName();
        }

        Hub::getCurrent()->configureScope(function (Scope $scope) use ($data): void {
            $scope->setUser($data);
        });
    }
}

And relevant container extension:

<?php declare(strict_types=1);

namespace App\DependencyInjection;

use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
use Symfony\Component\HttpKernel\KernelEvents;

final class AppSentryExtension extends Extension implements PrependExtensionInterface, CompilerPassInterface
{
    public function load(array $configs, ContainerBuilder $container)
    {
        // Required for interface
    }

    public function prepend(ContainerBuilder $container)
    {
        $bundles = $container->getParameter('kernel.bundles');

        if (isset($bundles['SentryBundle'])) {
            $deployedHashFile = $container->getParameter('kernel.root_dir').'/deployed.txt';

            if (file_exists($deployedHashFile)) {
                $deployedHash = trim(file_get_contents($deployedHashFile));

                if (!empty($deployedHash)) {
                    $container->prependExtensionConfig(
                        'sentry',
                        [
                            'options' => [
                                'release' => $deployedHash,
                            ],
                        ]
                    );
                }
            }
        }
    }

    public function process(ContainerBuilder $container)
    {
        // Remove the kernel.event_listener tag for the kernel.request event, we are using our own listener
        if ($container->hasDefinition('Sentry\SentryBundle\EventListener\RequestListener')) {
            $definition = $container->getDefinition('Sentry\SentryBundle\EventListener\RequestListener');
            $newTags = [];

            foreach ($definition->getTags() as $tag => $properties) {
                // Only processing kernel.event_listener tag
                if ($tag !== 'kernel.event_listener') {
                    $newTags[$tag] = $properties;

                    continue;
                }

                if (!isset($newTags['kernel.event_listener'])) {
                    $newTags['kernel.event_listener'] = [];
                }

                foreach ($properties as $property) {
                    if ($property['event'] !== KernelEvents::REQUEST) {
                        $newTags['kernel.event_listener'][] = $property;

                        continue;
                    }
                }
            }

            $definition->setTags($newTags);
        }
    }
}

[Stoakes]

Thanks for sharing your code.

After checking sentry code, I found that username was supposed to be included in details.

I eventually figured out that setting the send_default_pii option to true bring username back to sentry. So I guess this option switched from true to false with 3.0 release.

[Jean85]

send_default_pii is a new option of the 2.0 base SDK, which has to be turned off by default for GDPR compliance. I've opened #220 to document it.

[Jean85]

@mbabker you don't need to override the listener to change stuff in the Scope, you can just add your listener ad make it run with the default priority of 0. The default listener runs at priority 1, so before yours, which will override the info.

This is documented in the upgrade docs: https://github.com/getsentry/sentry-symfony/blob/master/UPGRADE-3.0.md#changes-in-the-services