graphql 1.12.24 → 1.13.19

data/lib/graphql/schema/subscription.rb

@@ -103,10 +103,12 @@ module GraphQL
       # Call this method to provide a new subscription_scope; OR
       # call it without an argument to get the subscription_scope
       # @param new_scope [Symbol]
+      # @param optional [Boolean] If true, then don't require `scope:` to be provided to updates to this subscription.
       # @return [Symbol]
-      def self.subscription_scope(new_scope = READING_SCOPE)
+      def self.subscription_scope(new_scope = READING_SCOPE, optional: false)
         if new_scope != READING_SCOPE
           @subscription_scope = new_scope
+          @subscription_scope_optional = optional
         elsif defined?(@subscription_scope)
           @subscription_scope
         else
@@ -114,6 +116,14 @@ module GraphQL
         end
       end
 
+      def self.subscription_scope_optional?
+        if defined?(@subscription_scope_optional)
+          @subscription_scope_optional
+        else
+          find_inherited_value(:subscription_scope_optional, false)
+        end
+      end
+
       # This is called during initial subscription to get a "name" for this subscription.
       # Later, when `.trigger` is called, this will be called again to build another "name".
       # Any subscribers with matching topic will begin the update flow.

data/lib/graphql/schema/traversal.rb

@@ -173,7 +173,7 @@ Some late-bound types couldn't be resolved:
           end
         when Class
           if member.respond_to?(:graphql_definition)
-            graphql_member = member.graphql_definition
+            graphql_member = member.graphql_definition(silence_deprecation_warning: true)
             visit(schema, graphql_member, context_description)
           else
             raise GraphQL::Schema::InvalidTypeError.new("Unexpected traversal member: #{member} (#{member.class.name})")

data/lib/graphql/schema/type_expression.rb

@@ -11,7 +11,7 @@ module GraphQL
       def self.build_type(type_owner, ast_node)
         case ast_node
         when GraphQL::Language::Nodes::TypeName
-          type_owner.get_type(ast_node.name)
+          type_owner.get_type(ast_node.name) # rubocop:disable Development/ContextIsPassedCop -- this is a `context` or `warden`, it's already query-aware
         when GraphQL::Language::Nodes::NonNullType
           ast_inner_type = ast_node.of_type
           inner_type = build_type(type_owner, ast_inner_type)

data/lib/graphql/schema/type_membership.rb

@@ -4,8 +4,6 @@ module GraphQL
   class Schema
     # This class joins an object type to an abstract type (interface or union) of which
     # it is a member.
-    #
-    # TODO: Not yet implemented for interfaces.
     class TypeMembership
       # @return [Class<GraphQL::Schema::Object>]
       attr_accessor :object_type
@@ -26,9 +24,25 @@ module GraphQL
       end
 
       # @return [Boolean] if false, {#object_type} will be treated as _not_ a member of {#abstract_type}
-      def visible?(_ctx)
-        true
+      def visible?(ctx)
+        warden = Warden.from_context(ctx)
+        (@object_type.respond_to?(:visible?) ? warden.visible_type?(@object_type, ctx) : true) &&
+          (@abstract_type.respond_to?(:visible?) ? warden.visible_type?(@abstract_type, ctx) : true)
       end
+
+      def graphql_name
+        "#{@object_type.graphql_name}.#{@abstract_type.kind.interface? ? "implements" : "belongsTo" }.#{@abstract_type.graphql_name}"
+      end
+
+      def path
+        graphql_name
+      end
+
+      def inspect
+        "#<#{self.class} #{@object_type.inspect} => #{@abstract_type.inspect}>"
+      end
+
+      alias :type_class :itself
     end
   end
 end

data/lib/graphql/schema/union.rb

@@ -19,8 +19,9 @@ module GraphQL
             end
           else
             visible_types = []
+            warden = Warden.from_context(context)
             type_memberships.each do |type_membership|
-              if type_membership.visible?(context)
+              if warden.visible_type_membership?(type_membership, context)
                 visible_types << type_membership.object_type
               end
             end
@@ -28,6 +29,12 @@ module GraphQL
           end
         end
 
+        def all_possible_types
+          type_memberships.map(&:object_type)
+        end
+
+        prepend GraphQL::Schema::Member::CachedGraphQLDefinition::DeprecatedToGraphQL
+
         def to_graphql
           type_defn = GraphQL::UnionType.new
           type_defn.name = graphql_name

