batch-loader 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb37551b8e0c52cb65a331801fa0110e311aebf9
-  data.tar.gz: 9f5a59bd9626c0341103c2d5c422119ff71aedba
+  metadata.gz: daca6a2439fe33924b7377eb3b37c15f9226e6ae
+  data.tar.gz: 11a8c50e28d6153de19f3ce7c76703a14995ac91
 SHA512:
-  metadata.gz: 92e829a4416c25050380ef59dbe43873f89911140ade537b9420bc05fb6bb45364591781010b0b0ecab5f71e1a5ec1bb56fa15f4cdb6ef4859547687e3bb30d0
-  data.tar.gz: 6101f58d4292906aa512ae16e88f3c563c351984c2edea960fc1d4ff7ddd87a95dbb69e0fdd201376e93d0f189638f27ad0a76ff191c30dc79ba6d5fbf61b5c2
+  metadata.gz: 8ec2f1daee17b1d27f8bd8f30b542a5590634f1726e48913e8d6ca8e6d1e32455cadf4172a43e769627a44aa7e38a04a4e87f36838623de43e8f56077066d035
+  data.tar.gz: 285454c49fb476088ab0d1cbe1a56671da695b5a1f3d9e69ac61b1070bb74d196653714ed01b457d8fab97e1443ffbcc0e17b2407348146fec16c424d278dd73

data/CHANGELOG.md

@@ -8,13 +8,44 @@ one of the following labels: `Added`, `Changed`, `Deprecated`,
 to manage the versions of this gem so
 that you can set version constraints properly.
 
-#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v1.0.2...HEAD)
+#### [Unreleased](https://github.com/exAspArk/batch-loader/compare/v1.0.3...HEAD)
 
 * WIP
 
