graphql 2.4.3 → 2.5.2

data/lib/graphql/tracing/monitor_trace.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    # This module is the basis for Ruby-level integration with third-party monitoring platforms.
+    # Platform-specific traces include this module and implement an adapter.
+    #
+    # @see ActiveSupportNotificationsTrace Integration via ActiveSupport::Notifications, an alternative approach.
+    module MonitorTrace
+      class Monitor
+        def initialize(trace:, set_transaction_name:, **_rest)
+          @trace = trace
+          @set_transaction_name = set_transaction_name
+          @platform_field_key_cache = Hash.new { |h, k| h[k] = platform_field_key(k) }.compare_by_identity
+          @platform_authorized_key_cache = Hash.new { |h, k| h[k] = platform_authorized_key(k) }.compare_by_identity
+          @platform_resolve_type_key_cache = Hash.new { |h, k| h[k] = platform_resolve_type_key(k) }.compare_by_identity
+          @platform_source_class_key_cache = Hash.new { |h, source_cls| h[source_cls] = platform_source_class_key(source_cls) }.compare_by_identity
+        end
+
+        def instrument(keyword, object, &block)
+          raise "Implement #{self.class}#instrument to measure the block"
+        end
+
+        def start_event(keyword, object)
+          ev = self.class::Event.new(self, keyword, object)
+          ev.start
+          ev
+        end
+
+        # 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
+
+        def name_for(keyword, object)
+          case keyword
+          when :execute_field
+            @platform_field_key_cache[object]
+          when :authorized
+            @platform_authorized_key_cache[object]
+          when :resolve_type
+            @platform_resolve_type_key_cache[object]
+          when :dataloader_source
+            @platform_source_class_key_cache[object.class]
+          when :parse then self.class::PARSE_NAME
+          when :lex then self.class::LEX_NAME
+          when :execute then self.class::EXECUTE_NAME
+          when :analyze then self.class::ANALYZE_NAME
+          when :validate then self.class::VALIDATE_NAME
+          else
+            raise "No name for #{keyword.inspect}"
+          end
+        end
+
+        class Event
+          def initialize(monitor, keyword, object)
+            @monitor = monitor
+            @keyword = keyword
+            @object = object
+          end
+
+          attr_reader :keyword, :object
+
+          def start
+            raise "Implement #{self.class}#start to begin a new event (#{inspect})"
+          end
+
+          def finish
+            raise "Implement #{self.class}#finish to end this event (#{inspect})"
+          end
+        end
+
+        module GraphQLSuffixNames
+          PARSE_NAME = "parse.graphql"
+          LEX_NAME = "lex.graphql"
+          VALIDATE_NAME = "validate.graphql"
+          EXECUTE_NAME = "execute.graphql"
+          ANALYZE_NAME = "analyze.graphql"
+
+          def platform_field_key(field)
+            "#{field.path}.graphql"
+          end
+
+          def platform_authorized_key(type)
+            "#{type.graphql_name}.authorized.graphql"
+          end
+
+          def platform_resolve_type_key(type)
+            "#{type.graphql_name}.resolve_type.graphql"
+          end
+
+          def platform_source_class_key(source_class)
+            "#{source_class.name.gsub("::", "_")}.fetch.graphql"
+          end
+        end
+
+        module GraphQLPrefixNames
+          PARSE_NAME = "graphql.parse"
+          LEX_NAME = "graphql.lex"
+          VALIDATE_NAME = "graphql.validate"
+          EXECUTE_NAME = "graphql.execute"
+          ANALYZE_NAME = "graphql.analyze"
+
+          def platform_field_key(field)
+            "graphql.#{field.path}"
+          end
+
+          def platform_authorized_key(type)
+            "graphql.authorized.#{type.graphql_name}"
+          end
+
+          def platform_resolve_type_key(type)
+            "graphql.resolve_type.#{type.graphql_name}"
+          end
+
+          def platform_source_class_key(source_class)
+            "graphql.fetch.#{source_class.name.gsub("::", "_")}"
+          end
+        end
+      end
+
+      def self.create_module(monitor_name)
+        if !monitor_name.match?(/[a-z]+/)
+          raise ArgumentError, "monitor name must be [a-z]+, not: #{monitor_name.inspect}"
+        end
+
+        trace_module = Module.new
+        code = MODULE_TEMPLATE % {
+          monitor: monitor_name,
+          monitor_class: monitor_name.capitalize + "Monitor",
+        }
+        trace_module.module_eval(code, __FILE__, __LINE__ + 5) # rubocop:disable Development/NoEvalCop This is build-time with a validated string
+        trace_module
+      end
+
+      MODULE_TEMPLATE = <<~RUBY
+        # @param set_transaction_name [Boolean] If `true`, use the GraphQL operation name as the request name on the monitoring platform
+        # @param trace_scalars [Boolean] If `true`, leaf fields will be traced too (Scalars _and_ Enums)
+        # @param trace_authorized [Boolean] If `false`, skip tracing `authorized?` calls
+        # @param trace_resolve_type [Boolean] If `false`, skip tracing `resolve_type?` calls
+        def initialize(...)
+          setup_%{monitor}_monitor(...)
+          super
+        end
+
+        def setup_%{monitor}_monitor(trace_scalars: false, trace_authorized: true, trace_resolve_type: true, set_transaction_name: false, **kwargs)
+          @trace_scalars = trace_scalars
+          @trace_authorized = trace_authorized
+          @trace_resolve_type = trace_resolve_type
+          @set_transaction_name = set_transaction_name
+          @%{monitor} = %{monitor_class}.new(trace: self, set_transaction_name: @set_transaction_name, **kwargs)
+        end
+
+        def parse(query_string:)
+          @%{monitor}.instrument(:parse, query_string) do
+            super
+          end
+        end
+
+        def lex(query_string:)
+          @%{monitor}.instrument(:lex, query_string) do
+            super
+          end
+        end
+
+        def validate(query:, validate:)
+          @%{monitor}.instrument(:validate, query) do
+            super
+          end
+        end
+
+        def begin_analyze_multiplex(multiplex, analyzers)
+          begin_%{monitor}_event(:analyze, nil)
+          super
+        end
+
+        def end_analyze_multiplex(multiplex, analyzers)
+          finish_%{monitor}_event
+          super
+        end
+
+        def execute_multiplex(multiplex:)
+          @%{monitor}.instrument(:execute, multiplex) do
+            super
+          end
+        end
+
+        def begin_execute_field(field, object, arguments, query)
+          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
+
+          if trace_field
+            begin_%{monitor}_event(:execute_field, field)
+          end
+          super
+        end
+
+        def end_execute_field(field, object, arguments, query, result)
+          finish_%{monitor}_event
+          super
+        end
+
+        def dataloader_fiber_yield(source)
+          Fiber[PREVIOUS_EV_KEY] = finish_%{monitor}_event
+          super
+        end
+
+        def dataloader_fiber_resume(source)
+          prev_ev = Fiber[PREVIOUS_EV_KEY]
+          if prev_ev
+            begin_%{monitor}_event(prev_ev.keyword, prev_ev.object)
+          end
+          super
+        end
+
+        def begin_authorized(type, object, context)
+          @trace_authorized && begin_%{monitor}_event(:authorized, type)
+          super
+        end
+
+        def end_authorized(type, object, context, result)
+          finish_%{monitor}_event
+          super
+        end
+
+        def begin_resolve_type(type, value, context)
+          @trace_resolve_type && begin_%{monitor}_event(:resolve_type, type)
+          super
+        end
+
+        def end_resolve_type(type, value, context, resolved_type)
+          finish_%{monitor}_event
+          super
+        end
+
+        def begin_dataloader_source(source)
+          begin_%{monitor}_event(:dataloader_source, source)
+          super
+        end
+
+        def end_dataloader_source(source)
+          finish_%{monitor}_event
+          super
+        end
+
+        CURRENT_EV_KEY = :__graphql_%{monitor}_trace_event
+        PREVIOUS_EV_KEY = :__graphql_%{monitor}_trace_previous_event
+
+        private
+
+        def begin_%{monitor}_event(keyword, object)
+          Fiber[CURRENT_EV_KEY] = @%{monitor}.start_event(keyword, object)
+        end
+
+        def finish_%{monitor}_event
+          if ev = Fiber[CURRENT_EV_KEY]
+            ev.finish
+            # Use `false` to prevent grabbing an event from a parent fiber
+            Fiber[CURRENT_EV_KEY] = false
+            ev
+          end
+        end
+      RUBY
+    end
+  end
+end

