graphql-remote_loader 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd7a27a207b0fccaa2e6329d51d3de738f333c09
-  data.tar.gz: b90fd6caae8031cc12b98c4d3a64a846cf92466a
+  metadata.gz: 8f7f2b1ab4cf983200d1c98e42324a2965677466
+  data.tar.gz: 6cd70f26a9b81d8be0899e519300fbdb30a3fb53
 SHA512:
-  metadata.gz: dab4bded8d2e3f34739b7adcd147597576b76a31b0a76290cd114a72b877a6ed2ffead7760ccc45644aff6b95558dd1f4bc8725e5a330ce3596dfbc76d916376
-  data.tar.gz: a6337ed60323d83c87f9ccb845021884d7cafcdd0ef74bec74d4a5b38734969b97a353417ab8b4549b4f0a10f83f952d22e44cf272b340a1b9dd31288ac9fe8e
+  metadata.gz: 1b5dbdc65a0fbcad465a567793044d4eb7cdb9b3728f44b6339ea956a00b46d97ca1cd499433e74847c78d3bde420cd7d60558990c6b97082934aea294e15886
+  data.tar.gz: 8b796e95b900b6afbab007932bd41b9841f32d7284724e709d01108be5abf785affa9a547bbb5fda81520efc2431936081ff52360e4c4d1be7a21cd8befd9ccd

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+script: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-remote_loader (0.0.5)
+    graphql-remote_loader (1.0.0)
       graphql (~> 1.6)
       graphql-batch (~> 0.3)
 

data/README.md

@@ -1,37 +1,67 @@
 # GraphQL Remote Loader
