class Selenium::WebDriver::ServiceManager

Base class implementing default behavior of service_manager object, responsible for starting and stopping driver implementations.

@api private

Constants

SOCKET_LOCK_TIMEOUT
START_TIMEOUT
STOP_TIMEOUT

Public Class Methods

new(config) click to toggle source

End users should use a class method for the desired driver, rather than using this directly.

@api private

# File lib/selenium/webdriver/common/service_manager.rb, line 39
def initialize(config)
  @executable_path = config.executable_path
  @host = Platform.localhost
  @port = config.port
  @io = config.log
  @extra_args = config.args
  @shutdown_supported = config.shutdown_supported

  raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
end

Public Instance Methods

start() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 50
def start
  raise "already started: #{uri.inspect} #{@executable_path.inspect}" if process_running?

  Platform.exit_hook { stop } # make sure we don't leave the server running

  socket_lock.locked do
    find_free_port
    start_process
    connect_until_stable
  end
end

stop() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 62
def stop
  return unless @shutdown_supported
  return if process_exited?

  stop_server
  @process.poll_for_exit STOP_TIMEOUT
rescue ChildProcess::TimeoutError, Errno::ECONNREFUSED
  nil # noop
ensure
  stop_process
end

uri() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 74
def uri
  @uri ||= URI.parse("http://#{@host}:#{@port}")
end

Private Instance Methods

build_process(*command) click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 80
def build_process(*command)
  WebDriver.logger.debug("Executing Process #{command}", id: :driver_service)
  @process = ChildProcess.build(*command)
  if ENV.key?('SE_DEBUG')
    if @io && @io != WebDriver.logger.io
      WebDriver.logger.warn('SE_DEBUG is set; overriding user-specified driver log output to use stderr',
                            id: :se_debug)
    end
    @io = WebDriver.logger.io
  end
  @process.io = @io if @io

  @process
end

cannot_connect_error_text() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 168
def cannot_connect_error_text
  "unable to connect to #{@executable_path} #{@host}:#{@port}"
end

check_connection_error() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 148
def check_connection_error
  response = Net::HTTP.start(@host, @port, open_timeout: 0.5, read_timeout: 1) do |http|
    http.get('/status', {'Connection' => 'close'})
  end

  return "status returned #{response.code}\n#{response.body}" unless response.is_a?(Net::HTTPSuccess)

  status = JSON.parse(response.body)
  ready = status['ready'] || status.dig('value', 'ready')
  "driver not ready: #{response.body}" unless ready
rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EPIPE, Errno::ETIMEDOUT,
       Errno::EADDRNOTAVAIL, Errno::EHOSTUNREACH, Net::OpenTimeout, Net::ReadTimeout,
       EOFError, SocketError, Net::HTTPBadResponse, JSON::ParserError => e
  "#{e.class}: #{e.message}"
end

connect_to_server() { |http| ... } click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 95
def connect_to_server
  Net::HTTP.start(@host, @port) do |http|
    http.open_timeout = STOP_TIMEOUT / 2
    http.read_timeout = STOP_TIMEOUT / 2

    yield http
  end
end

connect_until_stable() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 135
def connect_until_stable
  deadline = current_time + START_TIMEOUT

  loop do
    error = check_connection_error
    return unless error

    raise Error::WebDriverError, "#{cannot_connect_error_text}: #{error}" if current_time > deadline

    sleep 0.1
  end
end

current_time() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 164
def current_time
  Process.clock_gettime(Process::CLOCK_MONOTONIC)
end

find_free_port() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 104
def find_free_port
  @port = PortProber.above(@port)
end

process_exited?() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 131
def process_exited?
  @process.nil? || @process.exited?
end

process_running?() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 127
def process_running?
  defined?(@process) && @process&.alive?
end

socket_lock() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 172
def socket_lock
  @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
end

start_process() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 108
def start_process
  @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
  @process.start
end

stop_process() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 113
def stop_process
  return if process_exited?

  @process.stop STOP_TIMEOUT
end

stop_server() click to toggle source

# File lib/selenium/webdriver/common/service_manager.rb, line 119
def stop_server
  connect_to_server do |http|
    headers = WebDriver::Remote::Http::Common::DEFAULT_HEADERS.dup
    WebDriver.logger.debug('Sending shutdown request to server', id: :driver_service)
    http.get('/shutdown', headers)
  end
end