Add Settings.QueryParameterMultipleValueSupport (#836)

* QueryParameterMultipleValueSupport

* .

* ,

* ,

src/WireMock.Net/Owin/IWireMockMiddlewareOptions.cs

@@ -3,13 +3,13 @@ using System.Collections.Concurrent;
 using WireMock.Handlers;
 using WireMock.Logging;
 using WireMock.Matchers;
+using WireMock.Types;
 using WireMock.Util;
 #if !USE_ASPNETCORE
 using Owin;
 #else
 using IAppBuilder = Microsoft.AspNetCore.Builder.IApplicationBuilder;
 using Microsoft.Extensions.DependencyInjection;
-using WireMock.Types;
 #endif
 
 namespace WireMock.Owin;
@@ -70,5 +70,7 @@ internal interface IWireMockMiddlewareOptions
 
     bool? SaveUnmatchedRequests { get; set; }
 
-    public bool? DoNotSaveDynamicResponseInLogEntry { get; set; }
+    bool? DoNotSaveDynamicResponseInLogEntry { get; set; }
+
+    QueryParameterMultipleValueSupport? QueryParameterMultipleValueSupport { get; set; }
 }

src/WireMock.Net/Owin/Mappers/OwinResponseMapper.cs

@@ -81,11 +81,11 @@ namespace WireMock.Owin.Mappers
             var statusCodeType = responseMessage.StatusCode?.GetType();
             switch (statusCodeType)
             {
-                case Type typeAsIntOrEnum when typeAsIntOrEnum == typeof(int) || typeAsIntOrEnum == typeof(int?) || typeAsIntOrEnum.GetTypeInfo().IsEnum:
+                case { } typeAsIntOrEnum when typeAsIntOrEnum == typeof(int) || typeAsIntOrEnum == typeof(int?) || typeAsIntOrEnum.GetTypeInfo().IsEnum:
                     response.StatusCode = MapStatusCode((int)responseMessage.StatusCode!);
                     break;
 
-                case Type typeAsString when typeAsString == typeof(string):
+                case { } typeAsString when typeAsString == typeof(string):
                     // Note: this case will also match on null 
                     int.TryParse(responseMessage.StatusCode as string, out int result);
                     response.StatusCode = MapStatusCode(result);
@@ -130,7 +130,7 @@ namespace WireMock.Owin.Mappers
             switch (responseMessage.BodyData?.DetectedBodyType)
             {
                 case BodyType.String:
-                    return (responseMessage.BodyData.Encoding ?? _utf8NoBom).GetBytes(responseMessage.BodyData.BodyAsString);
+                    return (responseMessage.BodyData.Encoding ?? _utf8NoBom).GetBytes(responseMessage.BodyData.BodyAsString!);
 
                 case BodyType.Json:
                     var formatting = responseMessage.BodyData.BodyAsJsonIndented == true
@@ -143,7 +143,7 @@ namespace WireMock.Owin.Mappers
                     return responseMessage.BodyData.BodyAsBytes;
 
                 case BodyType.File:
-                    return _options.FileSystemHandler?.ReadResponseBodyAsFile(responseMessage.BodyData.BodyAsFile);
+                    return _options.FileSystemHandler?.ReadResponseBodyAsFile(responseMessage.BodyData.BodyAsFile!);
             }
 
             return null;
@@ -161,7 +161,7 @@ namespace WireMock.Owin.Mappers
                 });
 
             // Set other headers
-            foreach (var item in responseMessage.Headers)
+            foreach (var item in responseMessage.Headers!)
             {
                 var headerName = item.Key;
                 var value = item.Value;

src/WireMock.Net/Owin/WireMockMiddlewareOptions.cs

@@ -87,4 +87,7 @@ internal class WireMockMiddlewareOptions : IWireMockMiddlewareOptions
 
     /// <inheritdoc />
     public bool? DoNotSaveDynamicResponseInLogEntry { get; set; }
+
+    /// <inheritdoc />
+    public QueryParameterMultipleValueSupport? QueryParameterMultipleValueSupport { get; set; }
 }

src/WireMock.Net/RequestMessage.cs

@@ -6,6 +6,7 @@ using System.Linq;
 using System.Net;
 using Stef.Validation;
 using WireMock.Models;
+using WireMock.Owin;
 using WireMock.Types;
 using WireMock.Util;
 
@@ -26,7 +27,7 @@ public class RequestMessage : IRequestMessage
     public string AbsoluteUrl { get; }
 
     /// <inheritdoc cref="IRequestMessage.ProxyUrl" />
-    public string ProxyUrl { get; set; }
+    public string? ProxyUrl { get; set; }
 
     /// <inheritdoc cref="IRequestMessage.DateTime" />
     public DateTime DateTime { get; set; }
@@ -91,16 +92,36 @@ public class RequestMessage : IRequestMessage
     /// <inheritdoc cref="IRequestMessage.Origin" />
     public string Origin { get; }
 
