Allow to set custom filter handler (#2563)

ChilliCream · Nov 17, 2020 · 076e37c · 076e37c
1 parent 3dccf3a
commit 076e37c
Show file tree

Hide file tree

Showing 3 changed files with 97 additions and 13 deletions.
diff --git a/src/HotChocolate/Data/src/Data/Filters/Convention/FilterTypeInterceptor.cs b/src/HotChocolate/Data/src/Data/Filters/Convention/FilterTypeInterceptor.cs
@@ -9,8 +9,8 @@ namespace HotChocolate.Data.Filters
     public class FilterTypeInterceptor
         : TypeInterceptor
     {
-        private readonly Dictionary<string, IFilterConvention> _conventions
-            = new Dictionary<string, IFilterConvention>();
+        private readonly Dictionary<string, IFilterConvention> _conventions =
+            new Dictionary<string, IFilterConvention>();
 
         public override bool CanHandle(ITypeSystemObjectContext context) => true;
 
@@ -48,19 +48,22 @@ public class FilterTypeInterceptor
                             field.Type = field.Type.With(scope: discoveryContext.Scope);
                         }
 
-                        if (convention.TryGetHandler(
-                            discoveryContext,
-                            def,
-                            filterFieldDefinition,
-                            out IFilterFieldHandler? handler))
+                        if (filterFieldDefinition.Handler is null)
                         {
-                            filterFieldDefinition.Handler = handler;
-                        }
-                        else
-                        {
-                            throw ThrowHelper.FilterInterceptor_NoHandlerFoundForField(
+                            if (convention.TryGetHandler(
+                                discoveryContext,
                                 def,
-                                filterFieldDefinition);
+                                filterFieldDefinition,
+                                out IFilterFieldHandler? handler))
+                            {
+                                filterFieldDefinition.Handler = handler;
+                            }
+                            else
+                            {
+                                throw ThrowHelper.FilterInterceptor_NoHandlerFoundForField(
+                                    def,
+                                    filterFieldDefinition);
+                            }
                         }
                     }
                 }
@@ -92,6 +95,7 @@ public class FilterTypeInterceptor
                 convention = context.GetFilterConvention(scope);
                 _conventions[scope ?? ""] = convention;
             }
+
             return convention;
         }
     }

diff --git a/src/HotChocolate/Data/src/Data/Filters/FilterFieldDefinition.cs b/src/HotChocolate/Data/src/Data/Filters/FilterFieldDefinition.cs
@@ -16,3 +16,4 @@ public class FilterFieldDefinition
         public string? Scope { get; set; }
     }
 }
+
diff --git a/src/HotChocolate/Data/test/Data.Filters.Tests/FilterInputTypeTests.cs b/src/HotChocolate/Data/test/Data.Filters.Tests/FilterInputTypeTests.cs
@@ -1,7 +1,9 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using HotChocolate.Configuration;
 using HotChocolate.Data.Filters;
+using HotChocolate.Data.Filters.Expressions;
 using HotChocolate.Language;
 using HotChocolate.Types;
 using Snapshooter.Xunit;
@@ -293,6 +295,45 @@ public void FilterInputType_Should_UseCustomFilterType_When_Nested()
             builder.Create().Print().MatchSnapshot();
         }
 
+        [Fact]
+        public void FilterInputType_Should_NotOverrideHandler_OnBeforeCreate()
+        {
+            // arrange
+            ISchema builder = SchemaBuilder.New()
+                .AddFiltering()
+                .AddQueryType<CustomHandlerQueryType >()
+                .Create();
+
+            // act
+            builder.TryGetType<CustomHandlerFilterInputType>(
+                "TestName",
+                out CustomHandlerFilterInputType? type);
+
+            // assert
+            Assert.NotNull(type);
+            Assert.IsType<CustomHandler>(Assert.IsType<FilterField>(type.Fields["id"]).Handler);
+        }
+
+        [Fact]
+        public void FilterInputType_Should_NotOverrideHandler_OnBeforeCompletion()
+        {
+            // arrange
+            ISchema builder = SchemaBuilder.New()
+                .AddFiltering()
+                .AddQueryType<CustomHandlerQueryType >()
+                .Create();
+
+            // act
+            builder.TryGetType<CustomHandlerFilterInputType>(
+                "TestName",
+                out CustomHandlerFilterInputType? type);
+
+            // assert
+            Assert.NotNull(type);
+            Assert.IsType<CustomHandler>(Assert.IsType<FilterField>(type.Fields["friends"]).Handler);
+            Assert.IsType<QueryableDefaultFieldHandler>(Assert.IsType<FilterField>(type.Fields["name"]).Handler);
+        }
+
         public class FooDirectiveType
             : DirectiveType<FooDirective>
         {
@@ -378,5 +419,43 @@ protected override void Configure(IObjectTypeDescriptor<User> descriptor)
                     .UseFiltering<UserFilterInputType>();
             }
         }
+
+        public class CustomHandlerFilterInputType : FilterInputType<User>
+        {
+            protected override void Configure(IFilterInputTypeDescriptor<User> descriptor)
+            {
+                descriptor.Name("TestName");
+                descriptor.Field(x => x.Id)
+                    .Extend()
+                    .OnBeforeCreate(x => x.Handler = new CustomHandler());
+
+                descriptor.Field(x => x.Friends)
+                    .Extend()
+                    .OnBeforeCompletion((ctx, x) => x.Handler = new CustomHandler());
+            }
+        }
+
+        public class CustomHandlerQueryType : ObjectType<User>
+        {
+            protected override void Configure(IObjectTypeDescriptor<User> descriptor)
+            {
+                descriptor.Name(nameof(Query));
+                descriptor
+                    .Field("foo")
+                    .Resolve(new List<User>())
+                    .UseFiltering<CustomHandlerFilterInputType>();
+            }
+        }
+
+        public class CustomHandler : IFilterFieldHandler
+        {
+            public bool CanHandle(
+                ITypeDiscoveryContext context,
+                IFilterInputTypeDefinition typeDefinition,
+                IFilterFieldDefinition fieldDefinition)
+            {
+                throw new NotImplementedException();
+            }
+        }
     }
 }