[🐛 Bug]: Ruby: undefined method `logs' for #<Selenium::WebDriver::Chrome::Driver> with Chrome Beta (120) + headless mode

[tatsuyafw]

What happened?

As below, when I create Selenium::WebDriver instance with Chrome Beta (v120) and the headless mode option and call the logs method, I get a NoMethodError.

require 'selenium-webdriver'

options = Selenium::WebDriver::Options.chrome(browser_version: 'beta')
options.args << '--headless'
driver = Selenium::WebDriver.for(:chrome, options: options)

driver.logs
#=> undefined method `logs' for #<Selenium::WebDriver::Chrome::Driver:0x487c57d05253aecc browser=:"chrome-headless-shell"> (NoMethodError)

In contrast, with the stable version (v119) of Chrome there is no problem.

require 'selenium-webdriver'

options = Selenium::WebDriver::Options.chrome(browser_version: 'stable')
options.args << '--headless'
driver = Selenium::WebDriver.for(:chrome, options: options)

driver.logs
# => works fine

After investigating, I found that driver.bridge.browser is :"chrome-headless-shell" in Chrome Beta + headless mode, and the following code is not properly handled.

• selenium/rb/lib/selenium/webdriver/common/driver.rb

  Lines 330 to 344 in 0c86525

  	def add_extensions(browser)
  	extensions = case browser
  	when :chrome, :msedge
  	Chromium::Driver::EXTENSIONS
  	when :firefox
  	Firefox::Driver::EXTENSIONS
  	when :safari, :safari_technology_preview
  	Safari::Driver::EXTENSIONS
  	when :ie, :internet_explorer
  	IE::Driver::EXTENSIONS
  	else
  	[]
  	end
  	extensions.each { |extension| extend extension }
  	end

---

Investigation code

require 'selenium-webdriver'

browser_versions = %w(stable beta)

browser_versions.each do |browser_version|
  options = Selenium::WebDriver::Options.chrome(browser_version: browser_version)
  options.args << '--headless'
  driver = Selenium::WebDriver.for(:chrome, options: options)

  puts "browser_version: #{browser_version}"
  puts "driver.respond_to?(:logs): #{driver.respond_to?(:logs)}"
  puts "driver.bridge.browser: #{driver.send(:bridge).browser}"

  puts
end

Output

browser_version: stable
driver.respond_to?(:logs): true
driver.bridge.browser: chrome

browser_version: beta
driver.respond_to?(:logs): false
driver.bridge.browser: chrome-headless-shell

How can we reproduce the issue?

require 'selenium-webdriver'

options = Selenium::WebDriver::Options.chrome(browser_version: 'beta')
options.args << '--headless'
driver = Selenium::WebDriver.for(:chrome, options: options)

driver.logs

### Relevant log output

```shell
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] Selenium Manager binary found at /Users/hoshino_ta/.rbenv/versions/3.1.0/lib/ruby/gems/3.1.0/gems/selenium-webdriver-4.15.0/bin/macos/selenium-manager
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] Executing Process ["/Users/hoshino_ta/.rbenv/versions/3.1.0/lib/ruby/gems/3.1.0/gems/selenium-webdriver-4.15.0/bin/macos/selenium-manager", "--browser", "chrome", "--browser-version", "beta", "--output", "json", "--debug"]
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] chromedriver not found in PATH
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] chrome not found in PATH
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] chrome beta not found in the system
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] Required browser: chrome 120.0.6099.5
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] chrome 120.0.6099.5 already exists
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] chrome 120.0.6099.5 is available at /Users/hoshino_ta/.cache/selenium/chrome/mac-x64/120.0.6099.5/Google Chrome for Testing.app/Contents/MacOS/Google Chrome for Testing
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] Required driver: chromedriver 120.0.6099.5
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] chromedriver 120.0.6099.5 already in the cache
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] Driver path: /Users/hoshino_ta/.cache/selenium/chromedriver/mac-x64/120.0.6099.5/chromedriver
2023-11-08 13:16:42 DEBUG Selenium [:selenium_manager] Browser path: /Users/hoshino_ta/.cache/selenium/chrome/mac-x64/120.0.6099.5/Google Chrome for Testing.app/Contents/MacOS/Google Chrome for Testing
Starting ChromeDriver 120.0.6099.5 (dc7563588833ccad6482a3aa5848108c4387e7e5-refs/branch-heads/6099@{#21}) on port 9515
Only local connections are allowed.
Please see https://chromedriver.chromium.org/security-considerations for suggestions on keeping ChromeDriver safe.
ChromeDriver was started successfully.
selenium.rb:10:in `<main>': undefined method `logs' for #<Selenium::WebDriver::Chrome::Driver:0x29e4ce086854de18 browser=:"chrome-headless-shell"> (NoMethodError)

driver.logs
      ^^^^^

Operating System

macOS Monterey

Selenium version

Ruby 4.15.0 (Ruby: 3.1.0, selenium-webdriver: 4.15.0)

What are the browser(s) and version(s) where you see this issue?

Chrome Beta (120.0.6099.5)

What are the browser driver(s) and version(s) where you see this issue?

chromedriver 120.0.6099.5

Are you using Selenium Grid?

No response

[github-actions]

@tatsuyafw, thank you for creating this issue. We will troubleshoot it as soon as we can.

---

Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, MSEdgeDriver, W3C), add the applicable G-* label, and it will provide the correct link and auto-close the issue.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

[titusfortner]

I didn't realize it was giving a different browser name, that is useful for us to investigate in other areas as well.

What does it show if you use --headless=new (this is the new recommended version)

[github-actions]

This issue is looking for contributors.

Please comment below or reach out to us through our IRC/Slack/Matrix channels if you are interested.

[tatsuyafw]

@titusfortner

Thank you for your reply.

What does it show if you use --headless=new (this is the new recommended version)

The --headless=new option works fine! I would use the --headless=new option.

$ cat selenium.rb
require 'selenium-webdriver'

options = Selenium::WebDriver::Options.chrome(browser_version: 'beta')
options.args << '--headless=new'
driver = Selenium::WebDriver.for(:chrome, options: options)

driver.get('https://example.com')

p driver.logs
$ bundle exec ruby selenium.rb
#<Selenium::WebDriver::Logs:0x000000010c6059e8 @bridge=#<Selenium::WebDriver::Remote::Bridge:0x0000000108b6a5b8 @http=#<Selenium::WebDriver::Remote::Http::Default:0x0000000108c61610 @open_timeout=nil, @read_timeout=nil, @server_url=#<URI::HTTP http://127.0.0.1:9515/>, @proxy=nil, @http=#<Net::HTTP 127.0.0.1:9515 open=true>>, @file_detector=nil, @session_id="b1143348422958c52d0dea5af6e8f6a7", @capabilities=#<Selenium::WebDriver::Remote::Capabilities:0x0000000108b7a738 @capabilities={:timeouts=>{:implicit=>0, :page_load=>300000, :script=>30000}, :browser_name=>"chrome", :browser_version=>"120.0.6099.5", :platform_name=>"mac", :accept_insecure_certs=>false, :page_load_strategy=>"normal", :set_window_rect=>true, :unhandled_prompt_behavior=>"dismiss and notify", :strict_file_interactability=>false, "chrome"=>{"chromedriverVersion"=>"120.0.6099.5 (dc7563588833ccad6482a3aa5848108c4387e7e5-refs/branch-heads/6099@{#21})", "userDataDir"=>"/var/folders/qg/fry3twkj3wl56rm0f6qr6zh0xxv3rg/T/.org.chromium.Chromium.KADBnS"}, "fedcm:accounts"=>true, "goog:chromeOptions"=>{"debuggerAddress"=>"localhost:61076"}, "networkConnectionEnabled"=>false, "webauthn:extension:credBlob"=>true, "webauthn:extension:largeBlob"=>true, "webauthn:extension:minPinLength"=>true, "webauthn:extension:prf"=>true, "webauthn:virtualAuthenticators"=>true}>, @browser=:chrome>>
$

For Chrome Beta (v120) + --headless (not --headless=new), driver.bridge.browser seemes to be chrome-headless-shell.

$ cat selenium-investigation.rb
require 'selenium-webdriver'

browser_versions = %w(stable beta)
headless_options = %w(--headless --headless=new)

browser_versions.product(headless_options).each do |browser_version, headless_option|
  options = Selenium::WebDriver::Options.chrome(browser_version: browser_version)
  options.args << headless_option
  driver = Selenium::WebDriver.for(:chrome, options: options)

  puts "browser_version: #{browser_version}"
  puts "headless_option: #{headless_option}"
  puts "driver.respond_to?(:logs): #{driver.respond_to?(:logs)}"
  puts "driver.bridge.browser: #{driver.send(:bridge).browser}"

  puts
end
$ bundle exec ruby selenium-investigation.rb
browser_version: stable
headless_option: --headless
driver.respond_to?(:logs): true
driver.bridge.browser: chrome

browser_version: stable
headless_option: --headless=new
driver.respond_to?(:logs): true
driver.bridge.browser: chrome

browser_version: beta
headless_option: --headless
driver.respond_to?(:logs): false
driver.bridge.browser: chrome-headless-shell

browser_version: beta
headless_option: --headless=new
driver.respond_to?(:logs): true
driver.bridge.browser: chrome

$

[tatsuyafw]

I've closed this issue. Thanks.

[titusfortner]

Excellent! I'm going to re-open it because we should still support the other browser name.