graphql-preload 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b779bc0472181687609ba597178bd337c1653dfc
-  data.tar.gz: cdb4a938912f4337650e9f9f710083f8f2fe33f1
+  metadata.gz: c9cba006dfca0e52d2cbd40c5364594f358a3ac6
+  data.tar.gz: 3086dde1fc427ba144b721b9ae0d10cdca6f0f2d
 SHA512:
-  metadata.gz: 21b41bf9c3c001560f37598d0040a2651812fd298cd692108dacb35750992cab9d5172ae7f84164225c5621ffdd1c50d5e06a5ad192e1c295ce723747581d663
-  data.tar.gz: d9f543bf8f0a4d30024da23e4baf620c546fcd3db253b9076b98da793c8a232b4281c473805d608c6b152c115cec2e1f740fda54594812d56ada7316ef27d759
+  metadata.gz: d1490ee109e5d08f0bd5c8a5d84ba29981487a0a7950942fbab89936272dbe73180e135406b748c297991381ea867fea8b5a5a2ac2d684e3ab29d8945562bc94
+  data.tar.gz: 7de182aa0dba1117bbfb15482e7a218407f4022bdc62d8336f1133cac9c2149d424be4fa43f35e23dcc4ccab28692a154ce4e0f6ff8c5e73ccdf3cffbc862122

data/README.md

@@ -49,6 +49,27 @@ Call `preload` when defining your field:
       end
     end
 
+### `preload_scope`
+Starting with Rails 4.1, you can scope your preloaded records by passing a valid scope to [`ActiveRecord::Associations::Preloader`](https://apidock.com/rails/v4.1.8/ActiveRecord/Associations/Preloader/preload). Scoping can improve performance by reducing the number of models to be instantiated and can help with certain business goals (e.g., only returning records that have not been soft deleted).
+
+This functionality is surfaced through the `preload_scope` option:
+
+    PostType = GraphQL::ObjectType.define do
+      name 'Post'
+
+      field :comments, !types[!CommentType] do
+        preload :comments
+        preload_scope ->(args, ctx) { Comment.where(deleted_at: nil) }
+
+        # Resolves with records returned from the following query:
+        # SELECT "comments".*
+        # FROM "comments"
+        # WHERE "comments"."deleted_at" IS NULL
+        #   AND "comments"."post_id" IN (1, 2, 3)
+        resolve ->(obj, args, ctx) { obj.comments }
+      end
+    end
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/graphql-preload.gemspec

@@ -21,12 +21,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 'activerecord', '>= 3.2', '< 6'
+  spec.add_runtime_dependency 'activerecord', '>= 4.1', '< 6'
   spec.add_runtime_dependency 'graphql', '>= 1.5', '< 2'
   spec.add_runtime_dependency 'graphql-batch', '~> 0.3'
   spec.add_runtime_dependency 'promise.rb', '~> 0.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/graphql/preload.rb

@@ -6,7 +6,8 @@ GraphQL::Field.accepts_definitions(
   preload: ->(type, *args) do
     type.metadata[:preload] ||= []
     type.metadata[:preload].concat(args)
-  end
+  end,
+  preload_scope: ->(type, arg) { type.metadata[:preload_scope] = arg }
 )
 
 GraphQL::Schema.accepts_definitions(

data/lib/graphql/preload/instrument.rb

@@ -9,7 +9,11 @@ module GraphQL
         new_resolver = ->(obj, args, ctx) do
           return old_resolver.call(obj, args, ctx) unless obj
 
-          preload(obj, field.metadata[:preload]).then do
+          if field.metadata[:preload_scope]
+            scope = field.metadata[:preload_scope].call(args, ctx)
+          end
+
+          preload(obj, field.metadata[:preload], scope).then do
             old_resolver.call(obj, args, ctx)
           end
         end
@@ -19,32 +23,35 @@ module GraphQL
         end
       end
 
-      private def preload(record, associations)
-        raise TypeError, "Expected #{associations} to be a Symbol, not a String" if associations.is_a?(String)
-        return preload_single_association(record, associations) if associations.is_a?(Symbol)
+      private def preload(record, associations, scope)
+        if associations.is_a?(String)
+          raise TypeError, "Expected #{associations} to be a Symbol, not a String"
+        elsif associations.is_a?(Symbol)
+          return preload_single_association(record, associations, scope)
+        end
 
         promises = []
 
         Array.wrap(associations).each do |association|
           case association
           when Symbol
-            promises << preload_single_association(record, association)
+            promises << preload_single_association(record, association, scope)
           when Array
             association.each do |sub_association|
-              promises << preload(record, sub_association)
+              promises << preload(record, sub_association, scope)
             end
           when Hash
             association.each do |sub_association, nested_association|
-              promises << preload_single_association(record, sub_association).then do
+              promises << preload_single_association(record, sub_association, scope).then do
                 associated_records = record.public_send(sub_association)
 
                 case associated_records
                 when ActiveRecord::Base
-                  preload(associated_records, nested_association)
+                  preload(associated_records, nested_association, scope)
                 else
                   Promise.all(
                     Array.wrap(associated_records).map do |associated_record|
-                      preload(associated_record, nested_association)
+                      preload(associated_record, nested_association, scope)
                     end
                   )
                 end
@@ -56,8 +63,19 @@ module GraphQL
         Promise.all(promises)
       end
 
-      private def preload_single_association(record, association)
-        GraphQL::Preload::Loader.for(record.class, association).load(record)
+      private def preload_single_association(record, association, scope)
+        # We would like to pass the `scope` (which is an `ActiveRecord::Relation`),
+        # directly into `Loader.for`. However, because the scope is
+        # created for each parent record, they are different objects and
+        # return different loaders, breaking batching.
+        # Therefore, we pass in `scope.to_sql`, which is the same for all the
+        # scopes and set the `scope` using an accessor. The actual scope
+        # object used will be the last one, which shouldn't make any difference,
+        # because even though they are different objects, they are all
+        # functionally equivalent.
+        loader = GraphQL::Preload::Loader.for(record.class, association, scope.try(:to_sql))
+        loader.scope = scope
+        loader.load(record)
       end
     end
   end

data/lib/graphql/preload/loader.rb

@@ -2,13 +2,14 @@ module GraphQL
   module Preload
     # Preloads ActiveRecord::Associations when called from the Preload::Instrument
     class Loader < GraphQL::Batch::Loader
+      attr_accessor :scope
       attr_reader :association, :model
 
       def cache_key(record)
         record.object_id
       end
 
-      def initialize(model, association)
+      def initialize(model, association, _scope_sql)
         @association = association
         @model = model
 
@@ -34,12 +35,11 @@ module GraphQL
       end
 
       private def preload_association(records)
-        if ((ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 1) ||
-            ActiveRecord::VERSION::MAJOR > 4)
-          ActiveRecord::Associations::Preloader.new.preload(records, association)
-        else
-          ActiveRecord::Associations::Preloader.new(records, association).run
-        end
+        ActiveRecord::Associations::Preloader.new.preload(records, association, preload_scope)
+      end
+
+      private def preload_scope
+        scope if scope.try(:klass) == model.reflect_on_association(association).klass
       end
 
       private def validate_association

data/lib/graphql/preload/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Preload
-    VERSION = '1.0.4'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-preload
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Ryan Foster, Etienne Tripier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2018-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement