Allow Zero Complexity (#6097)

* Allow Zero Complexity * cleanup
ChilliCream · Apr 28, 2023 · a4ab9e1 · a4ab9e1
1 parent 1cbc56e
commit a4ab9e1
Show file tree

Hide file tree

Showing 5 changed files with 177 additions and 16 deletions.
diff --git a/src/HotChocolate/Core/src/Types/Types/Directives/CostDirective.cs b/src/HotChocolate/Core/src/Types/Types/Directives/CostDirective.cs
@@ -1,8 +1,7 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
-using System.Runtime.Serialization;
-using HotChocolate.Language;
 using HotChocolate.Properties;
 
 namespace HotChocolate.Types;
@@ -11,17 +10,32 @@ namespace HotChocolate.Types;
 /// The cost directive can be used to express the expected
 /// cost that a resolver incurs on the system.
 /// </summary>
+#if NET6_0_OR_GREATER
+[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.NonPublicConstructors)]
+#endif
 public sealed class CostDirective
 {
+    /// <summary>
+    /// Initializes a new instance of <see cref="CostDirective"/>.
+    /// </summary>
     public CostDirective()
     {
         Complexity = 1;
         Multipliers = Array.Empty<MultiplierPathString>();
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="CostDirective"/>.
+    /// </summary>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <exception cref="ArgumentOutOfRangeException">
+    /// <paramref name="complexity"/> is less than 0.
+    /// </exception>
     public CostDirective(int complexity)
     {
-        if (complexity <= 0)
+        if (complexity < 0)
         {
             throw new ArgumentOutOfRangeException(
                 nameof(complexity),
@@ -33,11 +47,26 @@ public CostDirective(int complexity)
         Multipliers = Array.Empty<MultiplierPathString>();
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="CostDirective"/>.
+    /// </summary>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <param name="multipliers">
+    /// The multiplier paths.
+    /// </param>
+    /// <exception cref="ArgumentOutOfRangeException">
+    /// <paramref name="complexity"/> is less than 0.
+    /// </exception>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="multipliers"/> is <c>null</c>.
+    /// </exception>
     public CostDirective(
         int complexity,
         params MultiplierPathString[] multipliers)
     {
-        if (complexity <= 0)
+        if (complexity < 0)
         {
             throw new ArgumentOutOfRangeException(
                 nameof(complexity),
@@ -54,12 +83,30 @@ public CostDirective(
         Multipliers = multipliers.Where(t => t.HasValue).ToArray();
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="CostDirective"/>.
+    /// </summary>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <param name="defaultMultiplier">
+    /// The default multiplier.
+    /// </param>
+    /// <param name="multipliers">
+    /// The multiplier paths.
+    /// </param>
+    /// <exception cref="ArgumentOutOfRangeException">
+    /// <paramref name="complexity"/> is less than 0.
+    /// </exception>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="multipliers"/> is <c>null</c>.
+    /// </exception>
     public CostDirective(
         int complexity,
         int defaultMultiplier,
         params MultiplierPathString[] multipliers)
     {
-        if (complexity <= 0)
+        if (complexity < 0)
         {
             throw new ArgumentOutOfRangeException(
                 nameof(complexity),
@@ -85,6 +132,7 @@ public CostDirective(
         Multipliers = multipliers.Where(t => t.HasValue).ToArray();
     }
 
+    // this constructor is used for serialization.
     private CostDirective(
         int complexity,
         IReadOnlyList<MultiplierPathString> multipliers,
@@ -95,9 +143,18 @@ private CostDirective(
         DefaultMultiplier = defaultMultiplier;
     }
 
+    /// <summary>
+    /// Gets the complexity of the field.
+    /// </summary>
     public int Complexity { get; }
 
+    /// <summary>
+    /// Gets the multiplier paths.
+    /// </summary>
     public IReadOnlyList<MultiplierPathString> Multipliers { get; }
 
+    /// <summary>
+    /// Gets the default multiplier.
+    /// </summary>
     public int? DefaultMultiplier { get; }
 }
diff --git a/src/HotChocolate/Core/src/Types/Types/Directives/CostDirectiveType.cs b/src/HotChocolate/Core/src/Types/Types/Directives/CostDirectiveType.cs
@@ -1,5 +1,9 @@
 namespace HotChocolate.Types;
 
+/// <summary>
+/// The cost directive can be used to express the expected
+/// cost that a resolver incurs on the system.
+/// </summary>
 public sealed class CostDirectiveType : DirectiveType<CostDirective>
 {
     protected override void Configure(IDirectiveTypeDescriptor<CostDirective> descriptor)

diff --git a/src/HotChocolate/Core/src/Types/Types/Directives/CostInterfaceFieldDescriptorExtensions.cs b/src/HotChocolate/Core/src/Types/Types/Directives/CostInterfaceFieldDescriptorExtensions.cs
@@ -4,6 +4,22 @@ namespace HotChocolate.Types;
 
 public static class CostInterfaceFieldDescriptorExtensions
 {
+    /// <summary>
+    /// The cost directive can be used to express the expected
+    /// cost that a resolver incurs on the system.
+    /// </summary>
+    /// <param name="descriptor">
+    /// The interface field descriptor.
+    /// </param>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <returns>
+    /// Returns the object field descriptor for configuration chaining.
+    /// </returns>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="descriptor"/> is <c>null</c>.
+    /// </exception>
     public static IInterfaceFieldDescriptor Cost(
         this IInterfaceFieldDescriptor descriptor,
         int complexity)
@@ -16,6 +32,25 @@ public static IInterfaceFieldDescriptor Cost(
         return descriptor.Directive(new CostDirective(complexity));
     }
 
+    /// <summary>
+    /// The cost directive can be used to express the expected
+    /// cost that a resolver incurs on the system.
+    /// </summary>
+    /// <param name="descriptor">
+    /// The interface field descriptor.
+    /// </param>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <param name="multiplier">
+    /// The multiplier path.
+    /// </param>
+    /// <returns>
+    /// Returns the object field descriptor for configuration chaining.
+    /// </returns>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="descriptor"/> is <c>null</c>.
+    /// </exception>
     public static IInterfaceFieldDescriptor Cost(
         this IInterfaceFieldDescriptor descriptor,
         int complexity,
@@ -26,10 +61,26 @@ public static IInterfaceFieldDescriptor Cost(
             throw new ArgumentNullException(nameof(descriptor));
         }
 
-        return descriptor.Directive(
-            new CostDirective(complexity, multiplier));
+        return descriptor.Directive(new CostDirective(complexity, multiplier));
     }
 
+    /// <summary>
+    /// The cost directive can be used to express the expected
+    /// cost that a resolver incurs on the system.
+    /// </summary>
+    /// <param name="descriptor">
+    /// The interface field descriptor.
+    /// </param>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <param name="multipliers">
+    /// The multiplier paths.
+    /// </param>
+    /// <returns></returns>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="descriptor"/> is <c>null</c>.
+    /// </exception>
     public static IInterfaceFieldDescriptor Cost(
         this IInterfaceFieldDescriptor descriptor,
         int complexity,
@@ -40,7 +91,6 @@ public static IInterfaceFieldDescriptor Cost(
             throw new ArgumentNullException(nameof(descriptor));
         }
 
-        return descriptor.Directive(
-            new CostDirective(complexity, multipliers));
+        return descriptor.Directive(new CostDirective(complexity, multipliers));
     }
 }
diff --git a/src/HotChocolate/Core/src/Types/Types/Directives/CostObjectFieldDescriptorExtensions.cs b/src/HotChocolate/Core/src/Types/Types/Directives/CostObjectFieldDescriptorExtensions.cs
@@ -4,6 +4,22 @@ namespace HotChocolate.Types;
 
 public static class CostObjectFieldDescriptorExtensions
 {
+    /// <summary>
+    /// The cost directive can be used to express the expected
+    /// cost that a resolver incurs on the system.
+    /// </summary>
+    /// <param name="descriptor">
+    /// The object field descriptor.
+    /// </param>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <returns>
+    /// Returns the object field descriptor for configuration chaining.
+    /// </returns>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="descriptor"/> is <c>null</c>.
+    /// </exception>
     public static IObjectFieldDescriptor Cost(
         this IObjectFieldDescriptor descriptor,
         int complexity)
@@ -16,6 +32,25 @@ public static IObjectFieldDescriptor Cost(
         return descriptor.Directive(new CostDirective(complexity));
     }
 
+    /// <summary>
+    /// The cost directive can be used to express the expected
+    /// cost that a resolver incurs on the system.
+    /// </summary>
+    /// <param name="descriptor">
+    /// The object field descriptor.
+    /// </param>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <param name="multiplier">
+    /// The multiplier path.
+    /// </param>
+    /// <returns>
+    /// Returns the object field descriptor for configuration chaining.
+    /// </returns>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="descriptor"/> is <c>null</c>.
+    /// </exception>
     public static IObjectFieldDescriptor Cost(
         this IObjectFieldDescriptor descriptor,
         int complexity,
@@ -26,10 +61,26 @@ public static IObjectFieldDescriptor Cost(
             throw new ArgumentNullException(nameof(descriptor));
         }
 
-        return descriptor.Directive(
-            new CostDirective(complexity, multiplier));
+        return descriptor.Directive(new CostDirective(complexity, multiplier));
     }
 
+    /// <summary>
+    /// The cost directive can be used to express the expected
+    /// cost that a resolver incurs on the system.
+    /// </summary>
+    /// <param name="descriptor">
+    /// The object field descriptor.
+    /// </param>
+    /// <param name="complexity">
+    /// The complexity of the field.
+    /// </param>
+    /// <param name="multipliers">
+    /// The multiplier paths.
+    /// </param>
+    /// <returns></returns>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="descriptor"/> is <c>null</c>.
+    /// </exception>
     public static IObjectFieldDescriptor Cost(
         this IObjectFieldDescriptor descriptor,
         int complexity,
@@ -40,7 +91,6 @@ public static IObjectFieldDescriptor Cost(
             throw new ArgumentNullException(nameof(descriptor));
         }
 
-        return descriptor.Directive(
-            new CostDirective(complexity, multipliers));
+        return descriptor.Directive(new CostDirective(complexity, multipliers));
     }
 }
diff --git a/src/HotChocolate/Core/test/Types.Tests/Types/Directives/CostDirectiveTests.cs b/src/HotChocolate/Core/test/Types.Tests/Types/Directives/CostDirectiveTests.cs
@@ -6,12 +6,12 @@ namespace HotChocolate.Types.Directives;
 public class CostDirectiveTests
 {
     [Fact]
-    public void ComplexityEqualsZero()
+    public void ComplexitySmallerThanZero()
     {
         // arrange
         // act
-        void Action() => new CostDirective(0);
-        void Action1() => new CostDirective(0, "a");
+        void Action() => new CostDirective(-1);
+        void Action1() => new CostDirective(-1, "a");
 
         // assert
         Assert.Throws<ArgumentOutOfRangeException>(Action);