graphql 1.10.2 → 2.0.21

data/lib/graphql/schema/validator.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Validator
+      # The thing being validated
+      # @return [GraphQL::Schema::Argument, GraphQL::Schema::Field, GraphQL::Schema::Resolver, Class<GraphQL::Schema::InputObject>]
+      attr_reader :validated
+
+      # @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
+      def initialize(validated:, allow_blank: false, allow_null: false)
+        @validated = validated
+        @allow_blank = allow_blank
+        @allow_null = allow_null
+      end
+
+      # @param object [Object] The application object that this argument's field is being resolved for
+      # @param context [GraphQL::Query::Context]
+      # @param value [Object] The client-provided value for this argument (after parsing and coercing by the input type)
+      # @return [nil, Array<String>, String] Error message or messages to add
+      def validate(object, context, value)
+        raise GraphQL::RequiredImplementationMissingError, "Validator classes should implement #validate"
+      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)
+        substitutions.each do |key, value|
+          sub_v = value.is_a?(String) ? value : value.to_s
+          string = string.gsub("%{#{key}}", sub_v)
+        end
+        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>]
+      def self.from_config(schema_member, validates_hash)
+        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
+              validator_name
+            else
+              all_validators[validator_name] || raise(ArgumentError, "unknown validation: #{validator_name.inspect}")
+            end
+            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
+
+      # Add `validator_class` to be initialized when `validates:` is given `name`.
+      # (It's initialized with whatever options are given by the key `name`).
+      # @param name [Symbol]
+      # @param validator_class [Class]
+      # @return [void]
+      def self.install(name, validator_class)
+        all_validators[name] = validator_class
+        nil
+      end
+
+      # Remove whatever validator class is {.install}ed at `name`, if there is one
+      # @param name [Symbol]
+      # @return [void]
+      def self.uninstall(name)
+        all_validators.delete(name)
+        nil
+      end
+
+      class << self
+        attr_accessor :all_validators
+      end
+
+      self.all_validators = {}
+
+      include GraphQL::EmptyObjects
+
+      class ValidationFailedError < GraphQL::ExecutionError
+        attr_reader :errors
+
+        def initialize(errors:)
+          @errors = errors
+          super(errors.join(", "))
+        end
+      end
+
+      # @param validators [Array<Validator>]
+      # @param object [Object]
+      # @param context [Query::Context]
+      # @param value [Object]
+      # @return [void]
+      # @raises [ValidationFailedError]
+      def self.validate!(validators, object, context, value, as: nil)
+        # Assuming the default case is no errors, reduce allocations in that case.
+        # This will be replaced with a mutable array if we actually get any errors.
+        all_errors = EMPTY_ARRAY
+
+        validators.each do |validator|
+          validated = as || validator.validated
+          errors = validator.validate(object, context, value)
+          if errors &&
+              (errors.is_a?(Array) && errors != EMPTY_ARRAY) ||
+              (errors.is_a?(String))
+            if all_errors.frozen? # It's empty
+              all_errors = []
+            end
+            interpolation_vars = { validated: validated.graphql_name }
+            if errors.is_a?(String)
+              all_errors << (errors % interpolation_vars)
+            else
+              errors = errors.map { |e| e % interpolation_vars }
+              all_errors.concat(errors)
+            end
+          end
+        end
+
+        if all_errors.any?
+          raise ValidationFailedError.new(errors: all_errors)
+        end
+        nil
+      end
+    end
+  end
+end
+
+
+require "graphql/schema/validator/length_validator"
+GraphQL::Schema::Validator.install(:length, GraphQL::Schema::Validator::LengthValidator)
+require "graphql/schema/validator/numericality_validator"
+GraphQL::Schema::Validator.install(:numericality, GraphQL::Schema::Validator::NumericalityValidator)
+require "graphql/schema/validator/format_validator"
+GraphQL::Schema::Validator.install(:format, GraphQL::Schema::Validator::FormatValidator)
+require "graphql/schema/validator/inclusion_validator"
+GraphQL::Schema::Validator.install(:inclusion, GraphQL::Schema::Validator::InclusionValidator)
+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

@@ -10,7 +10,7 @@ module GraphQL
     # should go through a warden. If you access the schema directly,
     # you may show a client something that it shouldn't be allowed to see.
     #
-    # @example Hidding private fields
+    # @example Hiding private fields
     #   private_members = -> (member, ctx) { member.metadata[:private] }
     #   result = Schema.execute(query_string, except: private_members)
     #
@@ -37,26 +37,82 @@ module GraphQL
     #
     # @api private
     class Warden
+      def self.from_context(context)
+        context.warden # this might be a hash which won't respond to this
+      rescue
+        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 DuplicateNamesError.new(
+                  duplicated_name: item.path, duplicated_definition_1: visible_item.inspect, duplicated_definition_2: 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]
-      # @param deep_check [Boolean]
       def initialize(filter, context:, schema:)
-        @schema = schema.interpreter? ? schema : schema.graphql_definition
+        @schema = schema
         # Cache these to avoid repeated hits to the inheritance chain when one isn't present
         @query = @schema.query
         @mutation = @schema.mutation
         @subscription = @schema.subscription
         @context = context
         @visibility_cache = read_through { |m| filter.call(m, context) }
