Skip to content

Added ability to retrieve message details in case of failed to get data from S3 #17

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added ability to retrieve message details in case of failed to get data from S3 #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 22 additions & 1 deletion src/Amazon.SQS.ExtendedClient.Tests/When_ExtendedClient_Receives.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
namespace Amazon.SQS.ExtendedClient.Tests
using Amazon.Runtime;

namespace Amazon.SQS.ExtendedClient.Tests
{
using System;
using System.IO;
Expand Down Expand Up @@ -75,5 +77,24 @@ public async Task Long_Message_Async_It_is_Read_From_S3()
Assert.AreEqual(originalBody, response.Messages[0].Body);
Assert.AreEqual(GenerateReceiptHandle(S3_BUCKET_NAME, messageKey, originalReceiptHadle), response.Messages[0].ReceiptHandle);
}

[Test]
public void Long_Message_Async_It_is_Not_Read_From_S3_Due_To_Resource_Missing()
{
var originalReceiptHandle = "_testrh_";
var messageKey = Guid.NewGuid().ToString("N");
var pointer = new MessageS3Pointer(S3_BUCKET_NAME, messageKey);
var message = new Message { Body = JsonConvert.SerializeObject(pointer), ReceiptHandle = originalReceiptHandle };
message.MessageAttributes.Add(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME, new MessageAttributeValue());

sqsMock.Setup(m => m.ReceiveMessageAsync(It.Is<ReceiveMessageRequest>(r => r.MessageAttributeNames.Contains(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME)), It.IsAny<CancellationToken>())).Returns(Task.FromResult(new ReceiveMessageResponse { Messages = Enumerable.Repeat(message, 1).ToList() }));
s3Mock.Setup(m => m.GetObjectAsync(It.IsAny<GetObjectRequest>(), It.IsAny<CancellationToken>())).Throws<AmazonServiceException>();
var exception = Assert.ThrowsAsync<AmazonClientException>(async () => await client.ReceiveMessageAsync(new ReceiveMessageRequest(SQS_QUEUE_NAME)));

s3Mock.Verify(s => s.GetObjectAsync(It.Is<GetObjectRequest>(r => r.BucketName == S3_BUCKET_NAME && r.Key == messageKey), It.IsAny<CancellationToken>()), Times.Once);
Assert.IsTrue(exception.Data.Contains(nameof(Message.ReceiptHandle)));
var receiptHandle = (string)exception.Data[nameof(Message.ReceiptHandle)];
Assert.AreEqual(originalReceiptHandle, receiptHandle);
}
}
}
21 changes: 15 additions & 6 deletions src/Amazon.SQS.ExtendedClient/AmazonSQSExtendedClient.Net45.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,20 @@ public override ReceiveMessageResponse ReceiveMessage(ReceiveMessageRequest rece
MessageAttributeValue largePayloadAttributeValue;
if (message.MessageAttributes.TryGetValue(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME, out largePayloadAttributeValue))
{
var messageS3Pointer = ReadMessageS3PointerFromJson(message.Body);
var originalMessageBody = GetTextFromS3(messageS3Pointer.S3BucketName, messageS3Pointer.S3Key);
message.Body = originalMessageBody;
message.ReceiptHandle = EmbedS3PointerInReceiptHandle(message.ReceiptHandle, messageS3Pointer.S3BucketName, messageS3Pointer.S3Key);
message.MessageAttributes.Remove(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME);
try
{
var messageS3Pointer = ReadMessageS3PointerFromJson(message.Body);
var originalMessageBody = GetTextFromS3(messageS3Pointer.S3BucketName, messageS3Pointer.S3Key);
message.Body = originalMessageBody;
message.ReceiptHandle = EmbedS3PointerInReceiptHandle(message.ReceiptHandle, messageS3Pointer.S3BucketName, messageS3Pointer.S3Key);
message.MessageAttributes.Remove(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME);
}
catch (AmazonClientException amazonClientException)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the same try/catch be used when the message is removed from the queue?
I mean, if one tries to delete non-existing s3 payload, will exception be raised?
If so, then it would be nice to have the same exception handling logics there.

{
amazonClientException.Data.Add(nameof(Message.MessageId), message.MessageId);
amazonClientException.Data.Add(nameof(Message.ReceiptHandle), message.ReceiptHandle);
throw;
}
}
}

Expand Down Expand Up @@ -267,5 +276,5 @@ private string GetTextFromS3(string s3BucketName, string s3Key)
}
}
#endif
}
}
}
19 changes: 14 additions & 5 deletions src/Amazon.SQS.ExtendedClient/AmazonSQSExtendedClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,20 @@ public AmazonSQSExtendedClient(IAmazonSQS sqsClient, ExtendedClientConfiguration
{
if (message.MessageAttributes.TryGetValue(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME, out _))
{
var messageS3Pointer = ReadMessageS3PointerFromJson(message.Body);
var originalMessageBody = await GetTextFromS3Async(messageS3Pointer.S3BucketName, messageS3Pointer.S3Key, cancellationToken).ConfigureAwait(false);
message.Body = originalMessageBody;
message.ReceiptHandle = EmbedS3PointerInReceiptHandle(message.ReceiptHandle, messageS3Pointer.S3BucketName, messageS3Pointer.S3Key);
message.MessageAttributes.Remove(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME);
try
{
var messageS3Pointer = ReadMessageS3PointerFromJson(message.Body);
var originalMessageBody = await GetTextFromS3Async(messageS3Pointer.S3BucketName, messageS3Pointer.S3Key, cancellationToken).ConfigureAwait(false);
message.Body = originalMessageBody;
message.ReceiptHandle = EmbedS3PointerInReceiptHandle(message.ReceiptHandle, messageS3Pointer.S3BucketName, messageS3Pointer.S3Key);
message.MessageAttributes.Remove(SQSExtendedClientConstants.RESERVED_ATTRIBUTE_NAME);
}
catch (AmazonClientException amazonClientException)
{
amazonClientException.Data.Add(nameof(Message.MessageId), message.MessageId);
amazonClientException.Data.Add(nameof(Message.ReceiptHandle), message.ReceiptHandle);
throw;
}
}
}

Expand Down