Skip to content

Commit 56cb5ec

Browse files
committed
Rename AWSMessageId to RawMessageId for consistency
1 parent dce5a94 commit 56cb5ec

File tree

3 files changed

+27
-31
lines changed

3 files changed

+27
-31
lines changed

spring-cloud-aws-sqs/src/main/java/io/awspring/cloud/sqs/MessageHeaderUtils.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -153,21 +153,21 @@ public static <T> Message<T> removeHeaderIfPresent(Message<T> message, String ke
153153
}
154154

155155
/**
156-
* Return the AWS message ID, falling back to Spring message ID if not present.
156+
* Return the raw provider message ID, falling back to Spring message ID if not present.
157157
* @param message the message.
158-
* @return the AWS ID or Spring ID.
158+
* @return the raw provider ID or Spring ID.
159159
*/
160-
public static String getAwsMessageId(Message<?> message) {
161-
String awsMessageId = message.getHeaders().get(SqsHeaders.SQS_AWS_MESSAGE_ID_HEADER, String.class);
162-
return awsMessageId != null ? awsMessageId : getId(message);
160+
public static String getRawMessageId(Message<?> message) {
161+
String rawMessageId = message.getHeaders().get(SqsHeaders.SQS_RAW_MESSAGE_ID_HEADER, String.class);
162+
return rawMessageId != null ? rawMessageId : getId(message);
163163
}
164164

165165
/**
166-
* Return the messages' AWS ID as a concatenated {@link String}.
166+
* Return the messages' raw provider IDs as a concatenated {@link String}.
167167
* @param messages the messages.
168-
* @return the AWS IDs.
168+
* @return the raw provider IDs.
169169
*/
170-
public static <T> String getAwsMessageId(Collection<Message<T>> messages) {
171-
return messages.stream().map(MessageHeaderUtils::getAwsMessageId).collect(Collectors.joining("; "));
170+
public static <T> String getRawMessageId(Collection<Message<T>> messages) {
171+
return messages.stream().map(MessageHeaderUtils::getRawMessageId).collect(Collectors.joining("; "));
172172
}
173173
}

spring-cloud-aws-sqs/src/main/java/io/awspring/cloud/sqs/listener/SqsHeaders.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ private SqsHeaders() {
9090
public static final String SQS_DEFAULT_TYPE_HEADER = "JavaType";
9191

9292
/**
93-
* Header for the original AWS MessageId when not using UUID conversion.
93+
* Header for the raw provider message ID when not using UUID conversion.
9494
*/
95-
public static final String SQS_AWS_MESSAGE_ID_HEADER = SQS_HEADER_PREFIX + "AWSMessageId";
95+
public static final String SQS_RAW_MESSAGE_ID_HEADER = SQS_HEADER_PREFIX + "RawMessageId";
9696

9797
public static class MessageSystemAttributes {
9898

spring-cloud-aws-sqs/src/test/java/io/awspring/cloud/sqs/MessageHeaderUtilsTest.java

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,12 @@
1818
import static org.assertj.core.api.Assertions.assertThat;
1919

2020
import io.awspring.cloud.sqs.listener.SqsHeaders;
21+
import java.util.Collection;
22+
import java.util.List;
2123
import org.junit.jupiter.api.Test;
2224
import org.springframework.messaging.Message;
2325
import org.springframework.messaging.support.MessageBuilder;
2426

25-
import java.util.Collection;
26-
import java.util.List;
27-
2827
/**
2928
* Tests for {@link MessageHeaderUtils}.
3029
*
@@ -100,52 +99,49 @@ void shouldPreserveOtherHeaders() {
10099
}
101100

102101
@Test
103-
void shouldReturnAwsMessageIdWhenHeaderPresent() {
102+
void shouldReturnRawMessageIdWhenHeaderPresent() {
104103
// given
105-
String awsMessageId = "92898073-7bd6a160-5797b060-54a7e539";
104+
String rawMessageId = "92898073-7bd6a160-5797b060-54a7e539";
106105
Message<String> message = MessageBuilder.withPayload("test-payload")
107-
.setHeader(SqsHeaders.SQS_AWS_MESSAGE_ID_HEADER, awsMessageId)
108-
.build();
106+
.setHeader(SqsHeaders.SQS_RAW_MESSAGE_ID_HEADER, rawMessageId).build();
109107

110108
// when
111-
String result = MessageHeaderUtils.getAwsMessageId(message);
109+
String result = MessageHeaderUtils.getRawMessageId(message);
112110

113111
// then
114-
assertThat(result).isEqualTo(awsMessageId);
112+
assertThat(result).isEqualTo(rawMessageId);
115113
}
116114

117115
@Test
118-
void shouldFallbackToSpringMessageIdWhenAwsHeaderNotPresent() {
116+
void shouldFallbackToSpringMessageIdWhenRawHeaderNotPresent() {
119117
// given
120118
Message<String> message = MessageBuilder.withPayload("test-payload").build();
121119
String expectedId = message.getHeaders().getId().toString();
122120

123121
// when
124-
String result = MessageHeaderUtils.getAwsMessageId(message);
122+
String result = MessageHeaderUtils.getRawMessageId(message);
125123

126124
// then
127125
assertThat(result).isEqualTo(expectedId);
128126
}
129127

130128
@Test
131-
void shouldConcatenateAwsMessageIdsFromCollection() {
129+
void shouldConcatenateRawMessageIdsFromCollection() {
132130
// given
133-
String awsMessageId1 = "aws-id-1";
134-
String awsMessageId2 = "aws-id-2";
131+
String rawMessageId1 = "raw-id-1";
132+
String rawMessageId2 = "raw-id-2";
135133

136134
Message<String> message1 = MessageBuilder.withPayload("payload1")
137-
.setHeader(SqsHeaders.SQS_AWS_MESSAGE_ID_HEADER, awsMessageId1)
138-
.build();
135+
.setHeader(SqsHeaders.SQS_RAW_MESSAGE_ID_HEADER, rawMessageId1).build();
139136
Message<String> message2 = MessageBuilder.withPayload("payload2")
140-
.setHeader(SqsHeaders.SQS_AWS_MESSAGE_ID_HEADER, awsMessageId2)
141-
.build();
137+
.setHeader(SqsHeaders.SQS_RAW_MESSAGE_ID_HEADER, rawMessageId2).build();
142138

143139
Collection<Message<String>> messages = List.of(message1, message2);
144140

145141
// when
146-
String result = MessageHeaderUtils.getAwsMessageId(messages);
142+
String result = MessageHeaderUtils.getRawMessageId(messages);
147143

148144
// then
149-
assertThat(result).isEqualTo("aws-id-1; aws-id-2");
145+
assertThat(result).isEqualTo("raw-id-1; raw-id-2");
150146
}
151147
}

0 commit comments

Comments
 (0)