graphql 1.12.12 → 2.4.8

data/lib/graphql/tracing/data_dog_tracing.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "graphql/tracing/platform_tracing"
+
 module GraphQL
   module Tracing
     class DataDogTracing < PlatformTracing
@@ -15,17 +17,23 @@ module GraphQL
       }
 
       def platform_trace(platform_key, key, data)
-        tracer.trace(platform_key, service: service_name) do |span|
-          span.span_type = 'custom'
+        tracer.trace(platform_key, service: options[:service], type: 'custom') do |span|
+          span.set_tag('component', 'graphql')
+          span.set_tag('operation', key)
 
           if key == 'execute_multiplex'
             operations = data[:multiplex].queries.map(&:selected_operation_name).join(', ')
-            span.resource = operations unless operations.empty?
 
-            # 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)
+            resource = if operations.empty?
+              first_query = data[:multiplex].queries.first
+              fallback_transaction_name(first_query && first_query.context)
+            else
+              operations
             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?
           end
 
           if key == 'execute_query'
@@ -34,29 +42,33 @@ module GraphQL
             span.set_tag(:query_string, data[:query].query_string)
           end
 
+          prepare_span(key, data, span)
+
           yield
         end
       end
 
-      def service_name
-        options.fetch(:service, 'ruby-graphql')
+      # 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)
+      # @param span [Datadog::Tracing::SpanOperation] The datadog span for this event
+      def prepare_span(key, data, span)
       end
 
       def tracer
-        options.fetch(:tracer, Datadog.tracer)
-      end
+        default_tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer
 
-      def analytics_available?
-        defined?(Datadog::Contrib::Analytics) \
-          && Datadog::Contrib::Analytics.respond_to?(:enabled?) \
-          && Datadog::Contrib::Analytics.respond_to?(:set_sample_rate)
+        # [Deprecated] options[:tracer] will be removed in the future
+        options.fetch(:tracer, default_tracer)
       end
 
       def analytics_enabled?
-        analytics_available? && Datadog::Contrib::Analytics.enabled?(options.fetch(:analytics_enabled, false))
+        # [Deprecated] options[:analytics_enabled] will be removed in the future
+        options.fetch(:analytics_enabled, false)
       end
 
       def analytics_sample_rate
+        # [Deprecated] options[:analytics_sample_rate] will be removed in the future
         options.fetch(:analytics_sample_rate, 1.0)
       end
 

data/lib/graphql/{execution/instrumentation.rb → tracing/legacy_hooks_trace.rb}

@@ -1,38 +1,21 @@
 # frozen_string_literal: true
-module GraphQL
-  module Execution
-    module Instrumentation
-      # This function implements the instrumentation policy:
-      #
-      # - Instrumenters are a stack; the first `before_query` will have the last `after_query`
-      # - If a `before_` hook returned without an error, its corresponding `after_` hook will run.
-      # - If the `before_` hook did _not_ run, the `after_` hook will not be called.
-      #
-      # When errors are raised from `after_` hooks:
-      #   - Subsequent `after_` hooks _are_ called
-      #   - The first raised error is captured; later errors are ignored
-      #   - If an error was capture, it's re-raised after all hooks are finished
-      #
-      # Partial runs of instrumentation are possible:
-      # - If a `before_multiplex` hook raises an error, no `before_query` hooks will run
-      # - If a `before_query` hook raises an error, subsequent `before_query` hooks will not run (on any query)
-      def self.apply_instrumenters(multiplex)
-        schema = multiplex.schema
-        queries = multiplex.queries
-        query_instrumenters = schema.instrumenters[:query]
-        multiplex_instrumenters = schema.instrumenters[:multiplex]
 
+module GraphQL
+  module Tracing
+    module LegacyHooksTrace
+      def execute_multiplex(multiplex:)
+        multiplex_instrumenters = multiplex.schema.instrumenters[:multiplex]
+        query_instrumenters = multiplex.schema.instrumenters[:query]
         # First, run multiplex instrumentation, then query instrumentation for each query
-        call_hooks(multiplex_instrumenters, multiplex, :before_multiplex, :after_multiplex) do
-          each_query_call_hooks(query_instrumenters, queries) do
-            # Let them be executed
-            yield
+        RunHooks.call_hooks(multiplex_instrumenters, multiplex, :before_multiplex, :after_multiplex) do
+          RunHooks.each_query_call_hooks(query_instrumenters, multiplex.queries) do
+            super
           end
         end
       end
 
