Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

[Messenger] Add receiving of old pending messages (redis) #35384

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
Feb 8, 2020
Merged

[Messenger] Add receiving of old pending messages (redis) #35384

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
68 changes: 56 additions & 12 deletions 68 src/Symfony/Component/Messenger/Bridge/Redis/Tests/Transport/ConnectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ public function testKeepGettingPendingMessages()

$redis->expects($this->exactly(3))->method('xreadgroup')
->with('symfony', 'consumer', ['queue' => 0], 1, null)
->willReturn(['queue' => [['message' => json_encode(['body' => 'Test', 'headers' => []])]]]);
->willReturn(['queue' => [['message' => '{"body":"Test","headers":[]}']]]);

$connection = Connection::fromDsn('redis://localhost/queue', [], $redis);
$this->assertNotNull($connection->get());
Expand Down Expand Up @@ -164,23 +164,67 @@ public function testDbIndex()
$this->assertSame(2, $redis->getDbNum());
}

public function testFirstGetPendingMessagesThenNewMessages()
public function testGetPendingMessageFirst()
{
$redis = $this->getMockBuilder(\Redis::class)->disableOriginalConstructor()->getMock();

$count = 0;
$redis->expects($this->exactly(1))->method('xreadgroup')
->with('symfony', 'consumer', ['queue' => '0'], 1, null)
->willReturn(['queue' => [['message' => '{"body":"1","headers":[]}']]]);

$redis->expects($this->exactly(2))->method('xreadgroup')
->with('symfony', 'consumer', $this->callback(function ($arr_streams) use (&$count) {
++$count;
$connection = Connection::fromDsn('redis://localhost/queue', [], $redis);
$connection->get();
}

public function testClaimAbandonedMessageWithRaceCondition()
{
$redis = $this->getMockBuilder(\Redis::class)->disableOriginalConstructor()->getMock();

$redis->expects($this->exactly(3))->method('xreadgroup')
->withConsecutive(
['symfony', 'consumer', ['queue' => '0'], 1, null], // first call for pending messages
['symfony', 'consumer', ['queue' => '0'], 1, null], // sencond call because of claimed message (redisid-123)
['symfony', 'consumer', ['queue' => '>'], 1, null] // third call because of no result (other consumer claimed message redisid-123)
)
->willReturnOnConsecutiveCalls([], [], []);

$redis->expects($this->once())->method('xpending')->willReturn([[
0 => 'redisid-123', // message-id
1 => 'consumer-2', // consumer-name
2 => 3600001, // idle
]]);

$redis->expects($this->exactly(1))->method('xclaim')
->with('queue', 'symfony', 'consumer', 3600000, ['redisid-123'], ['JUSTID'])
->willReturn([]);

$connection = Connection::fromDsn('redis://localhost/queue', [], $redis);
$connection->get();
}

if (1 === $count) {
return '0' === $arr_streams['queue'];
}
public function testClaimAbandonedMessage()
{
$redis = $this->getMockBuilder(\Redis::class)->disableOriginalConstructor()->getMock();

return '>' === $arr_streams['queue'];
}), 1, null)
->willReturn(['queue' => []]);
$redis->expects($this->exactly(2))->method('xreadgroup')
->withConsecutive(
['symfony', 'consumer', ['queue' => '0'], 1, null], // first call for pending messages
['symfony', 'consumer', ['queue' => '0'], 1, null] // sencond call because of claimed message (redisid-123)
)
->willReturnOnConsecutiveCalls(
[], // first call returns no result
['queue' => [['message' => '{"body":"1","headers":[]}']]] // second call returns clamed message (redisid-123)
);

$redis->expects($this->once())->method('xpending')->willReturn([[
0 => 'redisid-123', // message-id
1 => 'consumer-2', // consumer-name
2 => 3600001, // idle
]]);

$redis->expects($this->exactly(1))->method('xclaim')
->with('queue', 'symfony', 'consumer', 3600000, ['redisid-123'], ['JUSTID'])
->willReturn([]);

$connection = Connection::fromDsn('redis://localhost/queue', [], $redis);
$connection->get();
Expand Down
83 changes: 83 additions & 0 deletions 83 src/Symfony/Component/Messenger/Bridge/Redis/Tests/Transport/RedisExtIntegrationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,87 @@ public function testConnectionSendDelayedMessagesWithSameContent()
$this->assertEquals($body, $encoded['body']);
$this->assertEquals($headers, $encoded['headers']);
}

public function testConnectionBelowRedeliverTimeout()
{
// lower redeliver timeout and claim interval
$connection = Connection::fromDsn(getenv('MESSENGER_REDIS_DSN'), [], $this->redis);

$connection->cleanup();
$connection->setup();

$body = '{"message": "Hi"}';
$headers = ['type' => DummyMessage::class];

// Add two messages
$connection->add($body, $headers);

// Read first message with other consumer
$this->redis->xreadgroup(
$this->getConnectionGroup($connection),
'other-consumer2',
[$this->getConnectionStream($connection) => '>'],
1
);

// Queue will not have any messages yet
$this->assertNull($connection->get());
}

