Skip to content
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

snippet inject support like <head lang="en"> #8736

Merged
merged 12 commits into from
Aug 9, 2023
Merged

snippet inject support like <head lang="en"> #8736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1aaa862
snippet inject support like <head lang="en">
oliver-zhang Jun 15, 2023
f878ca1
code format
oliver-zhang Jun 15, 2023
b4d9d15
Let user passed multiple head tag
oliver-zhang Jun 16, 2023
a8275f9
Check head tag start with <head and end with >
oliver-zhang Jun 19, 2023
41c461d
Update instrumentation/servlet/servlet-common/bootstrap/src/main/java…
oliver-zhang Jun 20, 2023
9d82f76
add test case
oliver-zhang Jul 5, 2023
fab6cec
add test case
oliver-zhang Jul 6, 2023
368dbfe
Revert "add test case"
oliver-zhang Jul 20, 2023
85d36ee
remove the new integration tests and add new tests to the unit tests
oliver-zhang Jul 20, 2023
126fe01
refactor the code
oliver-zhang Jul 20, 2023
65b7b7d
code format
oliver-zhang Jul 20, 2023
8025b30
Merge branch 'main' into servlet-snippet-inject
laurit Aug 9, 2023
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
16 changes: 16 additions & 0 deletions .../opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetPrintWriterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,22 @@ void testWriteWithOffset() throws IOException {
assertThat(response.getStringContent()).isEqualTo(expectedHtml);
}

@Test
void testInjectToTextHtmlWithOtherHeadStyle() throws IOException {
String snippet = "\n <script type=\"text/javascript\"> Test </script>";
String html = readFileAsString("beforeSnippetInjectionWithOtherHeadStyle.html");

InMemoryHttpServletResponse response = createInMemoryHttpServletResponse("text/html");
Servlet3SnippetInjectingResponseWrapper responseWrapper =
new Servlet3SnippetInjectingResponseWrapper(response, snippet);

responseWrapper.getWriter().write(html);
responseWrapper.getWriter().flush();

String expectedHtml = readFileAsString("afterSnippetInjectionWithOtherHeadStyle.html");
assertThat(response.getStringContent()).isEqualTo(expectedHtml);
}

