graphql 2.4.3 → 2.4.13

data/lib/graphql/dataloader/active_record_association_source.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require "graphql/dataloader/source"
+require "graphql/dataloader/active_record_source"
+
+module GraphQL
+  class Dataloader
+    class ActiveRecordAssociationSource < GraphQL::Dataloader::Source
+      RECORD_SOURCE_CLASS = ActiveRecordSource
+
+      def initialize(association, scope = nil)
+        @association = association
+        @scope = scope
+      end
+
+      def load(record)
+        if (assoc = record.association(@association)).loaded?
+          assoc.target
+        else
+          super
+        end
+      end
+
+      def fetch(records)
+        record_classes = Set.new.compare_by_identity
+        associated_classes = Set.new.compare_by_identity
+        records.each do |record|
+          if record_classes.add?(record.class)
+            reflection = record.class.reflect_on_association(@association)
+            if !reflection.polymorphic? && reflection.klass
+              associated_classes.add(reflection.klass)
+            end
+          end
+        end
+
+        available_records = []
+        associated_classes.each do |assoc_class|
+          already_loaded_records = dataloader.with(RECORD_SOURCE_CLASS, assoc_class).results.values
+          available_records.concat(already_loaded_records)
+        end
+
+        ::ActiveRecord::Associations::Preloader.new(records: records, associations: @association, available_records: available_records, scope: @scope).call
+
+        loaded_associated_records = records.map { |r| r.public_send(@association) }
+        records_by_model = {}
+        loaded_associated_records.each do |record|
+          if record
+            updates = records_by_model[record.class] ||= {}
+            updates[record.id] = record
+          end
+        end
+
+        if @scope.nil?
+          # Don't cache records loaded via scope because they might have reduced `SELECT`s
+          # Could check .select_values here?
+          records_by_model.each do |model_class, updates|
+            dataloader.with(RECORD_SOURCE_CLASS, model_class).merge(updates)
+          end
+        end
+
+        loaded_associated_records
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/active_record_source.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require "graphql/dataloader/source"
+
+module GraphQL
+  class Dataloader
+    class ActiveRecordSource < GraphQL::Dataloader::Source
+      def initialize(model_class, find_by: model_class.primary_key)
+        @model_class = model_class
+        @find_by = find_by
+        @type_for_column = @model_class.type_for_attribute(@find_by)
+      end
+
+      def load(requested_key)
+        casted_key = @type_for_column.cast(requested_key)
+        super(casted_key)
+      end
+
+      def fetch(record_ids)
+        records = @model_class.where(@find_by => record_ids)
+        record_lookup = {}
+        records.each { |r| record_lookup[r.public_send(@find_by)] = r }
+        record_ids.map { |id| record_lookup[id] }
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/async_dataloader.rb

@@ -2,16 +2,20 @@
 module GraphQL
   class Dataloader
     class AsyncDataloader < Dataloader
-      def yield
-        if (condition = Thread.current[:graphql_dataloader_next_tick])
+      def yield(source = Fiber[:__graphql_current_dataloader_source])
+        trace = Fiber[:__graphql_current_multiplex]&.current_trace
+        trace&.dataloader_fiber_yield(source)
+        if (condition = Fiber[:graphql_dataloader_next_tick])
           condition.wait
         else
           Fiber.yield
         end
+        trace&.dataloader_fiber_resume(source)
         nil
       end
 
       def run
+        trace = Fiber[:__graphql_current_multiplex]&.current_trace
         jobs_fiber_limit, total_fiber_limit = calculate_fiber_limit
         job_fibers = []
         next_job_fibers = []
@@ -20,11 +24,12 @@ module GraphQL
         first_pass = true
         sources_condition = Async::Condition.new
         manager = spawn_fiber do
-          while first_pass || job_fibers.any?
+          trace&.begin_dataloader(self)
+          while first_pass || !job_fibers.empty?
             first_pass = false
             fiber_vars = get_fiber_variables
 
-            while (f = (job_fibers.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size) < jobs_fiber_limit) && spawn_job_fiber)))
+            while (f = (job_fibers.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size) < jobs_fiber_limit) && spawn_job_fiber(trace))))
               if f.alive?
                 finished = run_fiber(f)
                 if !finished
@@ -37,8 +42,8 @@ module GraphQL
 
             Sync do |root_task|
               set_fiber_variables(fiber_vars)
