Merge pull request #25 from nullscreen/wl-FixBroadcastLoggerPatch

Fix broadcast logger patch

Author: justinhoward

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.9.2
+
+- Fix double log issue in Rails 7.1+
+
 ## 0.9.1
 
 - Remove Rails 8 from CI

lib/epilog/rails/railtie.rb

@@ -55,12 +55,26 @@ def self.rails_6_1_higher?
         end
       end
 
+      # In Rails 7.1+, the server, console, and other components (like Sidekiq)
+      # call Rails.logger.broadcast_to() to add additional log destinations.
+      # This causes duplicate log lines and can lead to blocks being executed
+      # multiple times (via BroadcastLogger's method_missing delegation).
+      #
+      # This initializer runs AFTER :initialize_logger (which wraps the logger
+      # in a BroadcastLogger) but BEFORE any after_initialize hooks (where
+      # Sidekiq and others add their loggers). This ensures the no-op is in
+      # place before anyone tries to call broadcast_to.
+      initializer 'epilog.prevent_broadcast', after: :initialize_logger do
+        if ::Rails.gem_version >= Gem::Version.new('7.1') && ::Rails.logger
+          ::Rails.logger.define_singleton_method(:broadcast_to) { |*| nil }
+        end
+      end
+
       # In Rails 7.1+, ActionView::LogSubscriber::Start are attached late
       # in the initialization process, so we need to disable them after
       # initialization completes
       config.after_initialize do
         disable_rails_defaults
-        prevent_double_logs_from_broadcast
       end
 
       class << self
@@ -101,21 +115,6 @@ def unsubscribe_action_view_start_listeners
           end
         end
 
-        # In Rails 7.1+, the server and console call Rails.logger.broadcast_to(console)
-        # which adds a second logger and causes every log line to appear twice
-        # (e.g. custom format + default Logger format). Override broadcast_to with
-        # a no-op to prevent adding duplicate destinations.
-        #
-        # This must be done in after_initialize (not at require time) because:
-        # 1. Rails wraps the logger in a BroadcastLogger during bootstrap
-        # 2. We need to override the instance method on the actual Rails.logger
-        def prevent_double_logs_from_broadcast
-          return if ::Rails.gem_version < Gem::Version.new('7.1')
-          return unless ::Rails.logger
-
-          ::Rails.logger.define_singleton_method(:broadcast_to) { |*| nil }
-        end
-
         def blacklisted_subscribers
           ActiveSupport::LogSubscriber.log_subscribers.select do |subscriber|
             SUBSCRIBER_BLACKLIST.include?(subscriber.class)

lib/epilog/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Epilog
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 
   def self.version
     Gem::Version.new(VERSION)

spec/rails/action_controller_subscriber_spec.rb

@@ -198,7 +198,7 @@ def params(values)
       Rails.logger.info('middle')
       expect { get(:index) }.to raise_error('Something bad happened')
 
-      controller_log = [request: hash_including(path: '/error')]
+      controller_log = [{ request: hash_including(path: '/error') }]
       expect(Rails.logger[0][4]).to match(controller_log)
       expect(Rails.logger[2][4]).to eq([])
       expect(Rails.logger[3][4]).to match(controller_log)

spec/rails/active_job_subscriber_spec.rb

@@ -100,7 +100,7 @@ def perform
       expect { described_class.perform_later }
         .to raise_error('Something went wrong')
 
-      job_context = [job: hash_including(class: 'TestErrorJob')]
+      job_context = [{ job: hash_including(class: 'TestErrorJob') }]
       expect(Rails.logger[0][4]).to match(job_context)
       expect(Rails.logger[2][4]).to eq([])
       log_line = Rails::VERSION::MAJOR >= 6 ? 4 : 3