Skip to content

Commit

Permalink
Fix context check in trace subscription method
Browse files Browse the repository at this point in the history
  • Loading branch information
@w1am
w1am committed Aug 28, 2024
1 parent c736189 commit 1ff5d29
Show file tree
Hide file tree
Showing 7 changed files with 131 additions and 109 deletions.
22 changes: 7 additions & 15 deletions src/EventStore.Client.Streams/EventStoreClient.Append.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,13 +132,9 @@ await call.RequestStream
foreach (var e in eventData) {
var appendReq = new AppendReq {
ProposedMessage = new() {
Id = e.EventId.ToDto(),
Data = ByteString.CopyFrom(e.Data.Span),
CustomMetadata = ByteString.CopyFrom(
e.ContentType == Constants.Metadata.ContentTypes.ApplicationJson
? e.Metadata.InjectTracingContext(Activity.Current)
: e.Metadata.Span
),
Id = e.EventId.ToDto(),
Data = ByteString.CopyFrom(e.Data.Span),
CustomMetadata = ByteString.CopyFrom(e.Metadata.InjectTracingContext(Activity.Current)),
Metadata = {
{ Constants.Metadata.Type, e.Type },
{ Constants.Metadata.ContentType, e.ContentType }
Expand Down Expand Up @@ -392,13 +388,9 @@ IEnumerable<BatchAppendReq> GetRequests(IEnumerable<EventData> events, BatchAppe

foreach (var eventData in events) {
var proposedMessage = new BatchAppendReq.Types.ProposedMessage {
Data = ByteString.CopyFrom(eventData.Data.Span),
CustomMetadata = ByteString.CopyFrom(
eventData.ContentType == Constants.Metadata.ContentTypes.ApplicationJson
? eventData.Metadata.InjectTracingContext(Activity.Current)
: eventData.Metadata.Span
),
Id = eventData.EventId.ToDto(),
Data = ByteString.CopyFrom(eventData.Data.Span),
CustomMetadata = ByteString.CopyFrom(eventData.Metadata.InjectTracingContext(Activity.Current)),
Id = eventData.EventId.ToDto(),
Metadata = {
{ Constants.Metadata.Type, eventData.Type },
{ Constants.Metadata.ContentType, eventData.ContentType }
Expand Down Expand Up @@ -435,4 +427,4 @@ public void Dispose() {
}
}
}
}
}
21 changes: 11 additions & 10 deletions src/EventStore.Client/Common/Diagnostics/ActivitySourceExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ public static async ValueTask<T> TraceClientOperation<T>(
var res = await tracedOperation().ConfigureAwait(false);
activity?.StatusOk();
return res;
}
catch (Exception ex) {
} catch (Exception ex) {
activity?.StatusError(ex);
throw;
}
Expand All @@ -33,15 +32,12 @@ public static void TraceSubscriptionEvent(
EventStoreClientSettings settings,
UserCredentials? userCredentials
) {
if (resolvedEvent.OriginalEvent.ContentType != Constants.Metadata.ContentTypes.ApplicationJson)
return;

if (source.HasNoActiveListeners())
return;

var parentContext = resolvedEvent.OriginalEvent.Metadata.ExtractPropagationContext();

if (parentContext is null) return;
if (parentContext == default(ActivityContext)) return;

var tags = new ActivityTagsCollection()
.WithRequiredTag(TelemetryTags.EventStore.Stream, resolvedEvent.OriginalEvent.EventStreamId)
Expand All @@ -51,14 +47,19 @@ public static void TraceSubscriptionEvent(
// Ensure consistent server.address attribute when connecting to cluster via dns discovery
.WithGrpcChannelServerTags(channelInfo)
.WithClientSettingsServerTags(settings)
.WithOptionalTag(TelemetryTags.Database.User, userCredentials?.Username ?? settings.DefaultCredentials?.Username);
.WithOptionalTag(
TelemetryTags.Database.User,
userCredentials?.Username ?? settings.DefaultCredentials?.Username
);

StartActivity(source, TracingConstants.Operations.Subscribe, ActivityKind.Consumer, tags, parentContext)?.Dispose();
StartActivity(source, TracingConstants.Operations.Subscribe, ActivityKind.Consumer, tags, parentContext)
?.Dispose();
}

static Activity? StartActivity(
this ActivitySource source,
string operationName, ActivityKind activityKind, ActivityTagsCollection? tags = null, ActivityContext? parentContext = null
string operationName, ActivityKind activityKind, ActivityTagsCollection? tags = null,
ActivityContext? parentContext = null
) {
if (source.HasNoActiveListeners())
return null;
Expand All @@ -79,4 +80,4 @@ public static void TraceSubscriptionEvent(
}

static bool HasNoActiveListeners(this ActivitySource source) => !source.HasListeners();
}
}
5 changes: 2 additions & 3 deletions src/EventStore.Client/Common/Diagnostics/Core/Tracing/TracingMetadata.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ readonly record struct TracingMetadata(
isRemote: isRemote
)
: default;
}
catch (Exception) {
} catch (Exception) {
return default;
}
}
}
}
20 changes: 12 additions & 8 deletions src/EventStore.Client/Common/Diagnostics/EventMetadataExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ namespace EventStore.Client.Diagnostics;

