graphql 1.13.14 → 2.0.19

data/lib/graphql/tracing/notifications_trace.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+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
+      include PlatformTrace
+      # 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_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, &blk)
+            @notifications_engine.instrument("#{platform_key}", metadata, &blk)
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/graphql/tracing/platform_trace.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    module PlatformTrace
+      def initialize(trace_scalars: false, **_options)
+        @trace_scalars = trace_scalars
+        @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) }
+        super
+      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)
+        # Don't gather this unless necessary
+        pass_data_to_execute_field = child_class.method_defined?(:platform_execute_field) &&
+          child_class.instance_method(:platform_execute_field).arity != 1
+
+        [:execute_field, :execute_field_lazy].each do |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_field_key_cache[field]
+              else
+                nil
+              end
+              if platform_key && trace_field
+                platform_#{field_trace_method}(platform_key#{pass_data_to_execute_field ? ", { query: query, field: field, ast_node: ast_node, arguments: arguments, object: object }" : ""}) do
+                  super
+                end
+              else
+                super
+              end
+            end
+          RUBY
+        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_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_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

@@ -30,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, :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
@@ -78,32 +72,21 @@ 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)
+            schema_defn.trace_with(trace_module, **options)
           else
-            field
+            tracer = self.new(**options)
+            schema_defn.tracer(tracer)
           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
@@ -138,6 +121,9 @@ 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, trace_phase)
         cache = ctx.namespace(self.class)[:platform_key_cache] ||= {}

data/lib/graphql/tracing/prometheus_trace.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    module PrometheusTrace
+      include PlatformTrace
+
+      def initialize(client: PrometheusExporter::Client.default, keys_whitelist: ["execute_field", "execute_field_lazy"], collector_type: "graphql", **rest)
+        @client = client
+        @keys_whitelist = keys_whitelist
+        @collector_type = collector_type
+
+        super(**rest)
+      end
+
+      {
+        'lex' => "graphql.lex",
+        'parse' => "graphql.parse",
+        'validate' => "graphql.validate",
+        'analyze_query' => "graphql.analyze",
+        'analyze_multiplex' => "graphql.analyze",
+        'execute_multiplex' => "graphql.execute",
+        'execute_query' => "graphql.execute",
+        'execute_query_lazy' => "graphql.execute",
+      }.each do |trace_method, platform_key|
+        module_eval <<-RUBY, __FILE__, __LINE__
+          def #{trace_method}(**data, &block)
+            instrument_execution("#{platform_key}", "#{trace_method}", &block)
+          end
+        RUBY
+      end
+
+      def platform_execute_field(platform_key, &block)
+        instrument_execution(platform_key, "execute_field", &block)
+      end
+
+      def platform_execute_field_lazy(platform_key, &block)
+        instrument_execution(platform_key, "execute_field_lazy", &block)
+      end
+
+      def platform_authorized(platform_key, &block)
+        instrument_execution(platform_key, "authorized", &block)
+      end
+
+      def platform_authorized_lazy(platform_key, &block)
+        instrument_execution(platform_key, "authorized_lazy", &block)
+      end
+
+      def platform_resolve_type(platform_key, &block)
+        instrument_execution(platform_key, "resolve_type", &block)
+      end
+
+      def platform_resolve_type_lazy(platform_key, &block)
+        instrument_execution(platform_key, "resolve_type_lazy", &block)
+      end
+
+      def platform_field_key(field)
+        field.path
+      end
+
+      def platform_authorized_key(type)
+        "#{type.graphql_name}.authorized"
+      end
+
+      def platform_resolve_type_key(type)
+        "#{type.graphql_name}.resolve_type"
+      end
+
+      private
+
+      def instrument_execution(platform_key, key, &block)
+        if @keys_whitelist.include?(key)
+          start = ::Process.clock_gettime ::Process::CLOCK_MONOTONIC
+          result = block.call
+          duration = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start
+          @client.send_json(
+            type: @collector_type,
+            duration: duration,
+            platform_key: platform_key,
+            key: key
+          )
+          result
+        else
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/graphql/tracing/prometheus_tracing.rb

