graphql-batch 0.3.3 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b69567be96fe5b00779872cbb3a6d1e14b3d2a28
-  data.tar.gz: cfc2323ef559f92884560f68713b3d9cd41a3017
+  metadata.gz: c793255ae48cf638179b9e786d03493a469d1629
+  data.tar.gz: d235b788e4f9208747d7145e7d2599c2279319d1
 SHA512:
-  metadata.gz: 423111d4a94fde2835dcfea8cafa234047100d0dd2bc248362b988537ee1dc1c35c86e5924f8db3730d95b09fbb20a49c3dfa3d6e8858271d1ad060a8303e086
-  data.tar.gz: d31cc1b4cddb5db6d1650e51632b26f113e5414c6d9dc44916785b7a5911c0c953e9b1fd476395fea8d9eca2ad502e08a55ead3c7bec994ebdd4059284635980
+  metadata.gz: 7b263790b1871d54d9258e7bd2541c17361b8177a79e07aac146f9d3ccf05570cf07f8aaac40cf4dbe76c3b6f1677f3cd957a32904742c069a133d3906044767
+  data.tar.gz: d00d449a8872286251cc21d555b54be0690002f697dddb8afc1f43e6b90d75e42367ad70f54c701fc75d89b04427b4d127879481c406a24555d3ada35ce0582f

data/.travis.yml

@@ -2,4 +2,6 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
+  - 2.3
+  - 2.4
 before_install: gem install bundler -v 1.13.3

data/README.md