+[![Gem Version](https://badge.fury.io/rb/graphql-remote_loader.svg)](https://badge.fury.io/rb/graphql-remote_loader) [![Build Status](https://travis-ci.org/d12/graphql-remote_loader.svg?branch=master)](https://travis-ci.org/d12/graphql-remote_loader)
+
 Performant, batched GraphQL queries from within the resolvers of a [`graphql-ruby`](https://github.com/rmosolgo/graphql-ruby) API.
 
-## Example
+
+## Snippet
 
 ```ruby
-  field :repositoryUrl, !types.String do
-    description "The repository URL"
-
-    resolve ->(obj, args, ctx) do
-      query = <<-GQL
-        node(id: "#{obj.global_relay_id}"){
-          ... on Repository {
-            url
-          }
-        }
-      GQL
-    
-      GitHubLoader.load(query).then do |results|
-        results["node"]["url"]
-      end
+  field :login, String, null: false, description: "The currently authenticated GitHub user's login."
+
+  def login
+    GitHubLoader.load("viewer { login }").then do |results|
+      results["viewer"]["login"]
     end
   end
 ```
 
+## Full example
+
+To see a working example of how `graphql-remote_loader` works, see the [complete, working example application](https://github.com/d12/graphql-remote_loader_example).
+
 ## Description
-`graphql-remote_loader` allows for querying GraphQL APIs from within resolvers of a [`graphql-ruby`](https://github.com/rmosolgo/graphql-ruby) API. 
+`graphql-remote_loader` allows for querying GraphQL APIs from within resolvers of a [`graphql-ruby`](https://github.com/rmosolgo/graphql-ruby) API.
 
-This can be used to create GraphQL APIs that depend on data from other GraphQL APIs, either remote or local. 
+This can be used to create GraphQL APIs that depend on data from other GraphQL APIs, either remote or local.
 
 A promise-based resolution strategy from Shopify's [`graphql-batch`](https://github.com/Shopify/graphql-batch) is used to batch all requested data into a single GraphQL query. Promises are fulfilled with only the data they requested.
 
 You can think of it as a lightweight version of schema-stitching.
 
+## How it works
+
+Using GraphQL batch, the loader collects all GraphQL sub-queries before combining and executing one query.
+
+### Merging queries
+
+Once we have all the queries we need, we merge them all together by treating the query ASTs as prefix trees and merging the prefix trees together. For example, if the input queries were `["viewer { foo bar }", "buzz viewer { foo bazz }"]`, then the merged query would be:
+
+```graphql
+query{
+  buzz
+  viewer{
+    foo
+    bar
+    bazz
+  }
+}
+```
+
+### Name conflicts
+
+Suppose we want to merge `["user(login: "foo") { url }", "user(login: "bar") { url }"]`. We can't treat these `user` fields as equal since their arguments don't match, but we also can't naively combine these queries together, the `user` key will be ambiguous.
+
+To solve this problem, we introduce identified aliases. Every query to be merged is given a unique ID. When building the query, we include this unique ID in a new alias on all fields. This prevents conflicts between separate subqueries.
+
+### Fulfilling promises
+
+We only want to fulfill each promise with the data it asked for. This is especially relevant in the case of conflicts as in the case above.
+
+When fulfilling promises, we traverse the result hash and prune out all result keys with UIDs that don't match the query. Before returning the filtered hash, we scrub the UIDs so that the result keys are the same as the GraphQL field names.
+
+This solution prevents all conflict issues and doesn't change the way your API uses this library.
+
 ## How to use
 First, you'll need to install the gem. Either do `gem install graphql-remote_loader` or add this to your Gemfile:
 
@@ -51,8 +81,8 @@ require "graphql/remote_loader"
 module MyApp
   class GitHubLoader < GraphQL::RemoteLoader::Loader
     def query(query_string)
-      parsed_query = MyApp::Client.parse(query_string)
-      MyApp.query(parsed_query)
+      parsed_query = GraphQLClient.parse(query_string)
+      GraphQLClient.query(parsed_query)
     end
   end
 end
@@ -60,6 +90,9 @@ end
 
 This example uses [`graphql-client`](https://github.com/github/graphql-client). Any client, or even just plain `cURL`/`HTTP` can be used.
 
-## Current State
+## Running tests
 
-This project is very much WIP. Some TODOs are listed in the issues. Bugs and feature requests should be added as issues.
+```
+bundle install
+rspec
+```

data/lib/graphql/remote_loader/loader.rb

@@ -1,4 +1,5 @@
 require "prime"
+require "json"
 require_relative "query_merger"
 
 module GraphQL
@@ -33,17 +34,32 @@ module GraphQL
 
       def perform(queries_and_primes)
         query_string = QueryMerger.merge(queries_and_primes)
-        response = query(query_string)
+        response = query(query_string).to_h
+
+        data, errors = response["data"], response["errors"]
 
         queries_and_primes.each do |query, prime|
-          fulfill([query, prime], filter_keys_on_response(response.to_h, prime))
+          response = {}
+
+          response["data"] = filter_keys_on_data(data, prime)
+
+          errors_key = filter_errors(errors, prime)
+          response["errors"] = dup(errors_key) unless errors_key.empty?
+
+          scrub_primes_from_error_paths!(response["errors"])
+
+          fulfill([query, prime], response)
         end
       end
 
-      def filter_keys_on_response(obj, prime)
+      def dup(hash)
+        JSON.parse(hash.to_json)
+      end
+
+      def filter_keys_on_data(obj, prime)
         case obj
         when Array
-          obj.map { |element| filter_keys_on_response(element, prime) }
+          obj.map { |element| filter_keys_on_data(element, prime) }
         when Hash
           filtered_results = {}
 
@@ -61,7 +77,7 @@ module GraphQL
             method_name = method.match(/\Ap[0-9]+(.*)/)[1]
 
             method_value = obj[method]
-            filtered_value = filter_keys_on_response(method_value, prime)
+            filtered_value = filter_keys_on_data(method_value, prime)
 
             filtered_results[underscore(method_name)] = filtered_value
           end
@@ -72,6 +88,34 @@ module GraphQL
         end
       end
 
+      def filter_errors(errors, prime)
+        return [] unless errors
+
+        errors.select do |error|
+          # For now, do not support global errors with no path key
+          next unless error["path"]
+
+          # We fulfill a promise with an error object if field in the path
+          # key was requested by the promise.
+          error["path"].all? do |path_key|
+            next true if path_key.is_a? Integer
+
+            path_key_prime = path_key.match(/\Ap([0-9]+)/)[1].to_i
+            path_key_prime % prime == 0
+          end
+        end
+      end
+
+      def scrub_primes_from_error_paths!(error_array)
+        return unless error_array
+
+        error_array.map do |error|
+          error["path"].map! do |path_key|
+            path_key.match(/\Ap[0-9]+(.*)/)[1]
+          end
+        end
+      end
+
       def underscore(str)
         str.gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').

data/lib/graphql/remote_loader/query_merger.rb

@@ -26,7 +26,6 @@ module GraphQL
           parsed_queries.each do |query|
             merge_query_recursive(query.definitions[0], merged_query.definitions[0])
             merge_fragment_definitions(query, merged_query)
-
           end
 
           merged_query.definitions.each do |definition|
@@ -61,13 +60,13 @@ module GraphQL
           a_query.selections.each do |a_query_selection|
             matching_field = b_query.selections.find do |b_query_selection|
               same_name = a_query_selection.name == b_query_selection.name
-              same_args = if exempt_node_types.any? { |type| b_query_selection.is_a?(type) }
-                true
-              else
-                arguments_equal?(a_query_selection, b_query_selection)
-              end
 
-              same_name && same_args
+              next same_name if exempt_node_types.any? { |type| b_query_selection.is_a?(type) }
+
+              same_args = arguments_equal?(a_query_selection, b_query_selection)
+              same_alias = a_query_selection.alias == b_query_selection.alias
+
+              same_name && same_args && same_alias
             end
 
             if matching_field
@@ -107,9 +106,14 @@ module GraphQL
           ]
 
           query_selections.each do |selection|
-            unless exempt_node_types.any? { |type| selection.is_a? type  }
+            unless exempt_node_types.any? { |type| selection.is_a? type }
               prime_factor = selection.instance_variable_get(:@prime)
-              selection.alias = "p#{prime_factor}#{selection.name}"
+
+              selection.alias = if selection.alias
+                "p#{prime_factor}#{selection.alias}"
+              else
+                "p#{prime_factor}#{selection.name}"
+              end
             end
 
             # Some nodes don't have selections (e.g. fragment spreads)

data/lib/graphql/remote_loader/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module RemoteLoader
-    VERSION = "0.0.5"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-remote_loader
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Nathaniel Woodthorpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -104,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md