data/lib/graphql/schema/validator/format_validator.rb

@@ -18,10 +18,6 @@ module GraphQL
       #   # It's pretty hard to come up with a legitimate use case for `without:`
       #
       class FormatValidator < Validator
-        if !String.method_defined?(:match?)
-          using GraphQL::StringMatchBackport
-        end
-
         # @param with [RegExp, nil]
         # @param without [Regexp, nil]
         # @param message [String]

data/lib/graphql/schema/validator/numericality_validator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   class Schema
     class Validator

data/lib/graphql/schema/validator/required_validator.rb

@@ -14,7 +14,7 @@ module GraphQL
       #     argument :ingredient_id, ID, required: true
       #     argument :cups, Integer, required: false
       #     argument :tablespoons, Integer, required: false
-      #     argument :teaspoons, Integer, required: true
+      #     argument :teaspoons, Integer, required: false
       #     validates required: { one_of: [:cups, :tablespoons, :teaspoons] }
       #   end
       #
@@ -28,11 +28,23 @@ module GraphQL
       #    validates required: { one_of: [:node_id, [:object_type, :object_id]] }
       #  end
       #
+      # @example require _some_ value for an argument, even if it's null
+      #   field :update_settings, AccountSettings do
+      #     # `required: :nullable` means this argument must be given, but may be `null`
+      #     argument :age, Integer, required: :nullable
+      #   end
+      #
       class RequiredValidator < Validator
         # @param one_of [Symbol, Array<Symbol>] An argument, or a list of arguments, that represents a valid set of inputs for this field
         # @param message [String]
-        def initialize(one_of:, message: "%{validated} has the wrong arguments", **default_options)
-          @one_of = one_of
+        def initialize(one_of: nil, argument: nil, message: "%{validated} has the wrong arguments", **default_options)
+          @one_of = if one_of
+            one_of
+          elsif argument
+            [argument]
+          else
+            raise ArgumentError, "`one_of:` or `argument:` must be given in `validates required: {...}`"
+          end
           @message = message
           super(**default_options)
         end
@@ -40,19 +52,21 @@ module GraphQL
         def validate(_object, _context, value)
           matched_conditions = 0
 
-          @one_of.each do |one_of_condition|
-            case one_of_condition
-            when Symbol
-              if value.key?(one_of_condition)
-                matched_conditions += 1
-              end
-            when Array
-              if one_of_condition.all? { |k| value.key?(k) }
-                matched_conditions += 1
-                break
+          if !value.nil?
+            @one_of.each do |one_of_condition|
+              case one_of_condition
+              when Symbol
+                if value.key?(one_of_condition)
+                  matched_conditions += 1
+                end
+              when Array
+                if one_of_condition.all? { |k| value.key?(k) }
+                  matched_conditions += 1
+                  break
+                end
+              else
+                raise ArgumentError, "Unknown one_of condition: #{one_of_condition.inspect}"
               end
-            else
-              raise ArgumentError, "Unknown one_of condition: #{one_of_condition.inspect}"
             end
           end
 

data/lib/graphql/schema/validator.rb

@@ -48,16 +48,13 @@ module GraphQL
           EMPTY_ARRAY
         else
           validates_hash = validates_hash.dup
-          allow_null = validates_hash.delete(:allow_null)
-          allow_blank = validates_hash.delete(:allow_blank)
 
-          # This could be {...}.compact on Ruby 2.4+
           default_options = {}
-          if !allow_null.nil?
-            default_options[:allow_null] = allow_null
+          if validates_hash[:allow_null]
+            default_options[:allow_null] = validates_hash.delete(:allow_null)
           end
-          if !allow_blank.nil?
-            default_options[:allow_blank] = allow_blank
+          if validates_hash[:allow_blank]
+            default_options[:allow_blank] = validates_hash.delete(:allow_blank)
           end
 
           # allow_nil or allow_blank are the _only_ validations:

data/lib/graphql/schema/warden.rb

@@ -37,6 +37,52 @@ module GraphQL
     #
     # @api private
     class Warden
