graphql_preloader 1.1.0

checksums.yaml

@@ -0,0 +1,17 @@
+---
+!binary "U0hBMjU2":
+  metadata.gz: !binary |-
+    ZjhkMTBhYWMxM2FhNWE5YTA3ZDk3MDQxNjg4OTZlOWY3YTVjNjM2NTZlYmI3
+    MWMxOTdkN2RkZjQyODg5ZmQ1Yw==
+  data.tar.gz: !binary |-
+    YWRhOWNmNzg0Y2JiNWM0YzU3ZGI1ZGQxNDM5MWU2NzU3OWUyNTU5NjZhYWFj
+    NjQ2NGUxMzA1MTJhMzE2NjcxZQ==
+SHA512:
+  metadata.gz: !binary |-
+    ODgyZWIwMTJkNGY5NDFkMWRlNjdjMzlmY2RjNmU4ZjA2NTgxMGE5MTMwOGFj
+    ZGM4Y2FjNWQ0MTM0NWE4MWFjYTg1Y2YzNGUwYzI0MTZlYTM2MjllYjA4OWEx
+    YTNmMzlhN2QzYTc0ZGZjMmZiZjQ0YjY5YjA5M2QyZTk2MDE3MGQ=
+  data.tar.gz: !binary |-
+    OGRlYTRhZjRlNjc2ZjRmNjQxOGI5MGM4ZmYzZTQwMjk0MjYyNTdmZjAwYmRk
+    ZGZlYmI2YWVkZWU2NDc0NDU3NTRlZTZlZDY1MGJkMGJkNDU3MTM2MGVhNjE2
+    YzM1YzY5OTE4NjRmY2QyNmQ3MzIyZTdiMjg2MDEzOGJlOGRlMzI=

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "4"

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://gems.ruby-china.com"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+gemspec
+gem 'graphql', '>= 1.8.11' 
+

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: https://gems.ruby-china.com/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.1.5)
+    graphql (1.9.4)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2.1)
+  graphql (>= 1.8.11)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,93 @@
+## What's this gem do
+
+preload ActiveRecord Associations when using graphql and ActiveRecord
+
+## Install
+
+`gem 'graphql_preloader'`
+
+## Scene
+
+Your original code of resolver might look like this: 
+
+```ruby
+class Resolvers::ProfileResolver < GraphQL::Function
+  description 'User profile'
+
+  type Types::ProfileType
+
+  def _call(_, args, ctx)
+    ctx[:current_user]
+  end
+end
+```
+
+If the query like this:
+```
+query{
+  profile{
+    id
+    works{
+      comments{
+        replyUser{
+          name
+        }
+        content
+      }
+      name
+      id
+      likes{
+        owner{
+          name
+          works{
+            name
+            likes{
+              owner{
+                name
+              }
+            }
+          }
+        }
+      }
+    }
+    name
+  }
+}
+```
+
+It will cause Multi-level nested N + 1 problem.
+
+And you want to resolve it, you can write like this:
+
+```ruby
+class Resolvers::ProfileResolver < GraphQL::Function
+  description 'User profile'
+
+  type Types::ProfileType
+
+  def _call(_, args, ctx)
+    User.includes([works: [comments: :reply_user, likes: [owner: [works: [likes: :owner]]]]]).find(ctx[:current_user].id)
+  end
+end
+```
+
+You will manually resolve N + 1 problem in every resolver.Worse, even if only one field is used, you need to request all the tables included.
+
+## Usage
+
+Your Resolver inherits from `PreloadFunction` instead of `GraphQL::Function`.
+Defining `_call` method instead of `call`
+Using `included_model(your_model_name)` instead of your original includes statement.
+
+
+```ruby
+class Resolvers::ProfileResolver < PreloadFunction
+  description 'User profile'
+
+  type Types::ProfileType
+
+  def _call(_, args, ctx)
+    included_model(User).find(ctx[:current_user].id)
+  end
+end
+```

data/lib/graphql_preloader.rb

@@ -0,0 +1 @@
+require 'preload_function'

data/lib/preload_function.rb

@@ -0,0 +1,44 @@
+require 'graphql'
+class PreloadFunction < GraphQL::Function
+  def call obj, args, ctx
+    @ctx = ctx
+    @json_tree = {}
+    @result_tree = {}
+    _call obj, args, ctx
+  end
+
+  def included_model model_class
+    @root_model_class = model_class
+    recursion query_tree
+    gen_accociations_tree model_class
+    model_class.includes @result_tree
+  end
+
+  def query_tree
+    @ctx.query.document.children.first.selections.first
+  end
+
+  def recursion node, tree = @json_tree
+    node_key = node.name.underscore.to_sym
+    tree[node_key] = {}
+    node.selections.each do |n|
+      recursion n, tree[node_key]
+    end
+  end
+
+  def json_tree_without_root
+    @json_tree.values.first
+  end
+
+  def gen_accociations_tree model_class = @root_model_class, tree = json_tree_without_root, result_tree = @result_tree
+    tree.each do |k, v|
+      if v.present? && model_class.reflect_on_all_associations.map(&:name).include?(k)
+        result_tree[k.to_sym] = {}
+        next if model_class.reflections[k.to_s].options[:polymorphic]
+        _model_class = model_class.reflections[k.to_s].class_name.constantize
+        gen_accociations_tree _model_class, tree[k], result_tree[k.to_sym]
+      end
+    end
+  end
+end
+

data/rgraphql_preload_ar.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |s|
+  s.name = 'graphql_preloader'
+  s.version = "1.1.0"
+  s.date = Time.now.strftime("%Y-%m-%d")
+  s.summary = %q{rails graphql preload ar association in resolver}
+  s.files = `git ls-files`.split($/)
+  s.authors = ["tinyfeng.hou"]
+  s.license = 'MIT'
+  s.add_dependency "graphql", ">=1.8.11"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: graphql_preloader
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- tinyfeng.hou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.11
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .bundle/config
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/graphql_preloader.rb
+- lib/preload_function.rb
+- rgraphql_preload_ar.gemspec
+homepage: 
+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.7.9
+signing_key: 
+specification_version: 4
+summary: rails graphql preload ar association in resolver
+test_files: []