Skip to content

Refactor SendTo and Subscription Method Return Value Handlers to use … #36282

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

Closed
catturtle123 wants to merge 1 commit into from
+52 −39
Closed

Refactor SendTo and Subscription Method Return Value Handlers to use … #36282

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
5 changes: 3 additions & 2 deletions ...org/springframework/messaging/simp/annotation/support/SendToMethodReturnValueHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,9 +263,10 @@ private MessageHeaders createHeaders(@Nullable String sessionId, MethodParameter
getHeaderInitializer().initHeaders(headerAccessor);
}
if (inputMessage != null && this.headerFilter != null) {
inputMessage.getHeaders().forEach((name, value) -> {
SimpMessageHeaderAccessor inputAccessor = SimpMessageHeaderAccessor.wrap(inputMessage);
inputAccessor.toNativeHeaderMap().forEach((name, values) -> {
if (this.headerFilter.test(name)) {
headerAccessor.setHeader(name, value);
headerAccessor.setNativeHeaderValues(name, values);
}
});
}
Expand Down
5 changes: 3 additions & 2 deletions ...ringframework/messaging/simp/annotation/support/SubscriptionMethodReturnValueHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,10 @@ private MessageHeaders createHeaders(@Nullable String sessionId, String subscrip
getHeaderInitializer().initHeaders(accessor);
}
if (inputMessage != null && this.headerFilter != null) {
inputMessage.getHeaders().forEach((name, value) -> {
SimpMessageHeaderAccessor inputAccessor = SimpMessageHeaderAccessor.wrap(inputMessage);
inputAccessor.toNativeHeaderMap().forEach((name, values) -> {
if (this.headerFilter.test(name)) {
accessor.setHeader(name, value);
accessor.setNativeHeaderValues(name, values);
}
});
}
Expand Down
38 changes: 23 additions & 15 deletions ...pringframework/messaging/simp/annotation/support/SendToMethodReturnValueHandlerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,21 +298,26 @@ void sendToWithHeaderFilterSinglePredicate() throws Exception {
given(this.messageChannel.send(any(Message.class))).willReturn(true);

String sessionId = "sess1";
String headerName = "x-custom-header";
String headerValue = "custom-value";
Message<?> inputMessage = createMessage(sessionId, "sub1", null, null, null);
inputMessage = MessageBuilder.fromMessage(inputMessage).setHeader(headerName, headerValue).build();
String nativeHeaderName = "x-custom-header";
String nativeHeaderValue = "custom-value";

SimpMessageHeaderAccessor inputAccessor = SimpMessageHeaderAccessor.create();
inputAccessor.setSessionId(sessionId);
inputAccessor.setSubscriptionId("sub1");
inputAccessor.setNativeHeader(nativeHeaderName, nativeHeaderValue);
Message<?> inputMessage = MessageBuilder.createMessage(new byte[0], inputAccessor.getMessageHeaders());

SimpMessagingTemplate template = new SimpMessagingTemplate(this.messageChannel);
SendToMethodReturnValueHandler handler = new SendToMethodReturnValueHandler(template, true);
handler.addHeaderFilter(name -> name.equals(headerName));
handler.addHeaderFilter(name -> name.equals(nativeHeaderName));

handler.handleReturnValue(PAYLOAD, this.sendToReturnType, inputMessage);

verify(this.messageChannel, times(2)).send(this.messageCaptor.capture());
for (Message<?> sent : this.messageCaptor.getAllValues()) {
MessageHeaders headers = sent.getHeaders();
assertThat(headers.get(headerName)).isEqualTo(headerValue);
SimpMessageHeaderAccessor sentAccessor = MessageHeaderAccessor.getAccessor(sent, SimpMessageHeaderAccessor.class);
assertThat(sentAccessor).isNotNull();
assertThat(sentAccessor.getFirstNativeHeader(nativeHeaderName)).isEqualTo(nativeHeaderValue);
}
}

Expand All @@ -323,11 +328,13 @@ void sendToWithHeaderFilterMultiplePredicates() throws Exception {
String sessionId = "sess1";
String headerA = "x-header-a";
String headerB = "x-header-b";
Message<?> inputMessage = createMessage(sessionId, "sub1", null, null, null);
inputMessage = MessageBuilder.fromMessage(inputMessage)
.setHeader(headerA, "A-value")
.setHeader(headerB, "B-value")
.build();

SimpMessageHeaderAccessor inputAccessor = SimpMessageHeaderAccessor.create();
inputAccessor.setSessionId(sessionId);
inputAccessor.setSubscriptionId("sub1");
inputAccessor.setNativeHeader(headerA, "A-value");
inputAccessor.setNativeHeader(headerB, "B-value");
Message<?> inputMessage = MessageBuilder.createMessage(new byte[0], inputAccessor.getMessageHeaders());

SimpMessagingTemplate template = new SimpMessagingTemplate(this.messageChannel);
SendToMethodReturnValueHandler handler = new SendToMethodReturnValueHandler(template, true);
Expand All @@ -338,9 +345,10 @@ void sendToWithHeaderFilterMultiplePredicates() throws Exception {

verify(this.messageChannel, times(2)).send(this.messageCaptor.capture());
for (Message<?> sent : this.messageCaptor.getAllValues()) {
MessageHeaders headers = sent.getHeaders();
assertThat(headers.get(headerA)).isEqualTo("A-value");
assertThat(headers.get(headerB)).isEqualTo("B-value");
SimpMessageHeaderAccessor sentAccessor = MessageHeaderAccessor.getAccessor(sent, SimpMessageHeaderAccessor.class);
assertThat(sentAccessor).isNotNull();
assertThat(sentAccessor.getFirstNativeHeader(headerA)).isEqualTo("A-value");
assertThat(sentAccessor.getFirstNativeHeader(headerB)).isEqualTo("B-value");
}
}

Expand Down
43 changes: 23 additions & 20 deletions ...ramework/messaging/simp/annotation/support/SubscriptionMethodReturnValueHandlerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,26 +191,28 @@ void testHeaderFilterSinglePredicate() throws Exception {
String sessionId = "sess1";
String subscriptionId = "subs1";
String destination = "/dest";
String customHeaderName = "x-custom-header";
String customHeaderValue = "custom-value";
String nativeHeaderName = "x-custom-header";
String nativeHeaderValue = "custom-value";

Message<?> inputMessage = MessageBuilder.withPayload(PAYLOAD)
.setHeader(SimpMessageHeaderAccessor.SESSION_ID_HEADER, sessionId)
.setHeader(SimpMessageHeaderAccessor.SUBSCRIPTION_ID_HEADER, subscriptionId)
.setHeader(SimpMessageHeaderAccessor.DESTINATION_HEADER, destination)
.setHeader(customHeaderName, customHeaderValue)
.build();
SimpMessageHeaderAccessor inputAccessor = SimpMessageHeaderAccessor.create();
inputAccessor.setSessionId(sessionId);
inputAccessor.setSubscriptionId(subscriptionId);
inputAccessor.setDestination(destination);
inputAccessor.setNativeHeader(nativeHeaderName, nativeHeaderValue);
Message<?> inputMessage = MessageBuilder.createMessage(PAYLOAD, inputAccessor.getMessageHeaders());

MessageSendingOperations template = mock();
SubscriptionMethodReturnValueHandler handler = new SubscriptionMethodReturnValueHandler(template);
handler.addHeaderFilter(name -> name.equals(customHeaderName));
handler.addHeaderFilter(name -> name.equals(nativeHeaderName));

handler.handleReturnValue(PAYLOAD, this.subscribeEventReturnType, inputMessage);

ArgumentCaptor<MessageHeaders> captor = ArgumentCaptor.forClass(MessageHeaders.class);
verify(template).convertAndSend(eq(destination), eq(PAYLOAD), captor.capture());

assertThat(captor.getValue().get(customHeaderName)).isEqualTo(customHeaderValue);
SimpMessageHeaderAccessor sentAccessor = MessageHeaderAccessor.getAccessor(captor.getValue(), SimpMessageHeaderAccessor.class);
assertThat(sentAccessor).isNotNull();
assertThat(sentAccessor.getFirstNativeHeader(nativeHeaderName)).isEqualTo(nativeHeaderValue);
}

@Test
Expand All @@ -221,13 +223,13 @@ void testHeaderFilterMultiplePredicates() throws Exception {
String headerA = "x-header-a";
String headerB = "x-header-b";

Message<?> inputMessage = MessageBuilder.withPayload(PAYLOAD)
.setHeader(SimpMessageHeaderAccessor.SESSION_ID_HEADER, sessionId)
.setHeader(SimpMessageHeaderAccessor.SUBSCRIPTION_ID_HEADER, subscriptionId)
.setHeader(SimpMessageHeaderAccessor.DESTINATION_HEADER, destination)
.setHeader(headerA, "A-value")
.setHeader(headerB, "B-value")
.build();
SimpMessageHeaderAccessor inputAccessor = SimpMessageHeaderAccessor.create();
inputAccessor.setSessionId(sessionId);
inputAccessor.setSubscriptionId(subscriptionId);
inputAccessor.setDestination(destination);
inputAccessor.setNativeHeader(headerA, "A-value");
inputAccessor.setNativeHeader(headerB, "B-value");
Message<?> inputMessage = MessageBuilder.createMessage(PAYLOAD, inputAccessor.getMessageHeaders());

MessageSendingOperations template = mock();
SubscriptionMethodReturnValueHandler handler = new SubscriptionMethodReturnValueHandler(template);
Expand All @@ -239,9 +241,10 @@ void testHeaderFilterMultiplePredicates() throws Exception {
ArgumentCaptor<MessageHeaders> captor = ArgumentCaptor.forClass(MessageHeaders.class);
verify(template).convertAndSend(eq(destination), eq(PAYLOAD), captor.capture());

MessageHeaders sentHeaders = captor.getValue();
assertThat(sentHeaders.get(headerA)).isEqualTo("A-value");
assertThat(sentHeaders.get(headerB)).isEqualTo("B-value");
SimpMessageHeaderAccessor sentAccessor = MessageHeaderAccessor.getAccessor(captor.getValue(), SimpMessageHeaderAccessor.class);
assertThat(sentAccessor).isNotNull();
assertThat(sentAccessor.getFirstNativeHeader(headerA)).isEqualTo("A-value");
assertThat(sentAccessor.getFirstNativeHeader(headerB)).isEqualTo("B-value");
}

private Message<?> createInputMessage(String sessId, String subsId, String dest, Principal principal) {
Expand Down