graphql 1.8.0 → 1.12.12

data/lib/graphql/object_type.rb

@@ -1,32 +1,14 @@
 # frozen_string_literal: true
 module GraphQL
-  # This type exposes fields on an object.
-  #
-  # @example defining a type for your IMDB clone
-  #   MovieType = GraphQL::ObjectType.define do
-  #     name "Movie"
-  #     description "A full-length film or a short film"
-  #     interfaces [ProductionInterface, DurationInterface]
-  #
-  #     field :runtimeMinutes, !types.Int, property: :runtime_minutes
-  #     field :director, PersonType
-  #     field :cast, CastType
-  #     field :starring, types[PersonType] do
-  #       argument :limit, types.Int
-  #       resolve ->(object, args, ctx) {
-  #         stars = object.cast.stars
-  #         args[:limit] && stars = stars.limit(args[:limit])
-  #         stars
-  #       }
-  #      end
-  #   end
-  #
+  # @api deprecated
   class ObjectType < GraphQL::BaseType
-    accepts_definitions :interfaces, :fields, :mutation, field: GraphQL::Define::AssignObjectField
+    extend Define::InstanceDefinable::DeprecatedDefine
+
+    accepts_definitions :interfaces, :fields, :mutation, :relay_node_type, field: GraphQL::Define::AssignObjectField
     accepts_definitions implements: ->(type, *interfaces, inherit: false) { type.implements(interfaces, inherit: inherit) }
 
-    attr_accessor :fields, :mutation
-    ensure_defined(:fields, :mutation, :interfaces)
+    attr_accessor :fields, :mutation, :relay_node_type
+    ensure_defined(:fields, :mutation, :interfaces, :relay_node_type)
 
     # @!attribute fields
     #   @return [Hash<String => GraphQL::Field>] Map String fieldnames to their {GraphQL::Field} implementations
@@ -37,17 +19,15 @@ module GraphQL
     def initialize
       super
       @fields = {}
-      @interface_fields = {}
-      @dirty_interfaces = []
-      @dirty_inherited_interfaces = []
+      @clean_inherited_fields = nil
+      @structural_interface_type_memberships = []
+      @inherited_interface_type_memberships = []
     end
 
     def initialize_copy(other)
       super
-      @clean_interfaces = nil
-      @clean_inherited_interfaces = nil
-      @dirty_interfaces = other.dirty_interfaces.dup
-      @dirty_inherited_interfaces = other.dirty_inherited_interfaces.dup
+      @structural_interface_type_memberships = other.structural_interface_type_memberships.dup
+      @inherited_interface_type_memberships = other.inherited_interface_type_memberships.dup
       @fields = other.fields.dup
     end
 
@@ -55,18 +35,27 @@ module GraphQL
     # @param new_interfaces [Array<GraphQL::Interface>] interfaces that this type implements
     # @deprecated Use `implements` instead of `interfaces`.
     def interfaces=(new_interfaces)
-      @clean_interfaces = nil
-      @clean_inherited_interfaces = nil
+      @structural_interface_type_memberships = []
+      @inherited_interface_type_memberships = []
       @clean_inherited_fields = nil
-
-      @dirty_inherited_interfaces = []
-      @dirty_inherited_fields = {}
       implements(new_interfaces, inherit: true)
     end
 
-    def interfaces
-      load_interfaces
-      @clean_interfaces
+    def interfaces(ctx = GraphQL::Query::NullContext)
+      ensure_defined
+      visible_ifaces = []
+      unfiltered = ctx == GraphQL::Query::NullContext
+      [@structural_interface_type_memberships, @inherited_interface_type_memberships].each do |tms|
+        tms.each do |type_membership|
+          if unfiltered || type_membership.visible?(ctx)
+            # if this is derived from a class-based object, we have to
+            # get the `.graphql_definition` of the attached interface.
+            visible_ifaces << GraphQL::BaseType.resolve_related_type(type_membership.abstract_type)
+          end
+        end
+      end
+
+      visible_ifaces
     end
 
     def kind
@@ -91,20 +80,30 @@ module GraphQL
     # This declaration will be validated when the schema is defined.
     # @param interfaces [Array<GraphQL::Interface>] add a new interface that this type implements
     # @param inherits [Boolean] If true, copy the interfaces' field definitions to this type
