Fix FormUrlEncodedMatcher (+ refactor values / matchers logic) (#1503)

* Fix FormUrlEncodedMatcher

* tests

* Apply suggestions from code review

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* fix comments

---------

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

src/WireMock.Net.Abstractions/Models/IBodyData.cs

@@ -46,7 +46,7 @@ public interface IBodyData
     /// <summary>
     /// The body as Form UrlEncoded dictionary.
     /// </summary>
-    IDictionary<string, string>? BodyAsFormUrlEncoded { get; set; }
+    IDictionary<string, WireMockList<string>>? BodyAsFormUrlEncoded { get; set; }
 
     /// <summary>
     /// The detected body type (detection based on body content).

src/WireMock.Net.Abstractions/Types/WireMockList.cs

@@ -46,6 +46,98 @@ public class WireMockList<T> : List<T>
     /// <param name="values">The values to set.</param>
     public static implicit operator WireMockList<T>(T[] values) => new(values);
 
+    /// <summary>
+    /// Operator for equality comparison from WireMockList to T
+    /// </summary>
+    public static bool operator ==(WireMockList<T>? left, T? right)
+    {
+        if (ReferenceEquals(left, right))
+        {
+            return true;
+        }
+
+        if (left?.Count == 1 && Equals(left[0], right))
+        {
+            return true;
+        }
+
+        return false;
+    }
+
+    /// <summary>
+    /// Operator for equality comparison from T to WireMockList
+    /// </summary>
+    public static bool operator ==(T? left, WireMockList<T>? right)
+    {
+        if (ReferenceEquals(left, right))
+        {
+            return true;
+        }
+
+        if (right?.Count == 1 && Equals(left, right[0]))
+        {
+            return true;
+        }
+
+        return false;
+    }
+
+    /// <summary>
+    /// Operator for inequality comparison from WireMockList to T
+    /// </summary>
+    public static bool operator !=(WireMockList<T>? left, T? right) => !(left == right);
+
+    /// <summary>
+    /// Operator for inequality comparison from T to WireMockList
+    /// </summary>
+    public static bool operator !=(T? left, WireMockList<T>? right) => !(left == right);
+
+    /// <summary>
+    /// Determines whether the specified object is equal to the current instance.
+    /// Two <see cref="WireMockList{T}"/> instances are equal if they contain the same elements in the same order.
+    /// </summary>
+    public override bool Equals(object? obj)
+    {
+        if (ReferenceEquals(this, obj))
+        {
+            return true;
+        }
+
+        if (obj is WireMockList<T> other)
+        {
+            if (Count != other.Count)
+            {
+                return false;
+            }
+
+            for (var i = 0; i < Count; i++)
+            {
+                if (!Equals(this[i], other[i]))
+                {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /// <summary>
+    /// Returns a hash code for this instance based on its elements.
+    /// </summary>
+    public override int GetHashCode()
+    {
+        var hashCode = 17;
+        foreach (var item in this)
+        {
+            hashCode = hashCode * 31 + (item?.GetHashCode() ?? 0);
+        }
+
+        return hashCode;
+    }
+
     /// <summary>
     /// Returns a <see cref="string" /> that represents this instance.
     /// </summary>
@@ -61,7 +153,7 @@ public class WireMockList<T> : List<T>
                 {
                     return strValue;
                 }
-               
+
                 return this[0]?.ToString() ?? string.Empty;
 
             default:

src/WireMock.Net.Minimal/Matchers/FormUrlEncodedMatcher.cs

@@ -1,10 +1,10 @@
 // Copyright © WireMock.Net
 
-using System.Linq;
 using AnyOfTypes;
 using Stef.Validation;
 using WireMock.Extensions;
 using WireMock.Models;
+using WireMock.Types;
 using WireMock.Util;
 
 namespace WireMock.Matchers;
@@ -21,7 +21,7 @@ public class FormUrlEncodedMatcher : IStringMatcher, IIgnoreCaseMatcher
     /// <inheritdoc />
     public MatchBehaviour MatchBehaviour { get; }
 
-    private readonly List<(WildcardMatcher Key, WildcardMatcher? Value)> _pairs = [];
+    private readonly List<(WildcardMatcher Key, WildcardMatcher[]? Values)> KeyValueMatchers = [];
 
     /// <summary>
     /// Initializes a new instance of the <see cref="FormUrlEncodedMatcher"/> class.
@@ -91,9 +91,10 @@ public class FormUrlEncodedMatcher : IStringMatcher, IIgnoreCaseMatcher
             {
                 foreach (var nameValue in nameValueCollection)
                 {
-                    var keyMatcher = new WildcardMatcher(MatchBehaviour.AcceptOnMatch, [nameValue.Key], ignoreCase, MatchOperator);
-                    var valueMatcher = new WildcardMatcher(MatchBehaviour.AcceptOnMatch, [nameValue.Value], ignoreCase, MatchOperator);
-                    _pairs.Add((keyMatcher, valueMatcher));
+                    var keyMatcher = new WildcardMatcher(MatchBehaviour.AcceptOnMatch, nameValue.Key, ignoreCase);
+                    var valueMatchers = nameValue.Value.Select(value => new WildcardMatcher(MatchBehaviour.AcceptOnMatch, value, ignoreCase)).ToArray();
+
+                    KeyValueMatchers.Add((keyMatcher, valueMatchers));
                 }
             }
         }
@@ -119,34 +120,48 @@ public class FormUrlEncodedMatcher : IStringMatcher, IIgnoreCaseMatcher
         return MatchResult.From(Name, MatchBehaviourHelper.Convert(MatchBehaviour, score));
     }
 
-    private bool[] GetMatches(IDictionary<string, string> inputNameValueCollection)
+    private List<double> GetMatches(IDictionary<string, WireMockList<string>> inputNameValueCollection)
     {
-        var matches = new List<bool>();
-        if (_pairs.Count > inputNameValueCollection.Count)
+        var inputPairs = inputNameValueCollection.ToArray();
+        var rowCount = inputPairs.Length;
+        var columnCount = KeyValueMatchers.Count;
+
+        if (rowCount == 0 && columnCount == 0)
         {
-            matches.AddRange(Enumerable.Repeat(false, _pairs.Count - inputNameValueCollection.Count));
+            return [];
         }
 
-        foreach (var inputKeyValuePair in inputNameValueCollection)
+        var matrix = new double[rowCount][];
+
+        for (var row = 0; row < rowCount; row++)
         {
-            var match = false;
-            foreach (var pair in _pairs)
+            matrix[row] = new double[columnCount];
+
+            var inputKeyValuePair = inputPairs[row];
+            var inputKey = inputKeyValuePair.Key;
+            var inputValues = inputKeyValuePair.Value;
+
+            for (var column = 0; column < columnCount; column++)
             {
-                var keyMatchResult = pair.Key.IsMatch(inputKeyValuePair.Key).IsPerfect();
-                if (keyMatchResult)
-                {
-                    match = pair.Value?.IsMatch(inputKeyValuePair.Value).IsPerfect() ?? false;
-                    if (match)
-                    {
-                        break;
-                    }
-                }
-            }
+                var (keyMatcher, valuesMatchers) = KeyValueMatchers[column];
 
-            matches.Add(match);
+                var keyScore = keyMatcher.IsMatch(inputKey).Score;
+                var valueScore = valuesMatchers != null ? MatchScores.ToScore(inputValues, valuesMatchers) : MatchScores.Perfect;
+
+                matrix[row][column] = Math.Min(keyScore, valueScore);
+            }
         }
 
-        return matches.ToArray();
+        var rowScores = rowCount == 0 ? [] : matrix.Select(row => row.Length == 0 ? MatchScores.Mismatch : row.Max()).ToList();
+
+        var columnScores = new List<double>();
+        for (var column = 0; column < columnCount; column++)
+        {
+            columnScores.Add(rowCount == 0 ? MatchScores.Mismatch : matrix.Max(row => row[column]));
+        }
+
+        rowScores.AddRange(columnScores);
+        return rowScores;
     }
 
     /// <inheritdoc />

src/WireMock.Net.Minimal/Matchers/Request/RequestMessageBodyMatcher.cs

@@ -2,6 +2,7 @@
 
 using Stef.Validation;
 using WireMock.Matchers.Helpers;
+using WireMock.Types;
 using WireMock.Util;
 
 namespace WireMock.Matchers.Request;
@@ -34,7 +35,7 @@ public class RequestMessageBodyMatcher : IRequestMatcher
     /// <summary>
     /// The body data function for FormUrlEncoded
     /// </summary>
-    public Func<IDictionary<string, string>?, bool>? MatchOnBodyAsFormUrlEncodedFunc { get; }
+    public Func<IDictionary<string, WireMockList<string>>?, bool>? MatchOnBodyAsFormUrlEncodedFunc { get; }
 
     /// <summary>
     /// The matchers.
@@ -116,7 +117,7 @@ public class RequestMessageBodyMatcher : IRequestMatcher
     /// Initializes a new instance of the <see cref="RequestMessageBodyMatcher"/> class.
     /// </summary>
     /// <param name="func">The function.</param>
-    public RequestMessageBodyMatcher(Func<IDictionary<string, string>?, bool> func)
+    public RequestMessageBodyMatcher(Func<IDictionary<string, WireMockList<string>>?, bool> func)
     {
         MatchOnBodyAsFormUrlEncodedFunc = Guard.NotNull(func);
     }

src/WireMock.Net.Minimal/Matchers/Request/RequestMessageParamMatcher.cs

@@ -115,36 +115,6 @@ public class RequestMessageParamMatcher : IRequestMatcher
         }
 
         // Return the score based on Matchers and valuesPresentInRequestMessage
-        return CalculateScore(Matchers, valuesPresentInRequestMessage);
-    }
-
-    private static double CalculateScore(IReadOnlyList<IStringMatcher> matchers, WireMockList<string> valuesPresentInRequestMessage)
-    {
-        var total = new List<double>();
-
-        // If the total patterns in all matchers > values in message, use the matcher as base
-        if (matchers.Sum(m => m.GetPatterns().Length) > valuesPresentInRequestMessage.Count)
-        {
-            foreach (var matcher in matchers)
-            {
-                double score = 0d;
-                foreach (string valuePresentInRequestMessage in valuesPresentInRequestMessage)
-                {
-                    score += matcher.IsMatch(valuePresentInRequestMessage).Score / matcher.GetPatterns().Length;
-                }
-
-                total.Add(score);
-            }
-        }
-        else
-        {
-            foreach (string valuePresentInRequestMessage in valuesPresentInRequestMessage)
-            {
-                var score = matchers.Max(m => m.IsMatch(valuePresentInRequestMessage).Score);
-                total.Add(score);
-            }
-        }
-
-        return total.Any() ? MatchScores.ToScore(total, MatchOperator.Average) : 0;
+        return MatchScores.ToScore(valuesPresentInRequestMessage, Matchers.ToArray());
     }
 }

