graphql 1.9.0 → 2.1.1

data/lib/graphql/execution/instrumentation.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Execution
-    module Instrumentation
-      # This function implements the instrumentation policy:
-      #
-      # - Instrumenters are a stack; the first `before_query` will have the last `after_query`
-      # - If a `before_` hook returned without an error, its corresponding `after_` hook will run.
-      # - If the `before_` hook did _not_ run, the `after_` hook will not be called.
-      #
-      # When errors are raised from `after_` hooks:
-      #   - Subsequent `after_` hooks _are_ called
-      #   - The first raised error is captured; later errors are ignored
-      #   - If an error was capture, it's re-raised after all hooks are finished
-      #
-      # Partial runs of instrumentation are possible:
-      # - If a `before_multiplex` hook raises an error, no `before_query` hooks will run
-      # - If a `before_query` hook raises an error, subsequent `before_query` hooks will not run (on any query)
-      def self.apply_instrumenters(multiplex)
-        schema = multiplex.schema
-        queries = multiplex.queries
-        query_instrumenters = schema.instrumenters[:query]
-        multiplex_instrumenters = schema.instrumenters[:multiplex]
-
-        # First, run multiplex instrumentation, then query instrumentation for each query
-        call_hooks(multiplex_instrumenters, multiplex, :before_multiplex, :after_multiplex) do
-          each_query_call_hooks(query_instrumenters, queries) do
-            # Let them be executed
-            yield
-          end
-        end
-      end
-
-      class << self
-        private
-        # Call the before_ hooks of each query,
-        # Then yield if no errors.
-        # `call_hooks` takes care of appropriate cleanup.
-        def each_query_call_hooks(instrumenters, queries, i = 0)
-          if i >= queries.length
-            yield
-          else
-            query = queries[i]
-            call_hooks(instrumenters, query, :before_query, :after_query) {
-              each_query_call_hooks(instrumenters, queries, i + 1) {
-                yield
-              }
-            }
-          end
-        end
-
-        # Call each before hook, and if they all succeed, yield.
-        # If they don't all succeed, call after_ for each one that succeeded.
-        def call_hooks(instrumenters, object, before_hook_name, after_hook_name)
-          begin
-            successful = []
-            instrumenters.each do |instrumenter|
-              instrumenter.public_send(before_hook_name, object)
-              successful << instrumenter
-            end
-
-            # if any before hooks raise an exception, quit calling before hooks,
-            # but call the after hooks on anything that succeeded but also
-            # raise the exception that came from the before hook.
-          rescue GraphQL::ExecutionError => err
-            object.context.errors << err
-          rescue => e
-            raise call_after_hooks(successful, object, after_hook_name, e)
-          end
-
-          begin
-            yield # Call the user code
-          ensure
-            ex = call_after_hooks(successful, object, after_hook_name, nil)
-            raise ex if ex
-          end
-        end
-
-        def call_after_hooks(instrumenters, object, after_hook_name, ex)
-          instrumenters.reverse.each do |instrumenter|
-            begin
-              instrumenter.public_send(after_hook_name, object)
-            rescue => e
-              ex = e
-            end
-          end
-          ex
-        end
-      end
-    end
-  end
-end

data/lib/graphql/execution/interpreter/hash_response.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Execution
-    class Interpreter
-      # This response class handles `#write` by accumulating
-      # values into a Hash.
-      class HashResponse
-        def initialize
-          @result = {}
-        end
-
-        def final_value
-          @result
-        end
-
-        def inspect
-          "#<#{self.class.name} result=#{@result.inspect}>"
-        end
-
-        # Add `value` at `path`.
-        # @return [void]
-        def write(path, value)
-          if path.empty?
-            @result = value
-          elsif (write_target = @result)
-            i = 0
-            prefinal_steps = path.size - 1
-            # Use `while` to avoid a closure
-            while i < prefinal_steps
-              path_part = path[i]
-              i += 1
-              write_target = write_target[path_part]
-            end
-            path_part = path[i]
-            write_target[path_part] = value
-          else
-            # The response is completely nulled out
-          end
-
-          nil
-        end
-      end
-    end
-  end
-end

