Skip to content
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

[EasyNotification] Update SqsQueueTransport.php to handle FIFO queues #1631

Merged
merged 3 commits into from
Jan 28, 2025
Merged

[EasyNotification] Update SqsQueueTransport.php to handle FIFO queues #1631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8885bc2
[EasyNotification] Update SqsQueueTransport.php to handle FIFO queues
mark-fajardo Jan 27, 2025
b72bfa2
[EasyNotification] Update SqsQueueTransport.php to handle FIFO queues…
mark-fajardo Jan 27, 2025
f28054f
[EasyNotification] Update SqsQueueTransport.php to handle FIFO queues…
mark-fajardo Jan 27, 2025
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
3 changes: 2 additions & 1 deletion packages/EasyNotification/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"aws/aws-sdk-php": "^3.134",
"eonx-com/easy-utils": "^4.6",
"nette/utils": "^3.1",
"symfony/http-client": "^5.4 || ^6.0"
"symfony/http-client": "^5.4 || ^6.0",
"symfony/uid": "^5.4 || ^6.0"
},
"require-dev": {
"phpunit/phpunit": "^9.5 || ^10.0",
Expand Down
12 changes: 11 additions & 1 deletion packages/EasyNotification/src/Queue/SqsQueueTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Aws\Sqs\SqsClient;
use EonX\EasyNotification\Interfaces\QueueMessageInterface;
use EonX\EasyNotification\Interfaces\QueueTransportInterface;
use Symfony\Component\Uid\Uuid;

final class SqsQueueTransport implements QueueTransportInterface
{
Expand All @@ -22,10 +23,19 @@ public function __construct(SqsClient $sqs)

public function send(QueueMessageInterface $queueMessage): void
{
$queueUrl = $queueMessage->getQueueUrl();

if (\str_ends_with($queueUrl, '.fifo')) {
$messageDeduplicationId = (string)Uuid::v4();
$messageGroupId = (string)Uuid::v4();
}
Comment on lines +28 to +31
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok not to complicate things in this package as we are the only ones to use it really, but we need to at least required the symfony/uid package in composer so we ensure the Uuid class is available 😄


$this->sqs->sendMessage([
'QueueUrl' => $queueMessage->getQueueUrl(),
'QueueUrl' => $queueUrl,
'MessageAttributes' => $this->formatHeaders($queueMessage->getHeaders()),
'MessageBody' => $queueMessage->getBody(),
'MessageDeduplicationId' => $messageDeduplicationId ?? null,
'MessageGroupId' => $messageGroupId ?? null,
]);
}

Expand Down
2 changes: 2 additions & 0 deletions packages/EasyNotification/tests/NotificationClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ public function testSend(): void
],
],
'MessageBody' => '{"body":"{\"name\":\"nathan\"}","topics":["topic"]}',
'MessageDeduplicationId' => null,
'MessageGroupId' => null,
];

self::assertEquals($expected, $sqsClientStub->getCalls()[0]);
Expand Down
17 changes: 17 additions & 0 deletions packages/EasyNotification/tests/Queue/SqsQueueTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,25 @@ public function testSend(): void
],
],
'MessageBody' => 'my-body',
'MessageDeduplicationId' => null,
'MessageGroupId' => null,
];

self::assertEquals($expected, $stub->getCalls()[0]);
}

public function testSendFifo(): void
{
$queueUrl = 'https://sqs.my-queue.fifo';
$stub = new SqsClientStub();
$queueMessage = (new QueueMessage())
->addHeader('my-header', 'my-value')
->setBody('my-body')
->setQueueUrl($queueUrl);

(new SqsQueueTransport($stub))->send($queueMessage);

self::assertNotNull($stub->getCalls()[0]['MessageDeduplicationId']);
self::assertNotNull($stub->getCalls()[0]['MessageGroupId']);
}
}
Loading