graphql 0.16.0 → 2.0.15

data/lib/graphql/pagination/connection.rb

@@ -0,0 +1,253 @@
+# 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 and no `default_page_size` is set.
+      # @param default_page_size [Integer, nil] A configured value to determine the result size when neither first or last are given.
+      def initialize(items, parent: nil, field: nil, context: nil, first: nil, after: nil, max_page_size: :not_given, default_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
+        @has_default_page_size_override = default_page_size != :not_given
+        @default_page_size = if default_page_size == :not_given
+          nil
+        else
+          default_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
+
+      def default_page_size=(new_value)
+        @has_default_page_size_override = true
+        @default_page_size = new_value
+      end
+
+      def default_page_size
+        if @has_default_page_size_override
+          @default_page_size
+        else
+          context.schema.default_page_size
+        end
+      end
+
+      def has_default_page_size_override?
+        @has_default_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 `default_page_size` is
+      #   present, default_page_size is used for first. If `default_page_size`
+      #   is greater than `max_page_size``, it'll be clamped down to
+      #   `max_page_size`. If `default_page_size` is nil, use `max_page_size`.
+      def first
+        @first ||= begin
+          capped = limit_pagination_argument(@first_value, max_page_size)
+          if capped.nil? && last.nil?
+            capped = limit_pagination_argument(default_page_size, max_page_size) || 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,135 @@
+# 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 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
+          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,
+            default_page_size: field.has_default_page_size? ? field.default_page_size : context.schema.default_page_size,
+            first: arguments[:first],
+            after: arguments[:after],
+            last: arguments[:last],
+            before: arguments[:before],
+            arguments: arguments,
+            edge_class: edge_class_for_field(field),
+          )
+        else
+          raise ImplementationMissingError, "Couldn't find a connection wrapper for #{items.class} during #{field.path} (#{items.inspect})"
+        end
+      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 != Pagination::Connection::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
+
+        # Mongoid 7.3+
+        if defined?(Mongoid::Association::Referenced::HasMany::Enumerable)
+          add(Mongoid::Association::Referenced::HasMany::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

data/lib/graphql/pagination/relation_connection.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+require "graphql/pagination/connection"
+
+module GraphQL
+  module Pagination
+    # A generic class for working with database query objects.
+    class RelationConnection < Pagination::Connection
+      def nodes
+        load_nodes
+        @nodes
+      end
+
+      def has_previous_page
+        if @has_previous_page.nil?
+          @has_previous_page = if after_offset && after_offset > 0
+            true
+          elsif last
+            # See whether there are any nodes _before_ the current offset.
+            # If there _is no_ current offset, then there can't be any nodes before it.
+            # Assume that if the offset is positive, there are nodes before the offset.
+            limited_nodes
+            !(@paged_nodes_offset.nil? || @paged_nodes_offset == 0)
+          else
+            false
+          end
+        end
+        @has_previous_page
+      end
+
+      def has_next_page
+        if @has_next_page.nil?
+          @has_next_page = if before_offset && before_offset > 0
+            true
+          elsif first
+            if @nodes && @nodes.count < first
+              false
+            else
+              relation_larger_than(sliced_nodes, @sliced_nodes_offset, first)
+            end
+          else
+            false
+          end
+        end
+        @has_next_page
+      end
+
+      def cursor_for(item)
+        load_nodes
+        # index in nodes + existing offset + 1 (because it's offset, not index)
+        offset = nodes.index(item) + 1 + (@paged_nodes_offset || 0) - (relation_offset(items) || 0)
+        encode(offset.to_s)
+      end
+
+      private
+
+      # @param relation [Object] A database query object
+      # @param _initial_offset [Integer] The number of items already excluded from the relation
+      # @param size [Integer] The value against which we check the relation size
+      # @return [Boolean] True if the number of items in this relation is larger than `size`
+      def relation_larger_than(relation, _initial_offset, size)
+        relation_count(set_limit(relation, size + 1)) == size + 1
+      end
+
+      # @param relation [Object] A database query object
+      # @return [Integer, nil] The offset value, or nil if there isn't one
+      def relation_offset(relation)
+        raise "#{self.class}#relation_offset(relation) must return the offset value for a #{relation.class} (#{relation.inspect})"
+      end
+
+      # @param relation [Object] A database query object
+      # @return [Integer, nil] The limit value, or nil if there isn't one
+      def relation_limit(relation)
+        raise "#{self.class}#relation_limit(relation) must return the limit value for a #{relation.class} (#{relation.inspect})"
+      end
+
+      # @param relation [Object] A database query object
+      # @return [Integer, nil] The number of items in this relation (hopefully determined without loading all records into memory!)
+      def relation_count(relation)
+        raise "#{self.class}#relation_count(relation) must return the count of records for a #{relation.class} (#{relation.inspect})"
+      end
+
+      # @param relation [Object] A database query object
+      # @return [Object] A modified query object which will return no records
+      def null_relation(relation)
+        raise "#{self.class}#null_relation(relation) must return an empty relation for a #{relation.class} (#{relation.inspect})"
+      end
+
+      # @return [Integer]
+      def offset_from_cursor(cursor)
+        decode(cursor).to_i
+      end
+
+      # Abstract this operation so we can always ignore inputs less than zero.
+      # (Sequel doesn't like it, understandably.)
+      def set_offset(relation, offset_value)
+        if offset_value >= 0
+          relation.offset(offset_value)
+        else
+          relation.offset(0)
+        end
+      end
+
+      # Abstract this operation so we can always ignore inputs less than zero.
+      # (Sequel doesn't like it, understandably.)
+      def set_limit(relation, limit_value)
+        if limit_value > 0
+          relation.limit(limit_value)
+        elsif limit_value == 0
+          null_relation(relation)
+        else
+          relation
+        end
+      end
+
+      def calculate_sliced_nodes_parameters
+        if defined?(@sliced_nodes_limit)
+          return
+        else
+          next_offset = relation_offset(items) || 0
+          relation_limit = relation_limit(items)
+
+          if after_offset
+            next_offset += after_offset
+          end
+
+          if before_offset && after_offset
+            if after_offset < before_offset
+              # Get the number of items between the two cursors
+              space_between = before_offset - after_offset - 1
+              relation_limit = space_between
+            else
+              # The cursors overextend one another to an empty set
+              @sliced_nodes_null_relation = true
+            end
+          elsif before_offset
+            # Use limit to cut off the tail of the relation
+            relation_limit = before_offset - 1
+          end
+
+          @sliced_nodes_limit = relation_limit
+          @sliced_nodes_offset = next_offset
+        end
+      end
+
+      # Apply `before` and `after` to the underlying `items`,
+      # returning a new relation.
+      def sliced_nodes
+        @sliced_nodes ||= begin
+          calculate_sliced_nodes_parameters
+          paginated_nodes = items
+
+          if @sliced_nodes_null_relation
+            paginated_nodes = null_relation(paginated_nodes)
+          else
+            if @sliced_nodes_limit
+              paginated_nodes = set_limit(paginated_nodes, @sliced_nodes_limit)
+            end
+
+            if @sliced_nodes_offset
+              paginated_nodes = set_offset(paginated_nodes, @sliced_nodes_offset)
+            end
+          end
+
+          paginated_nodes
+        end
+      end
+
+      # @return [Integer, nil]
+      def before_offset
+        @before_offset ||= before && offset_from_cursor(before)
+      end
+
+      # @return [Integer, nil]
+      def after_offset
+        @after_offset ||= after && offset_from_cursor(after)
+      end
+
+      # Apply `first` and `last` to `sliced_nodes`,
+      # returning a new relation
+      def limited_nodes
+        @limited_nodes ||= begin
+          calculate_sliced_nodes_parameters
+          if @sliced_nodes_null_relation
+            # it's an empty set
+            return sliced_nodes
+          end
+          relation_limit = @sliced_nodes_limit
+          relation_offset = @sliced_nodes_offset
+
+          if first && (relation_limit.nil? || relation_limit > first)
+            # `first` would create a stricter limit that the one already applied, so add it
+            relation_limit = first
+          end
+
+          if last
+            if relation_limit
+              if last <= relation_limit
+                # `last` is a smaller slice than the current limit, so apply it
+                relation_offset += (relation_limit - last)
+                relation_limit = last
+              end
+            else
+              # No limit, so get the last items
+              sliced_nodes_count = relation_count(sliced_nodes)
+              relation_offset += (sliced_nodes_count - [last, sliced_nodes_count].min)
+              relation_limit = last
+            end
+          end
+
+          @paged_nodes_offset = relation_offset
+          paginated_nodes = items
+          paginated_nodes = set_offset(paginated_nodes, relation_offset)
+          if relation_limit
+            paginated_nodes = set_limit(paginated_nodes, relation_limit)
+          end
+          paginated_nodes
+        end
+      end
+
+      # Load nodes after applying first/last/before/after,
+      # returns an array of nodes
+      def load_nodes
+        # Return an array so we can consistently use `.index(node)` on it
+        @nodes ||= limited_nodes.to_a
+      end
+    end
+  end
+end

data/lib/graphql/pagination/sequel_dataset_connection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require "graphql/pagination/relation_connection"
+
+module GraphQL
+  module Pagination
+    # Customizes `RelationConnection` to work with `Sequel::Dataset`s.
+    class SequelDatasetConnection < Pagination::RelationConnection
+      private
+
+      def relation_offset(relation)
+        relation.opts[:offset]
+      end
+
+      def relation_limit(relation)
+        relation.opts[:limit]
+      end
+
+      def relation_count(relation)
+        # Remove order to make it faster
+        relation.order(nil).count
+      end
+
+      def null_relation(relation)
+        relation.where(false)
+      end
+    end
+  end
+end

data/lib/graphql/pagination.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require "graphql/pagination/array_connection"
+require "graphql/pagination/active_record_relation_connection"
+require "graphql/pagination/connections"
+require "graphql/pagination/mongoid_relation_connection"
+require "graphql/pagination/sequel_dataset_connection"

data/lib/graphql/parse_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module GraphQL
+  class ParseError < GraphQL::Error
+    attr_reader :line, :col, :query
+    def initialize(message, line, col, query, filename: nil)
+      if filename
+        message += " (#{filename})"
+      end
+
+      super(message)
+      @line = line
+      @col = col
+      @query = query
+    end
+
+    def to_h
+      locations = line ? [{ "line" => line, "column" => col }] : []
+      {
+        "message" => message,
+        "locations" => locations,
+      }
+    end
+  end
+end