-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Messenger] Add a redis stream transport #30917
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.
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
115 changes: 115 additions & 0 deletions
115
src/Symfony/Component/Messenger/Tests/Transport/RedisExt/ConnectionTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Messenger\Tests\Transport\RedisExt; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\Messenger\Exception\LogicException; | ||
| use Symfony\Component\Messenger\Transport\RedisExt\Connection; | ||
|
|
||
| /** | ||
| * @requires extension redis | ||
| */ | ||
| class ConnectionTest extends TestCase | ||
| { | ||
| public function testFromInvalidDsn() | ||
| { | ||
| $this->expectException(\InvalidArgumentException::class); | ||
| $this->expectExceptionMessage('The given Redis DSN "redis://" is invalid.'); | ||
|
|
||
| Connection::fromDsn('redis://'); | ||
| } | ||
|
|
||
| public function testFromDsn() | ||
| { | ||
| $this->assertEquals( | ||
| new Connection(['stream' => 'queue'], [ | ||
| 'host' => 'localhost', | ||
| 'port' => 6379, | ||
| ]), | ||
| Connection::fromDsn('redis://localhost/queue') | ||
| ); | ||
| } | ||
|
|
||
| public function testFromDsnWithOptions() | ||
| { | ||
| $this->assertEquals( | ||
| new Connection(['stream' => 'queue', 'group' => 'group1', 'consumer' => 'consumer1'], [ | ||
| 'host' => 'localhost', | ||
| 'port' => 6379, | ||
| ], [ | ||
| 'blocking_timeout' => 30, | ||
| ]), | ||
| Connection::fromDsn('redis://localhost/queue/group1/consumer1', ['blocking_timeout' => 30]) | ||
| ); | ||
| } | ||
|
|
||
| public function testFromDsnWithQueryOptions() | ||
| { | ||
| $this->assertEquals( | ||
| new Connection(['stream' => 'queue', 'group' => 'group1', 'consumer' => 'consumer1'], [ | ||
| 'host' => 'localhost', | ||
| 'port' => 6379, | ||
| ], [ | ||
| 'blocking_timeout' => 30, | ||
| ]), | ||
| Connection::fromDsn('redis://localhost/queue/group1/consumer1?blocking_timeout=30') | ||
| ); | ||
| } | ||
|
|
||
| public function testKeepGettingPendingMessages() | ||
| { | ||
| $redis = $this->getMockBuilder(\Redis::class)->disableOriginalConstructor()->getMock(); | ||
|
|
||
| $redis->expects($this->exactly(3))->method('xreadgroup') | ||
| ->with('symfony', 'consumer', ['queue' => 0], 1, null) | ||
| ->willReturn(['queue' => [['message' => json_encode(['body' => 'Test', 'headers' => []])]]]); | ||
|
|
||
| $connection = Connection::fromDsn('redis://localhost/queue', [], $redis); | ||
| $this->assertNotNull($connection->get()); | ||
| $this->assertNotNull($connection->get()); | ||
| $this->assertNotNull($connection->get()); | ||
| } | ||
|
|
||
| public function testFirstGetPendingMessagesThenNewMessages() | ||
| { | ||
| $redis = $this->getMockBuilder(\Redis::class)->disableOriginalConstructor()->getMock(); | ||
|
|
||
| $count = 0; | ||
|
|
||
| $redis->expects($this->exactly(2))->method('xreadgroup') | ||
| ->with('symfony', 'consumer', $this->callback(function ($arr_streams) use (&$count) { | ||
| ++$count; | ||
|
|
||
| if (1 === $count) { | ||
| return '0' === $arr_streams['queue']; | ||
| } | ||
|
|
||
| return '>' === $arr_streams['queue']; | ||
| }), 1, null) | ||
| ->willReturn(['queue' => []]); | ||
|
|
||
| $connection = Connection::fromDsn('redis://localhost/queue', [], $redis); | ||
| $connection->get(); | ||
| } | ||
|
|
||
| public function testUnexpectedRedisError() | ||
| { | ||
| $this->expectException(LogicException::class); | ||
| $this->expectExceptionMessage('Redis error happens'); | ||
| $redis = $this->getMockBuilder(\Redis::class)->disableOriginalConstructor()->getMock(); | ||
| $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->get(); | ||
| } | ||
| } |
65 changes: 65 additions & 0 deletions
65
src/Symfony/Component/Messenger/Tests/Transport/RedisExt/RedisExtIntegrationTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Messenger\Tests\Transport\RedisExt; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage; | ||
| use Symfony\Component\Messenger\Transport\RedisExt\Connection; | ||
|
|
||
| /** | ||
| * @requires extension redis | ||
| */ | ||
| class RedisExtIntegrationTest extends TestCase | ||
| { | ||
| private $redis; | ||
| private $connection; | ||
|
|
||
| protected function setUp() | ||
| { | ||
| if (!getenv('MESSENGER_REDIS_DSN')) { | ||
| $this->markTestSkipped('The "MESSENGER_REDIS_DSN" environment variable is required.'); | ||
| } | ||
|
|
||
| $this->redis = new \Redis(); | ||
| $this->connection = Connection::fromDsn(getenv('MESSENGER_REDIS_DSN'), [], $this->redis); | ||
| $this->clearRedis(); | ||
| $this->connection->setup(); | ||
| } | ||
|
|
||
| public function testConnectionSendAndGet() | ||
| { | ||
| $this->connection->add('{"message": "Hi"}', ['type' => DummyMessage::class]); | ||
| $encoded = $this->connection->get(); | ||
| $this->assertEquals('{"message": "Hi"}', $encoded['body']); | ||
| $this->assertEquals(['type' => DummyMessage::class], $encoded['headers']); | ||
| } | ||
|
|
||
| public function testGetTheFirstAvailableMessage() | ||
| { | ||
| $this->connection->add('{"message": "Hi1"}', ['type' => DummyMessage::class]); | ||
| $this->connection->add('{"message": "Hi2"}', ['type' => DummyMessage::class]); | ||
| $encoded = $this->connection->get(); | ||
| $this->assertEquals('{"message": "Hi1"}', $encoded['body']); | ||
| $this->assertEquals(['type' => DummyMessage::class], $encoded['headers']); | ||
| $encoded = $this->connection->get(); | ||
| $this->assertEquals('{"message": "Hi2"}', $encoded['body']); | ||
| $this->assertEquals(['type' => DummyMessage::class], $encoded['headers']); | ||
| } | ||
|
|
||
| private function clearRedis() | ||
| { | ||
| $parsedUrl = parse_url(getenv('MESSENGER_REDIS_DSN')); | ||
| $pathParts = explode('/', $parsedUrl['path'] ?? ''); | ||
| $stream = $pathParts[1] ?? 'symfony'; | ||
| $this->redis->del($stream); | ||
| } | ||
| } |
76 changes: 76 additions & 0 deletions
76
src/Symfony/Component/Messenger/Tests/Transport/RedisExt/RedisReceiverTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Messenger\Tests\Transport\RedisExt; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\Messenger\Exception\MessageDecodingFailedException; | ||
| use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage; | ||
| use Symfony\Component\Messenger\Transport\RedisExt\Connection; | ||
| use Symfony\Component\Messenger\Transport\RedisExt\RedisReceiver; | ||
| use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer; | ||
| use Symfony\Component\Messenger\Transport\Serialization\Serializer; | ||
| use Symfony\Component\Serializer as SerializerComponent; | ||
| use Symfony\Component\Serializer\Encoder\JsonEncoder; | ||
| use Symfony\Component\Serializer\Normalizer\ObjectNormalizer; | ||
|
|
||
| class RedisReceiverTest extends TestCase | ||
| { | ||
| public function testItReturnsTheDecodedMessageToTheHandler() | ||
| { | ||
| $serializer = $this->createSerializer(); | ||
|
|
||
| $redisEnvelop = $this->createRedisEnvelope(); | ||
| $connection = $this->getMockBuilder(Connection::class)->disableOriginalConstructor()->getMock(); | ||
| $connection->method('get')->willReturn($redisEnvelop); | ||
|
|
||
| $receiver = new RedisReceiver($connection, $serializer); | ||
| $actualEnvelopes = iterator_to_array($receiver->get()); | ||
| $this->assertCount(1, $actualEnvelopes); | ||
| $this->assertEquals(new DummyMessage('Hi'), $actualEnvelopes[0]->getMessage()); | ||
| } | ||
|
|
||
| public function testItRejectTheMessageIfThereIsAMessageDecodingFailedException() | ||
| { | ||
| $this->expectException(MessageDecodingFailedException::class); | ||
|
|
||
| $serializer = $this->createMock(PhpSerializer::class); | ||
| $serializer->method('decode')->willThrowException(new MessageDecodingFailedException()); | ||
|
|
||
| $redisEnvelop = $this->createRedisEnvelope(); | ||
| $connection = $this->getMockBuilder(Connection::class)->disableOriginalConstructor()->getMock(); | ||
| $connection->method('get')->willReturn($redisEnvelop); | ||
| $connection->expects($this->once())->method('reject'); | ||
|
|
||
| $receiver = new RedisReceiver($connection, $serializer); | ||
| iterator_to_array($receiver->get()); | ||
| } | ||
|
|
||
| private function createRedisEnvelope() | ||
| { | ||
| return [ | ||
| 'id' => 1, | ||
| 'body' => '{"message": "Hi"}', | ||
| 'headers' => [ | ||
| 'type' => DummyMessage::class, | ||
| ], | ||
| ]; | ||
| } | ||
|
|
||
| private function createSerializer(): Serializer | ||
| { | ||
| $serializer = new Serializer( | ||
| new SerializerComponent\Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]) | ||
| ); | ||
|
|
||
| return $serializer; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.