graphql 1.11.10 → 1.12.0

data/lib/graphql/dataloader/request_all.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module GraphQL
+  class Dataloader
+    # @see Source#request_all which returns an instance of this.
+    class RequestAll < Request
+      def initialize(source, keys)
+        @source = source
+        @keys = keys
+      end
+
+      # Call this method to cause the current Fiber to wait for the results of this request.
+      #
+      # @return [Array<Object>] One object for each of `keys`
+      def load
+        if @keys.any? { |k| !@source.results.key?(k) }
+          @source.sync
+        end
+        @keys.map { |k| @source.results[k] }
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/source.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Dataloader
+    class Source
+      # @api private
+      attr_reader :results
+
+      # Called by {Dataloader} to prepare the {Source}'s internal state
+      # @api private
+      def setup(dataloader)
+        @pending_keys = []
+        @results = {}
+        @dataloader = dataloader
+      end
+
+      attr_reader :dataloader
+
+      # @return [Dataloader::Request] a pending request for a value from `key`. Call `.load` on that object to wait for the result.
+      def request(key)
+        if !@results.key?(key)
+          @pending_keys << key
+        end
+        Dataloader::Request.new(self, key)
+      end
+
+      # @return [Dataloader::Request] a pending request for a values from `keys`. Call `.load` on that object to wait for the results.
+      def request_all(keys)
+        pending_keys = keys.select { |k| !@results.key?(k) }
+        @pending_keys.concat(pending_keys)
+        Dataloader::RequestAll.new(self, keys)
+      end
+
+      # @param key [Object] A loading key which will be passed to {#fetch} if it isn't already in the internal cache.
+      # @return [Object] The result from {#fetch} for `key`. If `key` hasn't been loaded yet, the Fiber will yield until it's loaded.
+      def load(key)
+        if @results.key?(key)
+          @results[key]
+        else
+          @pending_keys << key
+          sync
+          @results[key]
+        end
+      end
+
+      # @param keys [Array<Object>] Loading keys which will be passed to `#fetch` (or read from the internal cache).
+      # @return [Object] The result from {#fetch} for `keys`. If `keys` haven't been loaded yet, the Fiber will yield until they're loaded.
+      def load_all(keys)
+        if keys.any? { |k| !@results.key?(k) }
+          pending_keys = keys.select { |k| !@results.key?(k) }
+          @pending_keys.concat(pending_keys)
+          sync
+        end
+
+        keys.map { |k| @results[k] }
+      end
+
+      # Subclasses must implement this method to return a value for each of `keys`
+      # @param keys [Array<Object>] keys passed to {#load}, {#load_all}, {#request}, or {#request_all}
+      # @return [Array<Object>] A loaded value for each of `keys`. The array must match one-for-one to the list of `keys`.
+      def fetch(keys)
+        # somehow retrieve these from the backend
+        raise "Implement `#{self.class}#fetch(#{keys.inspect}) to return a record for each of the keys"
+      end
+
+      # Wait for a batch, if there's anything to batch.
+      # Then run the batch and update the cache.
+      # @return [void]
+      def sync
+        @dataloader.yield
+      end
+
+      # @return [Boolean] True if this source has any pending requests for data.
+      def pending?
+        @pending_keys.any?
+      end
+
+      # Called by {GraphQL::Dataloader} to resolve and pending requests to this source.
+      # @api private
+      # @return [void]
+      def run_pending_keys
+        return if @pending_keys.empty?
+        fetch_keys = @pending_keys.uniq
+        @pending_keys = []
+        results = fetch(fetch_keys)
+        fetch_keys.each_with_index do |key, idx|
+          @results[key] = results[idx]
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/graphql/dataloader.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require "graphql/dataloader/null_dataloader"
+require "graphql/dataloader/request"
+require "graphql/dataloader/request_all"
+require "graphql/dataloader/source"
+
+module GraphQL
+  # This plugin supports Fiber-based concurrency, along with {GraphQL::Dataloader::Source}.
+  #
+  # @example Installing Dataloader
+  #
+  #   class MySchema < GraphQL::Schema
+  #     use GraphQL::Dataloader
+  #   end
+  #
+  # @example Waiting for batch-loaded data in a GraphQL field
+  #
+  #   field :team, Types::Team, null: true
+  #
+  #   def team
+  #     dataloader.with(Sources::Record, Team).load(object.team_id)
+  #   end
+  #
+  class Dataloader
+    def self.use(schema)
+      schema.dataloader_class = self
+    end
+
+    def initialize(multiplex_context)
+      @context = multiplex_context
+      @source_cache = Hash.new { |h, source_class| h[source_class] = Hash.new { |h2, batch_parameters|
+          source = source_class.new(*batch_parameters)
+          source.setup(self)
+          h2[batch_parameters] = source
+        }
+      }
+      @waiting_fibers = []
+      @yielded_fibers = Set.new
+    end
+
+    # @return [Hash] the {Multiplex} context
+    attr_reader :context
+
+    # @api private
+    attr_reader :yielded_fibers
+
+    # Add some work to this dataloader to be scheduled later.
+    # @param block Some work to enqueue
+    # @return [void]
+    def enqueue(&block)
+      @waiting_fibers << Fiber.new {
+        begin
+          yield
+        rescue StandardError => exception
+          exception
+        end
+      }
+      nil
+    end
+
+    # Tell the dataloader that this fiber is waiting for data.
+    #
+    # Dataloader will resume the fiber after the requested data has been loaded (by another Fiber).
+    #
+    # @return [void]
+    def yield
+      Fiber.yield
+      nil
+    end
+
+    # @return [Boolean] Returns true if the current Fiber has yielded once via Dataloader
+    def yielded?
+      @yielded_fibers.include?(Fiber.current)
+    end
+
+    # Run all Fibers until they're all done
+    #
+    # Each cycle works like this:
+    #
+    #   - Run each pending execution fiber (`@waiting_fibers`),
+    #   - Then run each pending Source, preparing more data for those fibers.
+    #     - Run each pending Source _again_ (if one Source requested more data from another Source)
+    #     - Continue until there are no pending sources
+    #   - Repeat: run execution fibers again ...
+    #
+    # @return [void]
+    def run
+      # Start executing Fibers. This will run until all the Fibers are done.
+      already_run_fibers = []
+      while (current_fiber = @waiting_fibers.pop)
+        # Run each execution fiber, enqueuing it in `already_run_fibers`
+        # if it's still `.alive?`.
+        # Any spin-off continuations will be enqueued in `@waiting_fibers` (via {#enqueue})
+        resume_fiber_and_enqueue_continuation(current_fiber, already_run_fibers)
+
+        if @waiting_fibers.empty?
+          # Now, run all Sources which have become pending _before_ resuming GraphQL execution.
+          # Sources might queue up other Sources, which is fine -- those will also run before resuming execution.
+          #
+          # This is where an evented approach would be even better -- can we tell which
+          # fibers are ready to continue, and continue execution there?
+          #
+          source_fiber_stack = if (first_source_fiber = create_source_fiber)
+            [first_source_fiber]
+          else
+            nil
+          end
+
+          if source_fiber_stack
+            while (outer_source_fiber = source_fiber_stack.pop)
+              resume_fiber_and_enqueue_continuation(outer_source_fiber, source_fiber_stack)
+
+              # If this source caused more sources to become pending, run those before running this one again:
+              next_source_fiber = create_source_fiber
+              if next_source_fiber
+                source_fiber_stack << next_source_fiber
+              end
+            end
+          end
+
+          # We ran all the first round of execution fibers,
+          # and we ran all the pending sources.
+          # So pick up any paused execution fibers and repeat.
+          @waiting_fibers.concat(already_run_fibers)
+          already_run_fibers.clear
+        end
+      end
+      nil
+    end
+
+    # Get a Source instance from this dataloader, for calling `.load(...)` or `.request(...)` on.
+    #
+    # @param source_class [Class<GraphQL::Dataloader::Source]
+    # @param batch_parameters [Array<Object>]
+    # @return [GraphQL::Dataloader::Source] An instance of {source_class}, initialized with `self, *batch_parameters`,
+    #   and cached for the lifetime of this {Multiplex}.
+    def with(source_class, *batch_parameters)
+      @source_cache[source_class][batch_parameters]
+    end
+
+    # @api private
+    attr_accessor :current_runtime
+
+    private
+
+    # Check if this fiber is still alive.
+    # If it is, and it should continue, then enqueue a continuation.
+    # If it is, re-enqueue it in `fiber_queue`.
+    # Otherwise, clean it up from @yielded_fibers.
+    # @return [void]
+    def resume_fiber_and_enqueue_continuation(fiber, fiber_stack)
+      result = fiber.resume
+      if result.is_a?(StandardError)
+        raise result
+      end
+
+      # This fiber yielded; there's more to do here.
+      # (If `#alive?` is false, then the fiber concluded without yielding.)
+      if fiber.alive?
+        if !@yielded_fibers.include?(fiber)
+          # This fiber hasn't yielded yet, we should enqueue a continuation fiber
+          @yielded_fibers.add(fiber)
+          current_runtime.enqueue_selections_fiber
+        end
+        fiber_stack << fiber
+      else
+        # Keep this set clean so that fibers can be GC'ed during execution
+        @yielded_fibers.delete(fiber)
+      end
+    end
+
+    # If there are pending sources, return a fiber for running them.
+    # Otherwise, return `nil`.
+    #
+    # @return [Fiber, nil]
+    def create_source_fiber
+      pending_sources = nil
+      @source_cache.each_value do |source_by_batch_params|
+        source_by_batch_params.each_value do |source|
+          if source.pending?
+            pending_sources ||= []
+            pending_sources << source
+          end
+        end
+      end
+
+      if pending_sources
+        source_fiber = Fiber.new do
+          pending_sources.each(&:run_pending_keys)
+        end
+      end
+
+      source_fiber
+    end
+  end
+end

data/lib/graphql/define/assign_global_id_field.rb

@@ -4,7 +4,7 @@ module GraphQL
     module AssignGlobalIdField
       def self.call(type_defn, field_name, **field_kwargs)
         resolve = GraphQL::Relay::GlobalIdResolve.new(type: type_defn)
-        GraphQL::Define::AssignObjectField.call(type_defn, field_name, **field_kwargs, type: GraphQL::ID_TYPE.to_non_null_type, resolve: resolve)
+        GraphQL::Define::AssignObjectField.call(type_defn, field_name, **field_kwargs, type: GraphQL::DEPRECATED_ID_TYPE.to_non_null_type, resolve: resolve)
       end
     end
   end

data/lib/graphql/define/instance_definable.rb

@@ -3,6 +3,23 @@ module GraphQL
   module Define
     # @api deprecated
     module InstanceDefinable
+      module DeprecatedDefine
+        def define(**kwargs, &block)
+          deprecated_caller = caller(1, 1).first
+          if deprecated_caller.include?("lib/graphql")
+            deprecated_caller = caller(2, 10).find { |c| !c.include?("lib/graphql") }
+          end
+
+          if deprecated_caller
+            warn <<-ERR
+#{self}.define will be removed in GraphQL-Ruby 2.0; use a class-based definition instead. See https://graphql-ruby.org/schema/class_based_api.html.
+  -> called from #{deprecated_caller}
+ERR
+          end
+          deprecated_define(**kwargs, &block)
+        end
+      end
+
       def self.included(base)
         base.extend(ClassMethods)
         base.ensure_defined(:metadata)
