[Fusion] Add IncludeExceptionDetails option (#8694)

Author: tobias-tengler

src/HotChocolate/Fusion-vnext/src/Fusion.Execution/Execution/FusionRequestExecutorManager.cs

@@ -302,9 +302,13 @@ private void AddCoreServices(IServiceCollection services, FusionRequestOptions r
         services.AddSingleton(static sp => sp.GetRequiredService<RequestExecutorAccessor>().RequestExecutor);
         services.AddSingleton<IRequestExecutor>(sp => sp.GetRequiredService<FusionRequestExecutor>());
         services.AddSingleton(static sp => sp.GetRequiredService<ISchemaDefinition>().GetRequestOptions());
-        services.AddSingleton<IErrorHandler>(static sp => new DefaultErrorHandler(sp.GetServices<IErrorFilter>()));
-        services.AddSingleton<IErrorFilter>(static _ => new AddDebugInformationErrorFilter());
         services.TryAddSingleton<INodeIdParser, DefaultNodeIdParser>();
+        services.AddSingleton<IErrorHandler>(static sp => new DefaultErrorHandler(sp.GetServices<IErrorFilter>()));
+
+        if (requestOptions.IncludeExceptionDetails)
+        {
+            services.AddSingleton<IErrorFilter>(static _ => new AddDebugInformationErrorFilter());
+        }
 
         services.AddSingleton(static _ => new SchemaDefinitionAccessor());
         services.AddSingleton(static sp => sp.GetRequiredService<SchemaDefinitionAccessor>().Schema);

src/HotChocolate/Fusion-vnext/src/Fusion.Execution/Execution/FusionRequestOptions.cs

@@ -16,6 +16,7 @@ public sealed class FusionRequestOptions : ICloneable
     private bool _allowErrorHandlingModeOverride;
     private PersistedOperationOptions _persistedOperationOptions = new();
     private bool _isReadOnly;
+    private bool _includeExceptionDetails;
 
     /// <summary>
     /// Gets or sets the execution timeout.
@@ -166,6 +167,26 @@ public PersistedOperationOptions PersistedOperations
         }
     }
 
+    /// <summary>
+    /// Gets or sets whether exception details should be included for GraphQL
+    /// errors in the GraphQL response.
+    /// This should only be enabled for development purposes
+    /// and not in production environments.
+    /// </summary>
+    public bool IncludeExceptionDetails
+    {
+        get => _includeExceptionDetails;
+        set
+        {
+            if (_isReadOnly)
+            {
+                throw new InvalidOperationException("The request options are read-only.");
+            }
+
+            _includeExceptionDetails = value;
+        }
+    }
+
     /// <summary>
     /// Clones the request options into a new mutable instance.
     /// </summary>

src/HotChocolate/Fusion-vnext/src/Fusion.Execution/Execution/OperationPlanContext.cs

