< Summary - AsyncResponse (Release / net8.0+net10.0 / unit+integration)

Information
Class: AsyncResponse.Transports.CorrelationIdJsonPaths
Assembly: AsyncResponse.Transports.RabbitMQ
File(s): /_/src/Transports/Shared/CorrelationIdJsonPaths.cs
Line coverage
98%
Covered lines: 113
Uncovered lines: 2
Coverable lines: 115
Total lines: 268
Line coverage: 98.2%
Branch coverage
91%
Covered branches: 57
Total branches: 62
Branch coverage: 91.9%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.cctor()100%11100%
Extract(...)90%1010100%
GetSplitPaths(...)100%88100%
TryReadPath(...)100%1212100%
TryGetProperty(...)100%11100%
RentSeenNames()100%22100%
ReturnSeenNames(...)50%2280%
TryGetProperty(...)100%1616100%
UnwrapJsonString(...)75%121293.75%

File(s)

/_/src/Transports/Shared/CorrelationIdJsonPaths.cs

#LineLine coverage
 1using System.Runtime.CompilerServices;
 2using System.Text.Json;
 3
 4namespace AsyncResponse.Transports;
 5
 6// Shared source for every transport's correlation-id extractor (the 7 broker transports plus
 7// DbCorrelationIdExtractor, which the 3 database transports funnel through): each csproj pulls
 8// this file in via <Compile Include="..\Shared\CorrelationIdJsonPaths.cs" />, so it compiles INTO
 9// each provider assembly. The provider-specific fast path (header/property/attribute lookup) stays
 10// in the per-transport extractor; only the JSON-body path walk lives here.
 11
 12/// <summary>
 13/// Locates the AsyncResponse correlation id inside a message body via configured dotted JSON paths.
 14/// Configured paths are pre-split into segments once per distinct <c>CorrelationIdJsonPaths</c>
 15/// array instead of on every delivered message — the array is startup configuration read by every
 16/// provider's options, not per-message data. The body is walked over a <see cref="JsonDocument"/>
 17/// rather than a mutable <see cref="System.Text.Json.Nodes.JsonNode"/> DOM: a <see
 18/// cref="JsonDocument"/> rents its buffer from the array pool and returns it on <c>Dispose</c>,
 19/// and <see cref="JsonElement.EnumerateObject"/> never allocates a wrapper node per property, where
 20/// the DOM allocates one node per visited property and is never disposed by its caller.
 21/// </summary>
 22internal static class CorrelationIdJsonPaths
 23{
 24    // Keyed by the options-held array's identity (never its content): the array is validated once
 25    // at subscriber startup and re-read on every delivered message afterward, so this amortizes
 26    // path.Split across the process lifetime of a subscriber instead of paying it per message. A
 27    // ConditionalWeakTable lets a replaced array (or one built by a short-lived options instance in
 28    // a test) fall out of the cache with the array itself instead of being pinned forever.
 229    private static readonly ConditionalWeakTable<string[], string[][]> SplitPathCache = new();
 30
 31    /// <summary>
 32    /// Returns the first non-blank value found by walking <paramref name="jsonPaths"/> against
 33    /// <paramref name="messageJson"/> in order, or <see langword="null"/> when none resolve.
 34    /// </summary>
 35    public static string? Extract(string messageJson, string[]? jsonPaths)
 36    {
 3437        if (jsonPaths is null || jsonPaths.Length == 0 || string.IsNullOrWhiteSpace(messageJson))
 438            return null;
 39
 3040        var splitPaths = GetSplitPaths(jsonPaths);
 41
 42        JsonDocument document;
 43        try
 44        {
 3045            document = JsonDocument.Parse(messageJson);
 2846        }
 247        catch (JsonException)
 48        {
 249            return null;
 50        }
 51
 2852        using (document)
 53        {
 14854            foreach (var segments in splitPaths)
 55            {
 5256                var value = TryReadPath(document.RootElement, segments);
 5257                if (!string.IsNullOrWhiteSpace(value))
 1258                    return value;
 59            }
 1660        }
 61
 1662        return null;
 1463    }
 64
 65    private static string[][] GetSplitPaths(string[] jsonPaths)
 3066        => SplitPathCache.GetValue(jsonPaths, static paths =>
 3067        {
 3068            // A blank configured path is dropped here rather than cached as a no-op entry,
 3069            // mirroring the pre-shared walker's per-call IsNullOrWhiteSpace(path) short-circuit.
 3070            // A non-blank path of only dots/whitespace (e.g. ".") is NOT blank by that check, so
 3071            // it is kept even though it splits to zero segments — TryReadPath below walks zero
 3072            // steps and reads the message root itself, same as the pre-shared walker did.
 3073            var nonBlankCount = 0;
 22474            foreach (var path in paths)
 3075            {
 8276                if (!string.IsNullOrWhiteSpace(path))
 8077                    nonBlankCount++;
 3078            }
 3079
 3080            var split = new string[nonBlankCount][];
 3081            var index = 0;
 22482            foreach (var path in paths)
 3083            {
 8284                if (string.IsNullOrWhiteSpace(path))
 3085                    continue;
 8086                split[index++] = path.Split('.', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries)
 3087            }
 3088
 3089            return split;
 3090        });
 91
 92    private static string? TryReadPath(JsonElement root, string[] segments)
 93    {
 5294        var current = root;
 95
 96        // An embedded JSON string can appear at any segment, so the unwrap below can reparse
 97        // more than once per path; only the most recent reparse needs to stay alive; a value it
 98        // produced is copied out (GetString/GetRawText) before it is disposed.
 5299        JsonDocument? scratch = null;
 100        try
 101        {
 198102            foreach (var segment in segments)
 103            {
 64104                current = UnwrapJsonString(current, ref scratch);
 62105                if (current.ValueKind != JsonValueKind.Object)
 14106                    return null;
 107
 48108                if (!TryGetProperty(current, segment, out var next))
 16109                    return null;
 110
 30111                current = next;
 112            }
 113
 18114            current = UnwrapJsonString(current, ref scratch);
 14115            return current.ValueKind switch
 14116            {
 10117                JsonValueKind.String => current.GetString(),
 2118                JsonValueKind.Number or JsonValueKind.True or JsonValueKind.False => current.GetRawText(),
 2119                _ => null
 14120            };
 121        }
 8122        catch (InvalidOperationException)
 123        {
 124            // An ESCAPED lone surrogate ("\ud800") is well-formed JSON — Parse accepts it — but it
 125            // has no UTF-16 string form, so transcoding it (JsonProperty.Name on any property of a
 126            // walked object, GetString on the value or on an embedded-JSON candidate) throws
 127            // InvalidOperationException, not JsonException. Same rule as the duplicate key below:
 128            // unresolvable, NOT a failure — an escape here made an unroutable inbound message a
 129            // handler failure, which on RabbitMQ's default MaxDeliveryAttempts = 0 requeues forever.
 8130            return null;
 131        }
 132        finally
 133        {
 52134            scratch?.Dispose();
 52135        }
 52136    }
 137
 138    // Mirrors JsonObject.TryGetPropertyValue then a case-insensitive scan: an exact (ordinal) match
 139    // wins when present, else the first case-insensitive match in document order. JsonObject
 140    // materializes its whole backing dictionary the instant any property is touched, so on this
 141    // runtime looking up ANY property of an object that contains an exact-duplicate key anywhere —
 142    // not only when the duplicate is the key being requested — throws ArgumentException. A
 143    // JsonElement walk materializes nothing, so the object is scanned once here to detect and
 144    // reproduce that rather than silently resolving to one of the duplicates.
 145    private static bool TryGetProperty(JsonElement obj, string name, out JsonElement value)
 146    {
 48147        var seen = RentSeenNames();
 148        try
 149        {
 48150            return TryGetProperty(obj, name, seen, out value);
 151        }
 152        finally
 153        {
 48154            ReturnSeenNames(seen);
 48155        }
 46156    }
 157
 158    // The duplicate-key scan needs a set of the object's property names, and used to allocate a
 159    // fresh one — set, buckets, and every growth step on the way to the object's size — for every
 160    // segment of every configured path of every delivered message. The walk is synchronous and
 161    // never re-enters itself, so one set per thread serves them all; a set grown by an unusually
 162    // wide object is dropped rather than pinned on the thread for good.
 163    [ThreadStatic]
 164    private static HashSet<string>? t_seenNames;
 165
 166    private const int MaxRetainedSeenNames = 256;
 167
 168    private static HashSet<string> RentSeenNames()
 169    {
 48170        var seen = t_seenNames ?? new HashSet<string>(StringComparer.Ordinal);
 48171        t_seenNames = null;
 48172        return seen;
 173    }
 174
 175    private static void ReturnSeenNames(HashSet<string> seen)
 176    {
 48177        if (seen.Count > MaxRetainedSeenNames)
 0178            return;
 179
 48180        seen.Clear();
 48181        t_seenNames = seen;
 48182    }
 183
 184    private static bool TryGetProperty(JsonElement obj, string name, HashSet<string> seen, out JsonElement value)
 185    {
 48186        var exactFound = false;
 48187        JsonElement exactValue = default;
 48188        var caseInsensitiveFound = false;
 48189        JsonElement caseInsensitiveValue = default;
 190
 200191        foreach (var property in obj.EnumerateObject())
 192        {
 193            // Read ONCE: JsonProperty.Name transcodes a new string on every call, and the three
 194            // reads below used to cost three strings per property of every object walked.
 54195            var propertyName = property.Name;
 52196            if (!seen.Add(propertyName))
 197            {
 198                // Unresolvable, NOT a failure: extraction cannot choose between the duplicates, so
 199                // the id is simply not in this body. Throwing here made an unroutable inbound
 200                // message a handler failure, which the ingress explicitly refuses to do (see
 201                // AsyncResponseIngress: an id that cannot route is acknowledged, never redelivered,
 202                // because RabbitMQ's default MaxDeliveryAttempts = 0 has no cap). Returning false
 203                // lets the caller log-and-ack it instead of hot-looping at broker rate.
 204                //
 205                // The duplicate's NAME is deliberately not surfaced anywhere: it comes straight off
 206                // an untrusted body, and the "never logs a message body" guarantee covers it.
 2207                value = default;
 2208                return false;
 209            }
 210
 50211            if (!exactFound && string.Equals(propertyName, name, StringComparison.Ordinal))
 212            {
 30213                exactFound = true;
 30214                exactValue = property.Value;
 215            }
 20216            else if (!caseInsensitiveFound && string.Equals(propertyName, name, StringComparison.OrdinalIgnoreCase))
 217            {
 2218                caseInsensitiveFound = true;
 2219                caseInsensitiveValue = property.Value;
 220            }
 221        }
 222
 44223        if (exactFound)
 224        {
 28225            value = exactValue;
 28226            return true;
 227        }
 228
 16229        if (caseInsensitiveFound)
 230        {
 2231            value = caseInsensitiveValue;
 2232            return true;
 233        }
 234
 14235        value = default;
 14236        return false;
 2237    }
 238
 239    // A JSON-string-encoded object/array (e.g. a broker envelope carrying its payload as an escaped
 240    // string) is parsed and descended into transparently, same as the pre-shared walker.
 241    private static JsonElement UnwrapJsonString(JsonElement element, ref JsonDocument? scratch)
 242    {
 82243        if (element.ValueKind != JsonValueKind.String)
 62244            return element;
 245
 20246        var text = element.GetString();
 14247        if (text is null)
 0248            return element;
 249
 14250        var trimmed = text.AsSpan().TrimStart();
 14251        if (trimmed.Length == 0 || (trimmed[0] != '{' && trimmed[0] != '['))
 10252            return element;
 253
 254        JsonDocument parsed;
 255        try
 256        {
 4257            parsed = JsonDocument.Parse(text);
 2258        }
 2259        catch (JsonException)
 260        {
 2261            return element;
 262        }
 263
 2264        scratch?.Dispose();
 2265        scratch = parsed;
 2266        return parsed.RootElement;
 2267    }
 268}
Generated by: ReportGenerator 5.5.11.0
09/22/2026 - 09:41:04
GitHub | reportgenerator.io

Methods/Properties

.cctor()
Extract(System.String,System.String[])
GetSplitPaths(System.String[])
TryReadPath(System.Text.Json.JsonElement,System.String[])
TryGetProperty(System.Text.Json.JsonElement,System.String,System.Text.Json.JsonElement&)
RentSeenNames()
ReturnSeenNames(System.Collections.Generic.HashSet`1<System.String>)
TryGetProperty(System.Text.Json.JsonElement,System.String,System.Collections.Generic.HashSet`1<System.String>,System.Text.Json.JsonElement&)
UnwrapJsonString(System.Text.Json.JsonElement,System.Text.Json.JsonDocument&)