[rb] update logger with link on how to use it (#11478)

titusfortner · web-flow · commit 0e4fcd2e0955 · 2023-01-04T11:48:09.000-06:00
diff --git a/rb/lib/selenium/webdriver.rb b/rb/lib/selenium/webdriver.rb
@@ -94,8 +94,8 @@ def self.for(*args)
     # @return [Logger]
     #
 
-    def self.logger
-      @logger ||= WebDriver::Logger.new
+    def self.logger(**opts)
+      @logger ||= WebDriver::Logger.new('Selenium', **opts)
     end
   end # WebDriver
 end # Selenium
diff --git a/rb/lib/selenium/webdriver/common/logger.rb b/rb/lib/selenium/webdriver/common/logger.rb
@@ -48,9 +48,10 @@ class Logger
       #
       # @param [String] progname Allow child projects to use Selenium's Logger pattern
       #
-      def initialize(progname = 'Selenium')
+      def initialize(progname = 'Selenium', ignored: nil)
         @logger = create_logger(progname)
-        @ignored = []
+        @ignored = Array(ignored)
+        @first_warning = false
       end
 
       #
@@ -94,6 +95,13 @@ def ignore(id)
       # @yield see #deprecate
       #
       def warn(message, id: [])
+        unless @first_warning
+          @first_warning = true
+          warn("Details on how to use and modify Selenium logger:\n", id: [:logger_info]) do
+            "https://selenium.dev/documentation/webdriver/troubleshooting/logging#ruby\n"
+          end
+        end
+
         id = Array(id)
         return if (@ignored & id).any?
 
diff --git a/rb/spec/integration/selenium/webdriver/spec_support/test_environment.rb b/rb/spec/integration/selenium/webdriver/spec_support/test_environment.rb
@@ -28,7 +28,6 @@ def initialize
           @create_driver_error_count = 0
 
           populate_from_bazel_target
-          WebDriver.logger
 
           @driver = ENV.fetch('WD_SPEC_DRIVER', :chrome).to_sym
           @driver_instance = nil
diff --git a/rb/spec/unit/selenium/webdriver/common/logger_spec.rb b/rb/spec/unit/selenium/webdriver/common/logger_spec.rb
@@ -22,7 +22,7 @@
 module Selenium
   module WebDriver
     describe Logger do
-      subject(:logger) { Logger.new('Selenium') }
+      subject(:logger) { Logger.new('Selenium', ignored: [:logger_info]) }
 
       around do |example|
         debug = $DEBUG
@@ -37,6 +37,12 @@ module WebDriver
           msg = /WARN NotSelenium message/
           expect { other_logger.warn('message') }.to output(msg).to_stdout_from_any_process
         end
+
+        it 'does not log info from constructor' do
+          expect {
+            Logger.new('Selenium')
+          }.not_to output(/.+/).to_stdout_from_any_process
+        end
       end
 
       describe '#level' do
@@ -79,6 +85,12 @@ module WebDriver
       end
 
       describe '#warn' do
+        it 'logs info on first warning but not second' do
+          logger = Logger.new('Selenium')
+          expect { logger.warn('first') }.to output(/:logger_info/).to_stdout_from_any_process
+          expect { logger.warn('second') }.not_to output(/:logger_info/).to_stdout_from_any_process
+        end
+
         it 'logs with String' do
           expect { logger.warn "String Value" }.to output(/WARN Selenium String Value/).to_stdout_from_any_process
         end
diff --git a/rb/spec/unit/selenium/webdriver/spec_helper.rb b/rb/spec/unit/selenium/webdriver/spec_helper.rb
@@ -43,7 +43,7 @@ def with_env(hash)
   c.define_derived_metadata do |meta|
     meta[:aggregate_failures] = true
   end
-  Selenium::WebDriver.logger
+  Selenium::WebDriver.logger(ignored: [:logger_info])
 
   c.include Selenium::WebDriver::UnitSpecHelper
 

Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,10 @@ class Logger`
`48`	`48`	`#`
`49`	`49`	`# @param [String] progname Allow child projects to use Selenium's Logger pattern`
`50`	`50`	`#`
`51`		`- def initialize(progname = 'Selenium')`
	`51`	`+ def initialize(progname = 'Selenium', ignored: nil)`
`52`	`52`	`@logger = create_logger(progname)`
`53`		`- @ignored = []`
	`53`	`+ @ignored = Array(ignored)`
	`54`	`+ @first_warning = false`
`54`	`55`	`end`
`55`	`56`
`56`	`57`	`#`
`@@ -94,6 +95,13 @@ def ignore(id)`
`94`	`95`	`# @yield see #deprecate`
`95`	`96`	`#`
`96`	`97`	`def warn(message, id: [])`
	`98`	`+ unless @first_warning`
	`99`	`+ @first_warning = true`
	`100`	`+ warn("Details on how to use and modify Selenium logger:\n", id: [:logger_info]) do`
	`101`	`+ "https://selenium.dev/documentation/webdriver/troubleshooting/logging#ruby\n"`
	`102`	`+ end`
	`103`	`+ end`
	`104`	`+`
`97`	`105`	`id = Array(id)`
`98`	`106`	`return if (@ignored & id).any?`
`99`	`107`