Merge pull request #1544 from newrelic/spring6-pointcut

Spring 6 Jakarta point cuts
newrelic · Oct 11, 2023 · 5a75a5e · 5a75a5e
2 parents d8afa47 + f9f6132
commit 5a75a5e
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 15 deletions.
diff --git a/...-10/src/main/java/com/nr/agent/instrumentation/tomcat10/TomcatServletRequestListener.java b/...-10/src/main/java/com/nr/agent/instrumentation/tomcat10/TomcatServletRequestListener.java
@@ -22,7 +22,6 @@
 public final class TomcatServletRequestListener implements ServletRequestListener {
 
     private static final String SERVLET_EXCEPTION_ATTRIBUTE_NAME = "jakarta.servlet.error.exception";
-    private static final String SPRING6_SERVLET_EXCEPTION_ATTRIBUTE_NAME = "org.springframework.web.servlet.DispatcherServlet.EXCEPTION";
     private static final String REQUEST_FIELD = "request";
 
     private final Field requestField;
@@ -45,7 +44,7 @@ private Field getRequestField() {
     @CatchAndLog
     @Override
     public void requestDestroyed(ServletRequestEvent sre) {
-        Throwable exception = retrieveExceptionFromServlet(sre);
+        Throwable exception =(Throwable) sre.getServletRequest().getAttribute(SERVLET_EXCEPTION_ATTRIBUTE_NAME);
         if (exception != null) {
             AgentBridge.privateApi.reportException(exception);
         }
@@ -98,12 +97,4 @@ private Request_Weaved getRequest(HttpServletRequest httpServletRequest) {
         }
         return null;
     }
-
-    private Throwable retrieveExceptionFromServlet(ServletRequestEvent sre) {
-        //As of Spring 6, when controller advice is used for controller exception handling, the caught exception is
-        //now stored in the servlet attribute map with the "org.springframework.web.servlet.DispatcherServlet.EXCEPTION" key.
-        return (Throwable) (sre.getServletRequest().getAttribute(SERVLET_EXCEPTION_ATTRIBUTE_NAME) != null ?
-                sre.getServletRequest().getAttribute(SERVLET_EXCEPTION_ATTRIBUTE_NAME) :
-                sre.getServletRequest().getAttribute(SPRING6_SERVLET_EXCEPTION_ATTRIBUTE_NAME));
-    }
 }
diff --git a/...elic/agent/instrumentation/pointcuts/frameworks/spring/HandleInternalInvokerPointCut.java b/...elic/agent/instrumentation/pointcuts/frameworks/spring/HandleInternalInvokerPointCut.java
@@ -32,7 +32,13 @@ public HandleInternalInvokerPointCut(PointCutClassTransformer classTransformer)
                                 "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Lorg/springframework/web/method/HandlerMethod;)Lorg/springframework/web/servlet/ModelAndView;"),
                         createExactMethodMatcher(
                                 "invokeHandlerMethod",
-                                "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Lorg/springframework/web/method/HandlerMethod;)Lorg/springframework/web/servlet/ModelAndView;")));
+                                "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Lorg/springframework/web/method/HandlerMethod;)Lorg/springframework/web/servlet/ModelAndView;"),
+                        createExactMethodMatcher(
+                                "invokeHandleMethod",
+                                "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;Lorg/springframework/web/method/HandlerMethod;)Lorg/springframework/web/servlet/ModelAndView;"),
+                        createExactMethodMatcher(
+                                "invokeHandlerMethod",
+                                "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;Lorg/springframework/web/method/HandlerMethod;)Lorg/springframework/web/servlet/ModelAndView;")));
     }
 
     @Override

diff --git a/...ewrelic/agent/instrumentation/pointcuts/frameworks/spring/HandlerInterceptorPointCut.java b/...ewrelic/agent/instrumentation/pointcuts/frameworks/spring/HandlerInterceptorPointCut.java
@@ -33,7 +33,15 @@ public HandlerInterceptorPointCut(PointCutClassTransformer classTransformer) {
                                 "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Ljava/lang/Object;Lorg/springframework/web/servlet/ModelAndView;)V"),
                         new ExactMethodMatcher(
                                 "afterCompletion",
-                                "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Ljava/lang/Object;Ljava/lang/Exception;)V")));
+                                "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Ljava/lang/Object;Ljava/lang/Exception;)V"),
+                        new ExactMethodMatcher("preHandle",
+                                "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;Ljava/lang/Object;)Z"),
+                        new ExactMethodMatcher(
+                                "postHandle",
+                                "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;Ljava/lang/Object;Lorg/springframework/web/servlet/ModelAndView;)V"),
+                        new ExactMethodMatcher(
+                                "afterCompletion",
+                                "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;Ljava/lang/Object;Ljava/lang/Exception;)V")));
     }
 
     @Override

diff --git a/.../newrelic/agent/instrumentation/pointcuts/frameworks/spring/SpringDispatcherPointCut.java b/.../newrelic/agent/instrumentation/pointcuts/frameworks/spring/SpringDispatcherPointCut.java
@@ -40,12 +40,17 @@ public SpringDispatcherPointCut(PointCutClassTransformer classTransformer) {
                                 RENDER_METHOD_NAME,
                                 "(Lorg/springframework/web/servlet/ModelAndView;Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;)V"),
                         new ExactMethodMatcher("doDispatch",
-                                "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;)V")));
+                                "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;)V"),
+                        new ExactMethodMatcher(
+                                RENDER_METHOD_NAME,
+                                "(Lorg/springframework/web/servlet/ModelAndView;Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;)V"),
+                        new ExactMethodMatcher("doDispatch",
+                                "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;)V")));
     }
 
     @Override
     public Tracer doGetTracer(Transaction transaction, ClassMethodSignature sig, Object dispatcher, Object[] args) {
-        if (RENDER_METHOD_NAME == sig.getMethodName()) {
+        if (RENDER_METHOD_NAME.equals(sig.getMethodName())) {
             StringBuilder metricName = new StringBuilder("SpringView");
             if (canSetTransactionName(transaction)) {
                 try {

diff --git a/...lic/agent/instrumentation/pointcuts/frameworks/spring/SpringExceptionHandlerPointCut.java b/...lic/agent/instrumentation/pointcuts/frameworks/spring/SpringExceptionHandlerPointCut.java
@@ -30,7 +30,13 @@ public SpringExceptionHandlerPointCut(PointCutClassTransformer classTransformer)
                                 "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Ljava/lang/Object;Ljava/lang/Exception;)Lorg/springframework/web/servlet/ModelAndView;"),
                         new ExactMethodMatcher(
                                 "triggerAfterCompletion",
-                                "(Lorg/springframework/web/servlet/HandlerExecutionChain;ILjavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Ljava/lang/Exception;)V")));
+                                "(Lorg/springframework/web/servlet/HandlerExecutionChain;ILjavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;Ljava/lang/Exception;)V"),
+                        new ExactMethodMatcher(
+                                PROCESS_HANDLER_EXCEPTION_METHOD_NAME,
+                                "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;Ljava/lang/Object;Ljava/lang/Exception;)Lorg/springframework/web/servlet/ModelAndView;"),
+                        new ExactMethodMatcher(
+                                "triggerAfterCompletion",
+                                "(Lorg/springframework/web/servlet/HandlerExecutionChain;ILjakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;Ljava/lang/Exception;)V")));
     }
 
     @Override