Rename API method for batch processing

Author: Pankaj Agrawal

powertools-sqs/src/main/java/software/amazon/lambda/powertools/sqs/PowertoolsSqs.java

@@ -14,7 +14,6 @@
 package software.amazon.lambda.powertools.sqs;
 
 import java.lang.reflect.Constructor;
-import java.lang.reflect.InvocationTargetException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.function.Function;
@@ -89,48 +88,63 @@ public static <R> R enrichedMessageFromS3(final SQSEvent sqsEvent,
         return returnValue;
     }
 
+    /**
+     * Provides ability to set default {@link SqsClient} to be used by utility.
+     * If no default configuration is provided, client is instantiated via {@link SqsClient#create()}
+     *
+     * @param client {@link SqsClient} to be used by utility
+     */
     public static void defaultSqsClient(SqsClient client) {
         PowertoolsSqs.client = client;
     }
 
-    public static SqsClient defaultSqsClient() {
-        return client;
-    }
-
-    public static <R> List<R> partialBatchProcessor(final SQSEvent event,
-                                                    final Class<? extends SqsMessageHandler<R>> handler) {
-        return partialBatchProcessor(event, false, handler);
+    /**
+     * @param event
+     * @param handler
+     * @param <R>
+     * @return
+     */
+    public static <R> List<R> batchProcessor(final SQSEvent event,
+                                             final Class<? extends SqsMessageHandler<R>> handler) {
+        return batchProcessor(event, false, handler);
     }
 
-    public static <R> List<R> partialBatchProcessor(final SQSEvent event,
-                                                    final boolean suppressException,
-                                                    final Class<? extends SqsMessageHandler<R>> handler) {
+    /**
+     * @param event
+     * @param suppressException
+     * @param handler
+     * @param <R>
+     * @return
+     */
+    public static <R> List<R> batchProcessor(final SQSEvent event,
+                                             final boolean suppressException,
+                                             final Class<? extends SqsMessageHandler<R>> handler) {
 
-        try {
-            SqsMessageHandler<R> handlerInstance;
-            if (null == handler.getDeclaringClass()) {
-                handlerInstance = handler.newInstance();
-            } else {
-                Constructor<? extends SqsMessageHandler<R>> constructor = handler.getDeclaredConstructor(handler.getDeclaringClass());
-                constructor.setAccessible(true);
-                handlerInstance = constructor.newInstance(handler.getDeclaringClass().newInstance());
-            }
-            return partialBatchProcessor(event, suppressException, handlerInstance);
-        } catch (IllegalAccessException | InstantiationException | NoSuchMethodException | InvocationTargetException e) {
-            LOG.error("Failed invoking process method on handler", e);
-            throw new RuntimeException("Unexpected error occurred. Please raise issue at " +
-                    "https://github.com/awslabs/aws-lambda-powertools-java/issues", e);
-        }
+        SqsMessageHandler<R> handlerInstance = instantiatedHandler(handler);
+        return batchProcessor(event, suppressException, handlerInstance);
     }
 
-    public static <R> List<R> partialBatchProcessor(final SQSEvent event,
-                                                    final SqsMessageHandler<R> handler) {
-        return partialBatchProcessor(event, false, handler);
+    /**
+     * @param event
+     * @param handler
+     * @param <R>
+     * @return
+     */
+    public static <R> List<R> batchProcessor(final SQSEvent event,
+                                             final SqsMessageHandler<R> handler) {
+        return batchProcessor(event, false, handler);
     }
 
-    public static <R> List<R> partialBatchProcessor(final SQSEvent event,
-                                                    final boolean suppressException,
-                                                    final SqsMessageHandler<R> handler) {
+    /**
+     * @param event
+     * @param suppressException
+     * @param handler
+     * @param <R>
+     * @return
+     */
+    public static <R> List<R> batchProcessor(final SQSEvent event,
+                                             final boolean suppressException,
+                                             final SqsMessageHandler<R> handler) {
         final List<R> handlerReturn = new ArrayList<>();
 
         BatchContext batchContext = new BatchContext(defaultSqsClient());
@@ -154,6 +168,27 @@ public static <R> List<R> partialBatchProcessor(final SQSEvent event,
         return handlerReturn;
     }
 
+    private static SqsClient defaultSqsClient() {
+        return client;
+    }
+
+    private static <R> SqsMessageHandler<R> instantiatedHandler(final Class<? extends SqsMessageHandler<R>> handler) {
+
+        try {
+            if (null == handler.getDeclaringClass()) {
+                return handler.newInstance();
+            }
+
+            final Constructor<? extends SqsMessageHandler<R>> constructor = handler.getDeclaredConstructor(handler.getDeclaringClass());
+            constructor.setAccessible(true);
+            return constructor.newInstance(handler.getDeclaringClass().newInstance());
+        } catch (Exception e) {
+            LOG.error("Failed creating handler instance", e);
+            throw new RuntimeException("Unexpected error occurred. Please raise issue at " +
+                    "https://github.com/awslabs/aws-lambda-powertools-java/issues", e);
+        }
+    }
+
     private static SQSMessage clonedMessage(final SQSMessage sqsMessage) {
         try {
             return objectMapper

powertools-sqs/src/main/java/software/amazon/lambda/powertools/sqs/SQSBatchProcessingException.java

@@ -7,6 +7,9 @@
 
 import static java.util.stream.Collectors.joining;
 
+/**
+ *
+ */
 public class SQSBatchProcessingException extends RuntimeException {
 
     private final List<Exception> exceptions;

powertools-sqs/src/main/java/software/amazon/lambda/powertools/sqs/SqsBatchProcessor.java

@@ -5,7 +5,9 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-
+/**
+ *
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface SqsBatchProcessor {

powertools-sqs/src/main/java/software/amazon/lambda/powertools/sqs/SqsMessageHandler.java

@@ -2,6 +2,10 @@
 
 import static com.amazonaws.services.lambda.runtime.events.SQSEvent.SQSMessage;
 
+/**
+ *
+ * @param <R>
+ */
 @FunctionalInterface
 public interface SqsMessageHandler<R> {
 

powertools-sqs/src/main/java/software/amazon/lambda/powertools/sqs/internal/SqsMessageBatchProcessorAspect.java

@@ -8,7 +8,7 @@
 import software.amazon.lambda.powertools.sqs.SqsBatchProcessor;
 
 import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isHandlerMethod;
-import static software.amazon.lambda.powertools.sqs.PowertoolsSqs.partialBatchProcessor;
+import static software.amazon.lambda.powertools.sqs.PowertoolsSqs.batchProcessor;
 import static software.amazon.lambda.powertools.sqs.internal.SqsLargeMessageAspect.placedOnSqsEventRequestHandler;
 
 @Aspect
@@ -29,7 +29,7 @@ && placedOnSqsEventRequestHandler(pjp)) {
 
             SQSEvent sqsEvent = (SQSEvent) proceedArgs[0];
 
-            partialBatchProcessor(sqsEvent, sqsBatchProcessor.suppressException(), sqsBatchProcessor.value());
+            batchProcessor(sqsEvent, sqsBatchProcessor.suppressException(), sqsBatchProcessor.value());
         }
 
         return pjp.proceed(proceedArgs);

powertools-sqs/src/test/java/software/amazon/lambda/powertools/sqs/PowertoolsSqsBatchProcessorTest.java

@@ -24,8 +24,8 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoInteractions;
 import static org.mockito.Mockito.when;
+import static software.amazon.lambda.powertools.sqs.PowertoolsSqs.batchProcessor;
 import static software.amazon.lambda.powertools.sqs.PowertoolsSqs.defaultSqsClient;
-import static software.amazon.lambda.powertools.sqs.PowertoolsSqs.partialBatchProcessor;
 
 class PowertoolsSqsBatchProcessorTest {
 
@@ -48,7 +48,7 @@ void setUp() throws IOException {
 
     @Test
     void shouldBatchProcessAndNotDeleteMessagesWhenAllSuccess() {
-        List<String> returnValues = partialBatchProcessor(event, false, (message) -> {
+        List<String> returnValues = batchProcessor(event, false, (message) -> {
             interactionClient.listQueues();
             return "Success";
         });
@@ -64,7 +64,7 @@ void shouldBatchProcessAndNotDeleteMessagesWhenAllSuccess() {
     @ParameterizedTest
     @ValueSource(classes = {SampleInnerSqsHandler.class, SampleSqsHandler.class})
     void shouldBatchProcessViaClassAndNotDeleteMessagesWhenAllSuccess(Class<? extends SqsMessageHandler<String>> handler) {
-        List<String> returnValues = partialBatchProcessor(event, handler);
+        List<String> returnValues = batchProcessor(event, handler);
 
         assertThat(returnValues)
                 .hasSize(2)
@@ -87,7 +87,7 @@ void shouldBatchProcessAndDeleteSuccessMessageOnPartialFailures() {
         };
 
         assertThatExceptionOfType(SQSBatchProcessingException.class)
-                .isThrownBy(() -> partialBatchProcessor(event, failedHandler))
+                .isThrownBy(() -> batchProcessor(event, failedHandler))
                 .satisfies(e -> {
 
                     assertThat(e.successMessageReturnValues())
@@ -116,7 +116,7 @@ void shouldBatchProcessAndFullFailuresInBatch() {
         };
 
         assertThatExceptionOfType(SQSBatchProcessingException.class)
-                .isThrownBy(() -> partialBatchProcessor(event, failedHandler))
+                .isThrownBy(() -> batchProcessor(event, failedHandler))
                 .satisfies(e -> {
 
                     assertThat(e.successMessageReturnValues())
@@ -141,7 +141,7 @@ void shouldBatchProcessAndFullFailuresInBatch() {
     @Test
     void shouldBatchProcessViaClassAndDeleteSuccessMessageOnPartialFailures() {
         assertThatExceptionOfType(SQSBatchProcessingException.class)
-                .isThrownBy(() -> partialBatchProcessor(event, FailureSampleInnerSqsHandler.class))
+                .isThrownBy(() -> batchProcessor(event, FailureSampleInnerSqsHandler.class))
                 .satisfies(e -> {
 
                     assertThat(e.successMessageReturnValues())
@@ -176,7 +176,7 @@ void shouldBatchProcessAndSuppressExceptions() {
             return "Success";
         };
 
-        List<String> returnValues = partialBatchProcessor(event, true, failedHandler);
+        List<String> returnValues = batchProcessor(event, true, failedHandler);
 
         assertThat(returnValues)
                 .hasSize(1)
@@ -188,7 +188,7 @@ void shouldBatchProcessAndSuppressExceptions() {
 
     @Test
     void shouldBatchProcessViaClassAndSuppressExceptions() {
-        List<String> returnValues = partialBatchProcessor(event, true, FailureSampleInnerSqsHandler.class);
+        List<String> returnValues = batchProcessor(event, true, FailureSampleInnerSqsHandler.class);
 
         assertThat(returnValues)
                 .hasSize(1)

powertools-sqs/src/test/java/software/amazon/lambda/powertools/sqs/SampleSqsHandler.java

@@ -2,7 +2,7 @@
 
 import com.amazonaws.services.lambda.runtime.events.SQSEvent;
 
-public class SampleSqsHandler implements SqsMessageHandler<String> {
+public class SampleSqsHandler implements SqsMessageHandler<Object> {
     private int counter;
 
     @Override

powertools-sqs/src/test/java/software/amazon/lambda/powertools/sqs/handlers/LambdaHandlerApiGateway.java

@@ -4,11 +4,14 @@
 import com.amazonaws.services.lambda.runtime.RequestHandler;
 import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
 import software.amazon.lambda.powertools.sqs.LargeMessageHandler;
+import software.amazon.lambda.powertools.sqs.SampleSqsHandler;
+import software.amazon.lambda.powertools.sqs.SqsBatchProcessor;
 
 public class LambdaHandlerApiGateway implements RequestHandler<APIGatewayProxyRequestEvent, String> {
 
     @Override
     @LargeMessageHandler
+    @SqsBatchProcessor(value = SampleSqsHandler.class)
     public String handleRequest(APIGatewayProxyRequestEvent sqsEvent, Context context) {
         return sqsEvent.getBody();
     }

powertools-sqs/src/test/java/software/amazon/lambda/powertools/sqs/internal/SqsMessageBatchProcessorAspectTest.java

@@ -4,6 +4,7 @@
 
 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.SQSEvent;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.BeforeEach;
@@ -13,8 +14,9 @@
 import software.amazon.awssdk.services.sqs.model.GetQueueUrlRequest;
 import software.amazon.awssdk.services.sqs.model.GetQueueUrlResponse;
 import software.amazon.lambda.powertools.sqs.SQSBatchProcessingException;
-import software.amazon.lambda.powertools.sqs.handlers.PartialBatchPartialFailureHandler;
+import software.amazon.lambda.powertools.sqs.handlers.LambdaHandlerApiGateway;
 import software.amazon.lambda.powertools.sqs.handlers.PartialBatchFailureSuppressedHandler;
+import software.amazon.lambda.powertools.sqs.handlers.PartialBatchPartialFailureHandler;
 import software.amazon.lambda.powertools.sqs.handlers.PartialBatchSuccessHandler;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -24,6 +26,7 @@
 import static org.mockito.Mockito.reset;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoInteractions;
 import static org.mockito.Mockito.when;
 import static software.amazon.lambda.powertools.sqs.PowertoolsSqs.defaultSqsClient;
 
@@ -94,6 +97,15 @@ void shouldBatchProcessMessageWithSuccessDeletedOnFailureWithSuppressionInBatchF
         verify(sqsClient).deleteMessageBatch(any(DeleteMessageBatchRequest.class));
     }
 
+    @Test
+    void shouldNotTakeEffectOnNonSqsEventHandler() {
+        LambdaHandlerApiGateway handlerApiGateway = new LambdaHandlerApiGateway();
+
+        handlerApiGateway.handleRequest(mock(APIGatewayProxyRequestEvent.class), context);
+
+        verifyNoInteractions(sqsClient);
+    }
+
     private void setupContext() {
         when(context.getFunctionName()).thenReturn("testFunction");
         when(context.getInvokedFunctionArn()).thenReturn("testArn");