graphql 2.6.11 → 2.6.13

data/lib/graphql/tracing/data_dog_trace.rb

@@ -1,15 +1,26 @@
 # frozen_string_literal: true
+# typed: ignore
 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
+    #
+    # **Examples**
+    #
+    # **Example: Adding this tracer to your schema**
+    #
+    # ```ruby
+    # class MySchema < GraphQL::Schema
+    #   trace_with GraphQL::Tracing::DataDogTrace
+    # end
+    # ```
+    #
+    # **Example: Skipping `resolve_type` and `authorized` events**
+    #
+    # ```ruby
+    # trace_with GraphQL::Tracing::DataDogTrace, trace_authorized: false, trace_resolve_type: false
+    # ```
     DataDogTrace = MonitorTrace.create_module("datadog")
     module DataDogTrace
       class DatadogMonitor < MonitorTrace::Monitor

data/lib/graphql/tracing/data_dog_tracing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 
 require "graphql/tracing/platform_tracing"
 
@@ -49,9 +50,15 @@ module GraphQL
       end
 
       # 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
+      #
+      # **Parameters**
+      #
+      # - `key` (`String`) — The event being traced
+      # - `data` (`Hash`) — The runtime data for this event; see [GraphQL::Tracing](rdoc-ref:GraphQL::Tracing) for keys for each event
+      # - `span` (`Datadog::Tracing::SpanOperation`) — The datadog span for this event
+      #
+      # :call-seq:
+      #   prepare_span(String key, Hash data, Datadog::Tracing::SpanOperation span)
       def prepare_span(key, data, span)
       end
 

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

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

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

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

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

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

data/lib/graphql/tracing/detailed_trace.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 if defined?(ActiveRecord)
   require "graphql/tracing/detailed_trace/active_record_backend"
 end
@@ -13,7 +14,7 @@ module GraphQL
     # overriding the one in `context[:trace_mode]`.
     #
     # By default, the detailed tracer calls `.inspect` on application objects returned from fields. You can customize
-    # this behavior by extending {DetailedTrace} and overriding {#inspect_object}. You can opt out of debug annotations
+    # this behavior by extending [DetailedTrace](rdoc-ref:DetailedTrace) and overriding [inspect object](rdoc-ref:#inspect_object). You can opt out of debug annotations
     # entirely with `use ..., debug: false` or for a single query with `context: { detailed_trace_debug: false }`.
     #
     # You can store saved traces in two ways:
@@ -26,46 +27,67 @@ module GraphQL
     #
     # If you need to save traces indefinitely, you can download them from Perfetto after opening them there.
     #
-    # @example Installing with Rails
-    #   rails generate graphql:detailed_trace # optional: --redis
+    # See [GraphQL::Dashboard](rdoc-ref:GraphQL::Dashboard) for viewing stored results.
     #
-    # @example Adding the sampler to your schema
-    #   class MySchema < GraphQL::Schema
-    #     # Add the sampler:
-    #     use GraphQL::Tracing::DetailedTrace, redis: Redis.new(...), limit: 100
+    # **Examples**
     #
-    #     # 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
+    # **Example: Installing with Rails**
+    #
+    # ```ruby
+    # rails generate graphql:detailed_trace # optional: --redis
+    # ```
+    #
+    # **Example: Adding the sampler to your schema**
+    #
+    # ```ruby
+    # 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
+    # ```
+    #
+    # **Example: Customizing debug output in traces**
     #
-    # @see Graphql::Dashboard GraphQL::Dashboard for viewing stored results
-    #
-    # @example Customizing debug output in traces
-    #   class CustomDetailedTrace < GraphQL::Tracing::DetailedTrace
-    #     def inspect_object(object)
-    #       if object.is_a?(SomeThing)
-    #         # handle it specially ...
-    #       else
-    #         super
-    #        end
-    #     end
+    # ```ruby
+    # class CustomDetailedTrace < GraphQL::Tracing::DetailedTrace
+    #   def inspect_object(object)
+    #     if object.is_a?(SomeThing)
+    #       # handle it specially ...
+    #     else
+    #       super
+    #      end
     #   end
+    # end
+    # ```
+    #
+    # **Example: disabling debug annotations completely**
     #
-    # @example disabling debug annotations completely
-    #    use DetailedTrace, debug: false, ...
+    # ```ruby
+    # use DetailedTrace, debug: false, ...
+    # ```
     #
