Avoid locking in WebSocket session "close" callback

rstoyanchev · rstoyanchev · commit 31df09013280 · 2016-11-23T21:02:54.000-05:00
When processing a "close" notification from the server make an effort
to cancel any outstanding heartbeat but avoid going as far as acquiring
the responseLock since the server itself may already hold a lock of its
own leading to a potential deadlock.

The heartbeat task is now also further protected with an isClosed()
check in case the heartbeat does not get cancelled in a concurrent
scenario.

Issue: SPR-14917
diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/session/AbstractSockJsSession.java b/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/session/AbstractSockJsSession.java
@@ -396,7 +396,12 @@ public final void delegateConnectionClosed(CloseStatus status) throws Exception
 		if (!isClosed()) {
 			try {
 				updateLastActiveTime();
-				cancelHeartbeat();
+				// Avoid cancelHeartbeat() and responseLock within server "close" callback
+				ScheduledFuture<?> future = this.heartbeatFuture;
+				if (future != null) {
+					this.heartbeatFuture = null;
+					future.cancel(false);
+				}
 			}
 			finally {
 				this.state = State.CLOSED;
@@ -446,7 +451,7 @@ private class HeartbeatTask implements Runnable {
 		@Override
 		public void run() {
 			synchronized (responseLock) {
-				if (!this.expired) {
+				if (!this.expired && !isClosed()) {
 					try {
 						sendHeartbeat();
 					}
diff --git a/spring-websocket/src/test/java/org/springframework/web/socket/sockjs/transport/session/SockJsSessionTests.java b/spring-websocket/src/test/java/org/springframework/web/socket/sockjs/transport/session/SockJsSessionTests.java
@@ -144,7 +144,6 @@ public void delegateConnectionClosed() throws Exception {
 
 		assertClosed();
 		assertEquals(1, this.session.getNumberOfLastActiveTimeUpdates());
-		assertTrue(this.session.didCancelHeartbeat());
 		verify(this.webSocketHandler).afterConnectionClosed(this.session, CloseStatus.GOING_AWAY);
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,6 @@ public void delegateConnectionClosed() throws Exception {`
`144`	`144`
`145`	`145`	`assertClosed();`
`146`	`146`	`assertEquals(1, this.session.getNumberOfLastActiveTimeUpdates());`
`147`		`- assertTrue(this.session.didCancelHeartbeat());`
`148`	`147`	`verify(this.webSocketHandler).afterConnectionClosed(this.session, CloseStatus.GOING_AWAY);`
`149`	`148`	`}`
`150`	`149`