graphql 1.12.12 → 2.4.8

data/lib/graphql/schema/member/has_arguments.rb

@@ -11,10 +11,11 @@ module GraphQL
         def self.extended(cls)
           cls.extend(ArgumentClassAccessor)
           cls.include(ArgumentObjectLoader)
+          cls.extend(ClassConfigured)
         end
 
         # @see {GraphQL::Schema::Argument#initialize} for parameters
-        # @return [GraphQL::Schema::Argument] An instance of {arguments_class}, created from `*args`
+        # @return [GraphQL::Schema::Argument] An instance of {argument_class}, created from `*args`
         def argument(*args, **kwargs, &block)
           kwargs[:owner] = self
           loads = kwargs[:loads]
@@ -37,6 +38,7 @@ module GraphQL
           end
           arg_defn = self.argument_class.new(*args, **kwargs, &block)
           add_argument(arg_defn)
+          arg_defn
         end
 
         # Register this argument with the class.
@@ -44,33 +46,175 @@ module GraphQL
         # @return [GraphQL::Schema::Argument]
         def add_argument(arg_defn)
           @own_arguments ||= {}
-          own_arguments[arg_defn.name] = arg_defn
+          prev_defn = @own_arguments[arg_defn.name]
+          case prev_defn
+          when nil
+            @own_arguments[arg_defn.name] = arg_defn
+          when Array
+            prev_defn << arg_defn
+          when GraphQL::Schema::Argument
+            @own_arguments[arg_defn.name] = [prev_defn, arg_defn]
+          else
+            raise "Invariant: unexpected `@own_arguments[#{arg_defn.name.inspect}]`: #{prev_defn.inspect}"
+          end
           arg_defn
         end
 
-        # @return [Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions
-        def arguments
-          inherited_arguments = ((self.is_a?(Class) && superclass.respond_to?(:arguments)) ? superclass.arguments : nil)
-          # Local definitions override inherited ones
-          if inherited_arguments
-            inherited_arguments.merge(own_arguments)
+        def remove_argument(arg_defn)
+          prev_defn = @own_arguments[arg_defn.name]
+          case prev_defn
+          when nil
+            # done
+          when Array
+            prev_defn.delete(arg_defn)
+          when GraphQL::Schema::Argument
+            @own_arguments.delete(arg_defn.name)
           else
-            own_arguments
+            raise "Invariant: unexpected `@own_arguments[#{arg_defn.name.inspect}]`: #{prev_defn.inspect}"
           end
+          nil
         end
 
-        # @return [GraphQL::Schema::Argument, nil] Argument defined on this thing, fetched by name.
-        def get_argument(argument_name)
-          a = own_arguments[argument_name]
+        # @return [Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions
+        def arguments(context = GraphQL::Query::NullContext.instance, _require_defined_arguments = nil)
+          if !own_arguments.empty?
+            own_arguments_that_apply = {}
+            own_arguments.each do |name, args_entry|
+              if (visible_defn = Warden.visible_entry?(:visible_argument?, args_entry, context))
+                own_arguments_that_apply[visible_defn.graphql_name] = visible_defn
+              end
+            end
+          end
+          # might be nil if there are actually no arguments
+          own_arguments_that_apply || own_arguments
+        end
 