-              while source_tasks.any? || @source_cache.each_value.any? { |group_sources| group_sources.each_value.any?(&:pending?) }
-                while (task = (source_tasks.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size + next_source_tasks.size) < total_fiber_limit) && spawn_source_task(root_task, sources_condition))))
+              while !source_tasks.empty? || @source_cache.each_value.any? { |group_sources| group_sources.each_value.any?(&:pending?) }
+                while (task = (source_tasks.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size + next_source_tasks.size) < total_fiber_limit) && spawn_source_task(root_task, sources_condition, trace))))
                   if task.alive?
                     root_task.yield # give the source task a chance to run
                     next_source_tasks << task
@@ -50,6 +55,7 @@ module GraphQL
               end
             end
           end
+          trace&.end_dataloader(self)
         end
 
         manager.resume
@@ -63,7 +69,7 @@ module GraphQL
 
       private
 
-      def spawn_source_task(parent_task, condition)
+      def spawn_source_task(parent_task, condition, trace)
         pending_sources = nil
         @source_cache.each_value do |source_by_batch_params|
           source_by_batch_params.each_value do |source|
@@ -77,10 +83,16 @@ module GraphQL
         if pending_sources
           fiber_vars = get_fiber_variables
           parent_task.async do
+            trace&.dataloader_spawn_source_fiber(pending_sources)
             set_fiber_variables(fiber_vars)
-            Thread.current[:graphql_dataloader_next_tick] = condition
-            pending_sources.each(&:run_pending_keys)
+            Fiber[:graphql_dataloader_next_tick] = condition
+            pending_sources.each do |s|
+              trace&.begin_dataloader_source(s)
+              s.run_pending_keys
+              trace&.end_dataloader_source(s)
+            end
             cleanup_fiber
+            trace&.dataloader_fiber_exit
           end
         end
       end

data/lib/graphql/dataloader/null_dataloader.rb

@@ -11,7 +11,7 @@ module GraphQL
       # executed synchronously.
       def run; end
       def run_isolated; yield; end
-      def yield
+      def yield(_source)
         raise GraphQL::Error, "GraphQL::Dataloader is not running -- add `use GraphQL::Dataloader` to your schema to use Dataloader sources."
       end
 

data/lib/graphql/dataloader/source.rb

@@ -73,7 +73,7 @@ module GraphQL
           end
         }
 
-        if pending_keys.any?
+        if !pending_keys.empty?
           sync(pending_keys)
         end
 
@@ -93,14 +93,14 @@ module GraphQL
       # Then run the batch and update the cache.
       # @return [void]
       def sync(pending_result_keys)
-        @dataloader.yield
+        @dataloader.yield(self)
         iterations = 0
         while pending_result_keys.any? { |key| !@results.key?(key) }
           iterations += 1
           if iterations > MAX_ITERATIONS
             raise "#{self.class}#sync tried #{MAX_ITERATIONS} times to load pending keys (#{pending_result_keys}), but they still weren't loaded. There is likely a circular dependency#{@dataloader.fiber_limit ? " or `fiber_limit: #{@dataloader.fiber_limit}` is set too low" : ""}."
           end
-          @dataloader.yield
+          @dataloader.yield(self)
         end
         nil
       end

data/lib/graphql/dataloader.rb

@@ -4,6 +4,8 @@ require "graphql/dataloader/null_dataloader"
 require "graphql/dataloader/request"
 require "graphql/dataloader/request_all"
 require "graphql/dataloader/source"
+require "graphql/dataloader/active_record_association_source"
+require "graphql/dataloader/active_record_source"
 
 module GraphQL
   # This plugin supports Fiber-based concurrency, along with {GraphQL::Dataloader::Source}.
@@ -78,10 +80,7 @@ module GraphQL
     def get_fiber_variables
       fiber_vars = {}
       Thread.current.keys.each do |fiber_var_key|
-        # This variable should be fresh in each new fiber
-        if fiber_var_key != :__graphql_runtime_info
-          fiber_vars[fiber_var_key] = Thread.current[fiber_var_key]
-        end
+        fiber_vars[fiber_var_key] = Thread.current[fiber_var_key]
       end
       fiber_vars
     end
