|
| 1 | +// <copyright file="ContextPropagationTests.cs" company="Datadog"> |
| 2 | +// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License. |
| 3 | +// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc. |
| 4 | +// </copyright> |
| 5 | + |
| 6 | +#nullable enable |
| 7 | + |
| 8 | +using System.Collections; |
| 9 | +using System.Collections.Generic; |
| 10 | +using Amazon.EventBridge.Model; |
| 11 | +using Datadog.Trace.ClrProfiler.AutoInstrumentation.AWS.EventBridge; |
| 12 | +using Datadog.Trace.DuckTyping; |
| 13 | +using Datadog.Trace.Vendors.Newtonsoft.Json; |
| 14 | +using FluentAssertions; |
| 15 | +using Xunit; |
| 16 | + |
| 17 | +namespace Datadog.Trace.ClrProfiler.Managed.Tests.AutoInstrumentation.AWS.EventBridge; |
| 18 | + |
| 19 | +public class ContextPropagationTests |
| 20 | +{ |
| 21 | + private const string DatadogKey = "_datadog"; |
| 22 | + private const string StartTimeKey = "x-datadog-start-time"; |
| 23 | + private const string ResourceNameKey = "x-datadog-resource-name"; |
| 24 | + private const string EventBusName = "test-event-bus"; |
| 25 | + |
| 26 | + private readonly SpanContext _spanContext; |
| 27 | + |
| 28 | + public ContextPropagationTests() |
| 29 | + { |
| 30 | + const long upper = 1234567890123456789; |
| 31 | + const ulong lower = 9876543210987654321; |
| 32 | + |
| 33 | + var traceId = new TraceId(upper, lower); |
| 34 | + const ulong spanId = 6766950223540265769; |
| 35 | + _spanContext = new SpanContext(traceId, spanId, 1, "test-eventbridge", "serverless"); |
| 36 | + } |
| 37 | + |
| 38 | + [Fact] |
| 39 | + public void InjectTracingContext_EmptyDetail_AddsTraceContext() |
| 40 | + { |
| 41 | + var request = GeneratePutEventsRequest([ |
| 42 | + new PutEventsRequestEntry { Detail = "{}", EventBusName = EventBusName } |
| 43 | + ]); |
| 44 | + |
| 45 | + var proxy = request.DuckCast<IPutEventsRequest>(); |
| 46 | + |
| 47 | + ContextPropagation.InjectTracingContext(proxy, _spanContext); |
| 48 | + |
| 49 | + var entries = (IList)proxy.Entries.Value!; |
| 50 | + entries.Count.Should().Be(1); |
| 51 | + var entry = (PutEventsRequestEntry)entries[0]!; |
| 52 | + |
| 53 | + var detail = JsonConvert.DeserializeObject<Dictionary<string, object>>(entry.Detail); |
| 54 | + detail.Should().NotBeNull(); |
| 55 | + detail!.Count.Should().Be(1); |
| 56 | + |
| 57 | + var extracted = detail.TryGetValue(DatadogKey, out var datadogObject); |
| 58 | + extracted.Should().BeTrue(); |
| 59 | + datadogObject.Should().NotBeNull(); |
| 60 | + |
| 61 | + var jsonString = JsonConvert.SerializeObject(datadogObject); |
| 62 | + var extractedTraceContext = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString); |
| 63 | + |
| 64 | + extractedTraceContext!["x-datadog-parent-id"].Should().Be(_spanContext.SpanId.ToString()); |
| 65 | + extractedTraceContext["x-datadog-trace-id"].Should().Be(_spanContext.TraceId.ToString()); |
| 66 | + extractedTraceContext[ResourceNameKey].Should().Be(EventBusName); |
| 67 | + extractedTraceContext.Should().ContainKey(StartTimeKey); |
| 68 | + extractedTraceContext[StartTimeKey].Should().NotBeNullOrEmpty(); |
| 69 | + } |
| 70 | + |
| 71 | + [Fact] |
| 72 | + public void InjectTracingContext_ExistingDetail_AddsTraceContext() |
| 73 | + { |
| 74 | + var request = GeneratePutEventsRequest([ |
| 75 | + new PutEventsRequestEntry { Detail = "{\"foo\":\"bar\"}", EventBusName = EventBusName } |
| 76 | + ]); |
| 77 | + |
| 78 | + var proxy = request.DuckCast<IPutEventsRequest>(); |
| 79 | + |
| 80 | + ContextPropagation.InjectTracingContext(proxy, _spanContext); |
| 81 | + |
| 82 | + var entries = (IList)proxy.Entries.Value!; |
| 83 | + entries.Count.Should().Be(1); |
| 84 | + var entry = (PutEventsRequestEntry)entries[0]!; |
| 85 | + |
| 86 | + var detail = JsonConvert.DeserializeObject<Dictionary<string, object>>(entry.Detail); |
| 87 | + detail.Should().NotBeNull(); |
| 88 | + detail!.Count.Should().Be(2); |
| 89 | + detail["foo"].Should().Be("bar"); |
| 90 | + |
| 91 | + var extracted = detail.TryGetValue(DatadogKey, out var datadogObject); |
| 92 | + extracted.Should().BeTrue(); |
| 93 | + datadogObject.Should().NotBeNull(); |
| 94 | + |
| 95 | + var jsonString = JsonConvert.SerializeObject(datadogObject); |
| 96 | + var extractedTraceContext = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString); |
| 97 | + |
| 98 | + extractedTraceContext!["x-datadog-parent-id"].Should().Be(_spanContext.SpanId.ToString()); |
| 99 | + extractedTraceContext["x-datadog-trace-id"].Should().Be(_spanContext.TraceId.ToString()); |
| 100 | + extractedTraceContext[ResourceNameKey].Should().Be(EventBusName); |
| 101 | + extractedTraceContext.Should().ContainKey(StartTimeKey); |
| 102 | + extractedTraceContext[StartTimeKey].Should().NotBeNullOrEmpty(); |
| 103 | + } |
| 104 | + |
| 105 | + [Fact] |
| 106 | + public void InjectTracingContext_NullDetail_AddsTraceContext() |
| 107 | + { |
| 108 | + var request = GeneratePutEventsRequest([ |
| 109 | + new PutEventsRequestEntry { Detail = null, EventBusName = EventBusName } |
| 110 | + ]); |
| 111 | + |
| 112 | + var proxy = request.DuckCast<IPutEventsRequest>(); |
| 113 | + |
| 114 | + ContextPropagation.InjectTracingContext(proxy, _spanContext); |
| 115 | + |
| 116 | + var entries = (IList)proxy.Entries.Value!; |
| 117 | + entries.Count.Should().Be(1); |
| 118 | + var entry = (PutEventsRequestEntry)entries[0]!; |
| 119 | + |
| 120 | + var detail = JsonConvert.DeserializeObject<Dictionary<string, object>>(entry.Detail); |
| 121 | + detail.Should().NotBeNull(); |
| 122 | + detail!.Count.Should().Be(1); |
| 123 | + |
| 124 | + var extracted = detail.TryGetValue(DatadogKey, out var datadogObject); |
| 125 | + extracted.Should().BeTrue(); |
| 126 | + datadogObject.Should().NotBeNull(); |
| 127 | + |
| 128 | + var jsonString = JsonConvert.SerializeObject(datadogObject); |
| 129 | + var extractedTraceContext = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString); |
| 130 | + |
| 131 | + extractedTraceContext!["x-datadog-parent-id"].Should().Be(_spanContext.SpanId.ToString()); |
| 132 | + extractedTraceContext["x-datadog-trace-id"].Should().Be(_spanContext.TraceId.ToString()); |
| 133 | + extractedTraceContext[ResourceNameKey].Should().Be(EventBusName); |
| 134 | + extractedTraceContext.Should().ContainKey(StartTimeKey); |
| 135 | + extractedTraceContext[StartTimeKey].Should().NotBeNullOrEmpty(); |
| 136 | + } |
| 137 | + |
| 138 | + [Fact] |
| 139 | + public void InjectTracingContext_InvalidDetail_DoesNotAddTraceContext() |
| 140 | + { |
| 141 | + var request = GeneratePutEventsRequest([ |
| 142 | + new PutEventsRequestEntry { Detail = "{invalid json", EventBusName = EventBusName } |
| 143 | + ]); |
| 144 | + |
| 145 | + var proxy = request.DuckCast<IPutEventsRequest>(); |
| 146 | + |
| 147 | + ContextPropagation.InjectTracingContext(proxy, _spanContext); |
| 148 | + |
| 149 | + var entries = (IList)proxy.Entries.Value!; |
| 150 | + entries.Count.Should().Be(1); |
| 151 | + var entry = (PutEventsRequestEntry)entries[0]!; |
| 152 | + |
| 153 | + entry.Detail.Should().Be("{invalid json"); |
| 154 | + } |
| 155 | + |
| 156 | + [Fact] |
| 157 | + public void InjectTracingContext_MultipleEntries_AddsTraceContextToAll() |
| 158 | + { |
| 159 | + var request = GeneratePutEventsRequest([ |
| 160 | + new PutEventsRequestEntry { Detail = "{}", EventBusName = EventBusName }, |
| 161 | + new PutEventsRequestEntry { Detail = "{\"foo\":\"bar\"}", EventBusName = EventBusName } |
| 162 | + ]); |
| 163 | + |
| 164 | + var proxy = request.DuckCast<IPutEventsRequest>(); |
| 165 | + |
| 166 | + ContextPropagation.InjectTracingContext(proxy, _spanContext); |
| 167 | + |
| 168 | + var entries = (IList)proxy.Entries.Value!; |
| 169 | + entries.Count.Should().Be(2); |
| 170 | + |
| 171 | + foreach (var entry in entries) |
| 172 | + { |
| 173 | + var typedEntry = entry as PutEventsRequestEntry; |
| 174 | + var detail = JsonConvert.DeserializeObject<Dictionary<string, object>>(typedEntry!.Detail); |
| 175 | + detail.Should().NotBeNull(); |
| 176 | + detail!.Should().ContainKey(DatadogKey); |
| 177 | + |
| 178 | + var extracted = detail!.TryGetValue(DatadogKey, out var datadogObject); |
| 179 | + extracted.Should().BeTrue(); |
| 180 | + datadogObject.Should().NotBeNull(); |
| 181 | + |
| 182 | + var jsonString = JsonConvert.SerializeObject(datadogObject); |
| 183 | + var extractedTraceContext = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString); |
| 184 | + |
| 185 | + extractedTraceContext!["x-datadog-parent-id"].Should().Be(_spanContext.SpanId.ToString()); |
| 186 | + extractedTraceContext["x-datadog-trace-id"].Should().Be(_spanContext.TraceId.ToString()); |
| 187 | + extractedTraceContext[ResourceNameKey].Should().Be(EventBusName); |
| 188 | + extractedTraceContext.Should().ContainKey(StartTimeKey); |
| 189 | + extractedTraceContext[StartTimeKey].Should().NotBeNullOrEmpty(); |
| 190 | + } |
| 191 | + } |
| 192 | + |
| 193 | + [Fact] |
| 194 | + public void InjectTracingContext_NullEventBusName_OmitsResourceName() |
| 195 | + { |
| 196 | + var request = GeneratePutEventsRequest([ |
| 197 | + new PutEventsRequestEntry { Detail = "{}", EventBusName = null } |
| 198 | + ]); |
| 199 | + |
| 200 | + var proxy = request.DuckCast<IPutEventsRequest>(); |
| 201 | + |
| 202 | + ContextPropagation.InjectTracingContext(proxy, _spanContext); |
| 203 | + |
| 204 | + var entries = (IList)proxy.Entries.Value!; |
| 205 | + entries.Count.Should().Be(1); |
| 206 | + var entry = (PutEventsRequestEntry)entries[0]!; |
| 207 | + |
| 208 | + var detail = JsonConvert.DeserializeObject<Dictionary<string, object>>(entry.Detail); |
| 209 | + detail.Should().NotBeNull(); |
| 210 | + detail!.Count.Should().Be(1); |
| 211 | + |
| 212 | + var extracted = detail.TryGetValue(DatadogKey, out var datadogObject); |
| 213 | + extracted.Should().BeTrue(); |
| 214 | + datadogObject.Should().NotBeNull(); |
| 215 | + |
| 216 | + var jsonString = JsonConvert.SerializeObject(datadogObject); |
| 217 | + var extractedTraceContext = JsonConvert.DeserializeObject<Dictionary<string, string>>(jsonString); |
| 218 | + |
| 219 | + extractedTraceContext!["x-datadog-parent-id"].Should().Be(_spanContext.SpanId.ToString()); |
| 220 | + extractedTraceContext["x-datadog-trace-id"].Should().Be(_spanContext.TraceId.ToString()); |
| 221 | + extractedTraceContext.Should().NotContainKey(ResourceNameKey); |
| 222 | + extractedTraceContext.Should().ContainKey(StartTimeKey); |
| 223 | + extractedTraceContext[StartTimeKey].Should().NotBeNullOrEmpty(); |
| 224 | + } |
| 225 | + |
| 226 | + private static PutEventsRequest GeneratePutEventsRequest(List<PutEventsRequestEntry> entries) |
| 227 | + { |
| 228 | + return new PutEventsRequest { Entries = entries }; |
| 229 | + } |
| 230 | +} |
0 commit comments