graphql-active_record_batcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 987cfab30dfdc3481d7feff6ffe29273ed8de21c
+  data.tar.gz: 067a21a5f99cb3f68e6b1084a685e8839a82e442
+SHA512:
+  metadata.gz: 3f68ca34876e1ef67ce416b428fafb11b648388b68e5c36d4f017163ebe5cd82482822014accc07bd77a981e6c873975b7b20e8c6a8f7560b55b85e3007b16f7
+  data.tar.gz: b536f7dc3d2ccb195ebc70e66fcf4326185236acebcf057c2dfcef4770a464c7fa66b9ffe7d54b1ec7549f62125141f4c5a0007ce9139133ab55f4b5211e8b58

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mgiroux0@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-activerecord-preload.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,108 @@
+# Graphql::ActiveRecordBatcher
+
+`GraphQL::ActiveRecordBatcher` is a toolkit to batch record loading as well as preload
+ActiveRecord association durings GraphQL Execution.
+
+It is meant to be used with the `graphql` gem and uses `graphql-batch` under the hood to
+preload and batch calls to your database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-active_record_batcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-active_record_batcher
+
+## Usage
+
+### Preloading Associations
+
+Using GraphQL without preloading associations results in under performant API and
+too many queries to the database. Take for example a Movie type which has a `characters` associations, and this GraphQL query:
+
+```graphql
+query {
+  movie(id: "1") {
+    characters {
+      name
+    }
+  }
+  movie(id: "2") {
+    characters {
+      name
+    }
+  }
+}
+```
+
+This query would result in 4 calls to your database:
+
+```sql
+1: SELECT  "movies".* FROM "movies" WHERE "movies"."id" = ? LIMIT ?  [["id", 1]
+2: SELECT  "movies".* FROM "movies" WHERE "movies"."id" = ? LIMIT ?  [["id", 2]
+3: SELECT  "characters".* FROM "characters" WHERE "characters"."movie_id" = ? [["movie_id", 1]
+4: SELECT  "characters".* FROM "characters" WHERE "characters"."movie_id" = ? [["movie_id", 2]
+```
+
+`GraphQL::ActiveRecordBatcher` lets you preload associations by using the `preload` definition during field definition:
+
+```ruby
+StarWarsMovie = GraphQL::ObjectType.define do
+  name "StarWarsMovie"
+  description "A StarWars Movie"
+
+  # Define which active record model represents
+  # the parent object
+  model Movie
+
+  field :characters, !types[!Dog] do
+    preloads(:characters)
+    resolve ->(movie, _, _) { movie.characters }
+  end
+end
+```
+
+Associations will now be preloaded and only 3 queries are used this time:
+
+```sql
+1: SELECT  "movies".* FROM "movies" WHERE "movies"."id" = ? LIMIT ?  [["id", 1]
+2: SELECT  "movies".* FROM "movies" WHERE "movies"."id" = ? LIMIT ?  [["id", 2]
+3: SELECT   "characters".* FROM "characters" WHERE "characters"."movie_d" IN (1, 2)
+```
+
+### Schema config
+
+```ruby
+Schema = GraphQL::Schema.define do
+  query Query
+  mutation Mutation
+
+  # GraphQL Batch setup. Handle Promise objects.
+  lazy_resolve(Promise, :sync)
+  instrument(:query, GraphQL::Batch::Setup)
+
+  # FieldInstrumenter takes care of preloading assocations you've
+  # marked using the `preloads` attribute
+  instrument(:field, GraphQL::ActiveRecordBatcher::FieldInstrumenter.new)
+end
+```
+
+### TODO
+
+  - [ ] Expose a way to batch finds
+  - [ ] Expose a way or documentation on how to batch the `node` field
+  - [ ] Accept an array of preloads
+  - [ ] Accept nested preloads
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/active_record_batcher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.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/graphql-active_record_batcher.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/active_record_batcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-active_record_batcher"
+  spec.version       = GraphQL::ActiveRecordBatcher::VERSION
+  spec.authors       = ["Marc-Andre Giroux"]
+  spec.email         = ["mgiroux0@gmail.com"]
+
+  spec.summary       = %q{Association Preloading and Query Batching for GraphQL}
+  spec.description   = %q{Association Preloading and Query Batching for GraphQL}
+  spec.homepage      = "http://mgiroux.me"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.10.1"
+  spec.add_development_dependency "minitest-focus", "~> 1.1"
+  spec.add_development_dependency "minitest-reporters", "~>1.0"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
+
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "graphql"
+  spec.add_runtime_dependency "graphql-batch"
+  spec.add_runtime_dependency "promise.rb"
+end

