Open Telemetry Support

.build/Helpers.cs

@@ -16,6 +16,7 @@ class Helpers
         Path.Combine("HotChocolate", "AzureFunctions"),
         Path.Combine("HotChocolate", "Core"),
         Path.Combine("HotChocolate", "CodeGeneration"),
+        Path.Combine("HotChocolate", "Diagnostics"),
         Path.Combine("HotChocolate", "Language"),
         Path.Combine("HotChocolate", "PersistedQueries"),
         Path.Combine("HotChocolate", "Utilities"),

src/HotChocolate/AspNetCore/src/AspNetCore/DefaultSocketSessionInterceptor.cs

@@ -1,10 +1,7 @@
 using System.Security.Claims;
-using System.Threading;
-using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
 using HotChocolate.AspNetCore.Subscriptions;
 using HotChocolate.AspNetCore.Subscriptions.Messages;
-using HotChocolate.Execution;
-using Microsoft.AspNetCore.Http;
 
 namespace HotChocolate.AspNetCore;
 

src/HotChocolate/AspNetCore/src/AspNetCore/DelegateHttpRequestInterceptor.cs

@@ -1,7 +1,3 @@
-using System;
-using System.Threading;
-using System.Threading.Tasks;
-using HotChocolate.Execution;
 using Microsoft.AspNetCore.Http;
 
 namespace HotChocolate.AspNetCore;

src/HotChocolate/AspNetCore/src/AspNetCore/ErrorHelper.cs

@@ -7,19 +7,19 @@ namespace HotChocolate.AspNetCore;
 /// </summary>
 internal static class ErrorHelper
 {
-    public static IError InvalidRequest() 
+    public static IError InvalidRequest()
         => ErrorBuilder.New()
             .SetMessage(AspNetCoreResources.ErrorHelper_InvalidRequest)
             .SetCode(ErrorCodes.Server.RequestInvalid)
             .Build();
 
-    public static IError RequestHasNoElements() 
+    public static IError RequestHasNoElements()
         => ErrorBuilder.New()
             .SetMessage(AspNetCoreResources.ErrorHelper_RequestHasNoElements)
             .SetCode(ErrorCodes.Server.RequestInvalid)
             .Build();
 
-    public static IQueryResult ResponseTypeNotSupported() 
+    public static IQueryResult ResponseTypeNotSupported()
         => QueryResultBuilder.CreateError(
             ErrorBuilder.New()
                 .SetMessage(AspNetCoreResources.ErrorHelper_ResponseTypeNotSupported)
@@ -45,18 +45,18 @@ public static IQueryResult InvalidTypeName(string typeName)
             new Error(
                 "The type name is invalid.",
                 code: ErrorCodes.Server.InvalidTypeName,
-                extensions: new Dictionary<string, object?> 
+                extensions: new Dictionary<string, object?>
                 {
-                    { "typeName", typeName } 
+                    { "typeName", typeName }
                 }));
 
     public static IQueryResult TypeNotFound(string typeName)
         => QueryResultBuilder.CreateError(
             new Error(
                 $"The type `{typeName}` does not exist.",
                 code: ErrorCodes.Server.TypeDoesNotExist,
-                extensions: new Dictionary<string, object?> 
+                extensions: new Dictionary<string, object?>
                 {
-                    { "typeName", typeName } 
+                    { "typeName", typeName }
                 }));
 }

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/BananaCakePopEndpointConventionBuilder.cs

@@ -1,4 +1,3 @@
-using System;
 using Microsoft.AspNetCore.Builder;
 
 namespace HotChocolate.AspNetCore.Extensions;

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/EndpointRouteBuilderExtensions.cs

@@ -1,9 +1,9 @@
-using HotChocolate.AspNetCore;
-using HotChocolate.AspNetCore.Extensions;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.AspNetCore.Routing.Patterns;
 using Microsoft.Extensions.FileProviders;
+using HotChocolate.AspNetCore;
+using HotChocolate.AspNetCore.Extensions;
 using static Microsoft.AspNetCore.Routing.Patterns.RoutePatternFactory;
 
 namespace Microsoft.AspNetCore.Builder;

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/GraphQLEndpointConventionBuilder.cs

@@ -1,4 +1,3 @@
-using System;
 using Microsoft.AspNetCore.Builder;
 
 namespace HotChocolate.AspNetCore.Extensions;

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/GraphQLHttpEndpointConventionBuilder.cs

@@ -1,4 +1,3 @@
-using System;
 using Microsoft.AspNetCore.Builder;
 
 namespace HotChocolate.AspNetCore.Extensions;

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Http.cs

@@ -1,10 +1,9 @@
-using System;
 using System.Text.Json;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using HotChocolate.AspNetCore;
 using HotChocolate.AspNetCore.Serialization;
 using HotChocolate.Execution.Configuration;
 using HotChocolate.Utilities;
