graphql 2.4.10 → 2.4.12

data/lib/graphql/tracing/new_relic_trace.rb

@@ -4,16 +4,30 @@ require "graphql/tracing/platform_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
     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
-      def initialize(set_transaction_name: false, trace_authorized: true, trace_resolve_type: true, **_rest)
+      # @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
@@ -80,78 +94,88 @@ module GraphQL
       end
 
       def begin_execute_field(field, object, arguments, query)
-        nr_segment_stack << NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: @nr_field_names[field], category: :web)
+        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
+          start_segment(partial_name: @nr_field_names[field], category: :web)
+        end
         super
       end
 
       def end_execute_field(field, objects, arguments, query, result)
-        nr_segment_stack.pop.finish
+        finish_segment
         super
       end
 
       def begin_authorized(type, obj, ctx)
         if @trace_authorized
-          nr_segment_stack << NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: @nr_authorized_names[type], category: :web)
+          start_segment(partial_name: @nr_authorized_names[type], category: :web)
         end
         super
       end
 
       def end_authorized(type, obj, ctx, is_authed)
         if @trace_authorized
-          nr_segment_stack.pop.finish
+          finish_segment
         end
         super
       end
 
       def begin_resolve_type(type, value, context)
         if @trace_resolve_type
-          nr_segment_stack << NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: @nr_resolve_type_names[type], category: :web)
+          start_segment(partial_name: @nr_resolve_type_names[type], category: :web)
         end
         super
       end
 
       def end_resolve_type(type, value, context, resolved_type)
         if @trace_resolve_type
-          nr_segment_stack.pop.finish
+          finish_segment
         end
         super
       end
 
-      def begin_dataloader(dl)
-        super
-      end
-
-      def end_dataloader(dl)
-        super
-      end
-
       def begin_dataloader_source(source)
-        nr_segment_stack << NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: @nr_source_names[source], category: :web)
+        start_segment(partial_name: @nr_source_names[source], category: :web)
         super
       end
 
       def end_dataloader_source(source)
-        nr_segment_stack.pop.finish
+        finish_segment
         super
       end
 
       def dataloader_fiber_yield(source)
-        current_segment = nr_segment_stack.last
-        current_segment.finish
+        prev_segment = finish_segment
+        Fiber[:graphql_nr_previous_segment] = prev_segment
         super
       end
 
       def dataloader_fiber_resume(source)
-        prev_segment = nr_segment_stack.pop
+        prev_segment = Fiber[:graphql_nr_previous_segment]
+        Fiber[:graphql_nr_previous_segment] = nil
         seg_partial_name = prev_segment.name.sub(/^.*(GraphQL.*)$/, '\1')
-        nr_segment_stack << NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: seg_partial_name, category: :web)
+        start_segment(partial_name: seg_partial_name, category: :web)
         super
       end
 
       private
 
-      def nr_segment_stack
-        Fiber[:graphql_nr_segment_stack] ||= []
+      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)

data/lib/graphql/tracing/perfetto_trace.rb

@@ -61,8 +61,10 @@ module GraphQL
       DA_STR_VAL_NIL_IID = 14
 
       # @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, **_rest)
+      def initialize(active_support_notifications_pattern: nil, save_profile: false, **_rest)
         super
+        @save_profile = save_profile
+        Fiber[:graphql_flow_stack] = nil
         @sequence_id = object_id
         @pid = Process.pid
         @flow_ids = Hash.new { |h, source_inst| h[source_inst] = [] }.compare_by_identity
@@ -108,6 +110,7 @@ module GraphQL
         @fibers_counter_id = :fibers_counter.object_id
         @fields_counter_id = :fields_counter.object_id
         @begin_validate = nil
+        @begin_time = nil
         @packets = []
         @packets << TracePacket.new(
           track_descriptor: TrackDescriptor.new(
@@ -172,6 +175,8 @@ module GraphQL
       end
 
       def begin_execute_multiplex(m)
+        @operation_name = m.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,
@@ -189,6 +194,12 @@ module GraphQL
           track_uuid: fid,
         )
         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)))
+        end
         super
       end
 
@@ -297,7 +308,7 @@ module GraphQL
           {
             debug_annotations: [
               @begin_validate.track_event.debug_annotations.first,
-              payload_to_debug("valid?", !validation_errors.empty?)
+              payload_to_debug("valid?", validation_errors.empty?)
             ]
           }
         )

data/lib/graphql/tracing/prometheus_trace.rb

@@ -4,6 +4,28 @@ require "graphql/tracing/platform_trace"
 
 module GraphQL
   module Tracing
+    # A tracer for reporting GraphQL-Ruby times to Prometheus.
+    #
+    # The PrometheusExporter server must be run with a custom type collector that extends `GraphQL::Tracing::PrometheusTracing::GraphQLCollector`.
+    #
+    # @example Adding this trace to your schema
+    #   require 'prometheus_exporter/client'
+    #
+    #   class MySchema < GraphQL::Schema
+    #     trace_with GraphQL::Tracing::PrometheusTrace
+    #   end
+    #
+    # @example Running a custom type collector
+    #   # lib/graphql_collector.rb
+    #   if defined?(PrometheusExporter::Server)
+    #     require 'graphql/tracing'
+    #
+    #     class GraphQLCollector < GraphQL::Tracing::PrometheusTrace::GraphQLCollector
+    #     end
+    #   end
+    #
+    #    # Then run:
+    #    # bundle exec prometheus_exporter -a lib/graphql_collector.rb
     module PrometheusTrace
       if defined?(PrometheusExporter::Server)
         autoload :GraphQLCollector, "graphql/tracing/prometheus_trace/graphql_collector"