+      def self.from_context(context)
+        (context.respond_to?(:warden) && context.warden) || PassThruWarden
+      end
+
+      # @param visibility_method [Symbol] a Warden method to call for this entry
+      # @param entry [Object, Array<Object>] One or more definitions for a given name in a GraphQL Schema
+      # @param context [GraphQL::Query::Context]
+      # @param warden [Warden]
+      # @return [Object] `entry` or one of `entry`'s items if exactly one of them is visible for this context
+      # @return [nil] If neither `entry` nor any of `entry`'s items are visible for this context
+      def self.visible_entry?(visibility_method, entry, context, warden = Warden.from_context(context))
+        if entry.is_a?(Array)
+          visible_item = nil
+          entry.each do |item|
+            if warden.public_send(visibility_method, item, context)
+              if visible_item.nil?
+                visible_item = item
+              else
+                raise Schema::DuplicateNamesError, "Found two visible definitions for `#{item.path}`: #{visible_item.inspect}, #{item.inspect}"
+              end
+            end
+          end
+          visible_item
+        elsif warden.public_send(visibility_method, entry, context)
+          entry
+        else
+          nil
+        end
+      end
+
+      # This is used when a caller provides a Hash for context.
+      # We want to call the schema's hooks, but we don't have a full-blown warden.
+      # The `context` arguments to these methods exist purely to simplify the code that
+      # calls methods on this object, so it will have everything it needs.
+      class PassThruWarden
+        class << self
+          def visible_field?(field, ctx); field.visible?(ctx); end
+          def visible_argument?(arg, ctx); arg.visible?(ctx); end
+          def visible_type?(type, ctx); type.visible?(ctx); end
+          def visible_enum_value?(ev, ctx); ev.visible?(ctx); end
+          def visible_type_membership?(tm, ctx); tm.visible?(ctx); end
+          def interface_type_memberships(obj_t, ctx); obj_t.interface_type_memberships; end
+          def arguments(owner, ctx); owner.arguments(ctx); end
+        end
+      end
+
       # @param filter [<#call(member)>] Objects are hidden when `.call(member, ctx)` returns true
       # @param context [GraphQL::Query::Context]
       # @param schema [GraphQL::Schema]
@@ -54,8 +100,8 @@ module GraphQL
       def types
         @types ||= begin
           vis_types = {}
-          @schema.types.each do |n, t|
-            if visible_type?(t)
+          @schema.types(@context).each do |n, t|
+            if visible_and_reachable_type?(t)
               vis_types[n] = t
             end
           end
@@ -66,8 +112,8 @@ module GraphQL
       # @return [GraphQL::BaseType, nil] The type named `type_name`, if it exists (else `nil`)
       def get_type(type_name)
         @visible_types ||= read_through do |name|
-          type_defn = @schema.get_type(name)
-          if type_defn && visible_type?(type_defn)
+          type_defn = @schema.get_type(name, @context)
+          if type_defn && visible_and_reachable_type?(type_defn)
             type_defn
           else
             nil
@@ -84,7 +130,7 @@ module GraphQL
 
       # @return Boolean True if the type is visible and reachable in the schema
       def reachable_type?(type_name)
-        type = get_type(type_name)
+        type = get_type(type_name) # rubocop:disable Development/ContextIsPassedCop -- `self` is query-aware
         type && reachable_type_set.include?(type)
       end
 
@@ -92,8 +138,8 @@ module GraphQL
       def get_field(parent_type, field_name)
         @visible_parent_fields ||= read_through do |type|
           read_through do |f_name|
-            field_defn = @schema.get_field(type, f_name)
-            if field_defn && visible_field?(type, field_defn)
+            field_defn = @schema.get_field(type, f_name, @context)
+            if field_defn && visible_field?(field_defn, nil, type)
               field_defn
             else
               nil
@@ -106,15 +152,15 @@ module GraphQL
 
       # @return [GraphQL::Argument, nil] The argument named `argument_name` on `parent_type`, if it exists and is visible
       def get_argument(parent_type, argument_name)
-        argument = parent_type.get_argument(argument_name)
-        return argument if argument && visible_argument?(argument)
+        argument = parent_type.get_argument(argument_name, @context)
+        return argument if argument && visible_argument?(argument, @context)
       end
 
       # @return [Array<GraphQL::BaseType>] The types which may be member of `type_defn`
       def possible_types(type_defn)
         @visible_possible_types ||= read_through { |type_defn|
           pt = @schema.possible_types(type_defn, @context)
-          pt.select { |t| visible_type?(t) }
+          pt.select { |t| visible_and_reachable_type?(t) }
         }
         @visible_possible_types[type_defn]
       end