+#### [v1.0.3](https://github.com/exAspArk/batch-loader/compare/v1.0.2...v1.0.3) – 2017-09-18
+
+* `Fixed`: auto syncing performance up to 30x times compared to [v1.0.2](https://github.com/exAspArk/batch-loader/blob/master/CHANGELOG.md#v102--2017-09-14). Ruby `Forwardable` with `def_delegators` is too slow.
+* `Fixed`: GraphQL performance up to 3x times by disabling auto syncing in favor of syncing with [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) `lazy_resolve`.
+* `Added`: more benchmarks.
+
 #### [v1.0.2](https://github.com/exAspArk/batch-loader/compare/v1.0.1...v1.0.2) – 2017-09-14
 
 * `Added`: `BatchLoader#inspect` method because of Pry, which [swallows errors](https://github.com/pry/pry/issues/1642).
+
+```ruby
+# Before:
+require 'pry'
+binding.pry
+
+pry(main)> result = BatchLoader.for(1).batch { |ids, loader| raise "Oops" };
+pry(main)> result # Pry called result.inspect and swallowed the "Oops" error
+# => #<BatchLoader:0x8>
+pry(main)> result.id
+# => NoMethodError: undefined method `id' for nil:NilClass
+```
+
+```ruby
+# After:
+require 'pry'
+binding.pry
+
+pry(main)> result = BatchLoader.for(1).batch { |ids, loader| raise "Oops" };
+pry(main)> result
+# => #<BatchLoader:0x140653946335160>
+pry(main)> result.id
+# => RuntimeError: Oops
+```
+
 * `Added`: benchmarks.
 * `Fixed`: caching `nil`s for not loaded values only after successful `#batch` execution.
 * `Changed`: internal implementation with Ruby `Forwardable`, don't delegate methods like `object_id` and `__send__`.
@@ -27,42 +58,56 @@ that you can set version constraints properly.
 
 * `Removed`: `BatchLoader.sync!` and `BatchLoader#sync`. Now syncing is done implicitly when you call any method on the lazy object.
 
-Before:
-
 ```ruby
 def load_user(user_id)
   BatchLoader.for(user_id).batch { ... }
 end
 
+# Before:
 users = [load_user(1), load_user(2), load_user(3)]
 puts BatchLoader.sync!(users) # or users.map!(&:sync)
 ```
 
-After:
-
 ```ruby
+# After:
 users = [load_user(1), load_user(2), load_user(3)]
 puts users
 ```
 
 * `Removed`: `BatchLoader#load`. Use `loader` lambda instead:
 
-Before:
-
 ```ruby
+# Before:
 BatchLoader.for(user_id).batch do |user_ids, batch_loader|
   user_ids.each { |user_id| batch_loader.load(user_id, user_id) }
 end
 ```
 
-After:
-
 ```ruby
+# After:
 BatchLoader.for(user_id).batch do |user_ids, loader|
   user_ids.each { |user_id| loader.call(user_id, user_id) }
 end
 ```
 
+* `Changed`: use `BatchLoader::GraphQL` in GraphQL schema:
+
+```ruby
+# Before:
+Schema = GraphQL::Schema.define do
+  # ...
+  lazy_resolve BatchLoader, :sync
+end
+```
+
+```ruby
+# After:
+Schema = GraphQL::Schema.define do
+  # ...
+  use BatchLoader::GraphQL
+end
+```
+
 #### [v0.3.0](https://github.com/exAspArk/batch-loader/compare/v0.2.0...v0.3.0) – 2017-08-03
 
 * `Added`: `BatchLoader::Executor.clear_current` to clear cache manually.

data/batch-loader.gemspec

@@ -1,7 +1,5 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "batch_loader/version"
+require_relative "./lib/batch_loader/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "batch-loader"
@@ -29,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "graphql", "~> 1.6"
   spec.add_development_dependency "pry-byebug", "~> 3.4"
   spec.add_development_dependency "benchmark-ips", "~> 2.7"
+  spec.add_development_dependency "ruby-prof", "~> 0.16"
 end

data/lib/batch-loader.rb

@@ -1 +1 @@
-require "batch_loader"
+require_relative "./batch_loader"

data/lib/batch_loader.rb

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
 
 require "set"
-require "forwardable"
 
-require "batch_loader/version"
-require "batch_loader/executor_proxy"
-require "batch_loader/middleware"
-require "batch_loader/graphql"
+require_relative "./batch_loader/version"
+require_relative "./batch_loader/executor_proxy"
+require_relative "./batch_loader/middleware"
+require_relative "./batch_loader/graphql"
 
 class BatchLoader
-  extend Forwardable
-
-  IMPLEMENTED_INSTANCE_METHODS = %i[object_id __id__ __send__ singleton_method_added batch_loader? respond_to? batch inspect].freeze
+  IMPLEMENTED_INSTANCE_METHODS = %i[object_id __id__ __send__ singleton_method_added __sync respond_to? batch inspect].freeze
   REPLACABLE_INSTANCE_METHODS = %i[batch inspect].freeze
   LEFT_INSTANCE_METHODS = (IMPLEMENTED_INSTANCE_METHODS - REPLACABLE_INSTANCE_METHODS).freeze
 
@@ -28,17 +25,13 @@ class BatchLoader
   def batch(cache: true, &batch_block)
     @cache = cache
     @batch_block = batch_block
-    executor_proxy.add(item: @item)
+    __executor_proxy.add(item: @item)
 
-    singleton_class.class_eval { undef_method(:batch) }
+    __singleton_class.class_eval { undef_method(:batch) }
 
     self
   end
 
-  def batch_loader?
-    true
-  end
-
   def respond_to?(method_name)
     LEFT_INSTANCE_METHODS.include?(method_name) || method_missing(:respond_to?, method_name)
   end
@@ -47,58 +40,74 @@ class BatchLoader
     "#<BatchLoader:0x#{(object_id << 1)}>"
   end
 
+  def __sync
+    return @loaded_value if @synced
+
+    __ensure_batched
+    @loaded_value = __executor_proxy.loaded_value(item: @item)
+
+    if @cache
+      @synced = true
+    else
+      __purge_cache
+    end
+
+    @loaded_value
+  end
+
   private
 
   def method_missing(method_name, *args, &block)
-    sync!.public_send(method_name, *args, &block)
+    __sync!.public_send(method_name, *args, &block)
   end
 
-  def sync!
-    return self if @synced
-
-    ensure_batched
-    loaded_value = executor_proxy.loaded_value(item: @item)
+  def __sync!
+    loaded_value = __sync
 
     if @cache
-      replace_with!(loaded_value)
-      @synced = true
-      self
+      __replace_with!(loaded_value)
     else
-      purge_cache
       loaded_value
     end
   end
 
-  def ensure_batched
-    return if executor_proxy.value_loaded?(item: @item)
+  def __ensure_batched
+    return if __executor_proxy.value_loaded?(item: @item)
 
-    items = executor_proxy.list_items
-    loader = ->(item, value) { executor_proxy.load(item: item, value: value) }
+    items = __executor_proxy.list_items
+    loader = ->(item, value) { __executor_proxy.load(item: item, value: value) }
 
     @batch_block.call(items, loader)
     items.each do |item|
-      next if executor_proxy.value_loaded?(item: item)
+      next if __executor_proxy.value_loaded?(item: item)
       loader.call(item, nil) # use "nil" for not loaded item after succesfull batching
     end
-    executor_proxy.delete(items: items)
+    __executor_proxy.delete(items: items)
   end
 
-  def singleton_class
+  def __singleton_class
     class << self ; self ; end
   end
 
-  def replace_with!(value)
-    @loaded_value = value
-    singleton_class.class_eval { def_delegators :@loaded_value, *(value.methods - LEFT_INSTANCE_METHODS) }
+  def __replace_with!(value)
+    __singleton_class.class_eval do
+      (value.methods - LEFT_INSTANCE_METHODS).each do |method_name|
+        define_method(method_name) do |*args, &block|
+          value.public_send(method_name, *args, &block)
+        end
+      end
+    end
+
+    self
   end
 
-  def purge_cache
-    executor_proxy.unload_value(item: @item)
-    executor_proxy.add(item: @item)
+  def __purge_cache
+    __executor_proxy.unload_value(item: @item)
+    __executor_proxy.add(item: @item)
   end
 
-  def executor_proxy
-    @executor_proxy ||= begin
+  def __executor_proxy
+    @__executor_proxy ||= begin
       raise NoBatchError.new("Please provide a batch block first") unless @batch_block
       BatchLoader::ExecutorProxy.new(&@batch_block)
     end

data/lib/batch_loader/executor_proxy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "batch_loader/executor"
+require_relative "./executor"
 
 class BatchLoader
   class ExecutorProxy

data/lib/batch_loader/graphql.rb

@@ -8,7 +8,7 @@ class BatchLoader
       end
 
       def sync
-        @batch_loader
+        @batch_loader.__sync
       end
     end
 
@@ -21,7 +21,7 @@ class BatchLoader
       old_resolve_proc = field.resolve_proc
       new_resolve_proc = ->(object, arguments, context) do
         result = old_resolve_proc.call(object, arguments, context)
-        result.respond_to?(:batch_loader?) ? BatchLoader::GraphQL::Wrapper.new(result) : result
+        result.respond_to?(:__sync) ? BatchLoader::GraphQL::Wrapper.new(result) : result
       end
 
       field.redefine { resolve(new_resolve_proc) }

data/lib/batch_loader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class BatchLoader
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch-loader
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - exAspArk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: Powerful tool to avoid N+1 DB or HTTP queries
 email:
 - exaspark@gmail.com