-    # @example disabling debug annotations for one query
-    #    MySchema.execute(query_str, context: { detailed_trace_debug: false })
+    # **Example: disabling debug annotations for one query**
     #
+    # ```ruby
+    # MySchema.execute(query_str, context: { detailed_trace_debug: false })
+    # ```
     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
-      # @param debug [Boolean] if `false`, it won't create `debug` annotations in Perfetto traces (reduces overhead)
-      # @param model_class [Class<ActiveRecord::Base>] Overrides {ActiveRecordBackend::GraphqlDetailedTrace} if present
+      # **Parameters**
+      #
+      # - `redis` (`Redis`) — If provided, profiles will be stored in Redis for later review
+      # - `limit` (`Integer`) — A maximum number of profiles to store
+      # - `debug` (`Boolean`) — if `false`, it won't create `debug` annotations in Perfetto traces (reduces overhead)
+      # - `model_class` (`Class<ActiveRecord::Base>`) — Overrides [ActiveRecordBackend::GraphqlDetailedTrace](rdoc-ref:ActiveRecordBackend::GraphqlDetailedTrace) if present
+      #
+      # :call-seq:
+      #   use(schema, trace_mode:, memory:, bool debug:, Redis redis:, Integer limit:, Class[ActiveRecord::Base] model_class:)
       def self.use(schema, trace_mode: :profile_sample, memory: false, debug: debug?, redis: nil, limit: nil, model_class: nil)
         storage = if redis
           RedisBackend.new(redis: redis, limit: limit)
@@ -87,37 +109,72 @@ module GraphQL
         @debug = debug
       end
 
-      # @return [Symbol] The trace mode to use when {Schema.detailed_trace?} returns `true`
+      # **Returns**
+      #
+      # - `Symbol` — The trace mode to use when [Schema.detailed_trace?](rdoc-ref:Schema.detailed_trace?) returns `true`
       attr_reader :trace_mode
 
-      # @return [String] ID of saved trace
+      # **Returns**
+      #
+      # - `String` — ID of saved trace
+      #
+      # :call-seq:
+      #   save_trace(operation_name, duration_ms, begin_ms, trace_data) -> String
       def save_trace(operation_name, duration_ms, begin_ms, trace_data)
         @storage.save_trace(operation_name, duration_ms, begin_ms, trace_data)
       end
 
-      # @return [Boolean]
+      # **Returns**
+      #
+      # - `Boolean`
+      #
+      # :call-seq:
+      #   debug?() -> bool
       def debug?
         @debug
       end
 
-      # @param last [Integer]
-      # @param before [Integer] Timestamp in milliseconds since epoch
-      # @return [Enumerable<StoredTrace>]
+      # **Parameters**
+      #
+      # - `last` (`Integer`)
+      # - `before` (`Integer`) — Timestamp in milliseconds since epoch
+      #
+      # **Returns**
+      #
+      # - `Enumerable<StoredTrace>`
+      #
+      # :call-seq:
+      #   traces(Integer last:, Integer before:) -> Enumerable[StoredTrace]
       def traces(last: nil, before: nil)
         @storage.traces(last: last, before: before)
       end
 
-      # @return [StoredTrace, nil]
+      # **Returns**
+      #
+      # - `StoredTrace, nil`
+      #
+      # :call-seq:
+      #   find_trace(id) -> StoredTrace | nil
       def find_trace(id)
         @storage.find_trace(id)
       end
 
-      # @return [void]
+      # **Returns**
+      #
+      # - `void`
+      #
+      # :call-seq:
+      #   delete_trace(id) -> void
       def delete_trace(id)
         @storage.delete_trace(id)
       end
 
-      # @return [void]
+      # **Returns**
+      #
+      # - `void`
+      #
+      # :call-seq:
+      #   delete_all_traces() -> void
       def delete_all_traces
         @storage.delete_all_traces
       end
@@ -135,7 +192,13 @@ module GraphQL
       end
 
       # Default debug setting
-      # @return [true]
+      #
+      # **Returns**
+      #
+      # - `true`
+      #
+      # :call-seq:
+      #   debug?() -> true
       def self.debug?
         true
       end

data/lib/graphql/tracing/legacy_hooks_trace.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Tracing
@@ -14,6 +15,10 @@ module GraphQL
         end
       end
 
+      #--
+
+      # @requires_ancestor: Kernel
+
       module RunHooks
         module_function
         # Call the before_ hooks of each query,

