graphql 2.4.15 → 2.5.0

data/lib/graphql/tracing/new_relic_trace.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "graphql/tracing/platform_trace"
+require "graphql/tracing/monitor_trace"
 
 module GraphQL
   module Tracing
@@ -16,184 +16,52 @@ module GraphQL
     #
     # @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
-      # @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]`.
-      # @param trace_authorized [Boolean] If `false`, skip tracing `authorized?` calls
-      # @param trace_resolve_type [Boolean] If `false`, skip tracing `resolve_type?` calls
-      # @param trace_scalars [Boolean] If `true`, Enum and Scalar fields will be traced by default
-      def initialize(set_transaction_name: false, trace_authorized: true, trace_resolve_type: true, trace_scalars: false, **_rest)
-        @set_transaction_name = set_transaction_name
-        @trace_authorized = trace_authorized
-        @trace_resolve_type = trace_resolve_type
-        @trace_scalars = trace_scalars
-        @nr_field_names = Hash.new do |h, field|
-          h[field] = "GraphQL/#{field.owner.graphql_name}/#{field.graphql_name}"
-        end.compare_by_identity
-
-        @nr_authorized_names = Hash.new do |h, type|
-          h[type] = "GraphQL/Authorized/#{type.graphql_name}"
-        end.compare_by_identity
-
-        @nr_resolve_type_names = Hash.new do |h, type|
-          h[type] = "GraphQL/ResolveType/#{type.graphql_name}"
-        end.compare_by_identity
-
-        @nr_source_names = Hash.new do |h, source_inst|
-          h[source_inst] = "GraphQL/Source/#{source_inst.class.name}"
-        end.compare_by_identity
-
-        @nr_parse = @nr_validate = @nr_analyze = @nr_execute = nil
-        super
-      end
-
-      def begin_parse(query_str)
-        @nr_parse = NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: "GraphQL/parse", category: :web)
-        super
-      end
-
-      def end_parse(query_str)
-        @nr_parse.finish
-        super
-      end
-
-      def begin_validate(query, validate)
-        @nr_validate = NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: "GraphQL/validate", category: :web)
-        super
-      end
-
-      def end_validate(query, validate, validation_errors)
-        @nr_validate.finish
-        super
-      end
-
-      def begin_analyze_multiplex(multiplex, analyzers)
-        @nr_analyze = NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: "GraphQL/analyze", category: :web)
-        super
-      end
-
-      def end_analyze_multiplex(multiplex, analyzers)
-        @nr_analyze.finish
-        super
-      end
-
-      def begin_execute_multiplex(multiplex)
-        query = multiplex.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))
+      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 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
+          ::NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(name_for(keyword, payload), &block)
         end
-        @nr_execute = NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: "GraphQL/execute", category: :web)
-        super
-      end
-
-      def end_execute_multiplex(multiplex)
-        @nr_execute.finish
-        super
-      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
+        def platform_source_class_key(source_class)
+          "GraphQL/Source/#{source_class.name}"
         end
-        if trace_field
-          start_segment(partial_name: @nr_field_names[field], category: :web)
-        end
-        super
-      end
 
-      def end_execute_field(field, objects, arguments, query, result)
-        finish_segment
-        super
-      end
-
-      def begin_authorized(type, obj, ctx)
-        if @trace_authorized
-          start_segment(partial_name: @nr_authorized_names[type], category: :web)
-        end
-        super
-      end
-
-      def end_authorized(type, obj, ctx, is_authed)
-        if @trace_authorized
-          finish_segment
+        def platform_field_key(field)
+          "GraphQL/#{field.owner.graphql_name}/#{field.graphql_name}"
         end
-        super
-      end
 
-      def begin_resolve_type(type, value, context)
-        if @trace_resolve_type
-          start_segment(partial_name: @nr_resolve_type_names[type], category: :web)
+        def platform_authorized_key(type)
+          "GraphQL/Authorized/#{type.graphql_name}"
         end
-        super
-      end
 
-      def end_resolve_type(type, value, context, resolved_type)
-        if @trace_resolve_type
-          finish_segment
+        def platform_resolve_type_key(type)
+          "GraphQL/ResolveType/#{type.graphql_name}"
         end
-        super
-      end
-
-      def begin_dataloader_source(source)
-        start_segment(partial_name: @nr_source_names[source], category: :web)
-        super
-      end
 
-      def end_dataloader_source(source)
-        finish_segment
-        super
-      end
-
-      def dataloader_fiber_yield(source)
-        prev_segment = finish_segment
-        Fiber[:graphql_nr_previous_segment] = prev_segment
-        super
-      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 dataloader_fiber_resume(source)
-        prev_segment = Fiber[:graphql_nr_previous_segment]
-        Fiber[:graphql_nr_previous_segment] = nil
-        if prev_segment
-          seg_partial_name = prev_segment.name.sub(/^.*(GraphQL.*)$/, '\1')
-          start_segment(partial_name: seg_partial_name, category: :web)
+          def finish
+            @nr_ev.finish
+          end
         end