-    def implements(interfaces, inherit: false)
+    def implements(interfaces, inherit: false, **options)
       if !interfaces.is_a?(Array)
         raise ArgumentError, "`implements(interfaces)` must be an array, not #{interfaces.class} (#{interfaces})"
       end
-
-      @clean_interfaces = nil
       @clean_inherited_fields = nil
-      dirty_ifaces = inherit ? @dirty_inherited_interfaces : @dirty_interfaces
-      dirty_ifaces.concat(interfaces)
+
+      type_memberships = inherit ? @inherited_interface_type_memberships : @structural_interface_type_memberships
+      interfaces.each do |iface|
+        iface = BaseType.resolve_related_type(iface)
+        if iface.is_a?(GraphQL::InterfaceType)
+          type_memberships << iface.type_membership_class.new(iface, self, **options)
+        end
+      end
+    end
+
+    def resolve_type_proc
+      nil
     end
 
+    attr_writer :structural_interface_type_memberships
+
     protected
 
-    attr_reader :dirty_interfaces, :dirty_inherited_interfaces
+    attr_reader :structural_interface_type_memberships, :inherited_interface_type_memberships
 
     private
 
@@ -113,24 +112,18 @@ module GraphQL
     end
 
     def interface_fields
-      load_interfaces
-      @clean_inherited_fields
-    end
-
-    def load_interfaces
-      @clean_interfaces ||= begin
+      if @clean_inherited_fields
+        @clean_inherited_fields
+      else
         ensure_defined
-        clean_ifaces = normalize_interfaces(@dirty_interfaces)
-        clean_inherited_ifaces = normalize_interfaces(@dirty_inherited_interfaces)
-        inherited_fields = {}
-        clean_inherited_ifaces.each do |iface|
-          # This will be found later in schema validation:
+        @clean_inherited_fields = {}
+        @inherited_interface_type_memberships.each do |type_membership|
+          iface = GraphQL::BaseType.resolve_related_type(type_membership.abstract_type)
           if iface.is_a?(GraphQL::InterfaceType)
-            inherited_fields.merge!(iface.fields)
+            @clean_inherited_fields.merge!(iface.fields)
           end
         end
-        @clean_inherited_fields = inherited_fields
-        clean_inherited_ifaces + clean_ifaces
+        @clean_inherited_fields
       end
     end
   end

data/lib/graphql/pagination/active_record_relation_connection.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require "graphql/pagination/relation_connection"
+
+module GraphQL
+  module Pagination
+    # Customizes `RelationConnection` to work with `ActiveRecord::Relation`s.
+    class ActiveRecordRelationConnection < Pagination::RelationConnection
+      private
+
+      def relation_larger_than(relation, size)
+        initial_offset = relation.offset_value || 0
+        relation.offset(initial_offset + size).exists?
+      end
+
+      def relation_count(relation)
+        int_or_hash = if relation.respond_to?(:unscope)
+          relation.unscope(:order).count(:all)
+        else
+          # Rails 3
+          relation.count
+        end
+        if int_or_hash.is_a?(Integer)
+          int_or_hash
+        else
+          # Grouped relations return count-by-group hashes
+          int_or_hash.length
+        end
+      end
+
+      def relation_limit(relation)
+        relation.limit_value
+      end
+
+      def relation_offset(relation)
+        relation.offset_value
+      end
+
+      def null_relation(relation)
+        if relation.respond_to?(:none)
+          relation.none
+        else
+          # Rails 3
+          relation.where("1=2")
+        end
+      end
+    end
+  end
+end

data/lib/graphql/pagination/array_connection.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require "graphql/pagination/connection"
+
+module GraphQL
+  module Pagination
+    class ArrayConnection < Pagination::Connection
+      def nodes
+        load_nodes
+        @nodes
+      end
+
+      def has_previous_page
+        load_nodes
+        @has_previous_page
+      end
+
+      def has_next_page
+        load_nodes
+        @has_next_page
+      end
+
+      def cursor_for(item)
+        idx = items.find_index(item) + 1
+        encode(idx.to_s)
+      end
+
+      private
+
+      def index_from_cursor(cursor)
+        decode(cursor).to_i
+      end
+
+      # Populate all the pagination info _once_,
+      # It doesn't do anything on subsequent calls.
+      def load_nodes
+        @nodes ||= begin
+          sliced_nodes = if before && after
+            items[index_from_cursor(after)..index_from_cursor(before)-1] || []
+          elsif before
+            items[0..index_from_cursor(before)-2] || []
+          elsif after
+            items[index_from_cursor(after)..-1] || []
+          else
+            items
+          end
+
+          @has_previous_page = if last
+            # There are items preceding the ones in this result
+            sliced_nodes.count > last
+          elsif after
+            # We've paginated into the Array a bit, there are some behind us
+            index_from_cursor(after) > 0
+          else
+            false
+          end
+
+          @has_next_page = if first
+            # There are more items after these items
+            sliced_nodes.count > first
+          elsif before
+            # The original array is longer than the `before` index
+            index_from_cursor(before) < items.length + 1
+          else
+            false
+          end
+
+          limited_nodes = sliced_nodes
+
+          limited_nodes = limited_nodes.first(first) if first
+          limited_nodes = limited_nodes.last(last) if last
+
+          limited_nodes
+        end
+      end
+    end
+  end
+end

