Skip to content

[Diagnostics] Emit GraphQL spans for the persisted operation endpoint #10382

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

Merged
tobias-tengler merged 1 commit into from
Sep 11, 2026
Merged

[Diagnostics] Emit GraphQL spans for the persisted operation endpoint #10382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
199 changes: 103 additions & 96 deletions src/HotChocolate/AspNetCore/src/AspNetCore.Pipeline/PersistedOperationMiddleware.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
using System.Diagnostics.CodeAnalysis;
#endif
using System.Net;
using HotChocolate.AspNetCore.Instrumentation;
using HotChocolate.AspNetCore.Utilities;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
Expand Down Expand Up @@ -145,64 +146,67 @@ private static async Task ExecuteGetRequestAsync(
var ct = context.RequestAborted;
var executorSession = await executorProxy.GetOrCreateSessionAsync(ct);

// first, we validate the accept-headers.
var validationResult = MiddlewareHelper.ValidateAcceptContentType(context, executorSession);
var acceptMediaTypes = validationResult.AcceptMediaTypes;

if (!validationResult.IsValid)
using (executorSession.DiagnosticEvents.ExecuteHttpRequest(context, HttpRequestKind.HttpGet))
{
statusCode = validationResult.StatusCode.Value;
result = validationResult.Error;
goto HANDLE_RESULT;
}
// first, we validate the accept-headers.
var validationResult = MiddlewareHelper.ValidateAcceptContentType(context, executorSession);
var acceptMediaTypes = validationResult.AcceptMediaTypes;

// validate if the operation name is required.
if (requireOperationName && string.IsNullOrWhiteSpace(operationName))
{
statusCode = HttpStatusCode.BadRequest;
result = ErrorHelper.OperationNameRequired();
goto HANDLE_RESULT;
}
if (!validationResult.IsValid)
{
statusCode = validationResult.StatusCode.Value;
result = validationResult.Error;
goto HANDLE_RESULT;
}

// next, we parse the GraphQL request.
var parserResult =
MiddlewareHelper.ParseVariablesAndExtensionsFromParams(
operationId,
operationName,
context,
executorSession);
// validate if the operation name is required.
if (requireOperationName && string.IsNullOrWhiteSpace(operationName))
{
statusCode = HttpStatusCode.BadRequest;
result = ErrorHelper.OperationNameRequired();
goto HANDLE_RESULT;
}

// next, we parse the GraphQL request.
var parserResult =
MiddlewareHelper.ParseVariablesAndExtensionsFromParams(
operationId,
operationName,
context,
executorSession);

if (!parserResult.IsValid)
{
statusCode = parserResult.StatusCode.Value;
result = parserResult.Error;
goto HANDLE_RESULT;
}
if (!parserResult.IsValid)
{
statusCode = parserResult.StatusCode.Value;
result = parserResult.Error;
goto HANDLE_RESULT;
}

// before we can execute the request, we need to determine the request flags.
var request = parserResult.Request!;
var requestFlags =
MiddlewareHelper.DetermineHttpGetRequestFlags(
validationResult.RequestFlags,
options);

// next, we will execute the request.
var executionResult =
await MiddlewareHelper.ExecuteRequestAsync(
request,
requestFlags,
context,
executorSession);
statusCode = executionResult.StatusCode;
result = executionResult.Result;

// before we can execute the request, we need to determine the request flags.
var request = parserResult.Request!;
var requestFlags =
MiddlewareHelper.DetermineHttpGetRequestFlags(
validationResult.RequestFlags,
options);

// next, we will execute the request.
var executionResult =
await MiddlewareHelper.ExecuteRequestAsync(
request,
requestFlags,
HANDLE_RESULT:
await MiddlewareHelper.WriteResultAsync(
result!,
acceptMediaTypes,
statusCode,
context,
executorSession);
statusCode = executionResult.StatusCode;
result = executionResult.Result;

HANDLE_RESULT:
await MiddlewareHelper.WriteResultAsync(
result!,
acceptMediaTypes,
statusCode,
context,
executorSession);
}
}

