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

Guard against no-op observation 

Update `ServerHttpObservationFilter` to check if the `Observation`
is a no-op before adding the `ServerRequestObservationContext`.

Prior to this commit, if the `Observation` is a no-op then the
context type added with the `CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE`
would not be a `ServerRequestObservationContext`. This would mean
that `findObservationContext` would throw a `ClassCastException`.

Fixes gh-29356
This commit is contained in:
Phillip Webb 2022-10-19 16:01:09 -07:00
parent 0889e47608
commit f93fda2a95
2 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spring-web/src/main/java/org/springframework/web/filter/ServerHttpObservationFilter.java
View File

@ -130,7 +130,9 @@ public class ServerHttpObservationFilter extends OncePerRequestFilter {
observation = ServerHttpObservationDocumentation.HTTP_REQUESTS.observation(this.observationConvention, observation = ServerHttpObservationDocumentation.HTTP_REQUESTS.observation(this.observationConvention,
DEFAULT_OBSERVATION_CONVENTION, () -> context, this.observationRegistry).start(); DEFAULT_OBSERVATION_CONVENTION, () -> context, this.observationRegistry).start();
request.setAttribute(CURRENT_OBSERVATION_ATTRIBUTE, observation); request.setAttribute(CURRENT_OBSERVATION_ATTRIBUTE, observation);
request.setAttribute(CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE, observation.getContext()); if (!observation.isNoop()) {
request.setAttribute(CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE, observation.getContext());
}
} }
return observation; return observation;
} }

12
spring-web/src/test/java/org/springframework/web/filter/ServerHttpObservationFilterTests.java
View File

@ -16,6 +16,7 @@
package org.springframework.web.filter; package org.springframework.web.filter;
import io.micrometer.observation.ObservationRegistry;
import io.micrometer.observation.tck.TestObservationRegistry; import io.micrometer.observation.tck.TestObservationRegistry;
import io.micrometer.observation.tck.TestObservationRegistryAssert; import io.micrometer.observation.tck.TestObservationRegistryAssert;
import jakarta.servlet.RequestDispatcher; import jakarta.servlet.RequestDispatcher;
@ -33,6 +34,7 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy;
/** /**
* Tests for {@link ServerHttpObservationFilter}. * Tests for {@link ServerHttpObservationFilter}.
*
* @author Brian Clozel * @author Brian Clozel
*/ */
class ServerHttpObservationFilterTests { class ServerHttpObservationFilterTests {
@ -61,6 +63,16 @@ class ServerHttpObservationFilterTests {
assertThatHttpObservation().hasLowCardinalityKeyValue("outcome", "SUCCESS"); assertThatHttpObservation().hasLowCardinalityKeyValue("outcome", "SUCCESS");
} }
@Test
void filterShouldAcceptNoOpObservationContext() throws Exception {
ServerHttpObservationFilter filter = new ServerHttpObservationFilter(ObservationRegistry.NOOP);
filter.doFilter(this.request, this.response, this.mockFilterChain);
ServerRequestObservationContext context = (ServerRequestObservationContext) this.request
.getAttribute(ServerHttpObservationFilter.CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE);
assertThat(context).isNull();
}
@Test @Test
void filterShouldUseThrownException() throws Exception { void filterShouldUseThrownException() throws Exception {
IllegalArgumentException customError = new IllegalArgumentException("custom error"); IllegalArgumentException customError = new IllegalArgumentException("custom error");