graphql-batch 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1f52d43c7f189fab24b5e00f8b34435e99c03ae23ba4c99dfaa7a94d67271ed
-  data.tar.gz: 0ceb7b68519b2e1bd0f94686376d26590cebb9697fd50e80272d0770a85c4784
+  metadata.gz: b257f38787895a689caec957a242bef5fa56e02030b2ac499078a510820b8669
+  data.tar.gz: 9232d5995209ff370617a4f68f31cf936fd334ccd9eaad1cc449336d353a6535
 SHA512:
-  metadata.gz: '091fe19e752f10751216374384346e2c4bb0d8fbe35e86248b3584396531ff2775b4732380da5109968b402320ca22e0cc2f1f772ca26f9d12b4b2bfc5a5a049'
-  data.tar.gz: 6890562c5b66004bf10b886ba6370cf7c544ab796f2e29ac279b49c93003079b1722c068155a168f5ee9f3194b34395a2d26ac2e8e3013cecd6e74db2286d8ad
+  metadata.gz: d8106c65d1842f98cbe1698e881e54c569d8452b684a6caea28b62a75cfde21a4b28fdbb6a61acb7a884dc6826a6209d05ddcdc6b3b7843ee6188202dfdfb638
+  data.tar.gz: 370418c233cc8fbf99734ba76eefd1c3d703a0bc40b249ed0dc8e24890a968fe45cf22ff8dc9d1a88c73dee5aa00971c4e3b0a5104048f9b5e3390bfced7a421

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.7, '3.0']
+        graphql_version: ['~> 1.10.0', '~> 1.13']
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby }}
+      env:
+        GRAPHQL_VERSION: ${{ matrix.graphql_version }}
+    - run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+  Exclude:
+    - vendor/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,199 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-02-06 13:18:09 -0500 using RuboCop version 0.78.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: outdent, indent
+Layout/AccessModifierIndentation:
+  Exclude:
+    - 'examples/http_loader.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 182
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'test/graphql_test.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'test/support/db.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'test/graphql_test.rb'
+    - 'test/multiplex_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceInsideParens:
+  Exclude:
+    - 'test/loader_test.rb'
+
+# Offense count: 3
+Lint/MissingSuper:
+  Exclude:
+    - 'test/executor_test.rb'
+    - 'test/loader_test.rb'
+    - 'test/support/loaders.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/graphql/batch.rb'
+    - 'test/support/db.rb'
+    - 'test/support/loaders.rb'
+    - 'test/support/schema.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/graphql/batch/loader.rb'
+    - 'lib/graphql/batch/setup.rb'
+    - 'lib/graphql/batch/setup_multiplex.rb'
+    - 'test/executor_test.rb'
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Exclude:
+    - 'test/loader_test.rb'
+
+# Offense count: 1
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'test/support/db.rb'
+
+# Offense count: 11
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/graphql/batch/executor.rb'
+    - 'lib/graphql/batch/loader.rb'
+    - 'lib/graphql/batch/mutation_field_extension.rb'
+    - 'lib/graphql/batch/setup.rb'
+    - 'lib/graphql/batch/setup_multiplex.rb'
+    - 'test/batch_test.rb'
+    - 'test/custom_executor_test.rb'
+    - 'test/executor_test.rb'
+    - 'test/graphql_test.rb'
+    - 'test/loader_test.rb'
+    - 'test/multiplex_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerBackticks.
+# SupportedStyles: backticks, percent_x, mixed
+Style/CommandLiteral:
+  Exclude:
+    - 'graphql-batch.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/EmptyLiteral:
+  Exclude:
+    - 'test/support/schema.rb'
+
+# Offense count: 24
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 72
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreMacros, IgnoredMethods, IgnoredPatterns, IncludedMacros, AllowParenthesesInMultilineCall, AllowParenthesesInChaining, AllowParenthesesInCamelCaseMethod, EnforcedStyle.
+# SupportedStyles: require_parentheses, omit_parentheses
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - 'Gemfile'
+    - 'graphql-batch.gemspec'
+    - 'test/batch_test.rb'
+    - 'test/custom_executor_test.rb'
+    - 'test/executor_test.rb'
+    - 'test/graphql_test.rb'
+    - 'test/loader_test.rb'
+    - 'test/multiplex_test.rb'
+    - 'test/support/schema.rb'
+    - 'test/test_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/graphql/batch.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'test/support/db.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'test/support/schema.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInArrayLiteral:
+  Exclude:
+    - 'test/graphql_test.rb'
+
+# Offense count: 23
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'test/graphql_test.rb'
+    - 'test/multiplex_test.rb'

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-if ENV["TESTING_INTERPRETER"] == "true"
-  gem "graphql", "1.9.0.pre4"
+gem 'graphql', ENV['GRAPHQL_VERSION'] if ENV['GRAPHQL_VERSION']
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
+  gem 'rubocop', '~> 1.12.0', require: false
+  gem "rubocop-shopify", '~> 1.0.7', require: false
 end

