Better handling for AsyncRequestTimeoutException

Avoid call to sendError when response is committed and log a short
error message instead.

Issue: SPR-14739

Author: rstoyanchev

spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.java

@@ -18,6 +18,8 @@
 
 import java.util.List;
 import java.util.Set;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -43,6 +45,7 @@
 import org.springframework.web.bind.ServletRequestBindingException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.context.request.ServletWebRequest;
 import org.springframework.web.context.request.WebRequest;
 import org.springframework.web.context.request.async.AsyncRequestTimeoutException;
 import org.springframework.web.multipart.support.MissingServletRequestPartException;
@@ -439,14 +442,23 @@ protected ResponseEntity<Object> handleNoHandlerFoundException(
 	 * @param ex the exception
 	 * @param headers the headers to be written to the response
 	 * @param status the selected response status
-	 * @param request the current request
+	 * @param webRequest the current request
 	 * @return a {@code ResponseEntity} instance
 	 * @since 4.2.8
 	 */
 	protected ResponseEntity<Object> handleAsyncRequestTimeoutException(
-			AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
-
-		return handleExceptionInternal(ex, null, headers, status, request);
+			AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatus status, WebRequest webRequest) {
+
+		if (webRequest instanceof ServletWebRequest) {
+			ServletWebRequest servletRequest = (ServletWebRequest) webRequest;
+			HttpServletRequest request = servletRequest.getNativeRequest(HttpServletRequest.class);
+			HttpServletResponse response = servletRequest.getNativeResponse(HttpServletResponse.class);
+			if (response.isCommitted()) {
+				logger.error("Async timeout for " + request.getMethod() + " [" +  request.getRequestURI() + "]");
+				return null;
+			}
+		}
+		return handleExceptionInternal(ex, null, headers, status, webRequest);
 	}
 
 }

spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolver.java

@@ -469,7 +469,12 @@ protected ModelAndView handleNoHandlerFoundException(NoHandlerFoundException ex,
 	protected ModelAndView handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex,
 			HttpServletRequest request, HttpServletResponse response, Object handler) throws IOException {
 
-		response.sendError(HttpServletResponse.SC_SERVICE_UNAVAILABLE);
+		if (!response.isCommitted()) {
+			response.sendError(HttpServletResponse.SC_SERVICE_UNAVAILABLE);
+		}
+		else if (logger.isErrorEnabled()) {
+			logger.error("Async timeout for " + request.getMethod() + " [" + request.getRequestURI() + "]");
+		}
 		return new ModelAndView();
 	}
 
@@ -481,6 +486,7 @@ protected ModelAndView handleAsyncRequestTimeoutException(AsyncRequestTimeoutExc
 	protected void sendServerError(Exception ex, HttpServletRequest request, HttpServletResponse response)
 			throws IOException {
 
+
 		request.setAttribute("javax.servlet.error.exception", ex);
 		response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
 	}