@@ -27,9 +27,9 @@ module GraphQL
         super opts
       end
 
-      def platform_trace(platform_key, key, data, &block)
+      def platform_trace(platform_key, key, _data, &block)
         return yield unless @keys_whitelist.include?(key)
-        instrument_execution(platform_key, key, data, &block)
+        instrument_execution(platform_key, key, &block)
       end
 
       def platform_field_key(type, field)
@@ -46,7 +46,7 @@ module GraphQL
 
       private
 
-      def instrument_execution(platform_key, key, data, &block)
+      def instrument_execution(platform_key, key, &block)
         start = ::Process.clock_gettime ::Process::CLOCK_MONOTONIC
         result = block.call
         duration = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start

data/lib/graphql/tracing/scout_trace.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    module ScoutTrace
+      include PlatformTrace
+
+      INSTRUMENT_OPTS = { scope: true }
+
+      # @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_scout_transaction_name]`.
+      def initialize(set_transaction_name: false, **_rest)
+        self.class.include(ScoutApm::Tracer)
+        @set_transaction_name = set_transaction_name
+        super
+      end
+
+      {
+        "lex" => "lex.graphql",
+        "parse" => "parse.graphql",
+        "validate" => "validate.graphql",
+        "analyze_query" => "analyze.graphql",
+        "analyze_multiplex" => "analyze.graphql",
+        "execute_multiplex" => "execute.graphql",
+        "execute_query" => "execute.graphql",
+        "execute_query_lazy" => "execute.graphql",
+      }.each do |trace_method, platform_key|
+        module_eval <<-RUBY, __FILE__, __LINE__
+        def #{trace_method}(**data)
+          #{
+            if trace_method == "execute_query"
+              <<-RUBY
+              set_this_txn_name = data[:query].context[:set_scout_transaction_name]
+              if set_this_txn_name == true || (set_this_txn_name.nil? && @set_transaction_name)
+                ScoutApm::Transaction.rename(transaction_name(data[:query]))
+              end
+              RUBY
+            end
+          }
+
+          self.class.instrument("GraphQL", "#{platform_key}", INSTRUMENT_OPTS) do
+            super
+          end
+        end
+        RUBY
+      end
+
+      def platform_execute_field(platform_key, &block)
+        self.class.instrument("GraphQL", platform_key, INSTRUMENT_OPTS, &block)
+      end
+
+      def platform_authorized(platform_key, &block)
+        self.class.instrument("GraphQL", platform_key, INSTRUMENT_OPTS, &block)
+      end
+
+      alias :platform_resolve_type :platform_authorized
+
+      def platform_field_key(field)
+        field.path
+      end
+
+      def platform_authorized_key(type)
+        "#{type.graphql_name}.authorized"
+      end
+
+      def platform_resolve_type_key(type)
+        "#{type.graphql_name}.resolve_type"
+      end
+    end
+  end
+end

data/lib/graphql/tracing/statsd_trace.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    module StatsdTrace
+      include PlatformTrace
+
+      # @param statsd [Object] A statsd client
+      def initialize(statsd:, **rest)
+        @statsd = statsd
+        super(**rest)
+      end
+
+      {
+        'lex' => "graphql.lex",
+        'parse' => "graphql.parse",
+        'validate' => "graphql.validate",
+        'analyze_query' => "graphql.analyze_query",
+        'analyze_multiplex' => "graphql.analyze_multiplex",
+        'execute_multiplex' => "graphql.execute_multiplex",
+        'execute_query' => "graphql.execute_query",
+        'execute_query_lazy' => "graphql.execute_query_lazy",
+      }.each do |trace_method, platform_key|
+        module_eval <<-RUBY, __FILE__, __LINE__
+          def #{trace_method}(**data)
+            @statsd.time("#{platform_key}") do
+              super
+            end
+          end
+        RUBY
+      end
+
+      def platform_execute_field(platform_key, &block)
+        @statsd.time(platform_key, &block)
+      end
+
+      def platform_authorized(key, &block)
+        @statsd.time(key, &block)
+      end
+
+      alias :platform_resolve_type :platform_authorized
+
+      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
+    end
+  end
+end

