MinimalLambda.Envelopes.Sqs 2.0.0-beta.11

MinimalLambda.Envelopes.Sqs

Strongly-typed SQS event handling for the MinimalLambda framework.

Overview

This package provides SqsEnvelope<T>, which extends the base SQSEvent class with a generic Records collection that deserializes message bodies into strongly-typed objects. Instead of manually parsing JSON from record.Body, you access deserialized payloads directly via record.BodyContent. This package also provides SqsSnsEnvelope<T> for handling SNS messages delivered via SQS queues (SNS-to-SQS subscription pattern).

Quick Start

Define your message type and handler:

using Amazon.Lambda.SQSEvents;
using MinimalLambda.Builder;
using MinimalLambda.Envelopes.Sqs;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

var builder = LambdaApplication.CreateBuilder();
var lambda = builder.Build();

// SqsEnvelope<Message> provides access to the SQS event and deserialized Message payloads
lambda.MapHandler(
    ([FromEvent] SqsEnvelope<Message> envelope, ILogger<Program> logger) =>
    {
        // In order to handle any errors or unprocessed messages, you must return a SQSBatchResponse
        var batchResponse = new SQSBatchResponse();

        foreach (var record in envelope.Records)
        {
            // For this example, we'll add a failure to the batch response if the message body is null
            if (record.BodyContent is null)
                batchResponse.BatchItemFailures.Add(
                    new SQSBatchResponse.BatchItemFailure { ItemIdentifier = record.MessageId }
                );

            logger.LogInformation("Message: {Name}", record.BodyContent?.Name);
        }

        // Return the batch response regardless of whether there were any failures
        return batchResponse;
    }
);

await lambda.RunAsync();

// Your message payload - will be deserialized from SQS message body
internal record Message(string Name);

Custom Envelopes

To implement custom deserialization logic, extend SqsEnvelopeBase<T> and override the ExtractPayload method:

// Example: Custom XML deserialization
public sealed class SqsXmlEnvelope<T> : SqsEnvelopeBase<T>
{
    private static readonly XmlSerializer Serializer = new(typeof(T));

    public override void ExtractPayload(EnvelopeOptions options)
    {
        foreach (var record in Records)
        {
            using var stringReader = new StringReader(record.Body);
            using var xmlReader = XmlReader.Create(stringReader, options.XmlReaderSettings);
            record.BodyContent = (T)Serializer.Deserialize(xmlReader)!;
        }
    }
}

This pattern allows you to support multiple serialization formats while maintaining the same envelope interface.

AOT Support

When using .NET Native AOT, register both the envelope and payload types in your JsonSerializerContext:

[JsonSerializable(typeof(SqsEnvelope<Message>))]
[JsonSerializable(typeof(Message))]
internal partial class SerializerContext : JsonSerializerContext;

Register the serializer and configure envelope options to use the context:

builder.Services.AddLambdaSerializerWithContext<SerializerContext>();

builder.Services.ConfigureEnvelopeOptions(options =>
{
    options.JsonOptions.TypeInfoResolver = SerializerContext.Default;
});

SqsSnsEnvelope - SNS-to-SQS Subscription Pattern

This package also provides SqsSnsEnvelope<T> for handling SNS messages delivered via SQS queues (SNS-to-SQS subscription pattern). Unlike SqsEnvelope<T> which performs single-stage deserialization, SqsSnsEnvelope<T> performs two-stage deserialization:

1. The SQS message body is deserialized into an SNS message envelope
2. The SNS message content is then deserialized into your payload type

This envelope is useful when you have an SNS topic that delivers messages to an SQS queue, and your Lambda function processes messages from that queue.

[JsonSerializable(typeof(SqsSnsEnvelope<Request>))]
[JsonSerializable(typeof(SnsEnvelope<Request>.SnsMessageEnvelope))]
[JsonSerializable(typeof(SNSEvent.MessageAttribute), TypeInfoPropertyName = "SnsMessageAttribute")]
[JsonSerializable(typeof(SQSEvent.MessageAttribute), TypeInfoPropertyName = "SqsMessageAttribute")]
[JsonSerializable(typeof(Request))]
internal partial class SerializerContext : JsonSerializerContext;

Other Packages

Additional packages in the minimal-lambda framework for abstractions, observability, and event source handling.

Package	NuGet	Downloads
MinimalLambda
MinimalLambda.Abstractions
MinimalLambda.OpenTelemetry
MinimalLambda.Envelopes
MinimalLambda.Envelopes.Sqs
MinimalLambda.Envelopes.ApiGateway
MinimalLambda.Envelopes.Sns
MinimalLambda.Envelopes.Kinesis
MinimalLambda.Envelopes.KinesisFirehose
MinimalLambda.Envelopes.Kafka
MinimalLambda.Envelopes.CloudWatchLogs
MinimalLambda.Envelopes.Alb

License

This project is licensed under the MIT License. See LICENSE for details.