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.

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

base64 encode SNS Header message attribure #1308

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion pkg/sns/SnsProducer.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public function send(Destination $destination, Message $message): void
'MessageAttributes' => [
'Headers' => [
'DataType' => 'String',
'StringValue' => json_encode([$message->getHeaders(), $message->getProperties()]),
'StringValue' => base64_encode(json_encode([$message->getHeaders(), $message->getProperties()])),
Copy link

@rolandsusans rolandsusans Jul 13, 2023

Choose a reason for hiding this comment

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

Maybe we can leave this without encoding base64 for now (keep changes not breaking).
In the next major release, we can add base64_encode part. 🤔

],
],
'TopicArn' => $topicArn,
Expand Down
4 changes: 2 additions & 2 deletions pkg/sns/Tests/SnsProducerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ public function testShouldPublish()
'MessageAttributes' => [
'Headers' => [
'DataType' => 'String',
'StringValue' => '[{"hkey":"hvaleu"},{"key":"value"}]',
'StringValue' => base64_encode('[{"hkey":"hvaleu"},{"key":"value"}]'),
],
],
'TopicArn' => 'theTopicArn',
Expand Down Expand Up @@ -189,7 +189,7 @@ public function testShouldPublishWithMergedAttributes()
'MessageAttributes' => [
'Headers' => [
'DataType' => 'String',
'StringValue' => '[[],[]]',
'StringValue' => base64_encode('[[],[]]'),
],
'Foo' => [
'DataType' => 'String',
Expand Down
6 changes: 5 additions & 1 deletion pkg/snsqs/SnsQsConsumer.php
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,11 @@ private function convertMessage(SqsMessage $sqsMessage): SnsQsMessage
}

if (isset($data['MessageAttributes']['Headers'])) {
$headersData = json_decode($data['MessageAttributes']['Headers']['Value'], true);
$rawHeaderData = $data['MessageAttributes']['Headers']['Value'];
if (isset($rawHeaderData[0]) && '[' !== $rawHeaderData[0]) {
$rawHeaderData = base64_decode($rawHeaderData);
}
$headersData = json_decode($rawHeaderData, true);

$message->setHeaders($headersData[0]);
$message->setProperties($headersData[1]);
Expand Down
31 changes: 31 additions & 0 deletions pkg/snsqs/Tests/SnsQsConsumerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,37 @@
final class SnsQsConsumerTest extends TestCase
{
public function testReceivesSnsMessage(): void
{
$context = $this->createMock(SnsQsContext::class);
$context->expects($this->once())
->method('createMessage')
->willReturn(new SnsQsMessage());

$sqsConsumer = $this->createMock(SqsConsumer::class);
$sqsConsumer->expects($this->once())
->method('receive')
->willReturn(new SqsMessage(json_encode([
'Type' => 'Notification',
'TopicArn' => 'arn:aws:sns:us-east-2:12345:topic-name',
'Message' => 'The Body',
'MessageAttributes' => [
'Headers' => [
'Type' => 'String',
'Value' => base64_encode('[{"headerKey":"headerVal"},{"propKey": "propVal"}]'),
],
],
])));

$consumer = new SnsQsConsumer($context, $sqsConsumer, new SnsQsQueue('queue'));
$result = $consumer->receive();

$this->assertInstanceOf(SnsQsMessage::class, $result);
$this->assertSame('The Body', $result->getBody());
$this->assertSame(['headerKey' => 'headerVal'], $result->getHeaders());
$this->assertSame(['propKey' => 'propVal'], $result->getProperties());
}

public function testReceivesSnsMessageWithUnencodedHeaders(): void
{
$context = $this->createMock(SnsQsContext::class);
$context->expects($this->once())
Expand Down