graphql 1.10.2 → 2.0.21

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

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-# test_via: ../object.rb
-
-module GraphQL
-  class Schema
-    class Member
-      module Instrumentation
-        module_function
-        def instrument(type, field)
-          return_type = field.type.unwrap
-          if (return_type.is_a?(GraphQL::ObjectType) && return_type.metadata[:type_class]) ||
-              return_type.is_a?(GraphQL::InterfaceType) ||
-              (return_type.is_a?(GraphQL::UnionType) && return_type.possible_types.any? { |t| t.metadata[:type_class] })
-            field = apply_proxy(field)
-          end
-
-          field
-        end
-
-        def before_query(query)
-          # Get the root type for this query
-          root_node = query.irep_selection
-          if root_node.nil?
-            # It's an invalid query, nothing to do here
-          else
-            root_type = query.irep_selection.return_type
-            # If it has a wrapper, apply it
-            wrapper_class = root_type.metadata[:type_class]
-            if wrapper_class
-              new_root_value = wrapper_class.authorized_new(query.root_value, query.context)
-              new_root_value = query.schema.sync_lazy(new_root_value)
-              if new_root_value.nil?
-                # This is definitely a hack,
-                # but we need some way to tell execute.rb not to run.
-                query.context[:__root_unauthorized] = true
-              end
-              query.root_value = new_root_value
-            end
-          end
-        end
-
-        def after_query(_query)
-        end
-
-        private
-
-        module_function
-
-        def apply_proxy(field)
-          resolve_proc = field.resolve_proc
-          lazy_resolve_proc = field.lazy_resolve_proc
-          inner_return_type = field.type.unwrap
-          depth = list_depth(field.type)
-
-          field.redefine(
-            resolve: ProxiedResolve.new(inner_resolve: resolve_proc, list_depth: depth, inner_return_type: inner_return_type),
-            lazy_resolve: ProxiedResolve.new(inner_resolve: lazy_resolve_proc, list_depth: depth, inner_return_type: inner_return_type),
-          )
-        end
-
-        def list_depth(type, starting_at = 0)
-          case type
-          when GraphQL::ListType
-            list_depth(type.of_type, starting_at + 1)
-          when GraphQL::NonNullType
-            list_depth(type.of_type, starting_at)
-          else
-            starting_at
-          end
-        end
-
-        class ProxiedResolve
-          def initialize(inner_resolve:, list_depth:, inner_return_type:)
-            @inner_resolve = inner_resolve
-            @inner_return_type = inner_return_type
-            @list_depth = list_depth
-          end
-
-          def call(obj, args, ctx)
-            result = @inner_resolve.call(obj, args, ctx)
-            if ctx.skip == result || ctx.schema.lazy?(result) || result.nil? || execution_errors?(result) || ctx.wrapped_object
-              result
-            else
-              ctx.wrapped_object = true
-              proxy_to_depth(result, @list_depth, ctx)
-            end
-          end
-
-          private
-
-          def execution_errors?(result)
-            result.is_a?(GraphQL::ExecutionError) ||
-              (result.is_a?(Array) && result.any? && result.all? { |v| v.is_a?(GraphQL::ExecutionError) })
-          end
-
-          def proxy_to_depth(inner_obj, depth, ctx)
-            if depth > 0
-              inner_obj.map { |i| proxy_to_depth(i, depth - 1, ctx) }
-            else
-              ctx.schema.after_lazy(inner_obj) do |inner_obj|
-                if inner_obj.nil?
-                  # For lists with nil, we need another nil check here
-                  nil
-                else
-                  concrete_type_or_lazy = case @inner_return_type
-                  when GraphQL::UnionType, GraphQL::InterfaceType
-                    ctx.query.resolve_type(@inner_return_type, inner_obj)
-                  when GraphQL::ObjectType
-                    @inner_return_type
-                  else
-                    raise "unexpected proxying type #{@inner_return_type} for #{inner_obj} at #{ctx.owner_type}.#{ctx.field.name}"
-                  end
-
-                  # .resolve_type may have returned a lazy
-                  ctx.schema.after_lazy(concrete_type_or_lazy) do |concrete_type|
-                    if concrete_type && (object_class = concrete_type.metadata[:type_class])
-                      # use the query-level context here, since it won't be field-specific anyways
-                      query_ctx = ctx.query.context
-                      object_class.authorized_new(inner_obj, query_ctx)
-                    else
-                      inner_obj
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/schema/middleware_chain.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  class Schema
-    # Given {steps} and {arguments}, call steps in order, passing `(*arguments, next_step)`.
-    #
-    # Steps should call `next_step.call` to continue the chain, or _not_ call it to stop the chain.
-    class MiddlewareChain
-      extend Forwardable
-
-      # @return [Array<#call(*args)>] Steps in this chain, will be called with arguments and `next_middleware`
-      attr_reader :steps, :final_step
-
-      def initialize(steps: [], final_step: nil)
-        @steps = steps
-        @final_step = final_step
-      end
-
-      def initialize_copy(other)
-        super
-        @steps = other.steps.dup
-      end
-
-      def_delegators :@steps, :[], :first, :insert, :delete
-
-      def <<(callable)
-        add_middleware(callable)
-      end
-
-      def push(callable)
-        add_middleware(callable)
-      end
-
-      def ==(other)
-        steps == other.steps && final_step == other.final_step
-      end
-
-      def invoke(arguments)
-        invoke_core(0, arguments)
-      end
-
-      def concat(callables)
-        callables.each { |c| add_middleware(c) }
-      end
-
-      private
-
-      def invoke_core(index, arguments)
-        if index >= steps.length
-          final_step.call(*arguments)
-        else
-          steps[index].call(*arguments) { |next_args = arguments| invoke_core(index + 1, next_args) }
-        end
-      end
-
-      def add_middleware(callable)
-        # TODO: Stop wrapping callables once deprecated middleware becomes unsupported
-        steps << wrap(callable)
-      end
-
-      # TODO: Remove this code once deprecated middleware becomes unsupported
-      class MiddlewareWrapper
-        attr_reader :callable
-        def initialize(callable)
-          @callable = callable
-        end
-
-        def call(*args, &next_middleware)
-          callable.call(*args, next_middleware)
-        end
-      end
-
-      def wrap(callable)
-        if BackwardsCompatibility.get_arity(callable) == 6
-          warn("Middleware that takes a next_middleware parameter is deprecated (#{callable.inspect}); instead, accept a block and use yield.")
-          MiddlewareWrapper.new(callable)
-        else
-          callable
-        end
-      end
-    end
-  end
-end

