Merge pull request #5320 from rmosolgo/resolver-deprecation-reason

Add Resolver.deprecation_reason

Author: rmosolgo

lib/graphql/schema/directive/flagged.rb

@@ -37,6 +37,8 @@ def initialize(target, **options)
 
         argument :by, [String], "Flags to check for this schema member"
 
+        repeatable(true)
+
         module VisibleByFlag
           def self.included(schema_class)
             schema_class.extend(self)

lib/graphql/schema/field.rb

@@ -41,10 +41,24 @@ def resolver_method
         end
       end
 
+      # @return [String, nil]
+      def deprecation_reason
+        super || @resolver_class&.deprecation_reason
+      end
+
       def directives
         if @resolver_class && !(r_dirs = @resolver_class.directives).empty?
           if !(own_dirs = super).empty?
-            own_dirs + r_dirs
+            new_dirs = own_dirs.dup
+            r_dirs.each do |r_dir|
+              if r_dir.class.repeatable? ||
+                ( (r_dir_name = r_dir.graphql_name) &&
+                  (!new_dirs.any? { |d| d.graphql_name == r_dir_name })
+                )
+                new_dirs << r_dir
+              end
+            end
+            new_dirs
           else
             r_dirs
           end

lib/graphql/schema/member/has_deprecation_reason.rb

@@ -18,6 +18,21 @@ def deprecation_reason=(text)
             directive(GraphQL::Schema::Directive::Deprecated, reason: text)
           end
         end
+
+        def self.extended(child_class)
+          super
+          child_class.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def deprecation_reason(new_reason = NOT_CONFIGURED)
+            if NOT_CONFIGURED.equal?(new_reason)
+              super()
+            else
+              self.deprecation_reason = new_reason
+            end
+          end
+        end
       end
     end
   end

lib/graphql/schema/resolver.rb

@@ -28,6 +28,7 @@ class Resolver
       extend Schema::Member::HasPath
       extend Schema::Member::HasDirectives
       include Schema::Member::HasDataloader
+      extend Schema::Member::HasDeprecationReason
 
       # @param object [Object] The application object that this field is being resolved on
       # @param context [GraphQL::Query::Context]

spec/graphql/schema/resolver_spec.rb

@@ -1200,10 +1200,17 @@ class GetThingWithoutDirective < GraphQL::Schema::Resolver
         type String, null: false
       end
 
+      class GetThingDeprecated < GraphQL::Schema::Resolver
+        type String, null: false
+        deprecation_reason("Use something else instead")
+      end
+
       class Query < GraphQL::Schema::Object
         field :get_thing, resolver: GetThing
         field :get_thing_flagged, resolver: GetThing, directives: { GraphQL::Schema::Directive::Flagged => { by: "getThingFlagged" } }
         field :get_thing_field, resolver: GetThingWithoutDirective, directives: { GraphQL::Schema::Directive::Flagged => { by: "getField" } }
+        field :get_thing_deprecated, resolver: GetThingDeprecated
+        field :get_thing_double_deprecated, resolver: GetThingDeprecated, deprecation_reason: "Overridden reason"
       end
 
       query(Query)
@@ -1220,15 +1227,19 @@ class Query < GraphQL::Schema::Object
       Flags to check for this schema member
       """
       by: [String!]!
-    ) on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION
+    ) repeatable on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION
 
     type Query {
       getThing(id: ID!): String! @flagged(by: ["getThing"])
+      getThingDeprecated: String! @deprecated(reason: "Use something else instead")
+      getThingDoubleDeprecated: String! @deprecated(reason: "Overridden reason")
       getThingField(id: ID!): String! @flagged(by: ["getField"])
       getThingFlagged(id: ID!): String! @flagged(by: ["getThingFlagged"]) @flagged(by: ["getThing"])
     }
     GRAPHQL
 
     assert_equal expected_str, ResolverDirectivesSchema.to_definition(context: { flags: ["getField", "getThing", "getThingFlagged"] })
+    assert_equal "Use something else instead", ResolverDirectivesSchema.get_field("Query", "getThingDeprecated").deprecation_reason
+    assert_equal "Overridden reason", ResolverDirectivesSchema.get_field("Query", "getThingDoubleDeprecated").deprecation_reason
   end
 end