graphql 1.12.16 → 1.13.2

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

@@ -21,7 +21,9 @@ module GraphQL
         end
 
         def validate(_object, _context, value)
-          if @in_list.include?(value)
+          if permitted_empty_value?(value)
+            # pass
+          elsif @in_list.include?(value)
             @message
           end
         end

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]
@@ -38,7 +34,10 @@ module GraphQL
         end
 
         def validate(_object, _context, value)
-          if (@with_pattern && !value.match?(@with_pattern)) ||
+          if permitted_empty_value?(value)
+            # Do nothing
+          elsif value.nil? ||
+              (@with_pattern && !value.match?(@with_pattern)) ||
               (@without_pattern && value.match?(@without_pattern))
             @message
           end

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

@@ -23,7 +23,9 @@ module GraphQL
         end
 
         def validate(_object, _context, value)
-          if !@in_list.include?(value)
+          if permitted_empty_value?(value)
+            # pass
+          elsif !@in_list.include?(value)
             @message
           end
         end

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

@@ -43,11 +43,13 @@ module GraphQL
         end
 
         def validate(_object, _context, value)
-          if @maximum && value.length > @maximum
+          return if permitted_empty_value?(value) # pass in this case
+          length = value.nil? ? 0 : value.length
+          if @maximum && length > @maximum
             partial_format(@too_long, { count: @maximum })
-          elsif @minimum && value.length < @minimum
+          elsif @minimum && length < @minimum
             partial_format(@too_short, { count: @minimum })
-          elsif @is && value.length != @is
+          elsif @is && length != @is
             partial_format(@wrong_length, { count: @is })
           end
         end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQL
   class Schema
     class Validator
@@ -24,13 +25,15 @@ module GraphQL
         # @param other_than [Integer]
         # @param odd [Boolean]
         # @param even [Boolean]
+        # @param within [Range]
         # @param message [String] used for all validation failures
         def initialize(
             greater_than: nil, greater_than_or_equal_to: nil,
             less_than: nil, less_than_or_equal_to: nil,
             equal_to: nil, other_than: nil,
-            odd: nil, even: nil,
+            odd: nil, even: nil, within: nil,
             message: "%{validated} must be %{comparison} %{target}",
+            null_message: Validator::AllowNullValidator::MESSAGE,
             **default_options
           )
 
@@ -42,12 +45,18 @@ module GraphQL
           @other_than = other_than
           @odd = odd
           @even = even
+          @within = within
           @message = message
+          @null_message = null_message
           super(**default_options)
         end
 
         def validate(object, context, value)
-          if @greater_than && value <= @greater_than
+          if permitted_empty_value?(value)
+            # pass in this case
+          elsif value.nil? # @allow_null is handled in the parent class
+            @null_message
+          elsif @greater_than && value <= @greater_than
             partial_format(@message, { comparison: "greater than", target: @greater_than })
           elsif @greater_than_or_equal_to && value < @greater_than_or_equal_to
             partial_format(@message, { comparison: "greater than or equal to", target: @greater_than_or_equal_to })
@@ -63,6 +72,8 @@ module GraphQL
             (partial_format(@message, { comparison: "even", target: "" })).strip
           elsif @odd && !value.odd?
             (partial_format(@message, { comparison: "odd", target: "" })).strip
+          elsif @within && !@within.include?(value)
+            partial_format(@message, { comparison: "within", target: @within })
           end
         end
       end

data/lib/graphql/schema/validator.rb

@@ -7,7 +7,6 @@ module GraphQL
       # @return [GraphQL::Schema::Argument, GraphQL::Schema::Field, GraphQL::Schema::Resolver, Class<GraphQL::Schema::InputObject>]
       attr_reader :validated
 
-      # TODO should this implement `if:` and `unless:` ?
       # @param validated [GraphQL::Schema::Argument, GraphQL::Schema::Field, GraphQL::Schema::Resolver, Class<GraphQL::Schema::InputObject>] The argument or argument owner this validator is attached to
       # @param allow_blank [Boolean] if `true`, then objects that respond to `.blank?` and return true for `.blank?` will skip this validation
       # @param allow_null [Boolean] if `true`, then incoming `null`s will skip this validation
