graphql-stitching 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f67a4b892fba612e2e38552ae0a0f681ed0fdc136c04ecef4d2c01692eed9eb8
-  data.tar.gz: 3db164c53dc67d64b7364ba5a17186e3eb612074993b21df5f9a8b059fca9f89
+  metadata.gz: a05f9ff15f40a886a20136cdaf5323cf37a59e7d98de27cc19cf7e600feb48e2
+  data.tar.gz: 7727f7394bb99abcb3c3a448f1ebf8b3bd5f9b7a2fd74e9bc741285f401a23cc
 SHA512:
-  metadata.gz: 8d687747a19a25a69b1c998910265a183bdb22338fec5e9787412ca5c1cdfc5e0b838bb49ce4942ce41dec0e000e0ddc35bdf07368a7a772751ffc5342b7ee48
-  data.tar.gz: f4419aa525964b37db62ce2343d11914ac56677825c8f1450c5187465b2f28e3a740acf6779309bdb0a5fbd41829054101aed4c9d0eb764882759c50bbf1b641
+  metadata.gz: f8993da51f8bd18ec1e590727a24bcba8690831e006a1a3fc861cfaa83b9794b94f90fb0e458919d7997d67606ae8ece4acfdd8a3a0d6fe669e7971b01232cf3
+  data.tar.gz: 1032ed3279a98d1bc52db321a49a0a47d78dfb00cf9a8c922d1e77217ac837f8695c146908767ec398620f42a816f92eefc339d1fde970fe543904a6a30976f5

data/README.md

@@ -92,7 +92,7 @@ To facilitate this merging of types, stitching must know how to cross-reference
 directive @stitch(key: String!) repeatable on FIELD_DEFINITION
 ```
 
-This directive is applied to root queries where a merged type may be accessed in each location, and a `key` argument specifies a field needed from other locations to be used as a query argument.
+This directive (or [static configuration](#sdl-based-schemas)) is applied to root queries where a merged type may be accessed in each location, and a `key` argument specifies a field needed from other locations to be used as a query argument.
 
 ```ruby
 products_schema = <<~GRAPHQL
