graphql-batch 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e858070a0f23a5d42dc654bbc6760974bce89b24
-  data.tar.gz: d4771d661e223aced98ffaac3bf0314251274806
+  metadata.gz: 2ee4c1ca2f39afd8e9ecc36c867cc389357169f9
+  data.tar.gz: c0282358b5bf23cef97f6055af9b6010743a00c5
 SHA512:
-  metadata.gz: 898be9f7e40085e62777a1ed73b89149104b7b95c202201862f1f218d751815384521900eac19dad215cb4ba7b714cc093f48de0c5ae1054966d469a8c7996f8
-  data.tar.gz: 2800cf159f9441d9d88b03ccfb9239a1217349cf177e3477a23946440b41752b58de716b03811fe7928bfb546192feca9031967fa7e88399b8c13e9467fd21e8
+  metadata.gz: a0374a2cfdca4c4b61738914c21966582edb27920ea1ae986bc780dae9c1eb2f159f56228a4098c2d7205103f2125dba161e5c71e6d3f1ace468a7bb1e37f494
+  data.tar.gz: fac574fdb4ea3466c46c6a9ac6eda5ee229ecb3882ff2f9f11f65a47c9a987baac869643e319830ef14f4b6b4ef552243bc4f6584ea09e6c27e04f0962197a63

data/README.md

@@ -1,5 +1,8 @@
 # GraphQL::Batch
 
+[![Build Status](https://travis-ci.org/Shopify/graphql-batch.svg?branch=master)](https://travis-ci.org/Shopify/graphql-batch)
+[![Gem Version](https://badge.fury.io/rb/graphql-batch.svg)](https://rubygems.org/gems/graphql-batch)
+
 Provides an executor for the [`graphql` gem](https://github.com/rmosolgo/graphql-ruby) which allows queries to be batched.
 
 ## Installation
@@ -28,7 +31,7 @@ Require the library
 require 'graphql/batch'
 ```
 
-Define a custom loader, which is initialized with arguments that are used for grouping and an perform method for performing the batch load.
+Define a custom loader, which is initialized with arguments that are used for grouping and a perform method for performing the batch load.
 
 ```ruby
 class RecordLoader < GraphQL::Batch::Loader
@@ -118,7 +121,7 @@ GraphQL::Batch::Promise#sync can be used to wait for a promise to be resolved an
 
 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)

data/graphql-batch.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "graphql-batch"
   spec.version       = GraphQL::Batch::VERSION
   spec.authors       = ["Dylan Thacker-Smith"]
-  spec.email         = ["Dylan.Smith@shopify.com"]
+  spec.email         = ["gems@shopify.com"]
 
   spec.summary       = "A query batching executor for the graphql gem"
   spec.homepage      = "https://github.com/Shopify/graphql-batch"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "graphql", "~> 0.8"
+  spec.add_runtime_dependency "graphql", ">= 0.8", "< 2"
   spec.add_runtime_dependency "promise.rb", "~> 0.7.0.rc2"
 
   spec.add_development_dependency "byebug" if RUBY_ENGINE == 'ruby'

data/lib/graphql/batch/execution_strategy.rb

@@ -1,7 +1,12 @@
 module GraphQL::Batch
   class ExecutionStrategy < GraphQL::Query::SerialExecution
-    def execute(_, _, _)
+    attr_accessor :disable_batching
+
+    def execute(_, _, query)
       as_promise(super).sync
+    rescue GraphQL::InvalidNullError => err
+      err.parent_error? || query.context.errors.push(err)
+      nil
     ensure
       GraphQL::Batch::Executor.current.clear
     end

data/lib/graphql/batch/loader.rb

@@ -2,55 +2,97 @@ module GraphQL::Batch
   class Loader
     def self.for(*group_args)
       loader_key = [self].concat(group_args)
-      Executor.current.loaders[loader_key] ||= new(*group_args)
+      Executor.current.loaders[loader_key] ||= new(*group_args).tap do |loader|
+        loader.loader_key = loader_key
+      end
     end
 
-    def promises_by_key
-      @promises_by_key ||= {}
+    def self.load(key)
+      self.for.load(key)
     end
 
-    def keys
-      promises_by_key.keys
+    def self.load_many(keys)
+      self.for.load_many(keys)
     end
 
+    attr_accessor :loader_key
+
     def load(key)
-      promises_by_key[key] ||= Promise.new
+      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
+      end
     end
 
     def load_many(keys)
       Promise.all(keys.map { |key| load(key) })
     end
 
+    def resolve #:nodoc:
+      load_keys = queue
+      return if load_keys.empty?
+      @queue = nil
+      perform(load_keys)
+      check_for_broken_promises(load_keys)
+    rescue => err
+      each_pending_promise(load_keys) do |key, promise|
+        promise.reject(err)
+      end
+    end
+
+    protected
+
+    # Fulfill the key with provided value, for use in #perform
     def fulfill(key, value)
-      promises_by_key[key].fulfill(value)
+      promise_for(key).fulfill(value)
     end
 
+    # Returns true when the key has already been fulfilled, otherwise returns false
     def fulfilled?(key)
-      promises_by_key[key].fulfilled?
+      promise_for(key).fulfilled?
     end
 
-    # batch load keys and fulfill promises
+    # Must override to load the keys and call #fulfill for each key
     def perform(keys)
       raise NotImplementedError
     end
 
-    def resolve
-      perform(keys)
-      check_for_broken_promises
-    rescue => err
-      promises_by_key.each do |key, promise|
-        promise.reject(err)
-      end
+    # Override to use a different key for the cache than the load key
+    def cache_key(load_key)
+      load_key
     end
 
     private
 
-    def check_for_broken_promises
-      promises_by_key.each do |key, promise|
+    def cache
+      @cache ||= {}
+    end
+
+    def queue
+      @queue ||= []
+    end
+
+    def promise_for(load_key)
+      cache.fetch(cache_key(load_key))
+    end
+
+    def each_pending_promise(load_keys)
+      load_keys.each do |key|
+        promise = promise_for(key)
         if promise.pending?
-          promise.reject(BrokenPromiseError.new("#{self.class} didn't fulfill promise for key #{key.inspect}"))
+          yield key, promise
         end
       end
     end
+
+    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}"))
+      end
+    end
   end
 end

data/lib/graphql/batch/mutation_execution_strategy.rb

@@ -1,18 +1,18 @@
 module GraphQL::Batch
-  class MutationExecutionStrategy < GraphQL::Query::SerialExecution
-    class FieldResolution < GraphQL::Query::SerialExecution::FieldResolution
+  class MutationExecutionStrategy < GraphQL::Batch::ExecutionStrategy
+    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
 
-        context = execution_context.query.context
-        old_execution_strategy = context.execution_strategy
+        execution_context.strategy.disable_batching = true
         begin
-          context.execution_strategy = GraphQL::Batch::ExecutionStrategy.new
           result = super(raw_value)
           GraphQL::Batch::Executor.current.wait_all
           result
         ensure
-          context.execution_strategy = old_execution_strategy
+          execution_context.strategy.disable_batching = false
         end
       end
     end

data/lib/graphql/batch/version.rb

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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: graphql-batch
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Dylan Thacker-Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2016-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: promise.rb
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +102,7 @@ dependencies:
         version: '0'
 description: 
 email:
-- Dylan.Smith@shopify.com
+- gems@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -137,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A query batching executor for the graphql gem