data/README.md

@@ -48,7 +48,9 @@ class RecordLoader < GraphQL::Batch::Loader
 end
 ```
 
-Use `GraphQL::Batch` as a plugin in your schema (for graphql >= `1.5.0`).
+Use `GraphQL::Batch` as a plugin in your schema _after_ specifying the mutation
+so that `GraphQL::Batch` can extend the mutation fields to clear the cache after
+they are resolved.
 
 ```ruby
 class MySchema < GraphQL::Schema
@@ -59,25 +61,6 @@ class MySchema < GraphQL::Schema
 end
 ```
 
-For pre `1.5.0` versions:
-
-```ruby
-MySchema = GraphQL::Schema.define do
-  query MyQueryType
-
-  GraphQL::Batch.use(self)
-end
-```
-
-##### With `1.9.0`'s `Interpreter` runtime
-
-Add `GraphQL::Batch` _after_ the interpreter, so that `GraphQL::Batch` can detect the interpreter and attach the right integrations:
-
-```ruby
-use GraphQL::Execution::Interpreter
-use GraphQL::Batch
-```
-
 #### Field Usage
 
 The loader class can be used from the resolver for a graphql field by calling `.for` with the grouping arguments to get a loader instance, then call `.load` on that instance with the key to load.
@@ -99,7 +82,7 @@ field :products, [Types::Product, null: true], null: false do
   argument :ids, [ID], required: true
 end
 
-def product(ids:)
+def products(ids:)
   RecordLoader.for(Product).load_many(ids)
 end
 ```
@@ -150,11 +133,11 @@ end
 ```ruby
 def product(id:)
   # Try the cache first ...
-  CacheLoader.for(Product).load(args["id"]).then(nil, lambda do |exc|
+  CacheLoader.for(Product).load(id).then(nil, lambda do |exc|
     # But if there's a connection error, go to the underlying database
     raise exc unless exc.is_a?(Redis::BaseConnectionError)
     logger.warn err.message
-    RecordLoader.for(Product).load(args["id"])
+    RecordLoader.for(Product).load(id)
   end)
 end
 ```
@@ -162,19 +145,19 @@ end
 ## Unit Testing
 
 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
+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)
-    title = GraphQL::Batch.batch do
-      RecordLoader.for(Product).load(product.id).then(&:title)
-    end
-    assert_equal product.title, title
+def test_single_query
+  product = products(:snowboard)
+  title = GraphQL::Batch.batch do
+    RecordLoader.for(Product).load(product.id).then(&:title)
   end
