SLING-11392 : Escape characters in request progress tracker

apache · Jun 13, 2022 · 8754cd2 · 8754cd2
1 parent 69fe9c9
commit 8754cd2
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/src/main/java/org/apache/sling/api/request/builder/impl/RequestProgressTrackerImpl.java b/src/main/java/org/apache/sling/api/request/builder/impl/RequestProgressTrackerImpl.java
@@ -170,7 +170,9 @@ private String formatMessage(final long offset, final String message) {
         for (int i = PADDING_WIDTH - offsetStr.length(); i > 0; i--) {
             sb.append(' ');
         }
-        sb.append(offsetStr).append(' ').append(message).append('\n');
+        sb.append(offsetStr).append(' ')
+          .append(message.replace('\n', '_').replace('\r', '_'))
+          .append('\n');
         return sb.toString();
     }
 
@@ -179,12 +181,10 @@ public void dump(final PrintWriter writer) {
         logTimer(REQUEST_PROCESSING_TIMER,
             "Dumping SlingRequestProgressTracker Entries");
 
-        final StringBuilder sb = new StringBuilder();
         final Iterator<String> messages = getMessages();
         while (messages.hasNext()) {
-            sb.append(messages.next());
+            writer.print(messages.next());
         }
-        writer.print(sb.toString());
     }
 
     @Override

diff --git a/src/test/java/org/apache/sling/api/request/builder/impl/RequestProgressTrackerImplTest.java b/src/test/java/org/apache/sling/api/request/builder/impl/RequestProgressTrackerImplTest.java
@@ -129,6 +129,15 @@ public void removeFails() {
         tracker.getMessages().remove();
     }
 
+    @Test
+    public void testMessageEscape() {
+        tracker.log("foo\n\rbar");
+        final StringWriter w = new StringWriter();
+        tracker.dump(new PrintWriter(w));
+        w.flush();
+        final String result = w.toString();
+        assertTrue(result.contains("LOG foo__bar"));
+    }
     private String substringAfter(String string, char ch) {
         final int pos = string.indexOf(ch);
         return string.substring(pos);