Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support reading the body multiple times in ReadBodyRoutePredicateFactory #3548

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Support reading the body multiple times in ReadBodyRoutePredicateFactory #3548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c16586
Support reading the body multiple times in ReadBodyRoutePredicateFact…
qnnn Oct 3, 2024
ecd094b
Support reading the body multiple times in ReadBodyRoutePredicateFact…
qnnn Oct 3, 2024
0d036ce
Support reading the body multiple times in RequestPredicate.
qnnn Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions ...java/org/springframework/cloud/gateway/server/mvc/predicate/GatewayRequestPredicates.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import org.springframework.cloud.gateway.server.mvc.common.Shortcut;
import org.springframework.cloud.gateway.server.mvc.common.Shortcut.Type;
import org.springframework.cloud.gateway.server.mvc.common.WeightConfig;
import org.springframework.cloud.gateway.server.mvc.filter.BodyFilterFunctions;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
Expand All @@ -59,7 +60,6 @@
import static org.springframework.cloud.gateway.server.mvc.common.MvcUtils.GATEWAY_ROUTE_ID_ATTR;
import static org.springframework.cloud.gateway.server.mvc.common.MvcUtils.WEIGHT_ATTR;
import static org.springframework.cloud.gateway.server.mvc.common.MvcUtils.cacheAndReadBody;
import static org.springframework.cloud.gateway.server.mvc.common.MvcUtils.getAttribute;
import static org.springframework.cloud.gateway.server.mvc.common.MvcUtils.putAttribute;

public abstract class GatewayRequestPredicates {
Expand Down Expand Up @@ -487,22 +487,10 @@ private static final class ReadBodyPredicate<T> implements RequestPredicate {
@Override
@SuppressWarnings("unchecked")
public boolean test(ServerRequest request) {
try {
Object cachedBody = getAttribute(request, READ_BODY_CACHE_OBJECT_KEY);
ServerRequest cachedRequest = BodyFilterFunctions.adaptCachedBody().apply(request);

if (cachedBody != null) {
return predicate.test((T) cachedBody);
}
}
catch (ClassCastException e) {
if (log.isDebugEnabled()) {
log.debug("Predicate test failed because class in predicate "
+ "does not match the cached body object", e);
}
}

return cacheAndReadBody(request, toRead).map(body -> {
putAttribute(request, READ_BODY_CACHE_OBJECT_KEY, body);
return cacheAndReadBody(cachedRequest, toRead).map(body -> {
putAttribute(cachedRequest, READ_BODY_CACHE_OBJECT_KEY, body);
return predicate.test(body);
}).orElse(false);
}
Expand Down
47 changes: 21 additions & 26 deletions ...va/org/springframework/cloud/gateway/handler/predicate/ReadBodyRoutePredicateFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.reactivestreams.Publisher;
import reactor.core.publisher.Mono;

import org.springframework.cloud.gateway.handler.AsyncPredicate;
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
import org.springframework.http.codec.HttpMessageReader;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.web.reactive.function.server.HandlerStrategies;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.server.ServerWebExchange;
Expand Down Expand Up @@ -63,38 +63,33 @@ public AsyncPredicate<ServerWebExchange> applyAsync(Config config) {
return new AsyncPredicate<ServerWebExchange>() {
@Override
public Publisher<Boolean> apply(ServerWebExchange exchange) {
Class inClass = config.getInClass();

Object cachedBody = exchange.getAttribute(CACHE_REQUEST_BODY_OBJECT_KEY);
Mono<?> modifiedBody;
// We can only read the body from the request once, once that happens if
// we try to read the body again an exception will be thrown. The below
// if/else caches the body object as a request attribute in the
// ServerWebExchange so if this filter is run more than once (due to more
// than one route using it) we do not try to read the request body
// multiple times
if (cachedBody != null) {
try {
boolean test = config.predicate.test(cachedBody);
exchange.getAttributes().put(TEST_ATTRIBUTE, test);
return Mono.just(test);
}
catch (ClassCastException e) {
if (log.isDebugEnabled()) {
log.debug("Predicate test failed because class in predicate "
+ "does not match the cached body object", e);
}
}
return Mono.just(false);
exchange.getAttributes().put(TEST_ATTRIBUTE, false);

ServerHttpRequest mutableRequest = exchange
.getAttribute(ServerWebExchangeUtils.CACHED_SERVER_HTTP_REQUEST_DECORATOR_ATTR);
if (mutableRequest != null) {
return ServerRequest.create(exchange.mutate().request(mutableRequest).build(), messageReaders)
.bodyToMono(config.getInClass())
.doOnNext(objectValue -> exchange.getAttributes()
.put(CACHE_REQUEST_BODY_OBJECT_KEY, objectValue))
.map(objectValue -> {
boolean test = config.getPredicate().test(objectValue);
exchange.getAttributes().put(TEST_ATTRIBUTE, test);
return test;
});
}
else {
return ServerWebExchangeUtils.cacheRequestBodyAndRequest(exchange,
(serverHttpRequest) -> ServerRequest
.create(exchange.mutate().request(serverHttpRequest).build(), messageReaders)
.bodyToMono(inClass)
.bodyToMono(config.getInClass())
.doOnNext(objectValue -> exchange.getAttributes()
.put(CACHE_REQUEST_BODY_OBJECT_KEY, objectValue))
.map(objectValue -> config.getPredicate().test(objectValue)));
.map(objectValue -> {
boolean test = config.getPredicate().test(objectValue);
exchange.getAttributes().put(TEST_ATTRIBUTE, test);
return test;
}));
}
}

Expand Down
36 changes: 36 additions & 0 deletions ...g/springframework/cloud/gateway/handler/predicate/ReadBodyRoutePredicateFactoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,23 @@ public void readBodyWorks() {

}

@Test
public void multipleReadBodyMatchingTest() {

Event messageChannelEvent = new Event("message.channels", "bar");

webClient.post()
.uri("/events")
.body(BodyInserters.fromValue(messageChannelEvent))
.header("repeatable")
.exchange()
.expectStatus()
.isOk()
.expectBody()
.jsonPath("$.headers.World")
.isEqualTo("Hello");
}

@Test
public void toStringFormat() {
Config config = new Config();
Expand Down Expand Up @@ -118,6 +135,25 @@ public RouteLocator routeLocator(RouteLocatorBuilder builder) {
.readBody(Event.class, eventPredicate("message"))
.filters(f -> f.setPath("/message/events"))
.uri("lb://message"))
.route(p -> p.order(-100)
.path("/events")
.and()
.method(HttpMethod.POST)
.and()
.readBody(String.class, string -> false)
.and()
.header("repeatable")
.uri("lb://message"))
.route(p -> p.order(-99)
.path("/events")
.and()
.method(HttpMethod.POST)
.and()
.readBody(Event.class, eventPredicate("message"))
.and()
.header("repeatable")
.filters(f -> f.setPath("/message/events"))
.uri("lb://message"))
.build();
}

Expand Down
Loading