graphql 2.1.11 → 2.2.0

data/lib/graphql/language/printer.rb

@@ -337,14 +337,16 @@ module GraphQL
         print_string("union ")
         print_string(union_type.name)
         print_directives(union_type.directives)
-        print_string(" = ")
-        i = 0
-        union_type.types.each do |t|
-          if i > 0
-            print_string(" | ")
+        if union_type.types.any?
+          print_string(" = ")
+          i = 0
+          union_type.types.each do |t|
+            if i > 0
+              print_string(" | ")
+            end
+            print_string(t.name)
+            i += 1
           end
-          print_string(t.name)
-          i += 1
         end
       end
 
@@ -353,12 +355,14 @@ module GraphQL
         print_string("enum ")
         print_string(enum_type.name)
         print_directives(enum_type.directives)
-        print_string(" {\n")
-        enum_type.values.each.with_index do |value, i|
-          print_description(value, indent: "  ", first_in_block: i == 0)
-          print_enum_value_definition(value)
+        if enum_type.values.any?
+          print_string(" {\n")
+          enum_type.values.each.with_index do |value, i|
+            print_description(value, indent: "  ", first_in_block: i == 0)
+            print_enum_value_definition(value)
+          end
+          print_string("}")
         end
-        print_string("}")
       end
 
       def print_enum_value_definition(enum_value)

data/lib/graphql/schema.rb

@@ -384,6 +384,11 @@ module GraphQL
           (superclass.respond_to?(:get_type) ? superclass.get_type(type_name, context) : nil)
       end
 
+      # @return [Boolean] Does this schema have _any_ definition for a type named `type_name`, regardless of visibility?
+      def has_defined_type?(type_name)
+        own_types.key?(type_name) || introspection_system.types.key?(type_name) || (superclass.respond_to?(:has_defined_type?) ? superclass.has_defined_type?(type_name) : false)
+      end
+
       # @api private
       attr_writer :connections
 
@@ -939,11 +944,7 @@ module GraphQL
       end
 
       def resolve_type(type, obj, ctx)
-        if type.kind.object?
-          type
-        else
-          raise GraphQL::RequiredImplementationMissingError, "#{self.name}.resolve_type(type, obj, ctx) must be implemented to use Union types or Interface types (tried to resolve: #{type.name})"
-        end
+        raise GraphQL::RequiredImplementationMissingError, "#{self.name}.resolve_type(type, obj, ctx) must be implemented to use Union types, Interface types, or `loads:` (tried to resolve: #{type.name})"
       end
       # rubocop:enable Lint/DuplicateMethods
 

data/lib/graphql/testing/helpers.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+module GraphQL
+  module Testing
+    module Helpers
+      # @param schema_class [Class<GraphQL::Schema>]
+      # @return [Module] A helpers module which always uses the given schema
+      def self.for(schema_class)
+        Module.new do
+          include SchemaHelpers
+          @@schema_class_for_helpers = schema_class
+        end
+      end
+
+      class Error < GraphQL::Error
+      end
+
+      class TypeNotVisibleError < Error
+        def initialize(type_name:)
+          message = "`#{type_name}` should be `visible?` this field resolution and `context`, but it was not"
+          super(message)
+        end
+      end
+
+      class FieldNotVisibleError < Error
+        def initialize(type_name:, field_name:)
+          message = "`#{type_name}.#{field_name}` should be `visible?` for this resolution, but it was not"
+          super(message)
+        end
+      end
+
+      class TypeNotDefinedError < Error
+        def initialize(type_name:)
+          message = "No type named `#{type_name}` is defined; choose another type name or define this type."
+          super(message)
+        end
+      end
+
+      class FieldNotDefinedError < Error
+        def initialize(type_name:, field_name:)
+          message = "`#{type_name}` has no field named `#{field_name}`; pick another name or define this field."
+          super(message)
+        end
+      end
+
+      def run_graphql_field(schema, field_path, object, arguments: {}, context: {})
+        type_name, *field_names = field_path.split(".")
+        dummy_query = GraphQL::Query.new(schema, context: context)
+        query_context = dummy_query.context
+        object_type = dummy_query.get_type(type_name) # rubocop:disable Development/ContextIsPassedCop
+        if object_type
+          graphql_result = object
+          field_names.each do |field_name|
+            inner_object = graphql_result
+            graphql_result = object_type.wrap(inner_object, query_context)
+            if graphql_result.nil?
+              return nil
+            end
+            visible_field = dummy_query.get_field(object_type, field_name)
+            if visible_field
+              dummy_query.context.dataloader.run_isolated {
+                field_args = visible_field.coerce_arguments(graphql_result, arguments, query_context)
+                field_args = schema.sync_lazy(field_args)
+                graphql_result = visible_field.resolve(graphql_result, field_args.keyword_arguments, query_context)
+                graphql_result = schema.sync_lazy(graphql_result)
+              }
+              object_type = visible_field.type.unwrap
+            elsif object_type.all_field_definitions.any? { |f| f.graphql_name == field_name }
+              raise FieldNotVisibleError.new(field_name: field_name, type_name: type_name)
+            else
+              raise FieldNotDefinedError.new(type_name: type_name, field_name: field_name)
+            end
+          end
+          graphql_result
+        elsif schema.has_defined_type?(type_name)
+          raise TypeNotVisibleError.new(type_name: type_name)
+        else
+          raise TypeNotDefinedError.new(type_name: type_name)
+        end
+      end
+
+      def with_resolution_context(schema, type:, object:, context:{})
+        resolution_context = ResolutionAssertionContext.new(
+          self,
+          schema: schema,
+          type_name: type,
+          object: object,
+          context: context
+        )
+        yield(resolution_context)
+      end
+
+      class ResolutionAssertionContext
+        def initialize(test, type_name:, object:, schema:, context:)
+          @test = test
+          @type_name = type_name
+          @object = object
+          @schema = schema
+          @context = context
+        end
+
+
+        def run_graphql_field(field_name, arguments: {})
+          if @schema
+            @test.run_graphql_field(@schema, "#{@type_name}.#{field_name}", @object, arguments: arguments, context: @context)
+          else
+            @test.run_graphql_field("#{@type_name}.#{field_name}", @object, arguments: arguments, context: @context)
+          end
+        end
+      end
+
+      module SchemaHelpers
+        include Helpers
+
+        def run_graphql_field(field_path, object, arguments: {}, context: {})
+          super(@@schema_class_for_helpers, field_path, object, arguments: arguments, context: context)
+        end
+
+        def with_resolution_context(*args, **kwargs, &block)
+          # schema will be added later
+          super(nil, *args, **kwargs, &block)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/testing.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require "graphql/testing/helpers"

