Adds support for comments in config files. Closes #600 (#602)

Author: waldekmastykarz

dev-proxy-abstractions/GraphBatchRequestPayload.cs

@@ -1,26 +1,18 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System.Text.Json.Serialization;
-
 namespace Microsoft.DevProxy.Abstractions;
 
 public class GraphBatchRequestPayload
 {
-    [JsonPropertyName("requests")]
     public GraphBatchRequestPayloadRequest[] Requests { get; set; } = Array.Empty<GraphBatchRequestPayloadRequest>();
 }
 
 public class GraphBatchRequestPayloadRequest
 {
-    [JsonPropertyName("id")]
     public string Id { get; set; } = string.Empty;
-    [JsonPropertyName("method")]
     public string Method { get; set; } = string.Empty;
-    [JsonPropertyName("url")]
     public string Url { get; set; } = string.Empty;
-    [JsonPropertyName("headers")]
     public Dictionary<string, string>? Headers { get; set; } = new Dictionary<string, string>();
-    [JsonPropertyName("body")]
     public object? Body { get; set; }
 }

dev-proxy-abstractions/GraphBatchResponsePayload.cs

@@ -1,38 +1,28 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System.Text.Json.Serialization;
-
 namespace Microsoft.DevProxy.Abstractions;
 
 public class GraphBatchResponsePayload
 {
-    [JsonPropertyName("responses")]
     public GraphBatchResponsePayloadResponse[] Responses { get; set; } = Array.Empty<GraphBatchResponsePayloadResponse>();
 }
 
 public class GraphBatchResponsePayloadResponse
 {
-    [JsonPropertyName("id")]
     public string Id { get; set; } = string.Empty;
-    [JsonPropertyName("status")]
     public int Status { get; set; } = 200;
-    [JsonPropertyName("body")]
     public dynamic? Body { get; set; }
-    [JsonPropertyName("headers")]
     public Dictionary<string, string>? Headers { get; set; }
 }
 
 public class GraphBatchResponsePayloadResponseBody
 {
-    [JsonPropertyName("error")]
     public GraphBatchResponsePayloadResponseBodyError? Error { get; set; }
 }
 
 public class GraphBatchResponsePayloadResponseBodyError
 {
-    [JsonPropertyName("code")]
     public string Code { get; set; } = string.Empty;
-    [JsonPropertyName("message")]
     public string Message { get; set; } = string.Empty;
 }

dev-proxy-abstractions/MockResponse.cs

@@ -1,43 +1,31 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System.Text.Json.Serialization;
-
 namespace Microsoft.DevProxy.Abstractions;
 
 public class MockResponse
 {
-    [JsonPropertyName("request")]
     public MockResponseRequest? Request { get; set; }
-    [JsonPropertyName("response")]
     public MockResponseResponse? Response { get; set; }
 }
 
 public class MockResponseRequest
 {
-    [JsonPropertyName("url")]
     public string Url { get; set; } = string.Empty;
-    [JsonPropertyName("method")]
     public string Method { get; set; } = "GET";
-    [JsonPropertyName("nth"), JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public int? Nth { get; set; }
 }
 
 public class MockResponseResponse
 {
-    [JsonPropertyName("statusCode")]
     public int? StatusCode { get; set; } = 200;
-    [JsonPropertyName("body")]
     public dynamic? Body { get; set; }
-    [JsonPropertyName("headers")]
     public List<MockResponseHeader>? Headers { get; set; }
 }
 
 public class MockResponseHeader
 {
-    [JsonPropertyName("name")]
     public string Name { get; set; } = string.Empty;
-    [JsonPropertyName("value")]
     public string Value { get; set; } = string.Empty;
 
     public MockResponseHeader()

dev-proxy-abstractions/ProxyUtils.cs

@@ -2,6 +2,8 @@
 // Licensed under the MIT License.
 
 using System.Reflection;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Text.RegularExpressions;
 using Titanium.Web.Proxy.Http;
 
@@ -23,6 +25,14 @@ public static class ProxyUtils
     private static readonly Regex allAlphaRegex = new Regex("^[a-z]+$", RegexOptions.IgnoreCase);
     private static readonly Regex deprecationRegex = new Regex("^[a-z]+_v2$", RegexOptions.IgnoreCase);
     private static readonly Regex functionCallRegex = new Regex(@"^[a-z]+\(.*\)$", RegexOptions.IgnoreCase);
+    private static readonly JsonSerializerOptions jsonSerializerOptions = new JsonSerializerOptions
+    {
+        DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+        PropertyNameCaseInsensitive = true,
+        ReadCommentHandling = JsonCommentHandling.Skip,
+        WriteIndented = true
+    };
 
     // doesn't end with a path separator
     public static string? AppFolder => Path.GetDirectoryName(AppContext.BaseDirectory);
@@ -326,4 +336,6 @@ public static void MergeHeaders(IList<MockResponseHeader> allHeaders, IList<Mock
             allHeaders.Add(header);
         }
     }
+
+    public static JsonSerializerOptions JsonSerializerOptions => jsonSerializerOptions;
 }

