root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Use ConnectionLostException after heartbeat failures 

ConnectionLostException was applies only after the WebSocket library
notified us of a session close. However, read inactivity and heartbeat
send failures are also cases of the connection being lost rather than
closed intentionally.

This commit also ensures resetConnection is called after a heartbeat
write failure, consistent with other places where a transport error
is handled that implies the connection is lost.

See gh-32195
This commit is contained in:
rstoyanchev 2024-02-13 10:33:30 +00:00
parent 6a5953dca3
commit 6be0432e3d
3 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/ConnectionLostException.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -29,4 +29,8 @@ public class ConnectionLostException extends RuntimeException {
super(message);
}
public ConnectionLostException(String message, Throwable cause) {
super(message, cause);
}
}

17
spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/DefaultStompSession.java
View File

@ -714,9 +714,14 @@ public class DefaultStompSession implements ConnectionHandlingStompSession {
public void run() {
TcpConnection<byte[]> conn = connection;
if (conn != null) {
conn.sendAsync(HEARTBEAT).whenComplete((unused, throwable) -> {
if (throwable != null) {
handleFailure(throwable);
conn.sendAsync(HEARTBEAT).whenComplete((unused, ex) -> {
if (ex != null) {
String msg = "Heartbeat write failure. Closing connection in session id=" + sessionId + ".";
if (logger.isDebugEnabled()) {
logger.debug(msg);
}
resetConnection();
handleFailure(new ConnectionLostException(msg, ex));
}
});
}
@ -728,13 +733,13 @@ public class DefaultStompSession implements ConnectionHandlingStompSession {
@Override
public void run() {
String error = "Read inactivity. Closing connection in session id=" + sessionId + ".";
String msg = "Read inactivity. Closing connection in session id=" + sessionId + ".";
if (logger.isDebugEnabled()) {
logger.debug(error);
logger.debug(msg);
}
clientSideClose = true;
resetConnection();
handleFailure(new IllegalStateException(error));
handleFailure(new ConnectionLostException(msg));
}
}

2
spring-messaging/src/test/java/org/springframework/messaging/simp/stomp/DefaultStompSessionTests.java
View File

@ -221,7 +221,7 @@ public class DefaultStompSessionTests {
reset(this.sessionHandler);
readTask.run();
verify(this.sessionHandler).handleTransportError(same(this.session), any(IllegalStateException.class));
verify(this.sessionHandler).handleTransportError(same(this.session), any(ConnectionLostException.class));
verifyNoMoreInteractions(this.sessionHandler);
}