-      class << self
-        private
+      module RunHooks
+        module_function
         # Call the before_ hooks of each query,
         # Then yield if no errors.
         # `call_hooks` takes care of appropriate cleanup.

data/lib/graphql/tracing/legacy_trace.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "graphql/tracing/trace"
+require "graphql/tracing/call_legacy_tracers"
+
+module GraphQL
+  module Tracing
+    class LegacyTrace < Trace
+      include CallLegacyTracers
+    end
+  end
+end

data/lib/graphql/tracing/new_relic_trace.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "graphql/tracing/platform_trace"
+
+module GraphQL
+  module Tracing
+    module NewRelicTrace
+      include PlatformTrace
+
+      # @param set_transaction_name [Boolean] If true, the GraphQL operation name will be used as the transaction name.
+      #   This is not advised if you run more than one query per HTTP request, for example, with `graphql-client` or multiplexing.
+      #   It can also be specified per-query with `context[:set_new_relic_transaction_name]`.
+      def initialize(set_transaction_name: false, **_rest)
+        @set_transaction_name = set_transaction_name
+        super
+      end
+
+      def execute_query(query:)
+        set_this_txn_name =  query.context[:set_new_relic_transaction_name]
+        if set_this_txn_name == true || (set_this_txn_name.nil? && @set_transaction_name)
+          NewRelic::Agent.set_transaction_name(transaction_name(query))
+        end
+        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped("GraphQL/execute") do
+          super
+        end
+      end
+
+      {
+        "lex" => "GraphQL/lex",
+        "parse" => "GraphQL/parse",
+        "validate" => "GraphQL/validate",
+        "analyze_query" => "GraphQL/analyze",
+        "analyze_multiplex" => "GraphQL/analyze",
+        "execute_multiplex" => "GraphQL/execute",
+        "execute_query_lazy" => "GraphQL/execute",
+      }.each do |trace_method, platform_key|
+        module_eval <<-RUBY, __FILE__, __LINE__
+          def #{trace_method}(**_keys)
+            NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped("#{platform_key}") do
+              super
+            end
+          end
+        RUBY
+      end
+
+      def platform_execute_field(platform_key)
+        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
+          yield
+        end
+      end
+
+      def platform_authorized(platform_key)
+        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
+          yield
+        end
+      end
+
+      def platform_resolve_type(platform_key)
+        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
+          yield
+        end
+      end
+
+      def platform_field_key(field)
+        "GraphQL/#{field.owner.graphql_name}/#{field.graphql_name}"
+      end
+
+      def platform_authorized_key(type)
+        "GraphQL/Authorize/#{type.graphql_name}"
+      end
+
+      def platform_resolve_type_key(type)
+        "GraphQL/ResolveType/#{type.graphql_name}"
+      end
+    end
+  end
+end

data/lib/graphql/tracing/new_relic_tracing.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "graphql/tracing/platform_tracing"
+
 module GraphQL
   module Tracing
     class NewRelicTracing < PlatformTracing

data/lib/graphql/tracing/notifications_trace.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "graphql/tracing/platform_trace"
+
+module GraphQL
+  module Tracing
+    # This implementation forwards events to a notification handler (i.e.
+    # ActiveSupport::Notifications or Dry::Monitor::Notifications)
+    # with a `graphql` suffix.
+    module NotificationsTrace
+      # Initialize a new NotificationsTracing instance
+      #
+      # @param engine [#instrument(key, metadata, block)] The notifications engine to use
+      def initialize(engine:, **rest)
+        @notifications_engine = engine
+        super
+      end
+
+      {
+        "lex" => "lex.graphql",
+        "parse" => "parse.graphql",
+        "validate" => "validate.graphql",
+        "analyze_multiplex" => "analyze_multiplex.graphql",
+        "analyze_query" => "analyze_query.graphql",
+        "execute_multiplex" => "execute_multiplex.graphql",
+        "execute_query" => "execute_query.graphql",
+        "execute_query_lazy" => "execute_query_lazy.graphql",
+        "execute_field" => "execute_field.graphql",
+        "execute_field_lazy" => "execute_field_lazy.graphql",
+        "authorized" => "authorized.graphql",
+        "authorized_lazy" => "authorized_lazy.graphql",
+        "resolve_type" => "resolve_type.graphql",
+        "resolve_type_lazy" => "resolve_type.graphql",
+      }.each do |trace_method, platform_key|
+        module_eval <<-RUBY, __FILE__, __LINE__
+          def #{trace_method}(**metadata, &block)
+            @notifications_engine.instrument("#{platform_key}", metadata) { super(**metadata, &block) }
+          end
+        RUBY
+      end
+
+      include PlatformTrace
+    end
+  end
+end

