none: move around utilities, bump some dependencies and improve documentation (#147)

Author: JaidenAshmore

README.md

@@ -13,6 +13,40 @@ or other configuration properties.
 To keep the README minimal and easy to digest, the rest of the documentation is kept in the [doc](./doc/documentation.md) folder which provides a more
 thorough overview of how to use the library.
 
+## Spring Quick Guide
+The following provides some examples using the Spring Starter for this library. *Note that this library is not Spring specific as the main implementations are
+kept in the [core module](./java-dynamic-sqs-listener-core) which is framework agnostic.*
+
+### Using the Spring Starter
+This guide will give a quick guide to getting started for Spring Boot using the Spring Stater.
+
+Include the maven dependency in your Spring Boot pom.xml:
+```xml
+<dependency>
+    <groupId>com.jashmore</groupId>
+    <artifactId>java-dynamic-sqs-listener-spring-starter</artifactId>
+    <version>${sqs.listener.version}</version>
+</dependency>
+```
+
+In one of your beans, attach a
+[@QueueListener](./java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-core/src/main/java/com/jashmore/sqs/spring/container/basic/QueueListener.java)
+annotation to a method indicating that it should process messages from a queue.
+
+```java
+@Service
+public class MyMessageListener {
+    @QueueListener("${insert.queue.url.here}") // The queue here can point to your SQS server, e.g. a local SQS server or one on AWS 
+    public void processMessage(@Payload final String payload) {
+        // process the message payload here
+    }
+}
+```
+
+This will use any user configured `SqsAsyncClient` in the application context for connecting to the queue, otherwise if none is defined, a default
+is provided that will look for AWS credentials/region from multiple areas, like the environment variables. See
+[How to connect to AWS SQS Queues](./doc/how-to-guides/how-to-connect-to-aws-sqs-queue.md) for information about connecting to an actual queue in SQS.
+
 ## Core Infrastructure
 This library has been divided into four main components each with distinct responsibilities. The following is a diagram describing a simple flow of a
 single SQS message flowing through each of the components to eventually be executed by some code.
@@ -49,41 +83,7 @@ for compatibility.
   - [Jackson Databind](https://github.com/FasterXML/jackson-databind): 2.9.10.3
 - [Spring Framework](java-dynamic-sqs-listener-spring)
   - All of the core dependencies
-  - [Spring Boot](https://github.com/spring-projects/spring-boot): 2.2.5.RELEAS
-
-## Spring Quick Guide
-The following provides some examples using the Spring Starter for this library. *Note that this library is not Spring specific as the main implementations are
-kept in the [core module](./java-dynamic-sqs-listener-core) which is framework agnostic.*
-
-### Using the Spring Starter
-This guide will give a quick guide to getting started for Spring Boot using the Spring Stater.
-
-Include the maven dependency in your Spring Boot pom.xml:
-```xml
-<dependency>
-    <groupId>com.jashmore</groupId>
-    <artifactId>java-dynamic-sqs-listener-spring-starter</artifactId>
-    <version>${sqs.listener.version}</version>
-</dependency>
-```
-
-In one of your beans, attach a
-[@QueueListener](./java-dynamic-sqs-listener-spring/java-dynamic-sqs-listener-spring-core/src/main/java/com/jashmore/sqs/spring/container/basic/QueueListener.java)
-annotation to a method indicating that it should process messages from a queue.
-
-```java
-@Service
-public class MyMessageListener {
-    @QueueListener("${insert.queue.url.here}") // The queue here can point to your SQS server, e.g. a local SQS server or one on AWS 
-    public void processMessage(@Payload final String payload) {
-        // process the message payload here
-    }
-}
-```
-
-This will use any user configured `SqsAsyncClient` in the application context for connecting to the queue, otherwise if none is defined, a default
-is provided that will look for AWS credentials/region from multiple areas, like the environment variables. See
-[How to connect to AWS SQS Queues](./doc/how-to-guides/how-to-connect-to-aws-sqs-queue.md) for information about connecting to an actual queue in SQS.
+  - [Spring Boot](https://github.com/spring-projects/spring-boot): 2.2.5.RELEASE
 
 ### How to Mark the message as successfully processed
 When the method executing the message finishes without throwing an exception, the
@@ -168,11 +168,11 @@ do the logic for converting the message payload to uppercase.
            }
         }
     ```
-    You may be curious why a custom `AnnotationUtils.findParameterAnnotation` function is used instead of getting the annotation directly from the parameter.
+    You may be curious why a custom `AnnotationUtils.findParameterAnnotation` function is being used instead of getting the annotation directly from the parameter.
     The reason for this is due to potential proxying of beans in the application, such as by applying Aspects around your code via CGLIB.  As libraries, like
     CGLIB, won't copy the annotations to the proxied classes the resolver needs to look through the class hierarchy to find the original class to get the
     annotations. For more information about this, take a look at the JavaDoc provided in
-    [AnnotationUtils](./java-dynamic-sqs-listener-core/src/main/java/com/jashmore/sqs/util/annotation/AnnotationUtils.java). You can also see an example of
+    [AnnotationUtils](./util/common-utils/src/main/java/com/jashmore/sqs/util/annotation/AnnotationUtils.java). You can also see an example of
     this problem being tested in
     [PayloadArgumentResolver_ProxyClassTest.java](./java-dynamic-sqs-listener-core/src/test/java/com/jashmore/sqs/argument/payload/PayloadArgumentResolver_ProxyClassTest.java).
 1. Include the custom [ArgumentResolver](./java-dynamic-sqs-listener-api/src/main/java/com/jashmore/sqs/argument/ArgumentResolver.java) in the application
@@ -248,7 +248,7 @@ If you want to see the difference between this library and others like the
 module. This allows you to test the performance and usage of each library for different scenarios, such as heavy IO message processing, etc.
 
 ### Other examples
-See [examples](./examples) for all of the other available examples. 
+See [examples](./examples) for all the other available examples. 
 
 ## Bugs and Feedback
 For bugs, questions and discussions please use [Github Issues](https://github.com/JaidenAshmore/java-dynamic-sqs-listener/issues).
@@ -279,4 +279,3 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     SOFTWARE.
- 

examples/spring-aws-example/pom.xml

@@ -9,9 +9,8 @@
 
     <artifactId>java-dynamic-sqs-listener-spring-aws-example</artifactId>
 
-
     <name>Java Dynamic SQS Listener - Spring Starter - AWS Example</name>
-    <description>Contains examples for </description>
+    <description>Contains examples for connecting to an actual AWS SQS Queue</description>
 
     <properties>
         <spotbugs.config.location>../../configuration/spotbugs/bugsExcludeFilter.xml</spotbugs.config.location>

examples/spring-integration-test-example/pom.xml

@@ -20,7 +20,6 @@
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter</artifactId>
-            <version>${spring.boot.version}</version>
         </dependency>
 
         <dependency>
@@ -80,5 +79,12 @@
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
+
+        <dependency>
+            <groupId>com.jashmore</groupId>
+            <artifactId>expected-test-exception</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

examples/spring-integration-test-example/src/test/java/it/com/jashmore/sqs/examples/integrationtests/SqsListenerExampleJunit4IntegrationTest.java

@@ -12,6 +12,7 @@
 import com.jashmore.sqs.examples.integrationtests.IntegrationTestExampleApplication;
 import com.jashmore.sqs.test.LocalSqsRule;
 import com.jashmore.sqs.test.PurgeQueuesRule;
+import com.jashmore.sqs.util.ExpectedTestException;
 import com.jashmore.sqs.util.LocalSqsAsyncClient;
 import com.jashmore.sqs.util.SqsQueuesConfig;
 import org.junit.ClassRule;
@@ -92,7 +93,7 @@ public void messageFailingToProcessWillBeProcessedAgain() throws Exception {
         final AtomicBoolean processedMessageOnce = new AtomicBoolean();
         doAnswer(invocationOnMock -> {
             if (!processedMessageOnce.getAndSet(true)) {
-                throw new RuntimeException("Expected Test Exception");
+                throw new ExpectedTestException();
             }
             messageReceivedCountDownLatch.countDown();
             return null;
@@ -113,7 +114,7 @@ public void messageThatContinuesToFailWillBePlacedIntoDlq() throws Exception {
         final String queueUrl = localSqsAsyncClient.getQueueUrl(QUEUE_NAME);
         doAnswer(invocationOnMock -> {
             messageReceivedCountDownLatch.countDown();
-            throw new RuntimeException("Expected Test Exception");
+            throw new ExpectedTestException();
         }).when(mockSomeService).run(anyString());
 
         // act

examples/spring-integration-test-example/src/test/java/it/com/jashmore/sqs/examples/integrationtests/SqsListenerExampleJunit5IntegrationTest.java

@@ -11,6 +11,7 @@
 
 import com.jashmore.sqs.examples.integrationtests.IntegrationTestExampleApplication;
 import com.jashmore.sqs.test.LocalSqsExtension;
+import com.jashmore.sqs.util.ExpectedTestException;
 import com.jashmore.sqs.util.LocalSqsAsyncClient;
 import com.jashmore.sqs.util.SqsQueuesConfig;
 import org.junit.jupiter.api.Test;
@@ -87,7 +88,7 @@ void messageFailingToProcessWillBeProcessedAgain() throws Exception {
         final AtomicBoolean processedMessageOnce = new AtomicBoolean();
         doAnswer(invocationOnMock -> {
             if (!processedMessageOnce.getAndSet(true)) {
-                throw new RuntimeException("Expected Test Exception");
+                throw new ExpectedTestException();
             }
             messageReceivedCountDownLatch.countDown();
             return null;
@@ -108,7 +109,7 @@ void messageThatContinuesToFailWillBePlacedIntoDlq() throws Exception {
         final String queueUrl = localSqsAsyncClient.getQueueUrl(QUEUE_NAME);
         doAnswer(invocationOnMock -> {
             messageReceivedCountDownLatch.countDown();
-            throw new RuntimeException("Expected Test Exception");
+            throw new ExpectedTestException();
         }).when(mockSomeService).run(anyString());
 
         // act

java-dynamic-sqs-listener-api/pom.xml

@@ -32,5 +32,10 @@
             <groupId>javax.validation</groupId>
             <artifactId>validation-api</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
     </dependencies>
 </project>

java-dynamic-sqs-listener-core/src/main/java/com/jashmore/sqs/argument/DefaultMethodParameter.java renamed to java-dynamic-sqs-listener-api/src/main/java/com/jashmore/sqs/argument/DefaultMethodParameter.java

@@ -26,6 +26,12 @@
             <version>${project.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.jashmore</groupId>
+            <artifactId>common-utils</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>software.amazon.awssdk</groupId>
             <artifactId>sqs</artifactId>
@@ -72,9 +78,16 @@
         </dependency>
 
         <dependency>
-            <groupId>cglib</groupId>
-            <artifactId>cglib</artifactId>
-            <version>3.2.10</version>
+            <groupId>com.jashmore</groupId>
+            <artifactId>proxy-method-interceptor</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>com.jashmore</groupId>
+            <artifactId>expected-test-exception</artifactId>
+            <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

java-dynamic-sqs-listener-core/pom.xml

@@ -1,6 +1,5 @@
-package com.jashmore.sqs.retriever.prefetch.util;
+package com.jashmore.sqs.retriever.prefetch;
 
-import javafx.util.Pair;
 import lombok.extern.slf4j.Slf4j;
 import software.amazon.awssdk.services.sqs.model.Message;
 
@@ -31,7 +30,7 @@
  */
 @Slf4j
 @ThreadSafe
-public class PrefetchingMessageFutureConsumerQueue {
+class PrefetchingMessageFutureConsumerQueue {
     private final Queue<CompletableFuture<Message>> futureQueue;
     private final Queue<Message> messageQueue;
     private final Integer messageCapacity;
@@ -45,7 +44,7 @@ public class PrefetchingMessageFutureConsumerQueue {
      * @param messageCapacity the maximum number of messages to batch before {@link #pushMessage(Message)} blocks until
      *     {@link #pushCompletableFuture(CompletableFuture)} is called
      */
-    public PrefetchingMessageFutureConsumerQueue(final Integer messageCapacity) {
+    PrefetchingMessageFutureConsumerQueue(final Integer messageCapacity) {
         this.futureQueue = new LinkedList<>();
         this.messageQueue = new LinkedList<>();
         this.messageCapacity = messageCapacity;
@@ -57,7 +56,7 @@ public PrefetchingMessageFutureConsumerQueue(final Integer messageCapacity) {
      *
      * @param completableFuture the future to include in the queue
      */
-    public void pushCompletableFuture(@Nonnull CompletableFuture<Message> completableFuture) {
+    void pushCompletableFuture(@Nonnull CompletableFuture<Message> completableFuture) {
         final Message message;
         lock.lock();
         try {
@@ -89,7 +88,7 @@ public void pushCompletableFuture(@Nonnull CompletableFuture<Message> completabl
      * @param message the message to add
      * @throws InterruptedException if the thread was interrupted while waiting for the lock or adding a message onto the internal message queue
      */
-    public void pushMessage(@Nonnull final Message message) throws InterruptedException {
+    void pushMessage(@Nonnull final Message message) throws InterruptedException {
         CompletableFuture<Message> completableFuture;
         lock.lockInterruptibly();
         try {
@@ -116,7 +115,7 @@ public void pushMessage(@Nonnull final Message message) throws InterruptedExcept
      *
      * @throws InterruptedException if the thread was interrupted while waiting for a slot
      */
-    public void blockUntilFreeSlotForMessage() throws InterruptedException {
+    void blockUntilFreeSlotForMessage() throws InterruptedException {
         lock.lockInterruptibly();
         try {
             while (messageQueue.size() == messageCapacity) {
@@ -132,29 +131,26 @@ public void blockUntilFreeSlotForMessage() throws InterruptedException {
      *
      * @return the total messages batched
      */
-    public int getNumberOfBatchedMessages() {
+    int getNumberOfBatchedMessages() {
         return messageQueue.size();
     }
 
     /**
-     * Drain the queues (thus emptying) and return them as a {@link Pair}.
-     *
-     * <p>Note that only a single queue should contain entries. I wanted this to return an "Either" but Java does not provide this type, I did't want
-     * to import another library to provide this and I didn't want to implement it.
+     * Drain the queues (thus emptying) and return the messages to be resolved as well as the messages that have not been used yet.
      *
      * @return the queues of futures and messages that were in this queue
      */
-    public Pair<Queue<CompletableFuture<Message>>, Queue<Message>> drain() {
+    QueueDrain drain() {
         lock.lock();
         try {
-            final LinkedList<CompletableFuture<Message>> copiedFutureList = new LinkedList<>(futureQueue);
-            final LinkedList<Message> copiedMessageList = new LinkedList<>(messageQueue);
+            final LinkedList<CompletableFuture<Message>> futuresWaitingForMessages = new LinkedList<>(futureQueue);
+            final LinkedList<Message> messagesAvailableForProcessing = new LinkedList<>(messageQueue);
             futureQueue.clear();
             messageQueue.clear();
-            return new Pair<>(
-                    copiedFutureList,
-                    copiedMessageList
-            );
+            return QueueDrain.builder()
+                    .futuresWaitingForMessages(futuresWaitingForMessages)
+                    .messagesAvailableForProcessing(messagesAvailableForProcessing)
+                    .build();
         } finally {
             lock.unlock();
         }

java-dynamic-sqs-listener-core/src/main/java/com/jashmore/sqs/retriever/prefetch/util/PrefetchingMessageFutureConsumerQueue.java renamed to java-dynamic-sqs-listener-core/src/main/java/com/jashmore/sqs/retriever/prefetch/PrefetchingMessageFutureConsumerQueue.java

@@ -9,9 +9,7 @@
 import com.jashmore.sqs.QueueProperties;
 import com.jashmore.sqs.aws.AwsConstants;
 import com.jashmore.sqs.retriever.MessageRetriever;
-import com.jashmore.sqs.retriever.prefetch.util.PrefetchingMessageFutureConsumerQueue;
 import com.jashmore.sqs.util.properties.PropertyUtils;
-import javafx.util.Pair;
 import lombok.extern.slf4j.Slf4j;
 import software.amazon.awssdk.core.exception.SdkClientException;
 import software.amazon.awssdk.core.exception.SdkInterruptedException;
@@ -24,7 +22,6 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.ListIterator;
-import java.util.Queue;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 
@@ -144,11 +141,10 @@ public List<Message> run() {
             }
         }
 
-        final Pair<Queue<CompletableFuture<Message>>, Queue<Message>> pairQueue = pairConsumerQueue.drain();
-        final Queue<CompletableFuture<Message>> extraThreads = pairQueue.getKey();
-        extraThreads.forEach(future -> future.cancel(true));
+        final QueueDrain pairQueue = pairConsumerQueue.drain();
+        pairQueue.getFuturesWaitingForMessages().forEach(future -> future.cancel(true));
         return ImmutableList.<Message>builder()
-                .addAll(pairQueue.getValue())
+                .addAll(pairQueue.getMessagesAvailableForProcessing())
                 .addAll(listsNotPublished)
                 .build();
     }