src/WireMock.Net.Minimal/RequestBuilders/Request.WithBody.cs

@@ -5,6 +5,7 @@
 using Stef.Validation;
 using WireMock.Matchers;
 using WireMock.Matchers.Request;
+using WireMock.Types;
 using WireMock.Util;
 
 namespace WireMock.RequestBuilders;
@@ -84,7 +85,7 @@ public partial class Request
     }
 
     /// <inheritdoc />
-    public IRequestBuilder WithBody(Func<IDictionary<string, string>?, bool> func)
+    public IRequestBuilder WithBody(Func<IDictionary<string, WireMockList<string>>?, bool> func)
     {
         _requestMatchers.Add(new RequestMessageBodyMatcher(Guard.NotNull(func)));
         return this;

src/WireMock.Net.Shared/Extensions/AnyOfExtensions.cs

@@ -1,7 +1,5 @@
 // Copyright © WireMock.Net
 
-using System.Collections.Generic;
-using System.Linq;
 using AnyOfTypes;
 using WireMock.Models;
 

src/WireMock.Net.Shared/Matchers/MatchScores.cs

@@ -1,8 +1,6 @@
 // Copyright © WireMock.Net
 
-using System;
-using System.Collections.Generic;
-using System.Linq;
+using WireMock.Types;
 
 namespace WireMock.Matchers;
 
@@ -57,7 +55,7 @@ public static class MatchScores
     /// <param name="values">The values.</param>
     /// <param name="matchOperator">The <see cref="MatchOperator"/>.</param>
     /// <returns>average score</returns>
-    public static double ToScore(IReadOnlyCollection<bool> values, MatchOperator matchOperator)
+    public static double ToScore(IReadOnlyList<bool> values, MatchOperator matchOperator)
     {
         return ToScore(values.Select(ToScore).ToArray(), matchOperator);
     }
@@ -68,9 +66,9 @@ public static class MatchScores
     /// <param name="values">The values.</param>
     /// <param name="matchOperator"></param>
     /// <returns>average score</returns>
-    public static double ToScore(IReadOnlyCollection<double> values, MatchOperator matchOperator)
+    public static double ToScore(IReadOnlyList<double> values, MatchOperator matchOperator)
     {
-        if (!values.Any())
+        if (values.Count == 0)
         {
             return Mismatch;
         }
@@ -82,4 +80,28 @@ public static class MatchScores
             _ => values.Average()
         };
     }
