10000 [Messenger] [AMQP] Add TransportMessageIdStamp logic for AMQP by AurelienPillevesse · Pull Request #59526 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Messenger] [AMQP] Add TransportMessageIdStamp logic for AMQP #59526

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 17, 2025
Merged

[Messenger] [AMQP] Add TransportMessageIdStamp logic for AMQP #59526

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
72 changes: 71 additions & 1 deletion src/Symfony/Component/Messenger/Bridge/Amqp/Tests/Transport/AmqpReceiverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@
use Symfony\Component\Messenger\Bridge\Amqp\Transport\Connection;
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Exception\TransportException;
use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
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\ArrayDenormalizer;
use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;

/**
Expand Down Expand Up @@ -74,13 +77,80 @@ public function testItThrowsATransportExceptionIfItCannotRejectMessage()
$receiver->reject(new Envelope(new \stdClass(), [new AmqpReceivedStamp($amqpEnvelope, 'queueName')]));
}

private function createAMQPEnvelope(): \AMQPEnvelope
public function testTransportMessageIdStampIsCreatedWhenMessageIdIsSet()
{
$serializer = new Serializer(
new SerializerComponent\Serializer([new DateTimeNormalizer(), new ArrayDenormalizer(), new ObjectNormalizer()], ['json' => new JsonEncoder()])
);

$id = '01946fcb-4bcb-7aa7-9727-dac1c0374443';
$amqpEnvelope = $this->createAMQPEnvelope($id);

$connection = $this->createMock(Connection::class);
$connection->method('getQueueNames')->willReturn(['queueName']);
$connection->method('get')->with('queueName')->willReturn($amqpEnvelope);

$receiver = new AmqpReceiver($connection, $serializer);
$actualEnvelopes = iterator_to_array($receiver->get());
$this->assertCount(1, $actualEnvelopes);

/** @var Envelope $actualEnvelope */
$actualEnvelope = $actualEnvelopes[0];
$this->assertEquals(new DummyMessage('Hi'), $actualEnvelope->getMessage());

/** @var AmqpReceivedStamp $amqpReceivedStamp */
$amqpReceivedStamp = $actualEnvelope->last(AmqpReceivedStamp::class);
$this->assertNotNull($amqpReceivedStamp);
$this->assertSame($amqpEnvelope->getBody(), $amqpReceivedStamp->getAmqpEnvelope()->getBody());
$this->assertSame($amqpEnvelope->getHeaders(), $amqpReceivedStamp->getAmqpEnvelope()->getHeaders());
$this->assertSame($amqpEnvelope->getMessageId(), $amqpReceivedStamp->getAmqpEnvelope()->getMessageId());

/** @var TransportMessageIdStamp $transportMessageIdStamp */
$transportMessageIdStamp = $actualEnvelope->last(TransportMessageIdStamp::class);
$this->assertNotNull($transportMessageIdStamp);
$this->assertSame($id, $transportMessageIdStamp->getId());
}

public function testTransportMessageIdStampIsNotCreatedWhenMessageIdIsNotSet()
{
$serializer = new Serializer(
new SerializerComponent\Serializer([new DateTimeNormalizer(), new ArrayDenormalizer(), new ObjectNormalizer()], ['json' => new JsonEncoder()])
);

$amqpEnvelope = $this->createAMQPEnvelope();

$connection = $this->createMock(Connection::class);
$connection->method('getQueueNames')->willReturn(['queueName']);
$connection->method('get')->with('queueName')->willReturn($amqpEnvelope);

$receiver = new AmqpReceiver($connection, $serializer);
$actualEnvelopes = iterator_to_array($receiver->get());
$this->assertCount(1, $actualEnvelopes);

/** @var Envelope $actualEnvelope */
$actualEnvelope = $actualEnvelopes[0];
$this->assertEquals(new DummyMessage('Hi'), $actualEnvelope->getMessage());

/** @var AmqpReceivedStamp $amqpReceivedStamp */
$amqpReceivedStamp = $actualEnvelope->last(AmqpReceivedStamp::class);
$this->assertNotNull($amqpReceivedStamp);
$this->assertSame($amqpEnvelope->getBody(), $amqpReceivedStamp->getAmqpEnvelope()->getBody());
$this->assertSame($amqpEnvelope->getHeaders(), $amqpReceivedStamp->getAmqpEnvelope()->getHeaders());
$this->assertSame($amqpEnvelope->getMessageId(), $amqpReceivedStamp->getAmqpEnvelope()->getMessageId());

/** @var TransportMessageIdStamp $transportMessageIdStamp */
$transportMessageIdStamp = $actualEnvelope->last(TransportMessageIdStamp::class);
$this->assertNull($transportMessageIdStamp);
}

