Add DoNotRegisterAttribute (graphql-dotnet#2810)

Author: sungam3r

docs2/site/docs/getting-started/dependency-injection.md

@@ -163,8 +163,8 @@ injection provider, or their `Dispose` methods will not be called. Any dependenc
 
 You can also use the `services.AddGraphTypes()` extension method from the [server](https://github.com/graphql-dotnet/server)
 project to scan the calling assembly for classes that implement `IGraphType` and register them all as singletons
-within the service provider. For additional options and overloads of this method, see
-[GraphQLBuilderCoreExtensions.cs](https://github.com/graphql-dotnet/server/blob/master/src/Core/Extensions/GraphQLBuilderCoreExtensions.cs).
+within the service provider. Mark your class with `DoNotRegisterAttribute` if you want to skip registration.
+For additional options and overloads of this method, see [GraphQLBuilderCoreExtensions.cs](https://github.com/graphql-dotnet/server/blob/master/src/Core/Extensions/GraphQLBuilderCoreExtensions.cs).
 
 ## Nancy TinyIoCContainer
 

src/GraphQL.ApiTests/net6/GraphQL.approved.txt

@@ -54,6 +54,11 @@ namespace GraphQL
     {
         public DoNotMapClrTypeAttribute() { }
     }
+    [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
+    public sealed class DoNotRegisterAttribute : System.Attribute
+    {
+        public DoNotRegisterAttribute() { }
+    }
     public class DocumentExecuter : GraphQL.IDocumentExecuter
     {
         public DocumentExecuter() { }

src/GraphQL.ApiTests/netstandard20+netstandard21/GraphQL.approved.txt

@@ -54,6 +54,11 @@ namespace GraphQL
     {
         public DoNotMapClrTypeAttribute() { }
     }
+    [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
+    public sealed class DoNotRegisterAttribute : System.Attribute
+    {
+        public DoNotRegisterAttribute() { }
+    }
     public class DocumentExecuter : GraphQL.IDocumentExecuter
     {
         public DocumentExecuter() { }

src/GraphQL.Tests/DI/GraphQLBuilderTests.cs

@@ -666,6 +666,7 @@ public void AddErrorInfoProvider_Null()
         public void AddGraphTypes()
         {
             var typeList = new Type[] {
+                typeof(MyGraphNotRegistered),
                 typeof(MyGraph),
                 typeof(MyScalar),
                 typeof(IGraphType),
@@ -1411,6 +1412,11 @@ private class MyGraph : ObjectGraphType
         {
         }
 
+        [DoNotRegister]
+        private class MyGraphNotRegistered : ObjectGraphType
+        {
+        }
+
         private class MyScalar : IntGraphType
         {
         }

src/GraphQL/AssemblyExtensions.cs

@@ -60,7 +60,7 @@ internal static class AssemblyExtensions
                         var clrType = baseType.GetGenericArguments()[0];
 
                         //as long as it's not of type 'object', register it
-                        if (clrType != typeof(object))
+                        if (clrType != typeof(object) && !clrType.IsDefined(typeof(DoNotMapClrTypeAttribute)))
                             typeMappings.Add((clrType, graphType));
 
                         //skip to the next type

src/GraphQL/DoNotRegisterAttribute.cs

@@ -0,0 +1,14 @@
+using System;
+using GraphQL.Types;
+
+namespace GraphQL
+{
+    /// <summary>
+    /// Indicates that <see cref="GraphQLBuilderExtensions.AddGraphTypes(DI.IGraphQLBuilder, System.Reflection.Assembly)"/>
+    /// should skip this class when scanning an assembly for classes that implement <see cref="IGraphType"/>
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
+    public sealed class DoNotRegisterAttribute : Attribute
+    {
+    }
+}

src/GraphQL/GraphQLBuilderExtensions.cs

@@ -393,6 +393,8 @@ public static IGraphQLBuilder AddGraphTypes(this IGraphQLBuilder builder)
         /// the graph types will effectively be scoped graph types. If the schema is a singleton schema,
         /// the graph types will effectively be singleton graph types.
         /// <br/><br/>
+        /// Skips classes where the class is marked with the <see cref="DoNotRegisterAttribute"/>.
+        /// <br/><br/>
         /// Also registers <see cref="EnumerationGraphType{TEnum}"/>, <see cref="ConnectionType{TNodeType}"/>,
         /// <see cref="ConnectionType{TNodeType, TEdgeType}"/>, <see cref="EdgeType{TNodeType}"/>,
         /// <see cref="InputObjectGraphType{TSourceType}"/>, <see cref="AutoRegisteringInputObjectGraphType{TSourceType}"/>, and
@@ -409,7 +411,7 @@ public static IGraphQLBuilder AddGraphTypes(this IGraphQLBuilder builder, Assemb
                 throw new ArgumentNullException(nameof(assembly));
 
             foreach (var type in assembly.GetTypes()
-                .Where(x => x.IsClass && !x.IsAbstract && typeof(IGraphType).IsAssignableFrom(x)))
+                .Where(x => x.IsClass && !x.IsAbstract && typeof(IGraphType).IsAssignableFrom(x) && !x.IsDefined(typeof(DoNotRegisterAttribute))))
             {
                 builder.TryRegister(type, type, ServiceLifetime.Transient);
             }