Home Explore Help
Sign In
cecf
/
opentelemetry-java-instrumentation
7
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Browse Source

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

Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>
Co-authored-by: Lauri Tulmin <ltulmin@splunk.com>
oliver zhang 1 year ago
parent
f8f87944c1
commit
0c79f14c79
11 changed files with 121 additions and 6 deletions
Split View Show Diff Stats
  1. 16 0
      instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetPrintWriterTest.java
  2. 19 0
      instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetServletOutputStreamTest.java
  3. 11 0
      instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/resources/afterSnippetInjectionWithOtherHeadStyle.html
  4. 10 0
      instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/resources/beforeSnippetInjectionWithOtherHeadStyle.html
  5. 2 1
      instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/Servlet3SnippetInjectingResponseWrapper.java
  6. 16 0
      instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v5_0/snippet/SnippetPrintWriterTest.java
  7. 19 0
      instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v5_0/snippet/SnippetServletOutputStreamTest.java
  8. 11 0
      instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/resources/afterSnippetInjectionWithOtherHeadStyle.html
  9. 10 0
      instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/resources/beforeSnippetInjectionWithOtherHeadStyle.html
  10. 2 1
      instrumentation/servlet/servlet-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v5_0/snippet/Servlet5SnippetInjectingResponseWrapper.java
  11. 5 4
      instrumentation/servlet/servlet-common/bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/servlet/InjectionState.java

+ 16 - 0
instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetPrintWriterTest.java
View File 

@@ -124,6 +124,22 @@ class SnippetPrintWriterTest {
 
     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);

+ 19 - 0
instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetServletOutputStreamTest.java
View File 

@@ -125,6 +125,25 @@ class SnippetServletOutputStreamTest {
 
     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);

+ 11 - 0
instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/resources/afterSnippetInjectionWithOtherHeadStyle.html
View File 

@@ -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 - 0
instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/resources/beforeSnippetInjectionWithOtherHeadStyle.html
View File 

@@ -0,0 +1,10 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+<head lang="en">
 
+  <meta charset="UTF-8">
 
+  <title>Title</title>
 
+</head>
 
+<body>
 
+
 
+</body>
 
+</html>

+ 2 - 1
instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/Servlet3SnippetInjectingResponseWrapper.java
View File 

@@ -150,7 +150,8 @@ public class Servlet3SnippetInjectingResponseWrapper extends HttpServletResponse
 
     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

+ 16 - 0
instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v5_0/snippet/SnippetPrintWriterTest.java
View File 

@@ -123,6 +123,22 @@ class SnippetPrintWriterTest {
 
     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);

+ 19 - 0
instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v5_0/snippet/SnippetServletOutputStreamTest.java
View File 

@@ -127,6 +127,25 @@ class SnippetServletOutputStreamTest {
 
     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);

+ 11 - 0
instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/resources/afterSnippetInjectionWithOtherHeadStyle.html
View File 

@@ -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 - 0
instrumentation/servlet/servlet-5.0/javaagent-unit-tests/src/test/resources/beforeSnippetInjectionWithOtherHeadStyle.html
View File 

@@ -0,0 +1,10 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+<head lang="en">
 
+  <meta charset="UTF-8">
 
+  <title>Title</title>
 
+</head>
 
+<body>
 
+
 
+</body>
 
+</html>

+ 2 - 1
instrumentation/servlet/servlet-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v5_0/snippet/Servlet5SnippetInjectingResponseWrapper.java
View File 

@@ -142,7 +142,8 @@ public class Servlet5SnippetInjectingResponseWrapper extends HttpServletResponse
 
     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

+ 5 - 4
instrumentation/servlet/servlet-common/bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/servlet/InjectionState.java
View File 

@@ -8,7 +8,7 @@ package io.opentelemetry.javaagent.bootstrap.servlet;
 
 // 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;
 
 
@@ -45,7 +45,7 @@ public class InjectionState {
 
     } else {
 
       headTagBytesSeen = 0;
 
     }
 
-    if (headTagBytesSeen == HEAD_TAG_LENGTH) {
 
+    if (headTagBytesSeen > HEAD_TAG_PREFIX_LENGTH && b == '>') {
 
       setHeadTagWritten();
 
       return true;
 
     } else {
 
@@ -64,10 +64,11 @@ public class InjectionState {
 
       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() {