private function createAMQPEnvelope(?string $messageId = null): \AMQPEnvelope
{
$envelope = $this->createMock(\AMQPEnvelope::class);
$envelope->method('getBody')->willReturn('{"message": "Hi"}');
$envelope->method('getHeaders')->willReturn([
'type' => DummyMessage::class,
]);
$envelope->method('getMessageId')->willReturn($messageId);

return $envelope;
}
Expand Down
44 changes: 44 additions & 0 deletions src/Symfony/Component/Messenger/Bridge/Amqp/Tests/Transport/AmqpSenderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use Symfony\Component\Messenger\Bridge\Amqp\Transport\Connection;
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Exception\TransportException;
use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;

/**
Expand Down Expand Up @@ -118,4 +119,47 @@ public function testItThrowsATransportExceptionIfItCannotSendTheMessage()
$sender = new AmqpSender($connection, $serializer);
$sender->send($envelope);
}

public function testTransportMessageIdStampIsCreatedIfMessageIdIsSet()
{
$id = '01946fcb-4bcb-7aa7-9727-dac1c0374443';
$stamp = new AmqpStamp(null, \AMQP_NOPARAM, ['message_id' => $id]);

$envelope = (new Envelope(new DummyMessage('Oy')))->with($stamp);
$encoded = ['body' => '...', 'headers' => ['type' => DummyMessage::class]];

$serializer = $this->createMock(SerializerInterface::class);
$serializer->method('encode')->with($envelope)->willReturn($encoded);

$connection = $this->createMock(Connection::class);

$connection->expects($this->once())->method('publish')->with($encoded['body'], $encoded['headers'], 0, $stamp);

$sender = new AmqpSender($connection, $serializer);
$returnedEnvelope = $sender->send($envelope);

$transportMessageIdStamp = $returnedEnvelope->last(TransportMessageIdStamp::class);
$this->assertSame($id, $transportMessageIdStamp->getId());
}

public function testTransportMessageIdStampIsNotCreatedIfMessageIdIsNotSet()
{
$stamp = new AmqpStamp(null, \AMQP_NOPARAM, []);

$envelope = (new Envelope(new DummyMessage('Oy')))->with($stamp);
$encoded = ['body' => '...', 'headers' => ['type' => DummyMessage::class]];

$serializer = $this->createMock(SerializerInterface::class);
$serializer->method('encode')->with($envelope)->willReturn($encoded);

$connection = $this->createMock(Connection::class);

$connection->expects($this->once())->method('publish')->with($encoded['body'], $encoded['headers'], 0, $stamp);

$sender = new AmqpSender($connection, $serializer);
$returnedEnvelope = $sender->send($envelope);

$transportMessageIdStamp = $returnedEnvelope->last(TransportMessageIdStamp::class);
$this->assertNull($transportMessageIdStamp);
}
}
7 changes: 7 additions & 0 deletions src/Symfony/Component/Messenger/Bridge/Amqp/Transport/AmqpReceiver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Symfony\Component\Messenger\Exception\LogicException;
use Symfony\Component\Messenger\Exception\MessageDecodingFailedException;
use Symfony\Component\Messenger\Exception\TransportException;
use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
use Symfony\Component\Messenger\Transport\Receiver\MessageCountAwareInterface;
use Symfony\Component\Messenger\Transport\Receiver\QueueReceiverInterface;
use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
Expand Down Expand Up @@ -84,6 +85,12 @@ private function getEnvelope(string $queueName): iterable
throw $exception;
}

if (null !== $amqpEnvelope->getMessageId()) {
$envelope = $envelope
->withoutAll(TransportMessageIdStamp::class)
->with(new TransportMessageIdStamp($amqpEnvelope->getMessageId()));
}

yield $envelope->with(new AmqpReceivedStamp($amqpEnvelope, $queueName));
}

Expand Down
5 changes: 5 additions & 0 deletions src/Symfony/Component/Messenger/Bridge/Amqp/Transport/AmqpSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Symfony\Component\Messenger\Exception\TransportException;
use Symfony\Component\Messenger\Stamp\DelayStamp;
use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
Expand Down Expand Up @@ -54,6 +55,10 @@ public function send(Envelope $envelope): Envelope
}
}

if ($amqpStamp instanceof AmqpStamp && isset($amqpStamp->getAttributes()['message_id'])) {
$envelope = $envelope->with(new TransportMessageIdStamp($amqpStamp->getAttributes()['message_id']));
}

$amqpReceivedStamp = $envelope->last(AmqpReceivedStamp::class);
if ($amqpReceivedStamp instanceof AmqpReceivedStamp) {
$amqpStamp = AmqpStamp::createFromAmqpEnvelope(
Expand Down
Loading
0