10000 [Doctrine][Messenger] Prevents multiple TransportMessageIdStamp being stored in envelope by rtreffler · Pull Request #59362 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Doctrine][Messenger] Prevents multiple TransportMessageIdStamp being stored in envelope #59362

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
Jan 6, 2025
Merged

[Doctrine][Messenger] Prevents multiple TransportMessageIdStamp being stored in envelope #59362

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
83 changes: 75 additions & 8 deletions src/Symfony/Component/Messenger/Bridge/Doctrine/Tests/Transport/DoctrineReceiverTest.php
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
use Symfony\Component\Messenger\Transport\Serialization\Serializer;
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;

class DoctrineReceiverTest extends TestCase
Expand Down Expand Up @@ -100,6 +102,23 @@ public function testOccursRetryableExceptionFromConnection()
$receiver->get();
}

public function testGetReplacesExistingTransportMessageIdStamps()
{
$serializer = $this->createSerializer();

$doctrineEnvelope = $this->createRetriedDoctrineEnvelope();
$connection = $this->createMock(Connection::class);
$connection->method('get')->willReturn($doctrineEnvelope);

$receiver = new DoctrineReceiver($connection, $serializer);
$actualEnvelopes = $receiver->get();
/** @var Envelope $actualEnvelope */
$actualEnvelope = $actualEnvelopes[0];
$messageIdStamps = $actualEnvelope->all(TransportMessageIdStamp::class);

$this->assertCount(1, $messageIdStamps);
}

public function testAll()
{
$serializer = $this->createSerializer();
Expand All @@ -115,6 +134,24 @@ public function testAll()
$this->assertEquals(new DummyMessage('Hi'), $actualEnvelopes[0]->getMessage());
}

public function testAllReplacesExistingTransportMessageIdStamps()
{
$serializer = $this->createSerializer();

$doctrineEnvelope1 = $this->createRetriedDoctrineEnvelope();
$doctrineEnvelope2 = $this->createRetriedDoctrineEnvelope();
$connection = $this->createMock(Connection::class);
$connection->method('findAll')->willReturn([$doctrineEnvelope1, $doctrineEnvelope2]);

$receiver = new DoctrineReceiver($connection, $serializer);
$actualEnvelopes = $receiver->all();
foreach ($actualEnvelopes as $actualEnvelope) {
$messageIdStamps = $actualEnvelope->all(TransportMessageIdStamp::class);

$this->assertCount(1, $messageIdStamps);
}
}

public function testFind()
{
$serializer = $this->createSerializer();
Expand All @@ -128,6 +165,21 @@ public function testFind()
$this->assertEquals(new DummyMessage('Hi'), $actualEnvelope->getMessage());
}

public function testFindReplacesExistingTransportMessageIdStamps()
{
$serializer = $this->createSerializer();

$doctrineEnvelope = $this->createRetriedDoctrineEnvelope();
$connection = $this->createMock(Connection::class);
$connection->method('find')->with(3)->willReturn($doctrineEnvelope);

$receiver = new DoctrineReceiver($connection, $serializer);
$actualEnvelope = $receiver->find(3);
$messageIdStamps = $actualEnvelope->all(TransportMessageIdStamp::class);

$this->assertCount(1, $messageIdStamps);
}

public function testAck()
{
$serializer = $this->createSerializer();
Expand Down Expand Up @@ -195,7 +247,7 @@ public function testAckThrowsRetryableExceptionAndRetriesFail()
->with('1')
->willThrowException($deadlockException);

self::expectException(TransportException::class);
$this->expectException(TransportException::class);
$receiver->ack($envelope);
}

Expand All @@ -215,7 +267,7 @@ public function testAckThrowsException()
->with('1')
->willThrowException($exception);

self::expectException($exception::class);
$this->expectException($exception::class);
$receiver->ack($envelope);
}

Expand Down Expand Up @@ -286,7 +338,7 @@ public function testRejectThrowsRetryableExceptionAndRetriesFail()
->with('1')
->willThrowException($deadlockException);

self::expectException(TransportException::class);
$this->expectException(TransportException::class);
$receiver->reject($envelope);
}

Expand All @@ -306,7 +358,7 @@ public function testRejectThrowsException()
->with('1')
->willThrowException($exception);

self::expectException($exception::class);
$this->expectException($exception::class);
$receiver->reject($envelope);
}

Expand All @@ -321,12 +373,27 @@ private function createDoctrineEnvelope(): array
];
}

private function createRetriedDoctrineEnvelope(): array
{
return [
'id' => 3,
'body' => '{"message": "Hi"}',
'headers' => [
'type' => DummyMessage::class,
'X-Message-Stamp-Symfony\Component\Messenger\Stamp\BusNameStamp' => '[{"busName":"messenger.bus.default"}]',
'X-Message-Stamp-Symfony\Component\Messenger\Stamp\TransportMessageIdStamp' => '[{"id":1},{"id":2}]',
'X-Message-Stamp-Symfony\Component\Messenger\Stamp\ErrorDetailsStamp' => '[{"exceptionClass":"Symfony\\\\Component\\\\Messenger\\\\Exception\\\\RecoverableMessageHandlingException","exceptionCode":0,"exceptionMessage":"","flattenException":null}]',
'X-Message-Stamp-Symfony\Component\Messenger\Stamp\DelayStamp' => '[{"delay":1000},{"delay":1000}]',
'X-Message-Stamp-Symfony\Component\Messenger\Stamp\RedeliveryStamp' => '[{"retryCount":1,"redeliveredAt":"2025-01-05T13:58:25+00:00"},{"retryCount":2,"redeliveredAt":"2025-01-05T13:59:26+00:00"}]',
'Content-Type' => 'application/json',
],
];
}

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

return $serializer;
}
}
10 changes: 6 additions & 4 deletions src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/DoctrineReceiver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,12 @@ private function createEnvelopeFromData(array $data): Envelope
throw $exception;
}

return $envelope->with(
new DoctrineReceivedStamp($data['id']),
new TransportMessageIdStamp($data['id'])
);
return $envelope
->withoutAll(TransportMessageIdStamp::class)
->with(
new DoctrineReceivedStamp($data['id']),
new TransportMessageIdStamp($data['id'])
);
}

private function withRetryableExceptionRetry(callable $callable): void
Expand Down
0