Fix overaggressive escaping (#8054)

* Update RecordingHandler to use the same encoder as the one that exists within RecordEntry. This has the effect of properly serializing json bodies, without unicode encoding common symbols like '+' and '&'

Author: scbedd

tools/test-proxy/Azure.Sdk.Tools.TestProxy.Tests/RecordSessionTests.cs

@@ -1,11 +1,13 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using System;
 using System.Buffers;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Text.Encodings.Web;
 using System.Text.Json;
 using Azure.Core;
 using Azure.Core.Pipeline;
@@ -33,7 +35,8 @@ public class RecordSessionTests
         [InlineData("19", "application/json")]
         [InlineData("true", "application/json")]
         [InlineData("false", "application/json")]
-        [InlineData("{ \"json\": \"value\" }", "unknown")]
+        [InlineData("{\"a-key\":\"akeywith+inthemiddle\"}", "application/json")]
+        [InlineData("{\"json\":\"value\"}", "unknown")]
         [InlineData("multi\rline", "application/xml")]
         [InlineData("multi\r\nline", "application/xml")]
         [InlineData("multi\n\rline\n", "application/xml")]
@@ -65,7 +68,7 @@ public void CanRoundtripSessionRecord(string body, string contentType)
             var arrayBufferWriter = new ArrayBufferWriter<byte>();
             using var jsonWriter = new Utf8JsonWriter(arrayBufferWriter, new JsonWriterOptions()
             {
-                Indented = true
+                Indented = true, Encoder = RecordEntry.WriterOptions.Encoder
             });
             session.Serialize(jsonWriter);
             jsonWriter.Flush();
@@ -92,6 +95,51 @@ public void CanRoundtripSessionRecord(string body, string contentType)
             Assert.Equal(bodyBytes, deserializedRecord.Response.Body);
         }
 
+        [Fact]
+        public void EnsureJsonEscaping()
+        {
+            var shouldNotExist = new string[] {
+                "\\u0026", "\\u002B"
+            };
+
+            var body = "{\"tags\":{\"hidden-link:/app-insights-resource-id\":\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Lwm_Rg/providers/microsoft.insights/components/FunctionApp1Lwm\"}"
+            + ",\"properties\":{\"WEBSITE_CONTENTAZUREFILECONNECTIONSTRING\":\"DefaultEndpointsProtocol=https;AccountName=anaccountname!;AccountKey=aBase64&String+Fake==;EndpointSuffix=core.windows.net\"}}";
+
+            var session = new RecordSession();
+            session.Entries.Add(new RecordEntry()
+            {
+                Response = new RequestOrResponse()
+                {
+                    Headers = new SortedDictionary<string, string[]>()
+                    {
+                        {
+                            "Content-Type", new string[] { "application/json" }
+                        }
+                    },
+                    Body = Encoding.UTF8.GetBytes(body),
+                }
+            });
+
+            var tmpDir = Path.GetTempPath();
+            var recordSession = Path.Combine(tmpDir, $"{Guid.NewGuid()}.json");
+            using var stream = System.IO.File.Create(recordSession);
+            var options = new JsonWriterOptions { Indented = true, Encoder = RecordEntry.WriterOptions.Encoder };
+            var writer = new Utf8JsonWriter(stream, options);
+
+            session.Serialize(writer);
+            writer.Flush();
+            stream.Close();
+
+            var text = File.ReadAllText(recordSession);
+
+            foreach(var unicodeChar in shouldNotExist)
+            {
+                Assert.DoesNotContain(unicodeChar, text);
+            }
+        }
+
+
+
         [Theory]
         [InlineData("{\"json\":\"value\"}", "application/json")]
         [InlineData("{\"json\":\"\\\"value\\\"\"}", "application/json")]

tools/test-proxy/Azure.Sdk.Tools.TestProxy/Common/RecordEntry.cs

@@ -1,23 +1,23 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using Azure.Core;
 using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
 using System.Text;
 using System.Text.Encodings.Web;
 using System.Text.Json;
+using System.Text.Unicode;
 
 namespace Azure.Sdk.Tools.TestProxy.Common
 {
     public class RecordEntry
     {
         // Requests and 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 roundtrip
-        private static readonly JsonWriterOptions WriterOptions = new JsonWriterOptions()
+        // relaxed settings for roundtrip.
+        public static readonly JsonWriterOptions WriterOptions = new JsonWriterOptions()
         {
             Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping
         };
@@ -217,13 +217,6 @@ private void SerializeBody(Utf8JsonWriter jsonWriter, string name, byte[] reques
                         document.RootElement.ValueKind != JsonValueKind.String &&
                         document.RootElement.ValueKind != JsonValueKind.Null)
                     {
-                        using var memoryStream = new MemoryStream();
-                        // Settings of this writer should be in sync with the one used in deserialization
-                        using (var reformattedWriter = new Utf8JsonWriter(memoryStream, WriterOptions))
-                        {
-                            document.RootElement.WriteTo(reformattedWriter);
-                        }
-
                         jsonWriter.WritePropertyName(name.AsSpan());
                         document.RootElement.WriteTo(jsonWriter);
                         return;

tools/test-proxy/Azure.Sdk.Tools.TestProxy/RecordingHandler.cs

@@ -18,6 +18,7 @@
 using System.Net.Security;
 using System.Security.Cryptography.X509Certificates;
 using System.Text;
+using System.Text.Encodings.Web;
 using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
@@ -146,7 +147,7 @@ public void StopRecording(string sessionId, IDictionary<string, string> variable
                     }
 
                     using var stream = System.IO.File.Create(recordingSession.Path);
-                    var options = new JsonWriterOptions { Indented = true };
+                    var options = new JsonWriterOptions { Indented = true, Encoder = RecordEntry.WriterOptions.Encoder };
                     var writer = new Utf8JsonWriter(stream, options);
                     recordingSession.Session.Serialize(writer);
                     writer.Flush();