Fix double quote encoding in basilisp.edn/write-string

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
  * Fix a bug where the reader was double counting the CRLF newline seq in metadata (#1063)
  * Conform to the `cider-nrepl` `info` ops spec by ensuring result's `:file` is URI, also added missing :column number (#1066)
+ * Fix a bug with `basilisp.edn/write-string` where nested double quotes were not escaped properly (#1071)
 
 ## [v0.2.3]
 ### Added

src/basilisp/edn.lpy

@@ -539,6 +539,18 @@
 ;; Writers ;;
 ;;;;;;;;;;;;;
 
+(def ^:private str-escape-chars-translation
+  (python.str/maketrans
+   #py {"\\" "\\\\"
+        "\"" "\\\""
+        "\a" "\\a"
+        "\b" "\\b"
+        "\f" "\\f"
+        "\n" "\\n"
+        "\r" "\\r"
+        "\t" "\\t"
+        "\v" "\\v"}))
+
 (defprotocol EDNEncodeable
   (write* [this writer]
     "Write the object ``this`` to the stream ``writer`` encoded as EDN.
@@ -617,9 +629,10 @@
     nil)
   python/str
   (write* [this writer]
-    (.write writer "\"")
-    (.write writer this)
-    (.write writer "\"")
+    (let [decoded (.translate this str-escape-chars-translation)]
+      (.write writer "\"")
+      (.write writer decoded)
+      (.write writer "\""))
     nil)
   nil
   (write* [_this writer]

tests/basilisp/test_edn.lpy

@@ -365,28 +365,52 @@
     \u03A9 "\"Ω\""
 
     \space   "\" \""
-    \newline "\"\n\""
-    \tab     "\"\t\""
-    \return  "\"\r\""))
+    \newline "\"\\n\""
+    \tab     "\"\\t\""
+    \return  "\"\\r\""))
 
 (deftest write-string
-  (are [v s] (= s (edn/write-string v))
-    ""   "\"\""
-    " "  "\" \""
-    "\"" "\"\"\""
-    "\\" "\"\\\""
-    "\a" "\"\a\""
-    "\b" "\"\b\""
-    "\f" "\"\f\""
-    "\n" "\"\n\""
-    "\r" "\"\r\""
-    "\t" "\"\t\""
-    "\v" "\"\v\""
-
-    "Hello,\nmy name is\tChris."   "\"Hello,\nmy name is\tChris.\""
-    "Regular string"               "\"Regular string\""
-    "String with 'inner string'"   "\"String with 'inner string'\""
-    "String with \"inner string\"" "\"String with \"inner string\"\""))
+  (testing "expected outputs"
+    (are [v s] (= s (edn/write-string v))
+      ""   "\"\""
+      " "  "\" \""
+      "\"" "\"\\\"\""
+      "\\" "\"\\\\\""
+      "\a" "\"\\a\""
+      "\b" "\"\\b\""
+      "\f" "\"\\f\""
+      "\n" "\"\\n\""
+      "\r" "\"\\r\""
+      "\t" "\"\\t\""
+      "\v" "\"\\v\""
+
+      (str ["a"]) "\"[\\\"a\\\"]\""
+
+      "Hello,\nmy name is\tChris."   "\"Hello,\\nmy name is\\tChris.\""
+      "Regular string"               "\"Regular string\""
+      "String with 'inner string'"   "\"String with 'inner string'\""
+      "String with \"inner string\"" "\"String with \\\"inner string\\\"\""))
+
+  (testing "round-trip"
+    (are [s] (= s (edn/read-string (edn/write-string s)))
+      ""
+      " "
+      "\""
+      "\\"
+      "\a"
+      "\b"
+      "\f"
+      "\n"
+      "\r"
+      "\t"
+      "\v"
+
+      (str ["a"])
+
+      "Hello,\nmy name is\tChris."
+      "Regular string"
+      "String with 'inner string'"
+      "String with \"inner string\"")))
 
 (deftest write-dispatch
   (are [v s] (= s (edn/write-string v))