-using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Microsoft.Extensions.DependencyInjection;
 

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Subscriptions.cs

@@ -1,10 +1,9 @@
-using System;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using HotChocolate.AspNetCore;
 using HotChocolate.AspNetCore.Subscriptions;
 using HotChocolate.AspNetCore.Subscriptions.Messages;
 using HotChocolate.Execution.Configuration;
 using HotChocolate.Utilities;
-using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Microsoft.Extensions.DependencyInjection;
 

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Warmup.cs

@@ -1,4 +1,3 @@
-using System;
 using HotChocolate.AspNetCore.Warmup;
 using HotChocolate.Execution.Configuration;
 

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.cs

@@ -1,9 +1,8 @@
-using System;
-using HotChocolate;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using HotChocolate.AspNetCore.Instrumentation;
 using HotChocolate.AspNetCore.Serialization;
 using HotChocolate.Execution.Configuration;
 using HotChocolate.Language;
-using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Microsoft.Extensions.DependencyInjection;
 
@@ -45,6 +44,17 @@ public static IServiceCollection AddGraphQLServerCore(
                 sp.GetRequiredService<IDocumentHashProvider>(),
                 maxAllowedRequestSize,
                 sp.GetRequiredService<ParserOptions>()));
+        services.TryAddSingleton<IServerDiagnosticEvents>(sp =>
+        {
+            IServerDiagnosticEventListener[] listeners =
+                sp.GetServices<IServerDiagnosticEventListener>().ToArray();
+            return listeners.Length switch
+            {
+                0 => new NoopServerDiagnosticEventListener(),
+                1 => listeners[0],
+                _ => new AggregateServerDiagnosticEventListener(listeners)
+            };
+        });
         return services;
     }
 

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HttpContextExtensions.cs

@@ -1,4 +1,3 @@
-using System.Linq;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Primitives;
 

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HttpRequestExtensions.cs

@@ -1,4 +1,3 @@
-using System;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Primitives;
 using Microsoft.Net.Http.Headers;

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HttpResponseExtensions.cs

@@ -1,11 +1,8 @@
-using System.Globalization;
 using System.Text.Json;
 using System.Text.Json.Serialization;
-using System.Threading;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
-using static System.String;
 using static System.Globalization.CultureInfo;
+using static System.String;
 
 namespace HotChocolate.AspNetCore;
 
@@ -42,7 +39,7 @@ public static IHeaderDictionary SetContentDisposition(
         this IHeaderDictionary headers,
         string fileName)
     {
-        headers[_contentDepositionHeader] = 
+        headers[_contentDepositionHeader] =
             Format(InvariantCulture, _contentDepositionValue, fileName);
         return headers;
     }

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/RequestExecutorExtensions.cs

@@ -1,4 +1,3 @@
-using HotChocolate.Execution;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace HotChocolate.AspNetCore;

src/HotChocolate/AspNetCore/src/AspNetCore/GraphQLRequestException.cs

@@ -1,12 +1,9 @@
-using System;
-using System.Collections.Generic;
 using System.Runtime.Serialization;
 
 namespace HotChocolate.AspNetCore;
 
 [Serializable]
