Merge branch 'develop' into update-changelog-5462167625

Author: hjgraca

.github/boring-cyborg.yml

@@ -15,9 +15,12 @@ labelPRBasedOnFilePath:
   area/parameters:
     - libraries/src/AWS.Lambda.Powertools.Parameters/*
     - libraries/src/AWS.Lambda.Powertools.Parameters/**/*
-  area/Idempotency:
+  area/idempotency:
     - libraries/src/AWS.Lambda.Powertools.Idempotency/*
     - libraries/src/AWS.Lambda.Powertools.Idempotency/**/*
+  area/batch:
+    - libraries/src/AWS.Lambda.Powertools.Batch/*
+    - libraries/src/AWS.Lambda.Powertools.Batch/**/*
 
   documentation:
     - docs/*
@@ -62,7 +65,7 @@ labelPRBasedOnFilePath:
 firstPRWelcomeComment: >
   Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
 
-  In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)
+  In the meantime, check out the #dotnet channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)
 
 # Comment to be posted to congratulate user on their first merged PR
 firstPRMergeComment: >
@@ -72,4 +75,4 @@ firstPRMergeComment: >
 firstIssueWelcomeComment: >
   Thanks for opening your first issue here! We'll come back to you as soon as we can.
 
-  In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)
+  In the meantime, check out the #dotnet channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)

docs/core/tracing.md

@@ -26,6 +26,8 @@ Powertools for AWS Lambda (.NET) are available as NuGet packages. You can instal
 
 ## Getting Started
 
+!!! note "Tracer relies on AWS X-Ray SDK over [OpenTelememetry Distro (ADOT)](https://aws-otel.github.io/docs/getting-started/lambda){target="_blank"} for optimal cold start (lower latency)."
+
 Before you use this utility, your AWS Lambda function [must have permissions](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html#services-xray-permissions) to send traces to AWS X-Ray.
 
 To enable active tracing on an AWS Serverless Application Model (AWS SAM) AWS::Serverless::Function resource, use the `Tracing` property. You can use the Globals section of the AWS SAM template to set this for all  

docs/utilities/idempotency.md

@@ -122,6 +122,38 @@ You can quickly start by configuring `Idempotency` and using it with the `Idempo
     }
     ```
 
+#### Idempotent attribute on another method
+
+You can use the `Idempotent` attribute for any .NET function, not only the Lambda handlers.
+
+When using `Idempotent` attribute on another method, you must tell which parameter in the method signature has the data we should use:
+
+ - If the method only has one parameter, it will be used by default. 
+ - If there are 2 or more parameters, you must set the `IdempotencyKey` attribute on the parameter to use.
+
+!!! info "The parameter must be serializable in JSON. We use `System.Text.Json` internally to (de)serialize objects"
+
+    ```csharp
+    public class Function
+    {
+        public Function()
+        {
+            Idempotency.Configure(builder => builder.UseDynamoDb("idempotency_table"));
+        }
+        
+        public Task<string> FunctionHandler(string input, ILambdaContext context)
+        {
+            dummpy("hello", "world")
+            return Task.FromResult(input.ToUpper());
+        }
+
+        [Idempotent]
+        private string dummy(string argOne, [IdempotencyKey] string argTwo) {
+            return "something";
+        }
+    }
+    ```
+
 ### Choosing a payload subset for idempotency
 
 !!! tip "Tip: Dealing with always changing payloads"

examples/Idempotency/src/HelloWorld/Function.cs

@@ -15,16 +15,13 @@
 
 using System;
 using System.Collections.Generic;
-using System.Net.Http;
 using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 using Amazon.DynamoDBv2;
 using Amazon.Lambda.APIGatewayEvents;
 using Amazon.Lambda.Core;
 using Amazon.Lambda.Serialization.SystemTextJson;
 using AWS.Lambda.Powertools.Idempotency;
-using AWS.Lambda.Powertools.Idempotency.Persistence;
 using AWS.Lambda.Powertools.Logging;
 
 // Assembly attribute to enable the Lambda function's JSON input to be converted into a .NET class.
@@ -34,34 +31,30 @@ namespace HelloWorld;
 
 public class Function
 {
-    private static HttpClient? _httpClient;
     private static AmazonDynamoDBClient? _dynamoDbClient;
 
     /// <summary>
     /// Function constructor
     /// </summary>
     public Function()
     {
-        _httpClient = new HttpClient();
         _dynamoDbClient = new AmazonDynamoDBClient();
 
-        Init(_dynamoDbClient, _httpClient);
+        Init(_dynamoDbClient);
     }
 
     /// <summary>
     /// Test constructor
     /// </summary>
-    public Function(AmazonDynamoDBClient amazonDynamoDb, HttpClient httpClient)
+    public Function(AmazonDynamoDBClient amazonDynamoDb)
     {
-        _httpClient = httpClient;
         _dynamoDbClient = amazonDynamoDb;
-        Init(amazonDynamoDb, httpClient);
+        Init(amazonDynamoDb);
     }
-    
-    private void Init(AmazonDynamoDBClient amazonDynamoDb, HttpClient httpClient)
+
+    private void Init(AmazonDynamoDBClient amazonDynamoDb)
     {
         ArgumentNullException.ThrowIfNull(amazonDynamoDb);
-        ArgumentNullException.ThrowIfNull(httpClient);
         var tableName = Environment.GetEnvironmentVariable("TABLE_NAME");
         ArgumentNullException.ThrowIfNull(tableName);
 
@@ -92,29 +85,13 @@ private void Init(AmazonDynamoDBClient amazonDynamoDb, HttpClient httpClient)
     [Logging(LogEvent = true)]
     public async Task<APIGatewayProxyResponse> FunctionHandler(APIGatewayProxyRequest apigwProxyEvent, ILambdaContext context)
     {
-        var serializationOptions = new JsonSerializerOptions
-        {
-            PropertyNameCaseInsensitive = true
-        };
-        var request = JsonSerializer.Deserialize<LookupRequest>(apigwProxyEvent.Body, serializationOptions);
-        if (request is null)
-        {
-            return new APIGatewayProxyResponse
-            {
-                Body = "Invalid request",
-                StatusCode = 403,
-                Headers = new Dictionary<string, string> { { "Content-Type", "application/json" } }
-            };
-        }
-
-        var location = await GetCallingIp(request.Address);
-
         var requestContextRequestId = apigwProxyEvent.RequestContext.RequestId;
         var response = new
         {
             RequestId = requestContextRequestId,
             Greeting = "Hello Powertools for AWS Lambda (.NET)",
-            IpAddress = location  
+            MethodGuid = GenerateGuid(), // Guid generated by the GenerateGuid method. used to compare Method output
+            HandlerGuid = Guid.NewGuid().ToString() // Guid generated in the Handler. used to compare Handler output
         };
 
         try
@@ -138,33 +115,11 @@ public async Task<APIGatewayProxyResponse> FunctionHandler(APIGatewayProxyReques
     }
 
     /// <summary>
-    /// Calls location api to return IP address
+    /// Generates a new Guid to check if value is the same between calls (should be when idempotency enabled)
     /// </summary>
-    /// <param name="address">Uri of the service providing the calling IP</param>
-    /// <returns>IP address string</returns>
-    private static async Task<string?> GetCallingIp(string address)
-    {
-        if (_httpClient == null) return "0.0.0.0";
-        _httpClient.DefaultRequestHeaders.Accept.Clear();
-        _httpClient.DefaultRequestHeaders.Add("User-Agent", "AWS Lambda .Net Client");
-
-        var response = await _httpClient.GetStringAsync(address).ConfigureAwait(false);
-        var ip = response.Replace("\n", "");
-
-        return ip;
-    }
-}
-
-/// <summary>
-/// Record to represent the data structure of Lookup request
-/// </summary>
-[Serializable]
-public class LookupRequest
-{
-    public string Address { get; private set; }
-
-    public LookupRequest(string address)
+    /// <returns>GUID</returns>
+    private static string GenerateGuid()
     {
-        Address = address;
+        return Guid.NewGuid().ToString();
     }
 }

examples/Idempotency/src/HelloWorld/HelloWorld.csproj

@@ -6,10 +6,10 @@
     </PropertyGroup>
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.1.0" />
-        <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.5.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.3.0" />
+        <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.6.0" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.3.1" />
         <PackageReference Include="AWS.Lambda.Powertools.Idempotency" Version="0.0.1-preview" />
         <PackageReference Include="AWS.Lambda.Powertools.Logging" Version="1.1.1" />
-        <PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.103.7" />
+        <PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.105.1" />
     </ItemGroup>
 </Project>

examples/Idempotency/test/HelloWorld.Test/FunctionTest.cs

@@ -53,28 +53,14 @@ public async Task TestHelloWorldFunctionHandler()
             // arrange
             var requestId = Guid.NewGuid().ToString("D");
             var accountId = Guid.NewGuid().ToString("D");
-            var location = "192.158.1.38";
+
             Environment.SetEnvironmentVariable("POWERTOOLS_SERVICE_NAME","powertools-dotnet-idempotency-sample");
             Environment.SetEnvironmentVariable("POWERTOOLS_LOG_LEVEL","INFO");
             Environment.SetEnvironmentVariable("TABLE_NAME",_tableName);
 
-            var handlerMock = new Mock<HttpMessageHandler>();
-            handlerMock
-                .Protected()
-                .Setup<Task<HttpResponseMessage>>(
-                    "SendAsync",
-                    ItExpr.IsAny<HttpRequestMessage>(),
-                    ItExpr.IsAny<CancellationToken>()
-                )
-                .ReturnsAsync(new HttpResponseMessage
-                {
-                    StatusCode = HttpStatusCode.OK,
-                    Content = new StringContent(location)
-                });
-            
             var request = new APIGatewayProxyRequest
             {
-                Body = "{\"address\": \"https://checkip.amazonaws.com\"}",
+                Body = "{\"address\": \"Hello World\"}",
                 RequestContext = new APIGatewayProxyRequest.ProxyRequestContext
                 {
                     RequestId = requestId,
@@ -89,25 +75,11 @@ public async Task TestHelloWorldFunctionHandler()
                 MemoryLimitInMB = 215,
                 AwsRequestId = Guid.NewGuid().ToString("D")
             };
-            
-            var body = new Dictionary<string, string>
-            {
-                { "RequestId", requestId },
-                { "Greeting", "Hello Powertools for AWS Lambda (.NET)" },
-                { "IpAddress", location },
-            };
 
-            var expectedResponse = new APIGatewayProxyResponse
-            {
-                Body = JsonSerializer.Serialize(body),
-                StatusCode = 200,
-                Headers = new Dictionary<string, string> { { "Content-Type", "application/json" } }
-            };
-            
             // act
-            var function = new Function(_client, new HttpClient(handlerMock.Object));
+            var function = new Function(_client);
+            
             var firstResponse = await function.FunctionHandler(request, context);
-            await function.FunctionHandler(request, context);
 
             var secondCallContext = new TestLambdaContext
             {
@@ -116,16 +88,16 @@ public async Task TestHelloWorldFunctionHandler()
                 MemoryLimitInMB = 215,
                 AwsRequestId = Guid.NewGuid().ToString("D")
             };
+
             var secondResponse = await function.FunctionHandler(request, secondCallContext);
 
             _testOutputHelper.WriteLine("First Response: \n" + firstResponse.Body);
             _testOutputHelper.WriteLine("Second Response: \n" + secondResponse.Body);
 
             // assert
             Assert.Equal(firstResponse.Body, secondResponse.Body);
-            Assert.Equal(expectedResponse.Body, secondResponse.Body);
-            Assert.Equal(expectedResponse.Headers, secondResponse.Headers);
-            Assert.Equal(expectedResponse.StatusCode, secondResponse.StatusCode);
+            Assert.Equal(firstResponse.Headers, secondResponse.Headers);
+            Assert.Equal(firstResponse.StatusCode, secondResponse.StatusCode);
         }
 
     }

examples/Idempotency/test/HelloWorld.Test/HelloWorld.Tests.csproj

@@ -6,10 +6,10 @@
 		<PackageReference Include="Amazon.Lambda.Core" Version="2.1.0" />
 		<PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
 		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.3.1" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.2" />
-		<PackageReference Include="Moq" Version="4.18.3" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
+		<PackageReference Include="Moq" Version="4.18.4" />
 		<PackageReference Include="xunit" Version="2.4.2" />
-		<PackageReference Include="Testcontainers" Version="3.2.0" />
+		<PackageReference Include="Testcontainers" Version="3.3.0" />
 		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

libraries/src/AWS.Lambda.Powertools.Idempotency/IdempotencyKeyAttribute.cs

@@ -0,0 +1,34 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+using System;
+
+namespace AWS.Lambda.Powertools.Idempotency;
+
+/// <summary>
+/// IdempotencyKey is used to signal that a method parameter is used as a key for idempotency.
+/// Must be used in conjunction with the Idempotency attribute.
+/// 
+/// Example:
+/// 
+/// [Idempotent]
+/// private Basket SubMethod([IdempotencyKey]string magicProduct, Product p) { ... }
+/// Note: This annotation is not needed when the method only has one parameter.
+/// </summary>
+[AttributeUsage(AttributeTargets.Parameter)]
+public class IdempotencyKeyAttribute: Attribute
+{
+    
+}