data/lib/graphql/tracing/new_relic_trace.rb

@@ -1,74 +1,67 @@
 # frozen_string_literal: true
 
+require "graphql/tracing/monitor_trace"
+
 module GraphQL
   module Tracing
+    # A tracer for reporting GraphQL-Ruby time to New Relic
+    #
+    # @example Installing the tracer
+    #   class MySchema < GraphQL::Schema
+    #     trace_with GraphQL::Tracing::NewRelicTrace
+    #
+    #     # Optional, use the operation name to set the new relic transaction name:
+    #     # trace_with GraphQL::Tracing::NewRelicTrace, set_transaction_name: true
+    #   end
+    #
+    # @example Installing without trace events for `authorized?` or `resolve_type` calls
+    #   trace_with GraphQL::Tracing::NewRelicTrace, trace_authorized: false, trace_resolve_type: false
+    NewRelicTrace = MonitorTrace.create_module("newrelic")
     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
+      class NewrelicMonitor < MonitorTrace::Monitor
+        PARSE_NAME = "GraphQL/parse"
+        LEX_NAME = "GraphQL/lex"
+        VALIDATE_NAME = "GraphQL/validate"
+        EXECUTE_NAME = "GraphQL/execute"
+        ANALYZE_NAME = "GraphQL/analyze"
 