-public class GraphQLRequestException
-    : GraphQLException
+public class GraphQLRequestException : GraphQLException
 {
     public GraphQLRequestException(string message)
         : base(message)

src/HotChocolate/AspNetCore/src/AspNetCore/HotChocolate.AspNetCore.csproj

@@ -8,6 +8,10 @@
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
 
+  <ItemGroup>
+    <InternalsVisibleTo Include="HotChocolate.AspNetCore.Tests" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\..\Core\src\Core\HotChocolate.Core.csproj" />
     <ProjectReference Include="..\..\..\Core\src\Types.Scalars.Upload\HotChocolate.Types.Scalars.Upload.csproj" />

src/HotChocolate/AspNetCore/src/AspNetCore/HttpGetMiddleware.cs

@@ -1,39 +1,49 @@
-using System;
 using System.Diagnostics;
 using System.Net;
-using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using HotChocolate.AspNetCore.Instrumentation;
 using HotChocolate.AspNetCore.Serialization;
-using HotChocolate.Execution;
 using HotChocolate.Language;
-using Microsoft.AspNetCore.Http;
 using HttpRequestDelegate = Microsoft.AspNetCore.Http.RequestDelegate;
 
 namespace HotChocolate.AspNetCore;
 
-public class HttpGetMiddleware : MiddlewareBase
+public sealed class HttpGetMiddleware : MiddlewareBase
 {
     private static readonly OperationType[] _onlyQueries = { OperationType.Query };
 
     private readonly IHttpRequestParser _requestParser;
+    private readonly IServerDiagnosticEvents _diagnosticEvents;
 
     public HttpGetMiddleware(
         HttpRequestDelegate next,
         IRequestExecutorResolver executorResolver,
         IHttpResultSerializer resultSerializer,
         IHttpRequestParser requestParser,
+        IServerDiagnosticEvents diagnosticEvents,
         NameString schemaName)
         : base(next, executorResolver, resultSerializer, schemaName)
     {
         _requestParser = requestParser ??
             throw new ArgumentNullException(nameof(requestParser));
+        _diagnosticEvents = diagnosticEvents ??
+            throw new ArgumentNullException(nameof(diagnosticEvents));
     }
 
     public async Task InvokeAsync(HttpContext context)
     {
         if (HttpMethods.IsGet(context.Request.Method) &&
             (context.GetGraphQLServerOptions()?.EnableGetRequests ?? true))
         {
-            await HandleRequestAsync(context);
+            if (!IsDefaultSchema)
+            {
+                context.Items[WellKnownContextData.SchemaName] = SchemaName.Value;
+            }
+
+            using (_diagnosticEvents.ExecuteHttpRequest(context, HttpRequestKind.HttpGet))
+            {
+                await HandleRequestAsync(context);
+            }
         }
         else
         {
@@ -49,32 +59,54 @@ private async Task HandleRequestAsync(HttpContext context)
         IRequestExecutor requestExecutor = await GetExecutorAsync(context.RequestAborted);
         IHttpRequestInterceptor requestInterceptor = requestExecutor.GetRequestInterceptor();
         IErrorHandler errorHandler = requestExecutor.GetErrorHandler();
+        context.Items[WellKnownContextData.RequestExecutor] = requestExecutor;
 
         HttpStatusCode? statusCode = null;
         IExecutionResult? result;
 
+        // next we parse the GraphQL request.
+        GraphQLRequest request;
+        using (_diagnosticEvents.ParseHttpRequest(context))
+        {
+            try
+            {
+                request = _requestParser.ReadParamsRequest(context.Request.Query);
+            }
+            catch (GraphQLRequestException ex)
+            {
+                // A GraphQL request exception is thrown if the HTTP request body couldn't be
+                // parsed. In this case we will return HTTP status code 400 and return a
+                // GraphQL error result.
+                statusCode = HttpStatusCode.BadRequest;
+                IReadOnlyList<IError> errors = errorHandler.Handle(ex.Errors);
+                result = QueryResultBuilder.CreateError(errors);
+                _diagnosticEvents.ParserErrors(context, errors);
+                goto HANDLE_RESULT;
+            }
+            catch (Exception ex)
+            {
+                statusCode = HttpStatusCode.InternalServerError;
+                IError error = errorHandler.CreateUnexpectedError(ex).Build();
+                result = QueryResultBuilder.CreateError(error);
+                _diagnosticEvents.HttpRequestError(context, error);
+                goto HANDLE_RESULT;
+            }
+        }
+
+        // after successfully parsing the request we now will attempt to execute the request.
         try
         {
-            // next we parse the GraphQL request.
-            GraphQLRequest request = _requestParser.ReadParamsRequest(context.Request.Query);
             GraphQLServerOptions? options = context.GetGraphQLServerOptions();
             result = await ExecuteSingleAsync(
                 context,
                 requestExecutor,
                 requestInterceptor,
+                _diagnosticEvents,
                 request,
                 options is null or { AllowedGetOperations: AllowedGetOperations.Query }
                     ? _onlyQueries
                     : null);
         }
-        catch (GraphQLRequestException ex)
-        {
-            // A GraphQL request exception is thrown if the HTTP request body couldn't be
-            // parsed. In this case we will return HTTP status code 400 and return a
-            // GraphQL error result.
-            statusCode = HttpStatusCode.BadRequest;
-            result = QueryResultBuilder.CreateError(errorHandler.Handle(ex.Errors));
-        }
         catch (GraphQLException ex)
         {
             // This allows extensions to throw GraphQL exceptions in the GraphQL interceptor.
@@ -88,15 +120,34 @@ private async Task HandleRequestAsync(HttpContext context)
             result = QueryResultBuilder.CreateError(error);
         }
 
+HANDLE_RESULT:
+        IDisposable? formatScope = null;
+
         try
         {
+            // if cancellation is requested we will not try to attempt to write the result to the 
+            // response stream.
+            if (context.RequestAborted.IsCancellationRequested)
+            {
+                return;
+            }
+
             // in any case we will have a valid GraphQL result at this point that can be written
             // to the HTTP response stream.
             Debug.Assert(result is not null, "No GraphQL result was created.");
+
+            if (result is IQueryResult queryResult)
+            {
+                formatScope = _diagnosticEvents.FormatHttpResponse(context, queryResult);
+            }
+
             await WriteResultAsync(context.Response, result, statusCode, context.RequestAborted);
         }
         finally
         {
+            // we must dispose the diagnostic scope first.
+            formatScope?.Dispose();
+
             // query results use pooled memory an need to be disposed after we have
             // used them.
             if (result is IAsyncDisposable asyncDisposable)