preserve existing prosopite custom loggers

Author: joshuay03

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+-  Preserve existing prosopite custom loggers
+
 ## [0.5.1] - 2025-09-27
 
 - Don't clean up stale storage data in railtie

lib/dial/prosopite.rb

@@ -2,8 +2,35 @@
 
 require "active_support/core_ext/string/filters"
 
+require_relative "prosopite_composite_logger"
+
 module Dial
   module Prosopite
+    def custom_logger= logger
+      return super logger if @setting_dial_logger
+
+      @original_logger = logger
+
+      if @dial_logger && @original_logger
+        super ProsopiteCompositeLogger.new @dial_logger, @original_logger
+      else
+        super logger
+      end
+    end
+
+    def dial_logger= logger
+      @dial_logger = logger
+
+      @setting_dial_logger = true
+      if @original_logger
+        self.custom_logger = ProsopiteCompositeLogger.new @dial_logger, @original_logger
+      else
+        self.custom_logger = @dial_logger
+      end
+    ensure
+      @setting_dial_logger = false
+    end
+
     def send_notifications
       tc[:prosopite_notifications] = tc[:prosopite_notifications].to_h do |queries, kaller|
         [queries.map { |query| query.squish }, kaller]

lib/dial/prosopite_composite_logger.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Dial
+  class ProsopiteCompositeLogger
+    def initialize dial_logger, existing_logger = nil
+      @dial_logger = dial_logger
+      @existing_logger = existing_logger
+    end
+
+    def level
+      @dial_logger.level
+    end
+
+    def level= value
+      @dial_logger.level = value
+      @existing_logger.level = value if @existing_logger&.respond_to? :level=
+    end
+
+    def method_missing method, *args, &block
+      result = nil
+      result = @dial_logger.send method, *args, &block if @dial_logger.respond_to? method
+      @existing_logger.send method, *args, &block if @existing_logger&.respond_to? method
+      result
+    end
+
+    def respond_to_missing? method, include_private = false
+      @dial_logger.respond_to?(method, include_private) ||
+        @existing_logger&.respond_to?(method, include_private) ||
+          false
+    end
+  end
+end

lib/dial/railtie.rb

@@ -15,7 +15,7 @@ class Railtie < ::Rails::Railtie
         if ::ActiveRecord::Base.configurations.configurations.any? { |config| config.adapter == "postgresql" }
           require "pg_query"
         end
-        ::Prosopite.custom_logger = ProsopiteLogger.new
+        ::Prosopite.dial_logger = ProsopiteLogger.new
 
         # finalize configuration
         Dial._configuration.freeze

test/dial/test_prosopite_composite_logger.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Dial
+  class TestProsopiteCompositeLogger < ActiveSupport::TestCase
+    def setup
+      @dial_logger = ProsopiteLogger.new
+      @existing_logger = Logger.new StringIO.new
+      @composite_logger = ProsopiteCompositeLogger.new @dial_logger, @existing_logger
+    end
+
+    def test_composite_logger_delegates_to_both_loggers
+      message = "Test N+1 query detected"
+
+      @composite_logger.warn message
+
+      assert_includes ProsopiteLogger.log_io.string, message
+      assert @existing_logger.respond_to? :warn
+    end
+
+    def test_composite_logger_handles_nil_existing_logger
+      composite_logger = ProsopiteCompositeLogger.new @dial_logger, nil
+
+      assert_nothing_raised do
+        composite_logger.warn "Test message"
+      end
+
+      assert_includes ProsopiteLogger.log_io.string, "Test message"
+    end
+
+    def test_composite_logger_forwards_all_methods
+      assert_nothing_raised do
+        @composite_logger.info "test info"
+        @composite_logger.add Logger::WARN, "test add"
+      end
+
+      log_content = ProsopiteLogger.log_io.string
+      assert_includes log_content, "test info"
+      assert_includes log_content, "test add"
+    end
+
+    def test_composite_logger_level_getter_and_setter
+      @dial_logger.level = Logger::ERROR
+      assert_equal Logger::ERROR, @composite_logger.level
+
+      @composite_logger.level = Logger::WARN
+      assert_equal Logger::WARN, @dial_logger.level
+      assert_equal Logger::WARN, @existing_logger.level
+    end
+
+    def test_method_missing_delegation
+      assert @composite_logger.respond_to? :progname
+
+      assert_nothing_raised do
+        @composite_logger.progname
+      end
+    end
+
+    def test_respond_to_missing_works_correctly
+      assert @composite_logger.respond_to? :warn
+      assert @composite_logger.respond_to? :progname
+      refute @composite_logger.respond_to? :nonexistent_method
+    end
+  end
+end

