Skip to content

[Messenger] Add option to prevent Redis from deleting messages on rejection #36727

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
Sep 4, 2020
Merged

[Messenger] Add option to prevent Redis from deleting messages on rejection #36727

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
6 changes: 6 additions & 0 deletions src/Symfony/Component/Messenger/Bridge/Redis/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
CHANGELOG
=========

5.2.0
-----

* Added a `delete_after_reject` option to the DSN to allow control over message
deletion, similar to `delete_after_ack`.

5.1.0
-----

Expand Down
15 changes: 15 additions & 0 deletions 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 @@ -346,6 +346,21 @@ public function testDeleteAfterAck()
$connection->ack('1');
}

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

$redis->expects($this->exactly(1))->method('xack')
->with('queue', 'symfony', ['1'])
->willReturn(1);
$redis->expects($this->exactly(1))->method('xdel')
->with('queue', ['1'])
->willReturn(1);

$connection = Connection::fromDsn('redis://localhost/queue?delete_after_reject=true', [], $redis); // 1 = always
$connection->reject('1');
}

public function testLastErrorGetsCleared()
{
$redis = $this->getMockBuilder(\Redis::class)->disableOriginalConstructor()->getMock();
Expand Down
18 changes: 15 additions & 3 deletions 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 @@ -33,6 +33,7 @@ class Connection
'consumer' => 'consumer',
'auto_setup' => true,
'delete_after_ack' => false,
'delete_after_reject' => true,
'stream_max_entries' => 0, // any value higher than 0 defines an approximate maximum number of stream entries
'dbindex' => 0,
'tls' => false,
Expand All @@ -51,6 +52,7 @@ class Connection
private $nextClaim = 0;
private $claimInterval;
private $deleteAfterAck;
private $deleteAfterReject;
private $couldHavePendingMessages = true;

public function __construct(array $configuration, array $connectionCredentials = [], array $redisOptions = [], \Redis $redis = null)
Expand Down Expand Up @@ -89,6 +91,7 @@ public function __construct(array $configuration, array $connectionCredentials =
$this->autoSetup = $configuration['auto_setup'] ?? self::DEFAULT_OPTIONS['auto_setup'];
$this->maxEntries = $configuration['stream_max_entries'] ?? self::DEFAULT_OPTIONS['stream_max_entries'];
$this->deleteAfterAck = $configuration['delete_after_ack'] ?? self::DEFAULT_OPTIONS['delete_after_ack'];
$this->deleteAfterReject = $configuration['delete_after_reject'] ?? self::DEFAULT_OPTIONS['delete_after_reject'];
$this->redeliverTimeout = ($configuration['redeliver_timeout'] ?? self::DEFAULT_OPTIONS['redeliver_timeout']) * 1000;
$this->claimInterval = $configuration['claim_interval'] ?? self::DEFAULT_OPTIONS['claim_interval'];
}
Expand Down Expand Up @@ -128,6 +131,12 @@ public static function fromDsn(string $dsn, array $redisOptions = [], \Redis $re
unset($redisOptions['delete_after_ack']);
}

$deleteAfterReject = null;
if (\array_key_exists('delete_after_reject', $redisOptions)) {
$deleteAfterReject = filter_var($redisOptions['delete_after_reject'], \FILTER_VALIDATE_BOOLEAN);
unset($redisOptions['delete_after_reject']);
}

$dbIndex = null;
if (\array_key_exists('dbindex', $redisOptions)) {
$dbIndex = filter_var($redisOptions['dbindex'], \FILTER_VALIDATE_INT);
Expand Down Expand Up @@ -159,6 +168,7 @@ public static function fromDsn(string $dsn, array $redisOptions = [], \Redis $re
'auto_setup' => $autoSetup,
'stream_max_entries' => $maxEntries,
'delete_after_ack' => $deleteAfterAck,
'delete_after_reject' => $deleteAfterReject,
'dbindex' => $dbIndex,
'redeliver_timeout' => $redeliverTimeout,
'claim_interval' => $claimInterval,
Expand Down Expand Up @@ -348,7 +358,9 @@ public function reject(string $id): void
{
try {
$deleted = $this->connection->xack($this->stream, $this->group, [$id]);
$deleted = $this->connection->xdel($this->stream, [$id]) && $deleted;
if ($this->deleteAfterReject) {
$deleted = $this->connection->xdel($this->stream, [$id]) && $deleted;
}
} catch (\RedisException $e) {
throw new TransportException($e->getMessage(), 0, $e);
}
Expand Down Expand Up @@ -426,15 +438,15 @@ public function setup(): void
$this->connection->clearLastError();
}

if ($this->deleteAfterAck) {
if ($this->deleteAfterAck || $this->deleteAfterReject) {
$groups = $this->connection->xinfo('GROUPS', $this->stream);
if (
// support for Redis extension version 5+
(\is_array($groups) && 1 < \count($groups))
// support for Redis extension version 4.x
|| (\is_string($groups) && substr_count($groups, '"name"'))
) {
throw new LogicException(sprintf('More than one group exists for stream "%s", delete_after_ack can not be enabled as it risks deleting messages before all groups could consume them.', $this->stream));
throw new LogicException(sprintf('More than one group exists for stream "%s", delete_after_ack and delete_after_reject can not be enabled as it risks deleting messages before all groups could consume them.', $this->stream));
}
}

Expand Down