[rb] allow both allowing and ignoring logging messages by id

titusfortner · titusfortner · commit c4776a36f499 · 2023-05-05T22:31:02.000-05:00
diff --git a/rb/.rubocop.yml b/rb/.rubocop.yml
@@ -42,6 +42,7 @@ Metrics/CyclomaticComplexity:
   Max: 9
   Exclude:
     - 'lib/selenium/webdriver/support/color.rb'
+    - 'lib/selenium/webdriver/common/logger.rb'
 
 Metrics/MethodLength:
   CountComments: false
@@ -62,6 +63,7 @@ Metrics/PerceivedComplexity:
   Max: 9
   Exclude:
     - 'lib/selenium/webdriver/common/local_driver.rb'
+    - 'lib/selenium/webdriver/common/logger.rb'
 
 Naming/FileName:
   Exclude:
diff --git a/rb/lib/selenium/webdriver/common/logger.rb b/rb/lib/selenium/webdriver/common/logger.rb
@@ -48,14 +48,17 @@ class Logger
       #
       # @param [String] progname Allow child projects to use Selenium's Logger pattern
       #
-      def initialize(progname = 'Selenium', ignored: nil)
+      def initialize(progname = 'Selenium', ignored: nil, allowed: nil)
         @logger = create_logger(progname)
         @ignored = Array(ignored)
+        @allowed = Array(allowed)
         @first_warning = false
       end
 
       def level=(level)
-        info(':info is now the default log level, to see additional logging, set log level to :debug') if level == :info
+        if level == :info && @logger.level == :info
+          info(':info is now the default log level, to see additional logging, set log level to :debug')
+        end
 
         @logger.level = level
       end
@@ -87,10 +90,19 @@ def io
       #
       # Will not log the provided ID.
       #
-      # @param [Array, Symbol] id
+      # @param [Array, Symbol] ids
+      #
+      def ignore(*ids)
+        @ignored += Array(ids).flatten
+      end
+
+      #
+      # Will only log the provided ID.
+      #
+      # @param [Array, Symbol] ids
       #
-      def ignore(id)
-        Array(id).each { |ignore| @ignored << ignore }
+      def allow(ids)
+        @allowed += Array(ids).flatten
       end
 
       #
@@ -144,8 +156,11 @@ def warn(message, id: [], &block)
       # @yield appends additional message to end of provided template
       #
       def deprecate(old, new = nil, id: [], reference: '', &block)
+        id = Array(id)
         return if @ignored.include?(:deprecations)
 
+        id << :deprecations if @allowed.include?(:deprecations)
+
         message = +"[DEPRECATION] #{old} is deprecated"
         message << if new
                      ". Use #{new} instead."
@@ -177,6 +192,7 @@ def default_level
       def discard_or_log(level, message, id)
         id = Array(id)
         return if (@ignored & id).any?
+        return if @allowed.any? && (@allowed & id).none?
 
         msg = id.empty? ? message : "[#{id.map(&:inspect).join(', ')}] #{message} "
         msg += " #{yield}" if block_given?
diff --git a/rb/spec/unit/selenium/webdriver/chrome/options_spec.rb b/rb/spec/unit/selenium/webdriver/chrome/options_spec.rb
@@ -265,7 +265,7 @@ module Chrome
             expect(options.as_json).to eq('browserName' => 'chrome', 'goog:chromeOptions' => {})
           end
 
-          it 'errors when unrecognized capability is passed' do
+          it 'warns when unrecognized capability is passed' do
             expect {
               options.add_option(:foo, 'bar')
             }.to have_deprecated(:add_option)
diff --git a/rb/spec/unit/selenium/webdriver/common/logger_spec.rb b/rb/spec/unit/selenium/webdriver/common/logger_spec.rb
@@ -175,7 +175,7 @@ module WebDriver
       end
 
       describe '#ignore' do
-        it 'prevents logging when ignoring single id' do
+        it 'prevents logging when id' do
           logger.ignore(:foo)
           expect { logger.deprecate('#old', '#new', id: :foo) }.not_to output.to_stdout_from_any_process
         end
@@ -197,6 +197,28 @@ module WebDriver
           expect { logger.deprecate('#old', '#new') }.not_to output.to_stdout_from_any_process
         end
       end
+
+      describe '#allow' do
+        it 'logs only allowed ids from method' do
+          logger.allow(:foo)
+          logger.allow(:bar)
+          expect { logger.deprecate('#old', '#new', id: :foo) }.to output(/foo/).to_stdout_from_any_process
+          expect { logger.deprecate('#old', '#new', id: :bar) }.to output(/bar/).to_stdout_from_any_process
+          expect { logger.deprecate('#old', '#new', id: :foobar) }.not_to output.to_stdout_from_any_process
+        end
+
+        it 'logs only allowed ids from Array' do
+          logger.allow(%i[foo bar])
+          expect { logger.deprecate('#old', '#new', id: :foo) }.to output(/foo/).to_stdout_from_any_process
+          expect { logger.deprecate('#old', '#new', id: :bar) }.to output(/bar/).to_stdout_from_any_process
+          expect { logger.deprecate('#old', '#new', id: :foobar) }.not_to output.to_stdout_from_any_process
+        end
+
+        it 'prevents logging any deprecation when ignoring :deprecations' do
+          logger.allow(:deprecations)
+          expect { logger.deprecate('#old', '#new') }.to output(/new/).to_stdout_from_any_process
+        end
+      end
     end
   end # WebDriver
 end # Selenium
diff --git a/rb/spec/unit/selenium/webdriver/spec_helper.rb b/rb/spec/unit/selenium/webdriver/spec_helper.rb
@@ -51,7 +51,7 @@ def with_env(hash)
   c.define_derived_metadata do |meta|
     meta[:aggregate_failures] = true
   end
-  Selenium::WebDriver.logger(ignored: [:logger_info])
+  Selenium::WebDriver.logger(ignored: :logger_info)
 
   c.include Selenium::WebDriver::UnitSpecHelper
 