private static InMemoryHttpServletResponse createInMemoryHttpServletResponse(String contentType) {
HttpServletResponse response = mock(HttpServletResponse.class);
when(response.getContentType()).thenReturn(contentType);
Expand Down
19 changes: 19 additions & 0 deletions ...emetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetServletOutputStreamTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,25 @@ void testHeadTagSplitAcrossTwoWrites() throws IOException {
assertThat(out.getBytes()).isEqualTo(expectedSecondPart.getBytes(UTF_8));
}

@Test
void testInjectionWithOtherHeadStyle() throws IOException {
String snippet = "\n <script type=\"text/javascript\"> Test </script>";
byte[] html = readFileAsBytes("beforeSnippetInjectionWithOtherHeadStyle.html");

InjectionState obj = createInjectionStateForTesting(snippet, UTF_8);
InMemoryServletOutputStream out = new InMemoryServletOutputStream();

Supplier<String> stringSupplier = snippet::toString;
OutputStreamSnippetInjectionHelper helper =
new OutputStreamSnippetInjectionHelper(stringSupplier);
boolean injected = helper.handleWrite(obj, out, html, 0, html.length);
assertThat(obj.getHeadTagBytesSeen()).isEqualTo(-1);
assertThat(injected).isEqualTo(true);

byte[] expectedHtml = readFileAsBytes("afterSnippetInjectionWithOtherHeadStyle.html");
assertThat(out.getBytes()).isEqualTo(expectedHtml);
}

private static InjectionState createInjectionStateForTesting(String snippet, Charset charset) {
HttpServletResponse response = mock(HttpServletResponse.class);
when(response.isCommitted()).thenReturn(false);
Expand Down
11 changes: 11 additions & 0 deletions ...-3.0/javaagent-unit-tests/src/test/resources/afterSnippetInjectionWithOtherHeadStyle.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head lang="en">
<script type="text/javascript"> Test </script>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>

</body>
</html>
10 changes: 10 additions & 0 deletions ...3.0/javaagent-unit-tests/src/test/resources/beforeSnippetInjectionWithOtherHeadStyle.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head lang="en">
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>

</body>
</html>
3 changes: 2 additions & 1 deletion ...vaagent/instrumentation/servlet/v3_0/snippet/Servlet3SnippetInjectingResponseWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,8 @@ public boolean isContentTypeTextHtml() {
if (contentType == null) {
contentType = super.getHeader("content-type");
}
return contentType != null && contentType.startsWith("text/html");
return contentType != null
&& (contentType.startsWith("text/html") || contentType.startsWith("application/xhtml+xml"));
}

@Override
Expand Down
16 changes: 16 additions & 0 deletions .../opentelemetry/javaagent/instrumentation/servlet/v5_0/snippet/SnippetPrintWriterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,22 @@ void testWriteWithOffset() throws IOException {
assertThat(response.getStringContent()).isEqualTo(expectedHtml);
}

@Test
void testInjectToTextHtmlWithOtherHeadStyle() throws IOException {
String snippet = "\n <script type=\"text/javascript\"> Test </script>";
String html = TestUtil.readFileAsString("beforeSnippetInjectionWithOtherHeadStyle.html");

InMemoryHttpServletResponse response = createInMemoryHttpServletResponse("text/html");
Servlet5SnippetInjectingResponseWrapper responseWrapper =
new Servlet5SnippetInjectingResponseWrapper(response, snippet);

responseWrapper.getWriter().write(html);
responseWrapper.getWriter().flush();

String expectedHtml = TestUtil.readFileAsString("afterSnippetInjectionWithOtherHeadStyle.html");
assertThat(response.getStringContent()).isEqualTo(expectedHtml);
}

private static InMemoryHttpServletResponse createInMemoryHttpServletResponse(String contentType) {
HttpServletResponse response = mock(HttpServletResponse.class);
when(response.getContentType()).thenReturn(contentType);
Expand Down
19 changes: 19 additions & 0 deletions ...emetry/javaagent/instrumentation/servlet/v5_0/snippet/SnippetServletOutputStreamTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,25 @@ void testHeadTagSplitAcrossTwoWrites() throws IOException {
assertThat(out.getBytes()).isEqualTo(expectedSecondPart.getBytes(UTF_8));
}

@Test
void testInjectionWithOtherHeadStyle() throws IOException {
String snippet = "\n <script type=\"text/javascript\"> Test </script>";
byte[] html = readFileAsBytes("beforeSnippetInjectionWithOtherHeadStyle.html");

InjectionState obj = createInjectionStateForTesting(snippet, UTF_8);
InMemoryServletOutputStream out = new InMemoryServletOutputStream();

Supplier<String> stringSupplier = snippet::toString;
OutputStreamSnippetInjectionHelper helper =
new OutputStreamSnippetInjectionHelper(stringSupplier);
boolean injected = helper.handleWrite(obj, out, html, 0, html.length);
assertThat(obj.getHeadTagBytesSeen()).isEqualTo(-1);
assertThat(injected).isEqualTo(true);

byte[] expectedHtml = readFileAsBytes("afterSnippetInjectionWithOtherHeadStyle.html");
assertThat(out.getBytes()).isEqualTo(expectedHtml);
}

private static InjectionState createInjectionStateForTesting(String snippet, Charset charset) {
HttpServletResponse response = mock(HttpServletResponse.class);
when(response.isCommitted()).thenReturn(false);
Expand Down
11 changes: 11 additions & 0 deletions ...-5.0/javaagent-unit-tests/src/test/resources/afterSnippetInjectionWithOtherHeadStyle.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head lang="en">
<script type="text/javascript"> Test </script>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>

</body>
</html>
10 changes: 10 additions & 0 deletions ...5.0/javaagent-unit-tests/src/test/resources/beforeSnippetInjectionWithOtherHeadStyle.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head lang="en">
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>

</body>
</html>
3 changes: 2 additions & 1 deletion ...vaagent/instrumentation/servlet/v5_0/snippet/Servlet5SnippetInjectingResponseWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ public boolean isContentTypeTextHtml() {
if (contentType == null) {
contentType = super.getHeader("content-type");
}
return contentType != null && contentType.startsWith("text/html");
return contentType != null
&& (contentType.startsWith("text/html") || contentType.startsWith("application/xhtml+xml"));
}

@Override
Expand Down
9 changes: 5 additions & 4 deletions .../bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/servlet/InjectionState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
// this is shared by both ServletOutputStream and PrintWriter injection
public class InjectionState {
private static final int HEAD_TAG_WRITTEN_FAKE_VALUE = -1;
private static final int HEAD_TAG_LENGTH = "<head>".length();
private static final int HEAD_TAG_PREFIX_LENGTH = "<head".length();
private final SnippetInjectingResponseWrapper wrapper;
private int headTagBytesSeen = 0;

Expand Down Expand Up @@ -45,7 +45,7 @@ public boolean processByte(int b) {
} else {
headTagBytesSeen = 0;
}
if (headTagBytesSeen == HEAD_TAG_LENGTH) {
if (headTagBytesSeen > HEAD_TAG_PREFIX_LENGTH && b == '>') {
setHeadTagWritten();
return true;
} else {
Expand All @@ -64,10 +64,11 @@ private boolean inHeadTag(int b) {
return true;
} else if (headTagBytesSeen == 4 && b == 'd') {
return true;
} else if (headTagBytesSeen == 5 && b == '>') {
} else if (headTagBytesSeen == 5 && (b == '>' || Character.isWhitespace(b))) {
return true;
} else {
return headTagBytesSeen > 5;
}
return false;
}

public SnippetInjectingResponseWrapper getWrapper() {
Expand Down