data/lib/graphql/schema/possible_types.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  class Schema
-    # Find the members of a union or interface within a given schema.
-    #
-    # (Although its members never change, unions are handled this way to simplify execution code.)
-    #
-    # Internally, the calculation is cached. It's assumed that schema members _don't_ change after creating the schema!
-    #
-    # @example Get an interface's possible types
-    #   possible_types = GraphQL::Schema::PossibleTypes(MySchema)
-    #   possible_types.possible_types(MyInterface)
-    #   # => [MyObjectType, MyOtherObjectType]
-    class PossibleTypes
-      def initialize(schema)
-        @object_types = schema.types.values.select { |type| type.kind.object? }
-
-        @interface_implementers = Hash.new do |hash, key|
-          hash[key] = @object_types.select { |type| type.interfaces.include?(key) }.sort_by(&:name)
-        end
-      end
-
-      def possible_types(type_defn, ctx)
-        case type_defn
-        when Module
-          possible_types(type_defn.graphql_definition, ctx)
-        when GraphQL::UnionType
-          type_defn.possible_types(ctx)
-        when GraphQL::InterfaceType
-          @interface_implementers[type_defn]
-        when GraphQL::BaseType
-          [type_defn]
-        else
-          raise "Unexpected possible_types object: #{type_defn.inspect}"
-        end
-      end
-    end
-  end
-end

