Skip to content

[Messenger][RateLimiter] fix additional message handled when using a rate limiter #58763

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

Merged
merged 1 commit into from
Nov 9, 2024
Merged

[Messenger][RateLimiter] fix additional message handled when using a rate limiter #58763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions src/Symfony/Component/Messenger/Tests/WorkerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use PHPUnit\Framework\TestCase;
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Log\LoggerInterface;
use Symfony\Bridge\PhpUnit\ClockMock;
use Symfony\Component\Clock\MockClock;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpKernel\DependencyInjection\ServicesResetter;
Expand Down Expand Up @@ -47,8 +48,8 @@
use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
use Symfony\Component\Messenger\Worker;
use Symfony\Component\RateLimiter\RateLimiterFactory;
use Symfony\Component\RateLimiter\Reservation;
use Symfony\Component\RateLimiter\Storage\InMemoryStorage;
use Symfony\Contracts\Service\ResetInterface;

/**
* @group time-sensitive
Expand All @@ -73,7 +74,7 @@ public function testWorkerDispatchTheReceivedMessage()
return $envelopes[] = $envelope;
});

$dispatcher = new class() implements EventDispatcherInterface {
$dispatcher = new class implements EventDispatcherInterface {
private StopWorkerOnMessageLimitListener $listener;

public function __construct()
Expand Down Expand Up @@ -403,7 +404,7 @@ public function testWorkerLimitQueuesUnsupported()

$worker = new Worker(['transport1' => $receiver1, 'transport2' => $receiver2], $bus, clock: new MockClock());
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage(sprintf('Receiver for "transport2" does not implement "%s".', QueueReceiverInterface::class));
$this->expectExceptionMessage(\sprintf('Receiver for "transport2" does not implement "%s".', QueueReceiverInterface::class));
$worker->run(['queues' => ['foo']]);
}

Expand All @@ -418,7 +419,7 @@ public function testWorkerMessageReceivedEventMutability()
$eventDispatcher = new EventDispatcher();
$eventDispatcher->addSubscriber(new StopWorkerOnMessageLimitListener(1));

$stamp = new class() implements StampInterface {
$stamp = new class implements StampInterface {
};
$listener = function (WorkerMessageReceivedEvent $event) use ($stamp) {
$event->addStamps($stamp);
Expand All @@ -438,21 +439,21 @@ public function testWorkerRateLimitMessages()
$envelope = [
new Envelope(new DummyMessage('message1')),
new Envelope(new DummyMessage('message2')),
new Envelope(new DummyMessage('message3')),
new Envelope(new DummyMessage('message4')),
];
$receiver = new DummyReceiver([$envelope]);

$bus = $this->createMock(MessageBusInterface::class);
$bus->method('dispatch')->willReturnArgument(0);

$eventDispatcher = new EventDispatcher();
$eventDispatcher->addSubscriber(new StopWorkerOnMessageLimitListener(2));
$eventDispatcher->addSubscriber(new StopWorkerOnMessageLimitListener(4));

$rateLimitCount = 0;
$listener = function (WorkerRateLimitedEvent $event) use (&$rateLimitCount) {
$eventDispatcher->addListener(WorkerRateLimitedEvent::class, static function () use (&$rateLimitCount) {
++$rateLimitCount;
$event->getLimiter()->reset(); // Reset limiter to continue test
};
$eventDispatcher->addListener(WorkerRateLimitedEvent::class, $listener);
});

$rateLimitFactory = new RateLimiterFactory([
'id' => 'bus',
Expand All @@ -461,11 +462,14 @@ public function testWorkerRateLimitMessages()
'interval' => '1 minute',
], new InMemoryStorage());

ClockMock::register(Reservation::class);
ClockMock::register(InMemoryStorage::class);

$worker = new Worker(['bus' => $receiver], $bus, $eventDispatcher, null, ['bus' => $rateLimitFactory], new MockClock());
$worker->run();

$this->assertCount(2, $receiver->getAcknowledgedEnvelopes());
$this->assertEquals(1, $rateLimitCount);
$this->assertSame(4, $receiver->getAcknowledgeCount());
$this->assertSame(3, $rateLimitCount);
}

public function testWorkerShouldLogOnStop()
Expand Down
3 changes: 2 additions & 1 deletion src/Symfony/Component/Messenger/Worker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public function run(array $options = []): void
// if queue names are specified, all receivers must implement the QueueReceiverInterface
foreach ($this->receivers as $transportName => $receiver) {
if (!$receiver instanceof QueueReceiverInterface) {
throw new RuntimeException(sprintf('Receiver for "%s" does not implement "%s".', $transportName, QueueReceiverInterface::class));
throw new RuntimeException(\sprintf('Receiver for "%s" does not implement "%s".', $transportName, QueueReceiverInterface::class));
}
}
}
Expand Down Expand Up @@ -242,6 +242,7 @@ private function rateLimit(string $transportName): void

$this->eventDispatcher?->dispatch(new WorkerRateLimitedEvent($rateLimiter, $transportName));
$rateLimiter->reserve()->wait();
$rateLimiter->consume();
}

private function flush(bool $force): bool
Expand Down