Fix: CSV and Raw output, escape quotes (#3063)

Fixes #3050 Signed-off-by: Mike Swierczek <[email protected]>
opensearch-project · Nov 6, 2024 · cfe38d7 · cfe38d7
1 parent 4ff1fe3
commit cfe38d7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 6 deletions.
diff --git a/protocol/src/main/java/org/opensearch/sql/protocol/response/format/FlatResponseBase.java b/protocol/src/main/java/org/opensearch/sql/protocol/response/format/FlatResponseBase.java
@@ -84,6 +84,10 @@ protected List<List<String>> formatData(List<List<String>> lines) {
 
   protected String quoteIfRequired(String separator, String cell) {
     final String quote = "\"";
-    return cell.contains(separator) ? quote + cell.replaceAll("\"", "\"\"") + quote : cell;
+    if (cell != null && (cell.contains(separator) || cell.contains(quote))) {
+      return quote + cell.replaceAll(quote, quote + quote) + quote;
+    } else {
+      return cell;
+    }
   }
 }
diff --git a/...l/src/test/java/org/opensearch/sql/protocol/response/format/CsvResponseFormatterTest.java b/...l/src/test/java/org/opensearch/sql/protocol/response/format/CsvResponseFormatterTest.java
@@ -108,8 +108,11 @@ void quoteIfRequired() {
     QueryResult response =
         new QueryResult(
             schema,
-            Arrays.asList(tupleValue(ImmutableMap.of("na,me", "John,Smith", ",,age", "30,,,"))));
-    String expected = "\"na,me\",\",,age\"%n\"John,Smith\",\"30,,,\"";
+            Arrays.asList(
+                tupleValue(ImmutableMap.of("na,me", "John,Smith", ",,age", "30,,,")),
+                tupleValue(ImmutableMap.of("na,me", "\"Janice Jones", ",,age", "26\""))));
+    String expected =
+        "\"na,me\",\",,age\"%n\"John,Smith\",\"30,,,\"%n\"\"\"Janice Jones\",\"26\"\"\"";
     assertEquals(format(expected), formatter.format(response));
   }
 

diff --git a/...l/src/test/java/org/opensearch/sql/protocol/response/format/RawResponseFormatterTest.java b/...l/src/test/java/org/opensearch/sql/protocol/response/format/RawResponseFormatterTest.java
@@ -120,10 +120,18 @@ void quoteIfRequired() {
     QueryResult response =
         new QueryResult(
             schema,
-            Arrays.asList(tupleValue(ImmutableMap.of("na|me", "John|Smith", "||age", "30|||"))));
-    String expected = "\"na|me\"|\"||age\"%n" + "\"John|Smith\"|\"30|||\"";
+            Arrays.asList(
+                tupleValue(ImmutableMap.of("na|me", "John|Smith", "||age", "30|||")),
+                tupleValue(ImmutableMap.of("na|me", "Ja\"ne J\"ones", "||age", "\"40\""))));
+    String expected =
+        "\"na|me\"|\"||age\"%n"
+            + "\"John|Smith\"|\"30|||\"%n"
+            + "\"Ja\"\"ne J\"\"ones\"|\"\"\"40\"\"\"";
     assertEquals(format(expected), getRawFormatter().format(response));
-    String expectedPretty = "\"na|me\"     |\"||age\"%n" + "\"John|Smith\"|\"30|||\"";
+    String expectedPretty =
+        "\"na|me\"         |\"||age\" %n"
+            + "\"John|Smith\"    |\"30|||\" %n"
+            + "\"Ja\"\"ne J\"\"ones\"|\"\"\"40\"\"\"";
     assertEquals(format(expectedPretty), getRawFormatterPretty().format(response));
   }