@@ -25,26 +24,6 @@ module GraphQL
         raise GraphQL::RequiredImplementationMissingError, "Validator classes should implement #validate"
       end
 
-      # This is called by the validation system and eventually calls {#validate}.
-      # @api private
-      def apply(object, context, value)
-        if value.nil?
-          if @allow_null
-            nil # skip this
-          else
-            "%{validated} can't be null"
-          end
-        elsif value.respond_to?(:blank?) && value.blank?
-          if @allow_blank
-            nil # skip this
-          else
-            "%{validated} can't be blank"
-          end
-        else
-          validate(object, context, value)
-        end
-      end
-
       # This is like `String#%`, but it supports the case that only some of `string`'s
       # values are present in `substitutions`
       def partial_format(string, substitutions)
@@ -55,6 +34,12 @@ module GraphQL
         string
       end
 
+      # @return [Boolean] `true` if `value` is `nil` and this validator has `allow_null: true` or if value is `.blank?` and this validator has `allow_blank: true`
+      def permitted_empty_value?(value)
+        (value.nil? && @allow_null) ||
+          (@allow_blank && value.respond_to?(:blank?) && value.blank?)
+      end
+
       # @param schema_member [GraphQL::Schema::Field, GraphQL::Schema::Argument, Class<GraphQL::Schema::InputObject>]
       # @param validates_hash [Hash{Symbol => Hash}, Hash{Class => Hash} nil] A configuration passed as `validates:`
       # @return [Array<Validator>]
@@ -62,6 +47,21 @@ module GraphQL
         if validates_hash.nil? || validates_hash.empty?
           EMPTY_ARRAY
         else
+          validates_hash = validates_hash.dup
+
+          default_options = {}
+          if validates_hash[:allow_null]
+            default_options[:allow_null] = validates_hash.delete(:allow_null)
+          end
+          if validates_hash[:allow_blank]
+            default_options[:allow_blank] = validates_hash.delete(:allow_blank)
+          end
+
+          # allow_nil or allow_blank are the _only_ validations:
+          if validates_hash.empty?
+            validates_hash = default_options
+          end
+
           validates_hash.map do |validator_name, options|
             validator_class = case validator_name
             when Class
@@ -69,7 +69,11 @@ module GraphQL
             else
               all_validators[validator_name] || raise(ArgumentError, "unknown validation: #{validator_name.inspect}")
             end
-            validator_class.new(validated: schema_member, **options)
+            if options.is_a?(Hash)
+              validator_class.new(validated: schema_member, **(default_options.merge(options)))
+            else
+              validator_class.new(options, validated: schema_member, **default_options)
+            end
           end
         end
       end
@@ -122,10 +126,10 @@ module GraphQL
 
         validators.each do |validator|
           validated = as || validator.validated
-          errors = validator.apply(object, context, value)
+          errors = validator.validate(object, context, value)
           if errors &&
-            (errors.is_a?(Array) && errors != EMPTY_ARRAY) ||
-            (errors.is_a?(String))
+              (errors.is_a?(Array) && errors != EMPTY_ARRAY) ||
+              (errors.is_a?(String))
             if all_errors.frozen? # It's empty
               all_errors = []
             end
@@ -161,3 +165,7 @@ require "graphql/schema/validator/exclusion_validator"
 GraphQL::Schema::Validator.install(:exclusion, GraphQL::Schema::Validator::ExclusionValidator)
 require "graphql/schema/validator/required_validator"
 GraphQL::Schema::Validator.install(:required, GraphQL::Schema::Validator::RequiredValidator)
+require "graphql/schema/validator/allow_null_validator"
+GraphQL::Schema::Validator.install(:allow_null, GraphQL::Schema::Validator::AllowNullValidator)
+require "graphql/schema/validator/allow_blank_validator"
+GraphQL::Schema::Validator.install(:allow_blank, GraphQL::Schema::Validator::AllowBlankValidator)

data/lib/graphql/schema/warden.rb

@@ -37,6 +37,50 @@ 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
+        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 +98,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 +110,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 +128,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 +136,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 +150,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 +166,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) } }
+        @visible_arguments ||= read_through { |o| o.arguments(@context).each_value.select { |a| visible_argument?(a) } }
         @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 +207,52 @@ 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
+
+      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 +271,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 +291,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 +318,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 +333,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 +343,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 +360,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|