Skip to content

fix(http): enclose proceed in handler span lifecycle and propagate span in UserAgent and UrlReplace handlers #2219

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
Vincent Biret (baywet) merged 2 commits into from
Oct 26, 2026
Merged

fix(http): enclose proceed in handler span lifecycle and propagate span in UserAgent and UrlReplace handlers #2219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6a74f9
fix(http): enclose proceed in handler span lifecycle and propagate sp…
hardikkaurani Oct 24, 2026
02c59b5
test(http): add span and scope lifecycle assertions during and after …
hardikkaurani Oct 25, 2026
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
5 changes: 4 additions & 1 deletion ...ents/http/okHttp/src/main/java/com/microsoft/kiota/http/middleware/UrlReplaceHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ public Response intercept(@Nonnull Chain chain) throws IOException {
}
try {
request = replaceRequestUrl(request, replaceOption.getReplacementPairs());
if (span != null) {
request = request.newBuilder().tag(Span.class, span).build();
}
return chain.proceed(request);
} finally {
if (scope != null) {
scope.close();
Expand All @@ -69,7 +73,6 @@ public Response intercept(@Nonnull Chain chain) throws IOException {
span.end();
}
}
return chain.proceed(request);
}

/**
Expand Down
5 changes: 4 additions & 1 deletion ...nents/http/okHttp/src/main/java/com/microsoft/kiota/http/middleware/UserAgentHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ public Response intercept(final Chain chain) throws IOException {
} else if (!currentValue.contains(valueToAppend)) {
builder.header(USER_AGENT_HEADER_NAME, currentValue + " " + valueToAppend);
}
if (span != null) {
builder.tag(Span.class, span);
}
return chain.proceed(builder.build());
} finally {
if (scope != null) {
scope.close();
Expand All @@ -81,6 +85,5 @@ public Response intercept(final Chain chain) throws IOException {
span.end();
}
}
return chain.proceed(builder.build());
}
}
97 changes: 97 additions & 0 deletions .../http/okHttp/src/test/java/com/microsoft/kiota/http/middleware/UrlReplaceHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,25 @@

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.*;

import com.microsoft.kiota.http.KiotaClientFactory;
import com.microsoft.kiota.http.middleware.options.UrlReplaceHandlerOption;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanBuilder;
import io.opentelemetry.api.trace.Tracer;

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;

import java.io.IOException;
import java.util.HashMap;
Expand Down Expand Up @@ -96,4 +105,92 @@ void testItDoesNotReplaceTokensInThePath() throws IOException {
"https://graph.microsoft.com/v1.0/me/calendar/events/AAMkADM4Njk4YzMzLTc3YTktNGQwZi05ZjRjLTJlNTUzYWMxZjAxNABGAAAAAABzQLabgoJzT6ewNe8DeydoBwBoFwNVrXtLQ5PleemFoZ87AAAAAAENAABoFwNVrXtLQ5PleemFoZ87AAA33T-eAAA%3D",
response.request().url().toString());
}

@Test
void testUrlReplaceHandler_propagatesSpan() throws IOException {
try (MockedStatic<GlobalOpenTelemetry> otelMock = mockStatic(GlobalOpenTelemetry.class)) {
final Tracer mockTracer = mock(Tracer.class);
final SpanBuilder mockSpanBuilder = mock(SpanBuilder.class);
final Span mockSpan = mock(Span.class);
final io.opentelemetry.context.Scope mockScope =
mock(io.opentelemetry.context.Scope.class);

otelMock.when(() -> GlobalOpenTelemetry.getTracer(anyString())).thenReturn(mockTracer);
when(mockTracer.spanBuilder(anyString())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.setParent(any())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.startSpan()).thenReturn(mockSpan);
when(mockSpan.makeCurrent()).thenReturn(mockScope);

final com.microsoft.kiota.http.ObservabilityOptions obsOptions =
new com.microsoft.kiota.http.ObservabilityOptions();
final Interceptor.Chain mockChain = mock(Interceptor.Chain.class);
final Response mockResponse = mock(Response.class);
defaultReplacementPairs.put("/users/TokenToReplace", "/me");
final UrlReplaceHandler handler =
new UrlReplaceHandler(new UrlReplaceHandlerOption(defaultReplacementPairs));
final Request request =
new Request.Builder()
.url(DEFAULT_URL_WITH_TOKEN)
.tag(com.microsoft.kiota.http.ObservabilityOptions.class, obsOptions)
.build();
when(mockChain.request()).thenReturn(request);
when(mockChain.proceed(any(Request.class)))
.thenAnswer(
invocation -> {
final Request req = invocation.getArgument(0);
assertSame(mockSpan, req.tag(Span.class));
verify(mockSpan, never()).end();
verify(mockScope, never()).close();
return mockResponse;
});

final Response response = handler.intercept(mockChain);
assertNotNull(response);
verify(mockScope).close();
verify(mockSpan).end();
}
}

@Test
void testUrlReplaceHandler_cleansUpSpanOnException() throws IOException {
try (MockedStatic<GlobalOpenTelemetry> otelMock = mockStatic(GlobalOpenTelemetry.class)) {
final Tracer mockTracer = mock(Tracer.class);
final SpanBuilder mockSpanBuilder = mock(SpanBuilder.class);
final Span mockSpan = mock(Span.class);
final io.opentelemetry.context.Scope mockScope =
mock(io.opentelemetry.context.Scope.class);

otelMock.when(() -> GlobalOpenTelemetry.getTracer(anyString())).thenReturn(mockTracer);
when(mockTracer.spanBuilder(anyString())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.setParent(any())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.startSpan()).thenReturn(mockSpan);
when(mockSpan.makeCurrent()).thenReturn(mockScope);

final com.microsoft.kiota.http.ObservabilityOptions obsOptions =
new com.microsoft.kiota.http.ObservabilityOptions();
final Interceptor.Chain mockChain = mock(Interceptor.Chain.class);
defaultReplacementPairs.put("/users/TokenToReplace", "/me");
final UrlReplaceHandler handler =
new UrlReplaceHandler(new UrlReplaceHandlerOption(defaultReplacementPairs));
final Request request =
new Request.Builder()
.url(DEFAULT_URL_WITH_TOKEN)
.tag(com.microsoft.kiota.http.ObservabilityOptions.class, obsOptions)
.build();
when(mockChain.request()).thenReturn(request);
when(mockChain.proceed(any(Request.class)))
.thenAnswer(
invocation -> {
final Request req = invocation.getArgument(0);
assertSame(mockSpan, req.tag(Span.class));
verify(mockSpan, never()).end();
verify(mockScope, never()).close();
throw new IOException("network failure");
});

assertThrows(IOException.class, () -> handler.intercept(mockChain));
verify(mockScope).close();
verify(mockSpan).end();
}
}
}
90 changes: 90 additions & 0 deletions ...s/http/okHttp/src/test/java/com/microsoft/kiota/http/middleware/UserAgentHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,25 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.*;

import com.microsoft.kiota.http.middleware.options.UserAgentHandlerOption;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanBuilder;
import io.opentelemetry.api.trace.Tracer;

import okhttp3.Headers;
import okhttp3.Interceptor.Chain;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.ResponseBody;

import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;

Expand Down Expand Up @@ -84,4 +92,86 @@ void doesNotAddTheProductWhenDisabled() throws IOException {
assertNotNull(result);
assertNull(result.header("User-Agent"));
}

@Test
void enclosesProceedAndPropagatesSpan() throws IOException {
try (MockedStatic<GlobalOpenTelemetry> otelMock = mockStatic(GlobalOpenTelemetry.class)) {
final Tracer mockTracer = mock(Tracer.class);
final SpanBuilder mockSpanBuilder = mock(SpanBuilder.class);
final Span mockSpan = mock(Span.class);
final io.opentelemetry.context.Scope mockScope =
mock(io.opentelemetry.context.Scope.class);

otelMock.when(() -> GlobalOpenTelemetry.getTracer(anyString())).thenReturn(mockTracer);
when(mockTracer.spanBuilder(anyString())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.setParent(any())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.startSpan()).thenReturn(mockSpan);
when(mockSpan.makeCurrent()).thenReturn(mockScope);

final com.microsoft.kiota.http.ObservabilityOptions obsOptions =
new com.microsoft.kiota.http.ObservabilityOptions();
final UserAgentHandler handler = new UserAgentHandler();
final Request request =
new Request.Builder()
.url("http://localhost")
.tag(com.microsoft.kiota.http.ObservabilityOptions.class, obsOptions)
.build();
when(mockChain.request()).thenReturn(request);
when(mockChain.proceed(any(Request.class)))
.thenAnswer(
invocation -> {
final Request req = invocation.getArgument(0);
assertSame(mockSpan, req.tag(Span.class));
verify(mockSpan, never()).end();
verify(mockScope, never()).close();
when(mockResponse.request()).thenReturn(req);
return mockResponse;
});

final Response response = handler.intercept(mockChain);
assertNotNull(response);
verify(mockScope).close();
verify(mockSpan).end();
}
}

@Test
void enclosesProceedAndCleansUpOnException() throws IOException {
try (MockedStatic<GlobalOpenTelemetry> otelMock = mockStatic(GlobalOpenTelemetry.class)) {
final Tracer mockTracer = mock(Tracer.class);
final SpanBuilder mockSpanBuilder = mock(SpanBuilder.class);
final Span mockSpan = mock(Span.class);
final io.opentelemetry.context.Scope mockScope =
mock(io.opentelemetry.context.Scope.class);

otelMock.when(() -> GlobalOpenTelemetry.getTracer(anyString())).thenReturn(mockTracer);
when(mockTracer.spanBuilder(anyString())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.setParent(any())).thenReturn(mockSpanBuilder);
when(mockSpanBuilder.startSpan()).thenReturn(mockSpan);
when(mockSpan.makeCurrent()).thenReturn(mockScope);

final com.microsoft.kiota.http.ObservabilityOptions obsOptions =
new com.microsoft.kiota.http.ObservabilityOptions();
final UserAgentHandler handler = new UserAgentHandler();
final Request request =
new Request.Builder()
.url("http://localhost")
.tag(com.microsoft.kiota.http.ObservabilityOptions.class, obsOptions)
.build();
when(mockChain.request()).thenReturn(request);
when(mockChain.proceed(any(Request.class)))
.thenAnswer(
invocation -> {
final Request req = invocation.getArgument(0);
assertSame(mockSpan, req.tag(Span.class));
verify(mockSpan, never()).end();
verify(mockScope, never()).close();
throw new IOException("network failure");
});

assertThrows(IOException.class, () -> handler.intercept(mockChain));
verify(mockScope).close();
verify(mockSpan).end();
}
}
}
Loading