@@ -219,7 +219,7 @@ type Query {
 }
 ```
 
-The `@stitch` directive is also repeatable (_requires graphql-ruby v2.0.15_), allowing a single query to associate with multiple keys:
+The `@stitch` directive is also repeatable (_requires graphql-ruby >= v2.0.15_), allowing a single query to associate with multiple keys:
 
 ```graphql
 type Product {
@@ -251,6 +251,35 @@ class Query < GraphQL::Schema::Object
 end
 ```
 
+The `@stitch` directive can be exported from a class-based schema to an SDL string by calling `schema.to_definition`.
+
+#### SDL-based schemas
+
+A clean SDL string may also have stitching directives applied via static configuration using the `GraphQL::Stitching` module to build the SDL into a schema:
+
+```ruby
+sdl_string = <<~GRAPHQL
+  type Product {
+    id: ID!
+    upc: ID!
+  }
+  type Query {
+    productById(id: ID!): Product
+    productByUpc(upc: ID!): Product
+  }
+GRAPHQL
+
+decorated_schema = GraphQL::Stitching.schema_from_definition(sdl_string, stitch_directives: [
+  { type_name: "Query", field_name: "productById", key: "id" },
+  { type_name: "Query", field_name: "productByUpc", key: "upc" },
+])
+
+supergraph = GraphQL::Stitching::Composer.new(schemas: {
+  "products" => decorated_schema,
+  # ...
+})
+```
+
 #### Custom directive names
 
 The library is configured to use a `@stitch` directive by default. You may customize this by setting a new name during initialization:

data/docs/supergraph.md

@@ -30,7 +30,7 @@ end
 
 ### Export and caching
 
-A Supergraph is designed to be composed, cached, and restored. Calling the `export` method will return an SDL (Schema Definition Language) print of the combined graph schema and a deletation mapping hash. These can be persisted in any raw format that suits your stack:
+A Supergraph is designed to be composed, cached, and restored. Calling the `export` method will return an SDL (Schema Definition Language) print of the combined graph schema and a delegation mapping hash. These can be persisted in any raw format that suits your stack:
 
 ```ruby
 supergraph_sdl, delegation_map = supergraph.export

data/graphql-stitching.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'graphql', '~> 2.0.3'
+  spec.add_runtime_dependency 'graphql', '>= 1.13.9'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 12.0'

data/lib/graphql/stitching/composer/validate_boundaries.rb

@@ -67,7 +67,17 @@ module GraphQL
       end
 
       def validate_as_shared(ctx, type, subschema_types_by_location)
-        expected_fields = type.fields.keys.sort
+        expected_fields = begin
+          type.fields.keys.sort
+        rescue StandardError => e
+          # bug with inherited interfaces in older versions of GraphQL
+          if type.interfaces.any? { _1.is_a?(GraphQL::Schema::LateBoundType) }
+            raise Composer::ComposerError, "Merged interface inheritance requires GraphQL >= v2.0.3"
+          else
+            raise e
+          end
+        end
+
         subschema_types_by_location.each do |location, subschema_type|
           if subschema_type.fields.keys.sort != expected_fields
             raise Composer::ValidationError, "Shared type `#{type.graphql_name}` must have consistent fields across locations,

data/lib/graphql/stitching/supergraph.rb

@@ -96,7 +96,7 @@ module GraphQL
         end
       end
 
-      # { "Type" => ["location1", "location2", ...] }
+      # "Type" => ["location1", "location2", ...]
       def locations_by_type
         @locations_by_type ||= @locations_by_type_and_field.each_with_object({}) do |(type_name, fields), memo|
           memo[type_name] = fields.values.flatten.uniq
@@ -104,7 +104,7 @@ module GraphQL
       end
 
       # collects all possible boundary keys for a given type
-      # { "Type" => ["id", ...] }
+      # ("Type") => ["id", ...]
       def possible_keys_for_type(type_name)
         @possible_keys_by_type[type_name] ||= begin
           keys = @boundaries[type_name].map { _1["selection"] }

data/lib/graphql/stitching/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Stitching
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/lib/graphql/stitching.rb

@@ -19,6 +19,56 @@ module GraphQL
       def stitching_directive_names
         [stitch_directive]
       end
+
+      def schema_from_definition(sdl, stitch_directives:)
+        ast = GraphQL.parse(sdl)
+
+        if stitch_directives&.any?
+          directive_definition = ast.definitions.find do |d|
+            d.is_a?(GraphQL::Language::Nodes::DirectiveDefinition) && d.name == stitch_directive
+          end
+
+          if !directive_definition
+            directive_sdl = "directive @#{stitch_directive}(key: String!) repeatable on FIELD_DEFINITION"
+            directive_definition = GraphQL.parse(directive_sdl).definitions.first
+            ast.send(:merge!, { definitions: [directive_definition, *ast.definitions] })
+          end
+        end
+
+        stitch_directives.each do |config|
+          config[:type_name] ||= "Query"
+
+          type_node = ast.definitions.find do |d|
+            d.is_a?(GraphQL::Language::Nodes::ObjectTypeDefinition) && d.name == config[:type_name]
+          end
+
+          raise StitchingError, "invalid type name `#{config[:type_name]}`." unless type_node
+
+          field_node = type_node.fields.find do |f|
+            f.name == config[:field_name]
+          end
+
+          raise StitchingError, "invalid field name `#{config[:field_name]}`." unless field_node
+
+          field_node.send(:merge!, {
+            directives: [
+              *field_node.directives,
+              GraphQL::Language::Nodes::Directive.new(
+                arguments: [GraphQL::Language::Nodes::Argument.new(name: "key", value: config[:key])],
+                name: stitch_directive,
+              )
+            ]
+          })
+        end
+
+        if GraphQL::Schema::BuildFromDefinition.method(:from_document).parameters.first.last == :document
+          # GraphQL v1.13.x
+          GraphQL::Schema::BuildFromDefinition.from_document(ast, default_resolve: nil)
+        else
+          # GraphQL v2
+          GraphQL::Schema::BuildFromDefinition.from_document(GraphQL::Schema, ast, default_resolve: nil)
+        end
+      end
     end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 1.13.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 1.13.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement