graphql 2.4.9 → 2.4.11

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

@@ -23,6 +23,14 @@ module GraphQL
         yield
       end
 
+      # @param query_str [String]
+      # @return [void]
+      def begin_parse(query_str); end;
+      # @param query_str [String]
+      # @return [void]
+      def end_parse(query_str); end;
+      # @param query_string [String]
+      # @return [void]
       def parse(query_string:)
         yield
       end
@@ -31,6 +39,22 @@ module GraphQL
         yield
       end
 
+      def begin_validate(query, validate)
+      end
+
+      def end_validate(query, validate, errors)
+      end
+
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @param analyzers [Array<Class>]
+      # @return [void]
+      def begin_analyze_multiplex(multiplex, analyzers); end
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @param analyzers [Array<Class>]
+      # @return [void]
+      def end_analyze_multiplex(multiplex, analyzers); end
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @return [void]
       def analyze_multiplex(multiplex:)
         yield
       end
@@ -39,6 +63,20 @@ module GraphQL
         yield
       end
 
+      # This is the first event in the tracing lifecycle.
+      # Every Query is technically run _inside_ a {GraphQL::Multiplex}.
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @return [void]
+      def begin_execute_multiplex(multiplex); end;
+
+      # This is the last event of the tracing lifecycle.
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @return [void]
+      def end_execute_multiplex(multiplex); end;
+
+      # This wraps an entire `.execute` call.
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @return [void]
       def execute_multiplex(multiplex:)
         yield
       end
@@ -51,6 +89,20 @@ module GraphQL
         yield
       end
 
+      # GraphQL is about to resolve this field
+      # @param field [GraphQL::Schema::Field]
+      # @param object [GraphQL::Schema::Object]
+      # @param arguments [Hash]
+      # @param query [GraphQL::Query]
+      def begin_execute_field(field, object, arguments, query); end
+      # GraphQL just finished resolving this field
+      # @param field [GraphQL::Schema::Field]
+      # @param object [GraphQL::Schema::Object]
+      # @param arguments [Hash]
+      # @param query [GraphQL::Query]
+      # @param result [Object]
+      def end_execute_field(field, object, arguments, query, result); end
+
       def execute_field(field:, query:, ast_node:, arguments:, object:)
         yield
       end
@@ -63,6 +115,22 @@ module GraphQL
         yield
       end
 
+      # A call to `.authorized?` is starting
+      # @param type [Class<GraphQL::Schema::Object>]
+      # @param object [Object]
+      # @param context [GraphQL::Query::Context]
+      # @return [void]
+      def begin_authorized(type, object, context)
+      end
+      # A call to `.authorized?` just finished
+      # @param type [Class<GraphQL::Schema::Object>]
+      # @param object [Object]
+      # @param context [GraphQL::Query::Context]
+      # @param authorized_result [Boolean]
+      # @return [void]
+      def end_authorized(type, object, context, authorized_result)
+      end
+
       def authorized_lazy(query:, type:, object:)
         yield
       end
@@ -74,6 +142,62 @@ module GraphQL
       def resolve_type_lazy(query:, type:, object:)
         yield
       end
+
+      # A call to `.resolve_type` is starting
+      # @param type [Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>]
+      # @param value [Object]
+      # @param context [GraphQL::Query::Context]
+      # @return [void]
+      def begin_resolve_type(type, value, context)
+      end
+
+      # A call to `.resolve_type` just ended
+      # @param type [Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>]
+      # @param value [Object]
+      # @param context [GraphQL::Query::Context]
+      # @param resolved_type [Class<GraphQL::Schema::Object>]
+      # @return [void]
+      def end_resolve_type(type, value, context, resolved_type)
+      end
+
+      # A dataloader run is starting
+      # @param dataloader [GraphQL::Dataloader]
+      # @return [void]
+      def begin_dataloader(dataloader); end
+      # A dataloader run has ended
+      # @param dataloder [GraphQL::Dataloader]
+      # @return [void]
+      def end_dataloader(dataloader); end
+
+      # A source with pending keys is about to fetch
+      # @param source [GraphQL::Dataloader::Source]
+      # @return [void]
+      def begin_dataloader_source(source); end
+      # A fetch call has just ended
+      # @param source [GraphQL::Dataloader::Source]
+      # @return [void]
+      def end_dataloader_source(source); end
+
+      # Called when Dataloader spins up a new fiber for GraphQL execution
+      # @param jobs [Array<#call>] Execution steps to run
+      # @return [void]
+      def dataloader_spawn_execution_fiber(jobs); end
+      # Called when Dataloader spins up a new fiber for fetching data
+      # @param pending_sources [GraphQL::Dataloader::Source] Instances with pending keys
+      # @return [void]
+      def dataloader_spawn_source_fiber(pending_sources); end
+      # Called when an execution or source fiber terminates
+      # @return [void]
+      def dataloader_fiber_exit; end
+
+      # Called when a Dataloader fiber is paused to wait for data
+      # @param source [GraphQL::Dataloader::Source] The Source whose `load` call initiated this `yield`
+      # @return [void]
+      def dataloader_fiber_yield(source); end
+      # Called when a Dataloader fiber is resumed because data has been loaded
+      # @param source [GraphQL::Dataloader::Source] The Source whose `load` call previously caused this Fiber to wait
+      # @return [void]
+      def dataloader_fiber_resume(source); end
     end
   end
 end

data/lib/graphql/tracing.rb

@@ -31,6 +31,8 @@ module GraphQL
     autoload :ScoutTrace, "graphql/tracing/scout_trace"
     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.9"
+  VERSION = "2.4.11"
 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.9
+  version: 2.4.11
 platform: ruby
 authors:
 - Robert Mosolgo
 bindir: bin
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -79,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: graphql-batch
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +289,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-sass-converter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -431,7 +459,19 @@ 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
 - lib/graphql/dataloader/async_dataloader.rb
 - lib/graphql/dataloader/null_dataloader.rb
 - lib/graphql/dataloader/request.rb
@@ -560,6 +600,7 @@ files:
 - lib/graphql/schema/member/graphql_type_names.rb
 - lib/graphql/schema/member/has_arguments.rb
 - lib/graphql/schema/member/has_ast_node.rb
+- lib/graphql/schema/member/has_dataloader.rb
 - lib/graphql/schema/member/has_deprecation_reason.rb
 - lib/graphql/schema/member/has_directives.rb
 - lib/graphql/schema/member/has_fields.rb
@@ -573,7 +614,6 @@ files:
 - lib/graphql/schema/member/validates_input.rb
 - lib/graphql/schema/mutation.rb
 - lib/graphql/schema/non_null.rb
-- lib/graphql/schema/null_mask.rb
 - lib/graphql/schema/object.rb
 - lib/graphql/schema/printer.rb
 - lib/graphql/schema/relay_classic_mutation.rb
@@ -691,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
@@ -698,6 +741,9 @@ files:
 - lib/graphql/tracing/notifications_trace.rb
 - lib/graphql/tracing/notifications_tracing.rb
 - lib/graphql/tracing/null_trace.rb
+- lib/graphql/tracing/perfetto_trace.rb
+- lib/graphql/tracing/perfetto_trace/trace.proto
+- lib/graphql/tracing/perfetto_trace/trace_pb.rb
 - lib/graphql/tracing/platform_trace.rb
 - lib/graphql/tracing/platform_tracing.rb
 - lib/graphql/tracing/prometheus_trace.rb

data/lib/graphql/schema/null_mask.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  class Schema
-    # @api private
-    module NullMask
-      def self.call(member, ctx)
-        false
-      end
-    end
-  end
-end