+  assert_equal product.title, title
+end
 ```
 
 ## Development

data/Rakefile

@@ -7,4 +7,13 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task(default: :test)
+
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
+  task :rubocop do
+    require 'rubocop/rake_task'
+    RuboCop::RakeTask.new
+  end
+
+  task(default: :rubocop)
+end

data/examples/active_storage_loader.rb

@@ -0,0 +1,75 @@
+####
+# This is a loader for has_one_attached and has_many_attached Active Storage attachments
+# To load a variant for an attachment, 2 queries are required
+# Using preloading via the includes method.
+####
+
+####
+# The model with an attached image and many attached pictures
+####
+
+# class Event < ApplicationRecord
+#   has_one_attached :image
+#   has_many_attached :pictures
+# end
+
+####
+# An example data type using the AttachmentLoader
+####
+
+# class Types::EventType < Types::BaseObject
+#   graphql_name 'Event'
+#
+#   field :id, ID, null: false
+#   field :image, String, null: true
+#   field :pictures, String, null: true
+#
+#   def image
+#     AttachmentLoader.for(:Event, :image).load(object.id).then do |image|
+#       Rails.application.routes.url_helpers.url_for(
+#         image.variant({ quality: 75 })
+#       )
+#     end
+#   end
+#
+#   def pictures
+#     AttachmentLoader.for(:Event, :pictures, association_type: :has_many_attached).load(object.id).then do |pictures|
+#       pictures.map do |picture|
+#         Rails.application.routes.url_helpers.url_for(
+#           picture.variant({ quality: 75 })
+#         )
+#       end
+#     end
+#   end
+# end
+module Loaders
+  class ActiveStorageLoader < GraphQL::Batch::Loader
+    attr_reader :record_type, :attachment_name, :association_type # should be has_one_attached or has_many_attached
+
+    def initialize(record_type, attachment_name, association_type: :has_one_attached)
+      super()
+      @record_type = record_type
+      @attachment_name = attachment_name
+      @association_type = association_type
+    end
+
+    def perform(record_ids)
+      # find records and fulfill promises
+      attachments = ActiveStorage::Attachment.includes(:blob).where(
+        record_type: record_type, record_id: record_ids, name: attachment_name
+      )
+
+      if @association_type == :has_one_attached
+        attachments.each do |attachment|
+          fulfill(attachment.record_id, attachment)
+        end
+
+        record_ids.each { |id| fulfill(id, nil) unless fulfilled?(id) }
+      else
+        record_ids.each do |record_id|
+          fulfill(record_id, attachments.select { |attachment| attachment.record_id == record_id })
+        end
+      end
+    end
+  end
+end

data/examples/association_loader.rb

@@ -5,6 +5,7 @@ class AssociationLoader < GraphQL::Batch::Loader
   end
 
   def initialize(model, association_name)
+    super()
     @model = model
     @association_name = association_name
     validate
@@ -35,7 +36,7 @@ class AssociationLoader < GraphQL::Batch::Loader
   end
 
   def preload_association(records)
-    ::ActiveRecord::Associations::Preloader.new.preload(records, @association_name)
+    ::ActiveRecord::Associations::Preloader.new(records: records, associations: @association_name).call
   end
 
   def read_association(record)

data/examples/http_loader.rb

@@ -0,0 +1,66 @@
+# A sample HTTP loader using:
+#
+# 1. https://github.com/httprb/http
+# 2. https://github.com/mperham/connection_pool
+# 3. https://github.com/ruby-concurrency/concurrent-ruby
+#
+# Setup:
+#
+#   field :weather, String, null: true do
+#     argument :lat, Float, required: true
+#     argument :lng, Float, required: true
+#     argument :lang, String, required: true
+#   end
+#
+#   def weather(lat:, lng:, lang:)
+#     key = Rails.application.credentials.darksky_key
+#     path = "/forecast/#{key}/#{lat},#{lng}?lang=#{lang}"
+#     Loaders::HTTPLoader
+#       .for(host: 'https://api.darksky.net')
+#       .load(->(connection) { connection.get(path).flush })
+#       .then do |response|
+#         if response.status.ok?
+#           json = JSON.parse(response.body)
+#           json['currently']['summary']
+#         end
+#       end
+#   end
+#
+# Querying:
+#
+#   <<~GQL
+#     query Weather {
+#       montreal: weather(lat: 45.5017, lng: -73.5673, lang: "fr")
+#       waterloo: weather(lat: 43.4643, lng: -80.5204, lang: "en")
+#     }
+#   GQL
+
+module Loaders
+  class HTTPLoader < GraphQL::Batch::Loader
+    def initialize(host:, size: 4, timeout: 4)
+      super()
+      @host = host
+      @size = size
+      @timeout = timeout
+    end
+
+    def perform(operations)
+      futures = operations.map do |operation|
+        Concurrent::Promises.future do
+          pool.with { |connection| operation.call(connection) }
+        end
+      end
+      operations.each_with_index.each do |operation, index|
+        fulfill(operation, futures[index].value)
+      end
+    end
+
+  private
+
+    def pool
+      @pool ||= ConnectionPool.new(size: @size, timeout: @timeout) do
+        HTTP.persistent(@host)
+      end
+    end
+  end
+end

data/examples/record_loader.rb

@@ -1,5 +1,6 @@
 class RecordLoader < GraphQL::Batch::Loader
   def initialize(model, column: model.primary_key, where: nil)
+    super()
     @model = model
     @column = column.to_s
     @column_type = model.type_for_attribute(@column)

data/examples/window_key_loader.rb

@@ -0,0 +1,81 @@
+####
+# This is a has_many loader which takes advantage of Postgres'
+# windowing functionality to load the first N records for
+# a given relationship.
+####
+
+####
+# An example data type using the WindowKeyLoader
+####
+
+# class Types::CategoryType < Types::BaseObject
+#   graphql_name 'Category'
+
+#   field :id, ID, null: false
+#   field :events, [Types::EventType], null: false do
+#     argument :first, Int, required: false, default_value: 5
+#   end
+
+#   def events(first:)
+#     WindowKeyLoader.for(
+#       Event,
+#       :category_id,
+#       limit: first, order_col: :start_time, order_dir: :desc
+#     ).load(object.id)
+#   end
+# end
+
+####
+# The SQL that is produced
+####
+
+# SELECT
+#   "events".*
+# FROM (
+#   SELECT
+#     "events".*,
+#     row_number() OVER (PARTITION BY category_id ORDER BY start_time DESC) AS rank
+#   FROM
+#     "events"
+#   WHERE
+#     "events"."category_id" IN(1, 2, 3, 4, 5)) AS events
+# WHERE (rank <= 5)
+
+class WindowKeyLoader < GraphQL::Batch::Loader
+  attr_reader :model, :foreign_key, :limit, :order_col, :order_dir
+
+  def initialize(model, foreign_key, limit:, order_col:, order_dir: :asc)
+    super()
+    @model = model
+    @foreign_key = foreign_key
+    @limit = limit
+    @order_col = order_col
+    @order_dir = order_dir
+  end
+
+  def perform(foreign_ids)
+    # build the sub-query, limiting results by foreign key at this point
+    # we don't want to execute this query but get its SQL to be used later
+    ranked_from =
+      model.select(
+        "*",
+        "row_number() OVER (
+          PARTITION BY #{foreign_key} ORDER BY #{order_col} #{order_dir}
+        ) as rank"
+      ).where(foreign_key => foreign_ids).to_sql
+
+    # use the sub-query from above to query records which have a rank
+    # value less than or equal to our limit
+    records =
+      model.from("(#{ranked_from}) as #{model.table_name}").where(
+        "rank <= #{limit}"
+      ).to_a
+
+    # match records and fulfill promises
+    foreign_ids.each do |foreign_id|
+      matching_records =
+        records.select { |r| foreign_id == r.send(foreign_key) }
+      fulfill(foreign_id, matching_records)
+    end
+  end
+end

data/graphql-batch.gemspec

@@ -1,7 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'graphql/batch/version'
+require_relative 'lib/graphql/batch/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "graphql-batch"
@@ -18,10 +15,12 @@ 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", ">= 1.3", "< 2"
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.add_runtime_dependency "graphql", ">= 1.10", "< 2"
   spec.add_runtime_dependency "promise.rb", "~> 0.7.2"
 
   spec.add_development_dependency "byebug" if RUBY_ENGINE == 'ruby'
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest"
 end

data/lib/graphql/batch/loader.rb

@@ -1,21 +1,20 @@
 module GraphQL::Batch
   class Loader
-    def self.for(*group_args)
-      loader_key = loader_key_for(*group_args)
-      executor = Executor.current
-
-      unless executor
-        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`'
+    # Use new argument forwarding syntax if available as an optimization
+    if RUBY_ENGINE && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7")
+      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        def self.for(...)
+          current_executor.loader(loader_key_for(...)) { new(...) }
+        end
+      RUBY
+    else
+      def self.for(*group_args)
+        current_executor.loader(loader_key_for(*group_args)) { new(*group_args) }
       end