-          if a || !self.is_a?(Class)
-            a
-          else
-            for ancestor in ancestors
-              if ancestor.respond_to?(:own_arguments) && a = ancestor.own_arguments[argument_name]
-                return a
+        def any_arguments?
+          !own_arguments.empty?
+        end
+
+        module ClassConfigured
+          def inherited(child_class)
+            super
+            child_class.extend(InheritedArguments)
+          end
+
+          module InheritedArguments
+            def arguments(context = GraphQL::Query::NullContext.instance, require_defined_arguments = true)
+              own_arguments = super(context, require_defined_arguments)
+              inherited_arguments = superclass.arguments(context, false)
+
+              if !own_arguments.empty?
+                if !inherited_arguments.empty?
+                  # Local definitions override inherited ones
+                  inherited_arguments.merge(own_arguments)
+                else
+                  own_arguments
+                end
+              else
+                inherited_arguments
+              end
+            end
+
+            def any_arguments?
+              super || superclass.any_arguments?
+            end
+
+            def all_argument_definitions
+              all_defns = {}
+              ancestors.reverse_each do |ancestor|
+                if ancestor.respond_to?(:own_arguments)
+                  all_defns.merge!(ancestor.own_arguments)
+                end
+              end
+              all_defns = all_defns.values
+              all_defns.flatten!
+              all_defns
+            end
+
+
+            def get_argument(argument_name, context = GraphQL::Query::NullContext.instance)
+              warden = Warden.from_context(context)
+              skip_visible = context.respond_to?(:types) && context.types.is_a?(GraphQL::Schema::Visibility::Profile)
+              for ancestor in ancestors
+                if ancestor.respond_to?(:own_arguments) &&
+                  (a = ancestor.own_arguments[argument_name]) &&
+                  (skip_visible || (a = Warden.visible_entry?(:visible_argument?, a, context, warden)))
+                  return a
+                end
               end
+              nil
             end
+          end
+        end
+
+        module FieldConfigured
+          def arguments(context = GraphQL::Query::NullContext.instance, _require_defined_arguments = nil)
+            own_arguments = super
+            if @resolver_class
+              inherited_arguments = @resolver_class.field_arguments(context)
+              if !own_arguments.empty?
+                if !inherited_arguments.empty?
+                  inherited_arguments.merge(own_arguments)
+                else
+                  own_arguments
+                end
+              else
+                inherited_arguments
+              end
+            else
+              own_arguments
+            end
+          end
+
+          def any_arguments?
+            super || (@resolver_class && @resolver_class.any_field_arguments?)
+          end
+
+          def all_argument_definitions
+            if @resolver_class
+              all_defns = {}
+              @resolver_class.all_field_argument_definitions.each do |arg_defn|
+                key = arg_defn.graphql_name
+                case (current_value = all_defns[key])
+                when nil
+                  all_defns[key] = arg_defn
+                when Array
+                  current_value << arg_defn
+                when GraphQL::Schema::Argument
+                  all_defns[key] = [current_value, arg_defn]
+                else
+                  raise "Invariant: Unexpected argument definition, #{current_value.class}: #{current_value.inspect}"
+                end
+              end
+              all_defns.merge!(own_arguments)
+              all_defns = all_defns.values
+              all_defns.flatten!
+              all_defns
+            else
+              super
+            end
+          end
+        end
+
+        def all_argument_definitions
+          if !own_arguments.empty?
+            all_defns = own_arguments.values
+            all_defns.flatten!
+            all_defns
+          else
+            EmptyObjects::EMPTY_ARRAY
+          end
+        end
+
+        # @return [GraphQL::Schema::Argument, nil] Argument defined on this thing, fetched by name.
+        def get_argument(argument_name, context = GraphQL::Query::NullContext.instance)
+          warden = Warden.from_context(context)
+          if (arg_config = own_arguments[argument_name]) && ((context.respond_to?(:types) && context.types.is_a?(GraphQL::Schema::Visibility::Profile)) || (visible_arg = Warden.visible_entry?(:visible_argument?, arg_config, context, warden)))
+            visible_arg || arg_config
+          elsif defined?(@resolver_class) && @resolver_class
+            @resolver_class.get_field_argument(argument_name, context)
+          else
             nil
           end
         end
@@ -87,61 +231,59 @@ module GraphQL
         #
         # @param values [Hash<String, Object>]
         # @param context [GraphQL::Query::Context]