data/lib/graphql/pagination/connection.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Pagination
+    # A Connection wraps a list of items and provides cursor-based pagination over it.
+    #
+    # Connections were introduced by Facebook's `Relay` front-end framework, but
+    # proved to be generally useful for GraphQL APIs. When in doubt, use connections
+    # to serve lists (like Arrays, ActiveRecord::Relations) via GraphQL.
+    #
+    # Unlike the previous connection implementation, these default to bidirectional pagination.
+    #
+    # Pagination arguments and context may be provided at initialization or assigned later (see {Schema::Field::ConnectionExtension}).
+    class Connection
+      class PaginationImplementationMissingError < GraphQL::Error
+      end
+
+      # @return [Object] A list object, from the application. This is the unpaginated value passed into the connection.
+      attr_reader :items
+
+      # @return [GraphQL::Query::Context]
+      attr_accessor :context
+
+      # @return [Object] the object this collection belongs to
+      attr_accessor :parent
+
+      # Raw access to client-provided values. (`max_page_size` not applied to first or last.)
+      attr_accessor :before_value, :after_value, :first_value, :last_value
+
+      # @return [String, nil] the client-provided cursor. `""` is treated as `nil`.
+      def before
+        if defined?(@before)
+          @before
+        else
+          @before = @before_value == "" ? nil : @before_value
+        end
+      end
+
+      # @return [String, nil] the client-provided cursor. `""` is treated as `nil`.
+      def after
+        if defined?(@after)
+          @after
+        else
+          @after = @after_value == "" ? nil : @after_value
+        end
+      end
+
+      # @return [Hash<Symbol => Object>] The field arguments from the field that returned this connection
+      attr_accessor :arguments
+
+      # @param items [Object] some unpaginated collection item, like an `Array` or `ActiveRecord::Relation`
+      # @param context [Query::Context]
+      # @param parent [Object] The object this collection belongs to
+      # @param first [Integer, nil] The limit parameter from the client, if it provided one
+      # @param after [String, nil] A cursor for pagination, if the client provided one
+      # @param last [Integer, nil] Limit parameter from the client, if provided
+      # @param before [String, nil] A cursor for pagination, if the client provided one.
+      # @param arguments [Hash] The arguments to the field that returned the collection wrapped by this connection
+      # @param max_page_size [Integer, nil] A configured value to cap the result size. Applied as `first` if neither first or last are given.
+      def initialize(items, parent: nil, field: nil, context: nil, first: nil, after: nil, max_page_size: :not_given, last: nil, before: nil, edge_class: nil, arguments: nil)
+        @items = items
+        @parent = parent
+        @context = context
+        @field = field
+        @first_value = first
+        @after_value = after
+        @last_value = last
+        @before_value = before
+        @arguments = arguments
+        @edge_class = edge_class || self.class::Edge
+        # This is only true if the object was _initialized_ with an override
+        # or if one is assigned later.
+        @has_max_page_size_override = max_page_size != :not_given
+        @max_page_size = if max_page_size == :not_given
+          nil
+        else
+          max_page_size
+        end
+      end
+
+      def max_page_size=(new_value)
+        @has_max_page_size_override = true
+        @max_page_size = new_value
+      end
+
+      def max_page_size
+        if @has_max_page_size_override
+          @max_page_size
+        else
+          context.schema.default_max_page_size
+        end
+      end
+
+      def has_max_page_size_override?
+        @has_max_page_size_override
+      end
+
+      attr_writer :first
+      # @return [Integer, nil]
+      #   A clamped `first` value.
+      #   (The underlying instance variable doesn't have limits on it.)
+      #   If neither `first` nor `last` is given, but `max_page_size` is present, max_page_size is used for first.
+      def first
+        @first ||= begin
+          capped = limit_pagination_argument(@first_value, max_page_size)
+          if capped.nil? && last.nil?
+            capped = max_page_size
+          end
+          capped
+        end
+      end
+
+      # This is called by `Relay::RangeAdd` -- it can be overridden
+      # when `item` needs some modifications based on this connection's state.
+      #
+      # @param item [Object] An item newly added to `items`
+      # @return [Edge]
+      def range_add_edge(item)
+        edge_class.new(item, self)
+      end
+
+      attr_writer :last
+      # @return [Integer, nil] A clamped `last` value. (The underlying instance variable doesn't have limits on it)
+      def last
+        @last ||= limit_pagination_argument(@last_value, max_page_size)
+      end
+
+      # @return [Array<Edge>] {nodes}, but wrapped with Edge instances
+      def edges
+        @edges ||= nodes.map { |n| @edge_class.new(n, self) }
+      end
+
+      # @return [Class] A wrapper class for edges of this connection
+      attr_accessor :edge_class
+
+      # @return [GraphQL::Schema::Field] The field this connection was returned by
+      attr_accessor :field
+
+      # @return [Array<Object>] A slice of {items}, constrained by {@first_value}/{@after_value}/{@last_value}/{@before_value}
+      def nodes
+        raise PaginationImplementationMissingError, "Implement #{self.class}#nodes to paginate `@items`"
+      end
+
+      # A dynamic alias for compatibility with {Relay::BaseConnection}.
+      # @deprecated use {#nodes} instead
+      def edge_nodes
+        nodes
+      end
+
+      # The connection object itself implements `PageInfo` fields
+      def page_info
+        self
+      end
+
+      # @return [Boolean] True if there are more items after this page
+      def has_next_page
+        raise PaginationImplementationMissingError, "Implement #{self.class}#has_next_page to return the next-page check"
+      end
+
+      # @return [Boolean] True if there were items before these items
+      def has_previous_page
+        raise PaginationImplementationMissingError, "Implement #{self.class}#has_previous_page to return the previous-page check"
+      end
+
+      # @return [String] The cursor of the first item in {nodes}
+      def start_cursor
+        nodes.first && cursor_for(nodes.first)
+      end
+
+      # @return [String] The cursor of the last item in {nodes}
+      def end_cursor
+        nodes.last && cursor_for(nodes.last)
+      end
+
+      # Return a cursor for this item.
+      # @param item [Object] one of the passed in {items}, taken from {nodes}
+      # @return [String]
+      def cursor_for(item)
+        raise PaginationImplementationMissingError, "Implement #{self.class}#cursor_for(item) to return the cursor for #{item.inspect}"
+      end
+
+      private
+
+      # @param argument [nil, Integer] `first` or `last`, as provided by the client
+      # @param max_page_size [nil, Integer]
+      # @return [nil, Integer] `nil` if the input was `nil`, otherwise a value between `0` and `max_page_size`
+      def limit_pagination_argument(argument, max_page_size)
+        if argument
+          if argument < 0
+            argument = 0
+          elsif max_page_size && argument > max_page_size
+            argument = max_page_size
+          end
+        end
+        argument
+      end
+
+      def decode(cursor)
+        context.schema.cursor_encoder.decode(cursor, nonce: true)
+      end
+
+      def encode(cursor)
+        context.schema.cursor_encoder.encode(cursor, nonce: true)
+      end
+
+      # A wrapper around paginated items. It includes a {cursor} for pagination
+      # and could be extended with custom relationship-level data.
+      class Edge
+        attr_reader :node
+
+        def initialize(node, connection)
+          @connection = connection
+          @node = node
+        end
+
+        def parent
+          @connection.parent
+        end
+
+        def cursor
+          @cursor ||= @connection.cursor_for(@node)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/pagination/connections.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Pagination
+    # A schema-level connection wrapper manager.
+    #
+    # Attach as a plugin.
+    #
+    # @example Adding a custom wrapper
+    #   class MySchema < GraphQL::Schema
+    #     connections.add(MyApp::SearchResults, MyApp::SearchResultsConnection)
+    #   end
+    #
+    # @example Removing default connection support for arrays (they can still be manually wrapped)
+    #   class MySchema < GraphQL::Schema
+    #     connections.delete(Array)
+    #   end
+    #
+    # @see {Schema.connections}
+    class Connections
+      class ImplementationMissingError < GraphQL::Error
+      end
+
+      def self.use(schema_defn)
+        if schema_defn.plugins.any? { |(plugin, args)| plugin == self }
+          GraphQL::Deprecation.warn("#{self} is now the default, remove `use #{self}` from #{caller(2,1).first}")
+        end
+        schema_defn.connections = self.new(schema: schema_defn)
+      end
+
+      def initialize(schema:)
+        @schema = schema
+        @wrappers = {}
+        add_default
+      end
+
+      def add(nodes_class, implementation)
+        @wrappers[nodes_class] = implementation
+      end
+
+      def delete(nodes_class)
+        @wrappers.delete(nodes_class)
+      end
+
+      def all_wrappers
+        all_wrappers = {}
+        @schema.ancestors.reverse_each do |schema_class|
+          if schema_class.respond_to?(:connections) && (c = schema_class.connections)
+            all_wrappers.merge!(c.wrappers)
+          end
+        end
+        all_wrappers
+      end
+
+      def wrapper_for(items, wrappers: all_wrappers)
+        impl = nil
+
+        items.class.ancestors.each { |cls|
+          impl = wrappers[cls]
+          break if impl
+        }
+
+        impl
+      end
+
+      # Used by the runtime to wrap values in connection wrappers.
+      # @api Private
+      def wrap(field, parent, items, arguments, context)
+        return items if GraphQL::Execution::Interpreter::RawValue === items
+        wrappers = context ? context.namespace(:connections)[:all_wrappers] : all_wrappers
+        impl = wrapper_for(items, wrappers: wrappers)
+
+        if impl.nil?
+          raise ImplementationMissingError, "Couldn't find a connection wrapper for #{items.class} during #{field.path} (#{items.inspect})"
+        end
+
+        impl.new(
+          items,
+          context: context,
+          parent: parent,
+          field: field,
+          max_page_size: field.has_max_page_size? ? field.max_page_size : context.schema.default_max_page_size,
+          first: arguments[:first],
+          after: arguments[:after],
+          last: arguments[:last],
+          before: arguments[:before],
+          arguments: arguments,
+          edge_class: edge_class_for_field(field),
+        )
+      end
+
+      # use an override if there is one
+      # @api private
+      def edge_class_for_field(field)
+        conn_type = field.type.unwrap
+        conn_type_edge_type = conn_type.respond_to?(:edge_class) && conn_type.edge_class
+        if conn_type_edge_type && conn_type_edge_type != Relay::Edge
+          conn_type_edge_type
+        else
+          nil
+        end
+      end
+      protected
+
+      attr_reader :wrappers
+
+      private
+
+      def add_default
+        add(Array, Pagination::ArrayConnection)
+
+        if defined?(ActiveRecord::Relation)
+          add(ActiveRecord::Relation, Pagination::ActiveRecordRelationConnection)
+        end
+
+        if defined?(Sequel::Dataset)
+          add(Sequel::Dataset, Pagination::SequelDatasetConnection)
+        end
+
+        if defined?(Mongoid::Criteria)
+          add(Mongoid::Criteria, Pagination::MongoidRelationConnection)
+        end
+
+        # Mongoid 5 and 6
+        if defined?(Mongoid::Relations::Targets::Enumerable)
+          add(Mongoid::Relations::Targets::Enumerable, Pagination::MongoidRelationConnection)
+        end
+
+        # Mongoid 7
+        if defined?(Mongoid::Association::Referenced::HasMany::Targets::Enumerable)
+          add(Mongoid::Association::Referenced::HasMany::Targets::Enumerable, Pagination::MongoidRelationConnection)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/pagination/mongoid_relation_connection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require "graphql/pagination/relation_connection"
+
+module GraphQL
+  module Pagination
+    class MongoidRelationConnection < Pagination::RelationConnection
+      def relation_offset(relation)
+        relation.options.skip
+      end
+
+      def relation_limit(relation)
+        relation.options.limit
+      end
+
+      def relation_count(relation)
+        # Mongo's `.count` doesn't apply limit or skip, which we need. So we have to load _everything_!
+        relation.to_a.count
+      end
+
+      def null_relation(relation)
+        relation.without_options.none
+      end
+    end
+  end
+end