Escape the ' character in the loggable method to help with log parser frameworks. (#3460)

The ' (single quote) character can confuse log parsers. This PR escapes
this character when used within a log message.
This change alters the serialized representation of the byte array as a
string. Any usage of this representation would be therefore modified.
Searching the codebase showed usage within Exception messages and
logging, which is likely OK, but care should be taken to verify that no
ill impact is exposed.
Resolves #3461

Author: ohadzeliger

fdb-extensions/src/main/java/com/apple/foundationdb/tuple/ByteArrayUtil2.java

@@ -35,6 +35,7 @@ public class ByteArrayUtil2 {
 
     private static final byte EQUALS_CHARACTER = (byte)'=';
     private static final byte DOUBLE_QUOTE_CHARACTER = (byte)'"';
+    private static final byte SINGLE_QUOTE_CHARACTER = (byte)'\'';
     private static final byte BACKSLASH_CHARACTER = (byte)'\\';
     private static final byte MINIMUM_PRINTABLE_CHARACTER = 32;
     private static final int MAXIMUM_PRINTABLE_CHARACTER = 127;
@@ -71,7 +72,7 @@ public static String toHexString(@Nullable byte[] bytes) {
      * Creates a human-readable representation of {@code bytes} for logging purposes.
      * This differs from {@link ByteArrayUtil#printable(byte[])} in tha it excludes the
      * {@code =} and {@code "} characters, which can cause trouble when included as a
-     * key or value in log messages with keys and values.
+     * key or value in log messages with keys and values. For the same purpose, {@code '} is escaped as well.
      *
      * @param bytes a {@code byte} array
      * @return a hex representation of {@code bytes}
@@ -88,7 +89,7 @@ public static String loggable(@Nullable byte[] bytes) {
             for (byte b : bytes) {
                 // remove '=' and '"' because they confuse parsing of key=value log messages
                 if (b >= MINIMUM_PRINTABLE_CHARACTER && b < MAXIMUM_PRINTABLE_CHARACTER &&
-                        b != BACKSLASH_CHARACTER && b != EQUALS_CHARACTER && b != DOUBLE_QUOTE_CHARACTER) {
+                        b != BACKSLASH_CHARACTER && b != EQUALS_CHARACTER && b != DOUBLE_QUOTE_CHARACTER && b != SINGLE_QUOTE_CHARACTER) {
                     sb.append((char)b);
                 } else if (b == BACKSLASH_CHARACTER) {
                     sb.append("\\\\");

fdb-extensions/src/test/java/com/apple/foundationdb/tuple/ByteArrayUtil2Test.java

@@ -44,10 +44,14 @@ void testLoggable() {
             assertTrue(l.matches(hexRegex), l + " matches /" + hexRegex + "/");
         }
         for (int i = (byte)' '; i < (byte)'"'; i++) {
-            assertEquals(Character.toString((char) i), ByteArrayUtil2.loggable(new byte[]{(byte)i}));
+            assertEquals(Character.toString((char) i), ByteArrayUtil2.loggable(new byte[] {(byte)i}));
         }
         assertEquals("\\x22", ByteArrayUtil2.loggable(new byte[]{(byte)'"'}));
-        for (int i = (byte)'"' + 1; i < (byte)'='; i++) {
+        for (int i = (byte)'"' + 1; i < (byte)'\''; i++) {
+            assertEquals(Character.toString((char) i), ByteArrayUtil2.loggable(new byte[]{(byte)i}));
+        }
+        assertEquals("\\x27", ByteArrayUtil2.loggable(new byte[]{(byte)'\''}));
+        for (int i = (byte)'\'' + 1; i < (byte)'='; i++) {
             assertEquals(Character.toString((char) i), ByteArrayUtil2.loggable(new byte[]{(byte)i}));
         }
         assertEquals("\\x3d", ByteArrayUtil2.loggable(new byte[]{(byte)'='}));
@@ -91,8 +95,9 @@ void testRandomBytes(long seed) {
         assertArrayEquals(bytes, unlogged, "Unprinting loggable bytes should reconstruct original array");
         assertFalse(loggable.contains("="), "loggable string should not contain equals sign");
         assertFalse(loggable.contains("\""), "loggable string should not contain quote");
+        assertFalse(loggable.contains("\'"), "loggable string should not contain single quote");
 
-        if (!printable.contains("=") && !printable.contains("\"")) {
+        if (!printable.contains("=") && !printable.contains("\"") && !printable.contains("\'")) {
             assertEquals(printable, loggable);
         }
     }

fdb-extensions/src/test/java/com/apple/foundationdb/tuple/TupleTest.java

@@ -89,7 +89,7 @@ public class TupleTest {
             .add(new ExpectedTupleEncoding<>(Double.MIN_NORMAL, "!\\x80\\x10\\x00\\x00\\x00\\x00\\x00\\x00"))
             .add(new ExpectedTupleEncoding<>(0.11577446748173348d, "!\\xbf\\xbd\\xa3e?\\x8b\\xbd\\x88"))
             // TODO: Add tests for Tuple encoding of BigIntegers (https://github.com/FoundationDB/fdb-record-layer/issues/18)
-            .add(new ExpectedTupleEncoding<>(true, "'"))
+            .add(new ExpectedTupleEncoding<>(true, "\\x27"))
             .add(new ExpectedTupleEncoding<>(false, "&"))
             .add(new ExpectedTupleEncoding<>(Versionstamp.complete(
                     ByteArrayUtil2.unprint("\\x93\\x82\\x8db\\x97;\\xc5\\xfbt\\x9a"), 5180),
@@ -99,11 +99,11 @@ public class TupleTest {
             .add(new ExpectedTupleEncoding<>(new ArrayList<>(0), "\\x05\\x00"))
             .add(new ExpectedTupleEncoding<>(
                     Arrays.asList(0, 1, "String " + zeroByteCharacter + " andZero", true, null, new byte[] {0, 0x03}),
-                    "\\x05\\x14\\x15\\x01\\x02String \\x00\\xff andZero\\x00'\\x00\\xff\\x01\\x00\\xff\\x03\\x00\\x00"))
+                    "\\x05\\x14\\x15\\x01\\x02String \\x00\\xff andZero\\x00\\x27\\x00\\xff\\x01\\x00\\xff\\x03\\x00\\x00"))
             .add(new ExpectedTupleEncoding<>(Tuple.from(), "\\x05\\x00"))
             .add(new ExpectedTupleEncoding<>(
                     Tuple.fromList(Arrays.asList(0, 1, "String " + zeroByteCharacter + " andZero", true, null, new byte[] {0, 0x03})),
-                    "\\x05\\x14\\x15\\x01\\x02String \\x00\\xff andZero\\x00'\\x00\\xff\\x01\\x00\\xff\\x03\\x00\\x00"))
+                    "\\x05\\x14\\x15\\x01\\x02String \\x00\\xff andZero\\x00\\x27\\x00\\xff\\x01\\x00\\xff\\x03\\x00\\x00"))
             .add()
             .build();