-        # @yield [Interpreter::Arguments, Execution::Lazy<Interpeter::Arguments>]
-        # @return [Interpreter::Arguments, Execution::Lazy<Interpeter::Arguments>]
+        # @yield [Interpreter::Arguments, Execution::Lazy<Interpreter::Arguments>]
+        # @return [Interpreter::Arguments, Execution::Lazy<Interpreter::Arguments>]
         def coerce_arguments(parent_object, values, context, &block)
           # Cache this hash to avoid re-merging it
-          arg_defns = self.arguments
+          arg_defns = context.types.arguments(self)
           total_args_count = arg_defns.size
 
-          if total_args_count == 0
-            final_args = GraphQL::Execution::Interpreter::Arguments::EMPTY
-            if block_given?
-              block.call(final_args)
-              nil
+          finished_args = nil
+          prepare_finished_args = -> {
+            if total_args_count == 0
+              finished_args = GraphQL::Execution::Interpreter::Arguments::EMPTY
+              if block_given?
+                block.call(finished_args)
+              end
             else
-              final_args
-            end
-          else
-            finished_args = nil
-            argument_values = {}
-            resolved_args_count = 0
-            raised_error = false
-            arg_defns.each do |arg_name, arg_defn|
-              context.dataloader.append_job do
-                begin
-                  arg_defn.coerce_into_values(parent_object, values, context, argument_values)
-                rescue GraphQL::ExecutionError, GraphQL::UnauthorizedError => err
-                  raised_error = true
-                  if block_given?
-                    block.call(err)
-                  else
+              argument_values = {}
+              resolved_args_count = 0
+              raised_error = false
+              arg_defns.each do |arg_defn|
+                context.dataloader.append_job do
+                  begin
+                    arg_defn.coerce_into_values(parent_object, values, context, argument_values)
+                  rescue GraphQL::ExecutionError, GraphQL::UnauthorizedError => err
+                    raised_error = true
                     finished_args = err
+                    if block_given?
+                      block.call(finished_args)
+                    end
                   end
-                end
-
-                resolved_args_count += 1
-                if resolved_args_count == total_args_count && !raised_error
-                  finished_args = context.schema.after_any_lazies(argument_values.values) {
-                    GraphQL::Execution::Interpreter::Arguments.new(
-                      argument_values: argument_values,
-                    )
-                  }
 
-                  if block_given?
-                    block.call(finished_args)
+                  resolved_args_count += 1
+                  if resolved_args_count == total_args_count && !raised_error
+                    finished_args = context.schema.after_any_lazies(argument_values.values) {
+                      GraphQL::Execution::Interpreter::Arguments.new(
+                        argument_values: argument_values,
+                      )
+                    }
+                    if block_given?
+                      block.call(finished_args)
+                    end
                   end
                 end
               end
             end
+          }
 
-            if block_given?
-              nil
-            else
-              # This API returns eagerly, gotta run it now
-              context.dataloader.run
-              finished_args
-            end
+          if block_given?
+            prepare_finished_args.call
+            nil
+          else
+            # This API returns eagerly, gotta run it now
+            context.dataloader.run_isolated(&prepare_finished_args)
+            finished_args
           end
         end
 
@@ -149,7 +291,12 @@ module GraphQL
         # but not for directives.
         # TODO apply static validations on schema definitions?
         def validate_directive_argument(arg_defn, value)
-          if arg_defn.owner.is_a?(Class) && arg_defn.owner < GraphQL::Schema::Directive
+          # this is only implemented on directives.
+          nil
+        end
+
+        module HasDirectiveArguments
+          def validate_directive_argument(arg_defn, value)
             if value.nil? && arg_defn.type.non_null?
               raise ArgumentError, "#{arg_defn.path} is required, but no value was given"
             end
@@ -157,9 +304,11 @@ module GraphQL
         end
 
         def arguments_statically_coercible?
-          return @arguments_statically_coercible if defined?(@arguments_statically_coercible)
-
-          @arguments_statically_coercible = arguments.each_value.all?(&:statically_coercible?)
+          if defined?(@arguments_statically_coercible) && !@arguments_statically_coercible.nil?
+            @arguments_statically_coercible
+          else
+            @arguments_statically_coercible = all_argument_definitions.all?(&:statically_coercible?)
+          end
         end
 
         module ArgumentClassAccessor