data/lib/graphql/tracing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# Legacy tracing:
 require "graphql/tracing/active_support_notifications_tracing"
 require "graphql/tracing/platform_tracing"
 require "graphql/tracing/appoptics_tracing"
@@ -6,56 +7,150 @@ require "graphql/tracing/appsignal_tracing"
 require "graphql/tracing/data_dog_tracing"
 require "graphql/tracing/new_relic_tracing"
 require "graphql/tracing/scout_tracing"
-require "graphql/tracing/skylight_tracing"
 require "graphql/tracing/statsd_tracing"
 require "graphql/tracing/prometheus_tracing"
-require "graphql/tracing/opentelemetry_tracing"
 
+# New Tracing:
+require "graphql/tracing/platform_trace"
+require "graphql/tracing/appoptics_trace"
+require "graphql/tracing/appsignal_trace"
+require "graphql/tracing/data_dog_trace"
+require "graphql/tracing/new_relic_trace"
+require "graphql/tracing/notifications_trace"
+require "graphql/tracing/scout_trace"
+require "graphql/tracing/statsd_trace"
+require "graphql/tracing/prometheus_trace"
 if defined?(PrometheusExporter::Server)
   require "graphql/tracing/prometheus_tracing/graphql_collector"
 end
 
 module GraphQL
-  # Library entry point for performance metric reporting.
-  #
-  # @example Sending custom events
-  #   query.trace("my_custom_event", { ... }) do
-  #     # do stuff ...
-  #   end
-  #
-  # @example Adding a tracer to a schema
-  #  class MySchema < GraphQL::Schema
-  #    tracer MyTracer # <= responds to .trace(key, data, &block)
-  #  end
-  #
-  # @example Adding a tracer to a single query
-  #   MySchema.execute(query_str, context: { backtrace: true })
-  #
-  # Events:
-  #
-  # Key | Metadata
-  # ----|---------
-  # lex | `{ query_string: String }`
-  # parse | `{ query_string: String }`
-  # validate | `{ query: GraphQL::Query, validate: Boolean }`
-  # analyze_multiplex |  `{ multiplex: GraphQL::Execution::Multiplex }`
-  # analyze_query | `{ query: GraphQL::Query }`
-  # execute_multiplex | `{ multiplex: GraphQL::Execution::Multiplex }`
-  # execute_query | `{ query: GraphQL::Query }`
-  # execute_query_lazy | `{ query: GraphQL::Query?, multiplex: GraphQL::Execution::Multiplex? }`
-  # execute_field | `{ owner: Class, field: GraphQL::Schema::Field, query: GraphQL::Query, path: Array<String, Integer>, ast_node: GraphQL::Language::Nodes::Field}`
-  # execute_field_lazy | `{ owner: Class, field: GraphQL::Schema::Field, query: GraphQL::Query, path: Array<String, Integer>, ast_node: GraphQL::Language::Nodes::Field}`
-  # authorized | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  # authorized_lazy | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  # resolve_type | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  # resolve_type_lazy | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  #
-  # Note that `execute_field` and `execute_field_lazy` receive different data in different settings:
-  #
-  # - When using {GraphQL::Execution::Interpreter}, they receive `{field:, path:, query:}`
-  # - Otherwise, they receive `{context: ...}`
-  #
   module Tracing