data/lib/graphql/schema/rescue_middleware.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  class Schema
-    # - Store a table of errors & handlers
-    # - Rescue errors in a middleware chain, then check for a handler
-    # - If a handler is found, use it & return a {GraphQL::ExecutionError}
-    # - If no handler is found, re-raise the error
-    class RescueMiddleware
-      # @return [Hash] `{class => proc}` pairs for handling errors
-      attr_reader :rescue_table
-      def initialize
-        @rescue_table = {}
-      end
-
-      # @example Rescue from not-found by telling the user
-      #   MySchema.rescue_from(ActiveRecord::RecordNotFound) { "An item could not be found" }
-      #
-      # @param error_classes [Class] one or more classes of errors to rescue from
-      # @yield [err] A handler to return a message for these error instances
-      # @yieldparam [Exception] an error that was rescued
-      # @yieldreturn [String] message to put in GraphQL response
-      def rescue_from(*error_classes, &block)
-        error_classes.map{ |error_class| rescue_table[error_class] = block }
-      end
-
-      # Remove the handler for `error_classs`
-      # @param error_class [Class] the error class whose handler should be removed
-      def remove_handler(*error_classes)
-        error_classes.map{ |error_class| rescue_table.delete(error_class) }
-      end
-
-      # Implement the requirement for {GraphQL::Schema::MiddlewareChain}
-      def call(*args)
-        begin
-          yield
-        rescue StandardError => err
-          attempt_rescue(err)
-        end
-      end
-
-      private
-
-      def attempt_rescue(err)
-        rescue_table.each { |klass, handler|
-          if klass.is_a?(Class) && err.is_a?(klass) && handler
-            result = handler.call(err)
-            case result
-            when String
-              return GraphQL::ExecutionError.new(result)
-            when GraphQL::ExecutionError
-              return result
-            end
-          end
-        }
-
-        raise(err)
-      end
-    end
-  end
-end

