spring-cloud-gateway: Back-end websocket connection exception causes port not to be released(This is a very serious bug)

Describe the bug Please provide details of the problem, including the version of Spring Cloud that you are using.

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <!--<version>2.3.7.RELEASE</version>-->
    <version>2.4.2</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<spring-cloud.version>2020.0.0</spring-cloud.version>

Sample If possible, please provide a test case or sample application that reproduces the problem. This makes it much easier for us to diagnose the problem and to verify that we have fixed it.

Use Spring cloud gateway to proxy back-end websocket service When used normally, the port can be released

gateway port is 8082

var ws = new WebSocket("ws://10.15.105.4:8082/demo/ws/msgws")

ws.close();

When using a websocket address that does not exist, an exception occurs and the port will not be released

netstat -anoq | findstr "4096"
  TCP    10.15.105.4:4096       10.15.105.4:8081       ESTABLISHED     5992
  TCP    10.15.105.4:8081       10.15.105.4:4096       ESTABLISHED     11132
  TCP    0.0.0.0:4096           0.0.0.0:0              BOUND           5992

netstat -anoq |findstr "4096"
TCP    0.0.0.0:4096           0.0.0.0:0              BOUND           5992

var ws = new WebSocket("ws://10.15.105.4:8082/demo/ws/msgws333")

ws.close();

gateway exception：

2021-01-19 10:45:54.015  WARN 5992 --- [ctor-http-nio-4] r.netty.http.client.HttpClientConnect    : [id: 0x1e2c000c, L:/10.15.105.4:4096 - R:/10.15.105.4:8081] The connection observed an error

io.netty.handler.codec.http.websocketx.WebSocketClientHandshakeException: Invalid handshake response getStatus: 404 
	at io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker13.verify(WebSocketClientHandshaker13.java:272) ~[netty-codec-http-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker.finishHandshake(WebSocketClientHandshaker.java:302) ~[netty-codec-http-4.1.58.Final.jar:4.1.58.Final]
	at reactor.netty.http.client.WebsocketClientOperations.onInboundNext(WebsocketClientOperations.java:119) ~[reactor-netty-http-1.0.3.jar:1.0.3]
	at reactor.netty.channel.ChannelOperationsHandler.channelRead(ChannelOperationsHandler.java:94) ~[reactor-netty-core-1.0.3.jar:1.0.3]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.handler.codec.MessageToMessageDecoder.channelRead(MessageToMessageDecoder.java:103) ~[netty-codec-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.CombinedChannelDuplexHandler$DelegatingChannelHandlerContext.fireChannelRead(CombinedChannelDuplexHandler.java:436) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.handler.codec.ByteToMessageDecoder.fireChannelRead(ByteToMessageDecoder.java:324) ~[netty-codec-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.handler.codec.ByteToMessageDecoder.channelRead(ByteToMessageDecoder.java:296) ~[netty-codec-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.CombinedChannelDuplexHandler.channelRead(CombinedChannelDuplexHandler.java:251) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:357) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.DefaultChannelPipeline$HeadContext.channelRead(DefaultChannelPipeline.java:1410) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:379) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:365) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.DefaultChannelPipeline.fireChannelRead(DefaultChannelPipeline.java:919) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.nio.AbstractNioByteChannel$NioByteUnsafe.read(AbstractNioByteChannel.java:166) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.nio.NioEventLoop.processSelectedKey(NioEventLoop.java:719) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.nio.NioEventLoop.processSelectedKeysOptimized(NioEventLoop.java:655) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.nio.NioEventLoop.processSelectedKeys(NioEventLoop.java:581) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:493) ~[netty-transport-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.util.concurrent.SingleThreadEventExecutor$4.run(SingleThreadEventExecutor.java:989) ~[netty-common-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74) ~[netty-common-4.1.58.Final.jar:4.1.58.Final]
	at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30) ~[netty-common-4.1.58.Final.jar:4.1.58.Final]
	at java.base/java.lang.Thread.run(Thread.java:834) ~[na:na]

About this issue

Original URL
State: closed
Created 3 years ago
Comments: 18 (10 by maintainers)

Commits related to this issue

Ensure the connection is closed when websocket handshake fails Related to https://github.com/spring-cloud/spring-cloud-gateway/issues/2115 — committed to reactor/reactor-netty by violetagg 3 years ago
Ensure the connection is closed when websocket handshake fails (#1635) Related to https://github.com/spring-cloud/spring-cloud-gateway/issues/2115 — committed to reactor/reactor-netty by violetagg 3 years ago

Most upvoted comments

Hi, can you tell me in which version of spring cloud gateway we can see the correction of the issue? Thanks a lot Angelo

manang on Jun 14, 2021

You can expose the next bean to resolve such a case.

@Bean
    public HttpClientCustomizer terminateConnectionOnWsHandshakeErrorNettyClientCustomizer() {
        return (client) -> client.doOnResponseError((response, exception) -> {
            if (shouldDisposeWSConnection(response, exception)) {
                ((HttpOperations) response).channel().close();
            }
        });
    }

    private boolean shouldDisposeWSConnection(reactor.netty.http.client.HttpClientResponse response, Throwable exception) {
        return exception instanceof WebSocketClientHandshakeException
                && response.isWebsocket()
                && response instanceof HttpOperations;
    }

But it’ll be great if it’ll be resolved in https://github.com/reactor/reactor-netty

Fetsivalen on May 12, 2021