Improved error handling and diagnostics (#8616)

Author: michaelstaib

src/HotChocolate/Core/src/Execution.Abstractions/Execution/Instrumentation/ErrorKind.cs

@@ -19,6 +19,31 @@ public interface ICoreExecutionDiagnosticEvents
     /// </returns>
     IDisposable ExecuteRequest(RequestContext context);
 
+    /// <summary>
+    /// Called at the end of the execution if an exception occurred at some point,
+    /// including unhandled exceptions when resolving fields.
+    /// </summary>
+    /// <param name="context">
+    /// The request context encapsulates all GraphQL-specific information about an
+    /// individual GraphQL request.
+    /// </param>
+    /// <param name="error">
+    /// The last exception that occurred.
+    /// </param>
+    void RequestError(RequestContext context, Exception error);
+
+    /// <summary>
+    /// Called when a request termination error occurs within the request pipeline.
+    /// </summary>
+    /// <param name="context">
+    /// The request context encapsulates all GraphQL-specific information about an
+    /// individual GraphQL request.
+    /// </param>
+    /// <param name="error">
+    /// The GraphQL error object.
+    /// </param>
+    void RequestError(RequestContext context, IError error);
+
     /// <summary>
     /// Called when starting to parse a document.
     /// </summary>
@@ -43,6 +68,18 @@ public interface ICoreExecutionDiagnosticEvents
     /// </returns>
     IDisposable ValidateDocument(RequestContext context);
 
+    /// <summary>
+    /// Called if there are any document validation errors.
+    /// </summary>
+    /// <param name="context">
+    /// The request context encapsulates all GraphQL-specific information about an
+    /// individual GraphQL request.
+    /// </param>
+    /// <param name="errors">
+    /// The GraphQL validation errors.
+    /// </param>
+    void ValidationErrors(RequestContext context, IReadOnlyList<IError> errors);
+
     /// <summary>
     /// Called when starting to coerce variables for a request.
     /// </summary>
@@ -82,29 +119,6 @@ public interface ICoreExecutionDiagnosticEvents
     /// </returns>
     IDisposable ExecuteSubscription(RequestContext context, ulong subscriptionId);
 
-    /// <summary>
-    /// Called when an error occurs during the execution of a GraphQL request.
-    /// </summary>
-    /// <param name="context">
-    /// The request context encapsulates all GraphQL-specific information about an
-    /// individual GraphQL request.
-    /// </param>
-    /// <param name="kind">
-    /// The kind of error that occurred.
-    /// </param>
-    /// <param name="errors">
-    /// The errors that occurred.
-    /// </param>
-    /// <param name="state">
-    /// An additional state object that can be used to pass additional information
-    /// to the error diagnostic listener.
-    /// </param>
-    void ExecutionError(
-        RequestContext context,
-        ErrorKind kind,
-        IReadOnlyList<IError> errors,
-        object? state = null);
-
     /// <summary>
     /// A GraphQL request document was added to the document cache.
     /// </summary>
@@ -145,6 +159,15 @@ void ExecutionError(
     /// </param>
     void DocumentNotFoundInStorage(RequestContext context, OperationDocumentId documentId);
 
+    /// <summary>
+    /// Called when a request has a non-trusted document when only trusted-documents are allowed.
+    /// </summary>
+    /// <param name="context">
+    /// The request context encapsulates all GraphQL-specific information
+    /// about an individual GraphQL request.
+    /// </param>
+    void UntrustedDocumentRejected(RequestContext context);
+
     /// <summary>
     /// A GraphQL request executor was created and is now able to execute GraphQL requests.
     /// </summary>

src/HotChocolate/Core/src/Execution.Abstractions/Execution/Instrumentation/ICoreExecutionDiagnosticEvents.cs

@@ -69,7 +69,7 @@ public async ValueTask InvokeAsync(RequestContext context)
                                 .Build());
 
                         context.Result = OperationResultBuilder.CreateError(error);
-                        _diagnosticEvents.ExecutionError(context, ErrorKind.SyntaxError, [error]);
+                        _diagnosticEvents.RequestError(context, ex);
                     }
                 }
             }

src/HotChocolate/Core/src/Execution.Pipeline/DocumentParserMiddleware.cs

@@ -65,7 +65,7 @@ public async ValueTask InvokeAsync(RequestContext context)
                         }
 
                         context.Result = OperationResultBuilder.CreateError(result.Errors, resultContextData);
-                        _diagnosticEvents.ExecutionError(context, ErrorKind.ValidationError, result.Errors);
+                        _diagnosticEvents.ValidationErrors(context, result.Errors);
                         return;
                     }
                 }

src/HotChocolate/Core/src/Execution.Pipeline/DocumentValidationMiddleware.cs

@@ -33,19 +33,19 @@ public async ValueTask InvokeAsync(RequestContext context)
         {
             var error = _errorHandler.Handle(ErrorHelper.OperationCanceled(ex));
             context.Result = OperationResultBuilder.CreateError(error);
-            _diagnosticEvents.ExecutionError(context, ErrorKind.RequestError, [error]);
+            _diagnosticEvents.RequestError(context, ex);
         }
         catch (GraphQLException ex)
         {
             var errors = _errorHandler.Handle(ex.Errors);
             context.Result = OperationResultBuilder.CreateError(errors);
-            _diagnosticEvents.ExecutionError(context, ErrorKind.RequestError, errors);
+            _diagnosticEvents.RequestError(context, ex);
         }
         catch (Exception ex)
         {
             var error = _errorHandler.Handle(ErrorBuilder.FromException(ex).Build());
             context.Result = OperationResultBuilder.CreateError(error);
-            _diagnosticEvents.ExecutionError(context, ErrorKind.RequestError, [error]);
+            _diagnosticEvents.RequestError(context, ex);
         }
     }
 

src/HotChocolate/Core/src/Execution.Pipeline/ExceptionMiddleware.cs

@@ -35,7 +35,7 @@ internal static IServiceCollection TryAddDiagnosticEvents(
             var listeners = sp.GetServices<IExecutionDiagnosticEventListener>().ToArray();
             return listeners.Length switch
             {
-                0 => new NoopExecutionDiagnosticEvents(),
+                0 => NoopExecutionDiagnosticEvents.Instance,
                 1 => listeners[0],
                 _ => new AggregateExecutionDiagnosticEvents(listeners)
             };

src/HotChocolate/Core/src/Execution/DependencyInjection/InternalSchemaServiceCollectionExtensions.cs

@@ -48,7 +48,6 @@ public static OperationContext ReportError(
         var errors = new List<IError>();
 
         ReportSingleError(
-            operationContext.RequestContext,
             operationContext.ErrorHandler,
             error,
             errors);
@@ -58,18 +57,13 @@ public static OperationContext ReportError(
         foreach (var handled in errors)
         {
             operationContext.Result.AddError(handled, selection);
+            operationContext.DiagnosticEvents.ResolverError(resolverContext, handled);
         }
 
-        operationContext.DiagnosticEvents.ExecutionError(
-            operationContext.RequestContext,
-            ErrorKind.FieldError,
-            errors);
-
         return operationContext;
     }
 
     private static void ReportSingleError(
-        RequestContext requestContext,
         IErrorHandler errorHandler,
         IError error,
         List<IError> errors,
@@ -89,7 +83,6 @@ private static void ReportSingleError(
             foreach (var innerError in aggregateError.Errors)
             {
                 ReportSingleError(
-                    requestContext,
                     errorHandler,
                     innerError,
                     errors,