graphql-stitching 1.4.3 → 1.5.1

data/lib/graphql/stitching/{resolver → type_resolver}/arguments.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module GraphQL::Stitching
-  class Resolver
+  class TypeResolver
     # Defines a single resolver argument structure
     # @api private
     class Argument
@@ -129,9 +129,9 @@ module GraphQL::Stitching
       end
 
       def verify_key(arg, key)
-        key_field = value.reduce(Resolver::KeyField.new("", inner: key)) do |field, ns|
-          if ns == Resolver::TYPE_NAME
-            Resolver::KeyField.new(Resolver::TYPE_NAME)
+        key_field = value.reduce(TypeResolver::KeyField.new("", inner: key)) do |field, ns|
+          if ns == TYPENAME
+            TypeResolver::KeyField.new(TYPENAME)
           elsif field
             field.inner.find { _1.name == ns }
           end
@@ -146,7 +146,7 @@ module GraphQL::Stitching
 
       def build(origin_obj)
         value.each_with_index.reduce(origin_obj) do |obj, (ns, idx)|
-          obj[idx.zero? ? Resolver.export_key(ns) : ns]
+          obj[idx.zero? ? TypeResolver.export_key(ns) : ns]
         end
       end
 
@@ -174,7 +174,7 @@ module GraphQL::Stitching
       # Parses an argument template string into resolver arguments via schema casting.
       # @param template [String] the template string to parse.
       # @param field_def [GraphQL::Schema::FieldDefinition] a field definition providing arguments schema.
-      # @return [[GraphQL::Stitching::Resolver::Argument]] an array of resolver arguments.
+      # @return [[GraphQL::Stitching::TypeResolver::Argument]] an array of resolver arguments.
       def parse_arguments_with_field(template, field_def)
         ast = parse_arg_defs(template)
         args = build_argument_set(ast, field_def.arguments)
@@ -196,7 +196,7 @@ module GraphQL::Stitching
       # Parses an argument template string into resolver arguments via SDL casting.
       # @param template [String] the template string to parse.
       # @param type_defs [String] the type definition string declaring argument types.
-      # @return [[GraphQL::Stitching::Resolver::Argument]] an array of resolver arguments.
+      # @return [[GraphQL::Stitching::TypeResolver::Argument]] an array of resolver arguments.
       def parse_arguments_with_type_defs(template, type_defs)
         type_map = parse_type_defs(type_defs)
         parse_arg_defs(template).map { build_argument(_1, type_struct: type_map[_1.name]) }

data/lib/graphql/stitching/{resolver → type_resolver}/keys.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
 module GraphQL::Stitching
-  class Resolver
+  class TypeResolver
     EXPORT_PREFIX = "_export_"
-    TYPE_NAME = "__typename"
 
     class FieldNode
       # GraphQL Ruby changed the argument assigning Field.alias from
@@ -59,8 +58,8 @@ module GraphQL::Stitching
 
     EMPTY_FIELD_SET = KeyFieldSet.new(GraphQL::Stitching::EMPTY_ARRAY)
     TYPENAME_EXPORT_NODE = FieldNode.build(
-      field_alias: "#{EXPORT_PREFIX}#{TYPE_NAME}",
-      field_name: TYPE_NAME,
+      field_alias: "#{EXPORT_PREFIX}#{TYPENAME}",
+      field_name: TYPENAME,
     )
 
     class Key < KeyFieldSet

