Skip to content

[Messenger] Allow using user's serializer for message do not fit the expected JSON structure #42257

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 27, 2021
Merged

[Messenger] Allow using user's serializer for message do not fit the expected JSON structure #42257

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
31 changes: 31 additions & 0 deletions src/Symfony/Component/Messenger/Bridge/Redis/Tests/Fixtures/ExternalMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

namespace Symfony\Component\Messenger\Bridge\Redis\Tests\Fixtures;

class ExternalMessage
{
private $foo;
private $bar = [];

public function __construct(string $foo)
{
$this->foo = $foo;
}

public function getFoo(): string
{
return $this->foo;
}

public function setBar(array $bar): self
{
$this->bar = $bar;

return $this;
}

public function getBar(): array
{
return $this->bar;
}
}
25 changes: 25 additions & 0 deletions src/Symfony/Component/Messenger/Bridge/Redis/Tests/Fixtures/ExternalMessageSerializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

namespace Symfony\Component\Messenger\Bridge\Redis\Tests\Fixtures;

use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;

class ExternalMessageSerializer implements SerializerInterface
{
public function decode(array $encodedEnvelope): Envelope
{
$message = new ExternalMessage($encodedEnvelope['foo']);
$message->setBar($encodedEnvelope['bar']);

return new Envelope($message);
}

public function encode(Envelope $envelope): array
{
return [
'body' => $envelope->getMessage(),
'headers' => [],
];
}
}
12 changes: 11 additions & 1 deletion 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 @@ -251,7 +251,17 @@ public function testGetPendingMessageFirst()
->willReturn(['queue' => [['message' => '{"body":"1","headers":[]}']]]);

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

$this->assertSame([
'id' => 0,
'data' => [
'message' => json_encode([
'body' => '1',
'headers' => [],
]),
],
], $message);
}

public function testClaimAbandonedMessageWithRaceCondition()
Expand Down
126 changes: 88 additions & 38 deletions 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 @@ -45,21 +45,33 @@ protected function setUp(): void
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']);
$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => '{"message": "Hi"}',
'headers' => ['type' => DummyMessage::class],
]),
], $message['data']);
}

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']);
$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => '{"message": "Hi1"}',
'headers' => ['type' => DummyMessage::class],
]),
], $message['data']);
$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => '{"message": "Hi2"}',
'headers' => ['type' => DummyMessage::class],
]),
], $message['data']);
}

public function testConnectionSendWithSameContent()
Expand All @@ -70,24 +82,36 @@ public function testConnectionSendWithSameContent()
$this->connection->add($body, $headers);
$this->connection->add($body, $headers);

$encoded = $this->connection->get();
$this->assertEquals($body, $encoded['body']);
$this->assertEquals($headers, $encoded['headers']);

$encoded = $this->connection->get();
$this->assertEquals($body, $encoded['body']);
$this->assertEquals($headers, $encoded['headers']);
$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => $body,
'headers' => $headers,
]),
], $message['data']);

$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => $body,
'headers' => $headers,
]),
], $message['data']);
}

public function testConnectionSendAndGetDelayed()
{
$this->connection->add('{"message": "Hi"}', ['type' => DummyMessage::class], 500);
$encoded = $this->connection->get();
$this->assertNull($encoded);
$message = $this->connection->get();
$this->assertNull($message);
sleep(2);
$encoded = $this->connection->get();
$this->assertEquals('{"message": "Hi"}', $encoded['body']);
$this->assertEquals(['type' => DummyMessage::class], $encoded['headers']);
$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => '{"message": "Hi"}',
'headers' => ['type' => DummyMessage::class],
]),
], $message['data']);
}

public function testConnectionSendDelayedMessagesWithSameContent()
Expand All @@ -98,13 +122,21 @@ public function testConnectionSendDelayedMessagesWithSameContent()
$this->connection->add($body, $headers, 500);
$this->connection->add($body, $headers, 500);
sleep(2);
$encoded = $this->connection->get();
$this->assertEquals($body, $encoded['body']);
$this->assertEquals($headers, $encoded['headers']);

$encoded = $this->connection->get();
$this->assertEquals($body, $encoded['body']);
$this->assertEquals($headers, $encoded['headers']);
$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => $body,
'headers' => $headers,
]),
], $message['data']);

$message = $this->connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => $body,
'headers' => $headers,
]),
], $message['data']);
}

public function testConnectionBelowRedeliverTimeout()
Expand Down Expand Up @@ -162,16 +194,24 @@ public function testConnectionClaimAndRedeliver()
);

// 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']);
$message = $connection->get();
$this->assertEquals([
'message' => json_encode([
'body' => $body1,
'headers' => $headers,
]),
], $message['data']);
$connection->ack($message['id']);

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

