Tune #inspect output for Sidekiq::Component and Sidekiq::Config to keep size managable, fixes sidekiq#6553

Author: mperham

lib/sidekiq/component.rb

@@ -81,5 +81,27 @@ def fire_event(event, options = {})
       end
       arr.clear if oneshot # once we've fired an event, we never fire it again
     end
+
+    # When you have a large tree of components, the `inspect` output
+    # can get out of hand, especially with lots of Sidekiq::Config
+    # references everywhere. We avoid calling `inspect` on more complex
+    # state and use `to_s` instead to keep output manageable, #6553
+    def inspect
+      "#<#{self.class.name} #{
+        instance_variables.map do |name|
+          value = instance_variable_get(name)
+          case value
+          when Proc
+            "#{name}=#{value}"
+          when Sidekiq::Config
+            "#{name}=#{value}"
+          when Sidekiq::Component
+            "#{name}=#{value}"
+          else
+            "#{name}=#{value.inspect}"
+          end
+        end.join(", ")
+      }>"
+    end
   end
 end

lib/sidekiq/config.rb

@@ -65,6 +65,12 @@ def initialize(options = {})
     attr_reader :capsules
     attr_accessor :thread_priority
 
+    def inspect
+      "#<#{self.class.name} @options=#{
+        @options.except(:lifecycle_events, :reloader, :death_handlers, :error_handlers).inspect
+      }>"
+    end
+
     def to_json(*)
       Sidekiq.dump_json(@options)
     end

test/config_test.rb

@@ -16,4 +16,10 @@
     @config.redis = {size: 3}
     assert_equal 3, @config.redis_pool.size
   end
+
+  it "keeps #inspect output managable" do
+    assert_operator @config.inspect.size, :<, 500
+    refute_match(/death_handlers/, @config.inspect)
+    refute_match(/error_handlers/, @config.inspect)
+  end
 end