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

Author: titusfortner

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

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?
 

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

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

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