graphql 2.4.3 → 2.5.2

data/lib/graphql/tracing/data_dog_trace.rb

@@ -1,183 +1,71 @@
 # frozen_string_literal: true
+require "graphql/tracing/monitor_trace"
 
 module GraphQL
   module Tracing
+    # A tracer for reporting to DataDog
+    # @example Adding this tracer to your schema
+    #   class MySchema < GraphQL::Schema
+    #     trace_with GraphQL::Tracing::DataDogTrace
+    #   end
+    # @example Skipping `resolve_type` and `authorized` events
+    #   trace_with GraphQL::Tracing::DataDogTrace, trace_authorized: false, trace_resolve_type: false
+    DataDogTrace = MonitorTrace.create_module("datadog")
     module DataDogTrace
-      # @param tracer [#trace] Deprecated
-      # @param analytics_enabled [Boolean] Deprecated
-      # @param analytics_sample_rate [Float] Deprecated
-      def initialize(tracer: nil, analytics_enabled: false, analytics_sample_rate: 1.0, service: nil, **rest)
-        if tracer.nil?
-          tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer
+      class DatadogMonitor < MonitorTrace::Monitor
+        def initialize(set_transaction_name:, service: nil, tracer: nil, **_rest)
+          super
+          if tracer.nil?
+            tracer = defined?(Datadog::Tracing) ? Datadog::Tracing : Datadog.tracer
+          end
+          @tracer = tracer
+          @service_name = service
+          @has_prepare_span = @trace.respond_to?(:prepare_span)
         end
-        @tracer = tracer
-
-        @analytics_enabled = analytics_enabled
-        @analytics_sample_rate = analytics_sample_rate
-
-        @service_name = service
-        @has_prepare_span = respond_to?(:prepare_span)
-        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, trace_key|
-        module_eval <<-RUBY, __FILE__, __LINE__
-          def #{trace_method}(**data)
-            @tracer.trace("#{trace_key}", service: @service_name, type: 'custom') do |span|
-                span.set_tag('component', 'graphql')
-                span.set_tag('operation', '#{trace_method}')
-
-              #{
-                if trace_method == 'execute_multiplex'
-                  <<-RUBY
-                  operations = data[:multiplex].queries.map(&:selected_operation_name).join(', ')
 
-                  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
+        attr_reader :tracer, :service_name
 
-                  # [Deprecated] will be removed in the future
-                  span.set_metric('_dd1.sr.eausr', @analytics_sample_rate) if @analytics_enabled
-                  RUBY
-                elsif trace_method == 'execute_query'
-                  <<-RUBY
-                  span.set_tag(:selected_operation_name, data[:query].selected_operation_name)
-                  span.set_tag(:selected_operation_type, data[:query].selected_operation.operation_type)
-                  span.set_tag(:query_string, data[:query].query_string)
-                  RUBY
-                end
-              }
-              if @has_prepare_span
-                prepare_span("#{trace_method.sub("platform_", "")}", data, span)
+        def instrument(keyword, object)
+          trace_key = name_for(keyword, object)
+          @tracer.trace(trace_key, service: @service_name, type: 'custom') do |span|
+            span.set_tag('component', 'graphql')
+            op_name = keyword.respond_to?(:name) ? keyword.name : keyword.to_s
+            span.set_tag('operation', op_name)
+
+            if keyword == :execute
+              operations = object.queries.map(&:selected_operation_name).join(', ')
+              first_query = object.queries.first
+              resource = if operations.empty?
+                fallback_transaction_name(first_query && first_query.context)
+              else
+                operations
               end
-              super
-            end
-          end
-        RUBY
-      end
+              span.resource = resource if resource
 