private static async Task ExecutePostRequestAsync(
Expand All @@ -217,57 +221,60 @@ private static async Task ExecutePostRequestAsync(
var ct = context.RequestAborted;
var executorSession = await executorProxy.GetOrCreateSessionAsync(ct);

// first, we validate the accept-headers.
var validationResult = MiddlewareHelper.ValidateAcceptContentType(context, executorSession);

var acceptMediaTypes = validationResult.AcceptMediaTypes;

if (!validationResult.IsValid)
using (executorSession.DiagnosticEvents.ExecuteHttpRequest(context, HttpRequestKind.HttpPost))
{
statusCode = validationResult.StatusCode.Value;
result = validationResult.Error;
goto HANDLE_RESULT;
}
// first, we validate the accept-headers.
var validationResult = MiddlewareHelper.ValidateAcceptContentType(context, executorSession);

// validate if the operation name is required.
if (requireOperationName && string.IsNullOrWhiteSpace(operationName))
{
statusCode = HttpStatusCode.BadRequest;
result = ErrorHelper.OperationNameRequired();
goto HANDLE_RESULT;
}
var acceptMediaTypes = validationResult.AcceptMediaTypes;

// next, we parse the GraphQL request.
var parserResult =
await MiddlewareHelper.ParseSingleRequestFromBodyAsync(
operationId,
operationName,
context,
executorSession);
if (!validationResult.IsValid)
{
statusCode = validationResult.StatusCode.Value;
result = validationResult.Error;
goto HANDLE_RESULT;
}

if (!parserResult.IsValid)
{
statusCode = parserResult.StatusCode.Value;
result = parserResult.Error;
goto HANDLE_RESULT;
}
// validate if the operation name is required.
if (requireOperationName && string.IsNullOrWhiteSpace(operationName))
{
statusCode = HttpStatusCode.BadRequest;
result = ErrorHelper.OperationNameRequired();
goto HANDLE_RESULT;
}

// next, we parse the GraphQL request.
var parserResult =
await MiddlewareHelper.ParseSingleRequestFromBodyAsync(
operationId,
operationName,
context,
executorSession);

// after successfully parsing the request, we now will attempt to execute the request.
var executionResult =
await MiddlewareHelper.ExecuteRequestAsync(
parserResult.Request!,
validationResult.RequestFlags,
context,
executorSession);
statusCode = executionResult.StatusCode;
result = executionResult.Result;
if (!parserResult.IsValid)
{
statusCode = parserResult.StatusCode.Value;
result = parserResult.Error;
goto HANDLE_RESULT;
}

// after successfully parsing the request, we now will attempt to execute the request.
var executionResult =
await MiddlewareHelper.ExecuteRequestAsync(
parserResult.Request!,
validationResult.RequestFlags,
context,
executorSession);
statusCode = executionResult.StatusCode;
result = executionResult.Result;

HANDLE_RESULT:
await MiddlewareHelper.WriteResultAsync(
result!,
acceptMediaTypes,
statusCode,
context,
executorSession);
await MiddlewareHelper.WriteResultAsync(
result!,
acceptMediaTypes,
statusCode,
context,
executorSession);
}
}
}
48 changes: 48 additions & 0 deletions src/HotChocolate/Diagnostics/test/Diagnostics.Tests/ActivityServerDiagnosticListenerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using Microsoft.AspNetCore.TestHost;
using Microsoft.Extensions.DependencyInjection;
Expand Down Expand Up @@ -96,6 +98,52 @@ public async Task Http_Get_SingleRequest_GetHeroName()
}
}

[Fact]
public async Task Http_Post_PersistedOperationEndpoint_GetHeroName_Default()
{
using (CaptureActivities(out var activities))
{
// arrange
using var server = CreateInstrumentedServer();
using var client = server.CreateClient();
client.BaseAddress = new Uri("http://localhost:5000");

// act
using var content = new StringContent("{ }", Encoding.UTF8, "application/json");
using var response = await client.PostAsync(
"/graphql/persisted/a73defcdf38e5891e91b9ba532cf4c36/GetHeroName",
content,
TestContext.Current.CancellationToken);
await response.Content.ReadAsStringAsync(TestContext.Current.CancellationToken);

// assert
activities.MatchSnapshot(Postfix([NET11_0]));
}
}

[Fact]
public async Task Http_Get_PersistedOperationEndpoint_GetHeroName_Default()
{
using (CaptureActivities(out var activities))
{
// arrange
using var server = CreateInstrumentedServer();
using var client = server.CreateClient();
client.BaseAddress = new Uri("http://localhost:5000");
client.DefaultRequestHeaders.Accept.Add(
new MediaTypeWithQualityHeaderValue("application/graphql-response+json"));

// act
using var response = await client.GetAsync(
"/graphql/persisted/a73defcdf38e5891e91b9ba532cf4c36/GetHeroName",
TestContext.Current.CancellationToken);
await response.Content.ReadAsStringAsync(TestContext.Current.CancellationToken);

// assert
activities.MatchSnapshot(Postfix([NET11_0]));
}
}

[Fact]
public async Task Http_Post_Variables_Are_Not_Automatically_Added_To_Activities()
{
Expand Down
Loading
Loading