graphql 2.4.8 → 2.4.11

data/lib/graphql/subscriptions/serialize.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 require "set"
-require "ostruct"
-
 module GraphQL
   class Subscriptions
     # Serialization helpers for passing subscription data around.
@@ -148,7 +146,7 @@ module GraphQL
           elsif obj.is_a?(Date) || obj.is_a?(Time)
             # DateTime extends Date; for TimeWithZone, call `.utc` first.
             { TIMESTAMP_KEY => [obj.class.name, obj.strftime(TIMESTAMP_FORMAT)] }
-          elsif obj.is_a?(OpenStruct)
+          elsif defined?(OpenStruct) && obj.is_a?(OpenStruct)
             { OPEN_STRUCT_KEY => dump_value(obj.to_h) }
           elsif defined?(ActiveRecord::Relation) && obj.is_a?(ActiveRecord::Relation)
             dump_value(obj.to_a)

data/lib/graphql/tracing/active_support_notifications_trace.rb

@@ -4,8 +4,12 @@ require "graphql/tracing/notifications_trace"
 
 module GraphQL
   module Tracing
-    # This implementation forwards events to ActiveSupport::Notifications
-    # with a `graphql` suffix.
+    # This implementation forwards events to ActiveSupport::Notifications with a `graphql` suffix.
+    #
+    # @example Sending execution events to ActiveSupport::Notifications
+    #   class MySchema < GraphQL::Schema
+    #     trace_with(GraphQL::Tracing::ActiveSupportNotificationsTrace)
+    #   end
     module ActiveSupportNotificationsTrace
       include NotificationsTrace
       def initialize(engine: ActiveSupport::Notifications, **rest)

data/lib/graphql/tracing/appoptics_trace.rb

@@ -22,10 +22,12 @@ module GraphQL
       # These GraphQL events will show up as 'graphql.execute' spans
       EXEC_KEYS = ['execute_multiplex', 'execute_query', 'execute_query_lazy'].freeze
 
+
       # During auto-instrumentation this version of AppOpticsTracing is compared
       # with the version provided in the appoptics_apm gem, so that the newer
       # version of the class can be used
 
+
       def self.version
         Gem::Version.new('1.0.0')
       end
@@ -83,7 +85,7 @@ module GraphQL
         end
       end
 
-      def execute_field_lazy(query:, field:, ast_node:, arguments:, object:)
+      def execute_field_lazy(query:, field:, ast_node:, arguments:, object:)  # rubocop:disable Development/TraceCallsSuperCop
         execute_field(query: query, field: field, ast_node: ast_node, arguments: arguments, object: object)
       end
 

data/lib/graphql/tracing/appsignal_trace.rb

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

data/lib/graphql/tracing/data_dog_trace.rb

@@ -4,6 +4,11 @@ require "graphql/tracing/platform_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
     module DataDogTrace
       # @param tracer [#trace] Deprecated
       # @param analytics_enabled [Boolean] Deprecated

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/new_relic_trace.rb

@@ -4,73 +4,179 @@ 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
     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)
+      # @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)
         @set_transaction_name = set_transaction_name
+        @trace_authorized = trace_authorized
+        @trace_resolve_type = trace_resolve_type
+        @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 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)
+      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))
         end
-        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped("GraphQL/execute") do
-          super
+        @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)
+        nr_segment_stack << NewRelic::Agent::Tracer.start_transaction_or_segment(partial_name: @nr_field_names[field], category: :web)
+        super
+      end
+
+      def end_execute_field(field, objects, arguments, query, result)
+        nr_segment_stack.pop.finish
+        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)
         end
+        super
       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
-            end
-          end
-        RUBY
-      end
-
-      def platform_execute_field(platform_key)
-        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
-          yield
+      def end_authorized(type, obj, ctx, is_authed)
+        if @trace_authorized
+          nr_segment_stack.pop.finish
         end
+        super
       end
 
-      def platform_authorized(platform_key)
-        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
-          yield
+      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)
         end
+        super
       end
 
-      def platform_resolve_type(platform_key)
-        NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(platform_key) do
-          yield
+      def end_resolve_type(type, value, context, resolved_type)
+        if @trace_resolve_type
+          nr_segment_stack.pop.finish
         end
+        super
       end
 
-      def platform_field_key(field)
-        "GraphQL/#{field.owner.graphql_name}/#{field.graphql_name}"
+      def begin_dataloader(dl)
+        super
       end
 
-      def platform_authorized_key(type)
-        "GraphQL/Authorize/#{type.graphql_name}"
+      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)
+        super
+      end
+
+      def end_dataloader_source(source)
+        nr_segment_stack.pop.finish
+        super
+      end
+
+      def dataloader_fiber_yield(source)
+        current_segment = nr_segment_stack.last
+        current_segment.finish
+        super
+      end
+
+      def dataloader_fiber_resume(source)
+        prev_segment = nr_segment_stack.pop
+        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)
+        super
+      end
+
+      private
+
+      def nr_segment_stack
+        Fiber[:graphql_nr_segment_stack] ||= []
+      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 platform_resolve_type_key(type)
-        "GraphQL/ResolveType/#{type.graphql_name}"
+      def fallback_transaction_name(context)
+        context[:tracing_fallback_transaction_name]
       end
     end
   end

data/lib/graphql/tracing/perfetto_trace/trace.proto

@@ -0,0 +1,141 @@
+// This is an abbreviated version of the full Perfetto schema.
+// Most of them are for OS or Chrome traces and we'll never use them.
+// Full doc: https://github.com/google/perfetto/tree/main/protos/perfetto
+//
+// Build it with
+// protoc --ruby_out=lib/graphql/tracing/perfetto_trace --proto_path=lib/graphql/tracing/perfetto_trace trace.proto
+syntax = "proto2";
+package perfetto_trace.protos;
+option ruby_package = "GraphQL::Tracing::PerfettoTrace";
+
+message Trace {
+  repeated TracePacket packet = 1;
+}
+
+message TracePacket {
+  optional uint64 timestamp = 8;
+  oneof data {
+    TrackEvent track_event = 11;
+    TrackDescriptor track_descriptor = 60;
+  }
+  oneof optional_trusted_packet_sequence_id {
+    uint32 trusted_packet_sequence_id = 10;
+  }
+  optional InternedData interned_data = 12;
+  optional bool first_packet_on_sequence = 87;
+  optional bool previous_packet_dropped = 42;
+  optional uint32 sequence_flags = 13;
+}
+
+message TrackEvent {
+  repeated uint64 category_iids = 3;
+  repeated string categories = 22;
+  oneof name_field {
+    uint64 name_iid = 10;
+    string name = 23;
+  }
+  enum Type {
+    TYPE_UNSPECIFIED = 0;
+    TYPE_SLICE_BEGIN = 1;
+    TYPE_SLICE_END = 2;
+    TYPE_INSTANT = 3;
+    TYPE_COUNTER = 4;
+  }
+  optional Type type = 9;
+  optional uint64 track_uuid = 11;
+  oneof counter_value_field {
+    int64 counter_value = 30;
+    double double_counter_value = 44;
+  }
+  repeated uint64 extra_counter_track_uuids = 31;
+  repeated int64 extra_counter_values = 12;
+  repeated uint64 extra_double_counter_track_uuids = 45;
+  repeated double extra_double_counter_values = 46;
+  repeated fixed64 flow_ids = 47;
+  repeated fixed64 terminating_flow_ids = 48;
+  repeated DebugAnnotation debug_annotations = 4;
+}
+
+message DebugAnnotation {
+  oneof name_field {
+    uint64 name_iid = 1;
+    string name = 10;
+  }
+  oneof value {
+    bool bool_value = 2;
+    uint64 uint_value = 3;
+    int64 int_value = 4;
+    double double_value = 5;
+    string string_value = 6;
+    uint64 string_value_iid = 17;
+  }
+  repeated DebugAnnotation dict_entries = 11;
+  repeated DebugAnnotation array_values = 12;
+  uint64 string_value_iid = 17;
+}
+
+message TrackDescriptor {
+  optional uint64 uuid = 1;
+  optional uint64 parent_uuid = 5;
+
+  oneof static_or_dynamic_name {
+    string name = 2;
+  }
+
+  optional CounterDescriptor counter = 8;
+  enum ChildTracksOrdering {
+    UNKNOWN = 0;
+    LEXICOGRAPHIC = 1;
+    CHRONOLOGICAL = 2;
+    EXPLICIT = 3;
+  }
+  optional ChildTracksOrdering child_ordering = 11;
+  optional int32 sibling_order_rank = 12;
+}
+
+message CounterDescriptor {
+  enum BuiltinCounterType {
+    COUNTER_UNSPECIFIED = 0;
+    COUNTER_THREAD_TIME_NS = 1;
+    COUNTER_THREAD_INSTRUCTION_COUNT = 2;
+  }
+  enum Unit {
+    UNIT_UNSPECIFIED = 0;
+    UNIT_TIME_NS = 1;
+    UNIT_COUNT = 2;
+    UNIT_SIZE_BYTES = 3;
+  }
+  optional BuiltinCounterType type = 1;
+  repeated string categories = 2;
+  optional Unit unit = 3;
+  optional string unit_name = 6;
+  optional int64 unit_multiplier = 4;
+  optional bool is_incremental = 5;
+}
+
+message InternedData {
+  repeated EventCategory event_categories = 1;
+  repeated EventName event_names = 2;
+  repeated DebugAnnotationName debug_annotation_names = 3;
+  repeated InternedString debug_annotation_string_values = 29;
+}
+
+message InternedString {
+  optional uint64 iid = 1;
+  optional bytes str = 2;
+}
+
+message EventCategory {
+  optional uint64 iid = 1;
+  optional string name = 2;
+}
+
+message EventName {
+  optional uint64 iid = 1;
+  optional string name = 2;
+}
+
+message DebugAnnotationName {
+  optional uint64 iid = 1;
+  optional string name = 2;
+}