WebSocketServerHandshaker::handshake returns a Future that is never completed if HTTP request is not a FullHttpRequest

[hoat4]

Expected behavior

The FutureListener should be invoked when the WS handshake is done.

Actual behavior

The handshake completes successfully, but the FutureListener associated with handshaking is not invoked (but the next ChannelHandlerAdapter receives the WS message correctly).

Steps to reproduce

Run the code below. If you connect to it, the "Handshake done" string won't print, but the received messages will be printed.

Minimal yet complete reproducer code (or URL to code)

public static void main(String[] args) {
    ServerBootstrap b = new ServerBootstrap().
            group(new MultithreadEventLoopGroup(NioHandler.newFactory()), new MultithreadEventLoopGroup(NioHandler.newFactory())).
            channel(NioServerSocketChannel.class).
            childHandler(new ChannelInitializer<SocketChannel>() {

                @Override
                protected void initChannel(SocketChannel ch) {
                    ChannelPipeline pipeline = ch.pipeline();
                    pipeline.addLast("httpServerCodec", new HttpServerCodec());
                    pipeline.addLast("httpHandler", new HttpServerHandler());
                }
            });

    b.bind(5004);
}

private static class HttpServerHandler extends ChannelHandlerAdapter {

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) {
        HttpObject httpObject = (HttpObject) msg;

        if (httpObject instanceof HttpRequest) {
            HttpRequest req = (HttpRequest) msg;

            ctx.pipeline().replace(this, "websocketHandler", new ChannelHandlerAdapter() {

                @Override
                public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
                    System.out.println("Received: "+msg);
                }
            });
            String wsURL = "ws://" + req.headers().get(HttpHeaderNames.HOST) + req.uri();
            WebSocketServerHandshakerFactory wsFactory =
                    new WebSocketServerHandshakerFactory(wsURL, null, true);
            WebSocketServerHandshaker handshaker = wsFactory.newHandshaker(req);
            if (handshaker == null) {
                WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(ctx.channel());
            } else {
                handshaker.handshake(ctx.channel(), req).addListener((Future<?> future) -> {
                    System.out.println("Handshake done");
                });
            }
        }
    }
}

Netty version

5.0.0.Alpha4

JVM version (e.g. java -version)

17

OS version (e.g. uname -a)

Windows 11

[hoat4]

A workaround is to put a HttpObjectAggregator to the channel's initial pipeline. If it is added in the channel initializer, then the handshaking future will be completed after the handshake is done.

[amizurov]

@hoat4 Hi, i'll take a look.

[normanmaurer]

@amizurov what is the status of this one ?

[amizurov]

@amizurov what is the status of this one ?

I think this one we can close, but we have similar issue for client handshaker i'll prepare PR. @hoat4 any concerns ?