public function testLazyCluster()
Expand All @@ -186,7 +226,12 @@ public function testLazyCluster()

$connection->add('1', []);
$this->assertNotEmpty($message = $connection->get());
$this->assertSame('1', $message['body']);
$this->assertSame([
'message' => json_encode([
'body' => '1',
'headers' => [],
]),
], $message['data']);
$connection->reject($message['id']);
$connection->cleanup();
}
Expand All @@ -198,7 +243,12 @@ public function testLazy()

$connection->add('1', []);
$this->assertNotEmpty($message = $connection->get());
$this->assertSame('1', $message['body']);
$this->assertSame([
'message' => json_encode([
'body' => '1',
'headers' => [],
]),
], $message['data']);
$connection->reject($message['id']);
$redis->del('messenger-lazy');
}
Expand Down
85 changes: 65 additions & 20 deletions src/Symfony/Component/Messenger/Bridge/Redis/Tests/Transport/RedisReceiverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,64 +13,109 @@

use PHPUnit\Framework\TestCase;
use Symfony\Component\Messenger\Bridge\Redis\Tests\Fixtures\DummyMessage;
use Symfony\Component\Messenger\Bridge\Redis\Tests\Fixtures\ExternalMessage;
use Symfony\Component\Messenger\Bridge\Redis\Tests\Fixtures\ExternalMessageSerializer;
use Symfony\Component\Messenger\Bridge\Redis\Transport\Connection;
use Symfony\Component\Messenger\Bridge\Redis\Transport\RedisReceiver;
use Symfony\Component\Messenger\Exception\MessageDecodingFailedException;
use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
use Symfony\Component\Messenger\Transport\Serialization\Serializer;
use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
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()
/**
* @dataProvider redisEnvelopeProvider
*/
public function testItReturnsTheDecodedMessageToTheHandler(array $redisEnvelope, $expectedMessage, SerializerInterface $serializer)
{
$serializer = $this->createSerializer();

$redisEnvelop = $this->createRedisEnvelope();
$connection = $this->createMock(Connection::class);
$connection->method('get')->willReturn($redisEnvelop);
$connection->method('get')->willReturn($redisEnvelope);

$receiver = new RedisReceiver($connection, $serializer);
$actualEnvelopes = $receiver->get();
$this->assertCount(1, $actualEnvelopes);
$this->assertEquals(new DummyMessage('Hi'), $actualEnvelopes[0]->getMessage());
$this->assertEquals($expectedMessage, $actualEnvelopes[0]->getMessage());
}

public function testItRejectTheMessageIfThereIsAMessageDecodingFailedException()
/**
* @dataProvider rejectedRedisEnvelopeProvider
*/
public function testItRejectTheMessageIfThereIsAMessageDecodingFailedException(array $redisEnvelope)
{
$this->expectException(MessageDecodingFailedException::class);

$serializer = $this->createMock(PhpSerializer::class);
$serializer->method('decode')->willThrowException(new MessageDecodingFailedException());

$redisEnvelop = $this->createRedisEnvelope();
$connection = $this->createMock(Connection::class);
$connection->method('get')->willReturn($redisEnvelop);
$connection->method('get')->willReturn($redisEnvelope);
$connection->expects($this->once())->method('reject');

$receiver = new RedisReceiver($connection, $serializer);
$receiver->get();
}

private function createRedisEnvelope(): array
public function redisEnvelopeProvider(): \Generator
{
return [
'id' => 1,
'body' => '{"message": "Hi"}',
'headers' => [
'type' => DummyMessage::class,
yield [
[
'id' => 1,
'data' => json_encode([
'body' => '{"message": "Hi"}',
'headers' => [
'type' => DummyMessage::class,
],
]),
],
new DummyMessage('Hi'),
new Serializer(
new SerializerComponent\Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()])
),
];

yield [
[
'id' => 2,
'data' => json_encode([
'foo' => 'fooValue',
'bar' => [
'baz' => 'bazValue',
],
]),
],
(new ExternalMessage('fooValue'))->setBar(['baz' => 'bazValue']),
new ExternalMessageSerializer(),
];
}

private function createSerializer(): Serializer
public function rejectedRedisEnvelopeProvider(): \Generator
{
$serializer = new Serializer(
new SerializerComponent\Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()])
);
yield [
[
'id' => 1,
'data' => json_encode([
'body' => '{"message": "Hi"}',
'headers' => [
'type' => DummyMessage::class,
],
]),
],
];

return $serializer;
yield [
[
'id' => 2,
'data' => json_encode([
'foo' => 'fooValue',
'bar' => [
'baz' => 'bazValue',
],
]),
],
];
}
}
Loading