Merge branch '6.0.x'

This commit is contained in:
Josh Cummings 2022-11-29 16:26:13 -07:00
commit eb57d9e5c1
No known key found for this signature in database
GPG Key ID: A306A51F43B8E5A5
6 changed files with 155 additions and 22 deletions

View File

@ -192,7 +192,7 @@ Instead, you can alter the provided `ObservationRegistry` with an `ObservationPr
---- ----
@Bean @Bean
ObservationRegistryCustomizer<ObservationRegistry> noSpringSecurityObservations() { ObservationRegistryCustomizer<ObservationRegistry> noSpringSecurityObservations() {
ObservationPredicate predicate = (name, context) -> name.startsWith("spring.security.") ObservationPredicate predicate = (name, context) -> !name.startsWith("spring.security.")
return (registry) -> registry.observationConfig().observationPredicate(predicate) return (registry) -> registry.observationConfig().observationPredicate(predicate)
} }
---- ----
@ -202,7 +202,7 @@ ObservationRegistryCustomizer<ObservationRegistry> noSpringSecurityObservations(
---- ----
@Bean @Bean
fun noSpringSecurityObservations(): ObservationRegistryCustomizer<ObservationRegistry> { fun noSpringSecurityObservations(): ObservationRegistryCustomizer<ObservationRegistry> {
ObservationPredicate predicate = (name: String, context: Observation.Context) -> name.startsWith("spring.security.") ObservationPredicate predicate = (name: String, context: Observation.Context) -> !name.startsWith("spring.security.")
(registry: ObservationRegistry) -> registry.observationConfig().observationPredicate(predicate) (registry: ObservationRegistry) -> registry.observationConfig().observationPredicate(predicate)
} }
---- ----

View File

@ -197,7 +197,7 @@ Instead, you can alter the provided `ObservationRegistry` with an `ObservationPr
---- ----
@Bean @Bean
ObservationRegistryCustomizer<ObservationRegistry> noSpringSecurityObservations() { ObservationRegistryCustomizer<ObservationRegistry> noSpringSecurityObservations() {
ObservationPredicate predicate = (name, context) -> name.startsWith("spring.security.") ObservationPredicate predicate = (name, context) -> !name.startsWith("spring.security.");
return (registry) -> registry.observationConfig().observationPredicate(predicate) return (registry) -> registry.observationConfig().observationPredicate(predicate)
} }
---- ----
@ -207,7 +207,7 @@ ObservationRegistryCustomizer<ObservationRegistry> noSpringSecurityObservations(
---- ----
@Bean @Bean
fun noSpringSecurityObservations(): ObservationRegistryCustomizer<ObservationRegistry> { fun noSpringSecurityObservations(): ObservationRegistryCustomizer<ObservationRegistry> {
ObservationPredicate predicate = (name: String, context: Observation.Context) -> name.startsWith("spring.security.") ObservationPredicate predicate = (name: String, context: Observation.Context) -> !name.startsWith("spring.security.")
(registry: ObservationRegistry) -> registry.observationConfig().observationPredicate(predicate) (registry: ObservationRegistry) -> registry.observationConfig().observationPredicate(predicate)
} }
---- ----

View File

@ -177,17 +177,19 @@ public final class ObservationFilterChainDecorator implements FilterChainProxy.F
private void wrapFilter(ServletRequest request, ServletResponse response, FilterChain chain) private void wrapFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException { throws IOException, ServletException {
AroundFilterObservation parent = observation((HttpServletRequest) request); AroundFilterObservation parent = observation((HttpServletRequest) request);
FilterChainObservationContext parentBefore = (FilterChainObservationContext) parent.before().getContext(); if (parent.before().getContext() instanceof FilterChainObservationContext parentBefore) {
parentBefore.setChainSize(this.size); parentBefore.setChainSize(this.size);
parentBefore.setFilterName(this.name); parentBefore.setFilterName(this.name);
parentBefore.setChainPosition(this.position); parentBefore.setChainPosition(this.position);
}
parent.before().event(Observation.Event.of(this.name + " before")); parent.before().event(Observation.Event.of(this.name + " before"));
this.filter.doFilter(request, response, chain); this.filter.doFilter(request, response, chain);
parent.start(); parent.start();
FilterChainObservationContext parentAfter = (FilterChainObservationContext) parent.after().getContext(); if (parent.after().getContext() instanceof FilterChainObservationContext parentAfter) {
parentAfter.setChainSize(this.size); parentAfter.setChainSize(this.size);
parentAfter.setFilterName(this.name); parentAfter.setFilterName(this.name);
parentAfter.setChainPosition(this.size - this.position + 1); parentAfter.setChainPosition(this.size - this.position + 1);
}
parent.after().event(Observation.Event.of(this.name + " after")); parent.after().event(Observation.Event.of(this.name + " after"));
} }

View File

@ -196,18 +196,18 @@ public final class ObservationWebFilterChainDecorator implements WebFilterChainP
private Mono<Void> wrapFilter(ServerWebExchange exchange, WebFilterChain chain) { private Mono<Void> wrapFilter(ServerWebExchange exchange, WebFilterChain chain) {
AroundWebFilterObservation parent = observation(exchange); AroundWebFilterObservation parent = observation(exchange);
WebFilterChainObservationContext parentBefore = (WebFilterChainObservationContext) parent.before() if (parent.before().getContext() instanceof WebFilterChainObservationContext parentBefore) {
.getContext(); parentBefore.setChainSize(this.size);
parentBefore.setChainSize(this.size); parentBefore.setFilterName(this.name);
parentBefore.setFilterName(this.name); parentBefore.setChainPosition(this.position);
parentBefore.setChainPosition(this.position); }
return this.filter.filter(exchange, chain).doOnSuccess((result) -> { return this.filter.filter(exchange, chain).doOnSuccess((result) -> {
parent.start(); parent.start();
WebFilterChainObservationContext parentAfter = (WebFilterChainObservationContext) parent.after() if (parent.after().getContext() instanceof WebFilterChainObservationContext parentAfter) {
.getContext(); parentAfter.setChainSize(this.size);
parentAfter.setChainSize(this.size); parentAfter.setFilterName(this.name);
parentAfter.setFilterName(this.name); parentAfter.setChainPosition(this.size - this.position + 1);
parentAfter.setChainPosition(this.size - this.position + 1); }
}); });
} }

View File

@ -0,0 +1,64 @@
/*
* Copyright 2002-2022 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.web;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationRegistry;
import jakarta.servlet.FilterChain;
import org.junit.jupiter.api.Test;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
/**
* Tests for {@link ObservationFilterChainDecorator}
*/
public class ObservationFilterChainDecoratorTests {
@Test
void decorateWhenDefaultsThenObserves() throws Exception {
ObservationHandler<?> handler = mock(ObservationHandler.class);
given(handler.supportsContext(any())).willReturn(true);
ObservationRegistry registry = ObservationRegistry.create();
registry.observationConfig().observationHandler(handler);
ObservationFilterChainDecorator decorator = new ObservationFilterChainDecorator(registry);
FilterChain chain = mock(FilterChain.class);
FilterChain decorated = decorator.decorate(chain);
decorated.doFilter(new MockHttpServletRequest("GET", "/"), new MockHttpServletResponse());
verify(handler).onStart(any());
}
@Test
void decorateWhenNoopThenDoesNotObserve() throws Exception {
ObservationHandler<?> handler = mock(ObservationHandler.class);
given(handler.supportsContext(any())).willReturn(true);
ObservationRegistry registry = ObservationRegistry.NOOP;
registry.observationConfig().observationHandler(handler);
ObservationFilterChainDecorator decorator = new ObservationFilterChainDecorator(registry);
FilterChain chain = mock(FilterChain.class);
FilterChain decorated = decorator.decorate(chain);
decorated.doFilter(new MockHttpServletRequest("GET", "/"), new MockHttpServletResponse());
verifyNoInteractions(handler);
}
}

View File

@ -0,0 +1,67 @@
/*
* Copyright 2002-2022 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.web.server;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationRegistry;
import org.junit.jupiter.api.Test;
import reactor.core.publisher.Mono;
import org.springframework.mock.http.server.reactive.MockServerHttpRequest;
import org.springframework.mock.web.server.MockServerWebExchange;
import org.springframework.web.server.WebFilterChain;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
/**
* Tests for {@link ObservationWebFilterChainDecorator}
*/
public class ObservationWebFilterChainDecoratorTests {
@Test
void decorateWhenDefaultsThenObserves() {
ObservationHandler<?> handler = mock(ObservationHandler.class);
given(handler.supportsContext(any())).willReturn(true);
ObservationRegistry registry = ObservationRegistry.create();
registry.observationConfig().observationHandler(handler);
ObservationWebFilterChainDecorator decorator = new ObservationWebFilterChainDecorator(registry);
WebFilterChain chain = mock(WebFilterChain.class);
given(chain.filter(any())).willReturn(Mono.empty());
WebFilterChain decorated = decorator.decorate(chain);
decorated.filter(MockServerWebExchange.from(MockServerHttpRequest.get("/").build())).block();
verify(handler).onStart(any());
}
@Test
void decorateWhenNoopThenDoesNotObserve() {
ObservationHandler<?> handler = mock(ObservationHandler.class);
given(handler.supportsContext(any())).willReturn(true);
ObservationRegistry registry = ObservationRegistry.NOOP;
registry.observationConfig().observationHandler(handler);
ObservationWebFilterChainDecorator decorator = new ObservationWebFilterChainDecorator(registry);
WebFilterChain chain = mock(WebFilterChain.class);
given(chain.filter(any())).willReturn(Mono.empty());
WebFilterChain decorated = decorator.decorate(chain);
decorated.filter(MockServerWebExchange.from(MockServerHttpRequest.get("/").build())).block();
verifyNoInteractions(handler);
}
}