Merge branch '2.2.x'
This commit is contained in:
@@ -1488,6 +1488,33 @@ errorMessage` : `Request size is larger than permissible limit. Request size is
|
||||
|
||||
NOTE: The default request size is set to five MB if not provided as a filter argument in the route definition.
|
||||
|
||||
=== The `SetRequestHost` `GatewayFilter` Factory
|
||||
|
||||
There are certain situation when the host header may need to be overridden. In this situation, the `SetRequestHost` `GatewayFilter` factory can replace the existing host header with a specified vaue.
|
||||
The filter takes a `host` parameter.
|
||||
The following listing configures a `SetRequestHost` `GatewayFilter`:
|
||||
|
||||
.application.yml
|
||||
====
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
cloud:
|
||||
gateway:
|
||||
routes:
|
||||
- id: set_request_host_header_route
|
||||
uri: http://localhost:8080/headers
|
||||
predicates:
|
||||
- Path=/headers
|
||||
filters:
|
||||
- name: SetRequestHost
|
||||
args:
|
||||
host: example.org
|
||||
----
|
||||
====
|
||||
|
||||
The `SetRequestHost` `GatewayFilter` factory replaces the value of the host header with `example.org`.
|
||||
|
||||
=== Modify a Request Body `GatewayFilter` Factory
|
||||
|
||||
You can use the `ModifyRequestBody` filter filter to modify the request body before it is sent downstream by the gateway.
|
||||
|
||||
@@ -86,6 +86,7 @@ import org.springframework.cloud.gateway.filter.factory.SecureHeadersGatewayFilt
|
||||
import org.springframework.cloud.gateway.filter.factory.SecureHeadersProperties;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetPathGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetRequestHeaderGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetRequestHostHeaderGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetResponseHeaderGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetStatusGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.StripPrefixGatewayFilterFactory;
|
||||
@@ -390,8 +391,8 @@ public class GatewayAutoConfiguration {
|
||||
}
|
||||
|
||||
@Bean
|
||||
public ReadBodyPredicateFactory readBodyPredicateFactory() {
|
||||
return new ReadBodyPredicateFactory();
|
||||
public ReadBodyPredicateFactory readBodyPredicateFactory(ServerCodecConfigurer codecConfigurer) {
|
||||
return new ReadBodyPredicateFactory(codecConfigurer.getReaders());
|
||||
}
|
||||
|
||||
@Bean
|
||||
@@ -521,6 +522,11 @@ public class GatewayAutoConfiguration {
|
||||
return new SetRequestHeaderGatewayFilterFactory();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public SetRequestHostHeaderGatewayFilterFactory setRequestHostHeaderGatewayFilterFactory() {
|
||||
return new SetRequestHostHeaderGatewayFilterFactory();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public SetResponseHeaderGatewayFilterFactory setResponseHeaderGatewayFilterFactory() {
|
||||
return new SetResponseHeaderGatewayFilterFactory();
|
||||
|
||||
@@ -275,7 +275,7 @@ public class HttpClientProperties {
|
||||
|
||||
}
|
||||
|
||||
public class Proxy {
|
||||
public static class Proxy {
|
||||
|
||||
/** Hostname for proxy configuration of Netty HttpClient. */
|
||||
private String host;
|
||||
@@ -344,7 +344,7 @@ public class HttpClientProperties {
|
||||
|
||||
}
|
||||
|
||||
public class Ssl {
|
||||
public static class Ssl {
|
||||
|
||||
/**
|
||||
* Installs the netty InsecureTrustManagerFactory. This is insecure and not
|
||||
@@ -436,7 +436,7 @@ public class HttpClientProperties {
|
||||
CertificateFactory certificateFactory = CertificateFactory
|
||||
.getInstance("X.509");
|
||||
ArrayList<Certificate> allCerts = new ArrayList<>();
|
||||
for (String trustedCert : ssl.getTrustedX509Certificates()) {
|
||||
for (String trustedCert : getTrustedX509Certificates()) {
|
||||
try {
|
||||
URL url = ResourceUtils.getURL(trustedCert);
|
||||
Collection<? extends Certificate> certs = certificateFactory
|
||||
@@ -458,14 +458,14 @@ public class HttpClientProperties {
|
||||
|
||||
public KeyManagerFactory getKeyManagerFactory() {
|
||||
try {
|
||||
if (ssl.getKeyStore() != null && ssl.getKeyStore().length() > 0) {
|
||||
if (getKeyStore() != null && getKeyStore().length() > 0) {
|
||||
KeyManagerFactory keyManagerFactory = KeyManagerFactory
|
||||
.getInstance(KeyManagerFactory.getDefaultAlgorithm());
|
||||
char[] keyPassword = ssl.getKeyPassword() != null
|
||||
? ssl.getKeyPassword().toCharArray() : null;
|
||||
char[] keyPassword = getKeyPassword() != null
|
||||
? getKeyPassword().toCharArray() : null;
|
||||
|
||||
if (keyPassword == null && ssl.getKeyStorePassword() != null) {
|
||||
keyPassword = ssl.getKeyStorePassword().toCharArray();
|
||||
if (keyPassword == null && getKeyStorePassword() != null) {
|
||||
keyPassword = getKeyStorePassword().toCharArray();
|
||||
}
|
||||
|
||||
keyManagerFactory.init(this.createKeyStore(), keyPassword);
|
||||
@@ -482,18 +482,17 @@ public class HttpClientProperties {
|
||||
|
||||
public KeyStore createKeyStore() {
|
||||
try {
|
||||
KeyStore store = ssl.getKeyStoreProvider() != null
|
||||
? KeyStore.getInstance(ssl.getKeyStoreType(),
|
||||
ssl.getKeyStoreProvider())
|
||||
: KeyStore.getInstance(ssl.getKeyStoreType());
|
||||
KeyStore store = getKeyStoreProvider() != null
|
||||
? KeyStore.getInstance(getKeyStoreType(), getKeyStoreProvider())
|
||||
: KeyStore.getInstance(getKeyStoreType());
|
||||
try {
|
||||
URL url = ResourceUtils.getURL(ssl.getKeyStore());
|
||||
store.load(url.openStream(), ssl.getKeyStorePassword() != null
|
||||
? ssl.getKeyStorePassword().toCharArray() : null);
|
||||
URL url = ResourceUtils.getURL(getKeyStore());
|
||||
store.load(url.openStream(), getKeyStorePassword() != null
|
||||
? getKeyStorePassword().toCharArray() : null);
|
||||
}
|
||||
catch (Exception e) {
|
||||
throw new WebServerException(
|
||||
"Could not load key store ' " + ssl.getKeyStore() + "'", e);
|
||||
"Could not load key store ' " + getKeyStore() + "'", e);
|
||||
}
|
||||
|
||||
return store;
|
||||
@@ -561,7 +560,7 @@ public class HttpClientProperties {
|
||||
|
||||
}
|
||||
|
||||
public class Websocket {
|
||||
public static class Websocket {
|
||||
|
||||
/** Max frame payload length. */
|
||||
private Integer maxFramePayloadLength;
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
/*
|
||||
* 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.event;
|
||||
|
||||
import org.springframework.context.ApplicationEvent;
|
||||
|
||||
/**
|
||||
* @author alvin
|
||||
*/
|
||||
public class RefreshRoutesResultEvent extends ApplicationEvent {
|
||||
|
||||
private Throwable throwable;
|
||||
|
||||
public RefreshRoutesResultEvent(Object source, Throwable throwable) {
|
||||
super(source);
|
||||
this.throwable = throwable;
|
||||
}
|
||||
|
||||
public RefreshRoutesResultEvent(Object source) {
|
||||
super(source);
|
||||
}
|
||||
|
||||
public Throwable getThrowable() {
|
||||
return throwable;
|
||||
}
|
||||
|
||||
public boolean isSuccess() {
|
||||
return throwable == null;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
/*
|
||||
* 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.factory;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
import reactor.core.publisher.Mono;
|
||||
|
||||
import org.springframework.cloud.gateway.filter.GatewayFilter;
|
||||
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
|
||||
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
|
||||
import org.springframework.http.server.reactive.ServerHttpRequest;
|
||||
import org.springframework.web.server.ServerWebExchange;
|
||||
|
||||
import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
|
||||
import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.PRESERVE_HOST_HEADER_ATTRIBUTE;
|
||||
|
||||
/**
|
||||
* @author Andrew Fitzgerald
|
||||
*/
|
||||
public class SetRequestHostHeaderGatewayFilterFactory extends
|
||||
AbstractGatewayFilterFactory<SetRequestHostHeaderGatewayFilterFactory.Config> {
|
||||
|
||||
public SetRequestHostHeaderGatewayFilterFactory() {
|
||||
super(Config.class);
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<String> shortcutFieldOrder() {
|
||||
return Collections.singletonList("host");
|
||||
}
|
||||
|
||||
@Override
|
||||
public GatewayFilter apply(Config config) {
|
||||
return new GatewayFilter() {
|
||||
@Override
|
||||
public Mono<Void> filter(ServerWebExchange exchange,
|
||||
GatewayFilterChain chain) {
|
||||
String value = ServerWebExchangeUtils.expand(exchange, config.getHost());
|
||||
|
||||
ServerHttpRequest request = exchange.getRequest().mutate()
|
||||
.headers(httpHeaders -> {
|
||||
httpHeaders.remove("Host");
|
||||
httpHeaders.add("Host", value);
|
||||
}).build();
|
||||
|
||||
// Make sure the header we just set is preserved
|
||||
exchange.getAttributes().put(PRESERVE_HOST_HEADER_ATTRIBUTE, true);
|
||||
|
||||
return chain.filter(exchange.mutate().request(request).build());
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return filterToStringCreator(
|
||||
SetRequestHostHeaderGatewayFilterFactory.this)
|
||||
.append(config.getHost()).toString();
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
public static class Config {
|
||||
|
||||
private String host;
|
||||
|
||||
public String getHost() {
|
||||
return host;
|
||||
}
|
||||
|
||||
public void setHost(String host) {
|
||||
this.host = host;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -38,6 +38,8 @@ public class CachedBodyOutputMessage implements ReactiveHttpOutputMessage {
|
||||
|
||||
private final HttpHeaders httpHeaders;
|
||||
|
||||
private boolean cached = false;
|
||||
|
||||
private Flux<DataBuffer> body = Flux.error(new IllegalStateException(
|
||||
"The body is not set. " + "Did handling complete with success?"));
|
||||
|
||||
@@ -56,6 +58,10 @@ public class CachedBodyOutputMessage implements ReactiveHttpOutputMessage {
|
||||
return false;
|
||||
}
|
||||
|
||||
boolean isCached() {
|
||||
return this.cached;
|
||||
}
|
||||
|
||||
@Override
|
||||
public HttpHeaders getHeaders() {
|
||||
return this.httpHeaders;
|
||||
@@ -76,6 +82,7 @@ public class CachedBodyOutputMessage implements ReactiveHttpOutputMessage {
|
||||
|
||||
public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
|
||||
this.body = Flux.from(body);
|
||||
this.cached = true;
|
||||
return Mono.empty();
|
||||
}
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
package org.springframework.cloud.gateway.filter.factory.rewrite;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.function.Function;
|
||||
|
||||
import reactor.core.publisher.Flux;
|
||||
import reactor.core.publisher.Mono;
|
||||
@@ -26,6 +27,7 @@ import org.springframework.cloud.gateway.filter.GatewayFilterChain;
|
||||
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.support.BodyInserterContext;
|
||||
import org.springframework.core.io.buffer.DataBuffer;
|
||||
import org.springframework.core.io.buffer.DataBufferUtils;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.codec.HttpMessageReader;
|
||||
import org.springframework.http.server.reactive.ServerHttpRequest;
|
||||
@@ -98,7 +100,9 @@ public class ModifyRequestBodyGatewayFilterFactory extends
|
||||
outputMessage);
|
||||
return chain
|
||||
.filter(exchange.mutate().request(decorator).build());
|
||||
}));
|
||||
})).onErrorResume(
|
||||
(Function<Throwable, Mono<Void>>) throwable -> release(
|
||||
exchange, outputMessage, throwable));
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -111,6 +115,15 @@ public class ModifyRequestBodyGatewayFilterFactory extends
|
||||
};
|
||||
}
|
||||
|
||||
protected Mono<Void> release(ServerWebExchange exchange,
|
||||
CachedBodyOutputMessage outputMessage, Throwable throwable) {
|
||||
if (outputMessage.isCached()) {
|
||||
return outputMessage.getBody().map(DataBufferUtils::release)
|
||||
.then(Mono.error(throwable));
|
||||
}
|
||||
return Mono.error(throwable);
|
||||
}
|
||||
|
||||
ServerHttpRequestDecorator decorate(ServerWebExchange exchange, HttpHeaders headers,
|
||||
CachedBodyOutputMessage outputMessage) {
|
||||
return new ServerHttpRequestDecorator(exchange.getRequest()) {
|
||||
|
||||
@@ -46,11 +46,16 @@ public class ReadBodyPredicateFactory
|
||||
|
||||
private static final String CACHE_REQUEST_BODY_OBJECT_KEY = "cachedRequestBodyObject";
|
||||
|
||||
private static final List<HttpMessageReader<?>> messageReaders = HandlerStrategies
|
||||
.withDefaults().messageReaders();
|
||||
private final List<HttpMessageReader<?>> messageReaders;
|
||||
|
||||
public ReadBodyPredicateFactory() {
|
||||
super(Config.class);
|
||||
this.messageReaders = HandlerStrategies.withDefaults().messageReaders();
|
||||
}
|
||||
|
||||
public ReadBodyPredicateFactory(List<HttpMessageReader<?>> messageReaders) {
|
||||
super(Config.class);
|
||||
this.messageReaders = messageReaders;
|
||||
}
|
||||
|
||||
@Override
|
||||
|
||||
@@ -21,10 +21,15 @@ import java.util.Map;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import reactor.cache.CacheFlux;
|
||||
import reactor.core.publisher.Flux;
|
||||
|
||||
import org.springframework.cloud.gateway.event.RefreshRoutesEvent;
|
||||
import org.springframework.cloud.gateway.event.RefreshRoutesResultEvent;
|
||||
import org.springframework.context.ApplicationEventPublisher;
|
||||
import org.springframework.context.ApplicationEventPublisherAware;
|
||||
import org.springframework.context.ApplicationListener;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.annotation.AnnotationAwareOrderComparator;
|
||||
@@ -32,8 +37,10 @@ import org.springframework.core.annotation.AnnotationAwareOrderComparator;
|
||||
/**
|
||||
* @author Spencer Gibb
|
||||
*/
|
||||
public class CachingRouteLocator
|
||||
implements Ordered, RouteLocator, ApplicationListener<RefreshRoutesEvent> {
|
||||
public class CachingRouteLocator implements Ordered, RouteLocator,
|
||||
ApplicationListener<RefreshRoutesEvent>, ApplicationEventPublisherAware {
|
||||
|
||||
private static final Log log = LogFactory.getLog(CachingRouteLocator.class);
|
||||
|
||||
private static final String CACHE_KEY = "routes";
|
||||
|
||||
@@ -43,6 +50,8 @@ public class CachingRouteLocator
|
||||
|
||||
private final Map<String, List> cache = new ConcurrentHashMap<>();
|
||||
|
||||
private ApplicationEventPublisher applicationEventPublisher;
|
||||
|
||||
public CachingRouteLocator(RouteLocator delegate) {
|
||||
this.delegate = delegate;
|
||||
routes = CacheFlux.lookup(cache, CACHE_KEY, Route.class)
|
||||
@@ -69,8 +78,25 @@ public class CachingRouteLocator
|
||||
|
||||
@Override
|
||||
public void onApplicationEvent(RefreshRoutesEvent event) {
|
||||
fetch().materialize().collect(Collectors.toList())
|
||||
.doOnNext(routes -> cache.put(CACHE_KEY, routes)).subscribe();
|
||||
try {
|
||||
fetch().collect(Collectors.toList()).subscribe(list -> Flux.fromIterable(list)
|
||||
.materialize().collect(Collectors.toList()).subscribe(signals -> {
|
||||
applicationEventPublisher
|
||||
.publishEvent(new RefreshRoutesResultEvent(this));
|
||||
cache.put(CACHE_KEY, signals);
|
||||
}, throwable -> handleRefreshError(throwable)));
|
||||
}
|
||||
catch (Throwable e) {
|
||||
handleRefreshError(e);
|
||||
}
|
||||
}
|
||||
|
||||
private void handleRefreshError(Throwable throwable) {
|
||||
if (log.isErrorEnabled()) {
|
||||
log.error("Refresh routes error !!!", throwable);
|
||||
}
|
||||
applicationEventPublisher
|
||||
.publishEvent(new RefreshRoutesResultEvent(this, throwable));
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -78,4 +104,10 @@ public class CachingRouteLocator
|
||||
return 0;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setApplicationEventPublisher(
|
||||
ApplicationEventPublisher applicationEventPublisher) {
|
||||
this.applicationEventPublisher = applicationEventPublisher;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -62,6 +62,7 @@ import org.springframework.cloud.gateway.filter.factory.SaveSessionGatewayFilter
|
||||
import org.springframework.cloud.gateway.filter.factory.SecureHeadersGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetPathGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetRequestHeaderGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetRequestHostHeaderGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetResponseHeaderGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SetStatusGatewayFilterFactory;
|
||||
import org.springframework.cloud.gateway.filter.factory.SpringCloudCircuitBreakerFilterFactory;
|
||||
@@ -360,6 +361,17 @@ public class GatewayFilterSpec extends UriSpec {
|
||||
return filter(getBean(PreserveHostHeaderGatewayFilterFactory.class).apply());
|
||||
}
|
||||
|
||||
/**
|
||||
* A filter that will set the Host header to
|
||||
* {@param hostName} on the outgoing request
|
||||
* @param hostName the updated Host header value
|
||||
* @return a {@link GatewayFilterSpec} that can be used to apply additional filters
|
||||
*/
|
||||
public GatewayFilterSpec setHostHeader(String hostName) {
|
||||
return filter(getBean(SetRequestHostHeaderGatewayFilterFactory.class)
|
||||
.apply(c -> c.setHost(hostName)));
|
||||
}
|
||||
|
||||
/**
|
||||
* A filter that will return a redirect response back to the client.
|
||||
* @param status an HTTP status code, should be a {@code 300} series redirect
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
/*
|
||||
* 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.factory;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
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.filter.GatewayFilter;
|
||||
import org.springframework.cloud.gateway.test.BaseWebClientTests;
|
||||
import org.springframework.context.annotation.Import;
|
||||
import org.springframework.test.annotation.DirtiesContext;
|
||||
import org.springframework.test.context.junit4.SpringRunner;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
|
||||
import static org.springframework.cloud.gateway.test.TestUtils.getMap;
|
||||
|
||||
@RunWith(SpringRunner.class)
|
||||
@SpringBootTest(webEnvironment = RANDOM_PORT)
|
||||
@DirtiesContext
|
||||
public class SetRequestHostHeaderGatewayFilterFactoryTests extends BaseWebClientTests {
|
||||
|
||||
@Test
|
||||
public void setRequestHostHeaderFilterWorks() {
|
||||
testClient.get().uri("/headers").header("Host", "www.setrequesthostheader.org")
|
||||
.exchange().expectStatus().isOk().expectBody(Map.class)
|
||||
.consumeWith(result -> {
|
||||
Map<String, Object> headers = getMap(result.getResponseBody(),
|
||||
"headers");
|
||||
assertThat(headers).hasEntrySatisfying("Host",
|
||||
val -> assertThat(val).isEqualTo("otherhost.io"));
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
public void toStringFormat() {
|
||||
SetRequestHostHeaderGatewayFilterFactory.Config config = new SetRequestHostHeaderGatewayFilterFactory.Config();
|
||||
config.setHost("myhost");
|
||||
GatewayFilter filter = new SetRequestHostHeaderGatewayFilterFactory()
|
||||
.apply(config);
|
||||
assertThat(filter.toString()).contains("myhost");
|
||||
}
|
||||
|
||||
@EnableAutoConfiguration
|
||||
@SpringBootConfiguration
|
||||
@Import(DefaultTestConfig.class)
|
||||
public static class TestConfig {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,182 @@
|
||||
/*
|
||||
* 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.factory.rewrite;
|
||||
|
||||
import java.util.concurrent.atomic.AtomicInteger;
|
||||
|
||||
import javax.net.ssl.SSLException;
|
||||
|
||||
import io.netty.handler.ssl.SslContext;
|
||||
import io.netty.handler.ssl.SslContextBuilder;
|
||||
import io.netty.handler.ssl.util.InsecureTrustManagerFactory;
|
||||
import io.netty.util.internal.PlatformDependent;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import reactor.core.publisher.Mono;
|
||||
import reactor.netty.http.client.HttpClient;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.boot.SpringBootConfiguration;
|
||||
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.cloud.gateway.route.RouteLocator;
|
||||
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
|
||||
import org.springframework.cloud.gateway.test.BaseWebClientTests;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.DependsOn;
|
||||
import org.springframework.context.annotation.Import;
|
||||
import org.springframework.context.annotation.Primary;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.client.reactive.ReactorClientHttpConnector;
|
||||
import org.springframework.http.codec.ServerCodecConfigurer;
|
||||
import org.springframework.test.annotation.DirtiesContext;
|
||||
import org.springframework.test.context.ActiveProfiles;
|
||||
import org.springframework.test.context.junit4.SpringRunner;
|
||||
import org.springframework.web.reactive.function.BodyInserters;
|
||||
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;
|
||||
|
||||
/**
|
||||
* @author fangfeikun
|
||||
*/
|
||||
@RunWith(SpringRunner.class)
|
||||
@SpringBootTest(webEnvironment = RANDOM_PORT,
|
||||
properties = { "spring.cloud.gateway.httpclient.ssl.handshake-timeout=1ms",
|
||||
"spring.main.allow-bean-definition-overriding=true" })
|
||||
@DirtiesContext
|
||||
@ActiveProfiles("single-cert-ssl")
|
||||
public class ModifyRequestBodyGatewayFilterFactorySslTimeoutTests
|
||||
extends BaseWebClientTests {
|
||||
|
||||
@Autowired
|
||||
AtomicInteger releaseCount;
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
try {
|
||||
SslContext sslContext = SslContextBuilder.forClient()
|
||||
.trustManager(InsecureTrustManagerFactory.INSTANCE).build();
|
||||
HttpClient httpClient = HttpClient.create()
|
||||
.secure(ssl -> ssl.sslContext(sslContext));
|
||||
setup(new ReactorClientHttpConnector(httpClient),
|
||||
"https://localhost:" + port);
|
||||
}
|
||||
catch (SSLException e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void modifyRequestBodySSLTimeout() {
|
||||
testClient.post().uri("/post")
|
||||
.header("Host", "www.modifyrequestbodyssltimeout.org")
|
||||
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE)
|
||||
.body(BodyInserters.fromValue("request")).exchange().expectStatus()
|
||||
.isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR).expectBody()
|
||||
.jsonPath("message").isEqualTo("handshake timed out after 1ms");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void modifyRequestBodyRelease() {
|
||||
releaseCount.set(0);
|
||||
// long initialUsedDirectMemory = PlatformDependent.usedDirectMemory();
|
||||
for (int i = 0; i < 10; i++) {
|
||||
testClient.post().uri("/post")
|
||||
.header("Host", "www.modifyrequestbodyssltimeout.org")
|
||||
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE)
|
||||
.body(BodyInserters.fromValue("request")).exchange().expectStatus()
|
||||
.isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR);
|
||||
long usedDirectMemory = PlatformDependent.usedDirectMemory();
|
||||
// Assert.assertTrue(usedDirectMemory - initialUsedDirectMemory < 2 * 10 * 10
|
||||
// * 1024 * 1024);
|
||||
}
|
||||
assertThat(releaseCount).hasValue(10);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void modifyRequestBodyHappenedError() {
|
||||
testClient.post().uri("/post")
|
||||
.header("Host", "www.modifyrequestbodyexception.org")
|
||||
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE)
|
||||
.body(BodyInserters.fromValue("request")).exchange().expectStatus()
|
||||
.isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR).expectBody()
|
||||
.jsonPath("message").isEqualTo("modify body exception");
|
||||
}
|
||||
|
||||
@EnableAutoConfiguration
|
||||
@SpringBootConfiguration(proxyBeanMethods = false)
|
||||
@Import(DefaultTestConfig.class)
|
||||
public static class TestConfig {
|
||||
|
||||
@Value("${test.uri}")
|
||||
String uri;
|
||||
|
||||
@Bean
|
||||
@DependsOn("testModifyRequestBodyGatewayFilterFactory")
|
||||
public RouteLocator testRouteLocator(RouteLocatorBuilder builder) {
|
||||
return builder.routes().route("test_modify_request_body_ssl_timeout",
|
||||
r -> r.order(-1).host("**.modifyrequestbodyssltimeout.org")
|
||||
.filters(f -> f.modifyRequestBody(String.class, String.class,
|
||||
MediaType.APPLICATION_JSON_VALUE,
|
||||
(serverWebExchange, aVoid) -> {
|
||||
byte[] largeBody = new byte[10 * 1024 * 1024];
|
||||
return Mono.just(new String(largeBody));
|
||||
}))
|
||||
.uri(uri))
|
||||
.route("test_modify_request_body_exception", r -> r.order(-1)
|
||||
.host("**.modifyrequestbodyexception.org")
|
||||
.filters(f -> f.modifyRequestBody(String.class, String.class,
|
||||
MediaType.APPLICATION_JSON_VALUE,
|
||||
(serverWebExchange, body) -> {
|
||||
return Mono.error(
|
||||
new Exception("modify body exception"));
|
||||
}))
|
||||
.uri(uri))
|
||||
.build();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public AtomicInteger count() {
|
||||
return new AtomicInteger();
|
||||
}
|
||||
|
||||
@Bean
|
||||
@Primary
|
||||
public ModifyRequestBodyGatewayFilterFactory testModifyRequestBodyGatewayFilterFactory(
|
||||
ServerCodecConfigurer codecConfigurer, AtomicInteger count) {
|
||||
return new ModifyRequestBodyGatewayFilterFactory(
|
||||
codecConfigurer.getReaders()) {
|
||||
@Override
|
||||
protected Mono<Void> release(ServerWebExchange exchange,
|
||||
CachedBodyOutputMessage outputMessage, Throwable throwable) {
|
||||
if (outputMessage.isCached()) {
|
||||
count.incrementAndGet();
|
||||
}
|
||||
return super.release(exchange, outputMessage, throwable);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -16,11 +16,17 @@
|
||||
|
||||
package org.springframework.cloud.gateway.route;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.CountDownLatch;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
import org.junit.Test;
|
||||
import reactor.core.publisher.Flux;
|
||||
|
||||
import org.springframework.cloud.gateway.event.RefreshRoutesEvent;
|
||||
import org.springframework.cloud.gateway.event.RefreshRoutesResultEvent;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
public class CachingRouteLocatorTests {
|
||||
@@ -60,6 +66,73 @@ public class CachingRouteLocatorTests {
|
||||
assertThat(routes).containsExactly(route1, route2);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void refreshWorksWhenFirstRefreshSuccessAndOtherError()
|
||||
throws InterruptedException {
|
||||
Route route1 = route(1);
|
||||
Route route2 = route(2);
|
||||
|
||||
CachingRouteLocator locator = new CachingRouteLocator(new RouteLocator() {
|
||||
int i = 0;
|
||||
|
||||
@Override
|
||||
public Flux<Route> getRoutes() {
|
||||
if (i == 0) {
|
||||
i++;
|
||||
return Flux.just(route1);
|
||||
}
|
||||
else if (i == 1) {
|
||||
i++;
|
||||
return Flux.just(route2).map(route -> {
|
||||
throw new RuntimeException("in chain.");
|
||||
});
|
||||
}
|
||||
else if (i == 2) {
|
||||
i++;
|
||||
throw new RuntimeException("call getRoutes error.");
|
||||
}
|
||||
return Flux.just(route2);
|
||||
}
|
||||
});
|
||||
|
||||
List<Route> routes = locator.getRoutes().collectList().block();
|
||||
assertThat(routes).containsExactly(route1);
|
||||
|
||||
List<RefreshRoutesResultEvent> resultEvents = new ArrayList<>();
|
||||
|
||||
waitUntilRefreshFinished(locator, resultEvents);
|
||||
assertThat(resultEvents).hasSize(1);
|
||||
assertThat(resultEvents.get(0).getThrowable().getCause().getMessage())
|
||||
.isEqualTo("in chain.");
|
||||
assertThat(resultEvents.get(0).isSuccess()).isEqualTo(false);
|
||||
assertThat(locator.getRoutes().collectList().block()).containsExactly(route1);
|
||||
|
||||
waitUntilRefreshFinished(locator, resultEvents);
|
||||
assertThat(resultEvents).hasSize(2);
|
||||
assertThat(resultEvents.get(1).getThrowable().getMessage())
|
||||
.isEqualTo("call getRoutes error.");
|
||||
assertThat(resultEvents.get(1).isSuccess()).isEqualTo(false);
|
||||
assertThat(locator.getRoutes().collectList().block()).containsExactly(route1);
|
||||
|
||||
waitUntilRefreshFinished(locator, resultEvents);
|
||||
assertThat(resultEvents).hasSize(3);
|
||||
assertThat(resultEvents.get(2).isSuccess()).isEqualTo(true);
|
||||
assertThat(locator.getRoutes().collectList().block()).containsExactly(route2);
|
||||
|
||||
}
|
||||
|
||||
private void waitUntilRefreshFinished(CachingRouteLocator locator,
|
||||
List<RefreshRoutesResultEvent> resultEvents) throws InterruptedException {
|
||||
CountDownLatch cdl = new CountDownLatch(1);
|
||||
locator.setApplicationEventPublisher(o -> {
|
||||
resultEvents.add((RefreshRoutesResultEvent) o);
|
||||
cdl.countDown();
|
||||
});
|
||||
locator.onApplicationEvent(new RefreshRoutesEvent(this));
|
||||
|
||||
assertThat(cdl.await(5, TimeUnit.SECONDS)).isTrue();
|
||||
}
|
||||
|
||||
Route route(int id) {
|
||||
return Route.async().id(String.valueOf(id)).uri("http://localhost/" + id)
|
||||
.order(id).predicate(exchange -> true).build();
|
||||
|
||||
@@ -326,6 +326,15 @@ spring:
|
||||
filters:
|
||||
- SecureHeaders
|
||||
|
||||
# =====================================
|
||||
- id: set_request_host_header_test
|
||||
uri: ${test.uri}
|
||||
predicates:
|
||||
- Host=**.setrequesthostheader.org
|
||||
- Path=/headers
|
||||
filters:
|
||||
- SetRequestHostHeader=otherhost.io
|
||||
|
||||
# =====================================
|
||||
- id: set_path_test
|
||||
uri: ${test.uri}
|
||||
|
||||
Reference in New Issue
Block a user