graphql 1.12.12 → 2.4.8

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
@@ -98,7 +102,7 @@ module GraphQL
 
       self.all_validators = {}
 
-      include Schema::FindInheritedValue::EmptyObjects
+      include GraphQL::EmptyObjects
 
       class ValidationFailedError < GraphQL::ExecutionError
         attr_reader :errors
@@ -122,14 +126,14 @@ 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
-            interpolation_vars = { validated: validated.graphql_name }
+            interpolation_vars = { validated: validated.graphql_name, value: value.inspect }
             if errors.is_a?(String)
               all_errors << (errors % interpolation_vars)
             else
@@ -139,7 +143,7 @@ module GraphQL
           end
         end
 
-        if all_errors.any?
+        if !all_errors.empty?
           raise ValidationFailedError.new(errors: all_errors)
         end
         nil
@@ -161,3 +165,9 @@ 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)
+require "graphql/schema/validator/all_validator"
+GraphQL::Schema::Validator.install(:all, GraphQL::Schema::Validator::AllValidator)

data/lib/graphql/schema/visibility/migration.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Visibility
+      # You can use this to see how {GraphQL::Schema::Warden} and {GraphQL::Schema::Visibility::Profile}
+      # handle `.visible?` differently in your schema.
+      #
+      # It runs the same method on both implementations and raises an error when the results diverge.
+      #
+      # To fix the error, modify your schema so that both implementations return the same thing.
+      # Or, open an issue on GitHub to discuss the difference.
+      #
+      # This plugin adds overhead to runtime and may cause unexpected crashes -- **don't** use it in production!
+      #
+      # This plugin adds two keys to `context` when running:
+      #
+      # - `visibility_migration_running: true`
+      # - For the {Schema::Warden} which it instantiates, it adds `visibility_migration_warden_running: true`.
+      #
+      # Use those keys to modify your `visible?` behavior as needed.
+      #
+      # Also, in a pinch, you can set `skip_visibility_migration_error: true` in context to turn off this behavior per-query.
+      # (In that case, it uses {Profile} directly.)
+      #
+      # @example Adding this plugin
+      #
+      #   use GraphQL::Schema::Visibility, migration_errors: true
+      #
+      class Migration < GraphQL::Schema::Visibility::Profile
+        class RuntimeTypesMismatchError < GraphQL::Error
+          def initialize(method_called, warden_result, profile_result, method_args)
+            super(<<~ERR)
+              Mismatch in types for `##{method_called}(#{method_args.map(&:inspect).join(", ")})`:
+
+              #{compare_results(warden_result, profile_result)}
+
+              Update your `.visible?` implementation to make these implementations return the same value.
+
+              See: https://graphql-ruby.org/authorization/visibility_migration.html
+            ERR
+          end
+
+          private
+          def compare_results(warden_result, profile_result)
+            if warden_result.is_a?(Array) && profile_result.is_a?(Array)
+              all_results = warden_result | profile_result
+              all_results.sort_by!(&:graphql_name)
+
+              entries_text = all_results.map { |entry| "#{entry.graphql_name} (#{entry})"}
+              width = entries_text.map(&:size).max
+              yes = "    ✔   "
+              no =  "        "
+              res = "".dup
+              res << "#{"Result".center(width)} Warden  Profile \n"
+              all_results.each_with_index do |entry, idx|
+                res << "#{entries_text[idx].ljust(width)}#{warden_result.include?(entry) ? yes : no}#{profile_result.include?(entry) ? yes : no}\n"
+              end
+              res << "\n"
+            else
+              "- Warden returned: #{humanize(warden_result)}\n\n- Visibility::Profile returned: #{humanize(profile_result)}"
+            end
+          end
+          def humanize(val)
+            case val
+            when Array
+              "#{val.size}: #{val.map { |v| humanize(v) }.sort.inspect}"
+            when Module
+              if val.respond_to?(:graphql_name)
+                "#{val.graphql_name} (#{val.inspect})"
+              else
+                val.inspect
+              end
+            else
+              val.inspect
+            end
+          end
+        end
+
+        def initialize(context:, schema:, name: nil)
+          @name = name
+          @skip_error = context[:skip_visibility_migration_error] || context.is_a?(Query::NullContext) || context.is_a?(Hash)
+          @profile_types = GraphQL::Schema::Visibility::Profile.new(context: context, schema: schema)
+          if !@skip_error
+            context[:visibility_migration_running] = true
+            warden_ctx_vals = context.to_h.dup
+            warden_ctx_vals[:visibility_migration_warden_running] = true
+            if schema.const_defined?(:WardenCompatSchema, false) # don't use a defn from a superclass
+              warden_schema = schema.const_get(:WardenCompatSchema, false)
+            else
+              warden_schema = Class.new(schema)
+              warden_schema.use_visibility_profile = false
+              # TODO public API
+              warden_schema.send(:add_type_and_traverse, [warden_schema.query, warden_schema.mutation, warden_schema.subscription].compact, root: true)
+              warden_schema.send(:add_type_and_traverse, warden_schema.directives.values + warden_schema.orphan_types, root: false)
+              schema.const_set(:WardenCompatSchema, warden_schema)
+            end
+            warden_ctx = GraphQL::Query::Context.new(query: context.query, values: warden_ctx_vals)
+            warden_ctx.warden = GraphQL::Schema::Warden.new(schema: warden_schema, context: warden_ctx)
+            warden_ctx.warden.skip_warning = true
+            warden_ctx.types = @warden_types = warden_ctx.warden.visibility_profile
+          end
+        end
+
+        def loaded_types
+          @profile_types.loaded_types
+        end
+
+        PUBLIC_PROFILE_METHODS = [
+          :enum_values,
+          :interfaces,
+          :all_types,
+          :all_types_h,
+          :fields,
+          :loadable?,
+          :loadable_possible_types,
+          :type,
+          :arguments,
+          :argument,
+          :directive_exists?,
+          :directives,
+          :field,
+          :query_root,
+          :mutation_root,
+          :possible_types,
+          :subscription_root,
+          :reachable_type?,
+          :visible_enum_value?,
+        ]
+
+        PUBLIC_PROFILE_METHODS.each do |profile_method|
+          define_method(profile_method) do |*args|
+            call_method_and_compare(profile_method, args)
+          end
+        end
+
+        def call_method_and_compare(method, args)
+          res_1 = @profile_types.public_send(method, *args)
+          if @skip_error
+            return res_1
+          end
+
+          res_2 = @warden_types.public_send(method, *args)
+          normalized_res_1 = res_1.is_a?(Array) ? Set.new(res_1) : res_1
+          normalized_res_2 = res_2.is_a?(Array) ? Set.new(res_2) : res_2
+          if !equivalent_schema_members?(normalized_res_1, normalized_res_2)
+            # Raise the errors with the orignally returned values:
+            err = RuntimeTypesMismatchError.new(method, res_2, res_1, args)
+            raise err
+          else
+            res_1
+          end
+        end
+
+        def equivalent_schema_members?(member1, member2)
+          if member1.class != member2.class
+            return false
+          end
+
+          case member1
+          when Set
+            member1_array = member1.to_a.sort_by(&:graphql_name)
+            member2_array = member2.to_a.sort_by(&:graphql_name)
+            member1_array.each_with_index do |inner_member1, idx|
+              inner_member2 = member2_array[idx]
+              equivalent_schema_members?(inner_member1, inner_member2)
+            end
+          when GraphQL::Schema::Field
+            member1.ensure_loaded
+            member2.ensure_loaded
+            if member1.introspection? && member2.introspection?
+              member1.inspect == member2.inspect
+            else
+              member1 == member2
+            end
+          when Module
+            if member1.introspection? && member2.introspection?
+              member1.graphql_name == member2.graphql_name
+            else
+              member1 == member2
+            end
+          else
+            member1 == member2
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/visibility/profile.rb