@@ -122,26 +168,31 @@ module GraphQL
       # @param type_defn [GraphQL::ObjectType, GraphQL::InterfaceType]
       # @return [Array<GraphQL::Field>] Fields on `type_defn`
       def fields(type_defn)
-        @visible_fields ||= read_through { |t| @schema.get_fields(t).each_value.select { |f| visible_field?(t, f) } }
+        @visible_fields ||= read_through { |t| @schema.get_fields(t, @context).values }
         @visible_fields[type_defn]
       end
 
       # @param argument_owner [GraphQL::Field, GraphQL::InputObjectType]
       # @return [Array<GraphQL::Argument>] Visible arguments on `argument_owner`
-      def arguments(argument_owner)
-        @visible_arguments ||= read_through { |o| o.arguments.each_value.select { |a| visible_argument?(a) } }
+      def arguments(argument_owner, ctx = nil)
+        @visible_arguments ||= read_through { |o| o.arguments(@context).each_value.select { |a| visible_argument?(a, @context) } }
         @visible_arguments[argument_owner]
       end
 
       # @return [Array<GraphQL::EnumType::EnumValue>] Visible members of `enum_defn`
       def enum_values(enum_defn)
-        @visible_enum_values ||= read_through { |e| e.values.each_value.select { |enum_value_defn| visible?(enum_value_defn) } }
-        @visible_enum_values[enum_defn]
+        @visible_enum_arrays ||= read_through { |e| e.enum_values(@context) }
+        @visible_enum_arrays[enum_defn]
+      end
+
+      def visible_enum_value?(enum_value, _ctx = nil)
+        @visible_enum_values ||= read_through { |ev| visible?(ev) }
+        @visible_enum_values[enum_value]
       end
 
       # @return [Array<GraphQL::InterfaceType>] Visible interfaces implemented by `obj_type`
       def interfaces(obj_type)
-        @visible_interfaces ||= read_through { |t| t.interfaces(@context).select { |i| visible?(i) } }
+        @visible_interfaces ||= read_through { |t| t.interfaces(@context).select { |i| visible_type?(i) } }
         @visible_interfaces[obj_type]
       end
 
@@ -158,25 +209,59 @@ module GraphQL
         end
       end
 
-      private
-
-      def union_memberships(obj_type)
-        @unions ||= read_through { |obj_type| @schema.union_memberships(obj_type).select { |u| visible?(u) } }
-        @unions[obj_type]
-      end
-
-      def visible_argument?(arg_defn)
-        visible?(arg_defn) && visible_type?(arg_defn.type.unwrap)
-      end
-
-      def visible_field?(owner_type, field_defn)
+      # @param owner [Class, Module] If provided, confirm that field has the given owner.
+      def visible_field?(field_defn, _ctx = nil, owner = field_defn.owner)
         # This field is visible in its own right
         visible?(field_defn) &&
           # This field's return type is visible
-          visible_type?(field_defn.type.unwrap) &&
+          visible_and_reachable_type?(field_defn.type.unwrap) &&
           # This field is either defined on this object type,
           # or the interface it's inherited from is also visible
-          ((field_defn.respond_to?(:owner) && field_defn.owner == owner_type) || field_on_visible_interface?(field_defn, owner_type))
+          ((field_defn.respond_to?(:owner) && field_defn.owner == owner) || field_on_visible_interface?(field_defn, owner))
+      end
+
+      def visible_argument?(arg_defn, _ctx = nil)
+        visible?(arg_defn) && visible_and_reachable_type?(arg_defn.type.unwrap)
+      end
+
+      def visible_type?(type_defn, _ctx = nil)
+        @type_visibility ||= read_through { |type_defn| visible?(type_defn) }
+        @type_visibility[type_defn]
+      end
+
+      def visible_type_membership?(type_membership, _ctx = nil)
+        visible?(type_membership)
+      end
+
+      def interface_type_memberships(obj_type, _ctx = nil)
+        @type_memberships ||= read_through do |obj_t|
+          obj_t.interface_type_memberships
+        end
+        @type_memberships[obj_type]
+      end
+
+      private
+
+      def visible_and_reachable_type?(type_defn)
+        @visible_and_reachable_type ||= read_through do |type_defn|
+          next false unless visible_type?(type_defn)
+          next true if root_type?(type_defn) || type_defn.introspection?
+
+          if type_defn.kind.union?
+            visible_possible_types?(type_defn) && (referenced?(type_defn) || orphan_type?(type_defn))
+          elsif type_defn.kind.interface?
+            visible_possible_types?(type_defn)
+          else
+            referenced?(type_defn) || visible_abstract_type?(type_defn)
+          end
+        end
+
+        @visible_and_reachable_type[type_defn]
+      end
+
+      def union_memberships(obj_type)
+        @unions ||= read_through { |obj_type| @schema.union_memberships(obj_type).select { |u| visible?(u) } }
+        @unions[obj_type]
       end
 
       # We need this to tell whether a field was inherited by an interface
