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

Jump to bottom

Fix potential memory leak when using ReadBodyRoutePredicateFactory #3465

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+26 −22
Open

Fix potential memory leak when using ReadBodyRoutePredicateFactory #3465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8bc2081
Fix potential memory leak when using ReadBodyRoutePredicateFactory
qnnn Jul 19, 2024
34f749a
corrected function name clearRequestRequestBody to clearCachedRequest…
qnnn Jul 19, 2024
cfa3481
Update Copyright year.
qnnn Aug 26, 2024
b439117
Clear the cache body when the route is not found.
qnnn Sep 6, 2024
fdb29a8
Merge branch 'main' into main
qnnn Sep 6, 2024
c2cb50c
Resolved merge conflict by accepting changes from main branch.
qnnn Sep 6, 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
24 changes: 2 additions & 22 deletions ...server/src/main/java/org/springframework/cloud/gateway/filter/RemoveCachedBodyFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,17 @@

package org.springframework.cloud.gateway.filter;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import reactor.core.publisher.Mono;

import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.PooledDataBuffer;
import org.springframework.web.server.ServerWebExchange;

import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR;

public class RemoveCachedBodyFilter implements GlobalFilter, Ordered {

private static final Log log = LogFactory.getLog(RemoveCachedBodyFilter.class);

@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
return chain.filter(exchange).doFinally(s -> {
Object attribute = exchange.getAttributes().remove(CACHED_REQUEST_BODY_ATTR);
if (attribute != null && attribute instanceof PooledDataBuffer) {
PooledDataBuffer dataBuffer = (PooledDataBuffer) attribute;
if (dataBuffer.isAllocated()) {
if (log.isTraceEnabled()) {
log.trace("releasing cached body in exchange attribute");
}
// ensure proper release
while (!dataBuffer.release()) {
// release() counts down until zero, will never be infinite loop
}
}
}
});
return chain.filter(exchange).doFinally(s -> ServerWebExchangeUtils.clearCachedRequestBody(exchange));
}

@Override
Expand Down
2 changes: 2 additions & 0 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 @@ -24,6 +24,7 @@
import org.springframework.cloud.gateway.config.GlobalCorsProperties;
import org.springframework.cloud.gateway.route.Route;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
import org.springframework.core.env.Environment;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.reactive.handler.AbstractHandlerMapping;
Expand Down Expand Up @@ -99,6 +100,7 @@ protected Mono<?> getHandlerInternal(ServerWebExchange exchange) {
})
.switchIfEmpty(Mono.empty().then(Mono.fromRunnable(() -> {
exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR);
ServerWebExchangeUtils.clearCachedRequestBody(exchange);
if (logger.isTraceEnabled()) {
logger.trace("No RouteDefinition found for [" + getExchangeDesc(exchange) + "]");
}
Expand Down
22 changes: 22 additions & 0 deletions ...erver/src/main/java/org/springframework/cloud/gateway/support/ServerWebExchangeUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import org.springframework.core.io.buffer.DataBufferUtils;
import org.springframework.core.io.buffer.DefaultDataBuffer;
import org.springframework.core.io.buffer.NettyDataBuffer;
import org.springframework.core.io.buffer.PooledDataBuffer;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.AbstractServerHttpResponse;
import org.springframework.http.server.reactive.ServerHttpRequest;
Expand Down Expand Up @@ -379,6 +380,27 @@ private static <T> Mono<T> cacheRequestBody(ServerWebExchange exchange, boolean
.flatMap(function);
}

/**
* clear the request body in a ServerWebExchange attribute. The attribute is
* {@link #CACHED_REQUEST_BODY_ATTR}.
* @param exchange the available ServerWebExchange.
*/
public static void clearCachedRequestBody(ServerWebExchange exchange) {
Object attribute = exchange.getAttributes().remove(CACHED_REQUEST_BODY_ATTR);
if (attribute != null && attribute instanceof PooledDataBuffer) {
PooledDataBuffer dataBuffer = (PooledDataBuffer) attribute;
if (dataBuffer.isAllocated()) {
if (log.isTraceEnabled()) {
log.trace("releasing cached body in exchange attribute");
}
// ensure proper release
while (!dataBuffer.release()) {
// release() counts down until zero, will never be infinite loop
}
}
}
}

private static ServerHttpRequest decorate(ServerWebExchange exchange, DataBuffer dataBuffer,
boolean cacheDecoratedRequest) {
if (dataBuffer.readableByteCount() > 0) {
Expand Down