data/lib/graphql/schema/timeout_middleware.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-require "delegate"
-
-module GraphQL
-  class Schema
-    # This middleware will stop resolving new fields after `max_seconds` have elapsed.
-    # After the time has passed, any remaining fields will be `nil`, with errors added
-    # to the `errors` key. Any already-resolved fields will be in the `data` key, so
-    # you'll get a partial response.
-    #
-    # You can provide a block which will be called with any timeout errors that occur.
-    #
-    # Note that this will stop a query _in between_ field resolutions, but
-    # it doesn't interrupt long-running `resolve` functions. Be sure to use
-    # timeout options for external connections. For more info, see
-    # www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/
-    #
-    # @example Stop resolving fields after 2 seconds
-    #   MySchema.middleware << GraphQL::Schema::TimeoutMiddleware.new(max_seconds: 2)
-    #
-    # @example Notifying Bugsnag on a timeout
-    #   MySchema.middleware << GraphQL::Schema::TimeoutMiddleware(max_seconds: 1.5) do |timeout_error, query|
-    #    Bugsnag.notify(timeout_error, {query_string: query_ctx.query.query_string})
-    #   end
-    #
-    class TimeoutMiddleware
-      # @param max_seconds [Numeric] how many seconds the query should be allowed to resolve new fields
-      def initialize(max_seconds:, context_key: nil, &block)
-        @max_seconds = max_seconds
-        if context_key
-          warn("TimeoutMiddleware's `context_key` is ignored, timeout data is now stored in isolated storage")
-        end
-        @error_handler = block
-      end
-
-      def call(parent_type, parent_object, field_definition, field_args, query_context)
-        ns = query_context.namespace(self.class)
-        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        timeout_at = ns[:timeout_at] ||= now + @max_seconds
-
-        if timeout_at < now
-          on_timeout(parent_type, parent_object, field_definition, field_args, query_context)
-        else
-          yield
-        end
-      end
-
-      # This is called when a field _would_ be resolved, except that we're over the time limit.
-      # @return [GraphQL::Schema::TimeoutMiddleware::TimeoutError] An error whose message will be added to the `errors` key
-      def on_timeout(parent_type, parent_object, field_definition, field_args, field_context)
-        err = GraphQL::Schema::TimeoutMiddleware::TimeoutError.new(parent_type, field_definition)
-        if @error_handler
-          query_proxy = TimeoutQueryProxy.new(field_context.query, field_context)
-          @error_handler.call(err, query_proxy)
-        end
-        err
-      end
-
-      # This behaves like {GraphQL::Query} but {#context} returns
-      # the _field-level_ context, not the query-level context.
-      # This means you can reliably get the `irep_node` and `path`
-      # from it after the fact.
-      class TimeoutQueryProxy < SimpleDelegator
-        def initialize(query, ctx)
-          @context = ctx
-          super(query)
-        end
-
-        attr_reader :context
-      end
-
-      # This error is raised when a query exceeds `max_seconds`.
-      # Since it's a child of {GraphQL::ExecutionError},
-      # its message will be added to the response's `errors` key.
-      #
-      # To raise an error that will stop query resolution, use a custom block
-      # to take this error and raise a new one which _doesn't_ descend from {GraphQL::ExecutionError},
-      # such as `RuntimeError`.
-      class TimeoutError < GraphQL::ExecutionError
-        def initialize(parent_type, field_defn)
-          super("Timeout on #{parent_type.name}.#{field_defn.name}")
-        end
-      end
-    end
-  end
-end

data/lib/graphql/schema/traversal.rb

