Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow use of current hub scope in Messenger Listener #339

Merged
merged 6 commits into from
May 7, 2020
Merged

Allow use of current hub scope in Messenger Listener #339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7f6c83c
Alter MessengerListener to use current hub with methods for capturing…
sh41 May 6, 2020
7a10000
Inject the hub rather than rely upon singleton instance.
sh41 May 7, 2020
6ab1d88
Correctly typehint and remove phpstan exclusions for the MessengerLis…
sh41 May 7, 2020
4ef473f
Merge changes from #340.
sh41 May 7, 2020
d057924
Merge changes from #340.
sh41 May 7, 2020
77625a8
Fix up new test.
sh41 May 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions phpstan-baseline.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,11 @@ parameters:
count: 1
path: test/EventListener/MessengerListenerTest.php

-
message: "#^Property Sentry\\\\SentryBundle\\\\Test\\\\EventListener\\\\MessengerListenerTest\\:\\:\\$currentHub has no typehint specified\\.$#"
sh41 marked this conversation as resolved.
Show resolved Hide resolved
count: 1
path: test/EventListener/MessengerListenerTest.php

-
message: "#^Class Symfony\\\\Component\\\\Messenger\\\\Event\\\\WorkerMessageHandledEvent constructor invoked with 3 parameters, 2 required\\.$#"
count: 1
Expand Down
2 changes: 1 addition & 1 deletion src/DependencyInjection/SentryExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ private function configureMessengerListener(ContainerBuilder $container, array $
return;
}

$container->getDefinition(MessengerListener::class)->setArgument(1, $processedConfiguration['capture_soft_fails']);
$container->getDefinition(MessengerListener::class)->setArgument(0, $processedConfiguration['capture_soft_fails']);
Jean85 marked this conversation as resolved.
Show resolved Hide resolved
}

/**
Expand Down
25 changes: 12 additions & 13 deletions src/EventListener/MessengerListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,23 @@

namespace Sentry\SentryBundle\EventListener;

use Sentry\FlushableClientInterface;
use Sentry\SentrySdk;
use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
use Symfony\Component\Messenger\Exception\HandlerFailedException;

final class MessengerListener
{
/**
* @var FlushableClientInterface
*/
private $client;

/**
* @var bool
*/
private $captureSoftFails;

/**
* @param FlushableClientInterface $client
* @param bool $captureSoftFails
* @param bool $captureSoftFails
*/
public function __construct(FlushableClientInterface $client, bool $captureSoftFails = true)
Jean85 marked this conversation as resolved.
Show resolved Hide resolved
public function __construct(bool $captureSoftFails = true)
{
$this->client = $client;
$this->captureSoftFails = $captureSoftFails;
}

Expand All @@ -46,8 +39,11 @@ public function onWorkerMessageFailed(WorkerMessageFailedEvent $event): void
$error = $error->getPrevious();
}

$this->client->captureException($error);
$this->client->flush();
$hub = SentrySdk::getCurrentHub();
$hub->captureException($error);
if (method_exists($hub->getClient(), 'flush')) {
sh41 marked this conversation as resolved.
Show resolved Hide resolved
$hub->getClient()->flush();
}
}

