Optimized Query Planning (#6379)

Author: michaelstaib

src/HotChocolate/Core/src/Execution/Processing/OperationCompiler.cs

@@ -218,7 +218,7 @@ private Operation CreateOperation(
             while (Unsafe.IsAddressLessThan(ref variantsStart, ref variantsEnd))
             {
                 variantsStart.Complete();
-                variantsStart = ref Unsafe.Add(ref variantsStart, 1);
+                variantsStart = ref Unsafe.Add(ref variantsStart, 1)!;
             }
 
 #if NET5_0_OR_GREATER
@@ -229,7 +229,7 @@ private Operation CreateOperation(
             while (Unsafe.IsAddressLessThan(ref optStart, ref optEnd))
             {
                 optStart.OptimizeOperation(context);
-                optStart = ref Unsafe.Add(ref optStart, 1);
+                optStart = ref Unsafe.Add(ref optStart, 1)!;
             }
 #else
             for (var i = 0; i < _operationOptimizers.Count; i++)
@@ -241,13 +241,13 @@ private Operation CreateOperation(
             CompleteResolvers(schema);
 
             variantsSpan = variants.AsSpan();
-            variantsStart = ref GetReference(variantsSpan);
-            variantsEnd = ref Unsafe.Add(ref variantsStart, variantsSpan.Length);
+            variantsStart = ref GetReference(variantsSpan)!;
+            variantsEnd = ref Unsafe.Add(ref variantsStart, variantsSpan.Length)!;
 
             while (Unsafe.IsAddressLessThan(ref variantsStart, ref variantsEnd))
             {
                 variantsStart.Seal();
-                variantsStart = ref Unsafe.Add(ref variantsStart, 1);
+                variantsStart = ref Unsafe.Add(ref variantsStart, 1)!;
             }
         }
 

src/HotChocolate/Fusion/src/Composition/FusionGraphComposer.cs

@@ -164,4 +164,46 @@ public async ValueTask<Schema> ComposeAsync(
 
         return log.HasErrors ? null : context.FusionGraph;
     }
+
+    /// <summary>
+    /// Composes the subgraph schemas into a single,
+    /// merged schema representing the fusion gateway configuration.
+    /// </summary>
+    /// <param name="configurations">
+    /// The subgraph configurations to compose.
+    /// </param>
+    /// <param name="features">
+    /// The composition feature flags.
+    /// </param>
+    /// <param name="fusionTypePrefix">
+    /// The prefix that is used for the fusion types.
+    /// </param>
+    /// <param name="fusionTypeSelf">
+    /// Defines if the fusion types should be prefixed with the subgraph name.
+    /// </param>
+    /// <param name="logFactory">
+    /// A factory that creates a new composition log.
+    /// </param>
+    /// <param name="cancellationToken">
+    /// A cancellation token that can be used to cancel the operation.
+    /// </param>
+    /// <returns>The fusion gateway configuration.</returns>
+    public static async ValueTask<Schema> ComposeAsync(
+        IEnumerable<SubgraphConfiguration> configurations,
+        FusionFeatureCollection? features = null,
+        string? fusionTypePrefix = null,
+        bool fusionTypeSelf = false,
+        Func<ICompositionLog>? logFactory = null,
+        CancellationToken cancellationToken = default)
+    {
+        var composer = new FusionGraphComposer(
+            fusionTypePrefix,
+            fusionTypeSelf,
+            logFactory);
+
+        return await composer.ComposeAsync(
+            configurations,
+            features,
+            cancellationToken);
+    }
 }

src/HotChocolate/Fusion/src/Core/DependencyInjection/FusionRequestExecutorBuilderExtensions.cs

@@ -3,8 +3,8 @@
 using HotChocolate.Execution.Configuration;
 using HotChocolate.Execution.Pipeline;
 using HotChocolate.Fusion.Clients;
+using HotChocolate.Fusion.Execution.Pipeline;
 using HotChocolate.Fusion.Metadata;
-using HotChocolate.Fusion.Pipeline;
 using HotChocolate.Fusion.Planning;
 using HotChocolate.Language;
 using HotChocolate.Types.Descriptors;

src/HotChocolate/Fusion/src/Core/DependencyInjection/GatewayConfiguration.cs

@@ -5,15 +5,11 @@ namespace Microsoft.Extensions.DependencyInjection;
 /// <summary>
 /// Represents the Fusion gateway configuration.
 /// </summary>
-public sealed class GatewayConfiguration
+public sealed class GatewayConfiguration(DocumentNode document)
 {
-    public GatewayConfiguration(DocumentNode document)
-    {
-        Document = document ?? throw new ArgumentNullException(nameof(document));
-    }
-
     /// <summary>
     /// Gets the Fusion gateway configuration document.
     /// </summary>
-    public DocumentNode Document { get; }
+    public DocumentNode Document { get; } = document
+        ?? throw new ArgumentNullException(nameof(document));
 }

src/HotChocolate/Fusion/src/Core/Execution/ExecutionState.cs

@@ -1,3 +1,4 @@
+using System.Diagnostics;
 using HotChocolate.Execution.Processing;
 using HotChocolate.Language;
 
@@ -7,17 +8,18 @@ namespace HotChocolate.Fusion.Execution;
 /// Represents the query plan state for a single selection set.
 /// This working state can be shared between nodes of a query plan.
 /// </summary>
+[DebuggerDisplay($"{{{nameof(GetDebuggerDisplay)}(),nq}}")]
 internal sealed class ExecutionState
 {
     public ExecutionState(
         SelectionSet selectionSet,
         ObjectResult selectionSetResult,
-        IReadOnlyList<string> provides)
+        IReadOnlyList<string> requires)
     {
         SelectionSet = selectionSet;
         SelectionSetResult = selectionSetResult;
         SelectionSetData = new SelectionData[selectionSet.Selections.Count];
-        Provides = provides;
+        Requires = requires;
     }
 
     /// <summary>
@@ -28,10 +30,9 @@ public ExecutionState(
 
     /// <summary>
     /// Gets a list of keys representing the state that is being
-    /// provided after the associated <see cref="SelectionSet"/>
-    /// has been executed.
+    /// required to fetch data for the associated <see cref="SelectionSet"/>.
     /// </summary>
-    public IReadOnlyList<string> Provides { get; }
+    public IReadOnlyList<string> Requires { get; }
 
     /// <summary>
     /// Gets the selection set that is being executed.
@@ -52,4 +53,16 @@ public ExecutionState(
     /// Gets a flag that indicates if the work item has been initialized.
     /// </summary>
     public bool IsInitialized { get; set; }
+
+    private string GetDebuggerDisplay()
+    {
+        var displayName = $"State {SelectionSet.Id}";
+
+        if (Requires.Count > 0)
+        {
+            displayName = $"{displayName} requires: {string.Join(", ", Requires)}";
+        }
+
+        return displayName;
+    }
 }

src/HotChocolate/Fusion/src/Core/Execution/ExecutorUtils.cs

@@ -466,15 +466,15 @@ public static void TryInitializeExecutionState(QueryPlan queryPlan, ExecutionSta
             // next we will unwrap the results.
             ExtractSelectionResults(
                 partialResult,
-                (SelectionSet)executionState.SelectionSet,
+                executionState.SelectionSet,
                 executionState.SelectionSetData);
 
             // last we will check if there are any exports for this selection-set.
             ExtractVariables(
                 partialResult,
                 queryPlan,
                 executionState.SelectionSet,
-                executionState.Provides,
+                executionState.Requires,
                 executionState.VariableValues);
         }
 

src/HotChocolate/Fusion/src/Core/Execution/Nodes/If.cs

@@ -8,20 +8,13 @@ namespace HotChocolate.Fusion.Execution.Nodes;
 /// <summary>
 /// The <see cref="If"/> node is responsible for executing a node based on a state.
 /// </summary>
-internal sealed class If : QueryPlanNode
+/// <param name="id">
+/// The unique id of this node.
+/// </param>
+internal sealed class If(int id) : QueryPlanNode(id)
 {
     private readonly List<Branch> _branches = new();
 
-    /// <summary>
-    /// Initializes a new instance of <see cref="If"/>.
-    /// </summary>
-    /// <param name="id">
-    /// The unique id of this node.
-    /// </param>
-    public If(int id) : base(id)
-    {
-    }
-
     /// <summary>
     /// Gets the kind of this node.
     /// </summary>
@@ -65,15 +58,8 @@ public void AddBranch(string key, object value, QueryPlanNode node)
             throw ThrowHelper.Node_ReadOnly();
         }
 
-        if (key is null)
-        {
-            throw new ArgumentNullException(nameof(key));
-        }
-
-        if (node is null)
-        {
-            throw new ArgumentNullException(nameof(node));
-        }
+        ArgumentNullException.ThrowIfNull(key);
+        ArgumentNullException.ThrowIfNull(node);
 
         _branches.Add(new Branch(key, value, node));
         base.AddNode(node);
@@ -103,6 +89,6 @@ protected override void FormatNodesProperty(Utf8JsonWriter writer)
             writer.WriteEndArray();
         }
     }
-    
+
     private readonly record struct Branch(string Key, object Value, QueryPlanNode Node);
 }