data/lib/graphql/execution/lazy/resolve.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Execution
-    class Lazy
-      # Helpers for dealing with data structures containing {Lazy} instances
-      # @api private
-      module Resolve
-        # Mutate `value`, replacing {Lazy} instances in place with their resolved values
-        # @return [void]
-
-        # This object can be passed like an array, but it doesn't allocate an
-        # array until it's used.
-        #
-        # There's one crucial difference: you have to _capture_ the result
-        # of `#<<`. (This _works_ with arrays but isn't required, since it has a side-effect.)
-        # @api private
-        module NullAccumulator
-          def self.<<(item)
-            [item]
-          end
-
-          def self.empty?
-            true
-          end
-        end
-
-        def self.resolve(value)
-          lazies = resolve_in_place(value)
-          deep_sync(lazies)
-        end
-
-        def self.resolve_in_place(value)
-          acc = each_lazy(NullAccumulator, value)
-
-          if acc.empty?
-            Lazy::NullResult
-          else
-            Lazy.new {
-              acc.each_with_index { |ctx, idx|
-                acc[idx] = ctx.value.value
-              }
-              resolve_in_place(acc)
-            }
-          end
-        end
-
-        # If `value` is a collection,
-        # add any {Lazy} instances in the collection
-        # to `acc`
-        # @return [void]
-        def self.each_lazy(acc, value)
-          case value
-          when Hash
-            value.each do |key, field_result|
-              acc = each_lazy(acc, field_result)
-            end
-          when Array
-            value.each do |field_result|
-              acc = each_lazy(acc, field_result)
-            end
-          when Query::Context::SharedMethods
-            field_value = value.value
-            case field_value
-            when Lazy
-              acc = acc << value
-            when Enumerable # shortcut for Hash & Array
-              acc = each_lazy(acc, field_value)
-            end
-          end
-
-          acc
-        end
-
-        # Traverse `val`, triggering resolution for each {Lazy}.
-        # These {Lazy}s are expected to mutate their owner data structures
-        # during resolution! (They're created with the `.then` calls in `resolve_in_place`).
-        # @return [void]
-        def self.deep_sync(val)
-          case val
-          when Lazy
-            deep_sync(val.value)
-          when Array
-            val.each { |v| deep_sync(v.value) }
-          when Hash
-            val.each { |k, v| deep_sync(v.value) }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/execution/typecast.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Execution
-    # @api private
-    module Typecast
-      # @return [Boolean]
-      def self.subtype?(parent_type, child_type)
-        if parent_type == child_type
-          # Equivalent types are subtypes
-          true
-        elsif child_type.is_a?(GraphQL::NonNullType)
-          # A non-null type is a subtype of a nullable type
-          # if its inner type is a subtype of that type
-          if parent_type.is_a?(GraphQL::NonNullType)
-            subtype?(parent_type.of_type, child_type.of_type)
-          else
-            subtype?(parent_type, child_type.of_type)
-          end
-        else
-          case parent_type
-          when GraphQL::InterfaceType
-            # A type is a subtype of an interface
-            # if it implements that interface
-            case child_type
-            when GraphQL::ObjectType
-              child_type.interfaces.include?(parent_type)
-            else
-              false
-            end
-          when GraphQL::UnionType
-            # A type is a subtype of that union
-            # if the union includes that type
-            parent_type.possible_types.include?(child_type)
-          when GraphQL::ListType
-            # A list type is a subtype of another list type
-            # if its inner type is a subtype of the other inner type
-            case child_type
-            when GraphQL::ListType
-              subtype?(parent_type.of_type, child_type.of_type)
-            else
-              false
-            end
-          else
-            false
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/field/resolve.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  class Field
-    # Create resolve procs ahead of time based on a {GraphQL::Field}'s `name`, `property`, and `hash_key` configuration.
-    module Resolve
-      module_function
-
-      # @param field [GraphQL::Field] A field that needs a resolve proc
-      # @return [Proc] A resolver for this field, based on its config
-      def create_proc(field)
-        if field.property
-          MethodResolve.new(field)
-        elsif !field.hash_key.nil?
-          HashKeyResolve.new(field.hash_key)
-        else
-          NameResolve.new(field)
-        end
-      end
-
-      # These only require `obj` as input
-      class BuiltInResolve
-      end
-
-      # Resolve the field by `public_send`ing `@method_name`
-      class MethodResolve < BuiltInResolve
-        def initialize(field)
-          @method_name = field.property.to_sym
-        end
-
-        def call(obj, args, ctx)
-          obj.public_send(@method_name)
-        end
-      end
-
-      # Resolve the field by looking up `@hash_key` with `#[]`
-      class HashKeyResolve < BuiltInResolve
-        def initialize(hash_key)
-          @hash_key = hash_key
-        end
-
-        def call(obj, args, ctx)
-          obj[@hash_key]
-        end
-      end
-
-      # Call the field's name at query-time since
-      # it might have changed
-      class NameResolve < BuiltInResolve
-        def initialize(field)
-          @field = field
-        end
-
-        def call(obj, args, ctx)
-          obj.public_send(@field.name)
-        end
-      end
-    end
-  end
-end

