joviegas commented 2 months ago

Motivation and Context

Creating a Batch Manager

Default Configuration via SqsAsyncClient: Users can easily obtain a SqsAsyncBatchManager with default configurations via SqsAsyncClient. This is the simplest approach, requiring minimal setup:

SqsAsyncClient asyncClient = SqsAsyncClient.create();
SqsAsyncBatchManager sqsAsyncBatchManager = asyncClient.batchManager();

Custom Configuration via SqsAsyncBatchManager.Builder:

batchManager = SqsAsyncBatchManager.builder()
                               .client(client)
                               .scheduledExecutor(Executors.newScheduledThreadPool(5))
                               .overrideConfiguration(b -> b
                                   .maxBatchSize(10)
                                   .sendRequestFrequency(Duration.ofMillis(200))
                                   .receiveMessageMinWaitDuration(Duration.ofSeconds(10))
                                   .receiveMessageVisibilityTimeout(Duration.ofSeconds(20))
                                   .receiveMessageAttributeNames(Collections.singletonList("*"))
                                   .receiveMessageSystemAttributeNames(Collections.singletonList(MessageSystemAttributeName.ALL)))
                               .build();

Method Usage Scenarios

Sending Messages:

CompletableFuture<SendMessageResponse> futureOne = sqsAsyncBatchManager.sendMessage(r -> r.messageBody("One").queueUrl("queue"));
SendMessageResponse messageOne = futureOne.join();

Receiving Messages:

With default settings:

CompletableFuture<ReceiveMessageResponse> responseFuture = batchManager.receiveMessage(
    r -> r.queueUrl(defaultQueueUrl));

With custom timeout:

CompletableFuture<ReceiveMessageResponse> response = batchManager.receiveMessage(
    r -> r.queueUrl(defaultQueueUrl)
          .waitTimeSeconds(5)
          .visibilityTimeout(20));

With limited number of messages configured on Request:

CompletableFuture<ReceiveMessageResponse> response = batchManager.receiveMessage(
    r -> r.queueUrl(defaultQueueUrl)
          .maxNumberOfMessages(3));

Modifications

Please refer to the PR in the commit

#

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)

Checklist

[ ] I have read the CONTRIBUTING document
[ ] Local run of mvn install succeeds
[ ] My code follows the code style of this project
[ ] My change requires a change to the Javadoc documentation
[ ] I have updated the Javadoc documentation accordingly
[ ] I have added tests to cover my changes
[ ] All new and existing tests passed
[ ] I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
[ ] My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

[x] I confirm that this pull request can be released under the Apache 2 license

sonarcloud[bot] commented 2 months ago

Quality Gate failed

Failed conditions
B Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

jhchee commented 1 month ago

Hi @joviegas thanks for the great work! I believe there's a need to update the documentation at [here] (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-client-side-buffering-request-batching.html#using-buffered-async-client) as well.

joviegas commented 4 weeks ago