graphql-batch 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cadb2aa4640e2a2a7315b4a201ac2cee587d6696d49a6afe217850c710049b23
-  data.tar.gz: 22e8303ce284034b08d3c89af261c9ca82b9f9d18f4e6d2b768ff2448e544f75
+  metadata.gz: d554444b8de82eddc177ef4461270ed6b34c24e7d48f505c9b568115b913ec18
+  data.tar.gz: e46587c28fdf154c6747b658d6ec534d2bc8d036bcef02a5fa11e52b0dc0cb9d
 SHA512:
-  metadata.gz: 7c17ca80df3d0433a290ebbab09dfcac5800a2eaebed9f89d5e44fb1aee098a7d5af44607e8e6a53970e457b8734ce52a176335c542a93e4f6a80e9ddbc9a2ff
-  data.tar.gz: 262b06ce514d5028334fbf2557b7810137526d9f7dacae5e53acd2e0602dec19c6385b7f7c9f7574f2905c46d5f10df53b81b2e7c82c078642de40225eb47f3f
+  metadata.gz: 58d680e45da55224d58709d78ae187623d096dfc695b1ea8e00116590fafcd4f16b3f84ef78a337fbde0ca449c02822d87da6ce0274818cc8df336dbe016ee27
+  data.tar.gz: 3b609c6ad409cc48deeb71d2d0d487f1fd10063f54aae181dbec7da5825deab825900fa6764634aceae2663ee05ac0a8bfdec8148a970a0d677b0f9f5bf8455d

data/.github/workflows/ci.yml

@@ -10,8 +10,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.4, 2.7, '3.1']
-        graphql_version: ['~> 1.10.0', '~> 1.13', '~> 2.0']
+        ruby: [2.7, 3.1, 3.3]
+        graphql_version: ['~> 1.12.18', '~> 1.13', '~> 2.0']
+        include:
+          - ruby: 2.4
+            graphql_version: '~> 1.12.18'
+          - ruby: 2.4
+            graphql_version: '~> 1.13'
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      )
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/README.md

@@ -122,9 +122,7 @@ def all_collections
   Promise.all([
     CountLoader.for(Shop, :smart_collections).load(context.shop_id),
     CountLoader.for(Shop, :custom_collections).load(context.shop_id),
-  ]).then do |results|
-    results.reduce(&:+)
-  end
+  ]).then(&:sum)
 end
 ```
 

data/examples/active_storage_loader.rb

@@ -14,7 +14,7 @@
 # end
 
 ####
-# An example data type using the AttachmentLoader
+# An example data type using the Loaders::ActiveStorageLoader
 ####
 
 # class Types::EventType < Types::BaseObject
@@ -25,7 +25,7 @@
 #   field :pictures, String, null: true
 #
 #   def image
-#     AttachmentLoader.for(:Event, :image).load(object.id).then do |image|
+#     Loaders::ActiveStorageLoader.for(:Event, :image).load(object.id).then do |image|
 #       Rails.application.routes.url_helpers.url_for(
 #         image.variant({ quality: 75 })
 #       )
@@ -33,7 +33,7 @@
 #   end
 #
 #   def pictures
-#     AttachmentLoader.for(:Event, :pictures, association_type: :has_many_attached).load(object.id).then do |pictures|
+#     Loaders::ActiveStorageLoader.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 })

data/examples/http_loader.rb

@@ -35,6 +35,7 @@
 #     }
 #   GQL
 
+# An example loader which is blocking and synchronous as a whole, but executes all of its operations concurrently.
 module Loaders
   class HTTPLoader < GraphQL::Batch::Loader
     def initialize(host:, size: 4, timeout: 4)
@@ -45,13 +46,19 @@ module Loaders
     end
 
     def perform(operations)
+      # This fans out and starts off all the concurrent work, which starts and
+      # immediately returns Concurrent::Promises::Future` objects for each operation.
       futures = operations.map do |operation|
         Concurrent::Promises.future do
           pool.with { |connection| operation.call(connection) }
         end
       end
+      # At this point, all of the concurrent work has been started.
+
+      # This converges back in, waiting on each concurrent future to finish, and fulfilling each
+      # (non-concurrent) Promise.rb promise.
       operations.each_with_index.each do |operation, index|
-        fulfill(operation, futures[index].value)
+        fulfill(operation, futures[index].value) # .value is a blocking call
       end
     end
 

data/graphql-batch.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = "https://rubygems.org"
 
-  spec.add_runtime_dependency "graphql", ">= 1.10", "< 3"
+  spec.add_runtime_dependency "graphql", ">= 1.12.18", "< 3"
   spec.add_runtime_dependency "promise.rb", "~> 0.7.2"
 
   spec.add_development_dependency "byebug" if RUBY_ENGINE == 'ruby'

data/lib/graphql/batch/loader.rb

@@ -66,12 +66,21 @@ module GraphQL::Batch
       return if resolved?
       load_keys = queue
       @queue = nil
-      perform(load_keys)
+
+      around_perform do
+        perform(load_keys)
+      end
+
       check_for_broken_promises(load_keys)
     rescue => err
       reject_pending_promises(load_keys, err)
     end
 
+    # Interface to add custom code for purposes such as instrumenting the performance of the loader.
+    def around_perform
+      yield
+    end
+
     # For Promise#sync
     def wait #:nodoc:
       if executor

data/lib/graphql/batch/setup_multiplex.rb

@@ -12,5 +12,19 @@ module GraphQL::Batch
     def after_multiplex(multiplex)
       GraphQL::Batch::Executor.end_batch
     end
+
+    module Trace
+      def initialize(executor_class:, **_rest)
+        @executor_class = executor_class
+        super
+      end
+
+      def execute_multiplex(multiplex:)
+        GraphQL::Batch::Executor.start_batch(@executor_class)
+        super
+      ensure
+        GraphQL::Batch::Executor.end_batch
+      end
+    end
   end
 end

data/lib/graphql/batch/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Batch
-    VERSION = "0.5.2"
+    VERSION = "0.5.4"
   end
 end

data/lib/graphql/batch.rb

@@ -16,8 +16,12 @@ module GraphQL
     end
 
     def self.use(schema_defn, executor_class: GraphQL::Batch::Executor)
-      instrumentation = GraphQL::Batch::SetupMultiplex.new(schema_defn, executor_class: executor_class)
-      schema_defn.instrument(:multiplex, instrumentation)
+      if schema_defn.respond_to?(:trace_with)
+        schema_defn.trace_with(GraphQL::Batch::SetupMultiplex::Trace, executor_class: executor_class)
+      else
+        instrumentation = GraphQL::Batch::SetupMultiplex.new(schema_defn, executor_class: executor_class)
+        schema_defn.instrument(:multiplex, instrumentation)
+      end
 
       if schema_defn.mutation
         require_relative "batch/mutation_field_extension"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-batch
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Dylan Thacker-Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.12.18
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.12.18
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -94,6 +94,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -136,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.5
 signing_key: 
 specification_version: 4
 summary: A query batching executor for the graphql gem