SQSClient receiveMessage JSON Parse error

[xto]

Describe the bug

Calling receiveMessage on an instance of SqsClient throws an exception. We found this through a library upgrade triggered by Dependabot as it failed our CI. Here's the most minimal code to that triggers the exception.

    public function testJsonFailure(): void
    {
        $awsSdk = $this->client->getContainer()->get(AwsSdk::class);
        $sqsClient = $awsSdk->createSqS();
        $result = $sqsClient->receiveMessage(
            [
                'MaxNumberOfMessages' => 1,
                'QueueUrl' => "http://aws:4566/000000000000/internal_job_queue_dlq",
                'WaitTimeSeconds' => 0
            ]
        );
        $this->assertNull($result->get('Messages'));
    }

I did some digging and at https://github.com/aws/aws-sdk-php/blob/3.285.1/src/Api/Parser/PayloadParserTrait.php#L18, $json holds a GuzzleHttp\Psr7\Stream object and calling getContents on that object revealed that it does not contain a JSON string but rather an XML string. This is the result of dump($json->getContents()):

 "<ReceiveMessageResponse><ReceiveMessageResult></ReceiveMessageResult><ResponseMetadata><RequestId>4PDN22TK8BPVAKSD643TKWBWUD8BHMKZIF8VNGJ3JLXTCLH8811J</RequestId></ResponseMetadata></ReceiveMessageResponse>"

This issue was not present in 3.285.0

Expected Behavior

The expected behaviour is that the parser receives a JSON payload and parses it successfully

Current Behavior

An exception happens with the following message gets thrown:
Aws\Api\Parser\Exception\ParserException: Error parsing JSON: Syntax error

Reproduction Steps

<?php

namespace MyApp\IntegrationTest;

use Aws\Sdk;
use Symfony\Bundle\FrameworkBundle\KernelBrowser;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class InternalJobQueueTest extends WebTestCase
{
    protected KernelBrowser $client;

    /**
     * @test
     */
    public function testJsonFailure(): void
    {
        self::createKernel();
        $this->client = self::createClient();

        $awsSdk = $this->client->getContainer()->get(Sdk::class);
        $sqsClient = $awsSdk->createSqS();
        $result = $sqsClient->receiveMessage(
            [
                'MaxNumberOfMessages' => 1,
                'QueueUrl' => "http://aws:4566/000000000000/internal_job_queue_dlq",
                'WaitTimeSeconds' => 0
            ]
        );
        $this->assertNull($result->get('Messages'));
    }
}

Possible Solution

No response

Additional Information/Context

No response

SDK version used

3.285.1

Environment details (Version of PHP (php -v)? OS name and version, etc.)

PHP 8.2.4

[yenfryherrerafeliz]

Hi @xto, sorry to hear about your issues. I am not sure what could be causing this at your end. I just tried to reproduce this but I was not able to.
Here is the code I have used:

<?php

use Aws\Sqs\SqsClient;

require '../vendor/autoload.php';

$client = new SqsClient(['region' => 'us-east-2']);
$response = $client->receiveMessage([
    'QueueUrl' => 'test-queue',
    'MaxNumberOfMessages' => 1,
    'WaitTimeSeconds' => 0
]);

print_r($response);

Here is the response:

Response

Aws\Result Object
(
    [data:Aws\Result:private] => Array
        (
            [Messages] => Array
                (
                )

            [@metadata] => Array
                (
                    [statusCode] => 200
                    [effectiveUri] => https://sqs.us-east-2.amazonaws.com/test-queue
                    [headers] => Array
                        (
                            [x-amzn-requestid] => REQ-ID
                            [date] => Tue, 14 Nov 2023 17:32:57 GMT
                            [content-type] => application/x-amz-json-1.0
                            [content-length] => 15
                            [connection] => keep-alive
                        )

                    [transferStats] => Array
                        (
                            [http] => Array
                                (
                                    [0] => Array
                                        (
                                        )

                                )

                        )

                )

        )

    [monitoringEvents:Aws\Result:private] => Array
        (
        )

)

Could you please try to create new project from scratch and test it?, also, could you please make sure the SDK dependency is up to date?.

I look forward to your response.

Thanks!

[stobrien89]

@xto,

Also, could you could provide debug logs from the test by adding 'debug' => true to your client config? Please make sure to obscure any sensitive information.

[bentsku]

Hello, I believe this issue might be related to LocalStack, see localstack/localstack#8267

@xto this should now be fixed in the latest version of LocalStack, you can read about it in the linked issue.

[xto]

@bentsku thanks for the info. I'll report back on my issue after trying updating localstack.

[stobrien89]

@xto,

Sorry for the confusion. #2822 prompted an investigation on our side into how we were sending requests with QueueUrl. That issue has been fixed now and will be available in today's release. Localstack's changes should resolve the xml response issue, but you may need to update your code to expect an empty Messages in the response as opposed to null.

[ziyanli-amazon]

@xto @stobrien89 Thanks guys. SQS is also fixing the Messages being returned as null as opposed to an empty array if no messages exist.

[ziyanli-amazon]

@bentsku Thanks for fixing the LocalStack.

[xto]

I'm going to close this. Upgrading to the latest localstack version seems to have resolved the error. Thanks for the assist @bentsku @stobrien89 @yenfryherrerafeliz 🙇

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.