Skip to content

Internal classes and RequestBatchManager Impelementation #5418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions services/sqs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -91,5 +91,26 @@
<version>${awsjavasdk.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>nl.jqno.equalsverifier</groupId>
<artifactId>equalsverifier</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
<scope>test</scope>
</dependency>

</dependencies>
</project>
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,107 @@

package software.amazon.awssdk.services.sqs.internal.batchmanager;

import java.time.Duration;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ScheduledExecutorService;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.annotations.SdkTestInternalApi;
import software.amazon.awssdk.services.sqs.SqsAsyncClient;
import software.amazon.awssdk.services.sqs.batchmanager.BatchOverrideConfiguration;
import software.amazon.awssdk.services.sqs.batchmanager.SqsAsyncBatchManager;
import software.amazon.awssdk.services.sqs.internal.batchmanager.core.BatchManager;
import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchResponse;
import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest;
import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityResponse;
import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResponse;
import software.amazon.awssdk.services.sqs.model.DeleteMessageRequest;
import software.amazon.awssdk.services.sqs.model.DeleteMessageResponse;
import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
import software.amazon.awssdk.services.sqs.model.SendMessageBatchResponse;
import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
import software.amazon.awssdk.services.sqs.model.SendMessageResponse;
import software.amazon.awssdk.utils.Validate;

@SdkInternalApi
public final class DefaultSqsAsyncBatchManager implements SqsAsyncBatchManager {
// TODO : update the validation here while implementing this class in next PR
private final SqsAsyncClient client;
private final ScheduledExecutorService scheduledExecutor;
private final BatchOverrideConfiguration overrideConfiguration;

private final BatchManager<SendMessageRequest, SendMessageResponse, SendMessageBatchResponse> sendMessageBatchManager;

private final BatchManager<DeleteMessageRequest, DeleteMessageResponse, DeleteMessageBatchResponse> deleteMessageBatchManager;

private final BatchManager<ChangeMessageVisibilityRequest, ChangeMessageVisibilityResponse,
ChangeMessageVisibilityBatchResponse> changeMessageVisibilityBatchManager;
private final BatchManager<ReceiveMessageRequest, ReceiveMessageResponse,
ReceiveMessageResponse> receiveMessageBatchManager;

private DefaultSqsAsyncBatchManager(DefaultBuilder builder) {
this.client = Validate.notNull(builder.client, "client cannot be null");
this.scheduledExecutor = Validate.notNull(builder.scheduledExecutor, "scheduledExecutor cannot be null");
// TODO : create overrideConfiguration with Default values if null
this.overrideConfiguration = builder.overrideConfiguration;

ScheduledExecutorService scheduledExecutor = builder.scheduledExecutor;

this.sendMessageBatchManager = BatchManager
.requestBatchManagerBuilder(SendMessageRequest.class, SendMessageResponse.class, SendMessageBatchResponse.class)
.batchFunction(SqsBatchFunctions.sendMessageBatchAsyncFunction(client))
.responseMapper(SqsBatchFunctions.sendMessageResponseMapper())
.batchKeyMapper(SqsBatchFunctions.sendMessageBatchKeyMapper())
.overrideConfiguration(sendMessageConfig(builder.overrideConfiguration)).scheduledExecutor(scheduledExecutor)
.build();
this.deleteMessageBatchManager = BatchManager
.requestBatchManagerBuilder(DeleteMessageRequest.class, DeleteMessageResponse.class, DeleteMessageBatchResponse.class)
.batchFunction(SqsBatchFunctions.deleteMessageBatchAsyncFunction(client))
.responseMapper(SqsBatchFunctions.deleteMessageResponseMapper())
.batchKeyMapper(SqsBatchFunctions.deleteMessageBatchKeyMapper())
.overrideConfiguration(deleteMessageConfig(builder.overrideConfiguration)).scheduledExecutor(scheduledExecutor)
.build();
this.changeMessageVisibilityBatchManager = BatchManager
.requestBatchManagerBuilder(ChangeMessageVisibilityRequest.class, ChangeMessageVisibilityResponse.class,
ChangeMessageVisibilityBatchResponse.class)
.batchFunction(SqsBatchFunctions.changeMessageVisibilityBatchAsyncFunction(client))
.responseMapper(SqsBatchFunctions.changeMessageVisibilityResponseMapper())
.batchKeyMapper(SqsBatchFunctions.changeMessageVisibilityBatchKeyMapper())
.overrideConfiguration(changeMessageVisibilityConfig(builder.overrideConfiguration))
.scheduledExecutor(scheduledExecutor).build();

//TODO : this will be updated while implementing the Receive Message Batch Manager
receiveMessageBatchManager = null;
}


@SdkTestInternalApi
public DefaultSqsAsyncBatchManager(
SqsAsyncClient client,
BatchManager<SendMessageRequest, SendMessageResponse, SendMessageBatchResponse> sendMessageBatchManager,
BatchManager<DeleteMessageRequest, DeleteMessageResponse, DeleteMessageBatchResponse> deleteMessageBatchManager,
BatchManager<ChangeMessageVisibilityRequest, ChangeMessageVisibilityResponse,
ChangeMessageVisibilityBatchResponse> changeMessageVisibilityBatchManager) {
this.sendMessageBatchManager = sendMessageBatchManager;
this.deleteMessageBatchManager = deleteMessageBatchManager;
this.changeMessageVisibilityBatchManager = changeMessageVisibilityBatchManager;
receiveMessageBatchManager = null;
this.client = client;
}

@Override
public CompletableFuture<SendMessageResponse> sendMessage(SendMessageRequest request) {
return sendMessageBatchManager.batchRequest(request);
}

@Override
public CompletableFuture<DeleteMessageResponse> deleteMessage(DeleteMessageRequest request) {
return deleteMessageBatchManager.batchRequest(request);
}

@Override
public CompletableFuture<ChangeMessageVisibilityResponse> changeMessageVisibility(ChangeMessageVisibilityRequest request) {
return changeMessageVisibilityBatchManager.batchRequest(request);
}

@Override
public CompletableFuture<ReceiveMessageResponse> receiveMessage(ReceiveMessageRequest request) {
return receiveMessageBatchManager.batchRequest(request);
}

public static SqsAsyncBatchManager.Builder builder() {
Expand All @@ -42,6 +124,33 @@ public static SqsAsyncBatchManager.Builder builder() {

@Override
public void close() {
sendMessageBatchManager.close();
deleteMessageBatchManager.close();
changeMessageVisibilityBatchManager.close();
}

private BatchOverrideConfiguration createConfig(BatchOverrideConfiguration overrideConfiguration) {
BatchOverrideConfiguration.Builder config = BatchOverrideConfiguration.builder();
if (overrideConfiguration == null) {
config.maxBatchItems(10);
config.maxBatchOpenInMs(Duration.ofMillis(200));
} else {
config.maxBatchItems(overrideConfiguration.maxBatchItems().orElse(10));
config.maxBatchOpenInMs(overrideConfiguration.maxBatchOpenInMs().orElse(Duration.ofMillis(200)));
}
return config.build();
}

private BatchOverrideConfiguration sendMessageConfig(BatchOverrideConfiguration overrideConfiguration) {
return createConfig(overrideConfiguration);
}

private BatchOverrideConfiguration deleteMessageConfig(BatchOverrideConfiguration overrideConfiguration) {
return createConfig(overrideConfiguration);
}

private BatchOverrideConfiguration changeMessageVisibilityConfig(BatchOverrideConfiguration overrideConfiguration) {
return createConfig(overrideConfiguration);
}

public static final class DefaultBuilder implements SqsAsyncBatchManager.Builder {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.awssdk.services.sqs.internal.batchmanager;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ScheduledExecutorService;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.services.sqs.batchmanager.BatchOverrideConfiguration;
import software.amazon.awssdk.services.sqs.internal.batchmanager.core.BatchAndSend;
import software.amazon.awssdk.services.sqs.internal.batchmanager.core.BatchKeyMapper;
import software.amazon.awssdk.services.sqs.internal.batchmanager.core.BatchManager;
import software.amazon.awssdk.services.sqs.internal.batchmanager.core.BatchResponseMapper;


// TODO: This class will be implemented in future PR , for now just added it to show how we have separate Batch managers for
// Request And Response
@SdkInternalApi
public final class ResponseBatchManager<RequestT, ResponseT, BatchResponseT>
implements BatchManager<RequestT, ResponseT, BatchResponseT> {


private ResponseBatchManager(DefaultBuilder<RequestT, ResponseT, BatchResponseT> builder) {
// TODO: Add implementation logic for sending a request in separate PR
}

public static <ResponseT, BatchResponseT, RequestT> Builder<RequestT, ResponseT, BatchResponseT> builder() {
return new DefaultBuilder<>();

}


@Override
public CompletableFuture<ResponseT> batchRequest(RequestT request) {
// TODO: Add implementation logic for sending a request in separate PR
return null;
}

@Override
public void close() {
// TODO: Add implementation logic for sending a request in separate PR
}

public static final class DefaultBuilder<RequestT, ResponseT, BatchResponseT> implements Builder<RequestT, ResponseT,
BatchResponseT> {

public ResponseBatchManager<RequestT, ResponseT,
BatchResponseT> build() {
return new ResponseBatchManager<>(this);
}

@Override
public Builder<RequestT, ResponseT,
BatchResponseT> overrideConfiguration(BatchOverrideConfiguration overrideConfiguration) {
return this;
}

@Override
public Builder<RequestT, ResponseT, BatchResponseT> scheduledExecutor(ScheduledExecutorService scheduledExecutor) {
return this;
}

@Override
public Builder<RequestT, ResponseT,
BatchResponseT> batchFunction(BatchAndSend<RequestT, BatchResponseT> batchFunction) {
return this;
}

@Override
public Builder<RequestT, ResponseT,
BatchResponseT> responseMapper(BatchResponseMapper<BatchResponseT, ResponseT> responseMapper) {
return this;
}

@Override
public Builder<RequestT, ResponseT, BatchResponseT> batchKeyMapper(BatchKeyMapper<RequestT> batchKeyMapper) {
return this;
}
}
}
Loading
Loading