Adding circuitBreaker filter in mvc throws IllegalArgumentException #3327

bright-k · 2024-03-29T04:41:56Z

i using
java 21
spring boot 3.2.4
spring cloud dependencies 2023.0.1

Adding circuitBreaker filter in mvc throws IllegalArgumentException

An error occurs when the circuitBreaker filter is set as below and passes through the registered route.

spring-cloud-starter-circuitbreaker-reactor-resilience4j dependency is added

spring:
    gateway.mvc:
      routes:
        - id: test-routes
          predicates:
            - name: Path
              args:
                patterns: |
                  /api-test/**,
                  /api-test2/**
          filters:
            - StripPrefix=1
            - CircuitBreaker=myCircuitBreaker
          uri: http://localhost:8081

Caused by: java.lang.IllegalArgumentException: A CircuitBreaker must have an id.
	at org.springframework.util.Assert.hasText(Assert.java:240)
	at org.springframework.cloud.circuitbreaker.resilience4j.Resilience4JCircuitBreakerFactory.create(Resilience4JCircuitBreakerFactory.java:125)
	at org.springframework.cloud.gateway.server.mvc.filter.CircuitBreakerFilterFunctions.lambda$circuitBreaker$7(CircuitBreakerFilterFunctions.java:80)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$0(HandlerFilterFunction.java:58)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$ofRequestProcessor$3(HandlerFilterFunction.java:83)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$0(HandlerFilterFunction.java:58)
	at org.springframework.cloud.gateway.server.mvc.config.RouterFunctionHolderFactory.lambda$getRouterFunction$3(RouterFunctionHolderFactory.java:154)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$0(HandlerFilterFunction.java:58)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$ofRequestProcessor$3(HandlerFilterFunction.java:83)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$1(HandlerFilterFunction.java:59)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$1(HandlerFilterFunction.java:59)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$1(HandlerFilterFunction.java:59)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$1(HandlerFilterFunction.java:59)
	at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$apply$2(HandlerFilterFunction.java:70)
	at org.springframework.web.servlet.function.support.HandlerFunctionAdapter.handle(HandlerFunctionAdapter.java:108)
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1089)
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:979)
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1014)

Did I miss anything?

The text was updated successfully, but these errors were encountered:

karthik20 · 2024-04-01T10:14:09Z

I have the same issue. The yaml based configuration doesn't seem to register the circuitbreaker CircuitBreakerFilterFunctions. But doing via WebMvc.fn helps.

Reference: https://github.com/karthik20/spring-cloud-gateway-cb/blob/main/gateway/src/main/java/com/karthik/gateway/config/router/RouterConfig.java

@Bean
public RouterFunction<ServerResponse> routeConfig() {
    return route("customer_route")
            .route(path("/customer/**").or(path("/customer")), http("http://localhost:8080"))
            .filter(circuitBreaker(config -> config.setId("customerCircuitBreaker")
                    .setStatusCodes("500")))
            .build();
    }

jivebreaddev · 2024-05-11T01:16:26Z

May I handle this issue? I have an idea to work on this.

findOperation method will not show any useful information when binding yaml properties to each class instances. Such Logging will provide a mean to evaluate failure in binding yaml properties. spring-cloud#3327

@configuration

…elds to resolve) (RouterFunctionHolderFactory) Given yaml Properties, CircuitBreaker(`CircuitConfig`) method passes binding test even when given value is `ID` not `CircuitConfig` - operation method that is annotated with @configuration always pass binding test [findOperation] thereby creating wrong binding from property to method Introducing Priority will resolve methods without @configuration to be processed first and @configuration will be matched the last. spring-cloud#3327

…g yaml properties to each class instances. Such Logging will provide a mean to evaluate failure in binding yaml properties. spring-cloud#3327

@configuration

Given yaml Properties, CircuitBreaker(`CircuitConfig`) method passes binding test even when given value is `ID` not `CircuitConfig` - operation method that is annotated with @configuration always pass binding test [findOperation] thereby creating wrong binding from property to method Introducing Sorting to the operations, it will resolve methods without @configuration to be processed first and @configuration will be matched the last. spring-cloud#3327

jivebreaddev · 2024-05-16T14:39:29Z

Given Situation: yaml file fails to bind to the CircuitBreaker HandlerFilterFunction

// given properties.yaml
spring:
    gateway.mvc:
      routes:
        - id: test-routes
          predicates:
            - name: Path
              args:
                patterns: |
                  /api-test/**,
                  /api-test2/**
          filters:
            - StripPrefix=1
            - CircuitBreaker=myCircuitBreaker
          uri: http://localhost:8081
          
// Thrown Exception      
Caused by: java.lang.IllegalArgumentException: A CircuitBreaker must have an id.
	at org.springframework.util.Assert.hasText(Assert.java:240)
	at org.springframework.cloud.circuitbreaker.resilience4j.Resilience4JCircuitBreakerFactory.create(Resilience4JCircuitBreakerFactory.java:125)
	at org.springframework.cloud.gateway.server.mvc.filter.CircuitBreakerFilterFunctions.lambda$cir
	
	
// Code

public static HandlerFilterFunction<ServerResponse, ServerResponse> circuitBreaker(CircuitBreakerConfig config) {
	Set<HttpStatusCode> failureStatuses = config.getStatusCodes().stream()
			.map(status -> HttpStatusHolder.valueOf(status).resolve()).collect(Collectors.toSet());
	return (request, next) -> {
		CircuitBreakerFactory<?, ?> circuitBreakerFactory = MvcUtils.getApplicationContext(request)
				.getBean(CircuitBreakerFactory.class);
		// TODO: cache
		CircuitBreaker circuitBreaker = **circuitBreakerFactory.create(config.getId());**

findOperation method will match HandlerFilterFuction(given Parameters) with proper Arguments

	@Shortcut
	public static HandlerFilterFunction<ServerResponse, ServerResponse> circuitBreaker(String id) {
		return circuitBreaker(config -> config.setId(id));
	}

	public static HandlerFilterFunction<ServerResponse, ServerResponse> circuitBreaker(String id, URI fallbackUri) {
		return circuitBreaker(config -> config.setId(id).setFallbackUri(fallbackUri));
	}

	public static HandlerFilterFunction<ServerResponse, ServerResponse> circuitBreaker(String id, String fallbackPath) {
		return circuitBreaker(config -> config.setId(id).setFallbackPath(fallbackPath));
	}

	public static HandlerFilterFunction<ServerResponse, ServerResponse> circuitBreaker(
			Consumer<CircuitBreakerConfig> configConsumer) {
		CircuitBreakerConfig config = new CircuitBreakerConfig();
		configConsumer.accept(config);
		return circuitBreaker(config);
	}
       
        **@Shortcut
	@Configurable
	public static HandlerFilterFunction<ServerResponse, ServerResponse> circuitBreaker(CircuitBreakerConfig config) {**
		Set<HttpStatusCode> failureStatuses = config.getStatusCodes().stream()
				.map(status -> HttpStatusHolder.valueOf(status).resolve()).collect(Collectors.toSet());
		return (request, next) -> {
			CircuitBreakerFactory<?, ?> circuitBreakerFactory = MvcUtils.getApplicationContext(request)
					.getBean(CircuitBreakerFactory.class);
			// TODO: cache
			CircuitBreaker circuitBreaker = circuitBreakerFactory.create(config.getId());
			return circuitBreaker.run(() -> {
				try {
					ServerResponse serverResponse = next.handle(request);
					// on configured status code, throw exception
					if (failureStatuses.contains(serverResponse.statusCode())) {
						throw new CircuitBreakerStatusCodeException(serverResponse.statusCode());
					}

Debugging shows that method with @Configurable(which was added here Gateway MVC: Retry filter not supported with YAML configuration #3172) has been matched but it should have been bound to circuitBreaker(String id)

This is result of this line of code where @Configurable will always return by bypassing existing logic.
My code changes:

given HandlerFunctions, @configurable will be processed the last as it will be matched. Also, Unordered Map tolist will introduce uncertain behaviors.
Better Logging statements to observe which properties were failed to bind.

bright-k added the waiting-for-triage label Mar 29, 2024

spencergibb added bug in: proxyexchange-webmvc and removed waiting-for-triage labels Apr 5, 2024

spencergibb added this to the 4.1.3 milestone Apr 5, 2024

spencergibb modified the milestones: 4.1.3, 4.1.4 Apr 17, 2024

jivebreaddev mentioned this issue May 13, 2024

Add Logging to YAML Properties Resolving(RouterFunctionHolderFactory) #3389

Closed

jivebreaddev mentioned this issue May 13, 2024

Introducing Priority when binding yaml properties to OperationMethod in findOperation #3390

Closed

jivebreaddev mentioned this issue May 16, 2024

Add Logging to YAML Properties Resolving(RouterFunctionHolderFactory) #3396

Open

jivebreaddev linked a pull request May 16, 2024 that will close this issue

Introducing Sorting when binding yaml properties to OperationMethod in findOperation #3397

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding circuitBreaker filter in mvc throws IllegalArgumentException #3327

Adding circuitBreaker filter in mvc throws IllegalArgumentException #3327

bright-k commented Mar 29, 2024

karthik20 commented Apr 1, 2024 •

edited

jivebreaddev commented May 11, 2024

jivebreaddev commented May 16, 2024 •

edited

Adding circuitBreaker filter in mvc throws IllegalArgumentException #3327

Adding circuitBreaker filter in mvc throws IllegalArgumentException #3327

Comments

bright-k commented Mar 29, 2024

karthik20 commented Apr 1, 2024 • edited

jivebreaddev commented May 11, 2024

jivebreaddev commented May 16, 2024 • edited

karthik20 commented Apr 1, 2024 •

edited

jivebreaddev commented May 16, 2024 •

edited