@@ -14,7 +31,7 @@ module GraphQL
       end
 
       # @api deprecated
-      def define(**kwargs, &block)
+      def deprecated_define(**kwargs, &block)
         # make sure the previous definition_proc was executed:
         ensure_defined
         stash_dependent_methods
@@ -22,11 +39,16 @@ module GraphQL
         nil
       end
 
+      # @api deprecated
+      def define(**kwargs, &block)
+        deprecated_define(**kwargs, &block)
+      end
+
       # @api deprecated
       def redefine(**kwargs, &block)
         ensure_defined
         new_inst = self.dup
-        new_inst.define(**kwargs, &block)
+        new_inst.deprecated_define(**kwargs, &block)
         new_inst
       end
 
@@ -125,8 +147,16 @@ module GraphQL
       module ClassMethods
         # Create a new instance
         # and prepare a definition using its {.definitions}.
+        # @api deprecated
         # @param kwargs [Hash] Key-value pairs corresponding to defininitions from `accepts_definitions`
         # @param block [Proc] Block which calls helper methods from `accepts_definitions`
+        def deprecated_define(**kwargs, &block)
+          instance = self.new
+          instance.deprecated_define(**kwargs, &block)
+          instance
+        end
+
+        # @api deprecated
         def define(**kwargs, &block)
           instance = self.new
           instance.define(**kwargs, &block)

