graphql 1.11.8 → 1.12.0

data/lib/graphql/backtrace/table.rb

@@ -79,6 +79,25 @@ module GraphQL
       # @return [Array] 5 items for a backtrace table (not `key`)
       def build_rows(context_entry, rows:, top: false)
         case context_entry
+        when Backtrace::Frame
+          field_alias = context_entry.ast_node.respond_to?(:alias) && context_entry.ast_node.alias
+          value = if top && @override_value
+            @override_value
+          else
+            @context.query.context.namespace(:interpreter)[:runtime].value_at(context_entry.path)
+          end
+          rows << [
+            "#{context_entry.ast_node ? context_entry.ast_node.position.join(":") : ""}",
+            "#{context_entry.field.path}#{field_alias ? " as #{field_alias}" : ""}",
+            "#{context_entry.object.object.inspect}",
+            context_entry.arguments.to_h.inspect,
+            Backtrace::InspectResult.inspect_result(value),
+          ]
+          if (parent = context_entry.parent_frame)
+            build_rows(parent, rows: rows)
+          else
+            rows
+          end
         when GraphQL::Query::Context::FieldResolutionContext
           ctx = context_entry
           field_name = "#{ctx.irep_node.owner_type.name}.#{ctx.field.name}"
@@ -112,15 +131,16 @@ module GraphQL
           if object.is_a?(GraphQL::Schema::Object)
             object = object.object
           end
+          value = context_entry.namespace(:interpreter)[:runtime].value_at([])
           rows << [
             "#{position}",
             "#{op_type}#{op_name ? " #{op_name}" : ""}",
             "#{object.inspect}",
             query.variables.to_h.inspect,
-            Backtrace::InspectResult.inspect_result(query.context.value),
+            Backtrace::InspectResult.inspect_result(value),
           ]
         else
-          raise "Unexpected get_rows subject #{context_entry.inspect}"
+          raise "Unexpected get_rows subject #{context_entry.class} (#{context_entry.inspect})"
         end
       end
     end

data/lib/graphql/backtrace/tracer.rb

@@ -1,46 +1,77 @@
 # frozen_string_literal: true
 module GraphQL
   class Backtrace
+    # TODO this is not fiber-friendly
     module Tracer
       module_function
 
       # Implement the {GraphQL::Tracing} API.
       def trace(key, metadata)
-        push_data = case key
+        case key
         when "lex", "parse"
           # No context here, don't have a query yet
           nil
         when "execute_multiplex", "analyze_multiplex"
-          metadata[:multiplex].queries
+          # No query context yet
+          nil
         when "validate", "analyze_query", "execute_query", "execute_query_lazy"
-          metadata[:query] || metadata[:queries]
+          query = metadata[:query] || metadata[:queries].first
+          push_key = []
+          push_data = query
+          multiplex = query.multiplex
         when "execute_field", "execute_field_lazy"
-          # The interpreter passes `query:`, legacy passes `context:`
-          metadata[:context] || ((q = metadata[:query]) && q.context)
+          query = metadata[:query] || raise(ArgumentError, "Add `legacy: true` to use GraphQL::Backtrace without the interpreter runtime.")
+          context = query.context
+          multiplex = query.multiplex
+          push_key = metadata[:path].reject { |i| i.is_a?(Integer) }
+          parent_frame = multiplex.context[:graphql_backtrace_contexts][push_key[0..-2]]
+          if parent_frame.nil?
+            p push_key
+            binding.pry
+          end
+          if parent_frame.is_a?(GraphQL::Query)
+            parent_frame = parent_frame.context
+          end
+
+          push_data = Frame.new(
+            query: query,
+            path: push_key,
+            ast_node: metadata[:ast_node],
+            field: metadata[:field],
+            object: metadata[:object],
+            arguments: metadata[:arguments],
+            parent_frame: parent_frame,
+          )
         else
           # Custom key, no backtrace data for this
           nil
         end
 
         if push_data
-          Thread.current[:last_graphql_backtrace_context] = push_data
+          multiplex.context[:graphql_backtrace_contexts][push_key] = push_data
+          multiplex.context[:last_graphql_backtrace_context] = push_data
         end
 
         if key == "execute_multiplex"
