8000 [Messenger] Fix redis last error not cleared between calls by chalasr · Pull Request #32726 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Messenger] Fix redis last error not cleared between calls #32726

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
Jul 27, 2019
Merged

[Messenger] Fix redis last error not cleared between calls #32726

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
[Messenger] Fix redis last error not cleared between calls
  • Loading branch information
Robin Chalas committed Jul 24, 2019
commit 9c263ffca818de4b204dabb5babff189a2b055a8
31 changes: 29 additions & 2 deletions src/Symfony/Component/Messenger/Tests/Transport/RedisExt/ConnectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
use Symfony\Component\Messenger\Transport\RedisExt\Connection;

/**
* @requires extension redis
* @requires extension redis >= 4.3.0
*/
class ConnectionTest extends TestCase
{
Expand Down 8000 Expand Up @@ -119,7 +119,7 @@ public function testUnexpectedRedisError()
$redis->expects($this->once())->method('xreadgroup')->willReturn(false);
$redis->expects($this->once())->method('getLastError')->willReturn('Redis error happens');

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

Expand Down Expand Up @@ -152,4 +152,31 @@ public function testGetNonBlocking()
$connection->reject($message['id']);
$redis->del('messenger-getnonblocking');
}

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

$redis->expects($this->once())->method('xadd')->willReturn(0);
$redis->expects($this->once())->method('xack')->willReturn(0);

$redis->method('getLastError')->willReturnOnConsecutiveCalls('xadd error', 'xack error');
$redis->expects($this->exactly(2))->method('clearLastError');

$connection = Connection::fromDsn('redis://localhost/messenger-clearlasterror', ['auto_setup' => false], $redis);

try {
$connection->add('message', []);
} catch (TransportException $e) {
}

$this->assertSame('xadd error', $e->getMessage());

try {
$connection->ack('1');
} catch (TransportException $e) {
}

$this->assertSame('xack error', $e->getMessage());
}
}
43 changes: 30 additions & 13 deletions src/Symfony/Component/Messenger/Transport/RedisExt/Connection.php
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,15 @@ public function get(): ?array
1
);
} catch (\RedisException $e) {
throw new TransportException($e->getMessage(), 0, $e);
}

if ($e || false === $messages) {
throw new TransportException(
($e ? $e->getMessage() : $this->connection->getLastError()) ?? 'Could not read messages from the redis stream.'
);
if (false === $messages) {
if ($error = $this->connection->getLastError() ?: null) {
$this->connection->clearLastError();
}

throw new TransportException($error ?? 'Could not read messages from the redis stream.');
}

if ($this->couldHavePendingMessages && empty($messages[$this->stream])) {
Expand All @@ -144,28 +147,34 @@ public function get(): ?array

public function ack(string $id): void
{
$e = null;
try {
$acknowledged = $this->connection->xack($this->stream, $this->group, [$id]);
} catch (\RedisException $e) {
throw new TransportException($e->getMessage(), 0, $e);
}

if ($e || !$acknowledged) {
throw new TransportException(($e ? $e->getMessage() : $this->connection->getLastError()) ?? sprintf('Could not acknowledge redis message "%s".', $id), 0, $e);
if (!$acknowledged) {
if ($error = $this->connection->getLastError() ?: null) {
$this->connection->clearLastError();
}
throw new TransportException($error ?? sprintf('Could not acknowledge redis message "%s".', $id));
}
}

public function reject(string $id): void
{
$e = null;
try {
$deleted = $this->connection->xack($this->stream, $this->group, [$id]);
$deleted = $this->connection->xdel($this->stream, [$id]) && $deleted;
} catch (\RedisException $e) {
throw new TransportException($e->getMessage(), 0, $e);
}

if ($e || !$deleted) {
throw new TransportException(($e ? $e->getMessage() : $this->connection->getLastError()) ?? sprintf('Could not delete message "%s" from the redis stream.', $id), 0, $e);
if (!$deleted) {
if ($error = $this->connection->getLastError() ?: null) {
$this->connection->clearLastError();
}
throw new TransportException($error ?? sprintf('Could not delete message "%s" from the redis stream.', $id));
}
}

Expand All @@ -175,16 +184,19 @@ public function add(string $body, array $headers): void
$this->setup();
}

$e = null;
try {
$added = $this->connection->xadd($this->stream, '*', ['message' => json_encode(
['body' => $body, 'headers' => $headers]
)]);
} catch (\RedisException $e) {
throw new TransportException($e->getMessage(), 0, $e);
}

if ($e || !$added) {
throw new TransportException(($e ? $e->getMessage() : $this->connection->getLastError()) ?? 'Could not add a message to the redis stream.', 0, $e);
if (!$added) {
if ($error = $this->connection->getLastError() ?: null) {
$this->connection->clearLastError();
}
throw new TransportException($error ?? 'Could not add a message to the redis stream.');
}
}

Expand All @@ -196,6 +208,11 @@ public function setup(): void
throw new TransportException($e->getMessage(), 0, $e);
}

// group might already exist, ignore
if ($this->connection->getLastError()) {
$this->connection->clearLastError();
}

$this->autoSetup = false;
}
}
0