graphql 2.4.3 → 2.5.3

data/lib/graphql/tracing/notifications_trace.rb

@@ -1,45 +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
-
-      {
-        "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
+
+          def finish
+            raise "Implement #{self.class}#finish to end this event (#{inspect})"
+          end
+        end
+      end
+
+      # @api private
+      class DryMonitorAdapter < Adapter
+        def instrument(...)
+          Dry::Monitor.instrument(...)
+        end
+
+        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
-        RUBY
+
+          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
 
-      include PlatformTrace
+      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/notifications_tracing.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "graphql/tracing/platform_tracing"
+
 module GraphQL
   module Tracing
     # This implementation forwards events to a notification handler (i.e.

data/lib/graphql/tracing/null_trace.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "graphql/tracing/trace"
+
+module GraphQL
+  module Tracing
+    NullTrace = Trace.new
+  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;
+}

data/lib/graphql/tracing/perfetto_trace/trace_pb.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: trace.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x0btrace.proto\x12\x15perfetto_trace.protos\";\n\x05Trace\x12\x32\n\x06packet\x18\x01 \x03(\x0b\x32\".perfetto_trace.protos.TracePacket\"\x8a\x03\n\x0bTracePacket\x12\x11\n\ttimestamp\x18\x08 \x01(\x04\x12\x38\n\x0btrack_event\x18\x0b \x01(\x0b\x32!.perfetto_trace.protos.TrackEventH\x00\x12\x42\n\x10track_descriptor\x18< \x01(\x0b\x32&.perfetto_trace.protos.TrackDescriptorH\x00\x12$\n\x1atrusted_packet_sequence_id\x18\n \x01(\rH\x01\x12:\n\rinterned_data\x18\x0c \x01(\x0b\x32#.perfetto_trace.protos.InternedData\x12 \n\x18\x66irst_packet_on_sequence\x18W \x01(\x08\x12\x1f\n\x17previous_packet_dropped\x18* \x01(\x08\x12\x16\n\x0esequence_flags\x18\r \x01(\rB\x06\n\x04\x64\x61taB%\n#optional_trusted_packet_sequence_id\"\xf2\x04\n\nTrackEvent\x12\x15\n\rcategory_iids\x18\x03 \x03(\x04\x12\x12\n\ncategories\x18\x16 \x03(\t\x12\x12\n\x08name_iid\x18\n \x01(\x04H\x00\x12\x0e\n\x04name\x18\x17 \x01(\tH\x00\x12\x34\n\x04type\x18\t \x01(\x0e\x32&.perfetto_trace.protos.TrackEvent.Type\x12\x12\n\ntrack_uuid\x18\x0b \x01(\x04\x12\x17\n\rcounter_value\x18\x1e \x01(\x03H\x01\x12\x1e\n\x14\x64ouble_counter_value\x18, \x01(\x01H\x01\x12!\n\x19\x65xtra_counter_track_uuids\x18\x1f \x03(\x04\x12\x1c\n\x14\x65xtra_counter_values\x18\x0c \x03(\x03\x12(\n extra_double_counter_track_uuids\x18- \x03(\x04\x12#\n\x1b\x65xtra_double_counter_values\x18. \x03(\x01\x12\x10\n\x08\x66low_ids\x18/ \x03(\x06\x12\x1c\n\x14terminating_flow_ids\x18\x30 \x03(\x06\x12\x41\n\x11\x64\x65\x62ug_annotations\x18\x04 \x03(\x0b\x32&.perfetto_trace.protos.DebugAnnotation\"j\n\x04Type\x12\x14\n\x10TYPE_UNSPECIFIED\x10\x00\x12\x14\n\x10TYPE_SLICE_BEGIN\x10\x01\x12\x12\n\x0eTYPE_SLICE_END\x10\x02\x12\x10\n\x0cTYPE_INSTANT\x10\x03\x12\x10\n\x0cTYPE_COUNTER\x10\x04\x42\x0c\n\nname_fieldB\x15\n\x13\x63ounter_value_field\"\xd5\x02\n\x0f\x44\x65\x62ugAnnotation\x12\x12\n\x08name_iid\x18\x01 \x01(\x04H\x00\x12\x0e\n\x04name\x18\n \x01(\tH\x00\x12\x14\n\nbool_value\x18\x02 \x01(\x08H\x01\x12\x14\n\nuint_value\x18\x03 \x01(\x04H\x01\x12\x13\n\tint_value\x18\x04 \x01(\x03H\x01\x12\x16\n\x0c\x64ouble_value\x18\x05 \x01(\x01H\x01\x12\x16\n\x0cstring_value\x18\x06 \x01(\tH\x01\x12\x1a\n\x10string_value_iid\x18\x11 \x01(\x04H\x01\x12<\n\x0c\x64ict_entries\x18\x0b \x03(\x0b\x32&.perfetto_trace.protos.DebugAnnotation\x12<\n\x0c\x61rray_values\x18\x0c \x03(\x0b\x32&.perfetto_trace.protos.DebugAnnotationB\x0c\n\nname_fieldB\x07\n\x05value\"\xe1\x02\n\x0fTrackDescriptor\x12\x0c\n\x04uuid\x18\x01 \x01(\x04\x12\x13\n\x0bparent_uuid\x18\x05 \x01(\x04\x12\x0e\n\x04name\x18\x02 \x01(\tH\x00\x12\x39\n\x07\x63ounter\x18\x08 \x01(\x0b\x32(.perfetto_trace.protos.CounterDescriptor\x12R\n\x0e\x63hild_ordering\x18\x0b \x01(\x0e\x32:.perfetto_trace.protos.TrackDescriptor.ChildTracksOrdering\x12\x1a\n\x12sibling_order_rank\x18\x0c \x01(\x05\"V\n\x13\x43hildTracksOrdering\x12\x0b\n\x07UNKNOWN\x10\x00\x12\x11\n\rLEXICOGRAPHIC\x10\x01\x12\x11\n\rCHRONOLOGICAL\x10\x02\x12\x0c\n\x08\x45XPLICIT\x10\x03\x42\x18\n\x16static_or_dynamic_name\"\xb9\x03\n\x11\x43ounterDescriptor\x12I\n\x04type\x18\x01 \x01(\x0e\x32;.perfetto_trace.protos.CounterDescriptor.BuiltinCounterType\x12\x12\n\ncategories\x18\x02 \x03(\t\x12;\n\x04unit\x18\x03 \x01(\x0e\x32-.perfetto_trace.protos.CounterDescriptor.Unit\x12\x11\n\tunit_name\x18\x06 \x01(\t\x12\x17\n\x0funit_multiplier\x18\x04 \x01(\x03\x12\x16\n\x0eis_incremental\x18\x05 \x01(\x08\"o\n\x12\x42uiltinCounterType\x12\x17\n\x13\x43OUNTER_UNSPECIFIED\x10\x00\x12\x1a\n\x16\x43OUNTER_THREAD_TIME_NS\x10\x01\x12$\n COUNTER_THREAD_INSTRUCTION_COUNT\x10\x02\"S\n\x04Unit\x12\x14\n\x10UNIT_UNSPECIFIED\x10\x00\x12\x10\n\x0cUNIT_TIME_NS\x10\x01\x12\x0e\n\nUNIT_COUNT\x10\x02\x12\x13\n\x0fUNIT_SIZE_BYTES\x10\x03\"\xa0\x02\n\x0cInternedData\x12>\n\x10\x65vent_categories\x18\x01 \x03(\x0b\x32$.perfetto_trace.protos.EventCategory\x12\x35\n\x0b\x65vent_names\x18\x02 \x03(\x0b\x32 .perfetto_trace.protos.EventName\x12J\n\x16\x64\x65\x62ug_annotation_names\x18\x03 \x03(\x0b\x32*.perfetto_trace.protos.DebugAnnotationName\x12M\n\x1e\x64\x65\x62ug_annotation_string_values\x18\x1d \x03(\x0b\x32%.perfetto_trace.protos.InternedString\"*\n\x0eInternedString\x12\x0b\n\x03iid\x18\x01 \x01(\x04\x12\x0b\n\x03str\x18\x02 \x01(\x0c\"*\n\rEventCategory\x12\x0b\n\x03iid\x18\x01 \x01(\x04\x12\x0c\n\x04name\x18\x02 \x01(\t\"&\n\tEventName\x12\x0b\n\x03iid\x18\x01 \x01(\x04\x12\x0c\n\x04name\x18\x02 \x01(\t\"0\n\x13\x44\x65\x62ugAnnotationName\x12\x0b\n\x03iid\x18\x01 \x01(\x04\x12\x0c\n\x04name\x18\x02 \x01(\tB\"\xea\x02\x1fGraphQL::Tracing::PerfettoTrace"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module GraphQL
+  module Tracing
+    module PerfettoTrace
+      Trace = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.Trace").msgclass
+      TracePacket = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.TracePacket").msgclass
+      TrackEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.TrackEvent").msgclass
+      TrackEvent::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.TrackEvent.Type").enummodule
+      DebugAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.DebugAnnotation").msgclass
+      TrackDescriptor = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.TrackDescriptor").msgclass
+      TrackDescriptor::ChildTracksOrdering = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.TrackDescriptor.ChildTracksOrdering").enummodule
+      CounterDescriptor = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.CounterDescriptor").msgclass
+      CounterDescriptor::BuiltinCounterType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.CounterDescriptor.BuiltinCounterType").enummodule
+      CounterDescriptor::Unit = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.CounterDescriptor.Unit").enummodule
+      InternedData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.InternedData").msgclass
+      InternedString = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.InternedString").msgclass
+      EventCategory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.EventCategory").msgclass
+      EventName = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.EventName").msgclass
+      DebugAnnotationName = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("perfetto_trace.protos.DebugAnnotationName").msgclass
+    end
+  end
+end