@@ -72,6 +72,18 @@ The loader class can be used from the resolve proc for a graphql field by callin
 resolve -> (obj, args, context) { RecordLoader.for(Product).load(args["id"]) }
 ```
 
+The loader also supports batch loading an array of records instead of just a single record, via `load_many`. For example:
+
+```ruby
+resolve -> (obj, args, context) { RecordLoader.for(Product).load_many(args["ids"]) }
+```
+
+Although this library doesn't have a dependency on active record,
+the [examples directory](examples) has record and association loaders
+for active record which handles edge cases like type casting ids
+and overriding GraphQL::Batch::Loader#cache_key to load associations
+on records with the same id.
+
 ### Promises
 
 GraphQL::Batch::Loader#load returns a Promise using the [promise.rb gem](https://rubygems.org/gems/promise.rb) to provide a promise based API, so you can transform the query results using `.then`

data/examples/association_loader.rb

@@ -0,0 +1,48 @@
+class AssociationLoader < GraphQL::Batch::Loader
+  def self.validate(model, association_name)
+    new(model, association_name)
+    nil
+  end
+
+  def initialize(model, association_name)
+    @model = model
+    @association_name = association_name
+    validate
+  end
+
+  def load(record)
+    raise TypeError, "#{@model} loader can't load association for #{record.class}" unless record.is_a?(@model)
+    return Promise.resolve(read_association(record)) if association_loaded?(record)
+    super
+  end
+
+  # We want to load the associations on all records, even if they have the same id
+  def cache_key(record)
+    record.object_id
+  end
+
+  def perform(records)
+    preload_association(records)
+    records.each { |record| fulfill(record, read_association(record)) }
+  end
+
+  private
+
+  def validate
+    unless @model.reflect_on_association(@association_name)
+      raise ArgumentError, "No association #{@association_name} on #{@model}"
+    end
+  end
+
+  def preload_association(records)
+    ::ActiveRecord::Associations::Preloader.new.preload(records, @association_name)
+  end
+
+  def read_association(record)
+    record.public_send(@association_name)
+  end
+
+  def association_loaded?(record)
+    record.association(@association_name).loaded?
+  end
+end

data/examples/record_loader.rb

@@ -0,0 +1,25 @@
+class RecordLoader < GraphQL::Batch::Loader
+  def initialize(model, column: model.primary_key, where: nil)
+    @model = model
+    @column = column.to_s
+    @column_type = model.type_for_attribute(@column)
+    @where = where
+  end
+
+  def load(key)
+    super(@column_type.cast(key))
+  end
+
+  def perform(keys)
+    query(keys).each { |record| fulfill(record.public_send(@column), record) }
+    keys.each { |key| fulfill(key, nil) unless fulfilled?(key) }
+  end
+
+  private
+
+  def query(keys)
+    scope = @model
+    scope = scope.where(@where) if @where
+    scope.where(@column => keys)
+  end
+end

data/graphql-batch.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "graphql", ">= 0.8", "< 2"
   spec.add_runtime_dependency "promise.rb", "~> 0.7.2"
 
-  spec.add_development_dependency "byebug" if RUBY_ENGINE == 'ruby'
+  if RUBY_ENGINE == 'ruby' && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2")
+    spec.add_development_dependency "byebug"
+  end
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"

data/lib/graphql/batch/execution_strategy.rb

@@ -13,7 +13,7 @@ module GraphQL::Batch
 
     # Needed for MutationExecutionStrategy
     def deep_sync(result) #:nodoc:
-      Promise.sync(as_promise_unless_resolved(result))
+      ::Promise.sync(as_promise_unless_resolved(result))
     end
 
     private

data/lib/graphql/batch/executor.rb

@@ -3,15 +3,29 @@ module GraphQL::Batch
     THREAD_KEY = :"#{name}.batched_queries"
     private_constant :THREAD_KEY
 
-    def self.current
-      Thread.current[THREAD_KEY]
-    end
+    class << self
+      def current
+        Thread.current[THREAD_KEY]
+      end
 
-    def self.current=(executor)
-      Thread.current[THREAD_KEY] = executor
-    end
+      def current=(executor)
+        Thread.current[THREAD_KEY] = executor
+      end
 
-    attr_reader :loaders
+      def start_batch(executor_class)
+        executor = Thread.current[THREAD_KEY] ||= executor_class.new
+        executor.increment_level
+      end
+
+      def end_batch
+        executor = current
+        unless executor
+          raise NoExecutorError, 'Cannot end a batch without an Executor.'
+        end
+        return unless executor.decrement_level < 1
+        self.current = nil
+      end
+    end
 
     # Set to true when performing a batch query, otherwise, it is false.
     #
@@ -21,44 +35,52 @@ module GraphQL::Batch
     def initialize
       @loaders = {}
       @loading = false
+      @nesting_level = 0
     end
 
-    def resolve(loader)
-      with_loading(true) { loader.resolve }
+    def loader(key)
+      @loaders[key] ||= yield.tap do |loader|
+        loader.executor = self
+        loader.loader_key = key
+      end
     end
 
-    def shift
-      @loaders.shift.last
+    def resolve(loader)
+      was_loading = @loading
+      @loading = true
+      loader.resolve
+    ensure
+      @loading = was_loading
     end
 
     def tick
-      resolve(shift)
+      resolve(@loaders.shift.last)
     end
 
     def wait_all
-      tick until loaders.empty?
+      tick until @loaders.empty?
     end
 
     def clear
-      loaders.clear
+      @loaders.clear
     end
 
-    def defer
-      # Since we aren't actually deferring callbacks, we need to set #loading to false so that any queries
-      # that happen in the callback aren't interpreted as being performed in GraphQL::Batch::Loader#perform
-      with_loading(false) { yield }
+    def increment_level
+      @nesting_level += 1
     end
 
-    private
+    def decrement_level
+      @nesting_level -= 1
+    end
 
-    def with_loading(loading)
+    def around_promise_callbacks
+      # We need to set #loading to false so that any queries that happen in the promise
+      # callback aren't interpreted as being performed in GraphQL::Batch::Loader#perform
       was_loading = @loading
-      begin
-        @loading = loading
-        yield
-      ensure
-        @loading = was_loading
-      end
+      @loading = false
+      yield
+    ensure
+      @loading = was_loading
     end
   end
 end

data/lib/graphql/batch/loader.rb

@@ -1,21 +1,20 @@
 module GraphQL::Batch
   class Loader
-    class NoExecutorError < StandardError; end
+    NoExecutorError = GraphQL::Batch::NoExecutorError
+    deprecate_constant :NoExecutorError if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.3")
 
     def self.for(*group_args)
       loader_key = loader_key_for(*group_args)
       executor = Executor.current
 
       unless executor
-        raise NoExecutorError, "Cannot create loader without an Executor."\
-          " Wrap the call to `for` with `GraphQL::Batch.batch` or use"\
-          " `GraphQL::Batch::Setup` as a query instrumenter if using with `graphql-ruby`"
+        raise GraphQL::Batch::NoExecutorError, 'Cannot create loader without'\
+          ' an Executor. Wrap the call to `for` with `GraphQL::Batch.batch`'\
+          ' or use `GraphQL::Batch::Setup` as a query instrumenter if'\
+          ' using with `graphql-ruby`'
       end
 
-      executor.loaders[loader_key] ||= new(*group_args).tap do |loader|
-        loader.loader_key = loader_key
-        loader.executor = executor
-      end
+      executor.loader(loader_key) { new(*group_args) }
     end
 
     def self.loader_key_for(*group_args)
@@ -35,7 +34,7 @@ module GraphQL::Batch
     def load(key)
       cache[cache_key(key)] ||= begin
         queue << key
-        Promise.new.tap { |promise| promise.source = self }
+        ::Promise.new.tap { |promise| promise.source = self }
       end
     end
 
@@ -50,9 +49,7 @@ module GraphQL::Batch
       perform(load_keys)
       check_for_broken_promises(load_keys)
     rescue => err
-      each_pending_promise(load_keys) do |key, promise|
-        promise.reject(err)
-      end
+      reject_pending_promises(load_keys, err)
     end
 
     # For Promise#sync
@@ -72,7 +69,15 @@ module GraphQL::Batch
 
     # Fulfill the key with provided value, for use in #perform
     def fulfill(key, value)
-      promise_for(key).fulfill(value)
+      finish_resolve(key) do |promise|
+        promise.fulfill(value)
+      end
+    end
+
+    def reject(key, reason)
+      finish_resolve(key) do |promise|
+        promise.reject(reason)
+      end
     end
 
     # Returns true when the key has already been fulfilled, otherwise returns false
@@ -92,6 +97,14 @@ module GraphQL::Batch
 
     private
 
+    def finish_resolve(key)
+      promise = promise_for(key)
+      return yield(promise) unless executor
+      executor.around_promise_callbacks do
+        yield promise
+      end
+    end
+
     def cache
       @cache ||= {}
     end
@@ -104,18 +117,19 @@ module GraphQL::Batch
       cache.fetch(cache_key(load_key))
     end
 
-    def each_pending_promise(load_keys)
+    def reject_pending_promises(load_keys, err)
       load_keys.each do |key|
-        promise = promise_for(key)
-        if promise.pending?
-          yield key, promise
-        end
+        next unless promise_for(key).pending?
+
+        reject(key, err)
       end
     end
 
     def check_for_broken_promises(load_keys)
-      each_pending_promise(load_keys) do |key, promise|
-        promise.reject(::Promise::BrokenError.new("#{self.class} didn't fulfill promise for key #{key.inspect}"))
+      load_keys.each do |key|
+        next unless promise_for(key).pending?
+
+        reject(key, ::Promise::BrokenError.new("#{self.class} didn't fulfill promise for key #{key.inspect}"))
       end
     end
   end

data/lib/graphql/batch/mutation_execution_strategy.rb

@@ -9,11 +9,13 @@ module GraphQL::Batch
         strategy = execution_context.strategy
         return super if strategy.enable_batching
 
+        GraphQL::Batch::Executor.current.clear
         begin
           strategy.enable_batching = true
-          strategy.deep_sync(Promise.sync(super))
+          strategy.deep_sync(::Promise.sync(super))
         ensure
           strategy.enable_batching = false
+          GraphQL::Batch::Executor.current.clear
         end
       end
     end

data/lib/graphql/batch/promise.rb

@@ -1,8 +1,6 @@
 module GraphQL::Batch
-  class Promise < ::Promise
-    def defer
-      executor = Executor.current
-      executor ? executor.defer { super } : super
-    end
+  Promise = ::Promise
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.3")
+    deprecate_constant :Promise
   end
 end

data/lib/graphql/batch/setup.rb

@@ -1,14 +1,54 @@
 module GraphQL::Batch
-  module Setup
-    extend self
+  class Setup
+    class << self
+      def start_batching(executor_class)
+        GraphQL::Batch::Executor.start_batch(executor_class)
+      end
+
+      def end_batching
+        GraphQL::Batch::Executor.end_batch
+      end
+
+      def instrument_field(schema, type, field)
+        return field unless type == schema.mutation
+        old_resolve_proc = field.resolve_proc
+        field.redefine do
+          resolve ->(obj, args, ctx) {
+            GraphQL::Batch::Executor.current.clear
+            begin
+              ::Promise.sync(old_resolve_proc.call(obj, args, ctx))
+            ensure
+              GraphQL::Batch::Executor.current.clear
+            end
+          }
+        end
+      end
+
+      def before_query(query)
+        warn "Deprecated graphql-batch setup `instrument(:query, GraphQL::Batch::Setup)`, replace with `use GraphQL::Batch`"
+        start_batching(GraphQL::Batch::Executor)
+      end
+
+      def after_query(query)
+        end_batching
+      end
+    end
+
+    def initialize(schema, executor_class:)
+      @schema = schema
+      @executor_class = executor_class
+    end
 
     def before_query(query)
-      raise NestedError if GraphQL::Batch::Executor.current
-      GraphQL::Batch::Executor.current = GraphQL::Batch::Executor.new
+      Setup.start_batching(@executor_class)
     end
 
     def after_query(query)
-      GraphQL::Batch::Executor.current = nil
+      Setup.end_batching
+    end
+
+    def instrument(type, field)
+      Setup.instrument_field(@schema, type, field)
     end
   end
 end

data/lib/graphql/batch/setup_multiplex.rb

@@ -0,0 +1,20 @@
+module GraphQL::Batch
+  class SetupMultiplex
+    def initialize(schema, executor_class:)
+      @schema = schema
+      @executor_class = executor_class
+    end
+
+    def before_multiplex(multiplex)
+      Setup.start_batching(@executor_class)
+    end
+
+    def after_multiplex(multiplex)
+      Setup.end_batching
+    end
+
+    def instrument(type, field)
+      Setup.instrument_field(@schema, type, field)
+    end
+  end
+end

data/lib/graphql/batch/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Batch
-    VERSION = "0.3.3"
+    VERSION = "0.3.10"
   end
 end

data/lib/graphql/batch.rb

@@ -7,20 +7,28 @@ require "promise.rb"
 module GraphQL
   module Batch
     BrokenPromiseError = ::Promise::BrokenError
-    class NestedError < StandardError; end
+    class NoExecutorError < StandardError; end
 
-    def self.batch
-      raise NestedError if GraphQL::Batch::Executor.current
+    def self.batch(executor_class: GraphQL::Batch::Executor)
       begin
-        GraphQL::Batch::Executor.current = GraphQL::Batch::Executor.new
-        Promise.sync(yield)
+        GraphQL::Batch::Executor.start_batch(executor_class)
+        ::Promise.sync(yield)
       ensure
-        GraphQL::Batch::Executor.current = nil
+        GraphQL::Batch::Executor.end_batch
       end
     end
 
-    def self.use(schema_defn)
-      schema_defn.instrument(:query, GraphQL::Batch::Setup)
+    def self.use(schema_defn, executor_class: GraphQL::Batch::Executor)
+      schema = schema_defn.target
+      if GraphQL::VERSION >= "1.6.0"
+        instrumentation = GraphQL::Batch::SetupMultiplex.new(schema, executor_class: executor_class)
+        schema_defn.instrument(:multiplex, instrumentation)
+        schema_defn.instrument(:field, instrumentation)
+      else
+        instrumentation = GraphQL::Batch::Setup.new(schema, executor_class: executor_class)
+        schema_defn.instrument(:query, instrumentation)
+        schema_defn.instrument(:field, instrumentation)
+      end
       schema_defn.lazy_resolve(::Promise, :sync)
     end
 
@@ -34,3 +42,4 @@ require_relative "batch/loader"
 require_relative "batch/executor"
 require_relative "batch/promise"
 require_relative "batch/setup"
+require_relative "batch/setup_multiplex"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-batch
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.10
 platform: ruby
 authors:
 - Dylan Thacker-Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -116,6 +116,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/association_loader.rb
+- examples/record_loader.rb
 - graphql-batch.gemspec
 - lib/graphql/batch.rb
 - lib/graphql/batch/execution_strategy.rb
@@ -124,6 +126,7 @@ files:
 - lib/graphql/batch/mutation_execution_strategy.rb
 - lib/graphql/batch/promise.rb
 - lib/graphql/batch/setup.rb
+- lib/graphql/batch/setup_multiplex.rb
 - lib/graphql/batch/version.rb
 homepage: https://github.com/Shopify/graphql-batch
 licenses:
@@ -145,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A query batching executor for the graphql gem