data/lib/graphql/tracing/legacy_trace.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "graphql/tracing/trace"
 require "graphql/tracing/call_legacy_tracers"

data/lib/graphql/tracing/monitor_trace.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Tracing
     # This module is the basis for Ruby-level integration with third-party monitoring platforms.
     # Platform-specific traces include this module and implement an adapter.
     #
-    # @see ActiveSupportNotificationsTrace Integration via ActiveSupport::Notifications, an alternative approach.
+    # See [ActiveSupportNotificationsTrace](rdoc-ref:ActiveSupportNotificationsTrace) Integration via ActiveSupport::Notifications, an alternative approach.
     module MonitorTrace
       class Monitor
         def initialize(trace:, set_transaction_name:, **_rest)
@@ -22,7 +23,7 @@ module GraphQL
         end
 
         def start_event(keyword, object)
-          ev = self.class::Event.new(self, keyword, object)
+          ev = self.class.const_get(:Event).new(self, keyword, object)
           ev.start
           ev
         end
@@ -55,11 +56,11 @@ module GraphQL
             @platform_resolve_type_key_cache[object]
           when :dataloader_source
             @platform_source_class_key_cache[object.class]
-          when :parse then self.class::PARSE_NAME
-          when :lex then self.class::LEX_NAME
-          when :execute then self.class::EXECUTE_NAME
-          when :analyze then self.class::ANALYZE_NAME
-          when :validate then self.class::VALIDATE_NAME
+          when :parse then self.class.const_get(:PARSE_NAME)
+          when :lex then self.class.const_get(:LEX_NAME)
+          when :execute then self.class.const_get(:EXECUTE_NAME)
+          when :analyze then self.class.const_get(:ANALYZE_NAME)
+          when :validate then self.class.const_get(:VALIDATE_NAME)
           else
             raise "No name for #{keyword.inspect}"
           end
@@ -147,10 +148,15 @@ module GraphQL
       end
 
       MODULE_TEMPLATE = <<~RUBY
-        # @param set_transaction_name [Boolean] If `true`, use the GraphQL operation name as the request name on the monitoring platform
-        # @param trace_scalars [Boolean] If `true`, leaf fields will be traced too (Scalars _and_ Enums)
-        # @param trace_authorized [Boolean] If `false`, skip tracing `authorized?` calls
-        # @param trace_resolve_type [Boolean] If `false`, skip tracing `resolve_type?` calls
+        # **Parameters**
+        #
+        # - `set_transaction_name` (`Boolean`) — If `true`, use the GraphQL operation name as the request name on the monitoring platform
+        # - `trace_scalars` (`Boolean`) — If `true`, leaf fields will be traced too (Scalars _and_ Enums)
+        # - `trace_authorized` (`Boolean`) — If `false`, skip tracing `authorized?` calls
+        # - `trace_resolve_type` (`Boolean`) — If `false`, skip tracing `resolve_type?` calls
+        #
+        # :call-seq:
+        #   initialize(...)
         def initialize(...)
           setup_%{monitor}_monitor(...)
           super

data/lib/graphql/tracing/new_relic_trace.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 
 require "graphql/tracing/monitor_trace"
 
@@ -6,16 +7,24 @@ 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
+    # **Examples**
     #
-    #     # Optional, use the operation name to set the new relic transaction name:
-    #     # trace_with GraphQL::Tracing::NewRelicTrace, set_transaction_name: true
-    #   end
+    # **Example: Installing the tracer**
     #
-    # @example Installing without trace events for `authorized?` or `resolve_type` calls
-    #   trace_with GraphQL::Tracing::NewRelicTrace, trace_authorized: false, trace_resolve_type: false
+    # ```ruby
+    # 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
+    # ```
+    #
+    # **Example: Installing without trace events for `authorized?` or `resolve_type` calls**
+    #
+    # ```ruby
+    # trace_with GraphQL::Tracing::NewRelicTrace, trace_authorized: false, trace_resolve_type: false
+    # ```
     NewRelicTrace = MonitorTrace.create_module("newrelic")
     module NewRelicTrace
       class NewrelicMonitor < MonitorTrace::Monitor

data/lib/graphql/tracing/new_relic_tracing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 
 require "graphql/tracing/platform_tracing"
 
@@ -16,9 +17,12 @@ module GraphQL
         "execute_query_lazy" => "GraphQL/execute",
       }
 
