Skip to content

Commit

Permalink
fix: multiple server-tracing headers aren't handled (signalfx#1077)
Browse files Browse the repository at this point in the history 
* fix: multiple server-tracing headers aren't handled

* PR feedback
  • Loading branch information
@jtmalinowski
jtmalinowski authored Nov 21, 2024
1 parent d16e305 commit 4b3501d
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 33 deletions.
20 changes: 14 additions & 6 deletions splunk-otel-android/src/main/java/com/splunk/rum/RumResponseAttributesExtractor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

class RumResponseAttributesExtractor implements AttributesExtractor<Request, Response> {

public static final String SERVER_TIMING_HEADER = "server-timing";
private final ServerTimingHeaderParser serverTimingHeaderParser;

public RumResponseAttributesExtractor(ServerTimingHeaderParser serverTimingHeaderParser) {
Expand All @@ -52,11 +53,18 @@ public void onEnd(
}

private void onResponse(AttributesBuilder attributes, Response response) {
String serverTimingHeader = response.header("Server-Timing");
String[] ids = serverTimingHeaderParser.parse(serverTimingHeader);
if (ids.length == 2) {
attributes.put(LINK_TRACE_ID_KEY, ids[0]);
attributes.put(LINK_SPAN_ID_KEY, ids[1]);
}
response.headers()
.forEach(
header -> {
if (!header.getFirst().equalsIgnoreCase(SERVER_TIMING_HEADER)) {
return;
}

String[] ids = serverTimingHeaderParser.parse(header.getSecond());
if (ids.length == 2) {
attributes.put(LINK_TRACE_ID_KEY, ids[0]);
attributes.put(LINK_SPAN_ID_KEY, ids[1]);
}
});
}
}
92 changes: 65 additions & 27 deletions splunk-otel-android/src/test/java/com/splunk/rum/RumResponseAttributesExtractorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,32 +36,64 @@ class RumResponseAttributesExtractorTest {

@Test
void spanDecoration() {
ServerTimingHeaderParser headerParser = mock(ServerTimingHeaderParser.class);
when(headerParser.parse("headerValue"))
.thenReturn(new String[] {"9499195c502eb217c448a68bfe0f967c", "fe16eca542cd5d86"});
Request fakeRequest = mock(Request.class);
Response response =
getBaseRuestBuilder(fakeRequest)
.addHeader(
"Server-Timing",
"traceparent;desc=\"00-00000000000000000000000000000001-0000000000000001-01\"")
.build();
Attributes attributes = performAttributesExtraction(fakeRequest, response);

assertThat(attributes)
.containsOnly(
entry(COMPONENT_KEY, "http"),
entry(LINK_TRACE_ID_KEY, "00000000000000000000000000000001"),
entry(LINK_SPAN_ID_KEY, "0000000000000001"));
}

@Test
void ignoresMalformed() {
Request fakeRequest = mock(Request.class);
Response response =
new Response.Builder()
.request(fakeRequest)
.protocol(Protocol.HTTP_1_1)
.message("hello")
.code(200)
.addHeader("Server-Timing", "headerValue")
getBaseRuestBuilder(fakeRequest)
.addHeader("Server-Timing", "othervalue 1")
.addHeader(
"Server-Timing",
"traceparent;desc=\"00-00000000000000000000000000000001-0000000000000001-01\"")
.addHeader("Server-Timing", "othervalue 2")
.build();
Attributes attributes = performAttributesExtraction(fakeRequest, response);

RumResponseAttributesExtractor attributesExtractor =
new RumResponseAttributesExtractor(headerParser);
AttributesBuilder attributesBuilder = Attributes.builder();
attributesExtractor.onStart(attributesBuilder, Context.root(), fakeRequest);
attributesExtractor.onEnd(attributesBuilder, Context.root(), fakeRequest, response, null);
Attributes attributes = attributesBuilder.build();
assertThat(attributes)
.containsOnly(
entry(COMPONENT_KEY, "http"),
entry(LINK_TRACE_ID_KEY, "00000000000000000000000000000001"),
entry(LINK_SPAN_ID_KEY, "0000000000000001"));
}

@Test
void lastMatchingWins() {
Request fakeRequest = mock(Request.class);
Response response =
getBaseRuestBuilder(fakeRequest)
.addHeader(
"Server-Timing",
"traceparent;desc=\"00-00000000000000000000000000000001-0000000000000001-01\"")
.addHeader(
"Server-Timing",
"traceparent;desc=\"00-00000000000000000000000000000002-0000000000000002-01\"")
.addHeader(
"Server-Timing",
"traceparent;desc=\"00-00000000000000000000000000000003-0000000000000003-01\"")
.build();
Attributes attributes = performAttributesExtraction(fakeRequest, response);

assertThat(attributes)
.containsOnly(
entry(COMPONENT_KEY, "http"),
entry(LINK_TRACE_ID_KEY, "9499195c502eb217c448a68bfe0f967c"),
entry(LINK_SPAN_ID_KEY, "fe16eca542cd5d86"));
entry(LINK_TRACE_ID_KEY, "00000000000000000000000000000003"),
entry(LINK_SPAN_ID_KEY, "0000000000000003"));
}

@Test
Expand All @@ -70,21 +102,27 @@ void spanDecoration_noLinkingHeader() {
when(headerParser.parse(null)).thenReturn(new String[0]);

Request fakeRequest = mock(Request.class);
Response response =
new Response.Builder()
.request(fakeRequest)
.protocol(Protocol.HTTP_1_1)
.message("hello")
.code(200)
.build();
Response response = getBaseRuestBuilder(fakeRequest).build();
Attributes attributes = performAttributesExtraction(fakeRequest, response);

assertThat(attributes).containsOnly(entry(COMPONENT_KEY, "http"));
}

private static Attributes performAttributesExtraction(Request fakeRequest, Response response) {
RumResponseAttributesExtractor attributesExtractor =
new RumResponseAttributesExtractor(headerParser);
new RumResponseAttributesExtractor(new ServerTimingHeaderParser());
AttributesBuilder attributesBuilder = Attributes.builder();
attributesExtractor.onEnd(attributesBuilder, Context.root(), fakeRequest, response, null);
attributesExtractor.onStart(attributesBuilder, Context.root(), fakeRequest);
attributesExtractor.onEnd(attributesBuilder, Context.root(), fakeRequest, response, null);
Attributes attributes = attributesBuilder.build();
return attributes;
}

assertThat(attributes).containsOnly(entry(COMPONENT_KEY, "http"));
private Response.Builder getBaseRuestBuilder(Request fakeRequest) {
return new Response.Builder()
.request(fakeRequest)
.protocol(Protocol.HTTP_1_1)
.message("hello")
.code(200);
}
}

0 comments on commit 4b3501d

Please sign in to comment.