-      def execute_field_span(span_key, 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[DataDogTrace].platform_field_key_cache[field]
-        else
-          nil
-        end
-        if platform_key && trace_field
-          @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-            span.set_tag('component', 'graphql')
-            span.set_tag('operation', span_key)
+              span.set_tag("selected_operation_name", first_query.selected_operation_name)
+              span.set_tag("selected_operation_type", first_query.selected_operation&.operation_type)
+              span.set_tag("query_string", first_query.query_string)
+            end
 
             if @has_prepare_span
-              prepare_span_data = { query: query, field: field, ast_node: ast_node, arguments: arguments, object: object }
-              prepare_span(span_key, prepare_span_data, span)
+              @trace.prepare_span(keyword, object, span)
             end
             yield
           end
-        else
-          yield
-        end
-      end
-      def execute_field(query:, field:, ast_node:, arguments:, object:)
-        execute_field_span("execute_field", query, field, ast_node, arguments, object) do
-          super(query: query, field: field, ast_node: ast_node, arguments: arguments, object: object)
-        end
-      end
-
-      def execute_field_lazy(query:, field:, ast_node:, arguments:, object:)
-        execute_field_span("execute_field_lazy", query, field, ast_node, arguments, object) do
-          super(query: query, field: field, ast_node: ast_node, arguments: arguments, object: object)
-        end
-      end
-
-      def authorized(query:, type:, object:)
-        authorized_span("authorized", object, type, query) do
-          super(query: query, type: type, object: object)
         end
-      end
-
-      def authorized_span(span_key, object, type, query)
-        platform_key = @platform_key_cache[DataDogTrace].platform_authorized_key_cache[type]
-        @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', span_key)
 
-          if @has_prepare_span
-            prepare_span(span_key, {object: object, type: type, query: query}, span)
+        include MonitorTrace::Monitor::GraphQLSuffixNames
+        class Event < MonitorTrace::Monitor::Event
+          def start
+            name = @monitor.name_for(keyword, object)
+            @dd_span = @monitor.tracer.trace(name, service: @monitor.service_name, type: 'custom')
           end
-          yield
-        end
-      end
-
-      def authorized_lazy(object:, type:, query:)
-        authorized_span("authorized_lazy", object, type, query) do
-          super(query: query, type: type, object: object)
-        end
-      end
-
-      def resolve_type(object:, type:, query:)
-        resolve_type_span("resolve_type", object, type, query) do
-          super(object: object, query: query, type: type)
-        end
-      end
-
-      def resolve_type_lazy(object:, type:, query:)
-        resolve_type_span("resolve_type_lazy", object, type, query) do
-          super(object: object, query: query, type: type)
-        end
-      end
-
-      def resolve_type_span(span_key, object, type, query)
-        platform_key = @platform_key_cache[DataDogTrace].platform_resolve_type_key_cache[type]
-        @tracer.trace(platform_key, service: @service_name, type: 'custom') do |span|
-          span.set_tag('component', 'graphql')
-          span.set_tag('operation', span_key)
 
-          if @has_prepare_span
-            prepare_span(span_key, {object: object, type: type, query: query}, span)
+          def finish
+            @dd_span.finish
           end
-          yield
         end
       end
-
-      include PlatformTrace
-
-      # 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 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/data_dog_tracing.rb

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

data/lib/graphql/tracing/detailed_trace/memory_backend.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    class DetailedTrace
+      # An in-memory trace storage backend. Suitable for testing and development only.
+      # It won't work for multi-process deployments and everything is erased when the app is restarted.
+      class MemoryBackend
+        def initialize(limit: nil)
+          @limit = limit
+          @traces = {}
+          @next_id = 0
+        end
+
+        def traces(last:, before:)
+          page = []
+          @traces.values.reverse_each do |trace|
+            if page.size == last
+              break
+            elsif before.nil? || trace.begin_ms < before
+              page << trace
+            end
+          end
+          page
+        end
+
+        def find_trace(id)
+          @traces[id]
+        end
+
+        def delete_trace(id)
+          @traces.delete(id.to_i)
+          nil
+        end
+
+        def delete_all_traces
+          @traces.clear
+          nil
+        end
+
+        def save_trace(operation_name, duration, begin_ms, trace_data)
+          id = @next_id
+          @next_id += 1
+          @traces[id] = DetailedTrace::StoredTrace.new(
+            id: id,
+            operation_name: operation_name,
+            duration_ms: duration,
+            begin_ms: begin_ms,
+            trace_data: trace_data
+          )
+          if @limit && @traces.size > @limit
+            del_keys = @traces.keys[0...-@limit]
+            del_keys.each { |k| @traces.delete(k) }
+          end
+          id
+        end
+      end
+    end
+  end
+end

data/lib/graphql/tracing/detailed_trace/redis_backend.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    class DetailedTrace
+      class RedisBackend
+        KEY_PREFIX = "gql:trace:"
+        def initialize(redis:, limit: nil)
+          @redis = redis
+          @key = KEY_PREFIX + "traces"
+          @remrangebyrank_limit = limit ? -limit - 1 : nil
+        end
+
+        def traces(last:, before:)
+          before = case before
+          when Numeric
+            "(#{before}"
+          when nil
+            "+inf"
+          end
+          str_pairs = @redis.zrange(@key, before, 0, byscore: true, rev: true, limit: [0, last || 100], withscores: true)
+          str_pairs.map do |(str_data, score)|
+            entry_to_trace(score, str_data)
+          end
+        end
+
+        def delete_trace(id)
+          @redis.zremrangebyscore(@key, id, id)
+          nil
+        end
+
+        def delete_all_traces
+          @redis.del(@key)
+        end
+
+        def find_trace(id)
+          str_data = @redis.zrange(@key, id, id, byscore: true).first
+          if str_data.nil?
+            nil
+          else
+            entry_to_trace(id, str_data)
+          end
+        end
+
+        def save_trace(operation_name, duration_ms, begin_ms, trace_data)
+          id = begin_ms
+          data = JSON.dump({ "o" => operation_name, "d" => duration_ms, "b" => begin_ms, "t" => Base64.encode64(trace_data) })
+          @redis.pipelined do |pipeline|
+            pipeline.zadd(@key, id, data)
+            if @remrangebyrank_limit
+              pipeline.zremrangebyrank(@key, 0, @remrangebyrank_limit)
+            end
+          end
+          id
+        end
+
+        private
+
+        def entry_to_trace(id, json_str)
+          data = JSON.parse(json_str)
+          StoredTrace.new(
+            id: id,
+            operation_name: data["o"],
+            duration_ms: data["d"].to_f,
+            begin_ms: data["b"].to_i,
+            trace_data: Base64.decode64(data["t"]),
+          )
+        end
+      end
+    end
+  end
+end

data/lib/graphql/tracing/detailed_trace.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+require "graphql/tracing/detailed_trace/memory_backend"
+require "graphql/tracing/detailed_trace/redis_backend"
+
+module GraphQL
+  module Tracing
+    # `DetailedTrace` can make detailed profiles for a subset of production traffic.
+    #
+    # When `MySchema.detailed_trace?(query)` returns `true`, a profiler-specific `trace_mode: ...` will be used for the query,
+    # overriding the one in `context[:trace_mode]`.
+    #
+    # __Redis__: The sampler stores its results in a provided Redis database. Depending on your needs,
+    # You can configure this database to retail all data (persistent) or to expire data according to your rules.
+    # If you need to save traces indefinitely, you can download them from Perfetto after opening them there.
+    #
+    # @example Adding the sampler to your schema
+    #   class MySchema < GraphQL::Schema
+    #     # Add the sampler:
+    #     use GraphQL::Tracing::DetailedTrace, redis: Redis.new(...), limit: 100
+    #
+    #     # And implement this hook to tell it when to take a sample:
+    #     def self.detailed_trace?(query)
+    #       # Could use `query.context`, `query.selected_operation_name`, `query.query_string` here
+    #       # Could call out to Flipper, etc
+    #       rand <= 0.000_1 # one in ten thousand
+    #     end
+    #   end
+    #
+    # @see Graphql::Dashboard GraphQL::Dashboard for viewing stored results
+    class DetailedTrace
+      # @param redis [Redis] If provided, profiles will be stored in Redis for later review
+      # @param limit [Integer] A maximum number of profiles to store
+      def self.use(schema, trace_mode: :profile_sample, memory: false, redis: nil, limit: nil)
+        storage = if redis
+          RedisBackend.new(redis: redis, limit: limit)
+        elsif memory
+          MemoryBackend.new(limit: limit)
+        else
+          raise ArgumentError, "Pass `redis: ...` to store traces in Redis for later review"
+        end
+        schema.detailed_trace = self.new(storage: storage, trace_mode: trace_mode)
+        schema.trace_with(PerfettoTrace, mode: trace_mode, save_profile: true)
+      end
+
+      def initialize(storage:, trace_mode:)
+        @storage = storage
+        @trace_mode = trace_mode
+      end
+
+      # @return [Symbol] The trace mode to use when {Schema.detailed_trace?} returns `true`
+      attr_reader :trace_mode
+
+      # @return [String] ID of saved trace
+      def save_trace(operation_name, duration_ms, begin_ms, trace_data)
+        @storage.save_trace(operation_name, duration_ms, begin_ms, trace_data)
+      end
+
+      # @param last [Integer]
+      # @param before [Integer] Timestamp in milliseconds since epoch
+      # @return [Enumerable<StoredTrace>]
+      def traces(last: nil, before: nil)
+        @storage.traces(last: last, before: before)
+      end
+
+      # @return [StoredTrace, nil]
+      def find_trace(id)
+        @storage.find_trace(id)
+      end
+
+      # @return [void]
+      def delete_trace(id)
+        @storage.delete_trace(id)
+      end
+
+      # @return [void]
+      def delete_all_traces
+        @storage.delete_all_traces
+      end
+
+      class StoredTrace
+        def initialize(id:, operation_name:, duration_ms:, begin_ms:, trace_data:)
+          @id = id
+          @operation_name = operation_name
+          @duration_ms = duration_ms
+          @begin_ms = begin_ms
+          @trace_data = trace_data
+        end
+
+        attr_reader :id, :operation_name, :duration_ms, :begin_ms, :trace_data
+      end
+    end
+  end
+end

data/lib/graphql/tracing/legacy_hooks_trace.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GraphQL
   module Tracing
     module LegacyHooksTrace

data/lib/graphql/tracing/legacy_trace.rb

@@ -1,67 +1,10 @@
 # frozen_string_literal: true
-module GraphQL
-  module Tracing
-    # This trace class calls legacy-style tracer with payload hashes.
-    # New-style `trace_with` modules significantly reduce the overhead of tracing,
-    # but that advantage is lost when legacy-style tracers are also used (since the payload hashes are still constructed).
-    module CallLegacyTracers
-      def lex(query_string:)
-        (@multiplex || @query).trace("lex", { query_string: query_string }) { super }
-      end
-
-      def parse(query_string:)
-        (@multiplex || @query).trace("parse", { query_string: query_string }) { super }
-      end
-
-      def validate(query:, validate:)
-        query.trace("validate", { validate: validate, query: query }) { super }
-      end
-
-      def analyze_multiplex(multiplex:)
-        multiplex.trace("analyze_multiplex", { multiplex: multiplex }) { super }
-      end
-
-      def analyze_query(query:)
-        query.trace("analyze_query", { query: query }) { super }
-      end
-
-      def execute_multiplex(multiplex:)
-        multiplex.trace("execute_multiplex", { multiplex: multiplex }) { super }
-      end
-
-      def execute_query(query:)
-        query.trace("execute_query", { query: query }) { super }
-      end
-
-      def execute_query_lazy(query:, multiplex:)
-        multiplex.trace("execute_query_lazy", { multiplex: multiplex, query: query }) { super }
-      end
 
-      def execute_field(field:, query:, ast_node:, arguments:, object:)
-        query.trace("execute_field", { field: field, query: query, ast_node: ast_node, arguments: arguments, object: object, owner: field.owner, path: query.context[:current_path] }) { super }
-      end
-
-      def execute_field_lazy(field:, query:, ast_node:, arguments:, object:)
-        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] }) { super }
-      end
-
-      def authorized(query:, type:, object:)
-        query.trace("authorized", { context: query.context, type: type, object: object, path: query.context[:current_path] }) { super }
-      end
-
-      def authorized_lazy(query:, type:, object:)
-        query.trace("authorized_lazy", { context: query.context, type: type, object: object, path: query.context[:current_path] }) { super }
-      end
-
-      def resolve_type(query:, type:, object:)
-        query.trace("resolve_type", { context: query.context, type: type, object: object, path: query.context[:current_path] }) { super }
-      end
-
-      def resolve_type_lazy(query:, type:, object:)
-        query.trace("resolve_type_lazy", { context: query.context, type: type, object: object, path: query.context[:current_path] }) { super }
-      end
-    end
+require "graphql/tracing/trace"
+require "graphql/tracing/call_legacy_tracers"
 
+module GraphQL
+  module Tracing
     class LegacyTrace < Trace
       include CallLegacyTracers
     end