-
-      executor.loader(loader_key) { new(*group_args) }
     end
 
-    def self.loader_key_for(*group_args)
-      [self].concat(group_args)
+    def self.loader_key_for(*group_args, **group_kwargs)
+      [self, group_kwargs, group_args]
     end
 
     def self.load(key)
@@ -26,6 +25,23 @@ module GraphQL::Batch
       self.for.load_many(keys)
     end
 
+    class << self
+      private
+
+      def current_executor
+        executor = Executor.current
+
+        unless executor
+          raise GraphQL::Batch::NoExecutorError, 'Cannot create loader without'\
+            ' an Executor. Wrap the call to `for` with `GraphQL::Batch.batch`'\
+            ' or use `GraphQL::Batch::SetupMultiplex` as a query instrumenter if'\
+            ' using with `graphql-ruby`'
+        end
+
+        executor
+      end
+    end
+
     attr_accessor :loader_key, :executor
 
     def load(key)
@@ -79,7 +95,15 @@ module GraphQL::Batch
 
     # Returns true when the key has already been fulfilled, otherwise returns false
     def fulfilled?(key)
-      promise_for(key).fulfilled?
+      promise = promise_for(key)
+      # When a promise is fulfilled through this class, it will either:
+      #   become fulfilled, if fulfilled with a literal value
+      #   become pending with a new source if fulfilled with a promise
+      # Either of these is acceptable, promise.rb will automatically re-wait
+      # on the new source promise as needed.
+      return true if promise.fulfilled?
+
+      promise.pending? && promise.source != self
     end
 
     # Must override to load the keys and call #fulfill for each key
