graphql 2.1.12 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c57369275ccfc37cd8d5d3f1ca64056c53ab538e722c3746191e2099e800aca
-  data.tar.gz: '0847f67f1da704877713c46624c88ec92b1351468fb9f96be9d6957867182ee3'
+  metadata.gz: 1294ac9e09f2c6924a771765e3f79d6c29449235e65f736afd177270b2a90b99
+  data.tar.gz: eece859aa0e3137e5d7a67c39ec79917d3ee884e3011cb8e9f203801c78c0408
 SHA512:
-  metadata.gz: 4b915fddb5faf09e81fa47a2e1abf191e39ed0365bc7c82adf39d77caa9b86b278914253250566512d3bccb8d7e67d2f340b6a75863cb053fed56a469d7b8701
-  data.tar.gz: 0311216000e22a4b70a04dc59c68fb5b0e10e1cec17c359c1638d31b667516ac78414988446d89bb9e5abb78e2007ef29148b557b2734090b3925138a2e06500
+  metadata.gz: 4a8343dd7ddcdfbaa05cdfd462612810bbbaa600c62c2d392d367926e7c4742a14705cc05a7e14cfae6d0d5aecb0509e96b645edcbfcdb63d250349bdeef725e
+  data.tar.gz: de145d99232eecc3feb68fa0cb2f3cdfe73fa154924f3ad27ec25ab1e90783927a2b064667233379adc5f7bc1a38563a39466c193a5378b64e13676f802aeeeb

data/lib/graphql/dataloader/async_dataloader.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+module GraphQL
+  class Dataloader
+    class AsyncDataloader < Dataloader
+      def yield
+        Thread.current[:graphql_dataloader_next_tick].wait
+        nil
+      end
+
+      def run
+        job_tasks = []
+        next_job_tasks = []
+        source_tasks = []
+        next_source_tasks = []
+        first_pass = true
+        jobs_condition = Async::Condition.new
+        sources_condition = Async::Condition.new
+        Sync do |root_task|
+          while first_pass || job_tasks.any?
+            first_pass = false
+
+            root_task.async do |jobs_task|
+              while (task = job_tasks.shift || spawn_job_task(jobs_task, jobs_condition))
+                if task.alive?
+                  next_job_tasks << task
+                end
+              end
+            end.wait
+            job_tasks.concat(next_job_tasks)
+            next_job_tasks.clear
+
+            while source_tasks.any? || @source_cache.each_value.any? { |group_sources| group_sources.each_value.any?(&:pending?) }
+              root_task.async do |sources_loop_task|
+                while (task = source_tasks.shift || spawn_source_task(sources_loop_task, sources_condition))
+                  if task.alive?
+                    next_source_tasks << task
+                  end
+                end
+              end.wait
+              sources_condition.signal
+              source_tasks.concat(next_source_tasks)
+              next_source_tasks.clear
+            end
+            jobs_condition.signal
+          end
+        end
+      rescue UncaughtThrowError => e
+        throw e.tag, e.value
+      end
+
+      private
+
+      def spawn_job_task(parent_task, condition)
+        if @pending_jobs.any?
+          fiber_vars = get_fiber_variables
+          parent_task.async do |t|
+            set_fiber_variables(fiber_vars)
+            Thread.current[:graphql_dataloader_next_tick] = condition
+            while job = @pending_jobs.shift
+              job.call
+            end
+          end
+        end
+      end
+
+      def spawn_source_task(parent_task, condition)
+        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
+          fiber_vars = get_fiber_variables
+          parent_task.async do
+            set_fiber_variables(fiber_vars)
+            Thread.current[:graphql_dataloader_next_tick] = condition
+            pending_sources.each(&:run_pending_keys)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/source.rb

@@ -88,6 +88,7 @@ module GraphQL
         raise "Implement `#{self.class}#fetch(#{keys.inspect}) to return a record for each of the keys"
       end
 
+      MAX_ITERATIONS = 1000
       # Wait for a batch, if there's anything to batch.
       # Then run the batch and update the cache.
       # @return [void]
@@ -96,8 +97,8 @@ module GraphQL
         iterations = 0
         while pending_result_keys.any? { |key| !@results.key?(key) }
           iterations += 1