data/lib/graphql/tracing/data_dog_trace.rb

@@ -3,18 +3,20 @@
 module GraphQL
   module Tracing
     module DataDogTrace
-      # @param tracer [#trace] Deprecated
       # @param analytics_enabled [Boolean] Deprecated
       # @param analytics_sample_rate [Float] Deprecated
-      def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: nil, **rest)
+      def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: "ruby-graphql", **rest)
         if tracer.nil?
           tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer
         end
         @tracer = tracer
 
-        @analytics_enabled = analytics_enabled
-        @analytics_sample_rate = analytics_sample_rate
+        analytics_available = defined?(Datadog::Contrib::Analytics) \
+            && Datadog::Contrib::Analytics.respond_to?(:enabled?) \
+            && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate)
 
+        @analytics_enabled = analytics_available && Datadog::Contrib::Analytics.enabled?(analytics_enabled)
+        @analytics_sample_rate = analytics_sample_rate
         @service_name = service
         @has_prepare_span = respond_to?(:prepare_span)
         super
@@ -32,9 +34,12 @@ module GraphQL
       }.each do |trace_method, trace_key|
         module_eval <<-RUBY, __FILE__, __LINE__
           def #{trace_method}(**data)
-            @tracer.trace("#{trace_key}", service: @service_name, type: 'custom') do |span|
-                span.set_tag('component', 'graphql')
-                span.set_tag('operation', '#{trace_method}')
+            @tracer.trace("#{trace_key}", service: @service_name) do |span|
+              span.span_type = 'custom'
+              if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+                span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+                span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, '#{trace_method}')
+              end
 
               #{
                 if trace_method == 'execute_multiplex'
@@ -49,8 +54,10 @@ module GraphQL
                   end
                   span.resource = resource if resource
 
-                  # [Deprecated] will be removed in the future
-                  span.set_metric('_dd1.sr.eausr', @analytics_sample_rate) if @analytics_enabled
+                  # For top span of query, set the analytics sample rate tag, if available.
+                  if @analytics_enabled
+                    Datadog::Contrib::Analytics.set_sample_rate(span, @analytics_sample_rate)
+                  end
                   RUBY
                 elsif trace_method == 'execute_query'
                   <<-RUBY
@@ -82,10 +89,12 @@ module GraphQL
           nil
         end
         if platform_key && trace_field
-          @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-            span.set_tag('component', 'graphql')
-            span.set_tag('operation', span_key)
-
+          @tracer.trace(platform_key, service: @service_name) do |span|
+            span.span_type = 'custom'
+            if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+              span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+              span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, span_key)
+            end
             if @has_prepare_span
               prepare_span_data = { query: query, field: field, ast_node: ast_node, arguments: arguments, object: object }
               prepare_span(span_key, prepare_span_data, span)
@@ -116,10 +125,12 @@ module GraphQL
 
       def authorized_span(span_key, object, type, query)
         platform_key = @platform_key_cache[DataDogTrace].platform_authorized_key_cache[type]