@@ -132,8 +131,11 @@ module GraphQL
     # Dataloader will resume the fiber after the requested data has been loaded (by another Fiber).
     #
     # @return [void]
-    def yield
+    def yield(source = Fiber[:__graphql_current_dataloader_source])
+      trace = Fiber[:__graphql_current_multiplex]&.current_trace
+      trace&.dataloader_fiber_yield(source)
       Fiber.yield
+      trace&.dataloader_fiber_resume(source)
       nil
     end
 
@@ -187,6 +189,7 @@ module GraphQL
     end
 
     def run
+      trace = Fiber[:__graphql_current_multiplex]&.current_trace
       jobs_fiber_limit, total_fiber_limit = calculate_fiber_limit
       job_fibers = []
       next_job_fibers = []
@@ -194,10 +197,11 @@ module GraphQL
       next_source_fibers = []
       first_pass = true
       manager = spawn_fiber do
-        while first_pass || job_fibers.any?
+        trace&.begin_dataloader(self)
+        while first_pass || !job_fibers.empty?
           first_pass = false
 
-          while (f = (job_fibers.shift || (((next_job_fibers.size + job_fibers.size) < jobs_fiber_limit) && spawn_job_fiber)))
+          while (f = (job_fibers.shift || (((next_job_fibers.size + job_fibers.size) < jobs_fiber_limit) && spawn_job_fiber(trace))))
             if f.alive?
               finished = run_fiber(f)
               if !finished
@@ -207,8 +211,8 @@ module GraphQL
           end
           join_queues(job_fibers, next_job_fibers)
 
-          while (source_fibers.any? || @source_cache.each_value.any? { |group_sources| group_sources.each_value.any?(&:pending?) })
-            while (f = source_fibers.shift || (((job_fibers.size + source_fibers.size + next_source_fibers.size + next_job_fibers.size) < total_fiber_limit) && spawn_source_fiber))
+          while (!source_fibers.empty? || @source_cache.each_value.any? { |group_sources| group_sources.each_value.any?(&:pending?) })
+            while (f = source_fibers.shift || (((job_fibers.size + source_fibers.size + next_source_fibers.size + next_job_fibers.size) < total_fiber_limit) && spawn_source_fiber(trace)))
               if f.alive?
                 finished = run_fiber(f)
                 if !finished
@@ -219,6 +223,8 @@ module GraphQL
             join_queues(source_fibers, next_source_fibers)
           end
         end
+
+        trace&.end_dataloader(self)
       end
 
       run_fiber(manager)
@@ -227,12 +233,13 @@ module GraphQL
         raise "Invariant: Manager fiber didn't terminate properly."
       end
 
-      if job_fibers.any?
+      if !job_fibers.empty?
         raise "Invariant: job fibers should have exited but #{job_fibers.size} remained"
       end
-      if source_fibers.any?
+      if !source_fibers.empty?
         raise "Invariant: source fibers should have exited but #{source_fibers.size} remained"
       end
+
     rescue UncaughtThrowError => e
       throw e.tag, e.value
     end
@@ -250,6 +257,22 @@ module GraphQL
       }
     end
 
+    # Pre-warm the Dataloader cache with ActiveRecord objects which were loaded elsewhere.
+    # These will be used by {Dataloader::ActiveRecordSource}, {Dataloader::ActiveRecordAssociationSource} and their helper
+    # methods, `dataload_record` and `dataload_association`.
+    # @param records [Array<ActiveRecord::Base>] Already-loaded records to warm the cache with
+    # @param index_by [Symbol] The attribute to use as the cache key. (Should match `find_by:` when using {ActiveRecordSource})
+    # @return [void]
+    def merge_records(records, index_by: :id)
+      records_by_class = Hash.new { |h, k| h[k] = {} }
+      records.each do |r|
+        records_by_class[r.class][r.public_send(index_by)] = r
+      end
+      records_by_class.each do |r_class, records|
+        with(ActiveRecordSource, r_class).merge(records)
+      end
+    end
+
     private
 
     def calculate_fiber_limit
@@ -269,17 +292,19 @@ module GraphQL
       new_queue.clear
     end
 
-    def spawn_job_fiber
-      if @pending_jobs.any?
+    def spawn_job_fiber(trace)
+      if !@pending_jobs.empty?
         spawn_fiber do
