graphql_preload_queries 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89226168aa382eb59c56754b96a4eaa64c51c5f06fc6fd8d831b7795d84adf0e
-  data.tar.gz: b29ec85aa619a1f7412944d6f50388f68c9b196cc5e8607bc22fd163f3a64ed1
+  metadata.gz: fcc53358f8564b5b00d02cf7a341a7a82af9a9f02db2458fa4902f16d10847fb
+  data.tar.gz: 959b2a80b05637e60127762fae8fc765fff6c28c5438099cefbbe40c2c37a8c6
 SHA512:
-  metadata.gz: 42df9aacf5b59d341fc5498a61890a1ecd5c76713179c94b81696084af7d9d4f52abdd105c26a04775aa6b8199f86398841bf230127df711ffceef386752f7f9
-  data.tar.gz: cded97146bc935064f7dcaa94034deffd06adf1b6cf3c2daaacf746fb11eef542b261debd505ccb8963ec3b67f60cf7386d4829aeaa13feaed024786fa7ec04e
+  metadata.gz: 12797d60fbcdb9d528a56563d29b22c14555de16f4d0e34d063efc48444ec9e0936e854f5cf4912b7575720b40f7f79bfee25ab0b13039f9276efad5b99591e1
+  data.tar.gz: 991bb3d2cf4c6a8ccc2df2ce26f48cf564d6a37c6bc5f4a68a0d8de8a6d8ae8c48b62a4595b800dd62f72dcca180a31f23e3c28d0025625e76dea6c1f758961d

data/.github/workflows/ruby.yml

@@ -45,4 +45,5 @@ jobs:
         run: |
           bundle exec rspec
       - name: Code style (Rubocop)
-        run: bundle exec rubocop
+        run: bundle exec rubocop
+        if: matrix.ruby == '2.5'

data/.rubocop.yml

@@ -2,7 +2,7 @@
 
 require: rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
 RSpec/FilePath:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0 (30-05-2021)
+- feat: refactor `include_gql_preloads` to auto calculate `query_key` and make it optional
+- feat: support `:preload` option when defining a field
+
 ## 0.3.1 (22-01-2021)
 - feat: auto camelize key for queries and mutations
 

data/Gemfile

@@ -8,6 +8,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
 gemspec
+gem 'byebug'
 
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_preload_queries (0.3.1)
+    graphql_preload_queries (0.4.0)
       graphql
       rails
 
@@ -65,6 +65,7 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.1)
     builder (3.2.4)
+    byebug (11.1.3)
     concurrent-ruby (1.1.7)
     crass (1.0.6)
     database_cleaner (1.8.5)
@@ -86,11 +87,13 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.0)
     mini_portile2 (2.4.0)
     minitest (5.14.2)
-    nio4r (2.5.4)
+    nio4r (2.5.7)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.20.1)
@@ -183,6 +186,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   database_cleaner-active_record
   graphql_preload_queries!
   rspec-rails

data/README.md

@@ -1,57 +1,51 @@
 # GraphqlPreloadQueries
-This gem helps you to define all nested preloads to be added when required for graphql data results and avoid the common problem "N+1 Queries". 
+This gem permits your graphql application to define association preloads to improve app performance by removing N+1 query issues. 
 
 ## Usage
   * Object Type
     ```ruby
     class UserType < Types::BaseObject
-      add_preload 'parents|allParents', { preload: :parents, friends: :friends, parents: :parents }
-      add_preload :friends, { parents: { preload: :parents, parents: :parents, friends: :friends } }
-    
       field :id, Int, null: true
       field :name, String, null: true
-      field :friends, [Types::UserType], null: false
-      field :parents, [Types::UserType], null: false
+      field :parents, [Types::UserType], null: false, preload: true
+      field :friends, [Types::UserType], null: false, preload: :user_friends
     end
     ```