public function testConnectionClaimAndRedeliver()
{
// lower redeliver timeout and claim interval
$connection = Connection::fromDsn(
getenv('MESSENGER_REDIS_DSN'),
['redeliver_timeout' => 0, 'claim_interval' => 500],
$this->redis
);

$connection->cleanup();
$connection->setup();

$body1 = '{"message": "Hi"}';
$body2 = '{"message": "Bye"}';
$headers = ['type' => DummyMessage::class];

// Add two messages
$connection->add($body1, $headers);
$connection->add($body2, $headers);

// Read first message with other consumer
$this->redis->xreadgroup(
$this->getConnectionGroup($connection),
'other-consumer2',
[$this->getConnectionStream($connection) => '>'],
1
);

// Queue will return the pending message first because redeliver_timeout = 0
$encoded = $connection->get();
$this->assertEquals($body1, $encoded['body']);
$this->assertEquals($headers, $encoded['headers']);
$connection->ack($encoded['id']);

// Queue will return the second message
$encoded = $connection->get();
$this->assertEquals($body2, $encoded['body']);
$this->assertEquals($headers, $encoded['headers']);
$connection->ack($encoded['id']);
}

private function getConnectionGroup(Connection $connection): string
{
$property = (new \ReflectionClass(Connection::class))->getProperty('group');
$property->setAccessible(true);

return $property->getValue($connection);
}

private function getConnectionStream(Connection $connection): string
{
$property = (new \ReflectionClass(Connection::class))->getProperty('stream');
$property->setAccessible(true);

return $property->getValue($connection);
}
}
68 changes: 68 additions & 0 deletions 68 src/Symfony/Component/Messenger/Bridge/Redis/Transport/Connection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ class Connection
'stream_max_entries' => 0, // any value higher than 0 defines an approximate maximum number of stream entries
'dbindex' => 0,
'tls' => false,
'redeliver_timeout' => 3600, // Timeout before redeliver messages still in pending state (seconds)
'claim_interval' => 60000, // Interval by which pending/abandoned messages should be checked
];

private $connection;
Expand All @@ -44,6 +46,9 @@ class Connection
private $consumer;
private $autoSetup;
private $maxEntries;
private $redeliverTimeout;
private $nextClaim = 0;
private $claimInterval;
private $couldHavePendingMessages = true;

public function __construct(array $configuration, array $connectionCredentials = [], array $redisOptions = [], \Redis $redis = null)
Expand All @@ -70,6 +75,8 @@ public function __construct(array $configuration, array $connectionCredentials =
$this->queue = $this->stream.'__queue';
$this->autoSetup = $configuration['auto_setup'] ?? self::DEFAULT_OPTIONS['auto_setup'];
$this->maxEntries = $configuration['stream_max_entries'] ?? self::DEFAULT_OPTIONS['stream_max_entries'];
$this->redeliverTimeout = ($configuration['redeliver_timeout'] ?? self::DEFAULT_OPTIONS['redeliver_timeout']) * 1000;
$this->claimInterval = $configuration['claim_interval'] ?? self::DEFAULT_OPTIONS['claim_interval'];
}

public static function fromDsn(string $dsn, array $redisOptions = [], \Redis $redis = null): self
Expand Down Expand Up @@ -113,13 +120,27 @@ public static function fromDsn(string $dsn, array $redisOptions = [], \Redis $re
unset($redisOptions['tls']);
}

$redeliverTimeout = null;
if (\array_key_exists('redeliver_timeout', $redisOptions)) {
$redeliverTimeout = filter_var($redisOptions['redeliver_timeout'], FILTER_VALIDATE_INT);
unset($redisOptions['redeliver_timeout']);
}

$claimInterval = null;
if (\array_key_exists('claim_interval', $redisOptions)) {
$claimInterval = filter_var($redisOptions['claim_interval'], FILTER_VALIDATE_INT);
unset($redisOptions['claim_interval']);
}

$configuration = [
'stream' => $redisOptions['stream'] ?? null,
'group' => $redisOptions['group'] ?? null,
'consumer' => $redisOptions['consumer'] ?? null,
'auto_setup' => $autoSetup,
'stream_max_entries' => $maxEntries,
'dbindex' => $dbIndex,
'redeliver_timeout' => $redeliverTimeout,
'claim_interval' => $claimInterval,
];

if (isset($parsedUrl['host'])) {
Expand Down Expand Up @@ -157,6 +178,49 @@ private static function validateOptions(array $options): void
}
}

private function claimOldPendingMessages()
{
try {
// This could soon be optimized with https://github.com/antirez/redis/issues/5212 or
// https://github.com/antirez/redis/issues/6256
$pendingMessages = $this->connection->xpending($this->stream, $this->group, '-', '+', 1);
chalasr marked this conversation as resolved.
Show resolved Hide resolved
} catch (\RedisException $e) {
throw new TransportException($e->getMessage(), 0, $e);
}

$claimableIds = [];
foreach ($pendingMessages as $pendingMessage) {
if ($pendingMessage[1] === $this->consumer) {
$this->couldHavePendingMessages = true;

return;
}

if ($pendingMessage[2] >= $this->redeliverTimeout) {
$claimableIds[] = $pendingMessage[0];
}
}

if (\count($claimableIds) > 0) {
try {
$this->connection->xclaim(
$this->stream,
$this->group,
$this->consumer,
$this->redeliverTimeout,
$claimableIds,
['JUSTID']
);

$this->couldHavePendingMessages = true;
} catch (\RedisException $e) {
throw new TransportException($e->getMessage(), 0, $e);
}
}

$this->nextClaim = $this->getCurrentTimeInMilliseconds() + $this->claimInterval;
}

public function get(): ?array
{
if ($this->autoSetup) {
Expand Down Expand Up @@ -191,6 +255,10 @@ public function get(): ?array
}
}

if (!$this->couldHavePendingMessages && $this->nextClaim <= $this->getCurrentTimeInMilliseconds()) {
$this->claimOldPendingMessages();
}

$messageId = '>'; // will receive new messages

if ($this->couldHavePendingMessages) {
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.