-
-
Notifications
You must be signed in to change notification settings - Fork 973
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Silence Hashie::Mash logger on Hashie 3.5.0+
We introduced a new logger for Mash due to the huge number of issues that we get where people try to set keys on their Mash. This change silences the info messages that get logged when a Mash has a conflict with a method name. I had to do this in a kind of hacky way. Since OmniAuth supports Hashie versions `>= 1.2, < 4`, I can't just hook into the method that we'll be adding in 3.5.2. As such, I apply an override for the logging method if the disable method isn't present. I'm also only overriding the method in versions that have the logging capability.
- Loading branch information
1 parent
cb82bb4
commit 00481a9
Showing
5 changed files
with
126 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
require 'hashie/mash' | ||
|
||
module OmniAuth | ||
# Generic helper hash that allows method access on deeply nested keys. | ||
class KeyStore < ::Hashie::Mash | ||
# Disables warnings on Hashie 3.5.0+ for overwritten keys | ||
def self.override_logging | ||
require 'hashie/version' | ||
return unless Gem::Version.new(Hashie::VERSION) >= Gem::Version.new('3.5.0') | ||
|
||
if respond_to?(:disable_warnings) | ||
disable_warnings | ||
else | ||
define_method(:log_built_in_message) { |*| } | ||
private :log_built_in_message | ||
end | ||
end | ||
|
||
# Disable on loading of the class | ||
override_logging | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
require 'helper' | ||
|
||
RSpec.describe OmniAuth::KeyStore do | ||
let(:logger) { double('Logger') } | ||
|
||
around(:each) do |example| | ||
patched = monkey_patch_logger | ||
example.run | ||
remove_logger(patched) | ||
end | ||
|
||
context 'on Hashie < 3.5.0' do | ||
let(:version) { '3.4.0' } | ||
|
||
it 'does not log anything to the console' do | ||
stub_const('Hashie::VERSION', version) | ||
OmniAuth::KeyStore.override_logging | ||
expect(logger).not_to receive(:info) | ||
OmniAuth::KeyStore.new(:id => 1234) | ||
end | ||
end | ||
|
||
context 'on Hashie 3.5.0 and 3.5.1' do | ||
let(:version) { '3.5.0' } | ||
|
||
it 'does not log anything to the console' do | ||
stub_const('Hashie::VERSION', version) | ||
OmniAuth::KeyStore.override_logging | ||
expect(logger).not_to receive(:info) | ||
OmniAuth::KeyStore.new(:id => 1234) | ||
end | ||
end | ||
|
||
context 'on Hashie 3.5.2+' do | ||
let(:version) { '3.5.2' } | ||
|
||
around(:each) do |example| | ||
patching = monkey_patch_unreleased_interface | ||
example.run | ||
remove_monkey_patch(patching) | ||
end | ||
|
||
it 'does not log anything to the console' do | ||
stub_const('Hashie::VERSION', version) | ||
OmniAuth::KeyStore.override_logging | ||
expect(logger).not_to receive(:info) | ||
OmniAuth::KeyStore.new(:id => 1234) | ||
end | ||
end | ||
|
||
def monkey_patch_unreleased_interface | ||
return false if OmniAuth::KeyStore.class.respond_to?(:disable_warnings, true) | ||
|
||
OmniAuth::KeyStore.define_singleton_method(:disable_warnings) {} | ||
OmniAuth::KeyStore.define_singleton_method(:log_built_in_message) { |*| } | ||
|
||
true | ||
end | ||
|
||
def monkey_patch_logger | ||
return unless Hashie.respond_to?(:logger) | ||
|
||
original_logger = Hashie.logger | ||
Hashie.logger = logger | ||
original_logger | ||
end | ||
|
||
def remove_logger(logger) | ||
return unless logger | ||
|
||
Hashie.logger = logger | ||
end | ||
|
||
def remove_monkey_patch(perform) | ||
return unless perform | ||
|
||
OmniAuth::KeyStore.singleton_class.__send__(:remove_method, :disable_warnings) | ||
end | ||
end |