-    Examples:
-    * ```add_preload(:friends)```   
-      ```:friends``` association will be preloaded if query includes ```friends```, like: ```user(id: 10) { friends { ... } }```
-    
-    * ```add_preload(:allFriends, :friends)```   
-      ```:friends``` association will be preloaded if query includes ```allFriends```, like: ```user(id: 10) { allFriends { ... } }```  
-    
-    * ```add_preload(:allFriends, { preload: :friends, parents: :parents })```   
-      ```:preload``` key can be used to indicate the association name when defining nested preloads, like: ```user(id: 10) { allFriends { id parents { ... } } }```  
     
-    * ```add_preload(:friends, { allParents: :parents })```    
-      (Nested 1 lvl preloading) ```friends: :parents``` association will be preloaded if query includes ```allParents```, like: ```user(id: 10) { friends { allParents { ... } } }```  
-    
-    * ```add_preload(:friends, { allParents: { preload: :parents, friends: :friends } })```    
-      (Nested 2 levels preloading) ```friends: { parents: :friends }``` association will be preloaded if query includes ```friends``` inside ```parents```, like: ```user(id: 10) { friends { allParents { { friends { ... } } } } }```  
-    
-    * ```add_preload('friends|allFriends', :friends)```    
-      (Multiple gql queries) ```:friends``` association will be preloaded if query includes ```friends``` or ```allFriends```, like: ```user(id: 10) { friends { ... } }``` OR ```user(id: 10) { allFriends { ... } }```   
-      
-    * ```add_preload('ignoredFriends', 'ignored_friends.user')```    
-      (Deep preloading) ```{ ignored_friends: :user }``` association will be preloaded if query includes ```inogredFriends```, like: ```user(id: 10) { ignoredFriends { ... } }```   
+    `preload:` accepts:
+    - `true`: Will use field key as the association name    
+      `field :parents, ..., preload: true` will preload `parents` association
+    - `Symbol`: Custom association name    
+      `field :friends, ..., preload: :user_friends` will preload `user_friends` association
+    - `String`: Tied associations    
+      `field :excluded_friends, ..., preload: 'excluded_friends.user'` will preload `excluded_friends -> user` association
+    - `Hash`: Deep preload definitions   
+      `field :best_friends, ..., preload: { preload: :user_friends, parents: :parents }'`  
+      * Will preload `user_friends` and `user_friends.parents` only if query includes inner definition, like `user(id: 10) { bestFriends { id parents { ... } } }`       
+      * Will not preload `user_friends.parents` if query does not include inner definition, like `user(id: 10) { bestFriends { id } }`
+        
     
   * Preloads in query results
-    ```ruby
-      # queries/users.rb
-      def user(id:)
-        # includes all preloads defined in user type
-        #   Sample: user(id: 10){ friends { id } }
-        #     :friends will be preloaded inside "user" sql query    
-        user = include_gql_preloads(:user, User.where(id: id))
-        
-        # does not include user type preloads (only sub query preloads will be applied)
-        #   Sample: user(id: 10){ friends { id parents { ... } } }
-        #     Only :parents will be preloaded inside "friends" sql query
-        user = User.find(id)
-      end
-    ```
-    - include_gql_preloads: Will preload all preloads configured in UserType based on the gql query.
+    - BEFORE   
+      ```ruby
+        # queries/users.rb
+        def users(ids:)
+          users = User.where(id: ids)
+        end
+      ```
+      Does not apply preloads to the root query.
+    - AFTER
+      ```ruby
+        def users(ids:)
+          user = include_gql_preloads(User.where(id: id))
+        end
+      ```
+      Root query applies all defined preloads
+      
+    - `include_gql_preloads(collection, query_key: nil, type_klass: nil)`: Will include all preloads configured in `type_klass` (UserType) based on the gql query.
+      - `collection` (ActiveRecordCollection) Query results
+      - `query_key` (String | Sym, default: method name) Field result key
+      - `type_klass:` (GQL TypeClass, default: calculates using query_key)
     
   * Preloads in mutation results
     ```ruby
@@ -60,12 +54,14 @@ This gem helps you to define all nested preloads to be added when required for g
       field :users, [Types::UserType], null: true  
       def resolve(ids:)
         affected_users = User.where(id: ids)
-        affected_users = include_gql_preloads(:users, affected_users)
-        puts affected_users.first&.friends # will print preloaded friends data
+        affected_users = include_gql_preloads(affected_users, query_key: :users)
         { users: affected_users }
       end
     ```
