Default to more Newtonsoft-like response encoding in TestFramework (#…

…12482)
Azure · Jun 3, 2020 · ad21e16 · ad21e16
1 parent c4dcd59
commit ad21e16
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 9 deletions.
diff --git a/sdk/core/Azure.Core.TestFramework/src/RecordEntry.cs b/sdk/core/Azure.Core.TestFramework/src/RecordEntry.cs
@@ -6,13 +6,23 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Text.Encodings.Web;
 using System.Text.Json;
 using Azure.Core.Pipeline;
 
 namespace Azure.Core.TestFramework
 {
     public class RecordEntry
     {
+        private static readonly JsonWriterOptions RequestWriterOptions = new JsonWriterOptions();
+        // Responses are usually formatted using Newtonsoft.Json that has more relaxed encoding rules
+        // To enable us to store more responses as JSON instead of string in Recording files use
+        // relaxed settings for roundrip
+        private static readonly JsonWriterOptions ResponseWriterOptions = new JsonWriterOptions()
+        {
+            Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping
+        };
+
         public RecordEntryMessage Request { get; } = new RecordEntryMessage();
 
         public RecordEntryMessage Response { get; } = new RecordEntryMessage();
@@ -51,7 +61,7 @@ public static RecordEntry Deserialize(JsonElement element)
 
             if (element.TryGetProperty("RequestBody", out property))
             {
-                record.Request.Body = DeserializeBody(record.Request.Headers, property);
+                record.Request.Body = DeserializeBody(record.Request.Headers, property, RequestWriterOptions);
             }
 
             if (element.TryGetProperty(nameof(StatusCode), out property) &&
@@ -67,13 +77,13 @@ public static RecordEntry Deserialize(JsonElement element)
 
             if (element.TryGetProperty("ResponseBody", out property))
             {
-                record.Response.Body = DeserializeBody(record.Response.Headers, property);
+                record.Response.Body = DeserializeBody(record.Response.Headers, property, ResponseWriterOptions);
             }
 
             return record;
         }
 
-        private static byte[] DeserializeBody(IDictionary<string, string[]> headers, in JsonElement property)
+        private static byte[] DeserializeBody(IDictionary<string, string[]> headers, in JsonElement property, JsonWriterOptions writerOptions)
         {
             if (property.ValueKind == JsonValueKind.Null)
             {
@@ -85,7 +95,7 @@ private static byte[] DeserializeBody(IDictionary<string, string[]> headers, in
                 if (property.ValueKind == JsonValueKind.Object)
                 {
                     using var memoryStream = new MemoryStream();
-                    using var writer = new Utf8JsonWriter(memoryStream);
+                    using var writer = new Utf8JsonWriter(memoryStream, writerOptions);
                     property.WriteTo(writer);
                     writer.Flush();
                     return memoryStream.ToArray();
@@ -146,19 +156,19 @@ public void Serialize(Utf8JsonWriter jsonWriter)
             SerializeHeaders(jsonWriter, Request.Headers);
             jsonWriter.WriteEndObject();
 
-            SerializeBody(jsonWriter, "RequestBody", Request.Body, Request.Headers);
+            SerializeBody(jsonWriter, "RequestBody", Request.Body, Request.Headers, RequestWriterOptions);
 
             jsonWriter.WriteNumber(nameof(StatusCode), StatusCode);
 
             jsonWriter.WriteStartObject("ResponseHeaders");
             SerializeHeaders(jsonWriter, Response.Headers);
             jsonWriter.WriteEndObject();
 
-            SerializeBody(jsonWriter, "ResponseBody", Response.Body, Response.Headers);
+            SerializeBody(jsonWriter, "ResponseBody", Response.Body, Response.Headers, ResponseWriterOptions);
             jsonWriter.WriteEndObject();
         }
 
-        private void SerializeBody(Utf8JsonWriter jsonWriter, string name, byte[] requestBody, IDictionary<string, string[]> headers)
+        private void SerializeBody(Utf8JsonWriter jsonWriter, string name, byte[] requestBody, IDictionary<string, string[]> headers, JsonWriterOptions writerOptions)
         {
             if (requestBody == null)
             {
@@ -184,9 +194,9 @@ private void SerializeBody(Utf8JsonWriter jsonWriter, string name, byte[] reques
                         // Make sure we can replay JSON is exactly the same as the source
                         // for the case where service response was pre-formatted
                         // fallback to generic string writing
-                        var memoryStream = new MemoryStream();
+                        using var memoryStream = new MemoryStream();
                         // Settings of this writer should be in sync with the one used in deserialiation
-                        using (var reformattedWriter = new Utf8JsonWriter(memoryStream))
+                        using (var reformattedWriter = new Utf8JsonWriter(memoryStream, writerOptions))
                         {
                             document.RootElement.WriteTo(reformattedWriter);
                         }

diff --git a/sdk/core/Azure.Core/tests/RecordSessionTests.cs b/sdk/core/Azure.Core/tests/RecordSessionTests.cs
@@ -5,6 +5,7 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Text.Encodings.Web;
 using System.Text.Json;
 using Azure.Core.Pipeline;
 using Azure.Core.TestFramework;
@@ -16,6 +17,7 @@ namespace Azure.Core.Tests
     public class RecordSessionTests
     {
         [TestCase("{\"json\":\"value\"}", "application/json")]
+        [TestCase("{\"json\":\"\\\"value\\\"\"}", "application/json")]
         [TestCase("{\"json\":{\"json\":\"value\"}}", "application/json")]
         [TestCase("{\"json\"\n:\"value\"}", "application/json")]
         [TestCase("{\"json\" :\"value\"}", "application/json")]