@@ -186,43 +335,78 @@ module GraphQL
             context.schema.object_from_id(id, context)
           end
 
-          def load_application_object(argument, lookup_as_type, id, context)
+          def load_application_object(argument, id, context)
             # See if any object can be found for this ID
             if id.nil?
               return nil
             end
-            loaded_application_object = object_from_id(lookup_as_type, id, context)
-            context.schema.after_lazy(loaded_application_object) do |application_object|
+            object_from_id(argument.loads, id, context)
+          end
+
+          def load_and_authorize_application_object(argument, id, context)
+            loaded_application_object = load_application_object(argument, id, context)
+            authorize_application_object(argument, id, context, loaded_application_object)
+          end
+
+          def authorize_application_object(argument, id, context, loaded_application_object)
+            context.query.after_lazy(loaded_application_object) do |application_object|
               if application_object.nil?
-                err = GraphQL::LoadApplicationObjectFailedError.new(argument: argument, id: id, object: application_object)
-                load_application_object_failed(err)
+                err = GraphQL::LoadApplicationObjectFailedError.new(context: context, argument: argument, id: id, object: application_object)
+                application_object = load_application_object_failed(err)
               end
               # Double-check that the located object is actually of this type
               # (Don't want to allow arbitrary access to objects this way)
-              resolved_application_object_type = context.schema.resolve_type(lookup_as_type, application_object, context)
-              context.schema.after_lazy(resolved_application_object_type) do |application_object_type|
-                possible_object_types = context.warden.possible_types(lookup_as_type)
-                if !possible_object_types.include?(application_object_type)
-                  err = GraphQL::LoadApplicationObjectFailedError.new(argument: argument, id: id, object: application_object)
-                  load_application_object_failed(err)
-                else
-                  # This object was loaded successfully
-                  # and resolved to the right type,
-                  # now apply the `.authorized?` class method if there is one
-                  if (class_based_type = application_object_type.type_class)
-                    context.schema.after_lazy(class_based_type.authorized?(application_object, context)) do |authed|
+              if application_object.nil?
+                nil
+              else
+                arg_loads_type = argument.loads
+                maybe_lazy_resolve_type = context.schema.resolve_type(arg_loads_type, application_object, context)
+                context.query.after_lazy(maybe_lazy_resolve_type) do |resolve_type_result|
+                  if resolve_type_result.is_a?(Array) && resolve_type_result.size == 2
+                    application_object_type, application_object = resolve_type_result
+                  else
+                    application_object_type = resolve_type_result
+                    # application_object is already assigned
+                  end
+
+                  passes_possible_types_check = if context.types.loadable?(arg_loads_type, context)
+                    if arg_loads_type.kind.union?
+                      # This union is used in `loads:` but not otherwise visible to this query
+                      context.types.loadable_possible_types(arg_loads_type, context).include?(application_object_type)
+                    else
+                      true
+                    end
+                  else
+                    context.types.possible_types(arg_loads_type).include?(application_object_type)
+                  end
+                  if !passes_possible_types_check
+                    err = GraphQL::LoadApplicationObjectFailedError.new(context: context, argument: argument, id: id, object: application_object)
+                    application_object = load_application_object_failed(err)
+                  end
+
+                  if application_object.nil?
+                    nil
+                  else
+                    # This object was loaded successfully
+                    # and resolved to the right type,
+                    # now apply the `.authorized?` class method if there is one
+                    context.query.after_lazy(application_object_type.authorized?(application_object, context)) do |authed|
                       if authed
                         application_object
                       else