-    - include_gql_preloads: Will preload all preloads configured in UserType based on the gql query.
+    - `include_gql_preloads(collection, query_key: , type_klass: nil)`: Will include all preloads configured in `type_klass` (UserType) based on the gql query.
+      - `collection` (ActiveRecordCollection) Query results
+      - `query_key` (String | Sym) Field result key 
+      - `type_klass:` (GQL TypeClass, default: calculates using query_key)
     
 ## Installation
 Add this line to your application's Gemfile:

data/config/initializers/add_mutation_helper.rb

@@ -5,11 +5,11 @@ Rails.application.config.to_prepare do
   GraphQL::Schema::Mutation.class_eval do
     # TODO: auto recover type_klass using result key
     # Add corresponding preloads to mutation results
-    # @param gql_result_key (String | Sym)
+    # @param query_key (String | Sym)
     # @param collection (ActiveCollection)
     # @param type_klass (GQL TypeClass)
-    def include_gql_preloads(gql_result_key, collection, type_klass = nil)
-      gql_result_key = GraphQL::Schema::Member::BuildType.camelize(gql_result_key.to_s)
+    def include_gql_preloads(collection, query_key:, type_klass: nil)
+      gql_result_key = GraphQL::Schema::Member::BuildType.camelize(query_key.to_s)
       type_klass ||= preload_type_klass(gql_result_key.to_s)
       klass = GraphqlPreloadQueries::Extensions::Preload
       ast_node = preload_find_node(gql_result_key)

data/config/initializers/add_preload_field.rb

@@ -31,6 +31,14 @@ Rails.application.config.to_prepare do
         key = GraphQL::Schema::Member::BuildType.camelize(key.to_s)
         preloads[key] = preload
       end
+
+      alias_method :field_old, :field
+      def field(*args, **kwargs, &block)
+        preload = kwargs.delete(:preload)
+        key = args[0]
+        add_preload(key, preload == true ? key : preload) if preload
+        field_old(*args, **kwargs, &block)
+      end
     end
   end
 end

data/config/initializers/add_query_helper.rb

@@ -3,14 +3,14 @@
 # preload resolver for queries
 Rails.application.config.to_prepare do
   Types::QueryType.class_eval do
-    # TODO: auto recover type_klass using result key
     # Add corresponding preloads to query results
     #   Note: key is automatically calculated based on method name
-    # @param gql_result_key (String | Sym)
     # @param collection (ActiveCollection)
     # @param type_klass (GQL TypeClass, default: calculates using return type)
-    def include_gql_preloads(gql_result_key, collection, type_klass = nil)
-      gql_result_key = GraphQL::Schema::Member::BuildType.camelize(gql_result_key.to_s)
+    # @param query_key (String | Sym) Default method name
+    def include_gql_preloads(collection, query_key: nil, type_klass: nil)
+      query_key ||= caller_locations(1, 1)[0].label
+      gql_result_key = GraphQL::Schema::Member::BuildType.camelize(query_key.to_s)
       type_klass ||= preload_type_klass(gql_result_key.to_s)
       klass = GraphqlPreloadQueries::Extensions::Preload
       ast_node = preload_find_node(gql_result_key)

data/graphql_preload_queries.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Permit to avoid N+1 queries problem when using graphql queries'
   spec.homepage      = 'https://github.com/owen2345/graphql_preload_queries'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.0') # rubocop:disable Gemspec/RequiredRubyVersion
 
   # spec.metadata["allowed_push_host"] = ""
 

data/lib/graphql_preload_queries/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlPreloadQueries
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_preload_queries
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -154,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="