andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge WebSocket extensions, close #10792 (#10956)

Browse Source 
Motivation:

We currently append extensions to the user defined "sec-websocket-extensions" headers. This can cause duplicated entries.

Modifications:

* Replace existing `WebSocketExtensionUtil#appendExtension` private helper with a new `computeMergeExtensionsHeaderValue`. User defined parameters have higher precedence.
* Add tests (existing method wasn't tested)
* Reuse code for both client and server side (code was duplicated).

Result:

No more duplicated entries when user defined extensions overlap with the ones Netty generated.
This commit is contained in:
Stephane Landelle 2021-01-22 08:15:56 +01:00 committed by GitHub
parent f54bf7aeb0
commit ccd01934f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 104 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
codec-http/src/main/java/io/netty/handler/codec/http/websocketx/extensions/WebSocketClientExtensionHandler.java
View File

@ -63,14 +63,15 @@ public class WebSocketClientExtensionHandler extends ChannelDuplexHandler {
if (msg instanceof HttpRequest && WebSocketExtensionUtil.isWebsocketUpgrade(((HttpRequest) msg).headers())) {
HttpRequest request = (HttpRequest) msg;
String headerValue = request.headers().getAsString(HttpHeaderNames.SEC_WEBSOCKET_EXTENSIONS);
List<WebSocketExtensionData> extraExtensions =
new ArrayList<WebSocketExtensionData>(extensionHandshakers.size());
for (WebSocketClientExtensionHandshaker extensionHandshaker : extensionHandshakers) {
WebSocketExtensionData extensionData = extensionHandshaker.newRequestData();
headerValue = WebSocketExtensionUtil.appendExtension(headerValue,
extensionData.name(), extensionData.parameters());
extraExtensions.add(extensionHandshaker.newRequestData());
}
String newHeaderValue = WebSocketExtensionUtil
.computeMergeExtensionsHeaderValue(headerValue, extraExtensions);
request.headers().set(HttpHeaderNames.SEC_WEBSOCKET_EXTENSIONS, headerValue);
request.headers().set(HttpHeaderNames.SEC_WEBSOCKET_EXTENSIONS, newHeaderValue);
}
super.write(ctx, msg, promise);

60
codec-http/src/main/java/io/netty/handler/codec/http/websocketx/extensions/WebSocketExtensionUtil.java
View File

@ -72,25 +72,53 @@ public final class WebSocketExtensionUtil {
}
}
static String appendExtension(String currentHeaderValue, String extensionName,
Map<String, String> extensionParameters) {
static String computeMergeExtensionsHeaderValue(String userDefinedHeaderValue,
List<WebSocketExtensionData> extraExtensions) {
List<WebSocketExtensionData> userDefinedExtensions =
userDefinedHeaderValue != null ?
extractExtensions(userDefinedHeaderValue) :
Collections.<WebSocketExtensionData>emptyList();
StringBuilder newHeaderValue = new StringBuilder(
currentHeaderValue != null ? currentHeaderValue.length() : extensionName.length() + 1);
if (currentHeaderValue != null && !currentHeaderValue.trim().isEmpty()) {
newHeaderValue.append(currentHeaderValue);
newHeaderValue.append(EXTENSION_SEPARATOR);
}
newHeaderValue.append(extensionName);
for (Entry<String, String> extensionParameter : extensionParameters.entrySet()) {
newHeaderValue.append(PARAMETER_SEPARATOR);
newHeaderValue.append(extensionParameter.getKey());
if (extensionParameter.getValue() != null) {
newHeaderValue.append(PARAMETER_EQUAL);
newHeaderValue.append(extensionParameter.getValue());
for (WebSocketExtensionData userDefined: userDefinedExtensions) {
WebSocketExtensionData matchingExtra = null;
int i;
for (i = 0; i < extraExtensions.size(); i ++) {
WebSocketExtensionData extra = extraExtensions.get(i);
if (extra.name().equals(userDefined.name())) {
matchingExtra = extra;
break;
}
}
return newHeaderValue.toString();
if (matchingExtra == null) {
extraExtensions.add(userDefined);
} else {
// merge with higher precedence to user defined parameters
Map<String, String> mergedParameters = new HashMap<String, String>(matchingExtra.parameters());
mergedParameters.putAll(userDefined.parameters());
extraExtensions.set(i, new WebSocketExtensionData(matchingExtra.name(), mergedParameters));
}
}
StringBuilder sb = new StringBuilder(150);
for (WebSocketExtensionData data: extraExtensions) {
sb.append(data.name());
for (Entry<String, String> parameter : data.parameters().entrySet()) {
sb.append(PARAMETER_SEPARATOR);
sb.append(parameter.getKey());
if (parameter.getValue() != null) {
sb.append(PARAMETER_EQUAL);
sb.append(parameter.getValue());
}
}
sb.append(EXTENSION_SEPARATOR);
}
if (!extraExtensions.isEmpty()) {
sb.setLength(sb.length() - EXTENSION_SEPARATOR.length());
}
return sb.toString();
}
private WebSocketExtensionUtil() {

14
codec-http/src/main/java/io/netty/handler/codec/http/websocketx/extensions/WebSocketServerExtensionHandler.java
View File

@ -124,13 +124,13 @@ public class WebSocketServerExtensionHandler extends ChannelDuplexHandler {
if (validExtensions != null) {
String headerValue = headers.getAsString(HttpHeaderNames.SEC_WEBSOCKET_EXTENSIONS);
List<WebSocketExtensionData> extraExtensions =
new ArrayList<WebSocketExtensionData>(extensionHandshakers.size());
for (WebSocketServerExtension extension : validExtensions) {
WebSocketExtensionData extensionData = extension.newReponseData();
headerValue = WebSocketExtensionUtil.appendExtension(headerValue,
extensionData.name(),
extensionData.parameters());
extraExtensions.add(extension.newReponseData());
}
String newHeaderValue = WebSocketExtensionUtil
.computeMergeExtensionsHeaderValue(headerValue, extraExtensions);
promise.addListener(new ChannelFutureListener() {
@Override
public void operationComplete(ChannelFuture future) {
@ -147,8 +147,8 @@ public class WebSocketServerExtensionHandler extends ChannelDuplexHandler {
}
});
if (headerValue != null) {
headers.set(HttpHeaderNames.SEC_WEBSOCKET_EXTENSIONS, headerValue);
if (newHeaderValue != null) {
headers.set(HttpHeaderNames.SEC_WEBSOCKET_EXTENSIONS, newHeaderValue);
}
}

50
codec-http/src/test/java/io/netty/handler/codec/http/websocketx/extensions/WebSocketExtensionUtilTest.java
View File

@ -21,19 +21,63 @@ import io.netty.handler.codec.http.HttpHeaderValues;
import io.netty.handler.codec.http.HttpHeaders;
import org.junit.Test;
import java.util.List;
import static org.junit.Assert.*;
import static io.netty.handler.codec.http.websocketx.extensions.WebSocketExtensionUtil.*;
public class WebSocketExtensionUtilTest {
@Test
public void testIsWebsocketUpgrade() {
HttpHeaders headers = new DefaultHttpHeaders();
assertFalse(WebSocketExtensionUtil.isWebsocketUpgrade(headers));
assertFalse(isWebsocketUpgrade(headers));
headers.add(HttpHeaderNames.UPGRADE, HttpHeaderValues.WEBSOCKET);
assertFalse(WebSocketExtensionUtil.isWebsocketUpgrade(headers));
assertFalse(isWebsocketUpgrade(headers));
headers.add(HttpHeaderNames.CONNECTION, "Keep-Alive, Upgrade");
assertTrue(WebSocketExtensionUtil.isWebsocketUpgrade(headers));
assertTrue(isWebsocketUpgrade(headers));
}
@Test
public void computeMergeExtensionsHeaderValueWhenNoUserDefinedHeader() {
List<WebSocketExtensionData> extras = extractExtensions("permessage-deflate; client_max_window_bits," +
"permessage-deflate; client_no_context_takeover; client_max_window_bits," +
"deflate-frame," +
"x-webkit-deflate-frame");
String newHeaderValue = computeMergeExtensionsHeaderValue(null, extras);
assertEquals("permessage-deflate;client_max_window_bits," +
"permessage-deflate;client_no_context_takeover;client_max_window_bits," +
"deflate-frame," +
"x-webkit-deflate-frame", newHeaderValue);
}
@Test
public void computeMergeExtensionsHeaderValueWhenNoConflictingUserDefinedHeader() {
List<WebSocketExtensionData> extras = extractExtensions("permessage-deflate; client_max_window_bits," +
"permessage-deflate; client_no_context_takeover; client_max_window_bits," +
"deflate-frame," +
"x-webkit-deflate-frame");
String newHeaderValue = computeMergeExtensionsHeaderValue("foo, bar", extras);
assertEquals("permessage-deflate;client_max_window_bits," +
"permessage-deflate;client_no_context_takeover;client_max_window_bits," +
"deflate-frame," +
"x-webkit-deflate-frame," +
"foo," +
"bar", newHeaderValue);
}
@Test
public void computeMergeExtensionsHeaderValueWhenConflictingUserDefinedHeader() {
List<WebSocketExtensionData> extras = extractExtensions("permessage-deflate; client_max_window_bits," +
"permessage-deflate; client_no_context_takeover; client_max_window_bits," +
"deflate-frame," +
"x-webkit-deflate-frame");
String newHeaderValue = computeMergeExtensionsHeaderValue("permessage-deflate; client_max_window_bits", extras);
assertEquals("permessage-deflate;client_max_window_bits," +
"permessage-deflate;client_no_context_takeover;client_max_window_bits," +
"deflate-frame," +
"x-webkit-deflate-frame", newHeaderValue);
}
}