Skip to content

[feat] make logger in Rails include AS::LoggerSilence #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/main/ruby/jruby/rack/rails/railtie.rb
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,11 @@ class Railtie < ::Rails::Railtie
log_formatter = config.log_formatter if config.respond_to?(:log_formatter)
logger.formatter = log_formatter if log_formatter && logger.respond_to?(:formatter=)
require 'active_support/tagged_logging' unless defined?(ActiveSupport::TaggedLogging)
ActiveSupport::TaggedLogging.new(logger) # returns a logger.clone
logger = ActiveSupport::TaggedLogging.new(logger) # returns a logger.clone
logger.singleton_class.instance_eval do
include ActiveSupport::LoggerSilence if defined?(ActiveSupport::LoggerSilence)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have just send(:include) here instead of eval-ing...

end
logger
end
end

Expand Down
22 changes: 15 additions & 7 deletions src/spec/ruby/jruby/rack/rails_booter_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -168,16 +168,17 @@

before(:all) do
@active_support = defined? ::ActiveSupport
@tagged_logging = active_support && ActiveSupport::TaggedLogging rescue false
@active_support = ::ActiveSupport.constants if @active_support
require 'active_support/logger'
end

after(:all) do
if @tagged_logging == false
if @active_support
ActiveSupport.send :remove_const, :TaggedLogging
else
Object.send :remove_const, :ActiveSupport rescue nil
if @active_support
[:Logger, :TaggedLogging, :LoggerSilence, :LoggerThreadSafeLevel].each do |name| # stubbed bits we might end up loading
ActiveSupport.send :remove_const, name unless @active_support.include?(name)
end
else
Object.send :remove_const, :ActiveSupport rescue nil
end
end

Expand All @@ -195,7 +196,7 @@ def logger=(logger); @logger = logger; end
log_initializer[1].should == [{:before => :initialize_logger}]
end

it "gets set as config.logger (wrapped with tagged logging)" do
it "gets set as config.logger (wrapped with tagged logging and logger_silence)" do
logger = JRuby::Rack::Logger.new STDERR
@config.stub(:log_level).and_return(:info)
@config.stub(:log_formatter).and_return(nil)
Expand All @@ -206,6 +207,13 @@ def logger=(logger); @logger = logger; end
rails_logger = @app.config.logger
# ActiveSupport::TaggedLogging.new clones the original logger instance
expect(rails_logger).to be_a(JRuby::Rack::Logger)
expect(rails_logger).to be_a(ActiveSupport::TaggedLogging)
if defined? ActiveSupport::LoggerSilence
expect(rails_logger).to be_a(ActiveSupport::LoggerSilence)
# sanity check silence works:
value_returned = rails_logger.silence(Logger::WARN) { |logger| logger.class.name }
expect(value_returned).to eql('JRuby::Rack::Logger')
end
end

it "has a configurable log level" do
Expand Down
6 changes: 3 additions & 3 deletions src/spec/ruby/rails/stub/active_support/logger.rb
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# frozen_string_literal: true

# require "active_support/logger_silence"
# require "active_support/logger_thread_safe_level"
require "active_support/logger_silence"
require "active_support/logger_thread_safe_level"
require "logger"

module ActiveSupport
class Logger < ::Logger
# include LoggerSilence
include LoggerSilence

# Returns true if the logger destination matches one of the sources
#
Expand Down
27 changes: 27 additions & 0 deletions src/spec/ruby/rails/stub/active_support/logger_silence.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# frozen_string_literal: true

# require "active_support/concern"
# require "active_support/core_ext/module/attribute_accessors"
require "active_support/logger_thread_safe_level"

module ActiveSupport
module LoggerSilence
# extend ActiveSupport::Concern

def self.included(base)
base.class_eval do
# cattr_accessor :silencer, default: true
@@silencer = true
def self.silencer; @@silencer end
def silencer; self.class.silencer end

include ActiveSupport::LoggerThreadSafeLevel
end
end

# Silences the logger for the duration of the block.
def silence(severity = Logger::ERROR)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should remove logger.silence from JRuby::Rack::Logger impl, which includes a dummy silence(level) { ... } implementation that does nothing (simply yields).

silencer ? log_at(severity) { yield self } : yield(self)
end
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# frozen_string_literal: true

# require "active_support/concern"
require "logger"

module ActiveSupport
module LoggerThreadSafeLevel # :nodoc:
# extend ActiveSupport::Concern

def local_level
# IsolatedExecutionState[local_level_key]
end

def local_level=(level)
case level
when Integer
when Symbol
level = Logger::Severity.const_get(level.to_s.upcase)
when nil
else
raise ArgumentError, "Invalid log level: #{level.inspect}"
end
# if level.nil?
# IsolatedExecutionState.delete(local_level_key)
# else
# IsolatedExecutionState[local_level_key] = level
# end
level
end

def level
local_level || super
end

# Change the thread-local level for the duration of the given block.
def log_at(level)
old_local_level, self.local_level = local_level, level
yield
ensure
self.local_level = old_local_level
end

private
def local_level_key
@local_level_key ||= :"logger_thread_safe_level_#{object_id}"
end
end
end