Bug: SQS MessageAttribute Schema invalid

[hrzbrg]

Expected Behavior

Using the SQS Envelope and my custom body schema, I expected to be able to parse SQS events generated by Symfony Messenger.

Current Behavior

Parsing fails, because binaryValue is null. The SQS SqsMsgAttributeSchema defines it as optional string, but not nullish.

Code snippet

        "messageAttributes": {
          "X-Symfony-Messenger": {
            "stringValue": "{\"X-Message-Stamp-Symfony\\\\Component\\\\Messenger\\\\Stamp\\\\BusNameStamp\":\"[{\\\"busName\\\":\\\"external.event.bus\\\"}]\"}",
            "binaryValue": null,
            "stringListValues": [],
            "binaryListValues": [],
            "dataType": "String"
          },
          "type": {
            "stringValue": "App\\Event\\ChangeLogEvent",
            "binaryValue": null,
            "stringListValues": [],
            "binaryListValues": [],
            "dataType": "String"
          },
          "Content-Type": {
            "stringValue": "application/json",
            "binaryValue": null,
            "stringListValues": [],
            "binaryListValues": [],
            "dataType": "String"
          }
        },

Steps to Reproduce

1. Use the Powertools Parser with envelope: SqsEnvelope to parse an SQS event with the above mentioned messageAttributes.

Possible Solution

BinaryValue could be set to be nullish: binaryValue: z.string().nullish()

Powertools for AWS Lambda (TypeScript) version

2.10

AWS Lambda function runtime

20.x

Packaging format used

npm

Execution logs

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

[am29d]

Hey @hrzbrg thanks for dropping the issue, I will take a look why we missed it in the tests. Feel free to open a PR, if you want.

[dreamorosi]

Hi, could you please share more info on the API call used to generate these SQS messages and how the event gets to the Lambda function?

I tried to send a message to SQS with attribute of type String, and the binary value field is undefined instead of null when I poll the queue:

{
    "Messages": [
        {
            "MessageId": "92f0ce33-f118-4a6a-8041-3f5016ab16e3",
            "ReceiptHandle": "AQEBsoWTnNZVxAUZOcJ....",
            "MD5OfBody": "5dea26020e811def89cbf972425f0e46",
            "Body": "two two",
            "MD5OfMessageAttributes": "2db1f7ff6cc285162639816522a868fb",
            "MessageAttributes": {
                "type": {
                    "StringValue": "application/json",
                    "DataType": "String"
                }
            }
        }
    ]
}