data/lib/graphql/field.rb

@@ -1,330 +0,0 @@
-# frozen_string_literal: true
-require "graphql/field/resolve"
-
-module GraphQL
-  # {Field}s belong to {ObjectType}s and {InterfaceType}s.
-  #
-  # They're usually created with the `field` helper. If you create it by hand, make sure {#name} is a String.
-  #
-  # A field must have a return type, but if you want to defer the return type calculation until later,
-  # you can pass a proc for the return type. That proc will be called when the schema is defined.
-  #
-  # @example Lazy type resolution
-  #   # If the field's type isn't defined yet, you can pass a proc
-  #   field :city, -> { TypeForModelName.find("City") }
-  #
-  # For complex field definition, you can pass a block to the `field` helper, eg `field :name do ... end`.
-  # This block is equivalent to calling `GraphQL::Field.define { ... }`.
-  #
-  # @example Defining a field with a block
-  #   field :city, CityType do
-  #     # field definition continues inside the block
-  #   end
-  #
-  # ## Resolve
-  #
-  # Fields have `resolve` functions to determine their values at query-time.
-  # The default implementation is to call a method on the object based on the field name.
-  #
-  # @example Create a field which calls a method with the same name.
-  #   GraphQL::ObjectType.define do
-  #     field :name, types.String, "The name of this thing "
-  #   end
-  #
-  # You can specify a custom proc with the `resolve` helper.
-  #
-  # There are some shortcuts for common `resolve` implementations:
-  #   - Provide `property:` to call a method with a different name than the field name
-  #   - Provide `hash_key:` to resolve the field by doing a key lookup, eg `obj[:my_hash_key]`
-  #
-  # @example Create a field that calls a different method on the object
-  #   GraphQL::ObjectType.define do
-  #     # use the `property` keyword:
-  #     field :firstName, types.String, property: :first_name
-  #   end
-  #
-  # @example Create a field looks up with `[hash_key]`
-  #   GraphQL::ObjectType.define do
-  #     # use the `hash_key` keyword:
-  #     field :firstName, types.String, hash_key: :first_name
-  #   end
-  #
-  # ## Arguments
-  #
-  # Fields can take inputs; they're called arguments. You can define them with the `argument` helper.
-  #
-  # @example Create a field with an argument
-  #   field :students, types[StudentType] do
-  #     argument :grade, types.Int
-  #     resolve ->(obj, args, ctx) {
-  #       Student.where(grade: args[:grade])
-  #     }
-  #   end
-  #
-  # They can have default values which will be provided to `resolve` if the query doesn't include a value.
-  #
-  # @example Argument with a default value
-  #   field :events, types[EventType] do
-  #     # by default, don't include past events
-  #     argument :includePast, types.Boolean, default_value: false
-  #     resolve ->(obj, args, ctx) {
-  #       args[:includePast] # => false if no value was provided in the query
-  #       # ...
-  #     }
-  #   end
-  #
-  # Only certain types maybe used for inputs:
-  #
-  # - Scalars
-  # - Enums
-  # - Input Objects
-  # - Lists of those types
-  #
-  # Input types may also be non-null -- in that case, the query will fail
-  # if the input is not present.
-  #
-  # ## Complexity
-  #
-  # Fields can have _complexity_ values which describe the computation cost of resolving the field.
-  # You can provide the complexity as a constant with `complexity:` or as a proc, with the `complexity` helper.
-  #
-  # @example Custom complexity values
-  #   # Complexity can be a number or a proc.
-  #
-  #   # Complexity can be defined with a keyword:
-  #   field :expensive_calculation, !types.Int, complexity: 10
-  #
-  #   # Or inside the block:
-  #   field :expensive_calculation_2, !types.Int do
-  #     complexity ->(ctx, args, child_complexity) { ctx[:current_user].staff? ? 0 : 10 }
-  #   end
-  #
-  # @example Calculating the complexity of a list field
-  #   field :items, types[ItemType] do
-  #     argument :limit, !types.Int
-  #     # Multiply the child complexity by the possible items on the list
-  #     complexity ->(ctx, args, child_complexity) { child_complexity * args[:limit] }
-  #   end
-  #
-  # @example Creating a field, then assigning it to a type
-  #   name_field = GraphQL::Field.define do
-  #     name("Name")
-  #     type(!types.String)
-  #     description("The name of this thing")
-  #     resolve ->(object, arguments, context) { object.name }
-  #   end
-  #
-  #   NamedType = GraphQL::ObjectType.define do
-  #     # The second argument may be a GraphQL::Field
-  #     field :name, name_field
-  #   end
-  #
-  class Field
-    include GraphQL::Define::InstanceDefinable
-    accepts_definitions :name, :description, :deprecation_reason,
-      :resolve, :lazy_resolve,
-      :type, :arguments,
-      :property, :hash_key, :complexity,
-      :mutation, :function,
-      :edge_class,
-      :relay_node_field,
-      :relay_nodes_field,
-      :subscription_scope,
-      :trace,
-      :introspection,
-      argument: GraphQL::Define::AssignArgument
-
-    ensure_defined(
-      :name, :deprecation_reason, :description, :description=, :property, :hash_key,
-      :mutation, :arguments, :complexity, :function,
-      :resolve, :resolve=, :lazy_resolve, :lazy_resolve=, :lazy_resolve_proc, :resolve_proc,
-      :type, :type=, :name=, :property=, :hash_key=,
-      :relay_node_field, :relay_nodes_field, :edges?, :edge_class, :subscription_scope,
-      :introspection?
-    )
-
-    # @return [Boolean] True if this is the Relay find-by-id field
-    attr_accessor :relay_node_field
-
-    # @return [Boolean] True if this is the Relay find-by-ids field
-    attr_accessor :relay_nodes_field
-
-    # @return [<#call(obj, args, ctx)>] A proc-like object which can be called to return the field's value
-    attr_reader :resolve_proc
-
-    # @return [<#call(obj, args, ctx)>] A proc-like object which can be called trigger a lazy resolution
-    attr_reader :lazy_resolve_proc
-
-    # @return [String] The name of this field on its {GraphQL::ObjectType} (or {GraphQL::InterfaceType})
-    attr_reader :name
-    alias :graphql_name :name
-
-    # @return [String, nil] The client-facing description of this field
-    attr_accessor :description
-
-    # @return [String, nil] The client-facing reason why this field is deprecated (if present, the field is deprecated)
-    attr_accessor :deprecation_reason
-
-    # @return [Hash<String => GraphQL::Argument>] Map String argument names to their {GraphQL::Argument} implementations
-    attr_accessor :arguments
-
-    # @return [GraphQL::Relay::Mutation, nil] The mutation this field was derived from, if it was derived from a mutation
-    attr_accessor :mutation
-
-    # @return [Numeric, Proc] The complexity for this field (default: 1), as a constant or a proc like `->(query_ctx, args, child_complexity) { } # Numeric`
-    attr_accessor :complexity
-
-    # @return [Symbol, nil] The method to call on `obj` to return this field (overrides {#name} if present)
-    attr_reader :property
-
-    # @return [Object, nil] The key to access with `obj.[]` to resolve this field (overrides {#name} if present)
-    attr_reader :hash_key
-
-    # @return [Object, GraphQL::Function] The function used to derive this field
-    attr_accessor :function
-
-    attr_accessor :arguments_class
-
-    attr_writer :connection
-    attr_writer :introspection
-
-    # @return [nil, String] Prefix for subscription names from this field
-    attr_accessor :subscription_scope
-
-    # @return [Boolean] True if this field should be traced. By default, fields are only traced if they are not a ScalarType or EnumType.
-    attr_accessor :trace
-
-    attr_accessor :ast_node
-
-    # @return [Boolean]
-    def connection?
-      @connection
-    end
-
-    # @return [nil, Class]
-    # @api private
-    attr_accessor :edge_class
-
-    # @return [Boolean]
-    def edges?
-      !!@edge_class
-    end
-
-    # @return [nil, Integer]
-    attr_accessor :connection_max_page_size
-
-    def initialize
-      @complexity = 1
-      @arguments = {}
-      @resolve_proc = build_default_resolver
-      @lazy_resolve_proc = DefaultLazyResolve
-      @relay_node_field = false
-      @connection = false
-      @connection_max_page_size = nil
-      @edge_class = nil
-      @trace = nil
-      @introspection = false
-    end
-
-    def initialize_copy(other)
-      ensure_defined
-      super
-      @arguments = other.arguments.dup
-    end
-
-    # @return [Boolean] Is this field a predefined introspection field?
-    def introspection?
-      @introspection
-    end
-
-    # Get a value for this field
-    # @example resolving a field value
-    #   field.resolve(obj, args, ctx)
-    #
-    # @param object [Object] The object this field belongs to
-    # @param arguments [Hash] Arguments declared in the query
-    # @param context [GraphQL::Query::Context]
-    def resolve(object, arguments, context)
-      resolve_proc.call(object, arguments, context)
-    end
-
-    # Provide a new callable for this field's resolve function. If `nil`,
-    # a new resolve proc will be build based on its {#name}, {#property} or {#hash_key}.
-    # @param new_resolve_proc [<#call(obj, args, ctx)>, nil]
-    def resolve=(new_resolve_proc)
-      @resolve_proc = new_resolve_proc || build_default_resolver
-    end
-
-    def type=(new_return_type)
-      @clean_type = nil
-      @dirty_type = new_return_type
-    end
-
-    # Get the return type for this field.
-    def type
-      @clean_type ||= GraphQL::BaseType.resolve_related_type(@dirty_type)
-    end
-
-    def name=(new_name)
-      old_name = @name
-      @name = new_name
-
-      if old_name != new_name && @resolve_proc.is_a?(Field::Resolve::NameResolve)
-        # Since the NameResolve would use the old field name,
-        # reset resolve proc when the name has changed
-        self.resolve = nil
-      end
-    end
-
-    # @param new_property [Symbol] A method to call to resolve this field. Overrides the existing resolve proc.
-    def property=(new_property)
-      @property = new_property
-      self.resolve = nil # reset resolve proc
-    end
-
-    # @param new_hash_key [Symbol] A key to access with `#[key]` to resolve this field. Overrides the existing resolve proc.
-    def hash_key=(new_hash_key)
-      @hash_key = new_hash_key
-      self.resolve = nil # reset resolve proc
-    end
-
-    def to_s
-      "<Field name:#{name || "not-named"} desc:#{description} resolve:#{resolve_proc}>"
-    end
-
-    # If {#resolve} returned an object which should be handled lazily,
-    # this method will be called later to force the object to return its value.
-    # @param obj [Object] The {#resolve}-provided object, registered with {Schema#lazy_resolve}
-    # @param args [GraphQL::Query::Arguments] Arguments to this field
-    # @param ctx [GraphQL::Query::Context] Context for this field
-    # @return [Object] The result of calling the registered method on `obj`
-    def lazy_resolve(obj, args, ctx)
-      @lazy_resolve_proc.call(obj, args, ctx)
-    end
-
-    # Assign a new resolve proc to this field. Used for {#lazy_resolve}
-    def lazy_resolve=(new_lazy_resolve_proc)
-      @lazy_resolve_proc = new_lazy_resolve_proc
-    end
-
-    # Prepare a lazy value for this field. It may be `then`-ed and resolved later.
-    # @return [GraphQL::Execution::Lazy] A lazy wrapper around `obj` and its registered method name
-    def prepare_lazy(obj, args, ctx)
-      GraphQL::Execution::Lazy.new {
-        lazy_resolve(obj, args, ctx)
-      }
-    end
-
-    private
-
-    def build_default_resolver
-      GraphQL::Field::Resolve.create_proc(self)
-    end
-
-    module DefaultLazyResolve
-      def self.call(obj, args, ctx)
-        ctx.schema.sync_lazy(obj)
-      end
-    end
-  end
-end