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

Make response headers optional in /trace endpoint 

Update `WebRequestTraceFilter` so that the response respects the
TraceProperties.Include.RESPONSE enum.

See gh-3948
Closes gh-4242
This commit is contained in:
Johnny Lim 2015-10-20 11:57:04 +09:00 committed by Phillip Webb
parent eeb407881a
commit 71c8a114f1
2 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -170,8 +170,10 @@ public class WebRequestTraceFilter extends OncePerRequestFilter implements Order
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
protected void enhanceTrace(Map<String, Object> trace, HttpServletResponse response) { protected void enhanceTrace(Map<String, Object> trace, HttpServletResponse response) {
Map<String, Object> headers = (Map<String, Object>) trace.get("headers"); if (isIncluded(Include.RESPONSE_HEADERS)) {
headers.put("response", getResponseHeaders(response)); Map<String, Object> headers = (Map<String, Object>) trace.get("headers");
headers.put("response", getResponseHeaders(response));
}
} }
private Map<String, String> getResponseHeaders(HttpServletResponse response) { private Map<String, String> getResponseHeaders(HttpServletResponse response) {

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

@ -20,6 +20,7 @@ import java.io.BufferedReader;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.security.Principal; import java.security.Principal;
import java.util.Collections;
import java.util.EnumSet; import java.util.EnumSet;
import java.util.Map; import java.util.Map;
@ -37,6 +38,7 @@ import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse; import org.springframework.mock.web.MockHttpServletResponse;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
/** /**
* Tests for {@link WebRequestTraceFilter}. * Tests for {@link WebRequestTraceFilter}.
@ -126,6 +128,25 @@ public class WebRequestTraceFilterTests {
assertEquals("{Accept=application/json}", map.get("request").toString()); assertEquals("{Accept=application/json}", map.get("request").toString());
} }
@Test
@SuppressWarnings({ "unchecked" })
public void filterDoesNotAddResponseHeadersWithoutResponseHeadersInclude()
throws ServletException, IOException {
this.properties.setInclude(Collections.singleton(Include.REQUEST_HEADERS));
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/foo");
MockHttpServletResponse response = new MockHttpServletResponse();
response.addHeader("Content-Type", "application/json");
this.filter.doFilterInternal(request, response, new FilterChain() {
@Override
public void doFilter(ServletRequest request, ServletResponse response)
throws IOException, ServletException {
}
});
Map<String, Object> info = this.repository.findAll().iterator().next().getInfo();
Map<String, Object> headers = (Map<String, Object>) info.get("headers");
assertTrue(headers.get("response") == null);
}
@Test @Test
public void filterHasResponseStatus() { public void filterHasResponseStatus() {
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/foo"); MockHttpServletRequest request = new MockHttpServletRequest("GET", "/foo");
@ -156,4 +177,5 @@ public class WebRequestTraceFilterTests {
System.err.println(map); System.err.println(map);
assertEquals("Foo", map.get("message").toString()); assertEquals("Foo", map.get("message").toString());
} }
} }