Skip to content

Guard against null HttpContext #6792

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

Merged
trask merged 5 commits into from
Oct 6, 2022
Merged

Guard against null HttpContext #6792

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0db0458
guard against null HttpContext
breedx-splk Sep 30, 2022
61b706b
add @Nullable
breedx-splk Sep 30, 2022
7cf172e
default the http context
breedx-splk Oct 6, 2022
8573b02
remove null guard
breedx-splk Oct 6, 2022
0634baa
Update instrumentation/apache-httpclient/apache-httpclient-5.0/javaag…
trask Oct 6, 2022
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
17 changes: 11 additions & 6 deletions ...javaagent/instrumentation/apachehttpasyncclient/ApacheHttpAsyncClientInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import java.io.IOException;
import java.util.logging.Logger;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
Expand Down Expand Up @@ -148,7 +149,7 @@ public static class WrappedFutureCallback<T> implements FutureCallback<T> {
private static final Logger logger = Logger.getLogger(WrappedFutureCallback.class.getName());

private final Context parentContext;
private final HttpContext httpContext;
@Nullable private final HttpContext httpContext;
private final FutureCallback<T> delegate;

private volatile Context context;
Expand All @@ -171,7 +172,7 @@ public void completed(T result) {
return;
}

instrumenter().end(context, otelRequest, getResponse(httpContext), null);
instrumenter().end(context, otelRequest, getResponseFromHttpContext(), null);

if (parentContext == null) {
completeDelegate(result);
Expand All @@ -193,7 +194,7 @@ public void failed(Exception ex) {
}

// end span before calling delegate
instrumenter().end(context, otelRequest, getResponse(httpContext), ex);
instrumenter().end(context, otelRequest, getResponseFromHttpContext(), ex);

if (parentContext == null) {
failDelegate(ex);
Expand All @@ -216,7 +217,7 @@ public void cancelled() {

// TODO (trask) add "canceled" span attribute
// end span before calling delegate
instrumenter().end(context, otelRequest, getResponse(httpContext), null);
instrumenter().end(context, otelRequest, getResponseFromHttpContext(), null);

if (parentContext == null) {
cancelDelegate();
Expand Down Expand Up @@ -246,8 +247,12 @@ private void cancelDelegate() {
}
}

private static HttpResponse getResponse(HttpContext context) {
return (HttpResponse) context.getAttribute(HttpCoreContext.HTTP_RESPONSE);
@Nullable
private HttpResponse getResponseFromHttpContext() {
if (httpContext == null) {
return null;
}
return (HttpResponse) httpContext.getAttribute(HttpCoreContext.HTTP_RESPONSE);
}
}
}
20 changes: 13 additions & 7 deletions ...javaagent/instrumentation/apachehttpclient/v5_0/ApacheHttpAsyncClientInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import java.io.IOException;
import java.util.logging.Logger;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
Expand All @@ -32,6 +33,7 @@
import org.apache.hc.core5.http.nio.AsyncRequestProducer;
import org.apache.hc.core5.http.nio.DataStreamChannel;
import org.apache.hc.core5.http.nio.RequestChannel;
import org.apache.hc.core5.http.protocol.BasicHttpContext;
import org.apache.hc.core5.http.protocol.HttpContext;
import org.apache.hc.core5.http.protocol.HttpCoreContext;

Expand Down Expand Up @@ -67,10 +69,13 @@ public static class ClientAdvice {
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void methodEnter(
@Advice.Argument(value = 0, readOnly = false) AsyncRequestProducer requestProducer,
@Advice.Argument(3) HttpContext httpContext,
@Advice.Argument(value = 3, readOnly = false) HttpContext httpContext,
@Advice.Argument(value = 4, readOnly = false) FutureCallback<?> futureCallback) {

Context parentContext = currentContext();
if (httpContext == null) {
httpContext = new BasicHttpContext();
}

WrappedFutureCallback<?> wrappedFutureCallback =
new WrappedFutureCallback<>(parentContext, httpContext, futureCallback);
Expand Down Expand Up @@ -159,7 +164,7 @@ public static class WrappedFutureCallback<T> implements FutureCallback<T> {
private static final Logger logger = Logger.getLogger(WrappedFutureCallback.class.getName());

private final Context parentContext;
private final HttpContext httpContext;
@Nullable private final HttpContext httpContext;
private final FutureCallback<T> delegate;

private volatile Context context;
Expand All @@ -182,7 +187,7 @@ public void completed(T result) {
return;
}

instrumenter().end(context, httpRequest, getResponse(httpContext), null);
instrumenter().end(context, httpRequest, getResponseFromHttpContext(), null);

if (parentContext == null) {
completeDelegate(result);
Expand All @@ -204,7 +209,7 @@ public void failed(Exception ex) {
}

// end span before calling delegate
instrumenter().end(context, httpRequest, getResponse(httpContext), ex);
instrumenter().end(context, httpRequest, getResponseFromHttpContext(), ex);

if (parentContext == null) {
failDelegate(ex);
Expand All @@ -227,7 +232,7 @@ public void cancelled() {

// TODO (trask) add "canceled" span attribute
// end span before calling delegate
instrumenter().end(context, httpRequest, getResponse(httpContext), null);
instrumenter().end(context, httpRequest, getResponseFromHttpContext(), null);

if (parentContext == null) {
cancelDelegate();
Expand Down Expand Up @@ -257,8 +262,9 @@ private void cancelDelegate() {
}
}

private static HttpResponse getResponse(HttpContext context) {
return (HttpResponse) context.getAttribute(HttpCoreContext.HTTP_RESPONSE);
@Nullable
private HttpResponse getResponseFromHttpContext() {
return (HttpResponse) httpContext.getAttribute(HttpCoreContext.HTTP_RESPONSE);
}
}
}