From bc1f298f063a1c83cea2ad28339d0724632b8e17 Mon Sep 17 00:00:00 2001 From: Jonas Ha Date: Fri, 28 Nov 2025 18:52:01 -0500 Subject: [PATCH 1/3] docs(Envelopes): fix formatting issues in README key benefits section - Removed extraneous control characters causing display issues in the list. - Ensured consistent formatting for bullet points and descriptions. --- src/Envelopes/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Envelopes/README.md b/src/Envelopes/README.md index 38e40d4e..874a786e 100644 --- a/src/Envelopes/README.md +++ b/src/Envelopes/README.md @@ -12,11 +12,11 @@ IDE support and compile-time type checking. **Key benefits:** -- **Type Safety**  Generic type parameter `` ensures compile-time type checking for payloads -- **Extensibility**  Abstract base classes allow custom serialization formats (JSON, XML, etc.) -- **Zero Overhead**  Envelopes extend official AWS event types, adding no runtime cost -- **AOT Ready**  Support for Native AOT compilation via JsonSerializerContext registration -- **Familiar API**  Works seamlessly with existing AWS Lambda event patterns +- **Type Safety** Generic type parameter `` ensures compile-time type checking for payloads +- **Extensibility** Abstract base classes allow custom serialization formats (JSON, XML, etc.) +- **Zero Overhead** Envelopes extend official AWS event types, adding no runtime cost +- **AOT Ready** Support for Native AOT compilation via JsonSerializerContext registration +- **Familiar API** Works seamlessly with existing AWS Lambda event patterns ## Packages From eea0027f479354f5a0a1b465c77c113703f73515 Mon Sep 17 00:00:00 2001 From: Jonas Ha Date: Fri, 28 Nov 2025 18:52:54 -0500 Subject: [PATCH 2/3] refactor(examples): unify profile names in launchSettings.json files - Replaced specific profile names with "Local" for consistency. - Updated launchSettings.json in all example projects. --- .../Properties/launchSettings.json | 2 +- .../Properties/launchSettings.json | 2 +- .../Properties/launchSettings.json | 2 +- .../Properties/launchSettings.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/AwsLambda.Host.Example.Events/Properties/launchSettings.json b/examples/AwsLambda.Host.Example.Events/Properties/launchSettings.json index 270e34f4..6b37dc1a 100644 --- a/examples/AwsLambda.Host.Example.Events/Properties/launchSettings.json +++ b/examples/AwsLambda.Host.Example.Events/Properties/launchSettings.json @@ -1,7 +1,7 @@ { "$schema": "http://json.schemastore.org/launchsettings.json", "profiles": { - "Lambda.Host.Example.Events": { + "Local": { "commandName": "Project", "environmentVariables": { "AWS_LAMBDA_RUNTIME_API": "localhost:5050", diff --git a/examples/AwsLambda.Host.Example.HelloWorldAot/Properties/launchSettings.json b/examples/AwsLambda.Host.Example.HelloWorldAot/Properties/launchSettings.json index 64c9f321..6b37dc1a 100644 --- a/examples/AwsLambda.Host.Example.HelloWorldAot/Properties/launchSettings.json +++ b/examples/AwsLambda.Host.Example.HelloWorldAot/Properties/launchSettings.json @@ -1,7 +1,7 @@ { "$schema": "http://json.schemastore.org/launchsettings.json", "profiles": { - "Lambda.Host.Example.HelloWorldAot": { + "Local": { "commandName": "Project", "environmentVariables": { "AWS_LAMBDA_RUNTIME_API": "localhost:5050", diff --git a/examples/AwsLambda.Host.Example.Lifecycle/Properties/launchSettings.json b/examples/AwsLambda.Host.Example.Lifecycle/Properties/launchSettings.json index ffda578f..6b37dc1a 100644 --- a/examples/AwsLambda.Host.Example.Lifecycle/Properties/launchSettings.json +++ b/examples/AwsLambda.Host.Example.Lifecycle/Properties/launchSettings.json @@ -1,7 +1,7 @@ { "$schema": "http://json.schemastore.org/launchsettings.json", "profiles": { - "Lambda.Host.Example.Lifecycle": { + "Local": { "commandName": "Project", "environmentVariables": { "AWS_LAMBDA_RUNTIME_API": "localhost:5050", diff --git a/examples/AwsLambda.Host.Example.OpenTelemetry/Properties/launchSettings.json b/examples/AwsLambda.Host.Example.OpenTelemetry/Properties/launchSettings.json index 68c27704..075e2dbb 100644 --- a/examples/AwsLambda.Host.Example.OpenTelemetry/Properties/launchSettings.json +++ b/examples/AwsLambda.Host.Example.OpenTelemetry/Properties/launchSettings.json @@ -1,7 +1,7 @@ { "$schema": "http://json.schemastore.org/launchsettings.json", "profiles": { - "Lambda.Host.Example.OpenTelemetry": { + "Local": { "commandName": "Project", "environmentVariables": { "AWS_LAMBDA_RUNTIME_API": "localhost:5050", From b2c0da87f58dcab5e3c10e38302e0413fa456f70 Mon Sep 17 00:00:00 2001 From: Jonas Ha Date: Fri, 28 Nov 2025 18:54:46 -0500 Subject: [PATCH 3/3] docs(envelopes): fix formatting issues in comments and documentation - Resolved line break inconsistencies in XML documentation comments across multiple classes. - Removed an unnecessary blank line in the SNS envelope README. - Standardized summary formatting in nested AWS logs envelope properties. --- .../MiddlewareOpenTelemetryExtensions.cs | 4 ++-- .../CloudWatchLogsEnvelope.cs | 11 ++++++----- .../CloudWatchLogsEnvelopeBase.cs | 16 ++++++---------- .../AwsLambda.Host.Envelopes.Sns/README.md | 1 - 4 files changed, 14 insertions(+), 18 deletions(-) diff --git a/src/AwsLambda.Host.OpenTelemetry/MiddlewareOpenTelemetryExtensions.cs b/src/AwsLambda.Host.OpenTelemetry/MiddlewareOpenTelemetryExtensions.cs index 9d1ded2e..fa81f8f4 100644 --- a/src/AwsLambda.Host.OpenTelemetry/MiddlewareOpenTelemetryExtensions.cs +++ b/src/AwsLambda.Host.OpenTelemetry/MiddlewareOpenTelemetryExtensions.cs @@ -31,8 +31,8 @@ public static class MiddlewareOpenTelemetryExtensions /// /// /// - /// Wraps the handler pipeline with tracing middleware that creates a - /// root span with invocation info. + /// Wraps the handler pipeline with tracing middleware that creates a root + /// span with invocation info. /// /// /// diff --git a/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelope.cs b/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelope.cs index 99629432..c08de574 100644 --- a/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelope.cs +++ b/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelope.cs @@ -7,17 +7,18 @@ namespace AwsLambda.Host.Envelopes.CloudWatchLogs; /// deserialization. /// /// -/// Use this envelope when working with string-based log messages. For structured log data that -/// needs to be deserialized into typed objects, use +/// Use this envelope when working with string-based log messages. For structured log data +/// that needs to be deserialized into typed objects, use /// instead. /// public sealed class CloudWatchLogsEnvelope : CloudWatchLogsEnvelopeBase { /// /// - /// Sets each log event's - /// to the raw string without - /// performing any deserialization. + /// Sets each log event's + /// to the raw string + /// without performing any + /// deserialization. /// public override void ExtractPayload(EnvelopeOptions options) { diff --git a/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelopeBase.cs b/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelopeBase.cs index 4570638d..3627ff18 100644 --- a/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelopeBase.cs +++ b/src/Envelopes/AwsLambda.Host.Envelopes.CloudWatchLogs/CloudWatchLogsEnvelopeBase.cs @@ -7,10 +7,10 @@ namespace AwsLambda.Host.Envelopes.CloudWatchLogs; /// /// -/// This abstract class extends and provides a foundation for -/// strongly typed CloudWatch Logs handling. Derived classes implement -/// to deserialize the CloudWatch Logs data into strongly typed -/// records using their chosen deserialization strategy. +/// This abstract class extends and provides a foundation +/// for strongly typed CloudWatch Logs handling. Derived classes implement +/// to deserialize the CloudWatch Logs data into strongly typed +/// records using their chosen deserialization strategy. /// public abstract class CloudWatchLogsEnvelopeBase : CloudWatchLogsEvent, IRequestEnvelope { @@ -35,9 +35,7 @@ public virtual void ExtractPayload(EnvelopeOptions options) /// public class AwsLogsEnvelope { - /// - /// Gets or sets the array of log events included in the message. - /// + /// Gets or sets the array of log events included in the message. [JsonPropertyName("logEvents")] public required LogEventEnvelope[] LogEvents { get; set; } @@ -49,9 +47,7 @@ public class AwsLogsEnvelope [JsonPropertyName("logStream")] public required string LogStream { get; set; } - /// - /// Gets or sets the type of CloudWatch Logs message. - /// + /// Gets or sets the type of CloudWatch Logs message. [JsonPropertyName("messageType")] public required string MessageType { get; set; } diff --git a/src/Envelopes/AwsLambda.Host.Envelopes.Sns/README.md b/src/Envelopes/AwsLambda.Host.Envelopes.Sns/README.md index 6719aabf..88ed76e5 100644 --- a/src/Envelopes/AwsLambda.Host.Envelopes.Sns/README.md +++ b/src/Envelopes/AwsLambda.Host.Envelopes.Sns/README.md @@ -71,7 +71,6 @@ public sealed class SnsXmlEnvelope : SnsEnvelopeBase 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