selenide#2283 Escape special characters in subject

For example, in case of new line in subject the report schema is broken and all report start looks ugly.

We need to escape characters before the line length computing.

src/main/java/com/codeborne/selenide/logevents/SimpleReport.java

@@ -19,7 +19,7 @@
 
 /**
  * A simple text report of Selenide actions performed during test run.
- *
+ * <p>
  * Class is thread-safe: the same instance of SimpleReport can be reused by different threads simultaneously.
  */
 @ParametersAreNonnullByDefault
@@ -55,7 +55,7 @@ public void finish(String title) {
   @Nonnull
   @CheckReturnValue
   String generateReport(String title, List<LogEvent> events) {
-    var eventsWithNestingLevel = computeNestingLevel(events);
+    var eventsWithNestingLevel = escapeSubjectAndComputeNestingLevel(events);
 
     int firstColumnWidth = Math.max(maxLocatorLength(eventsWithNestingLevel), MIN_FIRST_COLUMN_WIDTH);
     int secondColumnWidth = Math.min(maxSubjectLength(eventsWithNestingLevel), MAX_SECOND_COLUMN_WIDTH);
@@ -72,16 +72,26 @@ String generateReport(String title, List<LogEvent> events) {
     return report.build();
   }
 
-  private List<LogEventWithNestingLevel> computeNestingLevel(List<LogEvent> events) {
-    var stack = new ArrayDeque<LogEvent>();
+  private List<LogEventWithNestingLevel> escapeSubjectAndComputeNestingLevel(List<LogEvent> events) {
+    var stack = new ArrayDeque<LogEventWithNestingLevel.SimpleLogEvent>();
     var result = new ArrayList<LogEventWithNestingLevel>(events.size());
     for (LogEvent event : events) {
-      while (!stack.isEmpty() && stack.peekFirst().getEndTime() <= event.getStartTime())
+      var eventWithEscapedSubject = new LogEventWithNestingLevel.SimpleLogEvent(
+        event.getElement(),
+        escape(event.getSubject()),
+        event.getStatus(),
+        event.getDuration(),
+        event.getStartTime(),
+        event.getEndTime(),
+        event.getError()
+      );
+
+      while (!stack.isEmpty() && stack.peekFirst().getEndTime() <= eventWithEscapedSubject.getStartTime())
         stack.removeFirst();
 
-      result.add(new LogEventWithNestingLevel(stack.size(), event));
+      result.add(new LogEventWithNestingLevel(stack.size(), eventWithEscapedSubject));
 
-      stack.addFirst(event);
+      stack.addFirst(eventWithEscapedSubject);
     }
 
     return result;
@@ -208,6 +218,36 @@ private static void checkThatSlf4jIsConfigured() {
   }
 
   @Desugar
-  private record LogEventWithNestingLevel(int nestingLevel, LogEvent event) {
+  private record LogEventWithNestingLevel(int nestingLevel, SimpleLogEvent event) {
+
+    @Desugar
+    private record SimpleLogEvent(
+      String getElement,
+      String getSubject,
+      EventStatus getStatus,
+      long getDuration,
+      long getStartTime,
+      long getEndTime,
+      Throwable getError
+    ) implements LogEvent {
+    }
+  }
+
+  private static String escape(String text) {
+    var builder = new StringBuilder((int) (text.length() * 1.5));
+    for (int i = 0; i < text.length(); i++) {
+      var symbol = text.charAt(i);
+
+      switch (symbol) {
+        case '\t' -> builder.append("\\t");
+        case '\r' -> builder.append("\\r");
+        case '\n' -> builder.append("\\n");
+        case '\f' -> builder.append("\\f");
+        case '\b' -> builder.append("\\b");
+        default -> builder.append(symbol);
+      }
+    }
+
+    return builder.toString();
   }
 }

src/test/java/com/codeborne/selenide/logevents/SimpleReportTest.java

@@ -57,6 +57,18 @@ void reportWithTooLongValue() throws IOException {
     assertThat(report).isEqualTo(sample("/simple-report-test2.txt"));
   }
 
+  @Test
+  void reportWithSubjectWithSpecialChars() throws IOException {
+    String report = new SimpleReport().generateReport("escapeSpecialCharactersInSubject", asList(
+      new Log("open", "https://some.com/", PASS, 0, millisToNanos(100)),
+      new Log("shouldHave", "text \"with\n\t\f\bspecial\n\r\"characters", PASS,
+        millisToNanos(100), millisToNanos(200)),
+      new Log("#loginButton", "click", FAIL, millisToNanos(200), millisToNanos(300))
+    ));
+
+    assertThat(report).isEqualTo(sample("/simple-report-test6.txt"));
+  }
+
   @Test
   void reportWithLongSelectors() throws IOException {
     String report = new SimpleReport().generateReport("userCanUseVeryLongSelectors", asList(

src/test/resources/simple-report-test6.txt

@@ -0,0 +1,8 @@
+Report for escapeSpecialCharactersInSubject
++----------------------+------------------------------------------+------------+------------+
+| Element              | Subject                                  | Status     | ms.        |
++----------------------+------------------------------------------+------------+------------+
+| open                 | https://some.com/                        | PASS       | 100        |
+| shouldHave           | text "with\n\t\f\bspecial\n\r"characters | PASS       | 100        |
+| #loginButton         | click                                    | FAIL       | 100        |
++----------------------+------------------------------------------+------------+------------+