@@ -195,10 +280,10 @@ module GraphQL
           any_interface_has_visible_field = false
           ints = unfiltered_interfaces(type_defn)
           ints.each do |interface_type|
-            if (iface_field_defn = interface_type.get_field(field_defn.graphql_name))
+            if (iface_field_defn = interface_type.get_field(field_defn.graphql_name, @context))
               any_interface_has_field = true
 
-              if interfaces(type_defn).include?(interface_type) && visible_field?(interface_type, iface_field_defn)
+              if interfaces(type_defn).include?(interface_type) && visible_field?(iface_field_defn, nil, interface_type)
                 any_interface_has_visible_field = true
               end
             end
@@ -215,23 +300,6 @@ module GraphQL
         end
       end
 
-      def visible_type?(type_defn)
-        @type_visibility ||= read_through do |type_defn|
-          next false unless visible?(type_defn)
-          next true if root_type?(type_defn) || type_defn.introspection?
-
-          if type_defn.kind.union?
-            visible_possible_types?(type_defn) && (referenced?(type_defn) || orphan_type?(type_defn))
-          elsif type_defn.kind.interface?
-            visible_possible_types?(type_defn)
-          else
-            referenced?(type_defn) || visible_abstract_type?(type_defn)
-          end
-        end
-
-        @type_visibility[type_defn]
-      end
-
       def root_type?(type_defn)
         @query == type_defn ||
           @mutation == type_defn ||
@@ -259,7 +327,7 @@ module GraphQL
       end
 
       def visible_possible_types?(type_defn)
-        possible_types(type_defn).any? { |t| visible_type?(t) }
+        possible_types(type_defn).any? { |t| visible_and_reachable_type?(t) }
       end
 
       def visible?(member)
@@ -274,6 +342,7 @@ module GraphQL
         return @reachable_type_set if defined?(@reachable_type_set)
 
         @reachable_type_set = Set.new
+        rt_hash = {}
 
         unvisited_types = []
         ['query', 'mutation', 'subscription'].each do |op_name|
@@ -283,16 +352,16 @@ module GraphQL
         unvisited_types.concat(@schema.introspection_system.types.values)
 
         directives.each do |dir_class|
-          dir_class.arguments.values.each do |arg_defn|
+          arguments(dir_class).each do |arg_defn|
             arg_t = arg_defn.type.unwrap
-            if get_type(arg_t.graphql_name)
+            if get_type(arg_t.graphql_name) # rubocop:disable Development/ContextIsPassedCop -- `self` is query-aware
               unvisited_types << arg_t
             end
           end
         end
 
         @schema.orphan_types.each do |orphan_type|
-          if get_type(orphan_type.graphql_name)
+          if get_type(orphan_type.graphql_name) == orphan_type # rubocop:disable Development/ContextIsPassedCop -- `self` is query-aware
             unvisited_types << orphan_type
           end
         end
@@ -300,6 +369,10 @@ module GraphQL
         until unvisited_types.empty?
           type = unvisited_types.pop
           if @reachable_type_set.add?(type)
+            type_by_name = rt_hash[type.graphql_name] ||= type
+            if type_by_name != type
+              raise DuplicateNamesError, "Found two visible type definitions for `#{type.graphql_name}`: #{type.inspect}, #{type_by_name.inspect}"
+            end
             if type.kind.input_object?
               # recurse into visible arguments
               arguments(type).each do |argument|