-
Notifications
You must be signed in to change notification settings - Fork 872
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.
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
Fix NullPointerException on tomcat #3705
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
...io/opentelemetry/javaagent/instrumentation/tomcat/v10_0/Tomcat10AttachResponseAdvice.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.tomcat.v10_0; | ||
|
|
||
| import io.opentelemetry.instrumentation.servlet.jakarta.v5_0.JakartaServletHttpServerTracer; | ||
| import io.opentelemetry.javaagent.instrumentation.tomcat.common.TomcatServerHandlerAdviceHelper; | ||
| import net.bytebuddy.asm.Advice; | ||
| import org.apache.coyote.Request; | ||
| import org.apache.coyote.Response; | ||
|
|
||
| public class Tomcat10AttachResponseAdvice { | ||
|
|
||
| @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) | ||
| public static void attachResponse( | ||
| @Advice.Argument(0) Request request, | ||
| @Advice.Argument(2) Response response, | ||
| @Advice.Return boolean success) { | ||
|
|
||
| if (success) { | ||
| TomcatServerHandlerAdviceHelper.attachResponseToRequest( | ||
| Tomcat10ServletEntityProvider.INSTANCE, | ||
| JakartaServletHttpServerTracer.tracer(), | ||
| request, | ||
| response); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 73 additions & 0 deletions
73
...c/test/groovy/io/opentelemetry/javaagent/instrumentation/tomcat/v10_0/AsyncServlet.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.tomcat.v10_0 | ||
|
|
||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.ERROR | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.EXCEPTION | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.INDEXED_CHILD | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.QUERY_PARAM | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.REDIRECT | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.SUCCESS | ||
|
|
||
| import io.opentelemetry.instrumentation.test.base.HttpServerTest | ||
| import jakarta.servlet.annotation.WebServlet | ||
| import jakarta.servlet.http.HttpServlet | ||
| import jakarta.servlet.http.HttpServletRequest | ||
| import jakarta.servlet.http.HttpServletResponse | ||
| import java.util.concurrent.Phaser | ||
|
|
||
| @WebServlet(asyncSupported = true) | ||
| class AsyncServlet extends HttpServlet { | ||
| @Override | ||
| protected void service(HttpServletRequest req, HttpServletResponse resp) { | ||
| HttpServerTest.ServerEndpoint endpoint = HttpServerTest.ServerEndpoint.forPath(req.servletPath) | ||
| def phaser = new Phaser(2) | ||
| def context = req.startAsync() | ||
| context.start { | ||
| try { | ||
| phaser.arriveAndAwaitAdvance() | ||
| HttpServerTest.controller(endpoint) { | ||
| resp.contentType = "text/plain" | ||
| switch (endpoint) { | ||
| case SUCCESS: | ||
| resp.status = endpoint.status | ||
| resp.writer.print(endpoint.body) | ||
| context.complete() | ||
| break | ||
| case INDEXED_CHILD: | ||
| endpoint.collectSpanAttributes { req.getParameter(it) } | ||
| resp.status = endpoint.status | ||
| context.complete() | ||
| break | ||
| case QUERY_PARAM: | ||
| resp.status = endpoint.status | ||
| resp.writer.print(req.queryString) | ||
| context.complete() | ||
| break | ||
| case REDIRECT: | ||
| resp.sendRedirect(endpoint.body) | ||
| context.complete() | ||
| break | ||
| case ERROR: | ||
| resp.status = endpoint.status | ||
| resp.writer.print(endpoint.body) | ||
| context.complete() | ||
| break | ||
| case EXCEPTION: | ||
| resp.status = endpoint.status | ||
| resp.writer.print(endpoint.body) | ||
| context.complete() | ||
| throw new Exception(endpoint.body) | ||
| } | ||
| } | ||
| } finally { | ||
| phaser.arriveAndDeregister() | ||
| } | ||
| } | ||
| phaser.arriveAndAwaitAdvance() | ||
| phaser.arriveAndAwaitAdvance() | ||
| } | ||
| } |
129 changes: 129 additions & 0 deletions
129
...est/groovy/io/opentelemetry/javaagent/instrumentation/tomcat/v10_0/TomcatAsyncTest.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.tomcat.v10_0 | ||
|
|
||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.AUTH_REQUIRED | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.ERROR | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.EXCEPTION | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.INDEXED_CHILD | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.NOT_FOUND | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.QUERY_PARAM | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.REDIRECT | ||
| import static io.opentelemetry.instrumentation.test.base.HttpServerTest.ServerEndpoint.SUCCESS | ||
|
|
||
| import io.opentelemetry.instrumentation.test.AgentTestTrait | ||
| import io.opentelemetry.instrumentation.test.asserts.TraceAssert | ||
| import io.opentelemetry.instrumentation.test.base.HttpServerTest | ||
| import jakarta.servlet.Servlet | ||
| import jakarta.servlet.ServletException | ||
| import java.nio.file.Files | ||
| import org.apache.catalina.Context | ||
| import org.apache.catalina.startup.Tomcat | ||
| import org.apache.tomcat.JarScanFilter | ||
| import org.apache.tomcat.JarScanType | ||
| import spock.lang.Unroll | ||
|
|
||
| @Unroll | ||
| class TomcatAsyncTest extends HttpServerTest<Tomcat> implements AgentTestTrait { | ||
|
|
||
| @Override | ||
| Tomcat startServer(int port) { | ||
| def tomcatServer = new Tomcat() | ||
|
|
||
| def baseDir = Files.createTempDirectory("tomcat").toFile() | ||
| baseDir.deleteOnExit() | ||
| tomcatServer.setBaseDir(baseDir.getAbsolutePath()) | ||
|
|
||
| tomcatServer.setPort(port) | ||
| tomcatServer.getConnector().enableLookups = true // get localhost instead of 127.0.0.1 | ||
|
|
||
| File applicationDir = new File(baseDir, "/webapps/ROOT") | ||
| if (!applicationDir.exists()) { | ||
| applicationDir.mkdirs() | ||
| applicationDir.deleteOnExit() | ||
| } | ||
| Context servletContext = tomcatServer.addWebapp(contextPath, applicationDir.getAbsolutePath()) | ||
| // Speed up startup by disabling jar scanning: | ||
| servletContext.getJarScanner().setJarScanFilter(new JarScanFilter() { | ||
| @Override | ||
| boolean check(JarScanType jarScanType, String jarName) { | ||
| return false | ||
| } | ||
| }) | ||
|
|
||
| setupServlets(servletContext) | ||
|
|
||
| tomcatServer.start() | ||
|
|
||
| return tomcatServer | ||
| } | ||
|
|
||
| @Override | ||
| void stopServer(Tomcat server) { | ||
| server.stop() | ||
| server.destroy() | ||
| } | ||
|
|
||
| @Override | ||
| String getContextPath() { | ||
| return "/tomcat-context" | ||
| } | ||
|
|
||
| protected void setupServlets(Context context) { | ||
| def servlet = servlet() | ||
|
|
||
| addServlet(context, SUCCESS.path, servlet) | ||
| addServlet(context, QUERY_PARAM.path, servlet) | ||
| addServlet(context, ERROR.path, servlet) | ||
| addServlet(context, EXCEPTION.path, servlet) | ||
| addServlet(context, REDIRECT.path, servlet) | ||
| addServlet(context, AUTH_REQUIRED.path, servlet) | ||
| addServlet(context, INDEXED_CHILD.path, servlet) | ||
| } | ||
|
|
||
| void addServlet(Context servletContext, String path, Class<Servlet> servlet) { | ||
| String name = UUID.randomUUID() | ||
| Tomcat.addServlet(servletContext, name, servlet.newInstance()) | ||
| servletContext.addServletMappingDecoded(path, name) | ||
| } | ||
|
|
||
| Class<Servlet> servlet() { | ||
| AsyncServlet | ||
| } | ||
|
|
||
| @Override | ||
| boolean testException() { | ||
| // https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/807 | ||
| return false | ||
| } | ||
|
|
||
| @Override | ||
| boolean testConcurrency() { | ||
| return true | ||
| } | ||
|
|
||
| @Override | ||
| Class<?> expectedExceptionClass() { | ||
| ServletException | ||
| } | ||
|
|
||
| @Override | ||
| boolean hasResponseSpan(ServerEndpoint endpoint) { | ||
| endpoint == NOT_FOUND || endpoint == REDIRECT | ||
| } | ||
|
|
||
| @Override | ||
| void responseSpan(TraceAssert trace, int index, Object parent, String method, ServerEndpoint endpoint) { | ||
| switch (endpoint) { | ||
| case REDIRECT: | ||
| redirectSpan(trace, index, parent) | ||
| break | ||
| case NOT_FOUND: | ||
| sendErrorSpan(trace, index, parent) | ||
| break | ||
| } | ||
| } | ||
| } |
30 changes: 30 additions & 0 deletions
30
...a/io/opentelemetry/javaagent/instrumentation/tomcat/v7_0/Tomcat7AttachResponseAdvice.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.tomcat.v7_0; | ||
|
|
||
| import io.opentelemetry.instrumentation.servlet.v3_0.Servlet3HttpServerTracer; | ||
| import io.opentelemetry.javaagent.instrumentation.tomcat.common.TomcatServerHandlerAdviceHelper; | ||
| import net.bytebuddy.asm.Advice; | ||
| import org.apache.coyote.Request; | ||
| import org.apache.coyote.Response; | ||
|
|
||
| public class Tomcat7AttachResponseAdvice { | ||
|
|
||
| @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) | ||
| public static void attachResponse( | ||
| @Advice.Argument(0) Request request, | ||
| @Advice.Argument(2) Response response, | ||
| @Advice.Return boolean success) { | ||
|
|
||
| if (success) { | ||
| TomcatServerHandlerAdviceHelper.attachResponseToRequest( | ||
| Tomcat7ServletEntityProvider.INSTANCE, | ||
| Servlet3HttpServerTracer.tracer(), | ||
| request, | ||
| response); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed this branch to make tests fail when
responseis null