-      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
+        def instrument(keyword, payload, &block)
+          if keyword == :execute
+            query = payload.queries.first
+            set_this_txn_name = query.context[:set_new_relic_transaction_name]
+            if set_this_txn_name || (set_this_txn_name.nil? && @set_transaction_name)
+              NewRelic::Agent.set_transaction_name(transaction_name(query))
             end
           end
-        RUBY
-      end
+          ::NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(name_for(keyword, payload), &block)
+        end
 
-      def platform_execute_field(platform_key)
-        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
-          yield
+        def platform_source_class_key(source_class)
+          "GraphQL/Source/#{source_class.name}"
         end
-      end
 
-      def platform_authorized(platform_key)
-        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
-          yield
+        def platform_field_key(field)
+          "GraphQL/#{field.owner.graphql_name}/#{field.graphql_name}"
         end
-      end
 
-      def platform_resolve_type(platform_key)
-        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
-          yield
+        def platform_authorized_key(type)
+          "GraphQL/Authorized/#{type.graphql_name}"
         end
-      end
 
-      def platform_field_key(field)
-        "GraphQL/#{field.owner.graphql_name}/#{field.graphql_name}"
-      end
+        def platform_resolve_type_key(type)
+          "GraphQL/ResolveType/#{type.graphql_name}"
+        end
 
-      def platform_authorized_key(type)
-        "GraphQL/Authorize/#{type.graphql_name}"
-      end
+        class Event < MonitorTrace::Monitor::Event
+          def start
+            name = @monitor.name_for(keyword, object)
+            @nr_ev = NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: name, category: :web)
+          end
 
-      def platform_resolve_type_key(type)
-        "GraphQL/ResolveType/#{type.graphql_name}"
+          def finish
+            @nr_ev.finish
+          end
+        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

@@ -1,45 +1,193 @@
 # 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.
+    # This implementation forwards events to a notification handler
+    # (i.e. ActiveSupport::Notifications or Dry::Monitor::Notifications) with a `graphql` suffix.
+    #
+    # @see ActiveSupportNotificationsTrace ActiveSupport::Notifications integration
     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) }
+      # @api private
+      class Adapter
+        def instrument(keyword, payload, &block)
+          raise "Implement #{self.class}#instrument to measure the block"
+        end
+
+        def start_event(keyword, payload)
+          ev = self.class::Event.new(keyword, payload)
+          ev.start
+          ev
+        end
+
+        class Event
+          def initialize(name, payload)
+            @name = name
+            @payload = payload
+          end
+
+          attr_reader :name, :payload
+
+          def start
+            raise "Implement #{self.class}#start to begin a new event (#{inspect})"
+          end
+
+          def finish
+            raise "Implement #{self.class}#finish to end this event (#{inspect})"
+          end
+        end
+      end
+
+      # @api private
+      class DryMonitorAdapter < Adapter
+        def instrument(...)
+          Dry::Monitor.instrument(...)
+        end
+
+        class Event < Adapter::Event
+          def start
+            Dry::Monitor.start(@name, @payload)
+          end
+
+          def finish
+            Dry::Monitor.stop(@name, @payload)
+          end
+        end
+      end
+
+      # @api private
+      class ActiveSupportNotificationsAdapter < Adapter
+        def instrument(...)
+          ActiveSupport::Notifications.instrument(...)
+        end
+
+        class Event < Adapter::Event
+          def start
+            @asn_event = ActiveSupport::Notifications.instrumenter.new_event(@name, @payload)
+            @asn_event.start!
           end