data/lib/graphql/stitching/{resolver.rb → type_resolver.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "./resolver/arguments"
-require_relative "./resolver/keys"
+require_relative "type_resolver/arguments"
+require_relative "type_resolver/keys"
 
 module GraphQL
   module Stitching
-    # Defines a root resolver query that provides direct access to an entity type.
-    class Resolver
+    # Defines a type resolver query that provides direct access to an entity type.
+    class TypeResolver
       extend ArgumentsParser
       extend KeysParser
 
@@ -47,7 +47,7 @@ module GraphQL
       end
 
       def version
-        @version ||= Digest::SHA2.hexdigest("#{Stitching::VERSION}/#{as_json.to_json}")
+        @version ||= Stitching.digest.call("#{Stitching::VERSION}/#{as_json.to_json}")
       end
 
       def ==(other)

data/lib/graphql/stitching/util.rb

@@ -2,6 +2,7 @@
 
 module GraphQL
   module Stitching
+    # General utilities to aid with stitching.
     class Util
       TypeStructure = Struct.new(:list, :null, :name, keyword_init: true) do
         alias_method :list?, :list

data/lib/graphql/stitching/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Stitching
-    VERSION = "1.4.3"
+    VERSION = "1.5.1"
   end
 end

data/lib/graphql/stitching.rb

@@ -4,7 +4,22 @@ require "graphql"
 
 module GraphQL
   module Stitching
+    # scope name of query operations.
+    QUERY_OP = "query"
+    
+    # scope name of mutation operations.
+    MUTATION_OP = "mutation"
+    
+    # scope name of subscription operations.
+    SUBSCRIPTION_OP = "subscription"
+    
+    # introspection typename field.
+    TYPENAME = "__typename"
+
+    # @api private
     EMPTY_OBJECT = {}.freeze
+
+    # @api private
     EMPTY_ARRAY = [].freeze
 
     class StitchingError < StandardError; end
@@ -12,12 +27,26 @@ module GraphQL
     class ValidationError < CompositionError; end
 
     class << self
+      attr_writer :stitch_directive
+
+      # Proc used to compute digests; uses SHA2 by default.
+      # @returns [Proc] proc used to compute digests.
+      def digest(&block)
+        if block_given?
+          @digest = block
+        else
+          @digest ||= ->(str) { Digest::SHA2.hexdigest(str) }
+        end
+      end
+
+      # Name of the directive used to mark type resolvers.
+      # @returns [String] name of the type resolver directive.
       def stitch_directive
         @stitch_directive ||= "stitch"
       end
 
-      attr_writer :stitch_directive
-
+      # Names of stitching directives to omit from the composed supergraph.
+      # @returns [Array<String>] list of stitching directive names.
       def stitching_directive_names
         [stitch_directive]
       end
@@ -33,7 +62,6 @@ require_relative "stitching/http_executable"
 require_relative "stitching/plan"
 require_relative "stitching/planner"
 require_relative "stitching/request"
-require_relative "stitching/resolver"
-require_relative "stitching/skip_include"
+require_relative "stitching/type_resolver"
 require_relative "stitching/util"
 require_relative "stitching/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.1
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -89,8 +89,9 @@ files:
 - docs/images/stitching.png
 - docs/mechanics.md
 - docs/request.md
-- docs/resolver.md
+- docs/subscriptions.md
 - docs/supergraph.md
+- docs/type_resolver.md
 - examples/file_uploads/Gemfile
 - examples/file_uploads/Procfile
 - examples/file_uploads/README.md
@@ -105,6 +106,51 @@ files:
 - examples/merged_types/graphiql.html
 - examples/merged_types/remote1.rb
 - examples/merged_types/remote2.rb
+- examples/subscriptions/.gitattributes
+- examples/subscriptions/.gitignore
+- examples/subscriptions/Gemfile
+- examples/subscriptions/README.md
+- examples/subscriptions/Rakefile
+- examples/subscriptions/app/channels/graphql_channel.rb
+- examples/subscriptions/app/controllers/graphql_controller.rb
+- examples/subscriptions/app/graphql/entities_schema.rb
+- examples/subscriptions/app/graphql/stitched_schema.rb
+- examples/subscriptions/app/graphql/subscriptions_schema.rb
+- examples/subscriptions/app/models/repository.rb
+- examples/subscriptions/app/views/graphql/client.html.erb
+- examples/subscriptions/bin/bundle
+- examples/subscriptions/bin/docker-entrypoint
+- examples/subscriptions/bin/importmap
+- examples/subscriptions/bin/rails
+- examples/subscriptions/bin/rake
+- examples/subscriptions/bin/setup
+- examples/subscriptions/config.ru
+- examples/subscriptions/config/application.rb
+- examples/subscriptions/config/boot.rb
+- examples/subscriptions/config/cable.yml
+- examples/subscriptions/config/credentials.yml.enc
+- examples/subscriptions/config/database.yml
+- examples/subscriptions/config/environment.rb
+- examples/subscriptions/config/environments/development.rb
+- examples/subscriptions/config/environments/production.rb
+- examples/subscriptions/config/environments/test.rb
+- examples/subscriptions/config/initializers/content_security_policy.rb
+- examples/subscriptions/config/initializers/filter_parameter_logging.rb
+- examples/subscriptions/config/initializers/inflections.rb
+- examples/subscriptions/config/initializers/permissions_policy.rb
+- examples/subscriptions/config/locales/en.yml
+- examples/subscriptions/config/master.key
+- examples/subscriptions/config/puma.rb
+- examples/subscriptions/config/routes.rb
+- examples/subscriptions/config/storage.yml
+- examples/subscriptions/db/seeds.rb
+- examples/subscriptions/public/404.html
+- examples/subscriptions/public/422.html
+- examples/subscriptions/public/500.html
+- examples/subscriptions/public/apple-touch-icon-precomposed.png
+- examples/subscriptions/public/apple-touch-icon.png
+- examples/subscriptions/public/favicon.ico
+- examples/subscriptions/public/robots.txt
 - gemfiles/graphql_1.13.9.gemfile
 - gemfiles/graphql_2.0.0.gemfile
 - gemfiles/graphql_2.1.0.gemfile
@@ -114,27 +160,27 @@ files:
 - lib/graphql/stitching/client.rb
 - lib/graphql/stitching/composer.rb
 - lib/graphql/stitching/composer/base_validator.rb
-- lib/graphql/stitching/composer/resolver_config.rb
+- lib/graphql/stitching/composer/type_resolver_config.rb
 - lib/graphql/stitching/composer/validate_interfaces.rb
-- lib/graphql/stitching/composer/validate_resolvers.rb
+- lib/graphql/stitching/composer/validate_type_resolvers.rb
 - lib/graphql/stitching/executor.rb
-- lib/graphql/stitching/executor/resolver_source.rb
 - lib/graphql/stitching/executor/root_source.rb
 - lib/graphql/stitching/executor/shaper.rb
+- lib/graphql/stitching/executor/type_resolver_source.rb
 - lib/graphql/stitching/http_executable.rb
 - lib/graphql/stitching/plan.rb
 - lib/graphql/stitching/planner.rb
 - lib/graphql/stitching/planner/step.rb
 - lib/graphql/stitching/request.rb
-- lib/graphql/stitching/resolver.rb
-- lib/graphql/stitching/resolver/arguments.rb
-- lib/graphql/stitching/resolver/keys.rb
-- lib/graphql/stitching/skip_include.rb
+- lib/graphql/stitching/request/skip_include.rb
 - lib/graphql/stitching/supergraph.rb
 - lib/graphql/stitching/supergraph/key_directive.rb
 - lib/graphql/stitching/supergraph/resolver_directive.rb
 - lib/graphql/stitching/supergraph/source_directive.rb
 - lib/graphql/stitching/supergraph/to_definition.rb
+- lib/graphql/stitching/type_resolver.rb
+- lib/graphql/stitching/type_resolver/arguments.rb
+- lib/graphql/stitching/type_resolver/keys.rb
 - lib/graphql/stitching/util.rb
 - lib/graphql/stitching/version.rb
 homepage: https://github.com/gmac/graphql-stitching-ruby