test/dial/test_prosopite_integration.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Dial
+  class TestProsopiteIntegration < ActiveSupport::TestCase
+    def setup
+      ::Prosopite.instance_variable_set :@custom_logger, false
+      ::Prosopite.instance_variable_set :@dial_logger, nil
+      ::Prosopite.instance_variable_set :@original_logger, nil
+    end
+
+    def teardown
+      ::Prosopite.instance_variable_set :@custom_logger, false
+      ::Prosopite.instance_variable_set :@dial_logger, nil
+      ::Prosopite.instance_variable_set :@original_logger, nil
+    end
+
+    def test_dial_logger_sets_custom_logger_when_none_exists
+      test_logger = ProsopiteLogger.new
+
+      ::Prosopite.dial_logger = test_logger
+
+      assert_equal test_logger, ::Prosopite.instance_variable_get(:@custom_logger)
+    end
+
+    def test_dial_logger_preserves_existing_custom_logger
+      existing_logger = Logger.new StringIO.new
+      ::Prosopite.custom_logger = existing_logger
+
+      dial_logger = ProsopiteLogger.new
+      ::Prosopite.dial_logger = dial_logger
+
+      assert_instance_of ProsopiteCompositeLogger, ::Prosopite.instance_variable_get(:@custom_logger)
+    end
+
+    def test_setting_custom_logger_after_dial_logger_creates_composite
+      dial_logger = ProsopiteLogger.new
+      ::Prosopite.dial_logger = dial_logger
+
+      existing_logger = Logger.new StringIO.new
+      ::Prosopite.custom_logger = existing_logger
+
+      assert_instance_of ProsopiteCompositeLogger, ::Prosopite.instance_variable_get(:@custom_logger)
+    end
+
+    def test_setting_dial_logger_twice_updates_composite
+      existing_logger = Logger.new StringIO.new
+      ::Prosopite.custom_logger = existing_logger
+
+      dial_logger1 = ProsopiteLogger.new
+      ::Prosopite.dial_logger = dial_logger1
+
+      first_composite = ::Prosopite.instance_variable_get(:@custom_logger)
+      assert_instance_of ProsopiteCompositeLogger, first_composite
+
+      dial_logger2 = ProsopiteLogger.new
+      ::Prosopite.dial_logger = dial_logger2
+
+      second_composite = ::Prosopite.instance_variable_get(:@custom_logger)
+      assert_instance_of ProsopiteCompositeLogger, second_composite
+
+      refute_same first_composite, second_composite
+    end
+
+    def test_composite_logger_receives_notifications
+      existing_io = StringIO.new
+      existing_logger = Logger.new existing_io
+      ::Prosopite.custom_logger = existing_logger
+
+      dial_logger = ProsopiteLogger.new
+      ::Prosopite.dial_logger = dial_logger
+
+      Thread.current[:prosopite_notifications] = {
+        ["SELECT * FROM users"] => ["app/controllers/users_controller.rb:10"]
+      }
+
+      ::Prosopite.send :send_notifications
+
+      assert_includes existing_io.string, "N+1 queries detected"
+      assert_includes ProsopiteLogger.log_io.string, "N+1 queries detected"
+    end
+
+    def test_setting_same_logger_twice_does_not_create_nested_composite
+      existing_logger = Logger.new StringIO.new
+      ::Prosopite.custom_logger = existing_logger
+
+      dial_logger = ProsopiteLogger.new
+      ::Prosopite.dial_logger = dial_logger
+
+      ::Prosopite.custom_logger = existing_logger
+
+      custom_logger = ::Prosopite.instance_variable_get(:@custom_logger)
+      assert_instance_of ProsopiteCompositeLogger, custom_logger
+
+      dial_internal = custom_logger.instance_variable_get(:@dial_logger)
+      existing_internal = custom_logger.instance_variable_get(:@existing_logger)
+
+      assert_equal dial_logger, dial_internal
+      assert_equal existing_logger, existing_internal
+    end
+
+    def test_setting_custom_logger_to_nil_removes_existing_logger
+      existing_logger = Logger.new StringIO.new
+      ::Prosopite.custom_logger = existing_logger
+
+      dial_logger = ProsopiteLogger.new
+      ::Prosopite.dial_logger = dial_logger
+
+      ::Prosopite.custom_logger = nil
+
+      assert_nil ::Prosopite.instance_variable_get(:@custom_logger)
+    end
+  end
+end