feature: Idempotency module

.github/workflows/build.yml

@@ -7,10 +7,12 @@ on:
     paths:
       - 'powertools-cloudformation/**'
       - 'powertools-core/**'
+      - 'powertools-utilities/**'
       - 'powertools-logging/**'
       - 'powertools-sqs/**'
       - 'powertools-tracing/**'
       - 'powertools-validation/**'
+      - 'powertools-idempotency/**'
       - 'powertools-parameters/**'
       - 'powertools-metrics/**'
       - 'powertools-test-suite/**'
@@ -22,10 +24,12 @@ on:
     paths:
       - 'powertools-cloudformation/**'
       - 'powertools-core/**'
+      - 'powertools-utilities/**'
       - 'powertools-logging/**'
       - 'powertools-sqs/**'
       - 'powertools-tracing/**'
       - 'powertools-validation/**'
+      - 'powertools-idempotency/**'
       - 'powertools-parameters/**'
       - 'powertools-metrics/**'
       - 'powertools-test-suite/**'

.github/workflows/spotbugs.yml

@@ -7,11 +7,13 @@ on:
     paths:
       - 'powertools-cloudformation/**'
       - 'powertools-core/**'
+      - 'powertools-utilities/**'
       - 'powertools-logging/**'
       - 'powertools-sqs/**'
       - 'powertools-tracing/**'
       - 'powertools-validation/**'
       - 'powertools-parameters/**'
+      - 'powertools-idempotency/**'
       - 'powertools-metrics/**'
       - 'powertools-test-suite/**'
       - 'pom.xml'

.gitignore

@@ -14,6 +14,7 @@ hs_err_pid*
 
 # Maven build
 target/
+native-libs/
 
 ######################
 # IntelliJ

example/HelloWorldFunction/build.gradle

@@ -4,6 +4,7 @@ plugins{
 }
 
 repositories {
+    mavenLocal()
     mavenCentral()
 }
 
@@ -15,8 +16,11 @@ dependencies {
     aspect 'software.amazon.lambda:powertools-parameters:1.10.3'
     aspect 'software.amazon.lambda:powertools-validation:1.10.3'
 
+    implementation 'software.amazon.lambda:powertools-idempotency:1.10.2'
+    aspectpath 'software.amazon.lambda:powertools-idempotency:1.10.2'
+
     implementation 'com.amazonaws:aws-lambda-java-core:1.2.1'
-    implementation 'com.amazonaws:aws-lambda-java-events:3.1.0'
+    implementation 'com.amazonaws:aws-lambda-java-events:3.11.0'
 
     implementation 'org.apache.logging.log4j:log4j-api:2.16.0'
     implementation 'org.apache.logging.log4j:log4j-core:2.16.0'

example/HelloWorldFunction/pom.xml

@@ -43,6 +43,11 @@
             <artifactId>powertools-sqs</artifactId>
             <version>1.10.3</version>
         </dependency>
+        <dependency>
+            <groupId>software.amazon.lambda</groupId>
+            <artifactId>powertools-idempotency</artifactId>
+            <version>1.10.2</version>
+        </dependency>
         <dependency>
             <groupId>com.amazonaws</groupId>
             <artifactId>aws-lambda-java-core</artifactId>
@@ -51,7 +56,7 @@
         <dependency>
             <groupId>com.amazonaws</groupId>
             <artifactId>aws-lambda-java-events</artifactId>
-            <version>3.1.0</version>
+            <version>3.11.0</version>
         </dependency>
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>

example/HelloWorldFunction/src/main/java/helloworld/AppIdempotency.java

@@ -0,0 +1,84 @@
+package helloworld;
+
+import com.amazonaws.services.lambda.runtime.Context;
+import com.amazonaws.services.lambda.runtime.RequestHandler;
+import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
+import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import software.amazon.lambda.powertools.idempotency.Idempotency;
+import software.amazon.lambda.powertools.idempotency.IdempotencyConfig;
+import software.amazon.lambda.powertools.idempotency.Idempotent;
+import software.amazon.lambda.powertools.idempotency.persistence.DynamoDBPersistenceStore;
+import software.amazon.lambda.powertools.utilities.JsonConfig;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.net.URL;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+public class AppIdempotency implements RequestHandler<APIGatewayProxyRequestEvent, APIGatewayProxyResponseEvent> {
+    private final static Logger LOG = LogManager.getLogger();
+
+    public AppIdempotency() {
+        // we need to initialize idempotency configuration before the handleRequest method is called
+        Idempotency.config().withConfig(
+                        IdempotencyConfig.builder()
+                                .withEventKeyJMESPath("powertools_json(body).address")
+                                .build())
+                .withPersistenceStore(
+                        DynamoDBPersistenceStore.builder()
+                                .withTableName("idempotency_table")
+                                .build()
+                ).configure();
+    }
+
+
+    /**
+     * Try with:
+     * <pre>
+     *     curl -X POST https://[REST-API-ID].execute-api.[REGION].amazonaws.com/Prod/helloidem/ -H "Content-Type: application/json" -d '{"address": "https://checkip.amazonaws.com"}'
+     * </pre>
+     * @param input
+     * @param context
+     * @return
+     */
+    @Idempotent
+    public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEvent input, final Context context) {
+        Map<String, String> headers = new HashMap<>();
+
+        headers.put("Content-Type", "application/json");
+        headers.put("Access-Control-Allow-Origin", "*");
+        headers.put("Access-Control-Allow-Methods", "GET, OPTIONS");
+        headers.put("Access-Control-Allow-Headers", "*");
+
+        APIGatewayProxyResponseEvent response = new APIGatewayProxyResponseEvent()
+                .withHeaders(headers);
+        try {
+            String address = JsonConfig.get().getObjectMapper().readTree(input.getBody()).get("address").asText();
+            final String pageContents = this.getPageContents(address);
+            String output = String.format("{ \"message\": \"hello world\", \"location\": \"%s\" }", pageContents);
+
+            LOG.debug("ip is {}", pageContents);
+            return response
+                    .withStatusCode(200)
+                    .withBody(output);
+
+        } catch (IOException e) {
+            return response
+                    .withBody("{}")
+                    .withStatusCode(500);
+        }
+    }
+
+    // we could actually also put the @Idempotent annotation here
+    private String getPageContents(String address) throws IOException {
+        URL url = new URL(address);
+        try (BufferedReader br = new BufferedReader(new InputStreamReader(url.openStream()))) {
+            return br.lines().collect(Collectors.joining(System.lineSeparator()));
+        }
+    }
+}