@@ -124,7 +148,13 @@ module GraphQL::Batch
 
     def check_for_broken_promises(load_keys)
       load_keys.each do |key|
-        next unless promise_for(key).pending?
+        promise = promise_for(key)
+        # When a promise is fulfilled through this class, it will either:
+        #   become not pending, if fulfilled with a literal value
+        #   become pending with a new source if fulfilled with a promise
+        # Either of these is acceptable, promise.rb will automatically re-wait
+        # on the new source promise as needed.
+        next unless promise.pending? && promise.source == self
 
         reject(key, ::Promise::BrokenError.new("#{self.class} didn't fulfill promise for key #{key.inspect}"))
       end

data/lib/graphql/batch/setup_multiplex.rb

@@ -6,15 +6,11 @@ module GraphQL::Batch
     end
 
     def before_multiplex(multiplex)
-      Setup.start_batching(@executor_class)
+      GraphQL::Batch::Executor.start_batch(@executor_class)
     end
 
     def after_multiplex(multiplex)
-      Setup.end_batching
-    end
-
-    def instrument(type, field)
-      Setup.instrument_field(@schema, type, field)
+      GraphQL::Batch::Executor.end_batch
     end
   end
 end

data/lib/graphql/batch/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Batch
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/graphql/batch.rb

@@ -16,26 +16,17 @@ module GraphQL
     end
 
     def self.use(schema_defn, executor_class: GraphQL::Batch::Executor)
-      schema = schema_defn.target
-      if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.9.0.pre3')
+      instrumentation = GraphQL::Batch::SetupMultiplex.new(schema_defn, executor_class: executor_class)
+      schema_defn.instrument(:multiplex, instrumentation)
+
+      if schema_defn.mutation
         require_relative "batch/mutation_field_extension"
-        if schema.mutation
-          schema.mutation.fields.each do |name, f|
-            field = f.metadata[:type_class]
-            field.extension(GraphQL::Batch::MutationFieldExtension)
-          end
+
+        schema_defn.mutation.fields.each do |name, field|
+          field.extension(GraphQL::Batch::MutationFieldExtension)
         end
-        instrumentation = GraphQL::Batch::SetupMultiplex.new(schema, executor_class: executor_class)
-        schema_defn.instrument(:multiplex, instrumentation)
-      elsif 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
   end
@@ -44,5 +35,4 @@ end
 require_relative "batch/version"
 require_relative "batch/loader"
 require_relative "batch/executor"
-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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dylan Thacker-Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -62,16 +62,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -93,8 +93,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -102,20 +104,23 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/active_storage_loader.rb
 - examples/association_loader.rb
+- examples/http_loader.rb
 - examples/record_loader.rb
+- examples/window_key_loader.rb
 - graphql-batch.gemspec
 - lib/graphql/batch.rb
 - lib/graphql/batch/executor.rb
 - lib/graphql/batch/loader.rb
 - lib/graphql/batch/mutation_field_extension.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:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -131,8 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: A query batching executor for the graphql gem

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.6
-env:
-  - TESTING_INTERPRETER=true
-  - TESTING_INTERPRETER=false

data/lib/graphql/batch/setup.rb

@@ -1,45 +0,0 @@
-module GraphQL::Batch
-  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
-    end
-
-    def initialize(schema, executor_class:)
-      @schema = schema
-      @executor_class = executor_class
-    end
-
-    def before_query(query)
-      Setup.start_batching(@executor_class)
-    end
-
-    def after_query(query)
-      Setup.end_batching
-    end
-
-    def instrument(type, field)
-      Setup.instrument_field(@schema, type, field)
-    end
-  end
-end