SpringCloud/spring-cloud-gateway
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Supports timeouts from properties rather than yaml.

Browse Source 
Fixes gh-1522
This commit is contained in:
echooymxq
2020-01-15 13:14:55 +08:00
committed by Spencer Gibb
parent 6553bce9f6
commit fd1763d5b9
2 changed files with 107 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
spring-cloud-gateway-core/src/main/java/org/springframework/cloud/gateway/filter/NettyRoutingFilter.java
View File

@@ -252,17 +252,38 @@ public class NettyRoutingFilter implements GlobalFilter, Ordered {
* @return
*/
protected HttpClient getHttpClient(Route route, ServerWebExchange exchange) {
Integer connectTimeout = (Integer) route.getMetadata().get(CONNECT_TIMEOUT_ATTR);
if (connectTimeout != null) {
Object connectTimeoutAttr = route.getMetadata().get(CONNECT_TIMEOUT_ATTR);
if (connectTimeoutAttr != null) {
Integer connectTimeout = getInteger(connectTimeoutAttr);
return this.httpClient.tcpConfiguration((tcpClient) -> tcpClient
.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, connectTimeout));
}
return httpClient;
}
static Integer getInteger(Object connectTimeoutAttr) {
Integer connectTimeout;
if (connectTimeoutAttr instanceof Integer) {
connectTimeout = (Integer) connectTimeoutAttr;
}
else {
connectTimeout = Integer.parseInt(connectTimeoutAttr.toString());
}
return connectTimeout;
}
private Duration getResponseTimeout(Route route) {
Number responseTimeout = (Number) route.getMetadata().get(RESPONSE_TIMEOUT_ATTR);
return responseTimeout != null ? Duration.ofMillis(responseTimeout.longValue())
Object responseTimeoutAttr = route.getMetadata().get(RESPONSE_TIMEOUT_ATTR);
Long responseTimeout = null;
if (responseTimeoutAttr != null) {
if (responseTimeoutAttr instanceof Number) {
responseTimeout = ((Number) responseTimeoutAttr).longValue();
}
else {
responseTimeout = Long.valueOf(responseTimeoutAttr.toString());
}
}
return responseTimeout != null ? Duration.ofMillis(responseTimeout)
: properties.getResponseTimeout();
}

82
spring-cloud-gateway-core/src/test/java/org/springframework/cloud/gateway/filter/NettyRoutingFilterCompatibleTests.java Normal file
View File

@@ -0,0 +1,82 @@
/*
* Copyright 2013-2019 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.cloud.gateway.filter;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.gateway.route.Route;
import org.springframework.cloud.gateway.test.BaseWebClientTests;
import org.springframework.context.annotation.Import;
import org.springframework.http.HttpStatus;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.web.server.ServerWebExchange;
import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
/**
* This test just avoid class cast exception with YAML or Properties parsing.
*
* {@link NettyRoutingFilter#getHttpClient(Route, ServerWebExchange)}
* {@link NettyRoutingFilter#getResponseTimeout(Route)}
*
* @author echooymxq
**/
@RunWith(SpringRunner.class)
@SpringBootTest(properties = { "spring.cloud.gateway.routes[0].id=route_connect_timeout",
"spring.cloud.gateway.routes[0].uri=http://localhost:32167",
"spring.cloud.gateway.routes[0].predicates[0].name=Path",
"spring.cloud.gateway.routes[0].predicates[0].args[pattern]=/connect/delay/{timeout}",
"spring.cloud.gateway.routes[0].metadata[connect-timeout]=5",
"spring.cloud.gateway.routes[1].id=route_response_timeout",
"spring.cloud.gateway.routes[1].uri=lb://testservice",
"spring.cloud.gateway.routes[1].predicates[0].name=Path",
"spring.cloud.gateway.routes[1].predicates[0].args[pattern]=/route/delay/{timeout}",
"spring.cloud.gateway.routes[1].filters[0]=StripPrefix=1",
"spring.cloud.gateway.routes[1].metadata.response-timeout=1000" },
webEnvironment = RANDOM_PORT)
@DirtiesContext
public class NettyRoutingFilterCompatibleTests extends BaseWebClientTests {
@Test
public void shouldApplyConnectTimeoutPerRoute() {
assertThat(NettyRoutingFilter.getInteger("5")).isEqualTo(5);
assertThat(NettyRoutingFilter.getInteger(5)).isEqualTo(5);
}
@Test
public void shouldApplyResponseTimeoutPerRoute() {
testClient.get().uri("/route/delay/2").exchange().expectStatus()
.isEqualTo(HttpStatus.GATEWAY_TIMEOUT).expectBody().jsonPath("$.status")
.isEqualTo(String.valueOf(HttpStatus.GATEWAY_TIMEOUT.value()))
.jsonPath("$.message")
.isEqualTo("Response took longer than timeout: PT1S");
}
@EnableAutoConfiguration
@SpringBootConfiguration
@Import(DefaultTestConfig.class)
public static class TestConfig {
}
}