@@ -61,9 +61,11 @@ public OperationPlanContext(
         _clientScope = requestContext.CreateClientScope();
         _nodeIdParser = requestContext.Schema.Services.GetRequiredService<INodeIdParser>();
         _diagnosticEvents = requestContext.Schema.Services.GetRequiredService<IFusionExecutionDiagnosticEvents>();
+        var errorHandler = requestContext.Schema.Services.GetRequiredService<IErrorHandler>();
 
         _resultStore = new FetchResultStore(
             requestContext.Schema,
+            errorHandler,
             _resultPoolSessionHolder,
             operationPlan.Operation,
             requestContext.ErrorHandlingMode(),

src/HotChocolate/Fusion-vnext/src/Fusion.Execution/Execution/Results/FetchResultStore.cs

@@ -5,6 +5,7 @@
 using System.Runtime.InteropServices;
 using System.Text.Json;
 using HotChocolate.Buffers;
+using HotChocolate.Execution;
 using HotChocolate.Fusion.Execution.Clients;
 using HotChocolate.Fusion.Execution.Nodes;
 using HotChocolate.Fusion.Language;
@@ -18,8 +19,9 @@ internal sealed class FetchResultStore : IDisposable
 {
     private readonly ReaderWriterLockSlim _lock = new(LockRecursionPolicy.NoRecursion);
     private readonly ISchemaDefinition _schema;
+    private readonly IErrorHandler _errorHandler;
     private readonly Operation _operation;
-    private readonly ErrorHandlingMode _errorHandling;
+    private readonly ErrorHandlingMode _errorHandlingMode;
     private readonly ulong _includeFlags;
     private readonly ConcurrentStack<IDisposable> _memory = [];
     private ObjectResult _root = null!;
@@ -29,18 +31,20 @@ internal sealed class FetchResultStore : IDisposable
 
     public FetchResultStore(
         ISchemaDefinition schema,
+        IErrorHandler errorHandler,
         ResultPoolSession resultPoolSession,
         Operation operation,
-        ErrorHandlingMode errorHandling,
+        ErrorHandlingMode errorHandlingMode,
         ulong includeFlags)
     {
         ArgumentNullException.ThrowIfNull(schema);
         ArgumentNullException.ThrowIfNull(resultPoolSession);
         ArgumentNullException.ThrowIfNull(operation);
 
         _schema = schema;
+        _errorHandler = errorHandler;
         _operation = operation;
-        _errorHandling = errorHandling;
+        _errorHandlingMode = errorHandlingMode;
         _includeFlags = includeFlags;
 
         Reset(resultPoolSession);
@@ -55,8 +59,9 @@ public void Reset(ResultPoolSession resultPoolSession)
 
         _valueCompletion = new ValueCompletion(
             _schema,
+            _errorHandler,
             resultPoolSession,
-            _errorHandling,
+            _errorHandlingMode,
             32,
             _includeFlags,
             _errors);

src/HotChocolate/Fusion-vnext/src/Fusion.Execution/Execution/Results/ValueCompletion.cs

@@ -1,5 +1,6 @@
 using System.Runtime.CompilerServices;
 using System.Text.Json;
+using HotChocolate.Execution;
 using HotChocolate.Fusion.Execution.Clients;
 using HotChocolate.Fusion.Execution.Nodes;
 using HotChocolate.Language;
@@ -10,16 +11,18 @@ namespace HotChocolate.Fusion.Execution.Results;
 internal sealed class ValueCompletion
 {
     private readonly ISchemaDefinition _schema;
+    private readonly IErrorHandler _errorHandler;
     private readonly ResultPoolSession _resultPoolSession;
-    private readonly ErrorHandlingMode _errorHandling;
+    private readonly ErrorHandlingMode _errorHandlingMode;
     private readonly int _maxDepth;
     private readonly ulong _includeFlags;
     private readonly List<IError> _errors;
 
     public ValueCompletion(
         ISchemaDefinition schema,
+        IErrorHandler errorHandler,
         ResultPoolSession resultPoolSession,
-        ErrorHandlingMode errorHandling,
+        ErrorHandlingMode errorHandlingMode,
         int maxDepth,
         ulong includeFlags,
         List<IError> errors)
@@ -29,8 +32,9 @@ public ValueCompletion(
         ArgumentNullException.ThrowIfNull(errors);
 
         _schema = schema;
+        _errorHandler = errorHandler;
         _resultPoolSession = resultPoolSession;
-        _errorHandling = errorHandling;
+        _errorHandlingMode = errorHandlingMode;
         _maxDepth = maxDepth;
         _includeFlags = includeFlags;
         _errors = errors;
@@ -80,7 +84,7 @@ public bool BuildResult(
 
             if (!TryCompleteValue(selection, selection.Type, property.Value, errorTrieForResponseName, 0, fieldResult))
             {
-                switch (_errorHandling)
+                switch (_errorHandlingMode)
                 {
                     case ErrorHandlingMode.Propagate:
                         var didPropagateToRoot = PropagateNullValues(objectResult);
@@ -122,15 +126,16 @@ public bool BuildErrorResult(
                 .SetPath(path.Append(responseName))
                 .AddLocation(fieldResult.Selection.SyntaxNodes[0].Node)
                 .Build();
+            errorWithPath = _errorHandler.Handle(errorWithPath);
 
             _errors.Add(errorWithPath);
 
-            if (_errorHandling is ErrorHandlingMode.Halt)
+            if (_errorHandlingMode is ErrorHandlingMode.Halt)
             {
                 return false;
             }
 
-            if (_errorHandling is ErrorHandlingMode.Propagate && fieldResult.Selection.Type.IsNonNullType())
+            if (_errorHandlingMode is ErrorHandlingMode.Propagate && fieldResult.Selection.Type.IsNonNullType())
             {
                 var didPropagateToRoot = PropagateNullValues(objectResult);
 
@@ -189,9 +194,10 @@ private bool TryCompleteValue(
                 .SetPath(parent.Path)
                 .AddLocation(selection.SyntaxNodes[0].Node)
                 .Build();
+            errorWithPath = _errorHandler.Handle(errorWithPath);
             _errors.Add(errorWithPath);
 
-            if (_errorHandling is ErrorHandlingMode.Halt)
+            if (_errorHandlingMode is ErrorHandlingMode.Halt)
             {
                 return false;
             }
@@ -207,10 +213,11 @@ private bool TryCompleteValue(
                     .SetPath(parent.Path)
                     .AddLocation(selection.SyntaxNodes[0].Node)
                     .Build();
+                nonNullViolationError = _errorHandler.Handle(nonNullViolationError);
 
                 _errors.Add(nonNullViolationError);
 
-                if (_errorHandling is ErrorHandlingMode.Propagate or ErrorHandlingMode.Halt)
+                if (_errorHandlingMode is ErrorHandlingMode.Propagate or ErrorHandlingMode.Halt)
                 {
                     return false;
                 }
@@ -284,17 +291,18 @@ private bool TryCompleteList(
                     .SetPath(parent.Path.Append(i))
                     .AddLocation(selection.SyntaxNodes[0].Node)
                     .Build();
+                errorWithPath = _errorHandler.Handle(errorWithPath);
                 _errors.Add(errorWithPath);
 
-                if (_errorHandling is ErrorHandlingMode.Halt)
+                if (_errorHandlingMode is ErrorHandlingMode.Halt)
                 {
                     return false;
                 }
             }
 
             if (item.IsNullOrUndefined())
             {
-                if (!isNullable && _errorHandling is ErrorHandlingMode.Propagate or ErrorHandlingMode.Halt)
+                if (!isNullable && _errorHandlingMode is ErrorHandlingMode.Propagate or ErrorHandlingMode.Halt)
                 {
                     return false;
                 }