Skip to content

Latest commit

 

History

History
153 lines (108 loc) · 5.39 KB

CHANGELOG.md

File metadata and controls

153 lines (108 loc) · 5.39 KB

Changelog

The following are lists of the notable changes included with each release. This is intended to help keep people informed about notable changes between versions, as well as provide a rough history. Each item is prefixed with one of the following labels: Added, Changed, Deprecated, Removed, Fixed, Security. We also use Semantic Versioning to manage the versions of this gem so that you can set version constraints properly.

Unreleased

  • WIP

v1.3.0

  • Added: BatchLoader::GraphQL.for to make it compatible with graphql gem versions >= 1.8.7. #30

v1.2.2

  • Fixed: Identify item by key object instead of key string representation. #27

v1.2.1

  • Fixed: Do not depend on method_missing for respond_to?. #14

v1.2.0

  • Added: key argument for the BatchLoader#batch method. #12

v1.1.1

  • Fixed: loader, made it thread-safe again. #10

v1.1.0

  • Added: default_value override option. #8
  • Added: loader.call {} block syntax, for memoizing repeat calls to the same item. #8

v1.0.4

  • Fixed: Fix arity bug in respond_to? #3

v1.0.3 – 2017-09-18

  • Fixed: auto syncing performance up to 30x times compared to v1.0.2. 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 lazy_resolve.
  • Added: more benchmarks.

v1.0.2 – 2017-09-14

# 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
# 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 nils for not loaded values only after successful #batch execution.
  • Changed: internal implementation with Ruby Forwardable, don't delegate methods like object_id and __send__.

v1.0.1 – 2017-09-03

  • Fixed: loading BatchLoader by requiring Set.

v1.0.0 – 2017-08-21

  • Removed: BatchLoader.sync! and BatchLoader#sync. Now syncing is done implicitly when you call any method on the lazy object.
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:
users = [load_user(1), load_user(2), load_user(3)]
puts users
  • Removed: BatchLoader#load. Use loader lambda instead:
# 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:
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:
# Before:
Schema = GraphQL::Schema.define do
  # ...
  lazy_resolve BatchLoader, :sync
end
# After:
Schema = GraphQL::Schema.define do
  # ...
  use BatchLoader::GraphQL
end

v0.3.0 – 2017-08-03

  • Added: BatchLoader::Executor.clear_current to clear cache manually.
  • Added: tests and description how to use with GraphQL.

v0.2.0 – 2017-08-02

  • Added: cache: false option to disable caching for resolved values.
  • Added: BatchLoader::Middleware to clear cache between Rack requests.
  • Added: more docs and tests.

v0.1.0 – 2017-07-31

  • Added: initial functional version.