Added Fusion Cost Analyzer Improvements. (#7867)

Author: michaelstaib

src/HotChocolate/Core/src/Types/Configuration/AggregateTypeInterceptor.cs

@@ -110,6 +110,22 @@ internal override void InitializeContext(
         }
     }
 
+    internal override bool SkipDirectiveDefinition(DirectiveDefinitionNode node)
+    {
+        ref var first = ref GetReference();
+        var length = _typeInterceptors.Length;
+
+        for (var i = 0; i < length; i++)
+        {
+            if (Unsafe.Add(ref first, i).SkipDirectiveDefinition(node))
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     public override void OnBeforeDiscoverTypes()
     {
         ref var first = ref GetReference();

src/HotChocolate/Core/src/Types/Configuration/TypeInterceptor.cs

@@ -74,6 +74,9 @@ public virtual void OnBeforeDiscoverTypes() { }
     /// </summary>
     public virtual void OnAfterDiscoverTypes() { }
 
+    internal virtual bool SkipDirectiveDefinition(DirectiveDefinitionNode node)
+        => false;
+
     /// <summary>
     /// This event is triggered after the type instance was created but before
     /// any type definition was initialized.

src/HotChocolate/Core/src/Types/Types/Factories/SchemaSyntaxVisitor.cs

@@ -171,6 +171,11 @@ protected override ISyntaxVisitorAction VisitChildren(
             goto EXIT;
         }
 
+        if(context.DescriptorContext.TypeInterceptor.SkipDirectiveDefinition(node))
+        {
+            goto EXIT;
+        }
+
         context.Types.Add(
             TypeReference.Create(
                 _directiveTypeFactory.Create(

src/HotChocolate/CostAnalysis/src/CostAnalysis/CostAnalyzerMiddleware.cs

@@ -36,7 +36,7 @@ public async ValueTask InvokeAsync(IRequestContext context)
         }
 
         var requestOptions = context.TryGetCostOptions() ?? options;
-        var mode = context.GetCostAnalyzerMode(requestOptions.EnforceCostLimits);
+        var mode = context.GetCostAnalyzerMode(requestOptions);
 
         if (mode == CostAnalyzerMode.Skip)
         {

src/HotChocolate/CostAnalysis/src/CostAnalysis/CostTypeInterceptor.cs

@@ -171,6 +171,13 @@ public override void OnBeforeCompleteType(ITypeCompletionContext completionConte
     }
 }
 
+internal sealed class CostDirectiveTypeInterceptor : TypeInterceptor
+{
+    internal override bool SkipDirectiveDefinition(DirectiveDefinitionNode node)
+        => node.Name.Value.Equals("cost", StringComparison.Ordinal)
+            || node.Name.Value.Equals("listSize", StringComparison.Ordinal);
+}
+
 file static class Extensions
 {
     public static bool HasCostDirective(this IHasDirectiveDefinition directiveProvider)

src/HotChocolate/CostAnalysis/src/CostAnalysis/DependencyInjection/CostAnalyzerRequestExecutorBuilderExtensions.cs

@@ -56,12 +56,14 @@ public static IRequestExecutorBuilder AddCostAnalyzer(this IRequestExecutorBuild
                             requestOptions.MaxFieldCost,
                             requestOptions.MaxTypeCost,
                             requestOptions.EnforceCostLimits,
+                            requestOptions.SkipAnalyzer,
                             requestOptions.Filtering.VariableMultiplier);
                     });
                 })
             .AddDirectiveType<CostDirectiveType>()
             .AddDirectiveType<ListSizeDirectiveType>()
             .TryAddTypeInterceptor<CostTypeInterceptor>()
+            .TryAddTypeInterceptor<CostDirectiveTypeInterceptor>()
 
             // we are replacing the default pipeline if the cost analyzer is added.
             .Configure(c => c.DefaultPipelineFactory = AddDefaultPipeline);

src/HotChocolate/CostAnalysis/src/CostAnalysis/Extensions/CostAnalyzerRequestContextExtensions.cs

@@ -58,21 +58,26 @@ public static CostMetrics GetCostMetrics(
 
     internal static CostAnalyzerMode GetCostAnalyzerMode(
         this IRequestContext context,
-        bool enforceCostLimits)
+        RequestCostOptions options)
     {
         if (context is null)
         {
             throw new ArgumentNullException(nameof(context));
         }
 
+        if (options.SkipAnalyzer)
+        {
+            return CostAnalyzerMode.Skip;
+        }
+
         if (context.ContextData.ContainsKey(WellKnownContextData.ValidateCost))
         {
             return CostAnalyzerMode.Analyze | CostAnalyzerMode.Report;
         }
 
         var flags = CostAnalyzerMode.Analyze;
 
-        if (enforceCostLimits)
+        if (options.EnforceCostLimits)
         {
             flags |= CostAnalyzerMode.Enforce;
         }

src/HotChocolate/CostAnalysis/src/CostAnalysis/HotChocolate.CostAnalysis.csproj

@@ -2,6 +2,7 @@
 
   <ItemGroup>
     <InternalsVisibleTo Include="HotChocolate.CostAnalysis.Tests" />
+    <InternalsVisibleTo Include="HotChocolate.Fusion" />
   </ItemGroup>
 
   <ItemGroup>

src/HotChocolate/CostAnalysis/src/CostAnalysis/Options/CostOptions.cs

@@ -5,6 +5,9 @@ namespace HotChocolate.CostAnalysis;
 /// </summary>
 public sealed class CostOptions
 {
+    private bool _skipAnalyzer = false;
+    private bool _enforceCostLimits = true;
+
     /// <summary>
     /// Gets or sets the maximum allowed field cost.
     /// </summary>
@@ -18,7 +21,35 @@ public sealed class CostOptions
     /// <summary>
     /// Defines if the analyzer shall enforce cost limits.
     /// </summary>
-    public bool EnforceCostLimits { get; set; } = true;
+    public bool EnforceCostLimits
+    {
+        get => _enforceCostLimits;
+        set
+        {
+            if(value)
+            {
+                SkipAnalyzer = false;
+            }
+
+            _enforceCostLimits = value;
+        }
+    }
+
+    /// <summary>
+    /// Skips the cost analyzer.
+    /// </summary>
+    public bool SkipAnalyzer
+    {
+        get => _skipAnalyzer;
+        set
+        {
+            if(value)
+            {
+                EnforceCostLimits = false;
+            }
+            _skipAnalyzer = value;
+        }
+    }
 
     /// <summary>
     /// Defines if cost defaults shall be applied to the schema.

src/HotChocolate/CostAnalysis/src/CostAnalysis/Options/RequestCostOptions.cs

@@ -3,20 +3,145 @@ namespace HotChocolate.CostAnalysis;
 /// <summary>
 /// Request options for cost analysis.
 /// </summary>
-/// <param name="MaxFieldCost">
-/// The maximum allowed field cost.
-/// </param>
-/// <param name="MaxTypeCost">
-/// The maximum allowed type cost.
-/// </param>
-/// <param name="EnforceCostLimits">
-/// Defines if the analyzer shall enforce cost limits.
-/// </param>
-/// <param name="FilterVariableMultiplier">
-/// The filter variable multiplier.
-/// </param>
-public record RequestCostOptions(
-    double MaxFieldCost,
-    double MaxTypeCost,
-    bool EnforceCostLimits,
-    int? FilterVariableMultiplier);
+public record RequestCostOptions
+{
+    /// <summary>
+    /// Request options for cost analysis.
+    /// </summary>
+    /// <param name="maxFieldCost">
+    /// The maximum allowed field cost.
+    /// </param>
+    /// <param name="maxTypeCost">
+    /// The maximum allowed type cost.
+    /// </param>
+    /// <param name="enforceCostLimits">
+    /// Defines if the analyzer shall enforce cost limits.
+    /// </param>
+    /// <param name="filterVariableMultiplier">
+    /// The filter variable multiplier.
+    /// </param>
+    public RequestCostOptions(
+        double maxFieldCost,
+        double maxTypeCost,
+        bool enforceCostLimits,
+        int? filterVariableMultiplier)
+    {
+        MaxFieldCost = maxFieldCost;
+        MaxTypeCost = maxTypeCost;
+        EnforceCostLimits = enforceCostLimits;
+        FilterVariableMultiplier = filterVariableMultiplier;
+    }
+
+    /// <summary>
+    /// Gets the maximum allowed field cost.
+    /// </summary>
+    /// <param name="maxFieldCost">
+    /// The maximum allowed field cost.
+    /// </param>
+    /// <param name="maxTypeCost">
+    /// The maximum allowed type cost.
+    /// </param>
+    /// <param name="enforceCostLimits">
+    /// Defines if the analyzer shall enforce cost limits.
+    /// </param>
+    /// <param name="skipAnalyzer">
+    /// Defines if the cost analyzer shall be skipped.
+    /// </param>
+    /// <param name="filterVariableMultiplier">
+    /// The filter variable multiplier.
+    /// </param>
+    public RequestCostOptions(
+        double maxFieldCost,
+        double maxTypeCost,
+        bool enforceCostLimits,
+        bool skipAnalyzer,
+        int? filterVariableMultiplier)
+    {
+        MaxFieldCost = maxFieldCost;
+        MaxTypeCost = maxTypeCost;
+        EnforceCostLimits = enforceCostLimits;
+        SkipAnalyzer = skipAnalyzer;
+        FilterVariableMultiplier = filterVariableMultiplier;
+    }
+
+    /// <summary>
+    /// Gets the maximum allowed field cost.
+    /// </summary>
+    public double MaxFieldCost { get; init; }
+
+    /// <summary>
+    /// Gets the maximum allowed type cost.
+    /// </summary>
+    public double MaxTypeCost { get; init; }
+
+    /// <summary>
+    /// Defines if the analyzer shall enforce cost limits.
+    /// </summary>
+    public bool EnforceCostLimits
+    {
+        get;
+        init
+        {
+            if (value)
+            {
+                SkipAnalyzer = false;
+            }
+
+            field = value;
+        }
+    }
+
+    /// <summary>
+    /// Defines if the cost analyzer shall be skipped.
+    /// </summary>
+    public bool SkipAnalyzer
+    {
+        get;
+        init
+        {
+            if (value)
+            {
+                EnforceCostLimits = false;
+            }
+
+            field = value;
+        }
+    }
+
+    /// <summary>
+    /// Gets the filter variable multiplier.
+    /// </summary>
+    public int? FilterVariableMultiplier { get; init; }
+
+    /// <summary>
+    /// Deconstructs the request options.
+    /// </summary>
+    /// <param name="maxFieldCost">
+    /// The maximum allowed field cost.
+    /// </param>
+    /// <param name="maxTypeCost">
+    /// The maximum allowed type cost.
+    /// </param>
+    /// <param name="enforceCostLimits">
+    /// Defines if the analyzer shall enforce cost limits.
+    /// </param>
+    /// <param name="skipAnalyzer">
+    /// Defines if the cost analyzer shall be skipped.
+    /// </param>
+    /// <param name="filterVariableMultiplier">
+    /// The filter variable multiplier.
+    /// </param>
+    public void Deconstruct(
+        out double maxFieldCost,
+        out double maxTypeCost,
+        out bool enforceCostLimits,
+        out bool skipAnalyzer,
+        out int? filterVariableMultiplier)
+    {
+        maxFieldCost = MaxFieldCost;
+        maxTypeCost = MaxTypeCost;
+        enforceCostLimits = EnforceCostLimits;
+        skipAnalyzer = SkipAnalyzer;
+        filterVariableMultiplier = FilterVariableMultiplier;
+    }
+}