data/lib/graphql/active_record_batcher.rb

@@ -0,0 +1,11 @@
+require 'graphql/active_record_batcher/version'
+require 'graphql/active_record_batcher/field_instrumenter'
+require 'graphql/active_record_batcher/association_loader'
+
+module GraphQL
+  module ActiveRecordBatcher
+  end
+end
+
+GraphQL::Field.accepts_definitions(preloads: GraphQL::Define.assign_metadata_key(:preloads))
+GraphQL::ObjectType.accepts_definitions(model: GraphQL::Define.assign_metadata_key(:model))

data/lib/graphql/active_record_batcher/association_loader.rb

@@ -0,0 +1,41 @@
+require 'promise.rb'
+require 'graphql/batch'
+
+module GraphQL
+  module ActiveRecordBatcher
+    class AssociationLoader < GraphQL::Batch::Loader
+      def initialize(model, association)
+        @model = model
+        @association = association
+      end
+
+      def load(record)
+        raise TypeError, "#{@model} loader can't load association for #{record.class}" unless record.is_a?(@model)
+        return Promise.resolve(read_association(record)) if association_loaded?(record)
+        super
+      end
+
+      # We want to load the associations on all records, even if they have the same id
+      def cache_key(record)
+        record.object_id
+      end
+
+      def perform(records)
+        ::ActiveRecord::Associations::Preloader.new.preload(records, association)
+
+        records.each do |record|
+          association_result = record.public_send(association)
+          fulfill(record, association_result)
+        end
+      end
+
+      private
+
+      attr_reader :model, :association
+
+      def association_loaded?(record)
+      record.association(@association).loaded?
+      end
+    end
+  end
+end

data/lib/graphql/active_record_batcher/field_instrumenter.rb

@@ -0,0 +1,46 @@
+module GraphQL
+  module ActiveRecordBatcher
+    class FieldInstrumenter
+      def instrument(type, field)
+        association_to_preload = field.metadata[:preloads]
+
+        if association_to_preload
+          # Model is needed to preload an association
+          unless model = type.metadata[:model]
+            message = "No ActiveRecord Model set on type #{type.name}'s metadata."\
+              " Use `model(YourActiveRecordModel)` inside the type's definition"
+            raise StandardError, message
+          end
+
+          # Make sure the association exists on the model
+          validate_preload(model, association_to_preload)
+
+          loader = GraphQL::ActiveRecordBatcher::AssociationLoader.new(
+            model,
+            association_to_preload
+          )
+
+          # "Wrap" the resolve proc with our own, which returns a promise
+          old_resolve_proc = field.resolve_proc
+          new_resolve_proc = ->(obj, args, ctx) do
+            loader.load(obj).then { old_resolve_proc.call(obj, args, ctx) }
+          end
+
+          field.redefine do
+            resolve(new_resolve_proc)
+          end
+        else
+          field
+        end
+      end
+
+      private
+
+      def validate_preload(model, association_to_preload)
+        unless model.reflect_on_association(association_to_preload)
+          raise ArgumentError, "No association `#{association_to_preload}` on model `#{model}`"
+        end
+      end
+    end
+  end
+end

data/lib/graphql/active_record_batcher/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module ActiveRecordBatcher
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: graphql-active_record_batcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc-Andre Giroux
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: byebug
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: promise.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Association Preloading and Query Batching for GraphQL
+email:
+- mgiroux0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- _test_.db
+- bin/console
+- bin/setup
+- graphql-active_record_batcher.gemspec
+- lib/graphql/active_record_batcher.rb
+- lib/graphql/active_record_batcher/association_loader.rb
+- lib/graphql/active_record_batcher/field_instrumenter.rb
+- lib/graphql/active_record_batcher/version.rb
+homepage: http://mgiroux.me
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Association Preloading and Query Batching for GraphQL
+test_files: []