data/lib/graphql/tracing/notifications_tracing.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "graphql/tracing/platform_tracing"
+
+module GraphQL
+  module Tracing
+    # This implementation forwards events to a notification handler (i.e.
+    # ActiveSupport::Notifications or Dry::Monitor::Notifications)
+    # with a `graphql` suffix.
+    #
+    # @see KEYS for event names
+    class NotificationsTracing
+      # A cache of frequently-used keys to avoid needless string allocations
+      KEYS = {
+        "lex" => "lex.graphql",
+        "parse" => "parse.graphql",
+        "validate" => "validate.graphql",
+        "analyze_multiplex" => "analyze_multiplex.graphql",
+        "analyze_query" => "analyze_query.graphql",
+        "execute_query" => "execute_query.graphql",
+        "execute_query_lazy" => "execute_query_lazy.graphql",
+        "execute_field" => "execute_field.graphql",
+        "execute_field_lazy" => "execute_field_lazy.graphql",
+        "authorized" => "authorized.graphql",
+        "authorized_lazy" => "authorized_lazy.graphql",
+        "resolve_type" => "resolve_type.graphql",
+        "resolve_type_lazy" => "resolve_type.graphql",
+      }
+
+      MAX_KEYS_SIZE = 100
+
+      # Initialize a new NotificationsTracing instance
+      #
+      # @param [Object] notifications_engine The notifications engine to use
+      def initialize(notifications_engine)
+        @notifications_engine = notifications_engine
+      end
+
+      # Sends a GraphQL tracing event to the notification handler
+      #
+      # @example
+      # . notifications_engine = Dry::Monitor::Notifications.new(:graphql)
+      # . tracer = GraphQL::Tracing::NotificationsTracing.new(notifications_engine)
+      # . tracer.trace("lex") { ... }
+      #
+      # @param [string] key The key for the event
+      # @param [Hash] metadata The metadata for the event
+      # @yield The block to execute for the event
+      def trace(key, metadata, &blk)
+        prefixed_key = KEYS[key] || "#{key}.graphql"
+
+        # Cache the new keys while making sure not to induce a memory leak
+        if KEYS.size < MAX_KEYS_SIZE
+          KEYS[key] ||= prefixed_key
+        end
+
+        @notifications_engine.instrument(prefixed_key, metadata, &blk)
+      end
+    end
+  end
+end

data/lib/graphql/tracing/null_trace.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "graphql/tracing/trace"
+
+module GraphQL
+  module Tracing
+    NullTrace = Trace.new
+  end
+end

