minor #53524 [Messenger] [AmazonSqs] Allow async-aws/sqs version 2 (smoench)

nicolas-grekas · nicolas-grekas · commit 09cc9c7ca77f · 2024-01-23T14:37:48.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [Messenger] [AmazonSqs] Allow `async-aws/sqs` version 2 | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no  | Deprecations? | no  | Issues | - | License | MIT With this PR async-aws/sqs version 2 would be allowed to be installed. [With version 2 they are using the AWS JSON-1.0 protocol instead of the XML one](https://github.com/async-aws/sqs/blob/master/CHANGELOG.md#200). They declared this as a BC-Break as they switced the protocol from query to json, but no public method signatures have been changed. TODO - [x] Provide JSON stubs for tests Commits ------- 96f103a [Messenger][AmazonSqs] Allow async-aws/sqs version 2
diff --git a/.github/workflows/integration-tests.yml b/.github/workflows/integration-tests.yml
@@ -95,9 +95,9 @@ jobs:
           - 8094:8094
           - 11210:11210
       sqs:
-        image: asyncaws/testing-sqs
+        image: localstack/localstack:3.0.2
         ports:
-          - 9494:9494
+          - 4566:4566
       zookeeper:
         image: wurstmeister/zookeeper:3.4.6
       kafka:
@@ -184,8 +184,8 @@ jobs:
           REDIS_SENTINEL_SERVICE: redis_sentinel
           MESSENGER_REDIS_DSN: redis://127.0.0.1:7006/messages
           MESSENGER_AMQP_DSN: amqp://localhost/%2f/messages
-          MESSENGER_SQS_DSN: "sqs://localhost:9494/messages?sslmode=disable&poll_timeout=0.01"
-          MESSENGER_SQS_FIFO_QUEUE_DSN: "sqs://localhost:9494/messages.fifo?sslmode=disable&poll_timeout=0.01"
+          MESSENGER_SQS_DSN: "sqs://localhost:4566/messages?sslmode=disable&poll_timeout=0.01"
+          MESSENGER_SQS_FIFO_QUEUE_DSN: "sqs://localhost:4566/messages.fifo?sslmode=disable&poll_timeout=0.01"
           KAFKA_BROKER: 127.0.0.1:9092
           POSTGRES_HOST: localhost
 
diff --git a/composer.json b/composer.json
@@ -121,7 +121,7 @@
         "amphp/http-client": "^4.2.1",
         "amphp/http-tunnel": "^1.0",
         "async-aws/ses": "^1.0",
-        "async-aws/sqs": "^1.0",
+        "async-aws/sqs": "^1.0|^2.0",
         "async-aws/sns": "^1.0",
         "cache/integration-tests": "dev-master",
         "doctrine/annotations": "^1.13.1|^2",
diff --git a/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Tests/Transport/ConnectionTest.php b/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Tests/Transport/ConnectionTest.php
@@ -17,6 +17,7 @@
 use AsyncAws\Sqs\Result\ReceiveMessageResult;
 use AsyncAws\Sqs\SqsClient;
 use AsyncAws\Sqs\ValueObject\Message;
+use Composer\InstalledVersions;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\NullLogger;
 use Symfony\Component\HttpClient\MockHttpClient;
@@ -342,6 +343,16 @@ public function testLoggerWithDebugOption()
 
     private function getMockedQueueUrlResponse(): MockResponse
     {
+        if ($this->isAsyncAwsSqsVersion2Installed()) {
+            return new MockResponse(
+                <<<JSON
+{
+    "QueueUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue"
+}
+JSON
+            );
+        }
+
         return new MockResponse(<<<XML
 <GetQueueUrlResponse>
     <GetQueueUrlResult>
@@ -357,6 +368,28 @@ private function getMockedQueueUrlResponse(): MockResponse
 
     private function getMockedReceiveMessageResponse(): MockResponse
     {
+        if ($this->isAsyncAwsSqsVersion2Installed()) {
+            return new MockResponse(<<<JSON
+{
+    "Messages": [
+        {
+            "Attributes": {
+                "SenderId": "195004372649",
+                "ApproximateFirstReceiveTimestamp": "1250700979248",
+                "ApproximateReceiveCount": "5",
+                "SentTimestamp": "1238099229000"
+            },
+            "Body": "This is a test message",
+            "MD5OfBody": "fafb00f5732ab283681e124bf8747ed1",
+            "MessageId": "5fea7756-0ea4-451a-a703-a558b933e274",
+            "ReceiptHandle": "MbZj6wDWli+JvwwJaBV+3dcjk2YW2vA3+STFFljTM8tJJg6HRG6PYSasuWXPJB+CwLj1FjgXUv1uSj1gUPAWV66FU/WeR4mq2OKpEGYWbnLmpRCJVAyeMjeU5ZBdtcQ+QEauMZc8ZRv37sIW2iJKq3M9MFx1YvV11A2x/KSbkJ0="
+        }
+    ]
+}
+JSON
+            );
+        }
+
         return new MockResponse(<<<XML
 <ReceiveMessageResponse>
   <ReceiveMessageResult>
@@ -394,4 +427,11 @@ private function getMockedReceiveMessageResponse(): MockResponse
 XML
         );
     }
+
+    private function isAsyncAwsSqsVersion2Installed(): bool
+    {
+        $version = InstalledVersions::getVersion('async-aws/sqs');
+
+        return 'dev-master' === $version || version_compare($version, '2.0.0') >= 0;
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Bridge/AmazonSqs/composer.json b/src/Symfony/Component/Messenger/Bridge/AmazonSqs/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": ">=7.2.5",
         "async-aws/core": "^1.5",
-        "async-aws/sqs": "^1.0",
+        "async-aws/sqs": "^1.0|^2.0",
         "symfony/messenger": "^4.3|^5.0|^6.0",
         "symfony/service-contracts": "^1.1|^2|^3",
         "psr/log": "^1|^2|^3"
