Write logging in case a Matcher throws an exception (#986)

* ThrowException

* ...

* .

* ...

* b

* fix test

* ...

* .

* sonar

* ft

* .

* fix tst

src/WireMock.Net/Matchers/JSONPathMatcher.cs

@@ -1,6 +1,6 @@
+using System;
 using System.Linq;
 using AnyOfTypes;
-using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using Stef.Validation;
 using WireMock.Extensions;
@@ -17,17 +17,15 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
 {
     private readonly AnyOf<string, StringPattern>[] _patterns;
 
-    /// <inheritdoc cref="IMatcher.MatchBehaviour"/>
+    /// <inheritdoc />
     public MatchBehaviour MatchBehaviour { get; }
 
-    /// <inheritdoc cref="IMatcher.ThrowException"/>
-    public bool ThrowException { get; }
-
     /// <summary>
     /// Initializes a new instance of the <see cref="JsonPathMatcher"/> class.
     /// </summary>
     /// <param name="patterns">The patterns.</param>
-    public JsonPathMatcher(params string[] patterns) : this(MatchBehaviour.AcceptOnMatch, false, MatchOperator.Or, patterns.ToAnyOfPatterns())
+    public JsonPathMatcher(params string[] patterns) : this(MatchBehaviour.AcceptOnMatch, MatchOperator.Or,
+        patterns.ToAnyOfPatterns())
     {
     }
 
@@ -35,7 +33,8 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
     /// Initializes a new instance of the <see cref="JsonPathMatcher"/> class.
     /// </summary>
     /// <param name="patterns">The patterns.</param>
-    public JsonPathMatcher(params AnyOf<string, StringPattern>[] patterns) : this(MatchBehaviour.AcceptOnMatch, false, MatchOperator.Or, patterns)
+    public JsonPathMatcher(params AnyOf<string, StringPattern>[] patterns) : this(MatchBehaviour.AcceptOnMatch,
+        MatchOperator.Or, patterns)
     {
     }
 
@@ -43,48 +42,45 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
     /// Initializes a new instance of the <see cref="JsonPathMatcher"/> class.
     /// </summary>
     /// <param name="matchBehaviour">The match behaviour.</param>
-    /// <param name="throwException">Throw an exception when the internal matching fails because of invalid input.</param>
     /// <param name="matchOperator">The <see cref="Matchers.MatchOperator"/> to use. (default = "Or")</param>
     /// <param name="patterns">The patterns.</param>
     public JsonPathMatcher(
         MatchBehaviour matchBehaviour,
-        bool throwException = false,
         MatchOperator matchOperator = MatchOperator.Or,
         params AnyOf<string, StringPattern>[] patterns)
     {
         _patterns = Guard.NotNull(patterns);
         MatchBehaviour = matchBehaviour;
-        ThrowException = throwException;
         MatchOperator = matchOperator;
     }
 
-    /// <inheritdoc cref="IStringMatcher.IsMatch"/>
-    public double IsMatch(string? input)
+    /// <inheritdoc />
+    public MatchResult IsMatch(string? input)
     {
-        double match = MatchScores.Mismatch;
+        var score = MatchScores.Mismatch;
+        Exception? exception = null;
+
         if (input != null)
         {
             try
             {
                 var jToken = JToken.Parse(input);
-                match = IsMatch(jToken);
+                score = IsMatch(jToken);
             }
-            catch (JsonException)
+            catch (Exception ex)
             {
-                if (ThrowException)
-                {
-                    throw;
-                }
+                exception = ex;
             }
         }
 
-        return MatchBehaviourHelper.Convert(MatchBehaviour, match);
+        return new MatchResult(MatchBehaviourHelper.Convert(MatchBehaviour, score), exception);
     }
 
-    /// <inheritdoc cref="IObjectMatcher.IsMatch"/>
-    public double IsMatch(object? input)
+    /// <inheritdoc />
+    public MatchResult IsMatch(object? input)
     {
-        double match = MatchScores.Mismatch;
+        var score = MatchScores.Mismatch;
+        Exception? exception = null;
 
         // When input is null or byte[], return Mismatch.
         if (input != null && !(input is byte[]))
@@ -93,18 +89,15 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
             {
                 // Check if JToken or object
                 JToken jToken = input as JToken ?? JObject.FromObject(input);
-                match = IsMatch(jToken);
+                score = IsMatch(jToken);
             }
-            catch (JsonException)
+            catch (Exception ex)
             {
-                if (ThrowException)
-                {
-                    throw;
-                }
+                exception = ex;
             }
         }
 
-        return MatchBehaviourHelper.Convert(MatchBehaviour, match);
+        return new MatchResult(MatchBehaviourHelper.Convert(MatchBehaviour, score), exception);
     }
 
     /// <inheritdoc />
@@ -116,7 +109,7 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
     /// <inheritdoc />
     public MatchOperator MatchOperator { get; }
 
-    /// <inheritdoc cref="IMatcher.Name"/>
+    /// <inheritdoc />
     public string Name => "JsonPathMatcher";
 
     private double IsMatch(JToken jToken)
@@ -125,7 +118,8 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
 
         // The SelectToken method can accept a string path to a child token ( i.e. "Manufacturers[0].Products[0].Price").
         // In that case it will return a JValue (some type) which does not implement the IEnumerable interface.
-        return MatchScores.ToScore(_patterns.Select(pattern => array.SelectToken(pattern.GetPattern()) != null).ToArray(), MatchOperator);
+        return MatchScores.ToScore(
+            _patterns.Select(pattern => array.SelectToken(pattern.GetPattern()) != null).ToArray(), MatchOperator);
     }
 
     // https://github.com/WireMock-Net/WireMock.Net/issues/965
@@ -151,4 +145,4 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
 
         return jToken;
     }
-}
+}