-        @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', span_key)
-
+        @tracer.trace(platform_key, service: @service_name) do |span|
+          span.span_type = 'custom'
+          if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, span_key)
+          end
           if @has_prepare_span
             prepare_span(span_key, {object: object, type: type, query: query}, span)
           end
@@ -147,10 +158,12 @@ module GraphQL
 
       def resolve_type_span(span_key, object, type, query)
         platform_key = @platform_key_cache[DataDogTrace].platform_resolve_type_key_cache[type]
-        @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', span_key)
-
+        @tracer.trace(platform_key, service: @service_name) do |span|
+          span.span_type = 'custom'
+          if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, span_key)
+          end
           if @has_prepare_span
             prepare_span(span_key, {object: object, type: type, query: query}, span)
           end

data/lib/graphql/tracing/data_dog_tracing.rb

@@ -15,9 +15,12 @@ module GraphQL
       }
 
       def platform_trace(platform_key, key, data)
-        tracer.trace(platform_key, service: options[:service], type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', key)
+        tracer.trace(platform_key, service: service_name) do |span|
+          span.span_type = 'custom'
+          if defined?(Datadog::Tracing::Metadata::Ext) # Introduced in ddtrace 1.0
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, 'graphql')
+            span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, key)
+          end
 
           if key == 'execute_multiplex'
             operations = data[:multiplex].queries.map(&:selected_operation_name).join(', ')
@@ -30,8 +33,10 @@ module GraphQL
             end
             span.resource = resource if resource
 
-            # [Deprecated] will be removed in the future
-            span.set_metric('_dd1.sr.eausr', analytics_sample_rate) if analytics_enabled?
+            # For top span of query, set the analytics sample rate tag, if available.
+            if analytics_enabled?
+              Datadog::Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
+            end
           end
 
           if key == 'execute_query'
@@ -46,6 +51,10 @@ module GraphQL
         end
       end
 
+      def service_name
+        options.fetch(:service, 'ruby-graphql')
+      end
+
       # Implement this method in a subclass to apply custom tags to datadog spans
       # @param key [String] The event being traced
       # @param data [Hash] The runtime data for this event (@see GraphQL::Tracing for keys for each event)
@@ -56,13 +65,18 @@ module GraphQL
       def tracer
         default_tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer
 
-        # [Deprecated] options[:tracer] will be removed in the future
         options.fetch(:tracer, default_tracer)
       end
 
+      def analytics_available?
+        defined?(Datadog::Contrib::Analytics) \
+          && Datadog::Contrib::Analytics.respond_to?(:enabled?) \
+          && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate)
+      end
+
       def analytics_enabled?
         # [Deprecated] options[:analytics_enabled] will be removed in the future
-        options.fetch(:analytics_enabled, false)
+        analytics_available? && Datadog::Contrib::Analytics.enabled?(options.fetch(:analytics_enabled, false))
       end
 
       def analytics_sample_rate

data/lib/graphql/tracing/trace.rb

@@ -15,6 +15,7 @@ module GraphQL
         @query = query
       end
 
+      # The Ruby parser doesn't call this method (`graphql/c_parser` does.)
       def lex(query_string:)
         yield
       end

data/lib/graphql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module GraphQL
-  VERSION = "2.1.11"
+  VERSION = "2.2.0"
 end

data/lib/graphql.rb

@@ -121,3 +121,4 @@ require "graphql/unauthorized_error"
 require "graphql/unauthorized_field_error"
 require "graphql/load_application_object_failed_error"
 require "graphql/deprecation"
+require "graphql/testing"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql
 version: !ruby/object:Gem::Version
-  version: 2.1.11
+  version: 2.2.0
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -309,6 +309,7 @@ files:
 - lib/graphql/backtrace/tracer.rb
 - lib/graphql/coercion_error.rb
 - lib/graphql/dataloader.rb
+- lib/graphql/dataloader/async_dataloader.rb
 - lib/graphql/dataloader/null_dataloader.rb
 - lib/graphql/dataloader/request.rb
 - lib/graphql/dataloader/request_all.rb
@@ -360,7 +361,6 @@ files:
 - lib/graphql/language/lexer.rb
 - lib/graphql/language/nodes.rb
 - lib/graphql/language/parser.rb
-- lib/graphql/language/parser.y
 - lib/graphql/language/printer.rb
 - lib/graphql/language/sanitized_printer.rb
 - lib/graphql/language/static_visitor.rb
@@ -553,6 +553,8 @@ files:
 - lib/graphql/subscriptions/event.rb
 - lib/graphql/subscriptions/instrumentation.rb
 - lib/graphql/subscriptions/serialize.rb
+- lib/graphql/testing.rb
+- lib/graphql/testing/helpers.rb
 - lib/graphql/tracing.rb
 - lib/graphql/tracing/active_support_notifications_trace.rb
 - lib/graphql/tracing/active_support_notifications_tracing.rb
@@ -629,7 +631,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A GraphQL language and runtime for Ruby