fix: CustomPojoSerializer only for Serde (#1916)

* fix: CustomPojoSerializer only for Serde

Close #1914

This PR remove  the `CustomPojoSerializer` when using  `JacksonDatabind`.

Jackson’s  `ObjectMapper ` creation requires customization which I don’t think it make sense to replicate in our  `CustomPojoSerializer`.

https://github.com/aws/aws-lambda-java-libs/blob/main/aws-lambda-java-serialization/src/main/java/com/amazonaws/services/lambda/runtime/serialization/factories/JacksonFactory.java#L57-L93

* Cleanup imports and use generics

* Update src/main/docs/guide/lambda/eventsLambdaSerde.adoc

Co-authored-by: Tim Yates <[email protected]>

---------

Co-authored-by: Tim Yates <[email protected]>

Author: sdelamo

function-aws/src/main/resources/META-INF/services/com.amazonaws.services.lambda.runtime.CustomPojoSerializer aws-lambda-events-serde/src/main/resources/META-INF/services/com.amazonaws.services.lambda.runtime.CustomPojoSerializer

@@ -29,6 +29,7 @@ managed-aws-java-sdk-v2 = '2.20.162'
 managed-aws-lambda = '1.2.3'
 managed-aws-lambda-events = '3.11.3'
 managed-aws-lambda-java-serialization = '1.1.2'
+aws-lambda-java-runtime-interface-client = '2.4.1'
 
 managed-aws-serverless-core = '1.9.3'
 micronaut-starter = "3.9.2"
@@ -109,6 +110,7 @@ managed-aws-java-sdk-core = { module = 'com.amazonaws:aws-java-sdk-core', versio
 managed-aws-lambda-core = { module = 'com.amazonaws:aws-lambda-java-core', version.ref = 'managed-aws-lambda'}
 managed-aws-lambda-events = { module = 'com.amazonaws:aws-lambda-java-events', version.ref = 'managed-aws-lambda-events' }
 managed-aws-lambda-java-serialization = { module = 'com.amazonaws:aws-lambda-java-serialization', version.ref = 'managed-aws-lambda-java-serialization' }
+aws-lambda-java-runtimeinterfaceclient = { module = 'com.amazonaws:aws-lambda-java-runtime-interface-client', version.ref = 'aws-lambda-java-runtime-interface-client' }
 
 managed-awssdk-secretsmanager = { module = 'software.amazon.awssdk:secretsmanager', version.ref = 'managed-aws-java-sdk-v2' }
 managed-jcl-over-slf4j = { module = 'org.slf4j:jcl-over-slf4j', version.ref = 'slf4j' }

gradle/libs.versions.toml

@@ -1,9 +1,7 @@
-`micronaut-function-aws` provides an implementation of `com.amazonaws.services.lambda.runtime.CustomPojoSerializer` which is loaded via SPI. This `CustomPojoSerialization` avoids your Micronaut function to pay a double hit on performances when using a serialization library inside the Lambda function.
+You need to add a dependency to Micronaut Jackson Databind:
 
-You need to add a dependency to either https://micronaut-projects.github.io/micronaut-serialization/latest/guide[Micronaut Serialization]
-
-dependency:micronaut-serde-jackson[groupId="io.micronaut.serde"]
+dependency:micronaut-jackson-databind[groupId="io.micronaut"]
 
-or to Micronaut Jackson Databind:
+or a dependency to https://micronaut-projects.github.io/micronaut-serialization/latest/guide[Micronaut Serialization]
 
-dependency:micronaut-jackson-databind[groupId="io.micronaut"]
+dependency:micronaut-serde-jackson[groupId="io.micronaut.serde"]

src/main/docs/guide/lambda/customPojoSerialization.adoc

@@ -1,3 +1,6 @@
 If you want to use https://micronaut-projects.github.io/micronaut-serialization/latest/guide/[Micronaut Serialization] with https://github.com/aws/aws-lambda-java-libs/tree/main/aws-lambda-java-events[AWS Lambda Java Events] add the following dependency:
 
 dependency:micronaut-aws-lambda-events-serde[groupId="io.micronaut.aws"]
+
+`micronaut-aws-lambda-events-serde` provides an implementation of `com.amazonaws.services.lambda.runtime.CustomPojoSerializer` which is loaded via SPI.
+This `CustomPojoSerialization` avoids your Micronaut function paying a double hit on performance when using a serialization library inside the Lambda function.

src/main/docs/guide/lambda/eventsLambdaSerde.adoc

@@ -5,7 +5,10 @@
 import org.junit.platform.suite.api.SuiteDisplayName;
 
 @Suite
-@SelectPackages("io.micronaut.aws.lambda.events.tests")
+@SelectPackages({
+    "io.micronaut.aws.lambda.events.tests",
+    "io.micronaut.aws.lambda.events.jacksondatabind.tests"
+})
 @SuiteDisplayName("AWS Lambda Events TCK for JacksonDatabind")
 public class AwsLambdaEventsJacksonDatabindSuite {
 }

test-suite-aws-lambda-events-jacksondatabind/src/test/java/io/micronaut/aws/lambda/events/jacksondatabind/AwsLambdaEventsJacksonDatabindSuite.java

@@ -0,0 +1,13 @@
+package io.micronaut.aws.lambda.events.jacksondatabind.tests;
+
+import org.junit.jupiter.api.Test;
+
+import static io.micronaut.aws.lambda.events.tests.CustomPojoSerializerUtils.loadSerializer;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class NoCustomPojoSerializerForJacksonDatabindTest {
+    @Test
+    void noCustomPojoSerializerForJacksonDatabindTest() {
+        assertNull(loadSerializer());
+    }
+}

test-suite-aws-lambda-events-jacksondatabind/src/test/java/io/micronaut/aws/lambda/events/jacksondatabind/tests/NoCustomPojoSerializerForJacksonDatabindTest.java

@@ -0,0 +1,19 @@
+package io.micronaut.aws.lambda.events.serde;
+
+import org.junit.platform.suite.api.ExcludeClassNamePatterns;
+import org.junit.platform.suite.api.SelectPackages;
+import org.junit.platform.suite.api.Suite;
+import org.junit.platform.suite.api.SuiteDisplayName;
+
+@Suite
+@ExcludeClassNamePatterns(
+    // Error decoding property [Map messageAttributes] of type [class com.amazonaws.services.lambda.runtime.events.SQSEvent$SQSMessage]: Error decoding property [ByteBuffer binaryValue] of type [class com.amazonaws.services.lambda.runtime.events.SQSEvent$MessageAttribute]
+    "io.micronaut.aws.lambda.events.tests.SqsHandlerTest"
+)
+@SelectPackages({
+    "io.micronaut.aws.lambda.events.tests",
+    "io.micronaut.aws.lambda.events.serde.tests"
+})
+@SuiteDisplayName("AWS Lambda Events TCK for Serde")
+public class AwsLambdaEventsSerdeSuite {
+}

test-suite-aws-lambda-events-serde/src/test/java/io/micronaut/aws/lambda/events/AwsLambdaEventsSerdeSuite.java

@@ -0,0 +1,13 @@
+package io.micronaut.aws.lambda.events.serde.tests;
+
+import org.junit.jupiter.api.Test;
+
+import static io.micronaut.aws.lambda.events.tests.CustomPojoSerializerUtils.loadSerializer;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+class CustomPojoSerializerForSerdeTest {
+    @Test
+    void customPojoSerializerForSerdeTest() {
+        assertNotNull(loadSerializer());
+    }
+}

test-suite-aws-lambda-events-serde/src/test/java/io/micronaut/aws/lambda/events/serde/AwsLambdaEventsSerdeSuite.java

@@ -2,7 +2,8 @@ plugins {
     id("java-library")
 }
 dependencies {
-    implementation(libs.managed.aws.lambda.events)
+    api(libs.aws.lambda.java.runtimeinterfaceclient)
+    api(libs.managed.aws.lambda.events)
     implementation(mnTest.micronaut.test.junit5)
     implementation(projects.micronautFunctionAws)
 }

test-suite-aws-lambda-events-serde/src/test/java/io/micronaut/aws/lambda/events/serde/tests/CustomPojoSerializerForSerdeTest.java

@@ -2,15 +2,13 @@
 
 import com.amazonaws.services.lambda.runtime.events.APIGatewayV2HTTPEvent;
 import io.micronaut.aws.lambda.events.FileUtils;
-import io.micronaut.function.aws.JsonMapperCustomPojoSerializer;
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
 
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 class ApiGatewayV2EventTest {
 
@@ -47,10 +45,8 @@ public static void expectedEvent(APIGatewayV2HTTPEvent event) {
 
     @Test
     void testDeserializationOfAPIGatewayV2HttpEvent() throws IOException {
-        JsonMapperCustomPojoSerializer serializer = new JsonMapperCustomPojoSerializer();
         String json = FileUtils.text(this.getClass().getClassLoader(), "apiGatewayV2HTTPEvent.json").orElse(null);
-        assertNotNull(json);
-        APIGatewayV2HTTPEvent event = assertDoesNotThrow(() -> serializer.fromJson(json, APIGatewayV2HTTPEvent.class));
+        APIGatewayV2HTTPEvent event = assertDoesNotThrow(() -> CustomPojoSerializerUtils.serializeFromJson(json, APIGatewayV2HTTPEvent.class));
         expectedEvent(event);
     }
 }

test-suite-aws-lambda-events/build.gradle.kts

@@ -2,7 +2,6 @@
 
 import com.amazonaws.services.lambda.runtime.events.ApplicationLoadBalancerRequestEvent;
 import io.micronaut.aws.lambda.events.FileUtils;
-import io.micronaut.function.aws.JsonMapperCustomPojoSerializer;
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
@@ -18,10 +17,9 @@ public class ApplicationLoadBalancerRequestEventTest {
     @Test
     @SuppressWarnings("java:S1313") // IP usage is safe here
     void testDeserializationOfApplicationLoadBalancerRequestEvent() throws IOException {
-        JsonMapperCustomPojoSerializer serializer = new JsonMapperCustomPojoSerializer();
         String json = FileUtils.text(this.getClass().getClassLoader(), "albRequest.json").orElse(null);
         assertNotNull(json);
-        ApplicationLoadBalancerRequestEvent event = assertDoesNotThrow(() -> serializer.fromJson(json, ApplicationLoadBalancerRequestEvent.class));
+        ApplicationLoadBalancerRequestEvent event = assertDoesNotThrow(() -> CustomPojoSerializerUtils.serializeFromJson(json, ApplicationLoadBalancerRequestEvent.class));
         assertEquals("arn:aws:elasticloadbalancing:us-east-1:646307737039:targetgroup/fubar-dev-tg/97533b9b279f7d7f", event.getRequestContext().getElb().getTargetGroupArn());
         assertEquals("GET", event.getHttpMethod());
         assertEquals("/", event.getPath());

test-suite-aws-lambda-events/src/main/java/io/micronaut/aws/lambda/events/tests/ApiGatewayV2EventTest.java

@@ -2,7 +2,6 @@
 
 import com.amazonaws.services.lambda.runtime.events.ApplicationLoadBalancerResponseEvent;
 import io.micronaut.aws.lambda.events.FileUtils;
-import io.micronaut.function.aws.JsonMapperCustomPojoSerializer;
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
@@ -18,10 +17,9 @@ public class ApplicationLoadBalancerResponseEventTest {
 
     @Test
     void testDeserializationOfApplicationLoadBalancerResponseEvent() throws IOException {
-        JsonMapperCustomPojoSerializer serializer = new JsonMapperCustomPojoSerializer();
         String json = FileUtils.text(this.getClass().getClassLoader(), "albResponse.json").orElse(null);
         assertNotNull(json);
-        ApplicationLoadBalancerResponseEvent event = assertDoesNotThrow(() -> serializer.fromJson(json, ApplicationLoadBalancerResponseEvent.class));
+        ApplicationLoadBalancerResponseEvent event = assertDoesNotThrow(() -> CustomPojoSerializerUtils.serializeFromJson(json, ApplicationLoadBalancerResponseEvent.class));
         assertEquals(200, event.getStatusCode());
         assertNull(event.getStatusDescription());
         assertFalse(event.getIsBase64Encoded());

test-suite-aws-lambda-events/src/main/java/io/micronaut/aws/lambda/events/tests/ApplicationLoadBalancerRequestEventTest.java

@@ -0,0 +1,40 @@
+package io.micronaut.aws.lambda.events.tests;
+
+import com.amazonaws.services.lambda.runtime.CustomPojoSerializer;
+import com.amazonaws.services.lambda.runtime.serialization.PojoSerializer;
+import com.amazonaws.services.lambda.runtime.serialization.events.LambdaEventSerializers;
+
+import java.util.Iterator;
+import java.util.ServiceLoader;
+
+public final class CustomPojoSerializerUtils {
+
+    private CustomPojoSerializerUtils() {
+    }
+
+    public static CustomPojoSerializer loadSerializer()  {
+
+        ServiceLoader<CustomPojoSerializer> loader = ServiceLoader.load(CustomPojoSerializer.class);
+        Iterator<CustomPojoSerializer> serializers = loader.iterator();
+
+        if (!serializers.hasNext()) {
+            return null;
+        }
+
+        return serializers.next();
+    }
+
+    public static <T> PojoSerializer<T> loadSerializer(Class<T> eventClass) {
+        return LambdaEventSerializers.serializerFor(eventClass, CustomPojoSerializerUtils.class.getClassLoader());
+    }
+
+    public static <T> T serializeFromJson(String input, Class<T> eventClass) {
+        CustomPojoSerializer customPojoSerializer = loadSerializer();
+        if (customPojoSerializer != null) {
+            return customPojoSerializer.fromJson(input, eventClass);
+        }
+
+        PojoSerializer<T> pojoSerializer = loadSerializer(eventClass);
+        return pojoSerializer.fromJson(input);
+    }
+}

test-suite-aws-lambda-events/src/main/java/io/micronaut/aws/lambda/events/tests/ApplicationLoadBalancerResponseEventTest.java

@@ -0,0 +1,23 @@
+package io.micronaut.aws.lambda.events.tests;
+
+import com.amazonaws.services.lambda.runtime.events.SQSEvent;
+import io.micronaut.aws.lambda.events.FileUtils;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+public class SqsHandlerTest {
+    @Test
+    void testDeserializationOfApplicationLoadBalancerRequestEvent() throws IOException {
+        String json = FileUtils.text(this.getClass().getClassLoader(), "sqs-event.json").orElse(null);
+        assertNotNull(json);
+        SQSEvent event = assertDoesNotThrow(() -> CustomPojoSerializerUtils.serializeFromJson(json, SQSEvent.class));
+        assertNotNull(event);
+        assertNotNull(event.getRecords());
+        assertEquals(1, event.getRecords().size());
+    }
+}

test-suite-aws-lambda-events/src/main/java/io/micronaut/aws/lambda/events/tests/CustomPojoSerializerUtils.java

@@ -0,0 +1,40 @@
+{
+  "Records": [
+    {
+      "messageId" : "MessageID_1",
+      "receiptHandle" : "MessageReceiptHandle",
+      "body" : "Message Body",
+      "md5OfBody" : "fce0ea8dd236ccb3ed9b37dae260836f",
+      "md5OfMessageAttributes" : "582c92c5c5b6ac403040a4f3ab3115c9",
+      "eventSourceARN": "arn:aws:sqs:us-west-2:123456789012:SQSQueue",
+      "eventSource": "aws:sqs",
+      "awsRegion": "us-west-2",
+      "attributes" : {
+        "ApproximateReceiveCount" : "2",
+        "SentTimestamp" : "1520621625029",
+        "SenderId" : "AROAIWPX5BD2BHG722MW4:sender",
+        "ApproximateFirstReceiveTimestamp" : "1520621634884"
+      },
+      "messageAttributes" : {
+        "Attribute3" : {
+          "binaryValue" : "MTEwMA==",
+          "stringListValues" : ["abc", "123"],
+          "binaryListValues" : ["MA==", "MQ==", "MA=="],
+          "dataType" : "Binary"
+        },
+        "Attribute2" : {
+          "stringValue" : "123",
+          "stringListValues" : [ ],
+          "binaryListValues" : ["MQ==", "MA=="],
+          "dataType" : "Number"
+        },
+        "Attribute1" : {
+          "stringValue" : "AttributeValue1",
+          "stringListValues" : [ ],
+          "binaryListValues" : [ ],
+          "dataType" : "String"
+        }
+      }
+    }
+  ]
+}