src/HotChocolate/Fusion/src/Core/Execution/Nodes/Introspect.cs

@@ -10,26 +10,19 @@ namespace HotChocolate.Fusion.Execution.Nodes;
 /// <summary>
 /// The <see cref="Introspect"/> node is responsible for executing introspection selection of the GraphQL request.
 /// </summary>
-internal sealed class Introspect : QueryPlanNode
+/// <param name="id">
+/// The unique id of this node.
+/// </param>
+/// <param name="selectionSet">
+/// The selection set for which the results shall be composed.
+/// </param>
+/// <exception cref="ArgumentNullException">
+/// <paramref name="selectionSet"/> is <c>null</c>.
+/// </exception>
+internal sealed class Introspect(int id, SelectionSet selectionSet) : QueryPlanNode(id)
 {
-    private readonly SelectionSet _selectionSet;
-
-    /// <summary>
-    /// Initializes a new instance of <see cref="Introspect"/>.
-    /// </summary>
-    /// <param name="id">
-    /// The unique id of this node.
-    /// </param>
-    /// <param name="selectionSet">
-    /// The selection set for which the results shall be composed.
-    /// </param>
-    /// <exception cref="ArgumentNullException">
-    /// <paramref name="selectionSet"/> is <c>null</c>.
-    /// </exception>
-    public Introspect(int id, SelectionSet selectionSet) : base(id)
-    {
-        _selectionSet = selectionSet ?? throw new ArgumentNullException(nameof(selectionSet));
-    }
+    private readonly SelectionSet _selectionSet = selectionSet
+        ?? throw new ArgumentNullException(nameof(selectionSet));
 
     /// <summary>
     /// Gets the kind of this node.
@@ -93,7 +86,7 @@ protected override void FormatProperties(Utf8JsonWriter writer)
             {
                 rootSelectionNodes.Add(selection.SyntaxNode);
             }
-            
+
             selection = ref Unsafe.Add(ref selection, 1)!;
         }
 