+          trace&.dataloader_spawn_execution_fiber(@pending_jobs)
           while job = @pending_jobs.shift
             job.call
           end
+          trace&.dataloader_fiber_exit
         end
       end
     end
 
-    def spawn_source_fiber
+    def spawn_source_fiber(trace)
       pending_sources = nil
       @source_cache.each_value do |source_by_batch_params|
         source_by_batch_params.each_value do |source|
@@ -292,10 +317,14 @@ module GraphQL
 
       if pending_sources
         spawn_fiber do
+          trace&.dataloader_spawn_source_fiber(pending_sources)
           pending_sources.each do |source|
             Fiber[:__graphql_current_dataloader_source] = source
+            trace&.begin_dataloader_source(source)
             source.run_pending_keys
+            trace&.end_dataloader_source(source)
           end
+          trace&.dataloader_fiber_exit
         end
       end
     end

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

@@ -22,7 +22,7 @@ module GraphQL
 
           if smallest_depth
             lazies = lazies_at_depth.delete(smallest_depth)
-            if lazies.any?
+            if !lazies.empty?
               dataloader.append_job {
                 lazies.each(&:value) # resolve these Lazy instances
               }
@@ -55,7 +55,7 @@ module GraphQL
           # these approaches.
           dataloader.run
           next_results = []
-          while results.any?
+          while !results.empty?
             result_value = results.shift
             if result_value.is_a?(Runtime::GraphQLResultHash) || result_value.is_a?(Hash)
               results.concat(result_value.values)
@@ -81,7 +81,7 @@ module GraphQL
             end
           end
 
-          if next_results.any?
+          if !next_results.empty?
             # Any pending data loader jobs may populate the
             # resutl arrays or result hashes accumulated in
             # `next_results``. Run those **to completion**

data/lib/graphql/execution/interpreter/runtime/graphql_result.rb

@@ -5,7 +5,10 @@ module GraphQL
     class Interpreter
       class Runtime
         module GraphQLResult
-          def initialize(result_name, result_type, application_value, parent_result, is_non_null_in_parent, selections, is_eager)
+          def initialize(result_name, result_type, application_value, parent_result, is_non_null_in_parent, selections, is_eager, ast_node, graphql_arguments, graphql_field) # rubocop:disable Metrics/ParameterLists
+            @ast_node = ast_node
+            @graphql_arguments = graphql_arguments
+            @graphql_field = graphql_field
             @graphql_parent = parent_result
             @graphql_application_value = application_value
             @graphql_result_type = result_type
@@ -31,14 +34,14 @@ module GraphQL
 
           attr_accessor :graphql_dead
           attr_reader :graphql_parent, :graphql_result_name, :graphql_is_non_null_in_parent,
-            :graphql_application_value, :graphql_result_type, :graphql_selections, :graphql_is_eager
+            :graphql_application_value, :graphql_result_type, :graphql_selections, :graphql_is_eager, :ast_node, :graphql_arguments, :graphql_field
 
           # @return [Hash] Plain-Ruby result data (`@graphql_metadata` contains Result wrapper objects)
           attr_accessor :graphql_result_data
         end
 
         class GraphQLResultHash
-          def initialize(_result_name, _result_type, _application_value, _parent_result, _is_non_null_in_parent, _selections, _is_eager)
+          def initialize(_result_name, _result_type, _application_value, _parent_result, _is_non_null_in_parent, _selections, _is_eager, _ast_node, _graphql_arguments, graphql_field) # rubocop:disable Metrics/ParameterLists
             super
             @graphql_result_data = {}
           end
@@ -126,7 +129,7 @@ module GraphQL
         class GraphQLResultArray
           include GraphQLResult
 
-          def initialize(_result_name, _result_type, _application_value, _parent_result, _is_non_null_in_parent, _selections, _is_eager)
+          def initialize(_result_name, _result_type, _application_value, _parent_result, _is_non_null_in_parent, _selections, _is_eager, _ast_node, _graphql_arguments, graphql_field) # rubocop:disable Metrics/ParameterLists
             super
             @graphql_result_data = []
           end
@@ -168,6 +171,10 @@ module GraphQL
           def values
             (@graphql_metadata || @graphql_result_data)
           end
+
+          def [](idx)
+            (@graphql_metadata || @graphql_result_data)[idx]
+          end
         end
       end
     end