Skip to content

Parse multiple Sec-WebSocket-Protocol header values #37291

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
zemiles wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −10
Open

Parse multiple Sec-WebSocket-Protocol header values #37291

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
11 changes: 1 addition & 10 deletions spring-websocket/src/main/java/org/springframework/web/socket/WebSocketHttpHeaders.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,16 +160,7 @@ public void setSecWebSocketProtocol(List<String> secWebSocketProtocols) {
* @return the value of the header
*/
public List<String> getSecWebSocketProtocol() {
List<String> values = get(SEC_WEBSOCKET_PROTOCOL);
if (CollectionUtils.isEmpty(values)) {
return Collections.emptyList();
}
else if (values.size() == 1) {
return getValuesAsList(SEC_WEBSOCKET_PROTOCOL);
}
else {
return values;
}
return getValuesAsList(SEC_WEBSOCKET_PROTOCOL);
}

/**
Expand Down
9 changes: 9 additions & 0 deletions ...ocket/src/test/java/org/springframework/web/socket/handler/WebSocketHttpHeadersTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import static org.springframework.http.MediaType.TEXT_PLAIN;
import static org.springframework.http.MediaType.TEXT_PLAIN_VALUE;
import static org.springframework.web.socket.WebSocketHttpHeaders.SEC_WEBSOCKET_EXTENSIONS;
import static org.springframework.web.socket.WebSocketHttpHeaders.SEC_WEBSOCKET_PROTOCOL;

/**
* Tests for {@link WebSocketHttpHeaders}.
Expand Down Expand Up @@ -142,6 +143,14 @@ void parseWebSocketExtensions() {
assertThat(parsedExtensions).hasSize(3);
}

@Test // gh-37282
void getSecWebSocketProtocolWithMultipleHeaderValues() {
this.headers.add(SEC_WEBSOCKET_PROTOCOL, "foo");
this.headers.add(SEC_WEBSOCKET_PROTOCOL, "bar, baz");

assertThat(this.headers.getSecWebSocketProtocol()).containsExactly("foo", "bar", "baz");
}

@Test // gh-35792
void addAllViaWebSocketHttpHeadersApi() {
headers.add("green", "grape");
Expand Down