+    /// <summary>
+    /// Used for Unit Testing
+    /// </summary>
+    public RequestMessage(
+        UrlDetails urlDetails,
+        string method,
+        string clientIP,
+        IBodyData? bodyData = null,
+        IDictionary<string, string[]>? headers = null,
+        IDictionary<string, string>? cookies = null) : this(null, urlDetails, method, clientIP, bodyData, headers, cookies)
+    {
+    }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="RequestMessage"/> class.
     /// </summary>
+    /// <param name="options">The<seealso cref="IWireMockMiddlewareOptions"/>.</param>
     /// <param name="urlDetails">The original url details.</param>
     /// <param name="method">The HTTP method.</param>
     /// <param name="clientIP">The client IP Address.</param>
     /// <param name="bodyData">The BodyData.</param>
     /// <param name="headers">The headers.</param>
     /// <param name="cookies">The cookies.</param>
-    public RequestMessage(UrlDetails urlDetails, string method, string clientIP, IBodyData? bodyData = null, IDictionary<string, string[]>? headers = null, IDictionary<string, string>? cookies = null)
+    internal RequestMessage(
+        IWireMockMiddlewareOptions? options,
+        UrlDetails urlDetails, string method,
+        string clientIP,
+        IBodyData? bodyData = null,
+        IDictionary<string, string[]>? headers = null,
+        IDictionary<string, string>? cookies = null)
     {
         Guard.NotNull(urlDetails, nameof(urlDetails));
         Guard.NotNull(method, nameof(method));
@@ -134,7 +155,7 @@ public class RequestMessage : IRequestMessage
         Headers = headers?.ToDictionary(header => header.Key, header => new WireMockList<string>(header.Value));
         Cookies = cookies;
         RawQuery = urlDetails.Url.Query;
-        Query = QueryStringParser.Parse(RawQuery);
+        Query = QueryStringParser.Parse(RawQuery, options?.QueryParameterMultipleValueSupport);
     }
 
     /// <summary>

src/WireMock.Net/Server/IRespondWithAProvider.cs

@@ -125,9 +125,9 @@ public interface IRespondWithAProvider
     /// <summary>
     /// Support FireAndForget for any configured Webhooks
     /// </summary>
-    /// <param name="UseWebhooksFireAndForget"></param>
+    /// <param name="useWebhooksFireAndForget"></param>
     /// <returns></returns>
-    IRespondWithAProvider WithWebhookFireAndForget(bool UseWebhooksFireAndForget);
+    IRespondWithAProvider WithWebhookFireAndForget(bool useWebhooksFireAndForget);
 
     /// <summary>
     /// Add a Webhook to call after the response has been generated.