-      # @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]`.
+      # **Parameters**
+      #
+      # - `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]`.
+      #
+      # :call-seq:
+      #   initialize(options)
       def initialize(options = {})
         @set_transaction_name = options.fetch(:set_transaction_name, false)
         super

data/lib/graphql/tracing/notifications_trace.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
+# typed: ignore
 
 module GraphQL
   module Tracing
     # 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
+    # See [ActiveSupportNotificationsTrace](rdoc-ref:ActiveSupportNotificationsTrace) ActiveSupport::Notifications integration
     module NotificationsTrace
-      # @api private
-      class Adapter
+      class Adapter # :nodoc:
         def instrument(keyword, payload, &block)
           raise "Implement #{self.class}#instrument to measure the block"
         end
@@ -37,8 +37,7 @@ module GraphQL
         end
       end
 
-      # @api private
-      class DryMonitorAdapter < Adapter
+      class DryMonitorAdapter < Adapter # :nodoc:
         def instrument(...)
           Dry::Monitor.instrument(...)
         end
@@ -54,8 +53,7 @@ module GraphQL
         end
       end
 
-      # @api private
-      class ActiveSupportNotificationsAdapter < Adapter
+      class ActiveSupportNotificationsAdapter < Adapter # :nodoc:
         def instrument(...)
           ActiveSupport::Notifications.instrument(...)
         end
@@ -73,7 +71,12 @@ module GraphQL
         end
       end
 
-      # @param engine [Class] The notifications engine to use, eg `Dry::Monitor` or `ActiveSupport::Notifications`
+      # **Parameters**
+      #
+      # - `engine` (`Class`) — The notifications engine to use, eg `Dry::Monitor` or `ActiveSupport::Notifications`
+      #
+      # :call-seq:
+      #   initialize(Class engine:, **rest)
       def initialize(engine:, **rest)
         adapter = if defined?(Dry::Monitor) && engine == Dry::Monitor
           DryMonitoringAdapter

data/lib/graphql/tracing/notifications_tracing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "graphql/tracing/platform_tracing"
 
@@ -8,7 +9,7 @@ module GraphQL
     # ActiveSupport::Notifications or Dry::Monitor::Notifications)
     # with a `graphql` suffix.
     #
