crabapples
/
Sentinel
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix issue 2485 which occur oom when using async servlet request. (#3440) 

* fix issue 2485 which occur oom when using async servlet request.

* optimize imports

* 1. fix the same issue in the webmvc-v6x
2. improve based on review comments
This commit is contained in:
Lingzhi 2024-08-23 13:43:53 +08:00 committed by GitHub
parent b78b09d324
commit 195150bc74
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 142 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
sentinel-adapter/sentinel-spring-webmvc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/AbstractSentinelInterceptor.java
View File

@ -26,9 +26,11 @@ import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.util.AssertUtil;
import com.alibaba.csp.sentinel.util.StringUtil;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.AsyncHandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
@ -50,11 +52,11 @@ import java.util.Objects;
* return mav;
* }
* </pre>
*
*
* @author kaizi2009
* @since 1.7.1
*/
public abstract class AbstractSentinelInterceptor implements HandlerInterceptor {
public abstract class AbstractSentinelInterceptor implements AsyncHandlerInterceptor {
public static final String SENTINEL_SPRING_WEB_CONTEXT_NAME = "sentinel_spring_web_context";
private static final String EMPTY_ORIGIN = "";
@ -66,12 +68,12 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
AssertUtil.assertNotBlank(config.getRequestAttributeName(), "requestAttributeName should not be blank");
this.baseWebMvcConfig = config;
}
/**
* @param request
* @param rcKey
* @param step
* @return reference count after increasing (initial value as zero to be increased)
* @return reference count after increasing (initial value as zero to be increased)
*/
private Integer increaseReference(HttpServletRequest request, String rcKey, int step) {
Object obj = request.getAttribute(rcKey);
@ -85,10 +87,10 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
request.setAttribute(rcKey, newRc);
return newRc;
}
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
throws Exception {
try {
String resourceName = getResourceName(request);
@ -99,7 +101,7 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
if (increaseReference(request, this.baseWebMvcConfig.getRequestRefName(), 1) != 1) {
return true;
}
// Parse the request origin using registered origin parser.
String origin = parseOrigin(request);
String contextName = getContextName(request);
@ -135,13 +137,37 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
return SENTINEL_SPRING_WEB_CONTEXT_NAME;
}
/**
* When a handler starts an asynchronous request, the DispatcherServlet exits without invoking postHandle and afterCompletion
* Called instead of postHandle and afterCompletion to exit the context and clean thread-local variables when the handler is being executed concurrently.
*
* @param request the current request
* @param response the current response
* @param handler the handler (or {@link HandlerMethod}) that started async
* execution, for type and/or instance examination
*/
@Override
public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
exit(request);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) throws Exception {
exit(request, ex);
}
private void exit(HttpServletRequest request) {
exit(request, null);
}
private void exit(HttpServletRequest request, Exception ex) {
if (increaseReference(request, this.baseWebMvcConfig.getRequestRefName(), -1) != 0) {
return;
}
Entry entry = getEntryInRequest(request, baseWebMvcConfig.getRequestAttributeName());
if (entry == null) {
// should not happen
@ -149,7 +175,7 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
getClass().getSimpleName(), baseWebMvcConfig.getRequestAttributeName());
return;
}
traceExceptionAndExit(entry, ex);
removeEntryInRequest(request);
ContextUtil.exit();
@ -162,7 +188,7 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
protected Entry getEntryInRequest(HttpServletRequest request, String attrKey) {
Object entryObject = request.getAttribute(attrKey);
return entryObject == null ? null : (Entry)entryObject;
return entryObject == null ? null : (Entry) entryObject;
}
protected void removeEntryInRequest(HttpServletRequest request) {
@ -188,7 +214,7 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
}
protected void handleBlockException(HttpServletRequest request, HttpServletResponse response, BlockException e)
throws Exception {
throws Exception {
if (baseWebMvcConfig.getBlockExceptionHandler() != null) {
baseWebMvcConfig.getBlockExceptionHandler().handle(request, response, e);
} else {

14
sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/SentinelSpringMvcIntegrationTest.java
View File

@ -17,10 +17,12 @@ package com.alibaba.csp.sentinel.adapter.spring.webmvc;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.node.ClusterNode;
import com.alibaba.csp.sentinel.slots.block.RuleConstant;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule;
@ -66,6 +68,18 @@ public class SentinelSpringMvcIntegrationTest {
assertEquals(1, cn.passQps(), 0.01);
}
@Test
public void testAsync() throws Exception {
String url = "/async";
this.mvc.perform(get(url))
.andExpect(status().isOk());
ClusterNode cn = ClusterBuilderSlot.getClusterNode(url);
assertNotNull(cn);
assertEquals(1, cn.passQps(), 0.01);
assertNull(ContextUtil.getContext());
}
@Test
public void testOriginParser() throws Exception {
String springMvcPathVariableUrl = "/foo/{id}";

14
sentinel-adapter/sentinel-spring-webmvc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc/controller/TestController.java
View File

@ -19,7 +19,9 @@ package com.alibaba.csp.sentinel.adapter.spring.webmvc.controller;
import com.alibaba.csp.sentinel.adapter.spring.webmvc.exception.BizException;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.async.DeferredResult;
/**
* @author kaizi2009
@ -58,4 +60,16 @@ public class TestController {
return "Exclude " + id;
}
@GetMapping("/async")
@ResponseBody
public DeferredResult<String> distribute() throws Exception{
DeferredResult<String> result = new DeferredResult<>();
Thread thread = new Thread(() -> result.setResult("async result."));
thread.start();
Thread.yield();
return result;
}
}

35
sentinel-adapter/sentinel-spring-webmvc-v6x-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/spring/webmvc_v6x/AbstractSentinelInterceptor.java
View File

@ -15,7 +15,11 @@
*/
package com.alibaba.csp.sentinel.adapter.spring.webmvc_v6x;
import com.alibaba.csp.sentinel.*;
import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.EntryType;
import com.alibaba.csp.sentinel.ResourceTypeConstants;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
import com.alibaba.csp.sentinel.adapter.spring.webmvc_v6x.config.BaseWebMvcConfig;
import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.log.RecordLog;
@ -24,7 +28,8 @@ import com.alibaba.csp.sentinel.util.AssertUtil;
import com.alibaba.csp.sentinel.util.StringUtil;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.AsyncHandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
@ -45,7 +50,7 @@ import org.springframework.web.servlet.ModelAndView;
*
* @since 1.8.8
*/
public abstract class AbstractSentinelInterceptor implements HandlerInterceptor {
public abstract class AbstractSentinelInterceptor implements AsyncHandlerInterceptor {
public static final String SENTINEL_SPRING_WEB_CONTEXT_NAME = "sentinel_spring_web_context";
private static final String EMPTY_ORIGIN = "";
@ -124,9 +129,33 @@ public abstract class AbstractSentinelInterceptor implements HandlerInterceptor
return SENTINEL_SPRING_WEB_CONTEXT_NAME;
}
/**
* When a handler starts an asynchronous request, the DispatcherServlet exits without invoking postHandle and afterCompletion
* Called instead of postHandle and afterCompletion to exit the context and clean thread-local variables when the handler is being executed concurrently.
*
* @param request the current request
* @param response the current response
* @param handler the handler (or {@link HandlerMethod}) that started async
* execution, for type and/or instance examination
*/
@Override
public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
exit(request);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) throws Exception {
exit(request, ex);
}
private void exit(HttpServletRequest request) {
exit(request, null);
}
private void exit(HttpServletRequest request, Exception ex) {
if (increaseReference(request, this.baseWebMvcConfig.getRequestRefName(), -1) != 0) {
return;
}

16
sentinel-adapter/sentinel-spring-webmvc-v6x-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc_v6x/SentinelSpringMvcIntegrationTest.java
View File

@ -17,10 +17,12 @@ package com.alibaba.csp.sentinel.adapter.spring.webmvc_v6x;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import com.alibaba.csp.sentinel.context.ContextUtil;
import com.alibaba.csp.sentinel.node.ClusterNode;
import com.alibaba.csp.sentinel.slots.block.RuleConstant;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
@ -64,6 +66,18 @@ public class SentinelSpringMvcIntegrationTest {
assertEquals(1, cn.passQps(), 0.01);
}
@Test
public void testAsync() throws Exception {
String url = "/async";
this.mvc.perform(get(url))
.andExpect(status().isOk());
ClusterNode cn = ClusterBuilderSlot.getClusterNode(url);
assertNotNull(cn);
assertEquals(1, cn.passQps(), 0.01);
assertNull(ContextUtil.getContext());
}
@Test
public void testOriginParser() throws Exception {
String springMvcPathVariableUrl = "/foo/{id}";
@ -78,7 +92,7 @@ public class SentinelSpringMvcIntegrationTest {
// This will be blocked since the caller is same: userA
this.mvc.perform(
get("/foo/2").accept(MediaType.APPLICATION_JSON).header(headerName, limitOrigin))
get("/foo/2").accept(MediaType.APPLICATION_JSON).header(headerName, limitOrigin))
.andExpect(status().isOk())
.andExpect(content().json(ResultWrapper.blocked().toJsonString()));

14
sentinel-adapter/sentinel-spring-webmvc-v6x-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/spring/webmvc_v6x/controller/TestController.java
View File

@ -18,7 +18,9 @@ package com.alibaba.csp.sentinel.adapter.spring.webmvc_v6x.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.async.DeferredResult;
/**
* @author kaizi2009
@ -52,4 +54,16 @@ public class TestController {
return "Exclude " + id;
}
@GetMapping("/async")
@ResponseBody
public DeferredResult<String> distribute() throws Exception {
DeferredResult<String> result = new DeferredResult<>();
Thread thread = new Thread(() -> result.setResult("async result."));
thread.start();
Thread.yield();
return result;
}
}

16
sentinel-demo/sentinel-demo-spring-webmvc/src/main/java/com/alibaba/csp/sentinel/demo/spring/webmvc/controller/WebMvcTestController.java
View File

@ -17,14 +17,17 @@ package com.alibaba.csp.sentinel.demo.spring.webmvc.controller;
import java.util.Random;
import java.util.concurrent.TimeUnit;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.context.request.async.DeferredResult;
import org.springframework.web.servlet.ModelAndView;
/**
* Test controller
*
* @author kaizi2009
*/
@Controller
@ -57,7 +60,7 @@ public class WebMvcTestController {
doBusiness();
return "Exclude " + id;
}
@GetMapping("/forward")
public ModelAndView apiForward() {
ModelAndView mav = new ModelAndView();
@ -65,6 +68,17 @@ public class WebMvcTestController {
return mav;
}
@GetMapping("/async")
@ResponseBody
public DeferredResult<String> distribute() throws Exception {
DeferredResult<String> result = new DeferredResult<>(4000L);
Thread thread = new Thread(() -> result.setResult("async result"));
thread.start();
return result;
}
private void doBusiness() {
Random random = new Random(1);
try {