-          if iterations > 1000
-            raise "#{self.class}#sync tried 1000 times to load pending keys (#{pending_result_keys}), but they still weren't loaded. There is likely a circular dependency."
+          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."
           end
           @dataloader.yield
         end
@@ -168,7 +169,7 @@ module GraphQL
         nil
       end
 
-      attr_reader :pending, :results
+      attr_reader :pending
 
       private
 

data/lib/graphql/dataloader.rb

@@ -27,11 +27,12 @@ module GraphQL
       attr_accessor :default_nonblocking
     end
 
-    AsyncDataloader = Class.new(self) { self.default_nonblocking = true }
+    NonblockingDataloader = Class.new(self) { self.default_nonblocking = true }
 
     def self.use(schema, nonblocking: nil)
       schema.dataloader_class = if nonblocking
-        AsyncDataloader
+        warn("`nonblocking: true` is deprecated from `GraphQL::Dataloader`, please use `GraphQL::Dataloader::AsyncDataloader` instead. Docs: https://graphql-ruby.org/dataloader/async_dataloader.")
+        NonblockingDataloader
       else
         self
       end
@@ -118,7 +119,12 @@ module GraphQL
     #
     # @return [void]
     def yield
-      Fiber.yield
+      if use_fiber_resume?
+        Fiber.yield
+      else
+        parent_fiber = Thread.current[:parent_fiber]
+        parent_fiber.transfer
+      end
       nil
     end
 
@@ -163,11 +169,7 @@ module GraphQL
     ensure
       @pending_jobs = prev_queue
       prev_pending_keys.each do |source_instance, pending|
-        pending.each do |key, value|
-          if !source_instance.results.key?(key)
-            source_instance.pending[key] = value
-          end
-        end
+        source_instance.pending.merge!(pending)
       end
     end
 
@@ -181,7 +183,7 @@ module GraphQL
         while first_pass || job_fibers.any?
           first_pass = false
 
-          while (f = (job_fibers.shift || spawn_job_fiber))
+          while (f = job_fibers.shift || spawn_job_fiber)
             if f.alive?
               finished = run_fiber(f)
               if !finished
@@ -202,37 +204,38 @@ module GraphQL
             end
             join_queues(source_fibers, next_source_fibers)
           end
+
         end
       end
 
       run_fiber(manager)
 
-      if manager.alive?
-        raise "Invariant: Manager fiber didn't terminate properly."
-      end
-
-      if job_fibers.any?
-        raise "Invariant: job fibers should have exited but #{job_fibers.size} remained"
-      end
-      if source_fibers.any?
-        raise "Invariant: source fibers should have exited but #{source_fibers.size} remained"
-      end
     rescue UncaughtThrowError => e
       throw e.tag, e.value
     end
 
     def run_fiber(f)
-      f.resume
+      if use_fiber_resume?
+        f.resume
+      else
+        f.transfer
+      end
     end
 
     def spawn_fiber
       fiber_vars = get_fiber_variables
+      parent_fiber = use_fiber_resume? ? nil : Fiber.current
       Fiber.new(blocking: !@nonblocking) {
         set_fiber_variables(fiber_vars)
+        Thread.current[:parent_fiber] = parent_fiber
         yield
         # With `.transfer`, you have to explicitly pass back to the parent --
         # if the fiber is allowed to terminate normally, control is passed to the main fiber instead.
-        true
+        if parent_fiber
+          parent_fiber.transfer(true)
+        else
+          true
+        end
       }
     end
 
@@ -244,6 +247,15 @@ module GraphQL
       new_queue.clear
     end
 
+    def use_fiber_resume?
+      Fiber.respond_to?(:scheduler) &&
+        (
+          (defined?(::DummyScheduler) && Fiber.scheduler.is_a?(::DummyScheduler)) ||
+          (defined?(::Evt) && ::Evt::Scheduler.singleton_class::BACKENDS.any? { |be| Fiber.scheduler.is_a?(be) }) ||
+          (defined?(::Libev) && Fiber.scheduler.is_a?(::Libev::Scheduler))
+        )
+    end
+
     def spawn_job_fiber
       if @pending_jobs.any?
         spawn_fiber do
@@ -273,3 +285,5 @@ module GraphQL
     end
   end
 end
+
+require "graphql/dataloader/async_dataloader"