Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Remove invalid trailing comma added to W3C tracestate header. #1779

Merged
merged 2 commits into from
Jul 14, 2023
Merged

fix: Remove invalid trailing comma added to W3C tracestate header. #1779

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
069ba35
fix: Remove invalid trailing comma added to W3C tracestate header.
jaffinito Jul 14, 2023
fc271a2
Check transaction.TracingState.VendorStateEntries for any values.
jaffinito Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions src/Agent/NewRelic/Agent/Core/DistributedTracing/DistributedTracePayloadHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,15 @@ private string BuildTracestate(IInternalTransaction transaction, DateTime timest
var newRelicTracestate = $"{accountKey}@nr={version}-{parentType}-{parentAccountId}-{appId}-{spanId}-{transactionId}-{sampled}-{priority}-{timestampInMillis}";
var otherVendorTracestates = string.Empty;

if (transaction.TracingState != null)
if (transaction.TracingState?.VendorStateEntries != null)
tippmar-nr marked this conversation as resolved.
Show resolved Hide resolved
{
if (transaction.TracingState.VendorStateEntries != null)
{
otherVendorTracestates = string.Join(",", transaction.TracingState.VendorStateEntries);
}
otherVendorTracestates = string.Join(",", transaction.TracingState.VendorStateEntries);
}

// If otherVendorTracestates is null/empty we get a trailing comma.
if (string.IsNullOrWhiteSpace(otherVendorTracestates))
{
return newRelicTracestate;
}

return string.Join(",", newRelicTracestate, otherVendorTracestates);
Expand Down
49 changes: 49 additions & 0 deletions ...nitTest/Wrapper/AgentWrapperApi/DistributedTracing/DistributedTracePayloadHandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1031,6 +1031,55 @@ public void TraceIdShouldBeSameForAllSpansWhenNoTraceIdReceived()

#endregion TraceID Tests

[TestCase(true)]
[TestCase(true, "")]
[TestCase(true, "k1=v1", "k2=v2")]
[TestCase(false)]
[TestCase(false, "")]
[TestCase(false, "k1=v1", "k2=v2")]
public void W3C_BuildTracestate_EmptyVendors_NoCommas(bool hasIncomingPayload, params string[] vendorState)
{
// Arrange
Mock.Arrange(() => _configuration.SpanEventsEnabled).Returns(true);
Mock.Arrange(() => _configuration.PayloadSuccessMetricsEnabled).Returns(true);

var transaction = BuildMockTransaction(hasIncomingPayload: hasIncomingPayload, sampled: true);

var transactionGuid = GuidGenerator.GenerateNewRelicGuid();
Mock.Arrange(() => transaction.Guid).Returns(transactionGuid);

var expectedSpanGuid = GuidGenerator.GenerateNewRelicGuid();
var segment = Mock.Create<ISegment>();
Mock.Arrange(() => segment.SpanId).Returns(expectedSpanGuid);

Mock.Arrange(() => transaction.CurrentSegment).Returns(segment);

var headers = new List<KeyValuePair<string, string>>();
var setHeaders = new Action<List<KeyValuePair<string, string>>, string, string>((carrier, key, value) =>
{
carrier.Add(new KeyValuePair<string, string>(key, value));
});

var tracingState = Mock.Create<ITracingState>();

var vendorStateEntries = vendorState.ToList();

Mock.Arrange(() => tracingState.VendorStateEntries).Returns(vendorStateEntries);
Mock.Arrange(() => transaction.TracingState).Returns(tracingState);

Mock.Arrange(() => transaction.InsertDistributedTraceHeaders(
Arg.IsAny<List<KeyValuePair<string, string>>>(),
Arg.IsAny<Action<List<KeyValuePair<string, string>>, string, string>>()))
.DoInstead(() => _distributedTracePayloadHandler.InsertDistributedTraceHeaders(transaction, headers, setHeaders));

// Act
transaction.InsertDistributedTraceHeaders(headers, setHeaders);

var tracestateHeaderValue = headers.Where(header => header.Key == TracestateHeaderName).Select(header => header.Value).FirstOrDefault();

Assert.That(!tracestateHeaderValue.EndsWith(","), "W3C Tracestate string has a trailing comma.");
}

#endregion

#region Supportability Metrics
Expand Down
Loading