+        # Initialize all ivars to improve object shape consistency:
+        @types = @visible_types = @reachable_types = @visible_parent_fields =
+          @visible_possible_types = @visible_fields = @visible_arguments = @visible_enum_arrays =
+          @visible_enum_values = @visible_interfaces = @type_visibility = @type_memberships =
+          @visible_and_reachable_type = @unions = @unfiltered_interfaces = @references_to =
+          @reachable_type_set =
+            nil
       end
 
-      # @return [Array<GraphQL::BaseType>] Visible types in the schema
+      # @return [Hash<String, GraphQL::BaseType>] Visible types in the schema
       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
@@ -67,8 +123,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
@@ -85,17 +141,16 @@ 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
 
       # @return [GraphQL::Field, nil] The field named `field_name` on `parent_type`, if it exists
       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?(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,10 +161,17 @@ module GraphQL
         @visible_parent_fields[parent_type][field_name]
       end
 
+      # @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, @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|
-          @schema.possible_types(type_defn, @context).select { |t| visible_type?(t) }
+          pt = @schema.possible_types(type_defn, @context)
+          pt.select { |t| visible_and_reachable_type?(t) }
         }
         @visible_possible_types[type_defn]
       end
@@ -117,26 +179,37 @@ 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?(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_field?(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|
+          values = e.enum_values(@context)
+          if values.size == 0
+            raise GraphQL::Schema::Enum::MissingValuesError.new(e)
+          end
+          values
+        }
+        @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.select { |i| visible?(i) } }
+        @visible_interfaces ||= read_through { |t| t.interfaces(@context).select { |i| visible_type?(i) } }
         @visible_interfaces[obj_type]
       end
 
@@ -153,20 +226,42 @@ module GraphQL
         end
       end
 
-      private
+      # @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_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) || field_on_visible_interface?(field_defn, owner))
+      end
 
-      def union_memberships(obj_type)
-        @unions ||= read_through { |obj_type| @schema.union_memberships(obj_type).select { |u| visible?(u) } }
-        @unions[obj_type]
+      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_field?(field_defn)
-        visible?(field_defn) && visible_type?(field_defn.type.unwrap)
+      def visible_type_membership?(type_membership, _ctx = nil)
+        visible?(type_membership)
       end
 
-      def visible_type?(type_defn)
-        @type_visibility ||= read_through do |type_defn|
-          next false unless visible?(type_defn)
+      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?
@@ -178,7 +273,48 @@ module GraphQL
           end
         end
 
-        @type_visibility[type_defn]
+        @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
+      # even when that interface is hidden from `#interfaces`
+      def unfiltered_interfaces(type_defn)
+        @unfiltered_interfaces ||= read_through(&:interfaces)
+        @unfiltered_interfaces[type_defn]
+      end
+
+      # If this field was inherited from an interface, and the field on that interface is _hidden_,
+      # then treat this inherited field as hidden.
+      # (If it _wasn't_ inherited, then don't hide it for this reason.)
+      def field_on_visible_interface?(field_defn, type_defn)
+        if type_defn.kind.object?
+          any_interface_has_field = false
+          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, @context))
+              any_interface_has_field = true
+
+              if interfaces(type_defn).include?(interface_type) && visible_field?(iface_field_defn, nil, interface_type)
+                any_interface_has_visible_field = true
+              end
+            end
+          end
+
+          if any_interface_has_field
+            any_interface_has_visible_field
+          else
+            # it's the object's own field
+            true
+          end
+        else
+          true
+        end
       end
 
       def root_type?(type_defn)
@@ -208,7 +344,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)
@@ -220,9 +356,10 @@ module GraphQL
       end
 
       def reachable_type_set
-        return @reachable_type_set if defined?(@reachable_type_set)
+        return @reachable_type_set if @reachable_type_set
 
         @reachable_type_set = Set.new
+        rt_hash = {}
 
         unvisited_types = []
         ['query', 'mutation', 'subscription'].each do |op_name|
@@ -230,8 +367,18 @@ module GraphQL
           unvisited_types << root_type if root_type
         end
         unvisited_types.concat(@schema.introspection_system.types.values)
+
+        directives.each do |dir_class|
+          arguments(dir_class).each do |arg_defn|
+            arg_t = arg_defn.type.unwrap
+            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
@@ -239,6 +386,12 @@ 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.new(
+                duplicated_name: type.graphql_name, duplicated_definition_1: type.inspect, duplicated_definition_2: type_by_name.inspect
+              )
+            end
             if type.kind.input_object?
               # recurse into visible arguments
               arguments(type).each do |argument|

data/lib/graphql/schema/wrapper.rb

@@ -3,7 +3,6 @@
 module GraphQL
   class Schema
     class Wrapper
-      include GraphQL::Schema::Member::CachedGraphQLDefinition
       include GraphQL::Schema::Member::TypeSystemHelpers
 
       # @return [Class, Module] The inner type of this wrapping type, the type of which one or more objects may be present.
@@ -13,10 +12,6 @@ module GraphQL
         @of_type = of_type
       end
 
-      def to_graphql
-        raise GraphQL::RequiredImplementationMissingError
-      end
-
       def unwrap
         @of_type.unwrap
       end