/**
Expand All @@ -57,6 +53,9 @@ public function onWorkerMessageHandled(WorkerMessageHandledEvent $event): void
{
// Flush normally happens at shutdown... which only happens in the worker if it is run with a lifecycle limit
// such as --time=X or --limit=Y. Flush immediately in a background worker.
$this->client->flush();
$hub = SentrySdk::getCurrentHub();
if (method_exists($hub->getClient(), 'flush')) {
$hub->getClient()->flush();
}
sh41 marked this conversation as resolved.
Show resolved Hide resolved
}
}
1 change: 0 additions & 1 deletion src/Resources/config/services.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</service>

<service id="Sentry\SentryBundle\EventListener\MessengerListener" class="Sentry\SentryBundle\EventListener\MessengerListener" public="false">
<argument type="service" id="Sentry\FlushableClientInterface" />
<tag name="kernel.event_listener" event="Symfony\Component\Messenger\Event\WorkerMessageFailedEvent" method="onWorkerMessageFailed" priority="%sentry.listener_priorities.worker_error%" />
<tag name="kernel.event_listener" event="Symfony\Component\Messenger\Event\WorkerMessageHandledEvent" method="onWorkerMessageHandled" priority="%sentry.listener_priorities.worker_error%" />
</service>
Expand Down
28 changes: 17 additions & 11 deletions test/EventListener/MessengerListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
use Sentry\FlushableClientInterface;
use Sentry\SentryBundle\EventListener\MessengerListener;
use Sentry\SentryBundle\Test\BaseTestCase;
use Sentry\SentrySdk;
use Sentry\State\HubInterface;
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
Expand All @@ -14,12 +16,16 @@
class MessengerListenerTest extends BaseTestCase
{
private $client;
private $currentHub;

protected function setUp(): void
{
parent::setUp();

$this->client = $this->prophesize(FlushableClientInterface::class);
$this->currentHub = $this->prophesize(HubInterface::class);
$this->currentHub->getClient()->willReturn($this->client);
SentrySdk::setCurrentHub($this->currentHub->reveal());
}

public function testSoftFailsAreRecorded(): void
Expand All @@ -30,10 +36,10 @@ public function testSoftFailsAreRecorded(): void

$error = new \RuntimeException();

$this->client->captureException($error)->shouldBeCalled();
$this->currentHub->captureException($error)->shouldBeCalled();
$this->client->flush()->shouldBeCalled();

$listener = new MessengerListener($this->client->reveal(), true);
$listener = new MessengerListener(true);
$message = (object) ['foo' => 'bar'];
$envelope = Envelope::wrap($message);
$event = $this->getMessageFailedEvent($envelope, 'receiver', $error, true);
Expand All @@ -49,10 +55,10 @@ public function testHardFailsAreRecorded(): void

$error = new \RuntimeException();

$this->client->captureException($error)->shouldBeCalled();
$this->currentHub->captureException($error)->shouldBeCalled();
$this->client->flush()->shouldBeCalled();

$listener = new MessengerListener($this->client->reveal(), true);
$listener = new MessengerListener(true);
$message = (object) ['foo' => 'bar'];
$envelope = Envelope::wrap($message);
$event = $this->getMessageFailedEvent($envelope, 'receiver', $error, false);
Expand All @@ -68,10 +74,10 @@ public function testSoftFailsAreNotRecorded(): void

$error = new \RuntimeException();

$this->client->captureException($error)->shouldNotBeCalled();
$this->currentHub->captureException($error)->shouldNotBeCalled();
$this->client->flush()->shouldNotBeCalled();

$listener = new MessengerListener($this->client->reveal(), false);
$listener = new MessengerListener(false);
$message = (object) ['foo' => 'bar'];
$envelope = Envelope::wrap($message);
$event = $this->getMessageFailedEvent($envelope, 'receiver', $error, true);
Expand All @@ -87,10 +93,10 @@ public function testHardFailsAreRecordedWithCaptureSoftDisabled(): void

$error = new \RuntimeException();

$this->client->captureException($error)->shouldBeCalled();
$this->currentHub->captureException($error)->shouldBeCalled();
$this->client->flush()->shouldBeCalled();

$listener = new MessengerListener($this->client->reveal(), false);
$listener = new MessengerListener(false);
$message = (object) ['foo' => 'bar'];
$envelope = Envelope::wrap($message);
$event = $this->getMessageFailedEvent($envelope, 'receiver', $error, false);
Expand All @@ -111,10 +117,10 @@ public function testHandlerFailedExceptionIsUnwrapped(): void

$event = $this->getMessageFailedEvent($envelope, 'receiver', $wrappedError, false);

$this->client->captureException($error)->shouldBeCalled();
$this->currentHub->captureException($error)->shouldBeCalled();
$this->client->flush()->shouldBeCalled();

$listener = new MessengerListener($this->client->reveal());
$listener = new MessengerListener();
$listener->onWorkerMessageFailed($event);
}

Expand All @@ -125,7 +131,7 @@ public function testClientIsFlushedWhenMessageHandled(): void
}

$this->client->flush()->shouldBeCalled();
$listener = new MessengerListener($this->client->reveal());
$listener = new MessengerListener();

$message = (object) ['foo' => 'bar'];
$envelope = Envelope::wrap($message);
Expand Down