dev-proxy-plugins/Behavior/RateLimitingCustomResponseLoader.cs

@@ -3,7 +3,6 @@
 
 using Microsoft.Extensions.Logging;
 using Microsoft.DevProxy.Abstractions;
-using Microsoft.DevProxy.Plugins.Mocks;
 using System.Text.Json;
 
 namespace Microsoft.DevProxy.Plugins.Behavior;
@@ -37,7 +36,7 @@ public void LoadResponse()
                 using (StreamReader reader = new StreamReader(stream))
                 {
                     var responseString = reader.ReadToEnd();
-                    var response = JsonSerializer.Deserialize<MockResponseResponse>(responseString);
+                    var response = JsonSerializer.Deserialize<MockResponseResponse>(responseString, ProxyUtils.JsonSerializerOptions);
                     if (response is not null)
                     {
                         _configuration.CustomResponse = response;

dev-proxy-plugins/Behavior/RateLimitingPlugin.cs

@@ -83,7 +83,8 @@ private void UpdateProxyResponse(ProxyHttpEventArgsBase e, HttpStatusCode errorS
                             RequestId = requestId,
                             Date = requestDate
                         }
-                    })
+                    }),
+                    ProxyUtils.JsonSerializerOptions
                 );
             }
 
@@ -242,7 +243,7 @@ _urlsToWatch is null ||
                     }
 
                     string body = _configuration.CustomResponse.Body is not null ?
-                        JsonSerializer.Serialize(_configuration.CustomResponse.Body, new JsonSerializerOptions { WriteIndented = true }) :
+                        JsonSerializer.Serialize(_configuration.CustomResponse.Body, ProxyUtils.JsonSerializerOptions) :
                         "";
                     e.Session.GenericResponse(body, responseCode, headers);
                     state.HasBeenSet = true;

dev-proxy-plugins/Behavior/RetryAfterPlugin.cs

@@ -103,7 +103,8 @@ private void UpdateProxyResponse(ProxyRequestArgs e, ThrottlingInfo throttlingIn
                         RequestId = requestId,
                         Date = requestDate
                     }
-                })
+                }),
+                ProxyUtils.JsonSerializerOptions
             );
         }
         else

dev-proxy-plugins/GenericErrorResponse.cs

@@ -1,17 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System.Text.Json.Serialization;
 using Microsoft.DevProxy.Abstractions;
 
 namespace Microsoft.DevProxy.Plugins;
 
 public class GenericErrorResponse
 {
-    [JsonPropertyName("statusCode")]
     public int StatusCode { get; set; }
-    [JsonPropertyName("headers")]
     public List<MockResponseHeader>? Headers { get; set; }
-    [JsonPropertyName("body")]
     public dynamic? Body { get; set; }
 }

dev-proxy-plugins/Guidance/ODataPagingGuidancePlugin.cs

@@ -88,7 +88,7 @@ private string GetNextLinkFromJson(string responseBody)
 
         try
         {
-            var response = JsonSerializer.Deserialize<JsonElement>(responseBody);
+            var response = JsonSerializer.Deserialize<JsonElement>(responseBody, ProxyUtils.JsonSerializerOptions);
             JsonElement nextLinkProperty = new JsonElement();
             if (response.TryGetProperty("@odata.nextLink", out nextLinkProperty))
             {

dev-proxy-plugins/Inspection/DevToolsPlugin.cs

@@ -114,7 +114,7 @@ private void SocketMessageReceived(string msg)
 
         try
         {
-            var message = JsonSerializer.Deserialize<GetResponseBodyMessage>(msg);
+            var message = JsonSerializer.Deserialize<GetResponseBodyMessage>(msg, ProxyUtils.JsonSerializerOptions);
             if (message?.Method == "Network.getResponseBody")
             {
                 var requestId = message.Params?.RequestId;