From 71ca9355dce5447395e057a6026bfde13940c486 Mon Sep 17 00:00:00 2001 From: James Roper Date: Fri, 17 Jul 2015 16:49:54 +1000 Subject: [PATCH] Send full response for unsupported websocket versions Motivation: WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse does not send a LastHttpContent, nor does it flush, and it doesn't send a content length. Modifications: Changed sendUnsupportedVersionResponse to send FullHttpResponse, to writeAndFlush, and to set a content length of 0. Also added a test for this method. Result: Upstream handlers will be able to determine the end of the response, the response will actually get written to the client, and the client will be able to determine the end of the response. --- .../WebSocketServerHandshakerFactory.java | 8 +-- .../WebSocketServerHandshakerFactoryTest.java | 52 +++++++++++++++++++ 2 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 codec-http/src/test/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactoryTest.java diff --git a/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.java b/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.java index c6f7b7a41d..141fcaa86b 100644 --- a/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.java +++ b/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.java @@ -18,8 +18,9 @@ package io.netty.handler.codec.http.websocketx; import io.netty.channel.Channel; import io.netty.channel.ChannelFuture; import io.netty.channel.ChannelPromise; -import io.netty.handler.codec.http.DefaultHttpResponse; +import io.netty.handler.codec.http.HttpHeaders; import io.netty.handler.codec.http.HttpHeaders.Names; +import io.netty.handler.codec.http.DefaultFullHttpResponse; import io.netty.handler.codec.http.HttpRequest; import io.netty.handler.codec.http.HttpResponse; import io.netty.handler.codec.http.HttpResponseStatus; @@ -128,10 +129,11 @@ public class WebSocketServerHandshakerFactory { * Return that we need cannot not support the web socket version */ public static ChannelFuture sendUnsupportedVersionResponse(Channel channel, ChannelPromise promise) { - HttpResponse res = new DefaultHttpResponse( + HttpResponse res = new DefaultFullHttpResponse( HttpVersion.HTTP_1_1, HttpResponseStatus.UPGRADE_REQUIRED); res.headers().set(Names.SEC_WEBSOCKET_VERSION, WebSocketVersion.V13.toHttpHeaderValue()); - return channel.write(res, promise); + HttpHeaders.setContentLength(res, 0); + return channel.writeAndFlush(res, promise); } } diff --git a/codec-http/src/test/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactoryTest.java b/codec-http/src/test/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactoryTest.java new file mode 100644 index 0000000000..a2f282f71f --- /dev/null +++ b/codec-http/src/test/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactoryTest.java @@ -0,0 +1,52 @@ +/* + * Copyright 2015 The Netty Project + * + * The Netty Project licenses this file to you under the Apache License, + * version 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ + +package io.netty.handler.codec.http.websocketx; + +import io.netty.channel.ChannelInboundHandlerAdapter; +import io.netty.channel.embedded.EmbeddedChannel; +import io.netty.handler.codec.http.FullHttpResponse; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpResponseStatus; +import io.netty.util.ReferenceCountUtil; +import org.junit.Test; + +import static org.junit.Assert.*; + +public class WebSocketServerHandshakerFactoryTest { + + @Test + public void testUnsupportedVersion() throws Exception { + EmbeddedChannel ch = new EmbeddedChannel(new ChannelInboundHandlerAdapter()); + WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(ch); + ch.runPendingTasks(); + Object msg = ch.readOutbound(); + + if (!(msg instanceof FullHttpResponse)) { + fail("Got wrong response " + msg); + } + FullHttpResponse response = (FullHttpResponse) msg; + + assertEquals(HttpResponseStatus.UPGRADE_REQUIRED, response.getStatus()); + assertEquals(WebSocketVersion.V13.toHttpHeaderValue(), + response.headers().get(HttpHeaders.Names.SEC_WEBSOCKET_VERSION)); + assertTrue(HttpHeaders.isContentLengthSet(response)); + assertEquals(0, HttpHeaders.getContentLength(response)); + + ReferenceCountUtil.release(response); + assertFalse(ch.finish()); + } +}