Skip to content

Improve route predicate handling of errors in filterWhen #427

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

Closed
wants to merge 1 commit into from
Closed

Improve route predicate handling of errors in filterWhen #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 17 additions & 16 deletions ...src/main/java/org/springframework/cloud/gateway/handler/RoutePredicateHandlerMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,15 @@

import java.util.function.Function;

import reactor.core.publisher.Mono;

import org.springframework.cloud.gateway.route.Route;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.reactive.handler.AbstractHandlerMapping;
import org.springframework.web.server.ServerWebExchange;

import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.GATEWAY_HANDLER_MAPPER_ATTR;
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.GATEWAY_PREDICATE_ROUTE_ATTR;
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR;

import reactor.core.publisher.Mono;
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.*;

/**
* @author Spencer Gibb
Expand Down Expand Up @@ -88,17 +86,20 @@ private String getExchangeDesc(ServerWebExchange exchange) {
}

protected Mono<Route> lookupRoute(ServerWebExchange exchange) {
return this.routeLocator.getRoutes()
.filterWhen(route -> {
// add the current route we are testing
exchange.getAttributes().put(GATEWAY_PREDICATE_ROUTE_ATTR, route.getId());
try {
return route.getPredicate().apply(exchange);
} catch (Exception e) {
logger.error("Error applying predicate for route: "+route.getId(), e);
}
return Mono.just(false);
})
return this.routeLocator
.getRoutes()
//individually filter routes so that filterWhen error delaying is not a problem
.concatMap(route -> Mono
.just(route)
.filterWhen(r -> {
// add the current route we are testing
exchange.getAttributes().put(GATEWAY_PREDICATE_ROUTE_ATTR, r.getId());
return r.getPredicate().apply(exchange);
})
//instead of immediately stopping main flux due to error, log and swallow it
.doOnError(e -> logger.error("Error applying predicate for route: "+route.getId(), e))
.onErrorResume(e -> Mono.empty())
)
// .defaultIfEmpty() put a static Route not found
// or .switchIfEmpty()
// .switchIfEmpty(Mono.<Route>empty().log("noroute"))
Expand Down
97 changes: 97 additions & 0 deletions ...test/java/org/springframework/cloud/gateway/handler/RoutePredicateHandlerMappingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
package org.springframework.cloud.gateway.handler;

import org.junit.Rule;
import org.junit.Test;
import org.mockito.Mockito;
import org.springframework.boot.test.rule.OutputCapture;
import org.springframework.cloud.gateway.route.Route;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.test.StepVerifier;

import static org.hamcrest.Matchers.containsString;

/**
* @author Simon Baslé
*/
public class RoutePredicateHandlerMappingTest {

@Rule
public OutputCapture outputCapture = new OutputCapture();

@Test
public void lookupRouteFromSyncPredicates() {
Route routeFalse = Route.async()
.id("routeFalse")
.uri("http://localhost")
.predicate(swe -> false)
.build();
Route routeFail = Route.async()
.id("routeFail")
.uri("http://localhost")
.predicate(swe -> { throw new IllegalStateException("boom"); })
.build();
Route routeTrue = Route.async()
.id("routeTrue")
.uri("http://localhost")
.predicate(swe -> true)
.build();
RouteLocator routeLocator =
() -> Flux.just(routeFalse, routeFail, routeTrue).hide();
RoutePredicateHandlerMapping mapping =
new RoutePredicateHandlerMapping(null, routeLocator);

final Mono<Route> routeMono =
mapping.lookupRoute(Mockito.mock(ServerWebExchange.class));

StepVerifier.create(routeMono.map(Route::getId))
.expectNext("routeTrue")
.verifyComplete();

outputCapture.expect(containsString("Error applying predicate for route: routeFail"));
outputCapture.expect(containsString("java.lang.IllegalStateException: boom"));
}

@Test
public void lookupRouteFromAsyncPredicates() {
Route routeFalse = Route.async()
.id("routeFalse")
.uri("http://localhost")
.asyncPredicate(swe -> Mono.just(false))
.build();
Route routeError = Route.async()
.id("routeError")
.uri("http://localhost")
.asyncPredicate(swe -> Mono.error(new IllegalStateException("boom1")))
.build();
Route routeFail = Route.async()
.id("routeFail")
.uri("http://localhost")
.asyncPredicate(swe -> { throw new IllegalStateException("boom2"); })
.build();
Route routeTrue = Route.async()
.id("routeTrue")
.uri("http://localhost")
.asyncPredicate(swe -> Mono.just(true))
.build();
RouteLocator routeLocator =
() -> Flux.just(routeFalse, routeError, routeFail, routeTrue).hide();
RoutePredicateHandlerMapping mapping =
new RoutePredicateHandlerMapping(null, routeLocator);

final Mono<Route> routeMono =
mapping.lookupRoute(Mockito.mock(ServerWebExchange.class));

StepVerifier.create(routeMono.map(Route::getId))
.expectNext("routeTrue")
.verifyComplete();

outputCapture.expect(containsString("Error applying predicate for route: routeError"));
outputCapture.expect(containsString("java.lang.IllegalStateException: boom1"));

outputCapture.expect(containsString("Error applying predicate for route: routeFail"));
outputCapture.expect(containsString("java.lang.IllegalStateException: boom2"));
}
}