-        super
-      end
-
-      private
-
-      def start_segment(...)
-        Fiber[:graphql_nr_segment] = NewRelic::Agent::Tracer.start_transaction_or_segment(...)
-      end
-
-      def finish_segment
-        segment = Fiber[:graphql_nr_segment]
-        if segment
-          segment.finish
-          Fiber[:graphql_nr_segment] = nil
-          segment
-        end
-      end
-
-      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

data/lib/graphql/tracing/notifications_trace.rb

@@ -1,49 +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
-
-      # rubocop:disable Development/NoEvalCop This eval takes static inputs at load-time
-
-      {
-        "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
-        RUBY
+
+          def finish
+            raise "Implement #{self.class}#finish to end this event (#{inspect})"
+          end
+        end
       end
 
-      # rubocop:enable Development/NoEvalCop
+      # @api private
+      class DryMonitorAdapter < Adapter
+        def instrument(...)
+          Dry::Monitor.instrument(...)
+        end
 
-      include PlatformTrace
+        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
+
+          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
+
+      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/perfetto_trace.rb

@@ -63,6 +63,7 @@ module GraphQL
       # @param active_support_notifications_pattern [String, RegExp, false] A filter for `ActiveSupport::Notifications`, if it's present. Or `false` to skip subscribing.
       def initialize(active_support_notifications_pattern: nil, save_profile: false, **_rest)
         super
+        @active_support_notifications_pattern = active_support_notifications_pattern
         @save_profile = save_profile
         Fiber[:graphql_flow_stack] = nil
         @sequence_id = object_id
@@ -168,39 +169,38 @@ module GraphQL
           track_uuid: @fields_counter_id,
           counter_value: count_fields,
         )
-
-        if defined?(ActiveSupport::Notifications) && active_support_notifications_pattern != false
-          subscribe_to_active_support_notifications(active_support_notifications_pattern)
-        end
       end
 
-      def begin_execute_multiplex(m)
-        @operation_name = m.queries.map { |q| q.selected_operation_name || "anonymous" }.join(",")
+      def execute_multiplex(multiplex:)
+        if defined?(ActiveSupport::Notifications) && @active_support_notifications_pattern != false
+          subscribe_to_active_support_notifications(@active_support_notifications_pattern)
+        end
+        @operation_name = multiplex.queries.map { |q| q.selected_operation_name || "anonymous" }.join(",")
         @begin_time = Time.now
         @packets << trace_packet(
           type: TrackEvent::Type::TYPE_SLICE_BEGIN,
           track_uuid: fid,
           name: "Multiplex",
           debug_annotations: [
-            payload_to_debug("query_string", m.queries.map(&:sanitized_query_string).join("\n\n"))
+            payload_to_debug("query_string", multiplex.queries.map(&:sanitized_query_string).join("\n\n"))
           ]
         )
-        super
-      end
+        result = super
 
-      def end_execute_multiplex(m)
         @packets << trace_packet(
           type: TrackEvent::Type::TYPE_SLICE_END,
           track_uuid: fid,
         )
+
+        result
+      ensure
         unsubscribe_from_active_support_notifications
         if @save_profile
           begin_ts = (@begin_time.to_f * 1000).round
           end_ts = (Time.now.to_f * 1000).round
           duration_ms = end_ts - begin_ts
-          m.schema.detailed_trace.save_trace(@operation_name, duration_ms, begin_ts, Trace.encode(Trace.new(packet: @packets)))
+          multiplex.schema.detailed_trace.save_trace(@operation_name, duration_ms, begin_ts, Trace.encode(Trace.new(packet: @packets)))
         end
-        super
       end
 
       def begin_execute_field(field, object, arguments, query)
@@ -261,7 +261,7 @@ module GraphQL
         super
       end
 
-      def begin_parse(str)
+      def parse(query_string:)
         @packets << trace_packet(
           type: TrackEvent::Type::TYPE_SLICE_BEGIN,
           track_uuid: fid,
@@ -269,17 +269,14 @@ module GraphQL
           extra_counter_values: [count_allocations],
           name: "Parse"
         )
-        super
-      end
-
-      def end_parse(str)
+        result = super
         @packets << trace_packet(
           type: TrackEvent::Type::TYPE_SLICE_END,
           track_uuid: fid,
           extra_counter_track_uuids: [@objects_counter_id],
           extra_counter_values: [count_allocations],
         )
-        super
+        result
       end
 
       def begin_validate(query, validate)