Fine-tuned logging of WebSocket close exceptions

Issue: SPR-16409

Author: jhoeller

spring-websocket/src/main/java/org/springframework/web/socket/adapter/jetty/JettyWebSocketHandlerAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -119,8 +119,8 @@ public void onWebSocketClose(int statusCode, String reason) {
 			this.webSocketHandler.afterConnectionClosed(this.wsSession, closeStatus);
 		}
 		catch (Throwable ex) {
-			if (logger.isErrorEnabled()) {
-				logger.error("Unhandled error for " + this.wsSession, ex);
+			if (logger.isWarnEnabled()) {
+				logger.warn("Unhandled exception after connection closed for " + this, ex);
 			}
 		}
 	}

spring-websocket/src/main/java/org/springframework/web/socket/adapter/standard/StandardWebSocketHandlerAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -141,8 +141,8 @@ public void onClose(javax.websocket.Session session, CloseReason reason) {
 			this.handler.afterConnectionClosed(this.wsSession, closeStatus);
 		}
 		catch (Throwable ex) {
-			if (logger.isErrorEnabled()) {
-				logger.error("Unhandled error for " + this.wsSession, ex);
+			if (logger.isWarnEnabled()) {
+				logger.warn("Unhandled on-close exception for " + this.wsSession, ex);
 			}
 		}
 	}

spring-websocket/src/main/java/org/springframework/web/socket/handler/ExceptionWebSocketHandlerDecorator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -78,8 +78,8 @@ public void afterConnectionClosed(WebSocketSession session, CloseStatus closeSta
 			getDelegate().afterConnectionClosed(session, closeStatus);
 		}
 		catch (Throwable ex) {
-			if (logger.isErrorEnabled()) {
-				logger.error("Unhandled error for " + this, ex);
+			if (logger.isWarnEnabled()) {
+				logger.warn("Unhandled exception after connection closed for " + this, ex);
 			}
 		}
 	}

spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolWebSocketHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -60,6 +60,7 @@
  * sub-protocol handler to send messages from the application back to the client.
  *
  * @author Rossen Stoyanchev
+ * @author Juergen Hoeller
  * @author Andy Wilkinson
  * @author Artem Bilan
  * @since 4.0
@@ -152,8 +153,8 @@ public void addProtocolHandler(SubProtocolHandler handler) {
 		for (String protocol : protocols) {
 			SubProtocolHandler replaced = this.protocolHandlerLookup.put(protocol, handler);
 			if (replaced != null && replaced != handler) {
-				throw new IllegalStateException("Can't map " + handler +
-						" to protocol '" + protocol + "'. Already mapped to " + replaced + ".");
+				throw new IllegalStateException("Cannot map " + handler +
+						" to protocol '" + protocol + "': already mapped to " + replaced + ".");
 			}
 		}
 		this.protocolHandlers.add(handler);
@@ -260,8 +261,8 @@ public final void stop() {
 					holder.getSession().close(CloseStatus.GOING_AWAY);
 				}
 				catch (Throwable ex) {
-					if (logger.isErrorEnabled()) {
-						logger.error("Failed to close '" + holder.getSession() + "': " + ex);
+					if (logger.isWarnEnabled()) {
+						logger.warn("Failed to close '" + holder.getSession() + "': " + ex);
 					}
 				}
 			}
@@ -321,7 +322,7 @@ public void handleMessage(Message<?> message) throws MessagingException {
 		String sessionId = resolveSessionId(message);
 		if (sessionId == null) {
 			if (logger.isErrorEnabled()) {
-				logger.error("Couldn't find session id in " + message);
+				logger.error("Could not find session id in " + message);
 			}
 			return;
 		}
@@ -400,8 +401,8 @@ protected final SubProtocolHandler findProtocolHandler(WebSocketSession session)
 		}
 		catch (Exception ex) {
 			// Shouldn't happen
-			logger.error("Failed to obtain session.getAcceptedProtocol(). " +
-					"Will use the default protocol handler (if configured).", ex);
+			logger.error("Failed to obtain session.getAcceptedProtocol(): " +
+					"will use the default protocol handler (if configured).", ex);
 		}
 
 		SubProtocolHandler handler;
@@ -469,17 +470,17 @@ private void checkSessions() {
 						continue;
 					}
 					WebSocketSession session = holder.getSession();
-					if (logger.isErrorEnabled()) {
-						logger.error("No messages received after " + timeSinceCreated + " ms. " +
+					if (logger.isInfoEnabled()) {
+						logger.info("No messages received after " + timeSinceCreated + " ms. " +
 								"Closing " + holder.getSession() + ".");
 					}
 					try {
 						this.stats.incrementNoMessagesReceivedCount();
 						session.close(CloseStatus.SESSION_NOT_RELIABLE);
 					}
 					catch (Throwable ex) {
-						if (logger.isErrorEnabled()) {
-							logger.error("Failure while closing " + session, ex);
+						if (logger.isWarnEnabled()) {
+							logger.warn("Failed to close unreliable " + session, ex);
 						}
 					}
 				}