insights-graphql-preload 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92bc2cc866e8255995fa5ac242ae473834c0109cea9f862ae33d5723e3abc84c
+  data.tar.gz: f654c8c14ef3a8016a976a6f8cbdc25801f75440fc4e95ffe9b58c839d9afae2
+SHA512:
+  metadata.gz: 7fc0795faca6a2583f9b7c186ddc3450e3401c29dab086a7831ac79f90797e34b4508215ad311803a77e8221cccff5fc7541070f143a48453f77263c5431b12b
+  data.tar.gz: b7e2dcb4a99730d080e08835ad51127f3121cc768ee9c4c7d986770b0539c984db1d31d69ce17c8915a38b8eac73812282dfee00b33d5da761f8f5bb76740fef

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+/gemfiles/*.lock

data/.travis.yml

@@ -0,0 +1,41 @@
+---
+language: ruby
+cache: bundler
+before_install: gem install bundler -v '~> 2.0'
+
+jobs:
+  include:
+    - rvm: 2.7.0
+      gemfile: gemfiles/graphql_1.10.gemfile
+      env:
+        - GRAPHQL_RUBY_INTERPRETER=yes
+        - RAILS_VERSION=6.0
+    - rvm: 2.7.0
+      gemfile: gemfiles/graphql_1.10.gemfile
+      env:
+        - GRAPHQL_RUBY_INTERPRETER=no
+        - RAILS_VERSION=6.0
+    - rvm: 2.6.5
+      gemfile: gemfiles/graphql_1.9.gemfile
+      env:
+        - GRAPHQL_RUBY_INTERPRETER=yes
+        - RAILS_VERSION=6.0
+    - rvm: 2.6.5
+      gemfile: gemfiles/graphql_1.9.gemfile
+      env:
+        - GRAPHQL_RUBY_INTERPRETER=no
+        - RAILS_VERSION=6.0
+    - rvm: 2.5.7
+      gemfile: gemfiles/graphql_1.9.gemfile
+      env:
+        - GRAPHQL_RUBY_INTERPRETER=yes
+        - RAILS_VERSION=5.2
+    - rvm: 2.5.7
+      gemfile: gemfiles/graphql_1.9.gemfile
+      env:
+        - GRAPHQL_RUBY_INTERPRETER=no
+        - RAILS_VERSION=5.2
+    - rvm: 2.4.9
+      gemfile: gemfiles/graphql_1.8.gemfile
+      env:
+        - RAILS_VERSION=5.1

data/.yardopts

@@ -0,0 +1,2 @@
+lib/**/*.rb - README.md
+--embed-mixin DSL

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "graphql-1.8" do
+  gem "graphql", "~> 1.8.0"
+end
+
+appraise "graphql-1.9" do
+  gem "graphql", "~> 1.9.0"
+end
+
+appraise "graphql-1.10" do
+  gem "graphql", "~> 1.10.0"
+end

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-preload.gemspec
+gemspec
+
+gem 'activerecord', ENV['RAILS_VERSION'] && "~> #{ENV['RAILS_VERSION']}.0"
+
+# See https://github.com/nepalez/rspec-sqlimit/issues/13
+gem 'rspec-sqlimit', git: 'https://github.com/nepalez/rspec-sqlimit', branch: 'master', ref: '90c85f4143ae584872a6ce1d240d77fa4f3ceb49' # v0.0.3

data/Gemfile.lock

