Use sanitized message in logs (Azure#25433)

* Use a sanitized message in logs

Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com>

Author: Liudmila Molkova

sdk/core/azure-core/pom.xml

@@ -64,6 +64,7 @@
       --add-opens com.azure.core/com.azure.core.implementation.models.jsonflatten=ALL-UNNAMED
       --add-opens com.azure.core/com.azure.core.implementation.serializer=ALL-UNNAMED
       --add-opens com.azure.core/com.azure.core.implementation.jackson=ALL-UNNAMED
+      --add-opens com.azure.core/com.azure.core.implementation.logging=ALL-UNNAMED
       --add-opens com.azure.core/com.azure.core.models=ALL-UNNAMED
       --add-opens com.azure.core/com.azure.core.util=ALL-UNNAMED
       --add-opens com.azure.core/com.azure.core.util.logging=ALL-UNNAMED

sdk/core/azure-core/src/main/java/com/azure/core/implementation/logging/LoggingUtils.java

@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.core.implementation.logging;
+
+import com.azure.core.util.CoreUtils;
+
+/**
+ * Contains utility methods for logging.
+ */
+public final class LoggingUtils {
+    private static final char CR = '\r';
+    private static final char LF = '\n';
+    
+    private LoggingUtils() {
+    }
+
+    /*
+     * Removes CR, LF or CRLF pattern in the {@code logMessage}.
+     *
+     * @param logMessage The log message to sanitize.
+     * @return The updated logMessage.
+     */
+    public static String removeNewLinesFromLogMessage(String logMessage) {
+        if (CoreUtils.isNullOrEmpty(logMessage)) {
+            return logMessage;
+        }
+
+        StringBuilder sb = null;
+        int prevStart = 0;
+
+        for (int i = 0; i < logMessage.length(); i++) {
+            if (logMessage.charAt(i) == CR || logMessage.charAt(i) == LF) {
+                if (sb == null) {
+                    sb = new StringBuilder(logMessage.length());
+                }
+
+                if (prevStart != i) {
+                    sb.append(logMessage, prevStart, i);
+                }
+                prevStart = i + 1;
+            }
+        }
+
+        if (sb == null) {
+            return logMessage;
+        }
+        sb.append(logMessage, prevStart, logMessage.length());
+        return sb.toString();
+    }
+}

sdk/core/azure-core/src/main/java/com/azure/core/util/logging/ClientLogger.java

@@ -13,7 +13,8 @@
 import java.util.Arrays;
 import java.util.Objects;
 import java.util.function.Supplier;
-import java.util.regex.Pattern;
+
+import static com.azure.core.implementation.logging.LoggingUtils.removeNewLinesFromLogMessage;
 
 /**
  * This is a fluent logger helper class that wraps a pluggable {@link Logger}.
@@ -37,7 +38,6 @@
  * @see Configuration
  */
 public class ClientLogger {
-    private static final Pattern CRLF_PATTERN = Pattern.compile("[\r\n]");
     private final Logger logger;
 
     /**
@@ -124,7 +124,7 @@ public void log(LogLevel logLevel, Supplier<String> message, Throwable throwable
      */
     public void verbose(String message) {
         if (logger.isDebugEnabled()) {
-            logger.debug(sanitizeLogMessageInput(message));
+            logger.debug(removeNewLinesFromLogMessage(message));
         }
     }
 
@@ -168,7 +168,7 @@ public void verbose(String format, Object... args) {
      */
     public void info(String message) {
         if (logger.isInfoEnabled()) {
-            logger.info(sanitizeLogMessageInput(message));
+            logger.info(removeNewLinesFromLogMessage(message));
         }
     }
 
@@ -213,7 +213,7 @@ public void info(String format, Object... args) {
      */
     public void warning(String message) {
         if (logger.isWarnEnabled()) {
-            logger.warn(sanitizeLogMessageInput(message));
+            logger.warn(removeNewLinesFromLogMessage(message));
         }
     }
 
@@ -262,7 +262,7 @@ public void warning(String format, Object... args) {
      */
     public void error(String message) {
         if (logger.isErrorEnabled()) {
-            logger.error(sanitizeLogMessageInput(message));
+            logger.error(removeNewLinesFromLogMessage(message));
         }
     }
 
@@ -419,7 +419,7 @@ private void performLogging(LogLevel logLevel, boolean isExceptionLogging, Strin
             }
         }
 
-        sanitizeLogMessageInput(format);
+        format = removeNewLinesFromLogMessage(format);
 
         switch (logLevel) {
             case VERBOSE:
@@ -455,7 +455,7 @@ private void performLogging(LogLevel logLevel, boolean isExceptionLogging, Strin
     private void performDeferredLogging(LogLevel logLevel, Supplier<String> messageSupplier, Throwable throwable) {
         String throwableMessage = (throwable != null) ? throwable.getMessage() : "";
         String message = messageSupplier.get();
-        sanitizeLogMessageInput(message);
+        message = removeNewLinesFromLogMessage(message);
         switch (logLevel) {
             case VERBOSE:
                 if (throwable != null) {
@@ -554,17 +554,4 @@ private boolean doesArgsHaveThrowable(Object... args) {
     private Object[] removeThrowable(Object... args) {
         return Arrays.copyOf(args, args.length - 1);
     }
-
-    /*
-     * Removes CRLF pattern in the {@code logMessage}.
-     *
-     * @param logMessage The log message to sanitize.
-     * @return The updated logMessage.
-     */
-    private static String sanitizeLogMessageInput(String logMessage) {
-        if (CoreUtils.isNullOrEmpty(logMessage)) {
-            return logMessage;
-        }
-        return CRLF_PATTERN.matcher(logMessage).replaceAll("");
-    }
 }

sdk/core/azure-core/src/test/java/com/azure/core/implementation/logging/LoggingUtilsTests.java

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.core.implementation.logging;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.junit.jupiter.params.provider.NullAndEmptySource;
+import org.junit.jupiter.params.provider.ValueSource;
+
+import java.util.stream.Stream;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class LoggingUtilsTests {
+    private static final String NEW_LINE = System.lineSeparator();
+    @ParameterizedTest
+    @NullAndEmptySource
+    @ValueSource(strings = {"hello", "hello world\t123"})
+    public void noNewLine(String message) {
+        assertEquals(message, LoggingUtils.removeNewLinesFromLogMessage(message));
+    }
+
+    @ParameterizedTest
+    @MethodSource("messagesWithNewLine")
+    public void newLine(String message) {
+        assertEquals("hello", LoggingUtils.removeNewLinesFromLogMessage(message));
+    }
+
+    @Test
+    public void newLineOnly() {
+        assertEquals("", LoggingUtils.removeNewLinesFromLogMessage(NEW_LINE + NEW_LINE + NEW_LINE));
+    }
+
+    @Test
+    public void withCL() {
+        assertEquals("\thelloworld", LoggingUtils.removeNewLinesFromLogMessage("\r\thello\r" + NEW_LINE + "world"));
+    }
+
+    private static Stream<String> messagesWithNewLine() {
+        return Stream.of(
+            "hello" + NEW_LINE + NEW_LINE,
+            NEW_LINE + "hello" + NEW_LINE,
+            NEW_LINE + NEW_LINE + "hello",
+            NEW_LINE + "he" + NEW_LINE + "l" + NEW_LINE + "lo");
+    }
+}

sdk/core/azure-core/src/test/java/com/azure/core/util/logging/ClientLoggerTests.java

@@ -269,6 +269,17 @@ public void logWithSupplier(LogLevel logLevel) {
         assertTrue(logValues.contains(supplier.get() + System.lineSeparator()));
     }
 
+    @Test
+    public void logWithNewLine() {
+        setupLogLevel(LogLevel.INFORMATIONAL.getLogLevel());
+        String message = String.format("Param 1: %s%s, Param 2: %s%s, Param 3: %s", "test1", System.lineSeparator(), "test2", System.lineSeparator(), "test3");
+        ClientLogger logger = new ClientLogger(ClientLoggerTests.class);
+        logger.log(LogLevel.INFORMATIONAL, () -> message);
+
+        String logValues = byteArraySteamToString(logCaptureStream);
+        assertTrue(logValues.contains("Param 1: test1, Param 2: test2, Param 3: test3"));
+    }
+
     @ParameterizedTest
     @MethodSource("provideLogLevels")
     public void logWithNullSupplier(LogLevel logLevel) {