src/HotChocolate/Fusion/src/Core/Execution/Nodes/Parallel.cs

@@ -1,3 +1,4 @@
+using System.Diagnostics;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
@@ -6,16 +7,11 @@ namespace HotChocolate.Fusion.Execution.Nodes;
 /// <summary>
 /// The <see cref="Parallel"/> node executes its child nodes in parallel.
 /// </summary>
-internal sealed class Parallel : QueryPlanNode
+/// <param name="id">
+/// The unique id of this node.
+/// </param>
+internal sealed class Parallel(int id) : QueryPlanNode(id)
 {
-    /// <summary>
-    /// Initializes a new instance of <see cref="Parallel"/>.
-    /// </summary>
-    /// <param name="id">
-    /// The unique id of this node.
-    /// </param>
-    public Parallel(int id) : base(id) { }
-
     /// <summary>
     /// Gets the kind of this node.
     /// </summary>
@@ -27,14 +23,26 @@ protected override async Task OnExecuteNodesAsync(
         CancellationToken cancellationToken)
     {
         InitializeNodes(context, cancellationToken, out var tasks);
+
+#if DISABLED_FOR_DEBUGGING
+        if(Debugger.IsAttached)
+        {
+            foreach (var task in tasks)
+            {
+                await task.ConfigureAwait(false);
+            }
+            return;
+        }
+#endif
+
         await Task.WhenAll(tasks).ConfigureAwait(false);
     }
 
     private void InitializeNodes(FusionExecutionContext context, CancellationToken cancellationToken, out Task[] tasks)
     {
         var nodes = GetNodesSpan();
         tasks = new Task[nodes.Length];
-        
+
         ref var node = ref MemoryMarshal.GetReference(nodes);
         ref var task = ref MemoryMarshal.GetArrayDataReference(tasks);
         ref var end = ref Unsafe.Add(ref node, nodes.Length);
@@ -46,4 +54,4 @@ private void InitializeNodes(FusionExecutionContext context, CancellationToken c
             task = ref Unsafe.Add(ref task, 1)!;
         }
     }
-}
+}