+    class Trace
+      # @param multiplex [GraphQL::Execution::Multiplex, nil]
+      # @param query [GraphQL::Query, nil]
+      def initialize(multiplex: nil, query: nil, **_options)
+        @multiplex = multiplex
+        @query = query
+      end
+
+      def lex(query_string:)
+        yield
+      end
+
+      def parse(query_string:)
+        yield
+      end
+
+      def validate(query:, validate:)
+        yield
+      end
+
+      def analyze_multiplex(multiplex:)
+        yield
+      end
+
+      def analyze_query(query:)
+        yield
+      end
+
+      def execute_multiplex(multiplex:)
+        yield
+      end
+
+      def execute_query(query:)
+        yield
+      end
+
+      def execute_query_lazy(query:, multiplex:)
+        yield
+      end
+
+      def execute_field(field:, query:, ast_node:, arguments:, object:)
+        yield
+      end
+
+      def execute_field_lazy(field:, query:, ast_node:, arguments:, object:)
+        yield
+      end
+
+      def authorized(query:, type:, object:)
+        yield
+      end
+
+      def authorized_lazy(query:, type:, object:)
+        yield
+      end
+
+      def resolve_type(query:, type:, object:)
+        yield
+      end
+
+      def resolve_type_lazy(query:, type:, object:)
+        yield
+      end
+    end
+
+    NullTrace = Trace.new
+
+    class LegacyTrace < Trace
+      def lex(query_string:, &block)
+        (@multiplex || @query).trace("lex", { query_string: query_string }, &block)
+      end
+
+      def parse(query_string:, &block)
+        (@multiplex || @query).trace("parse", { query_string: query_string }, &block)
+      end
+
+      def validate(query:, validate:, &block)
+        query.trace("validate", { validate: validate, query: query }, &block)
+      end
+
+      def analyze_multiplex(multiplex:, &block)
+        multiplex.trace("analyze_multiplex", { multiplex: multiplex }, &block)
+      end
+
+      def analyze_query(query:, &block)
+        query.trace("analyze_query", { query: query }, &block)
+      end
+
+      def execute_multiplex(multiplex:, &block)
+        multiplex.trace("execute_multiplex", { multiplex: multiplex }, &block)
+      end
+
+      def execute_query(query:, &block)
+        query.trace("execute_query", { query: query }, &block)
+      end
+
+      def execute_query_lazy(query:, multiplex:, &block)
+        multiplex.trace("execute_query_lazy", { multiplex: multiplex, query: query }, &block)
+      end
+
+      def execute_field(field:, query:, ast_node:, arguments:, object:, &block)
+        query.trace("execute_field", { field: field, query: query, ast_node: ast_node, arguments: arguments, object: object, owner: field.owner, path: query.context[:current_path] }, &block)
+      end
+
+      def execute_field_lazy(field:, query:, ast_node:, arguments:, object:, &block)
+        query.trace("execute_field_lazy", { field: field, query: query, ast_node: ast_node, arguments: arguments, object: object, owner: field.owner, path: query.context[:current_path] }, &block)
+      end
+
+      def authorized(query:, type:, object:, &block)
+        query.trace("authorized", { context: query.context, type: type, object: object, path: query.context[:current_path] }, &block)
+      end
+
+      def authorized_lazy(query:, type:, object:, &block)
+        query.trace("authorized_lazy", { context: query.context, type: type, object: object, path: query.context[:current_path] }, &block)
+      end
+
+      def resolve_type(query:, type:, object:, &block)
+        query.trace("resolve_type", { context: query.context, type: type, object: object, path: query.context[:current_path] }, &block)
+      end
+
+      def resolve_type_lazy(query:, type:, object:, &block)
+        query.trace("resolve_type_lazy", { context: query.context, type: type, object: object, path: query.context[:current_path] }, &block)
+      end
+    end
+
     # Objects may include traceable to gain a `.trace(...)` method.
     # The object must have a `@tracers` ivar of type `Array<<#trace(k, d, &b)>>`.
     # @api private