@@ -0,0 +1,359 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Visibility
+      # This class filters the types, fields, arguments, enum values, and directives in a schema
+      # based on the given `context`.
+      #
+      # It's like {Warden}, but has some differences:
+      #
+      # - It doesn't use {Schema}'s top-level caches (eg {Schema.references_to}, {Schema.possible_types}, {Schema.types})
+      # - It doesn't hide Interface or Union types when all their possible types are hidden. (Instead, those types should implement `.visible?` to hide in that case.)
+      # - It checks `.visible?` on root introspection types
+      # - It can be used to cache profiles by name for re-use across queries
+      class Profile
+        # @return [Schema::Visibility::Profile]
+        def self.from_context(ctx, schema)
+          if ctx.respond_to?(:types) && (types = ctx.types).is_a?(self)
+            types
+          else
+            schema.visibility.profile_for(ctx, nil)
+          end
+        end
+
+        def self.null_profile(context:, schema:)
+          profile = self.new(name: "NullProfile", context: context, schema: schema)
+          profile.instance_variable_set(:@cached_visible, Hash.new { |k, v| k[v] = true }.compare_by_identity)
+          profile
+        end
+
+        # @return [Symbol, nil]
+        attr_reader :name
+
+        def initialize(name: nil, context:, schema:)
+          @name = name
+          @context = context
+          @schema = schema
+          @all_types = {}
+          @all_types_loaded = false
+          @unvisited_types = []
+          @all_directives = nil
+          @cached_visible = Hash.new { |h, member| h[member] = @schema.visible?(member, @context) }.compare_by_identity
+
+          @cached_visible_fields = Hash.new { |h, owner|
+            h[owner] = Hash.new do |h2, field|
+              h2[field] = visible_field_for(owner, field)
+            end.compare_by_identity
+          }.compare_by_identity
+
+          @cached_visible_arguments = Hash.new do |h, arg|
+            h[arg] = if @cached_visible[arg] && (arg_type = arg.type.unwrap) && @cached_visible[arg_type]
+              true
+            else
+              false
+            end
+          end.compare_by_identity
+
+          @cached_parent_fields = Hash.new do |h, type|
+            h[type] = Hash.new do |h2, field_name|
+              h2[field_name] = type.get_field(field_name, @context)
+            end
+          end.compare_by_identity
+
+          @cached_parent_arguments = Hash.new do |h, arg_owner|
+            h[arg_owner] = Hash.new do |h2, arg_name|
+              h2[arg_name] = arg_owner.get_argument(arg_name, @context)
+            end
+          end.compare_by_identity
+
+          @cached_possible_types = Hash.new { |h, type| h[type] = possible_types_for(type) }.compare_by_identity
+
+          @cached_enum_values = Hash.new do |h, enum_t|
+            values = non_duplicate_items(enum_t.enum_values(@context), @cached_visible)
+            if values.size == 0
+              raise GraphQL::Schema::Enum::MissingValuesError.new(enum_t)
+            end
+            h[enum_t] = values
+          end.compare_by_identity
+
+          @cached_fields = Hash.new do |h, owner|
+            h[owner] = non_duplicate_items(owner.all_field_definitions.each(&:ensure_loaded), @cached_visible_fields[owner])
+          end.compare_by_identity
+
+          @cached_arguments = Hash.new do |h, owner|
+            h[owner] = non_duplicate_items(owner.all_argument_definitions, @cached_visible_arguments)
+          end.compare_by_identity
+
+          @loadable_possible_types = Hash.new { |h, union_type| h[union_type] = union_type.possible_types }.compare_by_identity
+        end
+
+        def field_on_visible_interface?(field, owner)
+          ints = owner.interface_type_memberships.map(&:abstract_type)
+          field_name = field.graphql_name
+          filtered_ints = interfaces(owner)
+          any_interface_has_field = false
+          any_interface_has_visible_field = false
+          ints.each do |int_t|
+            if (_int_f_defn = @cached_parent_fields[int_t][field_name])
+              any_interface_has_field = true
+
+              if filtered_ints.include?(int_t) # TODO cycles, or maybe not necessary since previously checked? && @cached_visible_fields[owner][field]
+                any_interface_has_visible_field = true
+                break
+              end
+            end
+          end
+
+          if any_interface_has_field
+            any_interface_has_visible_field
+          else
+            true
+          end
+        end
+
+        def type(type_name)
+          t = @schema.visibility.get_type(type_name) # rubocop:disable Development/ContextIsPassedCop
+          if t
+            if t.is_a?(Array)
+              vis_t = nil
+              t.each do |t_defn|
+                if @cached_visible[t_defn] && referenced?(t_defn)
+                  if vis_t.nil?
+                    vis_t = t_defn
+                  else
+                    raise_duplicate_definition(vis_t, t_defn)
+                  end
+                end
+              end
+              vis_t
+            else
+              if t && @cached_visible[t] && referenced?(t)
+                t
+              else
+                nil
+              end
+            end
+          end
+        end
+
+        def field(owner, field_name)
+          f = if owner.kind.fields? && (field = @cached_parent_fields[owner][field_name])
+            field
+          elsif owner == query_root && (entry_point_field = @schema.introspection_system.entry_point(name: field_name))
+            entry_point_field
+          elsif (dynamic_field = @schema.introspection_system.dynamic_field(name: field_name))
+            dynamic_field
+          else
+            nil
+          end
+          if f.is_a?(Array)
+            visible_f = nil
+            f.each do |f_defn|
+              if @cached_visible_fields[owner][f_defn]
+
+                if visible_f.nil?
+                  visible_f = f_defn
+                else
+                  raise_duplicate_definition(visible_f, f_defn)
+                end
+              end
+            end
+            visible_f.ensure_loaded
+          elsif f && @cached_visible_fields[owner][f.ensure_loaded]
+            f
+          else
+            nil
+          end
+        end
+
+        def fields(owner)
+          @cached_fields[owner]
+        end
+
+        def arguments(owner)
+          @cached_arguments[owner]
+        end
+
+        def argument(owner, arg_name)
+          arg = @cached_parent_arguments[owner][arg_name]
+          if arg.is_a?(Array)
+            visible_arg = nil
+            arg.each do |arg_defn|
+              if @cached_visible_arguments[arg_defn]
+                if visible_arg.nil?
+                  visible_arg = arg_defn
+                else
+                  raise_duplicate_definition(visible_arg, arg_defn)
+                end
+              end
+            end
+            visible_arg
+          else
+            if arg && @cached_visible_arguments[arg]
+              arg
+            else
+              nil
+            end
+          end
+        end
+
+        def possible_types(type)
+          @cached_possible_types[type]
+        end
+
+        def interfaces(obj_or_int_type)
+          ints = obj_or_int_type.interface_type_memberships
+            .select { |itm| @cached_visible[itm] && @cached_visible[itm.abstract_type] }
+            .map!(&:abstract_type)
+          ints.uniq! # Remove any duplicate interfaces implemented via other interfaces
+          ints
+        end
+
+        def query_root
+          ((t = @schema.query) && @cached_visible[t]) ? t : nil
+        end
+
+        def mutation_root
+          ((t = @schema.mutation) && @cached_visible[t]) ? t : nil
+        end
+
+        def subscription_root
+          ((t = @schema.subscription) && @cached_visible[t]) ? t : nil
+        end
+
+        def all_types
+          load_all_types
+          @all_types.values
+        end
+
+        def all_types_h
+          load_all_types
+          @all_types
+        end
+
+        def enum_values(owner)
+          @cached_enum_values[owner]
+        end
+
+        def directive_exists?(dir_name)
+          directives.any? { |d| d.graphql_name == dir_name }
+        end
+
+        def directives
+          @all_directives ||= @schema.visibility.all_directives.select { |dir|
+            @cached_visible[dir] && @schema.visibility.all_references[dir].any? { |ref| ref == true || (@cached_visible[ref] && referenced?(ref)) }
+          }
+        end
+
+        def loadable?(t, _ctx)
+          load_all_types
+          !@all_types[t.graphql_name] && @cached_visible[t]
+        end
+
+        def loadable_possible_types(t, _ctx)
+          @loadable_possible_types[t]
+        end
+
+        def loaded_types
+          @all_types.values
+        end
+
+        def reachable_type?(type_name)
+          load_all_types
+          !!@all_types[type_name]
+        end
+
+        def visible_enum_value?(enum_value, _ctx = nil)
+          @cached_visible[enum_value]
+        end
+
+        private
+
+        def non_duplicate_items(definitions, visibility_cache)
+          non_dups = []
+          definitions.each do |defn|
+            if visibility_cache[defn]
+              if (dup_defn = non_dups.find { |d| d.graphql_name == defn.graphql_name })
+                raise_duplicate_definition(dup_defn, defn)
+              end
+              non_dups << defn
+            end
+          end
+          non_dups
+        end
+
+        def raise_duplicate_definition(first_defn, second_defn)
+          raise DuplicateNamesError.new(duplicated_name: first_defn.path, duplicated_definition_1: first_defn.inspect, duplicated_definition_2: second_defn.inspect)
+        end
+
+        def load_all_types
+          return if @all_types_loaded
+          @all_types_loaded = true
+          visit = Visibility::Visit.new(@schema) do |member|
+            if member.is_a?(Module) && member.respond_to?(:kind)
+              if @cached_visible[member]
+                type_name = member.graphql_name
+                if (prev_t = @all_types[type_name]) && !prev_t.equal?(member)
+                  raise_duplicate_definition(member, prev_t)
+                end
+                @all_types[type_name] = member
+                true
+              else
+                false
+              end
+            else
+              @cached_visible[member]
+            end
+          end
+          visit.visit_each
+          @all_types.delete_if { |type_name, type_defn| !referenced?(type_defn) }
+          nil
+        end
+
+        def referenced?(type_defn)
+          @schema.visibility.all_references[type_defn].any? { |r| r == true ||  @cached_visible[r] }
+        end
+
+        def possible_types_for(type)
+          case type.kind.name
+          when "INTERFACE"
+            pts = []
+            @schema.visibility.all_interface_type_memberships[type].each do |itm|
+              if @cached_visible[itm] && (ot = itm.object_type) && @cached_visible[ot] && referenced?(ot)
+                pts << ot
+              end
+            end
+            pts
+          when "UNION"
+            pts = []
+            type.type_memberships.each { |tm|
+              if @cached_visible[tm] &&
+                  (ot = tm.object_type) &&
+                  @cached_visible[ot] &&
+                  referenced?(ot)
+                pts << ot
+              end
+            }
+            pts
+          when "OBJECT"
+            if @cached_visible[type]
+              [type]
+            else
+              EmptyObjects::EMPTY_ARRAY
+            end
+          else
+            GraphQL::EmptyObjects::EMPTY_ARRAY
+          end
+        end
+
+        def visible_field_for(owner, field)
+          @cached_visible[field] &&
+            (ret_type = field.type.unwrap) &&
+            @cached_visible[ret_type] &&
+            (owner == field.owner || (!owner.kind.object?) || field_on_visible_interface?(field, owner))
+        end
+      end
+    end
+  end
+end