using System; using System.Linq; using AnyOfTypes; using Newtonsoft.Json.Linq; using Stef.Validation; using WireMock.Extensions; using WireMock.Models; namespace WireMock.Matchers; /// /// JsonPathMatcher /// /// /// public class JsonPathMatcher : IStringMatcher, IObjectMatcher { private readonly AnyOf[] _patterns; /// public MatchBehaviour MatchBehaviour { get; } /// /// Initializes a new instance of the class. /// /// The patterns. public JsonPathMatcher(params string[] patterns) : this(MatchBehaviour.AcceptOnMatch, MatchOperator.Or, patterns.ToAnyOfPatterns()) { } /// /// Initializes a new instance of the class. /// /// The patterns. public JsonPathMatcher(params AnyOf[] patterns) : this(MatchBehaviour.AcceptOnMatch, MatchOperator.Or, patterns) { } /// /// Initializes a new instance of the class. /// /// The match behaviour. /// The to use. (default = "Or") /// The patterns. public JsonPathMatcher( MatchBehaviour matchBehaviour, MatchOperator matchOperator = MatchOperator.Or, params AnyOf[] patterns) { _patterns = Guard.NotNull(patterns); MatchBehaviour = matchBehaviour; MatchOperator = matchOperator; } /// public MatchResult IsMatch(string? input) { var score = MatchScores.Mismatch; Exception? exception = null; if (input != null) { try { var jToken = JToken.Parse(input); score = IsMatch(jToken); } catch (Exception ex) { exception = ex; } } return new MatchResult(MatchBehaviourHelper.Convert(MatchBehaviour, score), exception); } /// public MatchResult IsMatch(object? input) { var score = MatchScores.Mismatch; Exception? exception = null; // When input is null or byte[], return Mismatch. if (input != null && !(input is byte[])) { try { // Check if JToken or object JToken jToken = input as JToken ?? JObject.FromObject(input); score = IsMatch(jToken); } catch (Exception ex) { exception = ex; } } return new MatchResult(MatchBehaviourHelper.Convert(MatchBehaviour, score), exception); } /// public AnyOf[] GetPatterns() { return _patterns; } /// public MatchOperator MatchOperator { get; } /// public string Name => "JsonPathMatcher"; private double IsMatch(JToken jToken) { var array = ConvertJTokenToJArrayIfNeeded(jToken); // 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. var values = _patterns.Select(pattern => array.SelectToken(pattern.GetPattern()) != null).ToArray(); return MatchScores.ToScore(values, MatchOperator); } // https://github.com/WireMock-Net/WireMock.Net/issues/965 // https://stackoverflow.com/questions/66922188/newtonsoft-jsonpath-with-c-sharp-syntax // Filtering using SelectToken() isn't guaranteed to work for objects inside objects -- only objects inside arrays. // So this code checks if it's an JArray, if it's not an array, construct a new JArray. private static JToken ConvertJTokenToJArrayIfNeeded(JToken jToken) { if (jToken.Count() == 1) { var property = jToken.First(); var item = property.First(); if (item is JArray) { return jToken; } return new JObject { [property.Path] = new JArray(item) }; } return jToken; } }