graphql-batch 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ee4c1ca2f39afd8e9ecc36c867cc389357169f9
-  data.tar.gz: c0282358b5bf23cef97f6055af9b6010743a00c5
+  metadata.gz: dc3c6396e81315bc1c3a008f3b19e8e249eb2c46
+  data.tar.gz: 02272cc3f0ba19341379ea4d2534fda470698c1c
 SHA512:
-  metadata.gz: a0374a2cfdca4c4b61738914c21966582edb27920ea1ae986bc780dae9c1eb2f159f56228a4098c2d7205103f2125dba161e5c71e6d3f1ace468a7bb1e37f494
-  data.tar.gz: fac574fdb4ea3466c46c6a9ac6eda5ee229ecb3882ff2f9f11f65a47c9a987baac869643e319830ef14f4b6b4ef552243bc4f6584ea09e6c27e04f0962197a63
+  metadata.gz: f9f63fc31a2231ce25bcf11c8f8f9b96d38131712b6977d1b8bba6f288b168720450fbdbf07a926044f34a6bfeb6e3f16b561a0065d0adb80bb64df7a4a19a69
+  data.tar.gz: 04e5caec058af7eb05c441d519c76a63a33b7c6108f1cfb96b8f42e19f0b54f936d548b23f14c2b09f694ca9b87315a7526c120781fd2b8abadf4ad1b10ed549

data/.gitignore

@@ -1,6 +1,6 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
+/Gemfile*.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -2,4 +2,7 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
-before_install: gem install bundler -v 1.11.2
+gemfile:
+  - Gemfile
+  - Gemfile.graphql13
+before_install: gem install bundler -v 1.13.3

data/Gemfile.graphql13

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'graphql', github: 'rmosolgo/graphql-ruby', branch: 'master'

data/README.md

@@ -49,7 +49,9 @@ end
 Use the batch execution strategy with your schema
 
 ```ruby
-MySchema = GraphQL::Schema.new(query: MyQueryType)
+MySchema = GraphQL::Schema.define do
+  query MyQueryType
+end
 MySchema.query_execution_strategy = GraphQL::Batch::ExecutionStrategy
 MySchema.mutation_execution_strategy = GraphQL::Batch::MutationExecutionStrategy
 ```
@@ -109,26 +111,19 @@ end
 
 ## Unit Testing
 
-GraphQL::Batch::Promise#sync can be used to wait for a promise to be resolved and return its result. This can be useful for debugging and unit testing loaders.
+Your loaders can be tested outside of a GraphQL query by doing the
+batch loads in a block passed to GraphQL::Batch.batch.  That method
+will set up thread-local state to store the loaders, batch load any
+promise returned from the block then clear the thread-local state
+to avoid leaking state between tests.
 
 ```ruby
   def test_single_query
     product = products(:snowboard)
-    query = RecordLoader.for(Product).load(args["id"]).then(&:title)
-    assert_equal product.title, query.sync
-  end
-```
-
-Use GraphQL::Batch::Promise.all instead of Promise.all to be able to call sync on the returned promise.
-
-```ruby
-  def test_batch_query
-    products = [products(:snowboard), products(:jacket)]
-    query1 = RecordLoader.for(Product).load(products(:snowboard).id).then(&:title)
-    query2 = RecordLoader.for(Product).load(products(:jacket).id).then(&:title)
-    results = GraphQL::Batch::Promise.all([query1, query2]).sync
-    assert_equal products(:snowboard).title, results[0]
-    assert_equal products(:jacket).title, results[1]
+    title = GraphQL::Batch.batch do
+      RecordLoader.for(Product).load(product.id).then(&:title)
+    end
+    assert_equal product.title, title
   end
 ```
 

data/graphql-batch.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "graphql", ">= 0.8", "< 2"
-  spec.add_runtime_dependency "promise.rb", "~> 0.7.0.rc2"
+  spec.add_runtime_dependency "promise.rb", "~> 0.7.2"
 
   spec.add_development_dependency "byebug" if RUBY_ENGINE == 'ruby'
   spec.add_development_dependency "bundler", "~> 1.10"