data/lib/graphql/define/type_definer.rb

@@ -7,11 +7,11 @@ module GraphQL
     class TypeDefiner
       include Singleton
       # rubocop:disable Naming/MethodName
-      def Int;      GraphQL::INT_TYPE;      end
-      def String;   GraphQL::STRING_TYPE;   end
-      def Float;    GraphQL::FLOAT_TYPE;    end
-      def Boolean;  GraphQL::BOOLEAN_TYPE;  end
-      def ID;       GraphQL::ID_TYPE;       end
+      def Int;      GraphQL::DEPRECATED_INT_TYPE;      end
+      def String;   GraphQL::DEPRECATED_STRING_TYPE;   end
+      def Float;    GraphQL::DEPRECATED_FLOAT_TYPE;    end
+      def Boolean;  GraphQL::DEPRECATED_BOOLEAN_TYPE;  end
+      def ID;       GraphQL::DEPRECATED_ID_TYPE;       end
       # rubocop:enable Naming/MethodName
 
       # Make a {ListType} which wraps the input type

data/lib/graphql/deprecated_dsl.rb

@@ -23,12 +23,17 @@ module GraphQL
     ]
 
     def self.activate
+      deprecated_caller = caller(1, 1).first
+      warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` and remove `.activate` from #{deprecated_caller}"
       TYPE_CLASSES.each { |c| c.extend(Methods) }
       GraphQL::Schema::List.include(Methods)
       GraphQL::Schema::NonNull.include(Methods)
     end
+
     module Methods
       def !
+        deprecated_caller = caller(1, 1).first
+        warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` at #{deprecated_caller}"
         to_non_null_type
       end
     end

data/lib/graphql/enum_type.rb

@@ -2,6 +2,8 @@
 module GraphQL
   # @api deprecated
   class EnumType < GraphQL::BaseType
+    extend Define::InstanceDefinable::DeprecatedDefine
+
     accepts_definitions :values, value: GraphQL::Define::AssignEnumValue
     ensure_defined(:values, :validate_non_null_input, :coerce_non_null_input, :coerce_result)
     attr_accessor :ast_node

data/lib/graphql/execution/errors.rb

@@ -18,6 +18,10 @@ module GraphQL
     #
     class Errors
       def self.use(schema)
+        if schema.plugins.any? { |(plugin, kwargs)| plugin == self }
+          definition_line = caller(2, 1).first
+          warn("GraphQL::Execution::Errors is now installed by default, remove `use GraphQL::Execution::Errors` from #{definition_line}")
+        end
         schema.error_handler = self.new(schema)
       end
 

data/lib/graphql/execution/execute.rb

@@ -18,7 +18,14 @@ module GraphQL
       # @api private
       PROPAGATE_NULL = PropagateNull.new
 
+      def self.use(schema_class)
+        schema_class.query_execution_strategy(self)
+        schema_class.mutation_execution_strategy(self)
+        schema_class.subscription_execution_strategy(self)
+      end
+
       def execute(ast_operation, root_type, query)
+        warn "#{self.class} will be removed in GraphQL-Ruby 2.0, please upgrade to the Interpreter: https://graphql-ruby.org/queries/interpreter.html"
         result = resolve_root_selection(query)
         lazy_resolve_root_selection(result, **{query: query})
         GraphQL::Execution::Flatten.call(query.context)

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

@@ -5,6 +5,9 @@ module GraphQL
     class Interpreter
       # A wrapper for argument hashes in GraphQL queries.
       #
+      # This object is immutable so that the runtime code can be sure that
+      # modifications don't leak from one use to another
+      #
       # @see GraphQL::Query#arguments_for to get access to these objects.
       class Arguments
         extend Forwardable
@@ -14,26 +17,43 @@ module GraphQL
         # This hash is the one used at runtime.
         #
         # @return [Hash<Symbol, Object>]
-        def keyword_arguments
-          @keyword_arguments ||= begin
-            kwargs = {}
-            argument_values.each do |name, arg_val|
-              kwargs[name] = arg_val.value
-            end
-            kwargs
-          end
-        end
+        attr_reader :keyword_arguments
 
         # @param argument_values [nil, Hash{Symbol => ArgumentValue}]
-        def initialize(argument_values:)
-          @argument_values = argument_values
+        # @param keyword_arguments [nil, Hash{Symbol => Object}]
+        def initialize(keyword_arguments: nil, argument_values:)
           @empty = argument_values.nil? || argument_values.empty?
+          # This is only present when `extras` have been merged in:
+          if keyword_arguments
+            # This is a little crazy. We expect the `:argument_details` extra to _include extras_,
+            # but the object isn't created until _after_ extras are put together.
+            # So, we have to use a special flag here to say, "at the last minute, add yourself to the keyword args."
+            #
+            # Otherwise:
+            # - We can't access the final Arguments instance _while_ we're preparing extras
+            # - After we _can_ access it, it's frozen, so we can't add anything.
+            #
+            # So, this flag gives us a chance to sneak it in before freezing, _and_ while we have access
+            # to the new Arguments instance itself.
+            if keyword_arguments[:argument_details] == :__arguments_add_self
+              keyword_arguments[:argument_details] = self
+            end
+            @keyword_arguments = keyword_arguments.freeze
+          elsif !@empty
+            @keyword_arguments = {}
+            argument_values.each do |name, arg_val|
+              @keyword_arguments[name] = arg_val.value
+            end
+            @keyword_arguments.freeze
+          else
+            @keyword_arguments = NO_ARGS
+          end
+          @argument_values = argument_values ? argument_values.freeze : NO_ARGS
+          freeze
         end
 
         # @return [Hash{Symbol => ArgumentValue}]
-        def argument_values
-          @argument_values ||= {}
-        end
+        attr_reader :argument_values
 
         def empty?
           @empty
@@ -45,6 +65,23 @@ module GraphQL
         def inspect
           "#<#{self.class} @keyword_arguments=#{keyword_arguments.inspect}>"
         end
+
+        # Create a new arguments instance which includes these extras.
+        #
+        # This is called by the runtime to implement field `extras: [...]`
+        #
+        # @param extra_args [Hash<Symbol => Object>]
+        # @return [Interpreter::Arguments]
+        # @api private
+        def merge_extras(extra_args)
+          self.class.new(
+            argument_values: argument_values,
+            keyword_arguments: keyword_arguments.merge(extra_args)
+          )
+        end
+
+        NO_ARGS = {}.freeze
+        EMPTY = self.new(argument_values: nil, keyword_arguments: NO_ARGS).freeze
       end
     end
   end

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

@@ -13,13 +13,6 @@ module GraphQL
           @object
         end
       end
-
-      # Allows to return "raw" value from the resolver
-      module HandlesRawValue
-        def raw_value(obj)
-          RawValue.new(obj)
-        end
-      end
     end
   end
 end