+
+    internal static double ToScore(WireMockList<string> values, IStringMatcher[] matchers, MatchOperator matchOperator = MatchOperator.And)
+    {
+        // Create a matrix of scores where each row corresponds to a value and each column corresponds to a matcher.
+        var matrix = values
+            .Select(value => matchers
+                .Select(matcher => matcher.IsMatch(value).Score).ToArray()
+            )
+            .ToArray();
+
+        if (matrix.Length == 0 || matchers.Length == 0)
+        {
+            return Mismatch;
+        }
+
+        // For each value, how well was it matched by its best matcher?
+        var rowScore = matchOperator == MatchOperator.And ? matrix.Average(row => row.Max()) : matrix.Max(row => row.Max());
+
+        // For each matcher, how well was it satisfied by its best value?
+        var columnRange = Enumerable.Range(0, matchers.Length);
+        var columnScore = matchOperator == MatchOperator.And ? columnRange.Average(column => matrix.Max(row => row[column])) : columnRange.Max(column => matrix.Max(row => row[column]));
+
+        return matchOperator == MatchOperator.And ? Math.Min(rowScore, columnScore) : Math.Max(rowScore, columnScore);
+    }
 }

src/WireMock.Net.Shared/Models/BodyData.cs

@@ -22,7 +22,7 @@ public class BodyData : IBodyData
     public string? BodyAsString { get; set; }
 
     /// <inheritdoc />