data/lib/graphql/batch.rb

@@ -3,7 +3,18 @@ require "promise.rb"
 
 module GraphQL
   module Batch
-    BrokenPromiseError = Class.new(StandardError)
+    BrokenPromiseError = ::Promise::BrokenError
+    class NestedError < StandardError; end
+
+    def self.batch
+      raise NestedError if GraphQL::Batch::Executor.current
+      begin
+        GraphQL::Batch::Executor.current = GraphQL::Batch::Executor.new
+        Promise.sync(yield)
+      ensure
+        GraphQL::Batch::Executor.current = nil
+      end
+    end
   end
 end
 
@@ -11,5 +22,10 @@ require_relative "batch/version"
 require_relative "batch/loader"
 require_relative "batch/executor"
 require_relative "batch/promise"
-require_relative "batch/execution_strategy"
-require_relative "batch/mutation_execution_strategy"
+require_relative "batch/setup"
+
+# Allow custom execution strategies to be removed upstream
+if defined?(GraphQL::Query::SerialExecution)
+  require_relative "batch/execution_strategy"
+  require_relative "batch/mutation_execution_strategy"
+end

data/lib/graphql/batch/execution_strategy.rb

@@ -1,22 +1,21 @@
 module GraphQL::Batch
   class ExecutionStrategy < GraphQL::Query::SerialExecution
-    attr_accessor :disable_batching
-
     def execute(_, _, query)
-      as_promise(super).sync
+      GraphQL::Batch.batch do
+        as_promise_unless_resolved(super)
+      end
     rescue GraphQL::InvalidNullError => err
       err.parent_error? || query.context.errors.push(err)
       nil
-    ensure
-      GraphQL::Batch::Executor.current.clear
     end
 
-    private
-
-    def as_promise(result)
-      GraphQL::Batch::Promise.resolve(as_promise_unless_resolved(result))
+    # Needed for MutationExecutionStrategy
+    def deep_sync(result) #:nodoc:
+      Promise.sync(as_promise_unless_resolved(result))
     end
 
+    private
+
     def as_promise_unless_resolved(result)
       all_promises = []
       each_promise(result) do |obj, key, promise|
@@ -27,7 +26,7 @@ module GraphQL::Batch
         end
       end
       return result if all_promises.empty?
-      Promise.all(all_promises).then { result }
+      ::Promise.all(all_promises).then { result }
     end
 
     def each_promise(obj, &block)

data/lib/graphql/batch/executor.rb

@@ -4,7 +4,11 @@ module GraphQL::Batch
     private_constant :THREAD_KEY
 
     def self.current
-      Thread.current[THREAD_KEY] ||= new
+      Thread.current[THREAD_KEY]
+    end
+
+    def self.current=(executor)
+      Thread.current[THREAD_KEY] = executor
     end
 
     attr_reader :loaders
@@ -19,19 +23,16 @@ module GraphQL::Batch
       @loading = false
     end
 
+    def resolve(loader)
+      with_loading(true) { loader.resolve }
+    end
+
     def shift
       @loaders.shift.last
     end
 
     def tick
-      with_loading(true) { shift.resolve }
-    end
-
-    def wait(promise)
-      tick while promise.pending? && !loaders.empty?
-      if promise.pending?
-        promise.reject(BrokenPromiseError.new("Promise wasn't fulfilled after all queries were loaded"))
-      end
+      resolve(shift)
     end
 
     def wait_all

data/lib/graphql/batch/loader.rb

@@ -2,8 +2,10 @@ module GraphQL::Batch
   class Loader
     def self.for(*group_args)
       loader_key = [self].concat(group_args)
-      Executor.current.loaders[loader_key] ||= new(*group_args).tap do |loader|
+      executor = Executor.current
+      executor.loaders[loader_key] ||= new(*group_args).tap do |loader|
         loader.loader_key = loader_key
+        loader.executor = executor
       end
     end
 
@@ -15,21 +17,17 @@ module GraphQL::Batch
       self.for.load_many(keys)
     end
 
-    attr_accessor :loader_key
+    attr_accessor :loader_key, :executor
 
     def load(key)
-      loader = Executor.current.loaders[loader_key] ||= self
-      if loader != self
-        raise "load called on loader that wasn't registered with executor"
-      end
       cache[cache_key(key)] ||= begin
         queue << key
-        Promise.new
+        Promise.new.tap { |promise| promise.source = self }
       end
     end
 
     def load_many(keys)
-      Promise.all(keys.map { |key| load(key) })
+      ::Promise.all(keys.map { |key| load(key) })
     end
 
     def resolve #:nodoc:
@@ -44,6 +42,16 @@ module GraphQL::Batch
       end
     end
 
+    # For Promise#sync
+    def wait #:nodoc:
+      if executor
+        executor.loaders.delete(loader_key)
+        executor.resolve(self)
+      else
+        resolve
+      end
+    end
+
     protected
 
     # Fulfill the key with provided value, for use in #perform
@@ -91,7 +99,7 @@ module GraphQL::Batch
 
     def check_for_broken_promises(load_keys)
       each_pending_promise(load_keys) do |key, promise|
-        promise.reject(BrokenPromiseError.new("#{self.class} didn't fulfill promise for key #{key.inspect}"))
+        promise.reject(::Promise::BrokenError.new("#{self.class} didn't fulfill promise for key #{key.inspect}"))
       end
     end
   end

data/lib/graphql/batch/mutation_execution_strategy.rb

@@ -1,18 +1,17 @@
 module GraphQL::Batch
   class MutationExecutionStrategy < GraphQL::Batch::ExecutionStrategy
+    attr_accessor :enable_batching
+
     class FieldResolution < GraphQL::Batch::ExecutionStrategy::FieldResolution
       def get_finished_value(raw_value)
-        return super if execution_context.strategy.disable_batching
-
-        raw_value = GraphQL::Batch::Promise.resolve(raw_value).sync
+        strategy = execution_context.strategy
+        return super if strategy.enable_batching
 
-        execution_context.strategy.disable_batching = true
         begin
-          result = super(raw_value)
-          GraphQL::Batch::Executor.current.wait_all
-          result
+          strategy.enable_batching = true
+          strategy.deep_sync(Promise.sync(super))
         ensure
-          execution_context.strategy.disable_batching = false
+          strategy.enable_batching = false
         end
       end
     end

data/lib/graphql/batch/promise.rb

@@ -1,11 +1,8 @@
 module GraphQL::Batch
   class Promise < ::Promise
-    def wait
-      Executor.current.wait(self)
-    end
-
     def defer
-      Executor.current.defer { super }
+      executor = Executor.current
+      executor ? executor.defer { super } : super
     end
   end
 end

data/lib/graphql/batch/setup.rb

@@ -0,0 +1,14 @@
+module GraphQL::Batch
+  module Setup
+    extend self
+
+    def before_query(query)
+      raise NestedError if GraphQL::Batch::Executor.current
+      GraphQL::Batch::Executor.current = GraphQL::Batch::Executor.new
+    end
+
+    def after_query(query)
+      GraphQL::Batch::Executor.current = nil
+    end
+  end
+end

data/lib/graphql/batch/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Batch
-    VERSION = "0.2.5"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-batch
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Dylan Thacker-Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0.rc2
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0.rc2
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +110,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- Gemfile.graphql13
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -122,6 +123,7 @@ files:
 - lib/graphql/batch/loader.rb
 - lib/graphql/batch/mutation_execution_strategy.rb
 - lib/graphql/batch/promise.rb
+- lib/graphql/batch/setup.rb
 - lib/graphql/batch/version.rb
 homepage: https://github.com/Shopify/graphql-batch
 licenses: