graphql-stitching 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a228b0fe5779d625285182f885a7d65b5f66541f275a5313602e68a4c9eb209d
-  data.tar.gz: f6efcaeafd7c417db07f007641f84c800c0ebb32c99ad19c5004aa2bb9ac8685
+  metadata.gz: 5090330cd8b46c9d7dbfc7bbc68f5840e97f8bcbc5ec710de219441237fb61e5
+  data.tar.gz: 846a15ccc2734024dec751d61d456aa05d4b7c396d6789d629da21e11c182100
 SHA512:
-  metadata.gz: 1d484e39db0ac919e68477e8733fa6f0ca31ffde74b2bfebc4e13ba6b55d7973dc793c6df4251ae7b912c450bdc38ab4478e300c350d7be67555a635687b04a9
-  data.tar.gz: 6354381e960a922453cd38ae5c513b60f2d2ae4585ec2a53a1ab7b405c2da6ca6d01bce9999794f9c8b6df7fe0d49176a4f944ab0efabfcb8ff252393a60f88e
+  metadata.gz: 1c0c16a9bb49b3fad30057958d79fe92737bb659bf7135dd03ef716597f013249c99d9372478e20619f54e1e77f68f3b7f746b92e9e220b80be9ecaf88b656de
+  data.tar.gz: f370e520552f3e8be141073dd7ca06f68a463824c946b9cd03357b33ad5c9fc928893e846314f08941e2590d24202081450677fbfca480474be9833d341209a1

data/.github/workflows/ci.yml

@@ -11,14 +11,20 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.1.1']
+        include:
+          - gemfile: Gemfile
+            ruby: 3.2
+          - gemfile: Gemfile
+            ruby: 3.1
+          - gemfile: Gemfile
+            ruby: 2.7
 
     steps:
     - uses: actions/checkout@v2
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby-version }}
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: |

data/.gitignore

@@ -10,6 +10,7 @@
 /test/version_tmp/
 /tmp/
 .envrc
+Gemfile.lock
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -17,6 +18,7 @@
 
 # Ignore Byebug command history file.
 .byebug_history
+.ruby-version
 .DS_Store
 
 ## Specific to RubyMotion:

data/README.md

@@ -46,7 +46,7 @@ showtimes_schema = <<~GRAPHQL
 GRAPHQL
 
 gateway = GraphQL::Stitching::Gateway.new(locations: {
-  products: {
+  movies: {
     schema: GraphQL::Schema.from_definition(movies_schema),
     executable: GraphQL::Stitching::RemoteClient.new(url: "http://localhost:3000"),
   },
@@ -79,7 +79,6 @@ While the [`Gateway`](./docs/gateway.md) constructor is an easy quick start, the
 - [Document](./docs/document.md) - manages a parsed GraphQL request document.
 - [Planner](./docs/planner.md) - builds a cacheable query plan for a request document.
 - [Executor](./docs/executor.md) - executes a query plan with given request variables.
-- [Shaper](./docs/shaper.md) - takes the raw output of the executor and prepares it for delivery.
 
 ## Merged types
 

data/docs/executor.md

@@ -21,9 +21,19 @@ plan = GraphQL::Stitching::Planner.new(
   document: document,
 ).perform
 
+# get the raw result without shaping
 raw_result = GraphQL::Stitching::Executor.new(
   supergraph: supergraph,
   plan: plan.to_h,
   variables: variables,
 ).perform
+
+# get the final result with shaping
+final_result = GraphQL::Stitching::Executor.new(
+  supergraph: supergraph,
+  plan: plan.to_h,
+  variables: variables,
+).perform(document)
 ```
+
+Note that an executor's `perform` method accepts a document argument. When provided, the raw execution result will be shaped for delivery to match the document. Without a document, the raw result will be returned with stitching inclusions and no null bubbling applied.

data/graphql-stitching.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.version       = GraphQL::Stitching::VERSION
   spec.authors       = ['Greg MacWilliam']
   spec.summary       = 'GraphQL schema stitching for Ruby'
-  spec.description   = spec.summary
+  spec.description   = 'Combine GraphQL services into one unified graph'
   spec.homepage      = 'https://github.com/gmac/graphql-stitching-ruby'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 3.1.1'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata    = {
     'homepage_uri' => 'https://github.com/gmac/graphql-stitching-ruby',

data/lib/graphql/stitching/executor.rb

@@ -219,9 +219,14 @@ module GraphQL
         result["data"] = @data if @data && @data.length > 0
         result["errors"] = @errors if @errors.length > 0
 
-        result if document.nil?
-
-        GraphQL::Stitching::Shaper.new(supergraph: @supergraph, document: document, raw: result).perform!
+        if document && result["data"]
+          GraphQL::Stitching::Shaper.new(
+            schema: @supergraph.schema,
+            document: document,
+          ).perform!(result)
+        else
+          result
+        end
       end
 
       private

data/lib/graphql/stitching/shaper.rb

@@ -4,88 +4,92 @@
 module GraphQL
   module Stitching
     class Shaper
-      def initialize(supergraph:, document:, raw:)
-        @supergraph = supergraph
+      def initialize(schema:, document:)
+        @schema = schema
         @document = document
-        @result = raw
-        @errors = []
       end
 
-      def perform!
-        if @result.key?("data") && ! @result["data"].empty?
-          munge_entry(@result["data"], @document.operation.selections, @supergraph.schema.query)
-          # hate doing a second pass, but cannot remove _STITCH_ fields until the fragements are processed
-          clean_entry(@result["data"])
-        end
-
-        if @errors.length > 0
-          @result = [] unless @result.key?("errors")
-          @result["errors"] += @errors
-        end
-
-        @result
+      def perform!(raw)
+        raw["data"] = resolve_object_scope(raw["data"], @schema.query, @document.operation.selections)
+        raw
       end
 
       private
 
-      def munge_entry(entry, selections, parent_type)
+      def resolve_object_scope(raw_object, parent_type, selections, typename = nil)
+        return nil if raw_object.nil?
+
+        typename ||= raw_object["_STITCH_typename"]
+        raw_object.reject! { |k, _v| k.start_with?("_STITCH_") }
+
         selections.each do |node|
           case node
           when GraphQL::Language::Nodes::Field
-            next if node.respond_to?(:name) && node&.name == "__typename"
+            next if node.name.start_with?("__")
 
-            munge_field(entry, node, parent_type)
+            field_name = node.alias || node.name
+            node_type = parent_type.fields[node.name].type
+            named_type = Util.get_named_type_for_field_node(@schema, parent_type, node)
+
+            raw_object[field_name] = if node_type.list?
+              resolve_list_scope(raw_object[field_name], Util.unwrap_non_null(node_type), node.selections)
+            elsif Util.is_leaf_type?(named_type)
+              raw_object[field_name]
+            else
+              resolve_object_scope(raw_object[field_name], named_type, node.selections)
+            end
+
+            return nil if raw_object[field_name].nil? && node_type.non_null?
 
           when GraphQL::Language::Nodes::InlineFragment
-            next unless entry["_STITCH_typename"] == node.type.name
-            fragment_type = @supergraph.schema.types[node.type.name]
-            munge_entry(entry, node.selections, fragment_type)
+            next unless typename == node.type.name
+            fragment_type = @schema.types[node.type.name]
+            result = resolve_object_scope(raw_object, fragment_type, node.selections, typename)
+            return nil if result.nil?
 
           when GraphQL::Language::Nodes::FragmentSpread
-            next unless entry["_STITCH_typename"] == node.name
             fragment = @document.fragment_definitions[node.name]
-            fragment_type = @supergraph.schema.types[node.name]
-            munge_entry(entry, fragment.selections, fragment_type)
+            fragment_type = @schema.types[fragment.type.name]
+            next unless typename == fragment_type.graphql_name
+
+            result = resolve_object_scope(raw_object, fragment_type, fragment.selections, typename)
+            return nil if result.nil?
+
           else
             raise "Unexpected node of type #{node.class.name} in selection set."
           end
         end
+
+        raw_object
       end
 
-      def munge_field(entry, node, parent_type)
-        field_identifier = (node.alias || node.name)
-        node_type = Util.get_named_type_for_field_node(@supergraph.schema, parent_type, node)
+      def resolve_list_scope(raw_list, current_node_type, selections)
+        return nil if raw_list.nil?
 
-        if entry.nil?
-          return  # TODO bubble up error if not nullable
-        end
+        next_node_type = Util.unwrap_non_null(current_node_type).of_type
+        named_type = Util.get_named_type(next_node_type)
+        contains_null = false
 
-        child_entry = entry[field_identifier]
-        if child_entry.nil?
-          entry[field_identifier] = nil
-        elsif child_entry.is_a? Array
-          child_entry.each do |raw_item|
-            munge_entry(raw_item, node.selections, node_type)
+        resolved_list = raw_list.map! do |raw_list_element|
+          result = if next_node_type.list?
+            resolve_list_scope(raw_list_element, next_node_type, selections)
+          elsif Util.is_leaf_type?(named_type)
+            raw_list_element
+          else
+            resolve_object_scope(raw_list_element, named_type, selections)
           end
-        elsif ! Util.is_leaf_type?(node_type)
-          munge_entry(child_entry, node.selections, node_type)
-        end
-      end
 
-      def clean_entry(entry)
-        return if entry.nil?
-
-        entry.each do |key, value|
-          if key.start_with? "_STITCH_"
-            entry.delete(key)
-          elsif value.is_a?(Array)
-            value.each do |item|
-              clean_entry(item)
-            end
-          elsif value.is_a?(Hash)
-            clean_entry(value)
+          if result.nil?
+            contains_null = true
+            return nil if current_node_type.non_null?
           end
+
+          result
         end
+
+        return nil if contains_null && next_node_type.non_null?
+
+        resolved_list
       end
     end
   end

data/lib/graphql/stitching/util.rb

@@ -4,7 +4,7 @@ module GraphQL
   module Stitching
     class Util
 
-      # gets the named type at the bottom of a non-null/list wrapper chain
+      # gets the named type at the bottom of a non-null/list wrapper tree
       def self.get_named_type(type)
         while type.respond_to?(:of_type)
           type = type.of_type
@@ -12,6 +12,14 @@ module GraphQL
         type
       end
 
+      # strips non-null wrappers from a type
+      def self.unwrap_non_null(type)
+        while type.is_a?(GraphQL::Schema::NonNull)
+          type = type.of_type
+        end
+        type
+      end
+
       # gets a deep structural description of a list value type
       def self.get_list_structure(type)
         structure = []

data/lib/graphql/stitching/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Stitching
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.12'
-description: GraphQL schema stitching for Ruby
+description: Combine GraphQL services into one unified graph
 email:
 executables: []
 extensions: []
@@ -74,9 +74,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
-- ".ruby-version"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - Procfile
 - README.md
@@ -90,7 +88,6 @@ files:
 - docs/images/merging.png
 - docs/images/stitching.png
 - docs/planner.md
-- docs/shaper.md
 - docs/supergraph.md
 - example/gateway.rb
 - example/graphiql.html
@@ -128,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.1
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.ruby-version

@@ -1 +0,0 @@
-3.1.1

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    graphql-stitching (0.0.1)
-      graphql (~> 2.0.16)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.1.3)
-    coderay (1.1.3)
-    foreman (0.87.2)
-    graphql (2.0.16)
-    method_source (1.0.0)
-    minitest (5.17.0)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
-    rack (3.0.4.1)
-    rackup (2.1.0)
-      rack (>= 3)
-      webrick (~> 1.8)
-    rake (12.3.3)
-    warning (1.3.0)
-    webrick (1.8.1)
-
-PLATFORMS
-  arm64-darwin-21
-  ruby
-  x86_64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  foreman
-  graphql-stitching!
-  minitest (~> 5.12)
-  pry
-  pry-byebug
-  rack
-  rackup
-  rake (~> 12.0)
-  warning
-
-BUNDLED WITH
-   2.4.1

data/docs/shaper.md

@@ -1,20 +0,0 @@
-## GraphQL::Stitching::Shaper
-
-The `Shaper` takes the raw output generated by the `GraphQL::Stitching::Executor` and does the final shaping and
-cleaning. It removes data that was added while building the result, it also handles cleaning up violations that can
-only occur at the end, such as bubbling up null violoations.
-
-See the [Executor](./docs/executor.md)
-
-```ruby
-raw_result = GraphQL::Stitching::Executor.new(
-  supergraph: supergraph,
-  plan: plan.to_h,
-  variables: variables,
-).perform(document)
-
-final_result = GraphQL::Stitching::Shaper.new(
-  supergraph: supergraph,
-  document: document,
-  raw: raw_result).perform!
-```