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

Only access parameters in WebRequestTraceFilter when they are included 

Previously, WebRequestTraceFilter would call request.getParameterMap()
before deciding whether or not the parameters should be included in
the trace. For a POST request, this had the unwanted side-effect
of always reading the request body.

This commit updates WebRequestTraceFilter so that it checks that
parameters are to be included in the trace before calling
request.getParameterMap()

Closes gh-5089
This commit is contained in:
Andy Wilkinson 2016-02-12 10:26:23 +00:00
parent 815da8b845
commit 607dba97f8
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/WebRequestTraceFilter.java
View File

@ -45,6 +45,7 @@ import org.springframework.web.filter.OncePerRequestFilter;
* *
* @author Dave Syer * @author Dave Syer
* @author Wallace Wadge * @author Wallace Wadge
* @author Andy Wilkinson
*/ */
public class WebRequestTraceFilter extends OncePerRequestFilter implements Ordered { public class WebRequestTraceFilter extends OncePerRequestFilter implements Ordered {
@ -135,7 +136,9 @@ public class WebRequestTraceFilter extends OncePerRequestFilter implements Order
add(trace, Include.CONTEXT_PATH, "contextPath", request.getContextPath()); add(trace, Include.CONTEXT_PATH, "contextPath", request.getContextPath());
add(trace, Include.USER_PRINCIPAL, "userPrincipal", add(trace, Include.USER_PRINCIPAL, "userPrincipal",
(userPrincipal == null ? null : userPrincipal.getName())); (userPrincipal == null ? null : userPrincipal.getName()));
add(trace, Include.PARAMETERS, "parameters", request.getParameterMap()); if (isIncluded(Include.PARAMETERS)) {
trace.put("parameters", request.getParameterMap());
}
add(trace, Include.QUERY_STRING, "query", request.getQueryString()); add(trace, Include.QUERY_STRING, "query", request.getQueryString());
add(trace, Include.AUTH_TYPE, "authType", request.getAuthType()); add(trace, Include.AUTH_TYPE, "authType", request.getAuthType());
add(trace, Include.REMOTE_ADDRESS, "remoteAddress", request.getRemoteAddr()); add(trace, Include.REMOTE_ADDRESS, "remoteAddress", request.getRemoteAddr());

9
spring-boot-actuator/src/test/java/org/springframework/boot/actuate/trace/WebRequestTraceFilterTests.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2015 the original author or authors. * Copyright 2012-2016 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -39,6 +39,9 @@ import org.springframework.mock.web.MockHttpServletResponse;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue; import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
/** /**
* Tests for {@link WebRequestTraceFilter}. * Tests for {@link WebRequestTraceFilter}.
@ -46,6 +49,7 @@ import static org.junit.Assert.assertTrue;
* @author Dave Syer * @author Dave Syer
* @author Wallace Wadge * @author Wallace Wadge
* @author Phillip Webb * @author Phillip Webb
* @author Andy Wilkinson
*/ */
public class WebRequestTraceFilterTests { public class WebRequestTraceFilterTests {
@ -59,13 +63,14 @@ public class WebRequestTraceFilterTests {
@Test @Test
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public void filterAddsTraceWithDefaultIncludes() { public void filterAddsTraceWithDefaultIncludes() {
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/foo"); MockHttpServletRequest request = spy(new MockHttpServletRequest("GET", "/foo"));
request.addHeader("Accept", "application/json"); request.addHeader("Accept", "application/json");
Map<String, Object> trace = this.filter.getTrace(request); Map<String, Object> trace = this.filter.getTrace(request);
assertEquals("GET", trace.get("method")); assertEquals("GET", trace.get("method"));
assertEquals("/foo", trace.get("path")); assertEquals("/foo", trace.get("path"));
Map<String, Object> map = (Map<String, Object>) trace.get("headers"); Map<String, Object> map = (Map<String, Object>) trace.get("headers");
assertEquals("{Accept=application/json}", map.get("request").toString()); assertEquals("{Accept=application/json}", map.get("request").toString());
verify(request, times(0)).getParameterMap();
} }
@Test @Test