+          multiplex_context = metadata[:multiplex].context
+          multiplex_context[:graphql_backtrace_contexts] = {}
           begin
             yield
           rescue StandardError => err
             # This is an unhandled error from execution,
             # Re-raise it with a GraphQL trace.
-            potential_context = Thread.current[:last_graphql_backtrace_context]
+            potential_context = multiplex_context[:last_graphql_backtrace_context]
 
-            if potential_context.is_a?(GraphQL::Query::Context) || potential_context.is_a?(GraphQL::Query::Context::FieldResolutionContext)
+            if potential_context.is_a?(GraphQL::Query::Context) ||
+                potential_context.is_a?(GraphQL::Query::Context::FieldResolutionContext) ||
+                potential_context.is_a?(Backtrace::Frame)
               raise TracedError.new(err, potential_context)
             else
               raise
             end
           ensure
-            Thread.current[:last_graphql_backtrace_context] = nil
+            multiplex_context.delete(:graphql_backtrace_contexts)
+            multiplex_context.delete(:last_graphql_backtrace_context)
           end
         else
           yield

data/lib/graphql/backwards_compatibility.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module GraphQL
   # Helpers for migrating in a backwards-compatible way
+  # Remove this in GraphQL-Ruby 2.0, when all users of it will be gone.
   # @api private
   module BackwardsCompatibility
     module_function

data/lib/graphql/compatibility/execution_specification.rb

@@ -32,6 +32,7 @@ module GraphQL
       # @param execution_strategy [<#new, #execute>] An execution strategy class
       # @return [Class<Minitest::Test>] A test suite for this execution strategy
       def self.build_suite(execution_strategy)
+        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
         Class.new(Minitest::Test) do
           class << self
             attr_accessor :counter_schema, :specification_schema

data/lib/graphql/compatibility/lazy_execution_specification.rb

@@ -7,6 +7,8 @@ module GraphQL
       # @param execution_strategy [<#new, #execute>] An execution strategy class
       # @return [Class<Minitest::Test>] A test suite for this execution strategy
       def self.build_suite(execution_strategy)
+        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
+
         Class.new(Minitest::Test) do
           class << self
             attr_accessor :lazy_schema

data/lib/graphql/compatibility/query_parser_specification.rb

@@ -11,6 +11,8 @@ module GraphQL
       # @yieldreturn [GraphQL::Language::Nodes::Document]
       # @return [Class<Minitest::Test>] A test suite for this parse function
       def self.build_suite(&block)
+        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
+
         Class.new(Minitest::Test) do
           include QueryAssertions
           include ParseErrorSpecification

data/lib/graphql/compatibility/schema_parser_specification.rb

@@ -8,6 +8,8 @@ module GraphQL
       # @yieldreturn [GraphQL::Language::Nodes::Document]
       # @return [Class<Minitest::Test>] A test suite for this parse function
       def self.build_suite(&block)
+        warn "#{self} will be removed from GraphQL-Ruby 2.0. There is no replacement, please open an issue on GitHub if you need support."
+
         Class.new(Minitest::Test) do
           @@parse_fn = block
 

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/dataloader/null_dataloader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Dataloader
+    # The default implementation of dataloading -- all no-ops.
+    #
+    # The Dataloader interface isn't public, but it enables
+    # simple internal code while adding the option to add Dataloader.
+    class NullDataloader < Dataloader
+      def enqueue
+        yield
+      end
+
+      # These are all no-ops because code was
+      # executed sychronously.
+      def run; end
+      def yield; end
+      def yielded?; false; end
+    end
+  end
+end

data/lib/graphql/dataloader/request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module GraphQL
+  class Dataloader
+    # @see Source#request which returns an instance of this
+    class Request
+      def initialize(source, key)
+        @source = source
+        @key = key
+      end
+
+      # Call this method to cause the current Fiber to wait for the results of this request.
+      #
+      # @return [Object] the object loaded for `key`
+      def load
+        if @source.results.key?(@key)
+          @source.results[@key]
+        else
+          @source.sync
+          @source.results[@key]
+        end
+      end
+    end
+  end
+end

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