Skip to content

Add IgnorepayloadNotFound flag support for SQSExtendedAsync Client #167

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.

Sign up for GitHub

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
merged 2 commits into from
May 30, 2025
Merged

Add IgnorepayloadNotFound flag support for SQSExtendedAsync Client #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1be5c14
Fix unit tests and build
mit-aws May 28, 2025
6aa1bd6
Add IgnorePayload flag support for SQSExtendedAsync client
mit-aws May 29, 2025
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
5 changes: 5 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@
<version>5.12.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy</artifactId>
<version>LATEST</version>
</dependency>
</dependencies>
<build>
<pluginManagement>
Expand Down
27 changes: 26 additions & 1 deletion src/main/java/com/amazon/sqs/javamessaging/AmazonSQSExtendedAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.stream.Collectors;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
Expand Down Expand Up @@ -193,6 +195,7 @@ public CompletableFuture<ReceiveMessageResponse> receiveMessage(ReceiveMessageRe
messageAttributeNames.removeAll(AmazonSQSExtendedClientUtil.RESERVED_ATTRIBUTE_NAMES);
messageAttributeNames.addAll(AmazonSQSExtendedClientUtil.RESERVED_ATTRIBUTE_NAMES);
receiveMessageRequestBuilder.messageAttributeNames(messageAttributeNames);
String queueUrl = receiveMessageRequest.queueUrl();
receiveMessageRequest = receiveMessageRequestBuilder.build();

return super.receiveMessage(receiveMessageRequest)
Expand Down Expand Up @@ -222,7 +225,28 @@ public CompletableFuture<ReceiveMessageResponse> receiveMessage(ReceiveMessageRe

// Retrieve original payload
modifiedMessageFutures.add(payloadStore.getOriginalPayload(largeMessagePointer)
.thenApply(originalPayload -> {
.handle((originalPayload,throwable) -> {

if(throwable != null)
{
if(clientConfiguration.ignoresPayloadNotFound())
{
DeleteMessageRequest deleteMessageRequest = DeleteMessageRequest
.builder()
.queueUrl(queueUrl)
.receiptHandle(message.receiptHandle())
.build();

deleteMessage(deleteMessageRequest).join();
LOG.warn("Message deleted from SQS since payload with pointer could not be found in S3.");
return null;
}
else
{
throw new CompletionException(throwable);
}
}

// Set original payload
messageBuilder.body(originalPayload);

Expand All @@ -249,6 +273,7 @@ public CompletableFuture<ReceiveMessageResponse> receiveMessage(ReceiveMessageRe
modifiedMessageFutures.toArray(new CompletableFuture[modifiedMessageFutures.size()]))
.thenApply(v -> modifiedMessageFutures.stream()
.map(CompletableFuture::join)
.filter(Objects::nonNull)
.collect(Collectors.toList()));
})
.thenApply(modifiedMessages -> {
Expand Down
63 changes: 63 additions & 0 deletions src/test/java/com/amazon/sqs/javamessaging/AmazonSQSExtendedAsyncClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isA;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
Expand All @@ -25,6 +27,7 @@
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import org.junit.jupiter.api.BeforeEach;
Expand All @@ -35,14 +38,17 @@
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.async.AsyncRequestBody;
import software.amazon.awssdk.core.async.AsyncResponseTransformer;
import software.amazon.awssdk.core.exception.SdkException;
import software.amazon.awssdk.services.s3.S3AsyncClient;
import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
import software.amazon.awssdk.services.s3.model.DeleteObjectResponse;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;
import software.amazon.awssdk.services.s3.model.NoSuchKeyException;
import software.amazon.awssdk.services.s3.model.ObjectCannedACL;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.services.sqs.SqsAsyncClient;
import software.amazon.awssdk.services.sqs.SqsClient;
import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest;
import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequestEntry;
import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResponse;
Expand Down Expand Up @@ -640,6 +646,63 @@ private void testReceiveMessage_when_MessageIsLarge(String reservedAttributeName
verify(mockS3, times(1)).getObject(isA(GetObjectRequest.class), isA(AsyncResponseTransformer.class));
}

@Test
public void testReceiveMessage_when_ignorePayloadNotFound_then_messageWithPayloadNotFoundIsDeletedFromSQS() {
ExtendedAsyncClientConfiguration extendedAsyncClientConfiguration = new ExtendedAsyncClientConfiguration()
.withPayloadSupportEnabled(mockS3, S3_BUCKET_NAME)
.withIgnorePayloadNotFound(true);
SqsAsyncClient sqsAsyncExtended = spy(new AmazonSQSExtendedAsyncClient(mockSqsBackend, extendedAsyncClientConfiguration));

String receiptHandle = "receipt-handle";
Message message = Message.builder()
.messageAttributes(ImmutableMap.of(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME, MessageAttributeValue.builder().build()))
.body(new PayloadS3Pointer(S3_BUCKET_NAME, "S3Key").toJson())
.receiptHandle(receiptHandle)
.build();

when(mockSqsBackend.receiveMessage(isA(ReceiveMessageRequest.class))).thenReturn(
CompletableFuture.completedFuture(ReceiveMessageResponse.builder().messages(message).build()));
doThrow(NoSuchKeyException.class).when(mockS3).getObject((GetObjectRequest) any(), any(AsyncResponseTransformer.class));

ReceiveMessageRequest messageRequest = ReceiveMessageRequest.builder().queueUrl(SQS_QUEUE_URL).build();
ReceiveMessageResponse receiveMessageResponse = sqsAsyncExtended.receiveMessage(messageRequest).join();

assertTrue(receiveMessageResponse.messages().isEmpty());

ArgumentCaptor<DeleteMessageRequest> deleteMessageRequestArgumentCaptor = ArgumentCaptor.forClass(DeleteMessageRequest.class);
verify(mockSqsBackend).deleteMessage(deleteMessageRequestArgumentCaptor.capture());
assertEquals(SQS_QUEUE_URL, deleteMessageRequestArgumentCaptor.getValue().queueUrl());
assertEquals(receiptHandle, deleteMessageRequestArgumentCaptor.getValue().receiptHandle());
}

@Test
public void testReceiveMessage_when_ignorePayloadNotFoundIsFalse_then_messageWithPayloadNotFoundThrowsException() {
ExtendedAsyncClientConfiguration extendedAsyncClientConfiguration = new ExtendedAsyncClientConfiguration()
.withPayloadSupportEnabled(mockS3, S3_BUCKET_NAME)
.withIgnorePayloadNotFound(false);
SqsAsyncClient sqsAsyncExtended = spy(new AmazonSQSExtendedAsyncClient(mockSqsBackend, extendedAsyncClientConfiguration));

String receiptHandle = "receipt-handle";
Message message = Message.builder()
.messageAttributes(ImmutableMap.of(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME, MessageAttributeValue.builder().build()))
.body(new PayloadS3Pointer(S3_BUCKET_NAME, "S3Key").toJson())
.receiptHandle(receiptHandle)
.build();

when(mockSqsBackend.receiveMessage(isA(ReceiveMessageRequest.class))).thenReturn(
CompletableFuture.completedFuture(ReceiveMessageResponse.builder().messages(message).build()));
doThrow(NoSuchKeyException.class).when(mockS3).getObject((GetObjectRequest) any(), any(AsyncResponseTransformer.class));

ReceiveMessageRequest messageRequest = ReceiveMessageRequest.builder().build();
try {
sqsAsyncExtended.receiveMessage(messageRequest).join();
fail("Expected exception after receiving NoSuchKeyException from S3 was not thrown.");
} catch (CompletionException e) {
assertEquals(NoSuchKeyException.class.getName(), e.getCause().getClass().getName());
verify(mockSqsBackend, never()).deleteMessage(any(DeleteMessageRequest.class));
}
}

private DeleteMessageBatchRequest generateLargeDeleteBatchRequest(List<String> originalReceiptHandles) {
List<DeleteMessageBatchRequestEntry> deleteEntries = IntStream.range(0, originalReceiptHandles.size())
.mapToObj(i -> DeleteMessageBatchRequestEntry.builder()
Expand Down
10 changes: 7 additions & 3 deletions src/test/java/com/amazon/sqs/javamessaging/AmazonSQSExtendedClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,11 @@
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.isA;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.mockStatic;
Expand Down Expand Up @@ -704,6 +706,7 @@ public void testReceiveMessage_when_ignorePayloadNotFound_then_messageWithPayloa
ExtendedClientConfiguration extendedClientConfiguration = new ExtendedClientConfiguration()
.withPayloadSupportEnabled(mockS3, S3_BUCKET_NAME)
.withIgnorePayloadNotFound(true);

SqsClient sqsExtended = spy(new AmazonSQSExtendedClient(mockSqsBackend, extendedClientConfiguration));

String receiptHandle = "receipt-handle";
Expand All @@ -714,17 +717,18 @@ public void testReceiveMessage_when_ignorePayloadNotFound_then_messageWithPayloa
.build();

when(mockSqsBackend.receiveMessage(isA(ReceiveMessageRequest.class))).thenReturn(ReceiveMessageResponse.builder().messages(message).build());

doThrow(NoSuchKeyException.class).when(mockS3).getObject(any(GetObjectRequest.class));

ReceiveMessageRequest messageRequest = ReceiveMessageRequest.builder().queueUrl(SQS_QUEUE_URL).build();
ReceiveMessageResponse receiveMessageResponse = sqsExtended.receiveMessage(messageRequest);

Assert.assertTrue(receiveMessageResponse.messages().isEmpty());
assertTrue(receiveMessageResponse.messages().isEmpty());

ArgumentCaptor<DeleteMessageRequest> deleteMessageRequestArgumentCaptor = ArgumentCaptor.forClass(DeleteMessageRequest.class);
verify(mockSqsBackend).deleteMessage(deleteMessageRequestArgumentCaptor.capture());
Assert.assertEquals(SQS_QUEUE_URL, deleteMessageRequestArgumentCaptor.getValue().queueUrl());
Assert.assertEquals(receiptHandle, deleteMessageRequestArgumentCaptor.getValue().receiptHandle());
assertEquals(SQS_QUEUE_URL, deleteMessageRequestArgumentCaptor.getValue().queueUrl());
assertEquals(receiptHandle, deleteMessageRequestArgumentCaptor.getValue().receiptHandle());
}

@Test
Expand Down