data/lib/graphql/tracing/platform_trace.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    module PlatformTrace
+      def initialize(trace_scalars: false, **_options)
+        @trace_scalars = trace_scalars
+
+        @platform_key_cache = Hash.new { |h, mod| h[mod] = mod::KeyCache.new }
+        super
+      end
+
+      module BaseKeyCache
+        def initialize
+          @platform_field_key_cache = Hash.new { |h, k| h[k] = platform_field_key(k) }
+          @platform_authorized_key_cache = Hash.new { |h, k| h[k] = platform_authorized_key(k) }
+          @platform_resolve_type_key_cache = Hash.new { |h, k| h[k] = platform_resolve_type_key(k) }
+        end
+
+        attr_reader :platform_field_key_cache, :platform_authorized_key_cache, :platform_resolve_type_key_cache
+      end
+
+
+      def platform_execute_field_lazy(*args, &block)
+        platform_execute_field(*args, &block)
+      end
+
+      def platform_authorized_lazy(key, &block)
+        platform_authorized(key, &block)
+      end
+
+      def platform_resolve_type_lazy(key, &block)
+        platform_resolve_type(key, &block)
+      end
+
+      def self.included(child_class)
+        key_methods_class = Class.new {
+          include(child_class)
+          include(BaseKeyCache)
+        }
+        child_class.const_set(:KeyCache, key_methods_class)
+        [:execute_field, :execute_field_lazy].each do |field_trace_method|
+          if !child_class.method_defined?(field_trace_method)
+            child_class.module_eval <<-RUBY, __FILE__, __LINE__
+              def #{field_trace_method}(query:, field:, ast_node:, arguments:, object:)
+                return_type = field.type.unwrap
+                trace_field = if return_type.kind.scalar? || return_type.kind.enum?
+                  (field.trace.nil? && @trace_scalars) || field.trace
+                else
+                  true
+                end
+                platform_key = if trace_field
+                  @platform_key_cache[#{child_class}].platform_field_key_cache[field]
+                else
+                  nil
+                end
+                if platform_key && trace_field
+                  platform_#{field_trace_method}(platform_key) do
+                    super
+                  end
+                else
+                  super
+                end
+              end
+            RUBY
+          end
+        end
+
+
+        [:authorized, :authorized_lazy].each do |auth_trace_method|
+          if !child_class.method_defined?(auth_trace_method)
+            child_class.module_eval <<-RUBY, __FILE__, __LINE__
+              def #{auth_trace_method}(type:, query:, object:)
+                platform_key = @platform_key_cache[#{child_class}].platform_authorized_key_cache[type]
+                platform_#{auth_trace_method}(platform_key) do
+                  super
+                end
+              end
+            RUBY
+          end
+        end
+
+        [:resolve_type, :resolve_type_lazy].each do |rt_trace_method|
+          if !child_class.method_defined?(rt_trace_method)
+            child_class.module_eval <<-RUBY, __FILE__, __LINE__
+              def #{rt_trace_method}(query:, type:, object:)
+                platform_key = @platform_key_cache[#{child_class}].platform_resolve_type_key_cache[type]
+                platform_#{rt_trace_method}(platform_key) do
+                  super
+                end
+              end
+            RUBY
+          end
+        end
+      end
+
+      private
+
+      # Get the transaction name based on the operation type and name if possible, or fall back to a user provided
+      # one. Useful for anonymous queries.
+      def transaction_name(query)
+        selected_op = query.selected_operation
+        txn_name = if selected_op
+          op_type = selected_op.operation_type
+          op_name = selected_op.name || fallback_transaction_name(query.context) || "anonymous"
+          "#{op_type}.#{op_name}"
+        else
+          "query.anonymous"
+        end
+        "GraphQL/#{txn_name}"
+      end
+
+      def fallback_transaction_name(context)
+        context[:tracing_fallback_transaction_name]
+      end
+    end
+  end
+end

data/lib/graphql/tracing/platform_tracing.rb

@@ -10,6 +10,10 @@ module GraphQL
     class PlatformTracing
       class << self
         attr_accessor :platform_keys
+
+        def inherited(child_class)
+          child_class.platform_keys = self.platform_keys
+        end
       end
 
       def initialize(options = {})
@@ -26,25 +30,19 @@ module GraphQL
             yield
           end
         when "execute_field", "execute_field_lazy"
-          if data[:context]
-            field = data[:context].field
-            platform_key = field.metadata[:platform_key]
-            trace_field = true # implemented with instrumenter
+          field = data[:field]
+          return_type = field.type.unwrap
+          trace_field = if return_type.kind.scalar? || return_type.kind.enum?
+            (field.trace.nil? && @trace_scalars) || field.trace
           else
-            field = data[:field]
-            return_type = field.type.unwrap
-            trace_field = if return_type.kind.scalar? || return_type.kind.enum?
-              (field.trace.nil? && @trace_scalars) || field.trace
-            else
-              true
-            end
+            true
+          end
 
-            platform_key = if trace_field
-              context = data.fetch(:query).context
-              cached_platform_key(context, field) { platform_field_key(data[:owner], field) }
-            else
-              nil
-            end
+          platform_key = if trace_field
+            context = data.fetch(:query).context
+            cached_platform_key(context, field, :field) { platform_field_key(field.owner, field) }
+          else
+            nil
           end
 
           if platform_key && trace_field
@@ -57,14 +55,14 @@ module GraphQL
         when "authorized", "authorized_lazy"
           type = data.fetch(:type)
           context = data.fetch(:context)
-          platform_key = cached_platform_key(context, type) { platform_authorized_key(type) }
+          platform_key = cached_platform_key(context, type, :authorized) { platform_authorized_key(type) }
           platform_trace(platform_key, key, data) do
             yield
           end
         when "resolve_type", "resolve_type_lazy"
           type = data.fetch(:type)
           context = data.fetch(:context)
-          platform_key = cached_platform_key(context, type) { platform_resolve_type_key(type) }
+          platform_key = cached_platform_key(context, type, :resolve_type) { platform_resolve_type_key(type) }
           platform_trace(platform_key, key, data) do
             yield
           end
@@ -74,47 +72,43 @@ module GraphQL
         end
       end
 
-      def instrument(type, field)
-        return_type = field.type.unwrap
-        case return_type
-        when GraphQL::ScalarType, GraphQL::EnumType
-          if field.trace || (field.trace.nil? && @trace_scalars)
-            trace_field(type, field)
+      def self.use(schema_defn, options = {})
+        if options[:legacy_tracing]
+          tracer = self.new(**options)
+          schema_defn.tracer(tracer)
+        else
+          tracing_name = self.name.split("::").last
+          trace_name = tracing_name.sub("Tracing", "Trace")
+          if GraphQL::Tracing.const_defined?(trace_name, false)
+            trace_module = GraphQL::Tracing.const_get(trace_name)
+            warn("`use(#{self.name})` is deprecated, use the equivalent `trace_with(#{trace_module.name})` instead. More info: https://graphql-ruby.org/queries/tracing.html")
+            schema_defn.trace_with(trace_module, **options)
           else
-            field
+            warn("`use(#{self.name})` and `Tracing::PlatformTracing` are deprecated. Use a `trace_with(...)` module instead. More info: https://graphql-ruby.org/queries/tracing.html. Please open an issue on the GraphQL-Ruby repo if you want to discuss further!")
+            tracer = self.new(**options)
+          schema_defn.tracer(tracer, silence_deprecation_warning: true)
           end
-        else
-          trace_field(type, field)
         end
       end
 
-      def trace_field(type, field)
-        new_f = field.redefine
-        new_f.metadata[:platform_key] = platform_field_key(type, field)
-        new_f
-      end
-
-      def self.use(schema_defn, options = {})
-        tracer = self.new(**options)
-        if !schema_defn.is_a?(Class)
-          schema_defn.instrument(:field, tracer)
-        end
-        schema_defn.tracer(tracer)
-      end
-
       private
 
-      # Get the transaction name based on the operation type and name
+      # Get the transaction name based on the operation type and name if possible, or fall back to a user provided
+      # one. Useful for anonymous queries.
       def transaction_name(query)
         selected_op = query.selected_operation
-        if selected_op
+        txn_name = if selected_op
           op_type = selected_op.operation_type
-          op_name = selected_op.name || "anonymous"
+          op_name = selected_op.name || fallback_transaction_name(query.context) || "anonymous"
+          "#{op_type}.#{op_name}"
         else
-          op_type = "query"
-          op_name = "anonymous"
+          "query.anonymous"
         end
-        "GraphQL/#{op_type}.#{op_name}"
+        "GraphQL/#{txn_name}"
+      end
+
+      def fallback_transaction_name(context)
+        context[:tracing_fallback_transaction_name]
       end
 
       attr_reader :options
@@ -129,8 +123,11 @@ module GraphQL
       #
       # If the key isn't present, the given block is called and the result is cached for `key`.
       #
+      # @param ctx [GraphQL::Query::Context]
+      # @param key [Class, GraphQL::Field] A part of the schema
+      # @param trace_phase [Symbol] The stage of execution being traced (used by OpenTelementry tracing)
       # @return [String]
-      def cached_platform_key(ctx, key)
+      def cached_platform_key(ctx, key, trace_phase)
         cache = ctx.namespace(self.class)[:platform_key_cache] ||= {}
         cache.fetch(key) { cache[key] = yield }
       end

data/lib/graphql/tracing/{prometheus_tracing → prometheus_trace}/graphql_collector.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require "graphql/tracing"
+
 module GraphQL
   module Tracing
-    class PrometheusTracing < PlatformTracing
+    module PrometheusTrace
       class GraphQLCollector < ::PrometheusExporter::Server::TypeCollector
         def initialize
-          @graphql_gauge = PrometheusExporter::Metric::Summary.new(
+          @graphql_gauge = PrometheusExporter::Metric::Base.default_aggregation.new(
             'graphql_duration_seconds',
             'Time spent in GraphQL operations, in seconds'
           )
@@ -28,5 +30,7 @@ module GraphQL
         end
       end
     end
+    # Backwards-compat:
+    PrometheusTracing::GraphQLCollector = PrometheusTrace::GraphQLCollector
   end
 end