Merge pull request #4875 from rmosolgo/trace-module-inheritance-regression

Re-apply modules to newly added default trace mode class

Author: rmosolgo

Gemfile

@@ -7,7 +7,6 @@ gem 'bootsnap' # required by the Rails apps generated in tests
 gem 'stackprof', platform: :ruby
 gem 'pry'
 gem 'pry-stack_explorer', platform: :ruby
-gem 'graphql-batch'
 gem 'pry-byebug'
 
 # For Ruby 3.2 compat:

graphql.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "benchmark-ips"
   s.add_development_dependency "concurrent-ruby", "~>1.0"
+  s.add_development_dependency "graphql-batch"
   s.add_development_dependency "memory_profiler"
 
   s.add_development_dependency "minitest"

lib/graphql/schema.rb

@@ -158,6 +158,10 @@ def default_trace_mode(new_mode = nil)
 
       def trace_class(new_class = nil)
         if new_class
+          # If any modules were already added for `:default`,
+          # re-apply them here
+          mods = trace_modules_for(:default)
+          mods.each { |mod| new_class.include(mod) }
           trace_mode(:default, new_class)
           backtrace_class = Class.new(new_class)
           backtrace_class.include(GraphQL::Backtrace::Trace)

spec/graphql/tracing/trace_modes_spec.rb

@@ -148,6 +148,12 @@ def execute_query(query:)
       GraphQL::Schema.send(:own_tracers).delete(tracer_class)
       GraphQL::Schema.own_trace_modes[:default] = GraphQL::Schema.build_trace_mode(:default)
       refute_includes GraphQL::Schema.new_trace.class.ancestors, GraphQL::Tracing::CallLegacyTracers
+    ensure
+      # Since this modifies the base class, make sure it's undone for future test cases
+      GraphQL::Schema.instance_variable_get(:@own_tracers).clear
+      GraphQL::Schema.own_trace_modes.clear
+      GraphQL::Schema.own_trace_modules.clear
+      GraphQL::Schema.instance_variable_get(:@trace_options_for_mode).clear
     end
   end
 
@@ -248,4 +254,27 @@ def initialize(arg2:, **kwargs)
       assert ModeOptionsSchema.new_trace(mode: :extra)
     end
   end
+
+  module SomeTraceMod
+    def execute_query(query)
+      super
+    end
+  end
+
+  CustomTraceClass = Class.new(GraphQL::Tracing::Trace)
+
+  class BaseSchemaWithCustomTraceClass < GraphQL::Schema
+    use(GraphQL::Batch)
+    trace_class(CustomTraceClass)
+    trace_with(SomeTraceMod)
+  end
+
+  ChildSchema = Class.new(BaseSchemaWithCustomTraceClass)
+
+  describe "custom trace class supports trace module inheritance" do
+    it "inherits parent trace modules" do
+      assert_equal [GraphQL::Batch::SetupMultiplex::Trace, SomeTraceMod], ChildSchema.trace_modules_for(:default)
+      assert ChildSchema.new_trace.instance_variable_defined?(:@executor_class)
+    end
+  end
 end

spec/spec_helper.rb

@@ -23,6 +23,7 @@
 require "minitest/autorun"
 require "minitest/focus"
 require "minitest/reporters"
+require "graphql/batch"
 
 running_in_rubymine = ENV["RM_INFO"]
 unless running_in_rubymine