-    # @see KEYS for event names
+    # See [KEYS](rdoc-ref:KEYS) for event names
     class NotificationsTracing
       # A cache of frequently-used keys to avoid needless string allocations
       KEYS = {
@@ -31,21 +32,36 @@ module GraphQL
 
       # Initialize a new NotificationsTracing instance
       #
-      # @param [Object] notifications_engine The notifications engine to use
+      # **Parameters**
+      #
+      # - `notifications_engine` (`Object`) — The notifications engine to use
+      #
+      # :call-seq:
+      #   initialize(Object notifications_engine)
       def initialize(notifications_engine)
         @notifications_engine = notifications_engine
       end
 
       # Sends a GraphQL tracing event to the notification handler
       #
-      # @example
-      # . notifications_engine = Dry::Monitor::Notifications.new(:graphql)
+      # **Yields:** The block to execute for the event
+      #
+      # **Examples**
+      #
+      # **Example: . notifications_engine = Dry::Monitor::Notifications.new(:graphql)**
+      #
+      # ```ruby
       # . tracer = GraphQL::Tracing::NotificationsTracing.new(notifications_engine)
       # . tracer.trace("lex") { ... }
+      # ```
+      #
+      # **Parameters**
+      #
+      # - `key` (`string`) — The key for the event
+      # - `metadata` (`Hash`) — The metadata for the event
       #
-      # @param [string] key The key for the event
-      # @param [Hash] metadata The metadata for the event
-      # @yield The block to execute for the event
+      # :call-seq:
+      #   trace(string key, Hash metadata, &blk)
       def trace(key, metadata, &blk)
         prefixed_key = KEYS[key] || "#{key}.graphql"
 

data/lib/graphql/tracing/null_trace.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "graphql/tracing/trace"
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: ignore
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: trace.proto
 

data/lib/graphql/tracing/perfetto_trace.rb

@@ -1,32 +1,40 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Tracing
     # This produces a trace file for inspecting in the [Perfetto Trace Viewer](https://ui.perfetto.dev).
     #
-    # To get the file, call {#write} on the trace.
+    # To get the file, call [write](rdoc-ref:#write) on the trace.
     #
     # Use "trace modes" to configure this to run on command or on a sample of traffic.
     #
-    # @example Writing trace output
+    # **Examples**
     #
-    #   result = MySchema.execute(...)
-    #   result.query.trace.write(file: "tmp/trace.dump")
+    # **Example: Writing trace output**
     #
-    # @example Running this instrumenter when `trace: true` is present in the request
+    # ```ruby
+    # result = MySchema.execute(...)
+    # result.query.trace.write(file: "tmp/trace.dump")
+    # ```
     #
-    #   class MySchema < GraphQL::Schema
-    #     # Only run this tracer when `context[:trace_mode]` is `:trace`
-    #     trace_with GraphQL::Tracing::Perfetto, mode: :trace
-    #   end
+    # **Example: Running this instrumenter when `trace: true` is present in the request**
     #
-    #   # In graphql_controller.rb:
+    # ```ruby
+    # class MySchema < GraphQL::Schema
+    #   # Only run this tracer when `context[:trace_mode]` is `:trace`
+    #   trace_with GraphQL::Tracing::Perfetto, mode: :trace
+    # end
     #
-    #   context[:trace_mode] = params[:trace] ? :trace : nil
-    #   result = MySchema.execute(query_str, context: context, variables: variables, ...)
-    #   if context[:trace_mode] == :trace
-    #     result.trace.write(file: ...)
-    #   end
+    # # In graphql_controller.rb:
     #
+    # context[:trace_mode] = params[:trace] ? :trace : nil
+    # result = MySchema.execute(query_str, context: context, variables: variables, ...)
+    # if context[:trace_mode] == :trace
+    #   result.trace.write(file: ...)
+    # end
+    # ```
+    #--
+    # @requires_ancestor: Kernel
     module PerfettoTrace
       # TODOs:
       # - Make debug annotations visible on both parts when dataloader is involved
@@ -74,7 +82,12 @@ module GraphQL
       DEBUG_INSPECT_EVENT_NAME_IID = 17
       DA_DEBUG_INSPECT_FOR_IID = 18
 
-      # @param active_support_notifications_pattern [String, RegExp, false] A filter for `ActiveSupport::Notifications`, if it's present. Or `false` to skip subscribing.
+      # **Parameters**
+      #
+      # - `active_support_notifications_pattern` (`String, RegExp, false`) — A filter for `ActiveSupport::Notifications`, if it's present. Or `false` to skip subscribing.
+      #
+      # :call-seq:
+      #   initialize(String | RegExp | false active_support_notifications_pattern:, save_profile:, **_rest)
       def initialize(active_support_notifications_pattern: nil, save_profile: false, **_rest)
         super
         @active_support_notifications_pattern = active_support_notifications_pattern
@@ -571,9 +584,18 @@ module GraphQL
       end
 
       # Dump protobuf output in the specified file.
-      # @param file [String] path to a file in a directory that already exists
-      # @param debug_json [Boolean] True to print JSON instead of binary
-      # @return [nil, String, Hash] If `file` was given, `nil`. If `file` was `nil`, a Hash if `debug_json: true`, else binary data.
+      #
+      # **Parameters**
+      #
+      # - `file` (`String`) — path to a file in a directory that already exists
+      # - `debug_json` (`Boolean`) — True to print JSON instead of binary
+      #
+      # **Returns**
+      #
+      # - `nil, String, Hash` — If `file` was given, `nil`. If `file` was `nil`, a Hash if `debug_json: true`, else binary data.
+      #
+      # :call-seq:
+      #   write(String file:, bool debug_json:) -> nil | String | Hash
       def write(file:, debug_json: false)
         trace = Trace.new(
           packet: @packets,

data/lib/graphql/tracing/platform_trace.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
   module Tracing
@@ -6,7 +7,7 @@ module GraphQL
       def initialize(trace_scalars: false, **_options)
         @trace_scalars = trace_scalars
 
-        @platform_key_cache = Hash.new { |h, mod| h[mod] = mod::KeyCache.new }
+        @platform_key_cache = Hash.new { |h, mod| h[mod] = mod.const_get(:KeyCache).new }
         super
       end
 
@@ -22,6 +23,7 @@ module GraphQL
 
 
       def platform_execute_field_lazy(*args, &block)
+        args = args #: untyped
         platform_execute_field(*args, &block)
       end