example/template.yaml

@@ -53,6 +53,35 @@ Resources:
             Path: /helloparams
             Method: get
 
+  IdempotencyTable:
+    Type: AWS::Serverless::SimpleTable
+    Properties:
+      TableName: idempotency_table
+      PrimaryKey:
+        Name: id
+        Type: String
+
+  HelloWorldIdempotentFunction:
+    Type: AWS::Serverless::Function # More info about Function Resource: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
+    Properties:
+      CodeUri: HelloWorldFunction
+      Handler: helloworld.AppIdempotency::handleRequest
+      MemorySize: 512
+      Environment: # More info about Env Vars: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object
+        Variables:
+          POWERTOOLS_LOG_LEVEL: INFO
+          AWS_ENDPOINT_DISCOVERY_ENABLED: false
+      Tracing: Active
+      Policies:
+        - DynamoDBCrudPolicy:
+            TableName: !Ref IdempotencyTable
+      Events:
+        HelloWorld:
+          Type: Api # More info about API Event Source: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
+          Properties:
+            Path: /helloidem
+            Method: post
+
   UserPwd:
     Type: AWS::SecretsManager::Secret
     Properties:
@@ -171,3 +200,9 @@ Outputs:
     Description: "Hello World Params Lambda Function ARN"
     Value: !GetAtt HelloWorldParamsFunction.Arn
 
+  HelloWorldIdempotencyApi:
+    Description: "API Gateway endpoint URL for Prod stage for Hello World idempotency function"
+    Value: !Sub "https://${ServerlessRestApi}.execute-api.${AWS::Region}.amazonaws.com/Prod/helloidem/"
+  HelloWorldIdempotencyFunction:
+    Description: "Hello World Idempotency Lambda Function ARN"
+    Value: !GetAtt HelloWorldIdempotentFunction.Arn

pom.xml

@@ -28,6 +28,7 @@
 
     <modules>
         <module>powertools-core</module>
+        <module>powertools-utilities</module>
         <module>powertools-logging</module>
         <module>powertools-tracing</module>
         <module>powertools-sqs</module>
@@ -36,6 +37,7 @@
         <module>powertools-validation</module>
         <module>powertools-test-suite</module>
         <module>powertools-cloudformation</module>
+        <module>powertools-idempotency</module>
     </modules>
 
     <scm>
@@ -90,6 +92,11 @@
                 <artifactId>powertools-core</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>software.amazon.lambda</groupId>
+                <artifactId>powertools-utilities</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>software.amazon.lambda</groupId>
                 <artifactId>powertools-logging</artifactId>