@@ -141,7 +141,7 @@ public interface IRespondWithAProvider
     /// <returns>The <see cref="IRespondWithAProvider"/>.</returns>
     IRespondWithAProvider WithWebhook(
         string url,
-        string? method = "post",
+        string method = "post",
         IDictionary<string, WireMockList<string>>? headers = null,
         string? body = null,
         bool useTransformer = true,
@@ -160,7 +160,7 @@ public interface IRespondWithAProvider
     /// <returns>The <see cref="IRespondWithAProvider"/>.</returns>
     IRespondWithAProvider WithWebhook(
         string url,
-        string? method = "post",
+        string method = "post",
         IDictionary<string, WireMockList<string>>? headers = null,
         object? body = null,
         bool useTransformer = true,

src/WireMock.Net/Server/RespondWithAProvider.cs

@@ -30,7 +30,7 @@ internal class RespondWithAProvider : IRespondWithAProvider
     private readonly WireMockServerSettings _settings;
     private readonly bool _saveToFile;
 
-    private bool _useWebhookFireAndForget = false;
+    private bool _useWebhookFireAndForget;
 
     public Guid Guid { get; private set; } = Guid.NewGuid();
 

src/WireMock.Net/Server/WireMockServer.Admin.cs

@@ -223,6 +223,7 @@ public partial class WireMockServer
             WatchStaticMappingsInSubdirectories = _settings.WatchStaticMappingsInSubdirectories,
             HostingScheme = _settings.HostingScheme,
             DoNotSaveDynamicResponseInLogEntry = _settings.DoNotSaveDynamicResponseInLogEntry,
+            QueryParameterMultipleValueSupport = _settings.QueryParameterMultipleValueSupport,
 
 #if USE_ASPNETCORE
             CorsPolicyOptions = _settings.CorsPolicyOptions?.ToString()
@@ -252,6 +253,7 @@ public partial class WireMockServer
         _settings.WatchStaticMappings = settings.WatchStaticMappings;
         _settings.WatchStaticMappingsInSubdirectories = settings.WatchStaticMappingsInSubdirectories;
         _settings.DoNotSaveDynamicResponseInLogEntry = settings.DoNotSaveDynamicResponseInLogEntry;
+        _settings.QueryParameterMultipleValueSupport = settings.QueryParameterMultipleValueSupport;
 
         InitSettings(_settings);
 

src/WireMock.Net/Server/WireMockServer.cs

@@ -296,6 +296,7 @@ public partial class WireMockServer : IWireMockServer
         _options.HandleRequestsSynchronously = settings.HandleRequestsSynchronously;
         _options.SaveUnmatchedRequests = settings.SaveUnmatchedRequests;
         _options.DoNotSaveDynamicResponseInLogEntry = settings.DoNotSaveDynamicResponseInLogEntry;
+        _options.QueryParameterMultipleValueSupport = settings.QueryParameterMultipleValueSupport;
 
         if (settings.CustomCertificateDefined)
         {

src/WireMock.Net/Settings/WireMockServerSettings.cs

@@ -258,6 +258,14 @@ namespace WireMock.Settings
         [PublicAPI]
         public bool? DoNotSaveDynamicResponseInLogEntry { get; set; }
 
+        /// <summary>
+        /// See <seealso cref="QueryParameterMultipleValueSupport"/>.
+        ///
+        /// Default value = "All".
+        /// </summary>
+        [PublicAPI]
+        public QueryParameterMultipleValueSupport? QueryParameterMultipleValueSupport { get; set; }
+
         /// <summary>
         /// Custom matcher mappings for static mappings
         /// </summary>

src/WireMock.Net/Settings/WireMockServerSettingsParser.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Diagnostics.CodeAnalysis;
 using JetBrains.Annotations;
 using Stef.Validation;
@@ -55,7 +54,8 @@ public static class WireMockServerSettingsParser
             WatchStaticMappings = parser.GetBoolValue("WatchStaticMappings"),
             WatchStaticMappingsInSubdirectories = parser.GetBoolValue("WatchStaticMappingsInSubdirectories"),
             HostingScheme = parser.GetEnumValue<HostingScheme>(nameof(WireMockServerSettings.HostingScheme)),
-            DoNotSaveDynamicResponseInLogEntry = parser.GetBoolValue(nameof(WireMockServerSettings.DoNotSaveDynamicResponseInLogEntry))
+            DoNotSaveDynamicResponseInLogEntry = parser.GetBoolValue(nameof(WireMockServerSettings.DoNotSaveDynamicResponseInLogEntry)),
+            QueryParameterMultipleValueSupport = parser.GetEnumValue<QueryParameterMultipleValueSupport>(nameof(WireMockServerSettings.QueryParameterMultipleValueSupport))
         };
 
 #if USE_ASPNETCORE

src/WireMock.Net/Util/QueryStringParser.cs

@@ -11,25 +11,41 @@ namespace WireMock.Util;
 /// </summary>
 internal static class QueryStringParser
 {
-    public static IDictionary<string, WireMockList<string>> Parse(string queryString)
+    private static readonly Dictionary<string, WireMockList<string>> Empty = new();
+
+    public static IDictionary<string, WireMockList<string>> Parse(string? queryString, QueryParameterMultipleValueSupport? support = null)
     {
         if (string.IsNullOrEmpty(queryString))
         {
-            return new Dictionary<string, WireMockList<string>>();
+            return Empty;
         }
 
+        var queryParameterMultipleValueSupport = support ?? QueryParameterMultipleValueSupport.All;
+
         string[] JoinParts(string[] parts)
         {
             if (parts.Length > 1)
             {
-                return parts[1].Split(new[] { "," }, StringSplitOptions.RemoveEmptyEntries); // support "?key=1,2"
+                return queryParameterMultipleValueSupport.HasFlag(QueryParameterMultipleValueSupport.Comma) ?
+                    parts[1].Split(new[] { "," }, StringSplitOptions.RemoveEmptyEntries) : // Support "?key=1,2"
+                    new[] { parts[1] };
             }
 
             return new string[0];
         }
 
-        return queryString.TrimStart('?')
-            .Split(new[] { '&', ';' }, StringSplitOptions.RemoveEmptyEntries) // Support "?key=value;key=anotherValue" and "?key=value&key=anotherValue"
+        var splitOn = new List<string>();
+        if (queryParameterMultipleValueSupport.HasFlag(QueryParameterMultipleValueSupport.Ampersand))
+        {
+            splitOn.Add("&"); // Support "?key=value&key=anotherValue"
+        }
+        if (queryParameterMultipleValueSupport.HasFlag(QueryParameterMultipleValueSupport.SemiColon))
+        {
+            splitOn.Add(";"); // Support "?key=value;key=anotherValue"
+        }
+
+        return queryString!.TrimStart('?')
+            .Split(splitOn.ToArray(), StringSplitOptions.RemoveEmptyEntries)
             .Select(parameter => parameter.Split(new[] { '=' }, 2, StringSplitOptions.RemoveEmptyEntries))
             .GroupBy(parts => parts[0], JoinParts)
             .ToDictionary(grouping => grouping.Key, grouping => new WireMockList<string>(grouping.SelectMany(x => x).Select(WebUtility.UrlDecode)));