-                        raise GraphQL::UnauthorizedError.new(
+                        err = GraphQL::UnauthorizedError.new(
                           object: application_object,
-                          type: class_based_type,
+                          type: application_object_type,
                           context: context,
                         )
+                        if self.respond_to?(:unauthorized_object)
+                          err.set_backtrace(caller)
+                          unauthorized_object(err)
+                        else
+                          raise err
+                        end
                       end
                     end
-                  else
-                    application_object
                   end
                 end
               end
@@ -234,7 +418,7 @@ module GraphQL
           end
         end
 
-        NO_ARGUMENTS = {}.freeze
+        NO_ARGUMENTS =  GraphQL::EmptyObjects::EMPTY_HASH
         def own_arguments
           @own_arguments || NO_ARGUMENTS
         end

data/lib/graphql/schema/member/has_ast_node.rb

@@ -3,6 +3,16 @@ module GraphQL
   class Schema
     class Member
       module HasAstNode
+        def self.extended(child_cls)
+          super
+          child_cls.ast_node = nil
+        end
+
+        def inherited(child_cls)
+          super
+          child_cls.ast_node = nil
+        end
+
         # If this schema was parsed from a `.graphql` file (or other SDL),
         # this is the AST node that defined this part of the schema.
         def ast_node(new_ast_node = nil)
@@ -14,6 +24,8 @@ module GraphQL
             nil
           end
         end
+
+        attr_writer :ast_node
       end
     end
   end

data/lib/graphql/schema/member/has_deprecation_reason.rb

@@ -5,17 +5,16 @@ module GraphQL
     class Member
       module HasDeprecationReason
         # @return [String, nil] Explains why this member was deprecated (if present, this will be marked deprecated in introspection)
-        def deprecation_reason
-          dir = self.directives.find { |d| d.is_a?(GraphQL::Schema::Directive::Deprecated) }
-          dir && dir.arguments[:reason]
-        end
+        attr_reader :deprecation_reason
 
         # Set the deprecation reason for this member, or remove it by assigning `nil`
         # @param text [String, nil]
         def deprecation_reason=(text)
+          @deprecation_reason = text
           if text.nil?
             remove_directive(GraphQL::Schema::Directive::Deprecated)
           else
+            # This removes a previously-attached directive, if there is one:
             directive(GraphQL::Schema::Directive::Deprecated, reason: text)
           end
         end

data/lib/graphql/schema/member/has_directives.rb

@@ -4,6 +4,16 @@ module GraphQL
   class Schema
     class Member
       module HasDirectives
+        def self.extended(child_cls)
+          super
+          child_cls.module_eval { self.own_directives = nil }
+        end
+
+        def inherited(child_cls)
+          super
+          child_cls.own_directives = nil
+        end
+
         # Create an instance of `dir_class` for `self`, using `options`.
         #
         # It removes a previously-attached instance of `dir_class`, if there is one.
@@ -11,8 +21,7 @@ module GraphQL
         # @return [void]
         def directive(dir_class, **options)
           @own_directives ||= []
-          remove_directive(dir_class)
-          @own_directives << dir_class.new(self, **options)
+          HasDirectives.add_directive(self, @own_directives, dir_class, options)
           nil
         end
 
@@ -20,78 +29,89 @@ module GraphQL
         # @param dir_class [Class<GraphQL::Schema::Directive>]
         # @return [viod]
         def remove_directive(dir_class)
-          @own_directives && @own_directives.reject! { |d| d.is_a?(dir_class) }
+          HasDirectives.remove_directive(@own_directives, dir_class)
           nil
         end
 
-        NO_DIRECTIVES = [].freeze
-
         def directives
-          case self
-          when Class
-            inherited_directives = if superclass.respond_to?(:directives)
-              superclass.directives
-            else
-              NO_DIRECTIVES
-            end
-            if inherited_directives.any? && @own_directives
-              dirs = []
-              merge_directives(dirs, inherited_directives)
-              merge_directives(dirs, @own_directives)
-              dirs
-            elsif @own_directives
-              @own_directives
-            elsif inherited_directives.any?
-              inherited_directives
-            else
-              NO_DIRECTIVES
-            end
-          when Module
-            dirs = nil
-            self.ancestors.reverse_each do |ancestor|
-              if ancestor.respond_to?(:own_directives) &&
-                  (anc_dirs = ancestor.own_directives).any?
+          HasDirectives.get_directives(self, @own_directives, :directives)
+        end
+
+        class << self
+          def add_directive(schema_member, directives, directive_class, directive_options)
+            remove_directive(directives, directive_class) unless directive_class.repeatable?
+            directives << directive_class.new(schema_member, **directive_options)
+          end
+
+          def remove_directive(directives, directive_class)
+            directives && directives.reject! { |d| d.is_a?(directive_class) }
+          end
+
+          def get_directives(schema_member, directives, directives_method)
+            case schema_member
+            when Class
+              inherited_directives = if schema_member.superclass.respond_to?(directives_method)
+                get_directives(schema_member.superclass, schema_member.superclass.public_send(directives_method), directives_method)
+              else
+                GraphQL::EmptyObjects::EMPTY_ARRAY
+              end
+              if !inherited_directives.empty? && directives
+                dirs = []
+                merge_directives(dirs, inherited_directives)
+                merge_directives(dirs, directives)
+                dirs
+              elsif directives
+                directives
+              elsif !inherited_directives.empty?
+                inherited_directives
+              else
+                GraphQL::EmptyObjects::EMPTY_ARRAY
+              end
+            when Module
+              dirs = nil
+              schema_member.ancestors.reverse_each do |ancestor|
+                if ancestor.respond_to?(:own_directives) &&
+                    !(anc_dirs = ancestor.own_directives).empty?
+                  dirs ||= []
+                  merge_directives(dirs, anc_dirs)
+                end
+              end
+              if directives
                 dirs ||= []
-                merge_directives(dirs, anc_dirs)
+                merge_directives(dirs, directives)
               end
+              dirs || GraphQL::EmptyObjects::EMPTY_ARRAY
+            when HasDirectives
+              directives || GraphQL::EmptyObjects::EMPTY_ARRAY
+            else
+              raise "Invariant: how could #{schema_member} not be a Class, Module, or instance of HasDirectives?"
             end
-            if own_directives
-              dirs ||= []
-              merge_directives(dirs, own_directives)
-            end
-            dirs || NO_DIRECTIVES
-          when HasDirectives
-            @own_directives || NO_DIRECTIVES
-          else
-            raise "Invariant: how could #{self} not be a Class, Module, or instance of HasDirectives?"
           end
-        end
-
-        protected
-
-        def own_directives
-          @own_directives
-        end
 
-        private
+          private
 
-        # Modify `target` by adding items from `dirs` such that:
-        # - Any name conflict is overriden by the incoming member of `dirs`
-        # - Any other member of `dirs` is appended
-        # @param target [Array<GraphQL::Schema::Directive>]
-        # @param dirs [Array<GraphQL::Schema::Directive>]
-        # @return [void]
-        def merge_directives(target, dirs)
-          dirs.each do |dir|
-            if (idx = target.find_index { |d| d.graphql_name == dir.graphql_name })
-              target.slice!(idx)
-              target.insert(idx, dir)
-            else
-              target << dir
+          # Modify `target` by adding items from `dirs` such that:
+          # - Any name conflict is overridden by the incoming member of `dirs`
+          # - Any other member of `dirs` is appended
+          # @param target [Array<GraphQL::Schema::Directive>]
+          # @param dirs [Array<GraphQL::Schema::Directive>]
+          # @return [void]
+          def merge_directives(target, dirs)
+            dirs.each do |dir|
+              if (idx = target.find_index { |d| d.graphql_name == dir.graphql_name })
+                target.slice!(idx)
+                target.insert(idx, dir)
+              else
+                target << dir
+              end
             end
+            nil
           end
-          nil
         end
+
+        protected
+
+        attr_accessor :own_directives
       end
     end
   end