@@ -0,0 +1,192 @@
+GIT
+  remote: https://github.com/nepalez/rspec-sqlimit
+  revision: 90c85f4143ae584872a6ce1d240d77fa4f3ceb49
+  ref: 90c85f4143ae584872a6ce1d240d77fa4f3ceb49
+  branch: master
+  specs:
+    rspec-sqlimit (0.0.3)
+      rails (> 4.2, < 7.0)
+      rspec (~> 3.0)
+
+PATH
+  remote: .
+  specs:
+    graphql-preload (2.1.0)
+      activerecord (>= 4.1, < 7)
+      graphql (>= 1.8, < 2)
+      graphql-batch (~> 0.3)
+      promise.rb (~> 0.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activestorage (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.4)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    graphql (1.10.5)
+    graphql-batch (0.4.2)
+      graphql (>= 1.3, < 2)
+      promise.rb (~> 0.7.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    promise.rb (0.7.4)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.2)
+      actioncable (= 6.0.2.2)
+      actionmailbox (= 6.0.2.2)
+      actionmailer (= 6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actiontext (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    yard (0.9.24)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  appraisal
+  bundler (~> 2.0)
+  graphql-preload!
+  pry (~> 0.10)
+  rake (~> 13.0)
+  rspec (~> 3.8)
+  rspec-sqlimit!
+  sqlite3
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Grand Rounds
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# GraphQL::Preload
+
+[![Gem Version](https://badge.fury.io/rb/graphql-preload.svg)](https://rubygems.org/gems/graphql-preload)
+
+Provides a DSL for the [`graphql` gem](https://github.com/rmosolgo/graphql-ruby) that allows ActiveRecord associations to be preloaded in field definitions. Based on a [gist](https://gist.github.com/theorygeek/a1a59a2bf9c59e4b3706ac68d12c8434) by @theorygeek.
+
+This fork works with Ruby on Rails 6.0 and GraphQL-Ruby 1.10 (but not in interpreter mode yet).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-preload'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-preload
+
+## Usage
+
+First, enable preloading in your `GraphQL::Schema`:
+
+```ruby
+class PreloadSchema < GraphQL::Schema
+  use GraphQL::Batch
+
+  enable_preloading
+
+  query QueryType
+end
+```
+
+Call `preload` when defining your field:
+
+```ruby
+class PostType < GraphQL::Schema::Object
+  # This runs Post.includes(:comments) but only if comments are requested
+  field :comments,  [CommentType], null: false, preload: :comments
+
+  # Block syntax is supported too
+  field :comments,  [CommentType], null: false
+    preload :comments
+
+    # Post.includes(:comments, :authors)
+    preload [:comments, :authors]
+
+    # Post.includes(:comments, authors: [:followers, :posts])
+    preload [:comments, { authors: [:followers, :posts] }]
+  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:
+
+```ruby
+class UserType < GraphQL::Schema::Object
+  field :posts, [PostType], null: false,
+                            preload: :posts,
+                            preload_scope: ->(*) { Post.order(rating: :desc) }
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ConsultingMD/graphql-preload.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'graphql/preload'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/graphql_1.10.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec-sqlimit", git: "https://github.com/nepalez/rspec-sqlimit", branch: "master", ref: "90c85f4143ae584872a6ce1d240d77fa4f3ceb49"
+gem "graphql", "~> 1.10.0"
+
+gemspec path: "../"

data/gemfiles/graphql_1.8.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec-sqlimit", git: "https://github.com/nepalez/rspec-sqlimit", branch: "master", ref: "90c85f4143ae584872a6ce1d240d77fa4f3ceb49"
+gem "graphql", "~> 1.8.0"
+
+gemspec path: "../"

data/gemfiles/graphql_1.9.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec-sqlimit", git: "https://github.com/nepalez/rspec-sqlimit", branch: "master", ref: "90c85f4143ae584872a6ce1d240d77fa4f3ceb49"
+gem "graphql", "~> 1.9.0"
+
+gemspec path: "../"

data/graphql-preload.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/preload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'insights-graphql-preload'
+  spec.version       = GraphQL::Preload::VERSION
+  spec.authors       = ['Ryan Foster, Etienne Tripier']
+  spec.email         = ['etienne.tripier@grandrounds.com']
+
+  spec.summary       = 'Preload ActiveRecord associations with graphql-batch'
+  spec.homepage      = 'https://github.com/ConsultingMD/graphql-preload'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.1', '< 7'
+  spec.add_runtime_dependency 'graphql', '>= 1.8', '< 2'
+  spec.add_runtime_dependency 'graphql-batch', '~> 0.3'
+  spec.add_runtime_dependency 'promise.rb', '~> 0.7'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rspec-sqlimit'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency "appraisal"
+end

data/lib/graphql/preload.rb

@@ -0,0 +1,59 @@
+require 'graphql'
+require 'graphql/batch'
+require 'promise.rb'
+
+GraphQL::Field.accepts_definitions(
+  preload: ->(type, *args) do
+    type.metadata[:preload] ||= []
+    type.metadata[:preload].concat(args)
+  end,
+  preload_scope: ->(type, arg) { type.metadata[:preload_scope] = arg }
+)
+
+GraphQL::Schema.accepts_definitions(
+  enable_preloading: ->(schema) do
+    schema.instrument(:field, GraphQL::Preload::Instrument.new)
+  end
+)
+
+module GraphQL
+  # Provides a GraphQL::Field definition to preload ActiveRecord::Associations
+  module Preload
+    autoload :Instrument, 'graphql/preload/instrument'
+    autoload :Loader, 'graphql/preload/loader'
+    autoload :VERSION, 'graphql/preload/version'
+
+    module SchemaMethods
+      def enable_preloading
+        instrument(:field, GraphQL::Preload::Instrument.new)
+      end
+    end
+
+    module FieldMetadata
+      def initialize(*args, preload: nil, preload_scope: nil, **kwargs, &block)
+        super(*args, **kwargs, &block)
+        self.preload(preload) if preload
+        self.preload_scope(preload_scope) if preload_scope
+      end
+
+      def preload(associations)
+        @preload ||= []
+        @preload.concat Array.wrap associations
+      end
+
+      def preload_scope(scope_proc)
+        @preload_scope = scope_proc
+      end
+
+      def to_graphql
+        field_defn = super
+        field_defn.metadata[:preload] = @preload
+        field_defn.metadata[:preload_scope] = @preload_scope
+        field_defn
+      end
+    end
+  end
+
+  Schema.extend Preload::SchemaMethods
+  Schema::Field.prepend Preload::FieldMetadata
+end

data/lib/graphql/preload/instrument.rb

@@ -0,0 +1,98 @@
+module GraphQL
+  module Preload
+    # Provides an instrument for the GraphQL::Field :preload definition
+    class Instrument
+      def instrument(_type, field)
+        metadata = merged_metadata(field)
+        return field if metadata.fetch(:preload, nil).nil?
+
+        old_resolver = field.resolve_proc
+        new_resolver = ->(obj, args, ctx) do
+          return old_resolver.call(obj, args, ctx) unless obj
+
+          if metadata[:preload_scope]
+            scope = metadata[:preload_scope].call(args, ctx)
+          end
+
+          is_graphql_object = obj.is_a?(GraphQL::Schema::Object)
+          respond_to_object = obj.respond_to?(:object)
+          record = is_graphql_object && respond_to_object ? obj.object : obj
+
+          preload(record, metadata[:preload], scope).then do
+            old_resolver.call(obj, args, ctx)
+          end
+        end
+
+        field.redefine do
+          resolve(new_resolver)
+        end
+      end
+
+      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, scope)
+          when Array
+            association.each do |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, scope).then do
+                associated_records = record.public_send(sub_association)
+
+                case associated_records
+                when ActiveRecord::Base
+                  preload(associated_records, nested_association, scope)
+                else
+                  Promise.all(
+                    Array.wrap(associated_records).map do |associated_record|
+                      preload(associated_record, nested_association, scope)
+                    end
+                  )
+                end
+              end
+            end
+          end
+        end
+
+        Promise.all(promises)
+      end
+
+      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
+
+      private def merged_metadata(field)
+        type_class = field.metadata.fetch(:type_class, nil)
+
+        if type_class.nil? || !type_class.respond_to?(:to_graphql)
+          field.metadata
+        else
+          field.metadata.merge(type_class.to_graphql.metadata)
+        end
+      end
+
+    end
+  end
+end

data/lib/graphql/preload/loader.rb

@@ -0,0 +1,76 @@
+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, _scope_sql)
+        @association = association
+        @model = model
+
+        validate_association
+      end
+
+      def load(record)
+        unless record.is_a?(model)
+          raise TypeError, "Loader for #{model} can't load associations for #{record.class} objects"
+        end
+
+        return Promise.resolve(record) if association_loaded?(record)
+        super
+      end
+
+      def perform(records)
+        preload_association(records)
+        records.each { |record| fulfill(record, record) }
+      end
+
+      private def association_loaded?(record)
+        record.association(association).loaded?
+      end
+
+      private def preload_association(records)
+        preloader = ActiveRecord::Associations::Preloader.new.preload(records, association, preload_scope).first
+        return unless preload_scope
+        return if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("6.0.0")
+
+        if preloader.is_a?(::ActiveRecord::Associations::Preloader::AlreadyLoaded)
+          raise ArgumentError,
+              "Preloading association twice with scopes is not possible. " \
+              "To resolve this problem add a scoped association (e.g., `has_many :records, -> { scope_name }, ...`) to the model"
+        end
+
+        # this commit changes the way preloader works with scopes
+        # https://github.com/rails/rails/commit/2847653869ffc1ff5139c46e520c72e26618c199#diff-3bba5f66eb1ed62bd5700872fcd6c632
+        preloader.send(:owners).each do |owner|
+          preloader.send(:associate_records_to_owner, owner, preloader.records_by_owner[owner] || [])
+        end
+      end
+
+      private def preload_scope
+        return nil unless scope
+        reflection = model.reflect_on_association(association)
+        raise ArgumentError, 'Cannot specify preload_scope for polymorphic associations' if reflection.polymorphic?
+        scope if scope.try(:klass) == reflection.klass
+      end
+
+      private def validate_association
+        unless association.is_a?(Symbol)
+          raise ArgumentError, 'Association must be a Symbol object'
+        end
+
+        unless model < ActiveRecord::Base
+          raise ArgumentError, 'Model must be an ActiveRecord::Base descendant'
+        end
+
+        return if model.reflect_on_association(association)
+        raise TypeError, "Association :#{association} does not exist on #{model}"
+      end
+    end
+  end
+end

data/lib/graphql/preload/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module Preload
+    VERSION = '2.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: insights-graphql-preload
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+platform: ruby
+authors:
+- Ryan Foster, Etienne Tripier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: promise.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-sqlimit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- etienne.tripier@grandrounds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/.bundle/config
+- gemfiles/graphql_1.10.gemfile
+- gemfiles/graphql_1.8.gemfile
+- gemfiles/graphql_1.9.gemfile
+- graphql-preload.gemspec
+- lib/graphql/preload.rb
+- lib/graphql/preload/instrument.rb
+- lib/graphql/preload/loader.rb
+- lib/graphql/preload/version.rb
+homepage: https://github.com/ConsultingMD/graphql-preload
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Preload ActiveRecord associations with graphql-batch
+test_files: []