Implement logger option

Author: YusukeIwaki

lib/capybara/playwright/browser.rb

@@ -15,8 +15,9 @@ class Browser
 
       class NoSuchWindowError < StandardError ; end
 
-      def initialize(driver:, playwright_browser:, page_options:, record_video: false, callback_on_save_trace: nil, default_timeout: nil, default_navigation_timeout: nil)
+      def initialize(driver:, internal_logger:, playwright_browser:, page_options:, record_video: false, callback_on_save_trace: nil, default_timeout: nil, default_navigation_timeout: nil)
         @driver = driver
+        @internal_logger = internal_logger
         @playwright_browser = playwright_browser
         @page_options = page_options
         if record_video
@@ -36,6 +37,7 @@ def initialize(driver:, playwright_browser:, page_options:, record_video: false,
             unless @playwright_page
               @playwright_page = page
             end
+            page.send(:_update_internal_logger, @internal_logger)
           })
           if @callback_on_save_trace
             browser_context.tracing.start(screenshots: true, snapshots: true)
@@ -95,15 +97,15 @@ def refresh
       def find_xpath(query, **options)
         assert_page_alive {
           @playwright_page.capybara_current_frame.query_selector_all("xpath=#{query}").map do |el|
-            Node.new(@driver, @playwright_page, el)
+            Node.new(@driver, @internal_logger, @playwright_page, el)
           end
         }
       end
 
       def find_css(query, **options)
         assert_page_alive {
           @playwright_page.capybara_current_frame.query_selector_all(query).map do |el|
-            Node.new(@driver, @playwright_page, el)
+            Node.new(@driver, @internal_logger, @playwright_page, el)
           end
         }
       end
@@ -185,7 +187,7 @@ def evaluate_async_script(script, *args)
       def active_element
         el = @playwright_page.capybara_current_frame.evaluate_handle('() => document.activeElement')
         if el
-          Node.new(@driver, @playwright_page, el)
+          Node.new(@driver, @internal_logger, @playwright_page, el)
         else
           nil
         end
@@ -252,7 +254,7 @@ def switch_to_frame(frame)
             /Cannot find context with specified id/,
             /Unable to adopt element handle from a different document/
             # ignore error for retry
-            puts "[WARNING] #{err.message}"
+            @internal_logger.warn(err.message)
           else
             raise
           end
@@ -324,7 +326,7 @@ def resize_window_to(handle, width, height)
       end
 
       def maximize_window(handle)
-        puts "[WARNING] maximize_window is not supported in Playwright driver"
+        @internal_logger.warn("maximize_window is not supported in Playwright driver")
         # incomplete in Playwright
         # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L346
         on_window(handle) do |page|
@@ -334,7 +336,7 @@ def maximize_window(handle)
       end
 
       def fullscreen_window(handle)
-        puts "[WARNING] fullscreen_window is not supported in Playwright driver"
+        @internal_logger.warn("fullscreen_window is not supported in Playwright driver")
         # incomplete in Playwright
         # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L341
         on_window(handle) do |page|
@@ -375,7 +377,7 @@ def dismiss_modal(dialog_type, **options, &block)
             [key, wrap_node(value)]
           end.to_h
         when ::Playwright::ElementHandle
-          Node.new(@driver, @playwright_page, arg)
+          Node.new(@driver, @internal_logger, @playwright_page, arg)
         when ::Playwright::JSHandle
           obj_type, is_array = arg.evaluate('obj => [typeof obj, Array.isArray(obj)]')
           if obj_type == 'object'

lib/capybara/playwright/driver.rb

@@ -18,6 +18,7 @@ def initialize(app, **options)
         if options[:default_navigation_timeout].is_a?(Numeric)
           @default_navigation_timeout = options[:default_navigation_timeout] * 1000
         end
+        @internal_logger = options[:logger] || default_logger
       end
 
       def wait?; true; end
@@ -26,6 +27,7 @@ def needs_server?; true; end
       private def browser
         @browser ||= ::Capybara::Playwright::Browser.new(
           driver: self,
+          internal_logger: @internal_logger,
           playwright_browser: playwright_browser,
           page_options: @page_options.value,
           record_video: callback_on_save_screenrecord?,
@@ -52,6 +54,27 @@ def needs_server?; true; end
         @browser_runner.start
       end
 
+      private def default_logger
+        if defined?(Rails)
+          Rails.logger
+        else
+          PutsLogger.new
+        end
+      end
+
+      # Since existing user already monkey-patched Kernel#puts,
+      # (https://gist.github.com/searls/9caa12f66c45a72e379e7bfe4c48405b)
+      # Logger.new(STDOUT) should be avoided to use.
+      class PutsLogger
+        def info(message)
+          puts "[INFO] #{message}"
+        end
+
+        def warn(message)
+          puts "[WARNING] #{message}"
+        end
+      end
+
       private def quit
         @playwright_browser&.close
         @playwright_browser = nil

lib/capybara/playwright/node.rb

@@ -67,8 +67,9 @@ module Playwright
     #   selenium:   https://github.com/teamcapybara/capybara/blob/master/lib/capybara/selenium/node.rb
     #   apparition: https://github.com/twalpole/apparition/blob/master/lib/capybara/apparition/node.rb
     class Node < ::Capybara::Driver::Node
-      def initialize(driver, page, element)
+      def initialize(driver, internal_logger, page, element)
         super(driver, element)
+        @internal_logger = internal_logger
         @page = page
         @element = element
       end
@@ -252,7 +253,7 @@ def set(value, **options)
         rescue ::Playwright::TimeoutError
           raise if @element.editable?
 
-          puts "[INFO] Node#set: element is not editable. #{@element}"
+          @internal_logger.info("Node#set: element is not editable. #{@element}")
         end
       end
 

lib/capybara/playwright/page.rb

@@ -12,6 +12,10 @@ def initialize(*args, **kwargs)
         capybara_initialize
       end
 
+      private def _update_internal_logger(internal_logger)
+        @internal_logger = internal_logger
+      end
+
       private def capybara_initialize
         @capybara_all_responses = {}
         @capybara_last_response = nil
@@ -44,7 +48,7 @@ def initialize(*args, **kwargs)
       end
 
       private def capybara_on_unexpected_modal(dialog)
-        puts "[WARNING] Unexpected modal - \"#{dialog.message}\""
+        @internal_logger.warn "Unexpected modal - \"#{dialog.message}\""
         if dialog.type == 'beforeunload'
           dialog.accept_async
         else

spec/spec_helper.rb

@@ -56,6 +56,7 @@
   playwright_cli_executable_path: ENV['PLAYWRIGHT_CLI_EXECUTABLE_PATH'],
   browser_type: (ENV['BROWSER'] || 'chromium').to_sym,
   headless: ENV['CI'] ? true : false,
+  logger: Logger.new($stdout),
 }
 
 Capybara.register_driver(:playwright) do |app|