-        RUBY
+
+          def finish
+            @asn_event.finish!
+            ActiveSupport::Notifications.publish_event(@asn_event)
+          end
+        end
+      end
+
+      # @param engine [Class] The notifications engine to use, eg `Dry::Monitor` or `ActiveSupport::Notifications`
+      def initialize(engine:, **rest)
+        adapter = if defined?(Dry::Monitor) && engine == Dry::Monitor
+          DryMonitoringAdapter
+        elsif defined?(ActiveSupport::Notifications) && engine == ActiveSupport::Notifications
+          ActiveSupportNotificationsAdapter
+        else
+          engine
+        end
+        @notifications = adapter.new
+        super
+      end
+
+      def parse(**payload)
+        @notifications.instrument("parse.graphql", payload) do
+          super
+        end
+      end
+
+      def lex(**payload)
+        @notifications.instrument("lex.graphql", payload) do
+          super
+        end
+      end
+
+      def validate(**payload)
+        @notifications.instrument("validate.graphql", payload) do
+          super
+        end
+      end
+
+      def begin_analyze_multiplex(multiplex, analyzers)
+        begin_notifications_event("analyze.graphql", {multiplex: multiplex, analyzers: analyzers})
+        super
+      end
+
+      def end_analyze_multiplex(_multiplex, _analyzers)
+        finish_notifications_event
+        super
       end
 
-      include PlatformTrace
+      def execute_multiplex(**payload)
+        @notifications.instrument("execute.graphql", payload) do
+          super
+        end
+      end
+
+      def begin_execute_field(field, object, arguments, query)
+        begin_notifications_event("execute_field.graphql", {field: field, object: object, arguments: arguments, query: query})
+        super
+      end
+
+      def end_execute_field(_field, _object, _arguments, _query, _result)
+        finish_notifications_event
+        super
+      end
+
+      def dataloader_fiber_yield(source)
+        Fiber[PREVIOUS_EV_KEY] = finish_notifications_event
+        super
+      end
+
+      def dataloader_fiber_resume(source)
+        prev_ev = Fiber[PREVIOUS_EV_KEY]
+        begin_notifications_event(prev_ev.name, prev_ev.payload)
+        super
+      end
+
+      def begin_authorized(type, object, context)
+        begin_notifications_event("authorized.graphql", {type: type, object: object, context: context})
+        super
+      end
+
+      def end_authorized(type, object, context, result)
+        finish_notifications_event
+        super
+      end
+
+      def begin_resolve_type(type, object, context)
+        begin_notifications_event("resolve_type.graphql", {type: type, object: object, context: context})
+        super
+      end
+
+      def end_resolve_type(type, object, context, resolved_type)
+        finish_notifications_event
+        super
+      end
+
+      def begin_dataloader_source(source)
+        begin_notifications_event("dataloader_source.graphql", { source: source })
+        super
+      end
+
+      def end_dataloader_source(source)
+        finish_notifications_event
+        super
+      end
+
+      CURRENT_EV_KEY = :__notifications_graphql_trace_event
+      PREVIOUS_EV_KEY = :__notifications_graphql_trace_previous_event
+
+      private
+
+      def begin_notifications_event(name, payload)
+        Fiber[CURRENT_EV_KEY] = @notifications.start_event(name, payload)
+      end
+
+      def finish_notifications_event
+        if ev = Fiber[CURRENT_EV_KEY]
+          ev.finish
+          # Use `false` to prevent grabbing an event from a parent fiber
+          Fiber[CURRENT_EV_KEY] = false
+          ev
+        end
+      end
     end
   end
 end

data/lib/graphql/tracing/notifications_tracing.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "graphql/tracing/platform_tracing"
+
 module GraphQL
   module Tracing
     # This implementation forwards events to a notification handler (i.e.

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