@@ -1,228 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  class Schema
-    # Visit the members of this schema and build up artifacts for runtime.
-    # @api private
-    class Traversal
-      # @return [Hash<String => GraphQL::BaseType]
-      attr_reader :type_map
-
-      # @return [Hash<String => Hash<String => GraphQL::Field>>]
-      attr_reader :instrumented_field_map
-
-      # @return [Hash<String => Array<GraphQL::Field || GraphQL::Argument || GraphQL::Directive>]
-      attr_reader :type_reference_map
-
-      # @return [Hash<String => Array<GraphQL::BaseType>]
-      attr_reader :union_memberships
-
-
-      # @param schema [GraphQL::Schema]
-      def initialize(schema, introspection: true)
-        @schema = schema
-        @introspection = introspection
-        built_in_insts = [
-          GraphQL::Relay::ConnectionInstrumentation,
-          GraphQL::Relay::EdgesInstrumentation,
-          GraphQL::Relay::Mutation::Instrumentation,
-        ]
-
-        if schema.query_execution_strategy != GraphQL::Execution::Interpreter
-          built_in_insts << GraphQL::Schema::Member::Instrumentation
-        end
-
-        @field_instrumenters =
-          schema.instrumenters[:field] +
-            built_in_insts +
-            schema.instrumenters[:field_after_built_ins]
-
-        # These fields have types specified by _name_,
-        # So we need to inspect the schema and find those types,
-        # then update their references.
-        @late_bound_fields = []
-        @type_map = {}
-        @instrumented_field_map = Hash.new { |h, k| h[k] = {} }
-        @type_reference_map = Hash.new { |h, k| h[k] = [] }
-        @union_memberships = Hash.new { |h, k| h[k] = [] }
-        visit(schema, schema, nil)
-        resolve_late_bound_fields
-      end
-
-      private
-
-      # A brute-force appraoch to late binding.
-      # Just keep trying the whole list, hoping that they
-      # eventually all resolve.
-      # This could be replaced with proper dependency tracking.
-      def resolve_late_bound_fields
-        # This is a bit tricky, with the writes going to internal state.
-        prev_late_bound_fields = @late_bound_fields
-        # Things might get added here during `visit...`
-        # or they might be added manually if we can't find them by hand
-        @late_bound_fields = []
-        prev_late_bound_fields.each do |(owner_type, field_defn, dynamic_field)|
-          if @type_map.key?(field_defn.type.unwrap.name)
-            late_bound_return_type = field_defn.type
-            resolved_type = @type_map.fetch(late_bound_return_type.unwrap.name)
-            wrapped_resolved_type = rewrap_resolved_type(late_bound_return_type, resolved_type)
-            # Update the field definition in place? :thinking_face:
-            field_defn.type = wrapped_resolved_type
-            visit_field_on_type(@schema, owner_type, field_defn, dynamic_field: dynamic_field)
-          else
-            @late_bound_fields << [owner_type, field_defn, dynamic_field]
-          end
-        end
-
-        if @late_bound_fields.any?
-          # If we visited each field and failed to resolve _any_,
-          # then we're stuck.
-          if @late_bound_fields == prev_late_bound_fields
-            type_names = prev_late_bound_fields.map { |f| f[1] }.map(&:type).map(&:unwrap).map(&:name).uniq
-            raise <<-ERR
-Some late-bound types couldn't be resolved:
-
-- #{type_names}
-- Found __* types: #{@type_map.keys.select { |k| k.start_with?("__") }}
-            ERR
-          else
-            resolve_late_bound_fields
-          end
-        end
-      end
-
-      # The late-bound type may be wrapped with list or non-null types.
-      # Apply the same wrapping to the resolve type and
-      # return the maybe-wrapped type
-      def rewrap_resolved_type(late_bound_type, resolved_inner_type)
-        case late_bound_type
-        when GraphQL::NonNullType
-          rewrap_resolved_type(late_bound_type.of_type, resolved_inner_type).to_non_null_type
-        when GraphQL::ListType
-          rewrap_resolved_type(late_bound_type.of_type, resolved_inner_type).to_list_type
-        when GraphQL::Schema::LateBoundType
-          resolved_inner_type
-        else
-          raise "Unexpected late_bound_type: #{late_bound_type.inspect} (#{late_bound_type.class})"
-        end
-      end
-
-      def visit(schema, member, context_description)
-        case member
-        when GraphQL::Schema
-          member.directives.each { |name, directive| visit(schema, directive, "Directive #{name}") }
-          # Find the starting points, then visit them
-          visit_roots = [member.query, member.mutation, member.subscription]
-          if @introspection
-            introspection_types = schema.introspection_system.types.values
-            visit_roots.concat(introspection_types)
-            if member.query
-              member.introspection_system.entry_points.each do |introspection_field|
-                # Visit this so that arguments class is preconstructed
-                # Skip validation since it begins with "__"
-                visit_field_on_type(schema, member.query, introspection_field, dynamic_field: true)
-              end
-            end
-          end
-          visit_roots.concat(member.orphan_types)
-          visit_roots.compact!
-          visit_roots.each { |t| visit(schema, t, t.name) }
-        when GraphQL::Directive
-          member.arguments.each do |name, argument|
-            @type_reference_map[argument.type.unwrap.to_s] << argument
-            visit(schema, argument.type, "Directive argument #{member.name}.#{name}")
-          end
-          # Construct arguments class here, which is later used to generate GraphQL::Query::Arguments
-          # to be passed to a resolver proc
-          GraphQL::Query::Arguments.construct_arguments_class(member)
-        when GraphQL::BaseType
-          type_defn = member.unwrap
-          prev_type = @type_map[type_defn.name]
-          # Continue to visit this type if it's the first time we've seen it:
-          if prev_type.nil?
-            validate_type(type_defn, context_description)
-            @type_map[type_defn.name] = type_defn
-            case type_defn
-            when GraphQL::ObjectType
-              type_defn.interfaces.each { |i| visit(schema, i, "Interface on #{type_defn.name}") }
-              visit_fields(schema, type_defn)
-            when GraphQL::InterfaceType
-              visit_fields(schema, type_defn)
-              type_defn.orphan_types.each do |t|
-                visit(schema, t, "Orphan type for #{type_defn.name}")
-              end
-            when GraphQL::UnionType
-              type_defn.possible_types.each do |t|
-                @union_memberships[t.name] << type_defn
-                visit(schema, t, "Possible type for #{type_defn.name}")
-              end
-            when GraphQL::InputObjectType
-              type_defn.arguments.each do |name, arg|
-                @type_reference_map[arg.type.unwrap.to_s] << arg
-                visit(schema, arg.type, "Input field #{type_defn.name}.#{name}")
-              end
-
-              # Construct arguments class here, which is later used to generate GraphQL::Query::Arguments
-              # to be passed to a resolver proc
-              if type_defn.arguments_class.nil?
-                GraphQL::Query::Arguments.construct_arguments_class(type_defn)
-              end
-            end
-          elsif !prev_type.equal?(type_defn)
-            # If the previous entry in the map isn't the same object we just found, raise.
-            raise("Duplicate type definition found for name '#{type_defn.name}' at '#{context_description}' (#{prev_type.metadata[:type_class] || prev_type}, #{type_defn.metadata[:type_class] || type_defn})")
-          end
-        when Class
-          if member.respond_to?(:graphql_definition)
-            graphql_member = member.graphql_definition
-            visit(schema, graphql_member, context_description)
-          else
-            raise GraphQL::Schema::InvalidTypeError.new("Unexpected traversal member: #{member} (#{member.class.name})")
-          end
-        else
-          message = "Unexpected schema traversal member: #{member} (#{member.class.name})"
-          raise GraphQL::Schema::InvalidTypeError.new(message)
-        end
-      end
-
-      def visit_fields(schema, type_defn)
-        type_defn.all_fields.each do |field_defn|
-          visit_field_on_type(schema, type_defn, field_defn)
-        end
-      end
-
-      def visit_field_on_type(schema, type_defn, field_defn, dynamic_field: false)
-        base_return_type = field_defn.type.unwrap
-        if base_return_type.is_a?(GraphQL::Schema::LateBoundType)
-          @late_bound_fields << [type_defn, field_defn, dynamic_field]
-          return
-        end
-        if dynamic_field
-          # Don't apply instrumentation to dynamic fields since they're shared constants
-          instrumented_field_defn = field_defn
-        else
-          instrumented_field_defn = @field_instrumenters.reduce(field_defn) do |defn, inst|
-            inst.instrument(type_defn, defn)
-          end
-          @instrumented_field_map[type_defn.name][instrumented_field_defn.name] = instrumented_field_defn
-        end
-        @type_reference_map[instrumented_field_defn.type.unwrap.name] << instrumented_field_defn
-        visit(schema, instrumented_field_defn.type, "Field #{type_defn.name}.#{instrumented_field_defn.name}'s return type")
-        instrumented_field_defn.arguments.each do |name, arg|
-          @type_reference_map[arg.type.unwrap.to_s] << arg
-          visit(schema, arg.type, "Argument #{name} on #{type_defn.name}.#{instrumented_field_defn.name}")
-        end
-
-        # Construct arguments class here, which is later used to generate GraphQL::Query::Arguments
-        # to be passed to a resolver proc
-        GraphQL::Query::Arguments.construct_arguments_class(instrumented_field_defn)
-      end
-
-      def validate_type(member, context_description)
-        error_message = GraphQL::Schema::Validation.validate(member)
-        if error_message
-          raise GraphQL::Schema::InvalidTypeError.new("#{context_description} is invalid: #{error_message}")
-        end
-      end
-    end
-  end
-end