static class EventMetadataExtensions {
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static ReadOnlySpan<byte> InjectTracingContext(this ReadOnlyMemory<byte> eventMetadata, Activity? activity) =>
public static ReadOnlySpan<byte> InjectTracingContext(
this ReadOnlyMemory<byte> eventMetadata, Activity? activity
) =>
eventMetadata.InjectTracingMetadata(activity?.GetTracingMetadata() ?? TracingMetadata.None);

[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand All @@ -32,14 +34,15 @@ public static TracingMetadata ExtractTracingMetadata(this ReadOnlyMemory<byte> e

return new TracingMetadata(traceId.GetString(), spanId.GetString());
}
}
catch (Exception) {
} catch (Exception) {
return TracingMetadata.None;
}
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
static ReadOnlySpan<byte> InjectTracingMetadata(this ReadOnlyMemory<byte> eventMetadata, TracingMetadata tracingMetadata) {
static ReadOnlySpan<byte> InjectTracingMetadata(
this ReadOnlyMemory<byte> eventMetadata, TracingMetadata tracingMetadata
) {
if (tracingMetadata == TracingMetadata.None || !tracingMetadata.IsValid)
return eventMetadata.Span;

Expand All @@ -49,7 +52,9 @@ static ReadOnlySpan<byte> InjectTracingMetadata(this ReadOnlyMemory<byte> eventM
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
static ReadOnlyMemory<byte> TryInjectTracingMetadata(this ReadOnlyMemory<byte> utf8Json, TracingMetadata tracingMetadata) {
static ReadOnlyMemory<byte> TryInjectTracingMetadata(
this ReadOnlyMemory<byte> utf8Json, TracingMetadata tracingMetadata
) {
try {
using var doc = JsonDocument.Parse(utf8Json);
using var stream = new MemoryStream();
Expand All @@ -72,9 +77,8 @@ static ReadOnlyMemory<byte> TryInjectTracingMetadata(this ReadOnlyMemory<byte> u
writer.Flush();

return stream.ToArray();
}
catch (Exception) {
} catch (Exception) {
return utf8Json;
}
}
}
}
124 changes: 62 additions & 62 deletions test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
namespace EventStore.Client.Streams.Tests.Diagnostics;

[Trait("Category", "Diagnostics:Tracing")]
public class StreamsTracingInstrumentationTests(ITestOutputHelper output, DiagnosticsFixture fixture) : EventStoreTests<DiagnosticsFixture>(output, fixture) {
public class StreamsTracingInstrumentationTests(ITestOutputHelper output, DiagnosticsFixture fixture)
: EventStoreTests<DiagnosticsFixture>(output, fixture) {
[Fact]
public async Task AppendIsInstrumentedWithTracingAsExpected() {
var stream = Fixture.GetStreamName();
Expand Down Expand Up @@ -42,66 +43,6 @@ public async Task AppendTraceIsTaggedWithErrorStatusOnException() {
Fixture.AssertErroneousAppendActivityHasExpectedTags(activity, actualException);
}

[Fact]
public async Task CatchupSubscriptionIsInstrumentedWithTracingAndRestoresRemoteAppendContextAsExpected() {
var stream = Fixture.GetStreamName();
var events = Fixture.CreateTestEvents(2, metadata: Fixture.CreateTestJsonMetadata()).ToArray();

await Fixture.Streams.AppendToStreamAsync(
stream,
StreamState.NoStream,
events
);

string? subscriptionId = null;
await Subscribe().WithTimeout();

var appendActivity = Fixture
.GetActivitiesForOperation(TracingConstants.Operations.Append, stream)
.SingleOrDefault()
.ShouldNotBeNull();

var subscribeActivities = Fixture
.GetActivitiesForOperation(TracingConstants.Operations.Subscribe, stream)
.ToArray();

subscriptionId.ShouldNotBeNull();
subscribeActivities.Length.ShouldBe(events.Length);

for (var i = 0; i < subscribeActivities.Length; i++) {
subscribeActivities[i].TraceId.ShouldBe(appendActivity.Context.TraceId);
subscribeActivities[i].ParentSpanId.ShouldBe(appendActivity.Context.SpanId);
subscribeActivities[i].HasRemoteParent.ShouldBeTrue();

Fixture.AssertSubscriptionActivityHasExpectedTags(
subscribeActivities[i],
stream,
events[i].EventId.ToString(),
subscriptionId
);
}

return;

async Task Subscribe() {
await using var subscription = Fixture.Streams.SubscribeToStream(stream, FromStream.Start);
await using var enumerator = subscription.Messages.GetAsyncEnumerator();

var eventsAppeared = 0;
while (await enumerator.MoveNextAsync()) {
if (enumerator.Current is StreamMessage.SubscriptionConfirmation(var sid))
subscriptionId = sid;

if (enumerator.Current is not StreamMessage.Event(_))
continue;

eventsAppeared++;
if (eventsAppeared >= events.Length)
return;
}
}
}

[Fact]
public async Task TracingContextIsInjectedWhenUserMetadataIsValidJsonObject() {
var stream = Fixture.GetStreamName();
Expand Down Expand Up @@ -169,4 +110,63 @@ await Fixture.Streams.AppendToStreamAsync(
var test = JsonSerializer.Deserialize<object>(outputMetadata);
outputMetadata.ShouldBe(inputMetadata);

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (previous-lts) / Streams (ubuntu-latest, net6.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 53, 55, 101, 100, 100, 49, 99, 50, 48, 55, 53, 99, 50, 54, 101, 52, 48, 54, 99, 101, 51, 52, 52, 48, 99, 99, 54, 55, 48, 56, 50, 54, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 54, 57, 56, 97, 56, 102, 53, 52, 97, 56, 99, 100, 100, 53, 49, 97, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *53*, *55*, *101*, *100*, *100*, *49*, *99*, *50*, *48*, *55*, *53*, *99*, *50*, *54*, *101*, *52*, *48*, *54*, *99*, *101*, *51*, *52*, *52*, *48*, *99*, *99*, *54*, *55*, *48*, *56*, *50*, *54*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *54*, *57*, *56*, *97*, *56*, *102*, *53*, *52*, *97*, *56*, *99*, *100*, *100*, *53*, *49*, *97*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (previous-lts) / Streams (ubuntu-latest, net7.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 53, 53, 49, 102, 54, 102, 52, 49, 54, 52, 50, 98, 48, 53, 49, 97, 102, 57, 102, 100, 56, 50, 101, 50, 99, 98, 54, 98, 102, 49, 57, 52, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 100, 49, 98, 57, 97, 97, 97, 102, 100, 101, 50, 54, 51, 53, 54, 57, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *53*, *53*, *49*, *102*, *54*, *102*, *52*, *49*, *54*, *52*, *50*, *98*, *48*, *53*, *49*, *97*, *102*, *57*, *102*, *100*, *56*, *50*, *101*, *50*, *99*, *98*, *54*, *98*, *102*, *49*, *57*, *52*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *100*, *49*, *98*, *57*, *97*, *97*, *97*, *102*, *100*, *101*, *50*, *54*, *51*, *53*, *54*, *57*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (previous-lts) / Streams (ubuntu-latest, net8.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 48, 56, 54, 99, 56, 48, 102, 56, 98, 56, 54, 101, 54, 99, 57, 57, 54, 52, 49, 99, 51, 101, 52, 57, 55, 54, 101, 54, 56, 51, 99, 100, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 56, 98, 101, 98, 100, 51, 102, 55, 101, 53, 101, 50, 49, 48, 51, 56, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *48*, *56*, *54*, *99*, *56*, *48*, *102*, *56*, *98*, *56*, *54*, *101*, *54*, *99*, *57*, *57*, *54*, *52*, *49*, *99*, *51*, *101*, *52*, *57*, *55*, *54*, *101*, *54*, *56*, *51*, *99*, *100*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *56*, *98*, *101*, *98*, *100*, *51*, *102*, *55*, *101*, *53*, *101*, *50*, *49*, *48*, *51*, *56*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (ci) / Streams (ubuntu-latest, net6.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 50, 48, 55, 101, 51, 57, 97, 99, 49, 49, 102, 56, 53, 102, 57, 97, 49, 50, 53, 56, 56, 100, 55, 102, 56, 50, 99, 101, 54, 101, 48, 52, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 100, 98, 49, 100, 100, 55, 98, 55, 101, 48, 98, 99, 100, 102, 99, 55, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *50*, *48*, *55*, *101*, *51*, *57*, *97*, *99*, *49*, *49*, *102*, *56*, *53*, *102*, *57*, *97*, *49*, *50*, *53*, *56*, *56*, *100*, *55*, *102*, *56*, *50*, *99*, *101*, *54*, *101*, *48*, *52*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *100*, *98*, *49*, *100*, *100*, *55*, *98*, *55*, *101*, *48*, *98*, *99*, *100*, *102*, *99*, *55*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (lts) / Streams (ubuntu-latest, net8.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 51, 98, 97, 48, 101, 51, 98, 100, 49, 52, 56, 48, 98, 55, 56, 55, 50, 97, 49, 56, 97, 100, 55, 57, 101, 100, 52, 97, 57, 99, 97, 99, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 49, 99, 98, 50, 54, 99, 97, 99, 50, 54, 53, 99, 100, 54, 53, 51, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *51*, *98*, *97*, *48*, *101*, *51*, *98*, *100*, *49*, *52*, *56*, *48*, *98*, *55*, *56*, *55*, *50*, *97*, *49*, *56*, *97*, *100*, *55*, *57*, *101*, *100*, *52*, *97*, *57*, *99*, *97*, *99*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *49*, *99*, *98*, *50*, *54*, *99*, *97*, *99*, *50*, *54*, *53*, *99*, *100*, *54*, *53*, *51*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (ci) / Streams (ubuntu-latest, net7.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 99, 98, 102, 48, 55, 56, 53, 55, 53, 98, 51, 98, 102, 97, 53, 49, 49, 97, 57, 52, 54, 52, 56, 100, 102, 54, 48, 50, 99, 48, 99, 102, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 97, 97, 49, 56, 100, 99, 100, 99, 53, 55, 54, 56, 100, 55, 57, 54, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *99*, *98*, *102*, *48*, *55*, *56*, *53*, *55*, *53*, *98*, *51*, *98*, *102*, *97*, *53*, *49*, *49*, *97*, *57*, *52*, *54*, *52*, *56*, *100*, *102*, *54*, *48*, *50*, *99*, *48*, *99*, *102*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *97*, *97*, *49*, *56*, *100*, *99*, *100*, *99*, *53*, *55*, *54*, *56*, *100*, *55*, *57*, *54*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (ci) / Streams (ubuntu-latest, net8.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 51, 51, 53, 101, 100, 50, 54, 50, 102, 50, 51, 99, 49, 54, 55, 99, 102, 56, 99, 100, 97, 98, 101, 100, 100, 49, 55, 98, 50, 57, 48, 56, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 101, 53, 99, 100, 54, 55, 97, 101, 54, 57, 50, 48, 54, 48, 51, 55, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *51*, *51*, *53*, *101*, *100*, *50*, *54*, *50*, *102*, *50*, *51*, *99*, *49*, *54*, *55*, *99*, *102*, *56*, *99*, *100*, *97*, *98*, *101*, *100*, *100*, *49*, *55*, *98*, *50*, *57*, *48*, *56*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *101*, *53*, *99*, *100*, *54*, *55*, *97*, *101*, *54*, *57*, *50*, *48*, *54*, *48*, *51*, *55*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (lts) / Streams (ubuntu-latest, net7.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 99, 97, 54, 99, 56, 102, 97, 57, 54, 54, 100, 51, 55, 98, 49, 55, 51, 100, 53, 53, 51, 53, 56, 48, 53, 55, 51, 52, 102, 97, 98, 101, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 53, 51, 51, 54, 54, 57, 101, 100, 102, 100, 57, 48, 51, 54, 50, 56, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *99*, *97*, *54*, *99*, *56*, *102*, *97*, *57*, *54*, *54*, *100*, *51*, *55*, *98*, *49*, *55*, *51*, *100*, *53*, *53*, *51*, *53*, *56*, *48*, *53*, *55*, *51*, *52*, *102*, *97*, *98*, *101*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *53*, *51*, *51*, *54*, *54*, *57*, *101*, *100*, *102*, *100*, *57*, *48*, *51*, *54*, *50*, *56*, *34*, *125*]

Check failure on line 111 in test/EventStore.Client.Streams.Tests/Diagnostics/StreamsTracingInstrumentationTests.cs

View workflow job for this annotation

GitHub Actions / Test CE (lts) / Streams (ubuntu-latest, net6.0)

EventStore.Client.Streams.Tests.Diagnostics.StreamsTracingInstrumentationTests.TracingContextIsNotInjectedWhenEventIsNotJsonButHasJsonMetadata 

Shouldly.ShouldAssertException : outputMetadata
    should be
[123, 34, 70, 111, 111, 34, 58, 32, 34, 66, 97, 114, 34, 125]
    but was
[123, 34, 70, 111, 111, 34, 58, 34, 66, 97, 114, 34, 44, 34, 36, 116, 114, 97, 99, 101, 73, 100, 34, 58, 34, 98, 48, 55, 102, 55, 56, 54, 48, 57, 102, 53, 48, 51, 49, 97, 49, 53, 102, 100, 54, 54, 97, 97, 53, 102, 53, 98, 99, 54, 102, 98, 50, 34, 44, 34, 36, 115, 112, 97, 110, 73, 100, 34, 58, 34, 57, 50, 56, 102, 53, 54, 53, 98, 55, 100, 57, 54, 53, 98, 101, 100, 34, 125]
    difference
[123, 34, 70, 111, 111, 34, 58, *34*, *66*, *97*, *114*, *34*, *44*, *34*, *36*, *116*, *114*, *97*, *99*, *101*, *73*, *100*, *34*, *58*, *34*, *98*, *48*, *55*, *102*, *55*, *56*, *54*, *48*, *57*, *102*, *53*, *48*, *51*, *49*, *97*, *49*, *53*, *102*, *100*, *54*, *54*, *97*, *97*, *53*, *102*, *53*, *98*, *99*, *54*, *102*, *98*, *50*, *34*, *44*, *34*, *36*, *115*, *112*, *97*, *110*, *73*, *100*, *34*, *58*, *34*, *57*, *50*, *56*, *102*, *53*, *54*, *53*, *98*, *55*, *100*, *57*, *54*, *53*, *98*, *101*, *100*, *34*, *125*]
}
}

[Fact]
public async Task json_metadata_event_is_traced_and_non_json_metadata_event_is_not_traced() {
var streamName = Fixture.GetStreamName();

var seedEvents = new[] {
Fixture.CreateTestEvent(metadata: Fixture.CreateTestJsonMetadata()),
Fixture.CreateTestEvent(metadata: Fixture.CreateTestNonJsonMetadata())
};

var availableEvents = new HashSet<Uuid>(seedEvents.Select(x => x.EventId));

await Fixture.Streams.AppendToStreamAsync(streamName, StreamState.NoStream, seedEvents);

await using var subscription = Fixture.Streams.SubscribeToStream(streamName, FromStream.Start);
await using var enumerator = subscription.Messages.GetAsyncEnumerator();

var appendActivities = Fixture
.GetActivitiesForOperation(TracingConstants.Operations.Append, streamName)
.ShouldNotBeNull();

Assert.True(await enumerator.MoveNextAsync());

Assert.IsType<StreamMessage.SubscriptionConfirmation>(enumerator.Current);

await Subscribe(enumerator).WithTimeout();

var subscribeActivities = Fixture
.GetActivitiesForOperation(TracingConstants.Operations.Subscribe, streamName)
.ToArray();

appendActivities.ShouldHaveSingleItem();

subscribeActivities.ShouldHaveSingleItem();

subscribeActivities.First().ParentId.ShouldBe(appendActivities.First().Id);

var jsonMetadataEvent = seedEvents.First();

Fixture.AssertSubscriptionActivityHasExpectedTags(
subscribeActivities.First(),
streamName,
jsonMetadataEvent.EventId.ToString()
);

return;

async Task Subscribe(IAsyncEnumerator<StreamMessage> internalEnumerator) {
while (await internalEnumerator.MoveNextAsync()) {
if (internalEnumerator.Current is not StreamMessage.Event(var resolvedEvent))
continue;

availableEvents.Remove(resolvedEvent.Event.EventId);

if (availableEvents.Count == 0)
return;
}
}
}
}
28 changes: 21 additions & 7 deletions test/EventStore.Client.Tests.Common/Fixtures/DiagnosticsFixture.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class DiagnosticsFixture : EventStoreFixture {
public DiagnosticsFixture() {
var diagnosticActivityListener = new ActivityListener {
ShouldListenTo = source => source.Name == EventStoreClientDiagnostics.InstrumentationName,
Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllDataAndRecorded,
Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllDataAndRecorded,
ActivityStopped = activity => {
var operation = (string?)activity.GetTagItem(TelemetryTags.Database.Operation);
var stream = (string?)activity.GetTagItem(TelemetryTags.EventStore.Stream);
Expand Down Expand Up @@ -71,23 +71,37 @@ public void AssertErroneousAppendActivityHasExpectedTags(Activity activity, Exce
var actualEvent = activity.Events.ShouldHaveSingleItem();

actualEvent.Name.ShouldBe(TelemetryTags.Exception.EventName);
actualEvent.Tags.ShouldContain(new KeyValuePair<string, object?>(TelemetryTags.Exception.Type, actualException.GetType().FullName));
actualEvent.Tags.ShouldContain(new KeyValuePair<string, object?>(TelemetryTags.Exception.Message, actualException.Message));
actualEvent.Tags.ShouldContain(
new KeyValuePair<string, object?>(TelemetryTags.Exception.Type, actualException.GetType().FullName)
);

actualEvent.Tags.ShouldContain(
new KeyValuePair<string, object?>(TelemetryTags.Exception.Message, actualException.Message)
);

actualEvent.Tags.Any(x => x.Key == TelemetryTags.Exception.Stacktrace).ShouldBeTrue();
}

public void AssertSubscriptionActivityHasExpectedTags(Activity activity, string stream, string eventId, string? subscriptionId) {
public void AssertSubscriptionActivityHasExpectedTags(
Activity activity,
string stream,
string eventId,
string? subscriptionId = null
) {
var expectedTags = new Dictionary<string, string?> {
{ TelemetryTags.Database.System, EventStoreClientDiagnostics.InstrumentationName },
{ TelemetryTags.Database.Operation, TracingConstants.Operations.Subscribe },
{ TelemetryTags.EventStore.Stream, stream },
{ TelemetryTags.EventStore.EventId, eventId },
{ TelemetryTags.EventStore.EventType, TestEventType },
{ TelemetryTags.EventStore.SubscriptionId, subscriptionId },
{ TelemetryTags.Database.User, TestCredentials.Root.Username }
};

foreach (var tag in expectedTags)
if (subscriptionId != null)
expectedTags[TelemetryTags.EventStore.SubscriptionId] = subscriptionId;

foreach (var tag in expectedTags) {
activity.Tags.ShouldContain(tag);
}
}
}
}
Loading

0 comments on commit 1ff5d29

Please sign in to comment.