data/lib/graphql/tracing/scout_trace.rb

@@ -4,6 +4,12 @@ require "graphql/tracing/platform_trace"
 
 module GraphQL
   module Tracing
+    # A tracer for sending GraphQL-Ruby times to Scout
+    #
+    # @example Adding this tracer to your schema
+    #   class MySchema < GraphQL::Schema
+    #     trace_with GraphQL::Tracing::ScoutTrace
+    #   end
     module ScoutTrace
       include PlatformTrace
 

data/lib/graphql/tracing/sentry_trace.rb

@@ -4,6 +4,11 @@ require "graphql/tracing/platform_trace"
 
 module GraphQL
   module Tracing
+    # A tracer for reporting GraphQL-Ruby times to Sentry.
+    # @example Installing the tracer
+    #   class MySchema < GraphQL::Schema
+    #     trace_with GraphQL::Tracing::SentryTrace
+    #   end
     module SentryTrace
       include PlatformTrace
 

data/lib/graphql/tracing/statsd_trace.rb

@@ -4,6 +4,15 @@ require "graphql/tracing/platform_trace"
 
 module GraphQL
   module Tracing
+    # A tracer for reporting GraphQL-Ruby times to Statsd.
+    # Passing any Statsd client that implements `.time(name) { ... }` will work.
+    #
+    # @example Installing this tracer
+    #   # eg:
+    #   # $statsd = Statsd.new 'localhost', 9125
+    #   class MySchema < GraphQL::Schema
+    #     use GraphQL::Tracing::StatsdTrace, statsd: $statsd
+    #   end
     module StatsdTrace
       include PlatformTrace
 

data/lib/graphql/tracing.rb

@@ -32,6 +32,7 @@ module GraphQL
     autoload :StatsdTrace, "graphql/tracing/statsd_trace"
     autoload :PrometheusTrace, "graphql/tracing/prometheus_trace"
     autoload :PerfettoTrace, "graphql/tracing/perfetto_trace"
+    autoload :DetailedTrace, "graphql/tracing/detailed_trace"
 
     # Objects may include traceable to gain a `.trace(...)` method.
     # The object must have a `@tracers` ivar of type `Array<<#trace(k, d, &b)>>`.

data/lib/graphql/version.rb

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

data/lib/graphql.rb

@@ -125,6 +125,9 @@ This is probably a bug in GraphQL-Ruby, please report this error on GitHub: http
   autoload :LoadApplicationObjectFailedError, "graphql/load_application_object_failed_error"
   autoload :Testing, "graphql/testing"
   autoload :Current, "graphql/current"
+  if defined?(::Rails::Engine)
+    autoload :Dashboard, 'graphql/dashboard'
+  end
 end
 
 require "graphql/version"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: graphql
 version: !ruby/object:Gem::Version
-  version: 2.4.10
+  version: 2.4.12
 platform: ruby
 authors:
 - Robert Mosolgo
 bindir: bin
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -459,6 +459,16 @@ files:
 - lib/graphql/backtrace/traced_error.rb
 - lib/graphql/coercion_error.rb
 - lib/graphql/current.rb
+- lib/graphql/dashboard.rb
+- lib/graphql/dashboard/statics/bootstrap-5.3.3.min.css
+- lib/graphql/dashboard/statics/bootstrap-5.3.3.min.js
+- lib/graphql/dashboard/statics/dashboard.css
+- lib/graphql/dashboard/statics/dashboard.js
+- lib/graphql/dashboard/statics/header-icon.png
+- lib/graphql/dashboard/statics/icon.png
+- lib/graphql/dashboard/views/graphql/dashboard/landings/show.html.erb
+- lib/graphql/dashboard/views/graphql/dashboard/traces/index.html.erb
+- lib/graphql/dashboard/views/layouts/graphql/dashboard/application.html.erb
 - lib/graphql/dataloader.rb
 - lib/graphql/dataloader/active_record_association_source.rb
 - lib/graphql/dataloader/active_record_source.rb
@@ -721,6 +731,9 @@ files:
 - lib/graphql/tracing/call_legacy_tracers.rb
 - lib/graphql/tracing/data_dog_trace.rb
 - lib/graphql/tracing/data_dog_tracing.rb
+- lib/graphql/tracing/detailed_trace.rb
+- lib/graphql/tracing/detailed_trace/memory_backend.rb
+- lib/graphql/tracing/detailed_trace/redis_backend.rb
 - lib/graphql/tracing/legacy_hooks_trace.rb
 - lib/graphql/tracing/legacy_trace.rb
 - lib/graphql/tracing/new_relic_trace.rb