-    public IDictionary<string, string>? BodyAsFormUrlEncoded { get; set; }
+    public IDictionary<string, WireMockList<string>>? BodyAsFormUrlEncoded { get; set; }
 
     /// <inheritdoc />
     public object? BodyAsJson { get; set; }

src/WireMock.Net.Shared/RequestBuilders/IBodyRequestBuilder.cs

@@ -1,8 +1,7 @@
 // Copyright © WireMock.Net
 
-using System;
-using System.Collections.Generic;
 using WireMock.Matchers;
+using WireMock.Types;
 using WireMock.Util;
 
 namespace WireMock.RequestBuilders;
@@ -100,5 +99,5 @@ public interface IBodyRequestBuilder : IMultiPartRequestBuilder
     /// </summary>
     /// <param name="func">The form-urlencoded values.</param>
     /// <returns>The <see cref="IRequestBuilder"/>.</returns>
-    IRequestBuilder WithBody(Func<IDictionary<string, string>?, bool> func);
+    IRequestBuilder WithBody(Func<IDictionary<string, WireMockList<string>>?, bool> func);
 }

src/WireMock.Net.Shared/Util/QueryStringParser.cs

@@ -1,9 +1,6 @@
 // Copyright © WireMock.Net
 
-using System;
-using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
-using System.Linq;
 using System.Net;
 using WireMock.Types;
 
@@ -16,7 +13,7 @@ internal static class QueryStringParser
 {
     private static readonly Dictionary<string, WireMockList<string>> Empty = new();
 
-    public static bool TryParse(string? queryString, bool caseIgnore, [NotNullWhen(true)] out IDictionary<string, string>? nameValueCollection)
+    public static bool TryParse(string? queryString, bool caseIgnore, [NotNullWhen(true)] out IDictionary<string, WireMockList<string>>? nameValueCollection)
     {
         if (queryString == null)
         {
@@ -29,12 +26,22 @@ internal static class QueryStringParser
             .Select(parameter => parameter.Split('='))
             .Distinct();
 
-        nameValueCollection = caseIgnore ? new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase) : new Dictionary<string, string>();
+        nameValueCollection = caseIgnore ? new Dictionary<string, WireMockList<string>>(StringComparer.OrdinalIgnoreCase) : new Dictionary<string, WireMockList<string>>();
         foreach (var part in parts)
         {
             if (part.Length == 2)
             {
-                nameValueCollection.Add(part[0], WebUtility.UrlDecode(part[1]));
+                var key = part[0];
+                var value = WebUtility.UrlDecode(part[1]);
+
+                if (!nameValueCollection.TryGetValue(key, out var stringList))
+                {
+                    nameValueCollection.Add(key, value);
+                }
+                else
+                {
+                    stringList.Add(value);
+                }
             }
         }