bug #37038 Fix invalid char in SQS Headers (jderusse)

fabpot · fabpot · commit 773b4ef3826b · 2020-06-03T10:07:24.000+02:00
This PR was squashed before being merged into the 5.1 branch. Discussion ---------- Fix invalid char in SQS Headers | Q | A | ------------- | --- | Branch? | 5.1 | Bug fix? | yes | New feature? | no | Deprecations? | yes | Tickets | #36525 (comment) | License | MIT | Doc PR | / From [Amazon documnetation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) header's name have constraints: - only `a-zA-Z0-9_\.-` + not start/end with a `.` - 256 char This PR serialize ALL headers in a single SQS Attribute. Commits ------- 76a18b0 Fix invalid char in SQS Headers
diff --git a/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Tests/Transport/AmazonSqsIntegrationTest.php b/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Tests/Transport/AmazonSqsIntegrationTest.php
@@ -45,7 +45,7 @@ private function execute(string $dsn): void
         $connection->setup();
         $this->clearSqs($dsn);
 
-        $connection->send('{"message": "Hi"}', ['type' => DummyMessage::class]);
+        $connection->send('{"message": "Hi"}', ['type' => DummyMessage::class, DummyMessage::class => 'special']);
         $this->assertSame(1, $connection->getMessageCount());
 
         $wait = 0;
@@ -54,7 +54,7 @@ private function execute(string $dsn): void
         }
 
         $this->assertEquals('{"message": "Hi"}', $encoded['body']);
-        $this->assertEquals(['type' => DummyMessage::class], $encoded['headers']);
+        $this->assertEquals(['type' => DummyMessage::class, DummyMessage::class => 'special'], $encoded['headers']);
     }
 
     private function clearSqs(string $dsn): void
diff --git a/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Transport/Connection.php b/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Transport/Connection.php
@@ -30,6 +30,7 @@
 class Connection
 {
     private const AWS_SQS_FIFO_SUFFIX = '.fifo';
+    private const MESSAGE_ATTRIBUTE_NAME = 'X-Symfony-Messenger';
 
     private const DEFAULT_OPTIONS = [
         'buffer_size' => 9,
@@ -200,7 +201,12 @@ private function fetchMessage(): bool
 
         foreach ($this->currentResponse->getMessages() as $message) {
             $headers = [];
-            foreach ($message->getMessageAttributes() as $name => $attribute) {
+            $attributes = $message->getMessageAttributes();
+            if (isset($attributes[self::MESSAGE_ATTRIBUTE_NAME]) && 'String' === $attributes[self::MESSAGE_ATTRIBUTE_NAME]->getDataType()) {
+                $headers = json_decode($attributes[self::MESSAGE_ATTRIBUTE_NAME]->getStringValue(), true);
+                unset($attributes[self::MESSAGE_ATTRIBUTE_NAME]);
+            }
+            foreach ($attributes as $name => $attribute) {
                 if ('String' !== $attribute->getDataType()) {
                     continue;
                 }
@@ -284,13 +290,29 @@ public function send(string $body, array $headers, int $delay = 0, ?string $mess
             'MessageAttributes' => [],
         ];
 
+        $specialHeaders = [];
         foreach ($headers as $name => $value) {
+            if ('.' === $name[0] || self::MESSAGE_ATTRIBUTE_NAME === $name || \strlen($name) > 256 || '.' === substr($name, -1) || 'AWS.' === substr($name, 0, \strlen('AWS.')) || 'Amazon.' === substr($name, 0, \strlen('Amazon.')) || preg_match('/([^a-zA-Z0-9_\.-]+|\.\.)/', $name)) {
+                $specialHeaders[$name] = $value;
+
+                continue;
+            }
+
             $parameters['MessageAttributes'][$name] = new MessageAttributeValue([
                 'DataType' => 'String',
                 'StringValue' => $value,
             ]);
         }
 
+        if (!empty($specialHeaders)) {
+            $parameters['MessageAttributes'][self::MESSAGE_ATTRIBUTE_NAME] = new MessageAttributeValue([
+                'DataType' => 'String',
+                'StringValue' => json_encode($specialHeaders),
+            ]);
+        }
+
+        dd($parameters);
+
         if (self::isFifoQueue($this->configuration['queue_name'])) {
             $parameters['MessageGroupId'] = null !== $messageGroupId ? $messageGroupId : __METHOD__;
             $parameters['MessageDeduplicationId'] = null !== $messageDeduplicationId ? $messageDeduplicationId : sha1(json_encode(['body' => $body, 'headers' => $headers]));

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ private function execute(string $dsn): void`
`45`	`45`	`$connection->setup();`
`46`	`46`	`$this->clearSqs($dsn);`
`47`	`47`
`48`		`- $connection->send('{"message": "Hi"}', ['type' => DummyMessage::class]);`
	`48`	`+ $connection->send('{"message": "Hi"}', ['type' => DummyMessage::class, DummyMessage::class => 'special']);`
`49`	`49`	`$this->assertSame(1, $connection->getMessageCount());`
`50`	`50`
`51`	`51`	`$wait = 0;`
`@@ -54,7 +54,7 @@ private function execute(string $dsn): void`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`$this->assertEquals('{"message": "Hi"}', $encoded['body']);`
`57`		`- $this->assertEquals(['type' => DummyMessage::class], $encoded['headers']);`
	`57`	`+ $this->assertEquals(['type' => DummyMessage::class, DummyMessage::class => 'special'], $encoded['headers']);`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`private function clearSqs(string $dsn): void`