selenium-webdriver 4.0.0.alpha1 → 4.0.0.alpha6

data/lib/selenium/webdriver/common/service.rb

@@ -21,36 +21,40 @@ module Selenium
   module WebDriver
     #
     # Base class implementing default behavior of service object,
-    # responsible for starting and stopping driver implementations.
+    # responsible for storing a service manager configuration.
     #
 
     class Service
-      START_TIMEOUT = 20
-      SOCKET_LOCK_TIMEOUT = 45
-      STOP_TIMEOUT = 20
-
       class << self
         attr_reader :driver_path
 
-        def chrome(*args)
-          Chrome::Service.new(*args)
+        def chrome(**opts)
+          Chrome::Service.new(**opts)
         end
 
-        def firefox(*args)
-          Firefox::Service.new(*args)
+        def firefox(**opts)
+          Firefox::Service.new(**opts)
         end
 
-        def ie(*args)
-          IE::Service.new(*args)
+        def ie(**opts)
+          IE::Service.new(**opts)
         end
         alias_method :internet_explorer, :ie
 
-        def edge(*args)
-          Edge::Service.new(*args)
+        def edge(**opts)
+          Edge::Service.new(**opts)
+        end
+
+        def edge_chrome(**opts)
+          EdgeChrome::Service.new(**opts)
         end
 
-        def safari(*args)
-          Safari::Service.new(*args)
+        def edge_html(**opts)
+          EdgeHtml::Service.new(**opts)
+        end
+
+        def safari(**opts)
+          Safari::Service.new(**opts)
         end
 
         def driver_path=(path)
@@ -60,7 +64,7 @@ module Selenium
       end
 
       attr_accessor :host
-      attr_reader :executable_path
+      attr_reader :executable_path, :port, :extra_args
 
       #
       # End users should use a class method for the desired driver, rather than using this directly.
@@ -82,31 +86,20 @@ module Selenium
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
       end
 
-      def start
-        raise "already started: #{uri.inspect} #{@executable_path.inspect}" if process_running?
-
-        Platform.exit_hook(&method(:stop)) # make sure we don't leave the server running
-
-        socket_lock.locked do
-          find_free_port
-          start_process
-          connect_until_stable
-        end
+      def launch
+        sm = ServiceManager.new(self)
+        sm.start
+        sm
       end
 
-      def stop
-        return unless self.class::SHUTDOWN_SUPPORTED
-
-        stop_server
-        @process.poll_for_exit STOP_TIMEOUT
-      rescue ChildProcess::TimeoutError
-        nil # noop
-      ensure
-        stop_process
+      def shutdown_supported
+        self.class::SHUTDOWN_SUPPORTED
       end
 
-      def uri
-        @uri ||= URI.parse("http://#{@host}:#{@port}")
+      protected
+
+      def extract_service_args(driver_opts)
+        driver_opts.key?(:args) ? driver_opts.delete(:args) : []
       end
 
       private
@@ -120,82 +113,6 @@ module Selenium
         Platform.assert_executable path
         path
       end
-
-      def build_process(*command)
-        WebDriver.logger.debug("Executing Process #{command}")
-        @process = ChildProcess.build(*command)
-        if WebDriver.logger.debug?
-          @process.io.stdout = @process.io.stderr = WebDriver.logger.io
-        elsif Platform.jruby?
-          # Apparently we need to read the output of drivers on JRuby.
-          @process.io.stdout = @process.io.stderr = File.new(Platform.null_device, 'w')
-        end
-
-        @process
-      end
-
-      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
-
-      def find_free_port
-        @port = PortProber.above(@port)
-      end
-
-      def start_process
-        @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-        # Note: this is a bug only in Windows 7
-        @process.leader = true unless Platform.windows?
-        @process.start
-      end
-
-      def stop_process
-        return if process_exited?
-
-        @process.stop STOP_TIMEOUT
-        @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
-      end
-
-      def stop_server
-        return if process_exited?
-
-        connect_to_server { |http| http.get('/shutdown') }
-      end
-
-      def process_running?
-        defined?(@process) && @process&.alive?
-      end
-
-      def process_exited?
-        @process.nil? || @process.exited?
-      end
-
-      def connect_until_stable
-        socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
-        return if socket_poller.connected?
-
-        raise Error::WebDriverError, cannot_connect_error_text
-      end
-
-      def cannot_connect_error_text
-        "unable to connect to #{self.class::EXECUTABLE} #{@host}:#{@port}"
-      end
-
-      def socket_lock
-        @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
-      end
-
-      protected
-
-      def extract_service_args(driver_opts)
-        driver_opts.key?(:args) ? driver_opts.delete(:args) : []
-      end
-
     end # Service
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/service_manager.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    #
+    # Base class implementing default behavior of service_manager object,
+    # responsible for starting and stopping driver implementations.
+    #
+    # @api private
+    #
+    class ServiceManager
+      START_TIMEOUT = 20
+      SOCKET_LOCK_TIMEOUT = 45
+      STOP_TIMEOUT = 20
+
+      #
+      # End users should use a class method for the desired driver, rather than using this directly.
+      #
+      # @api private
+      #
+
+      def initialize(config)
+        @executable_path = config.executable_path
+        @host = Platform.localhost
+        @port = config.port
+        @extra_args = config.extra_args
+        @shutdown_supported = config.shutdown_supported
+
+        raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
+      end
+
+      def start
+        raise "already started: #{uri.inspect} #{@executable_path.inspect}" if process_running?
+
+        Platform.exit_hook(&method(:stop)) # make sure we don't leave the server running
+
+        socket_lock.locked do
+          find_free_port
+          start_process
+          connect_until_stable
+        end
+      end
+
+      def stop
+        return unless @shutdown_supported
+
+        stop_server
+        @process.poll_for_exit STOP_TIMEOUT
+      rescue ChildProcess::TimeoutError
+        nil # noop
+      ensure
+        stop_process
+      end
+
+      def uri
+        @uri ||= URI.parse("http://#{@host}:#{@port}")
+      end
+
+      private
+
+      def build_process(*command)
+        WebDriver.logger.debug("Executing Process #{command}")
+        @process = ChildProcess.build(*command)
+        if WebDriver.logger.debug?
+          @process.io.stdout = @process.io.stderr = WebDriver.logger.io
+        elsif Platform.jruby?
+          # Apparently we need to read the output of drivers on JRuby.
+          @process.io.stdout = @process.io.stderr = File.new(Platform.null_device, 'w')
+        end
+
+        @process
+      end
+
+      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
+
+      def find_free_port
+        @port = PortProber.above(@port)
+      end
+
+      def start_process
+        @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
+        # Note: this is a bug only in Windows 7
+        @process.leader = true unless Platform.windows?
+        @process.start
+      end
+
+      def stop_process
+        return if process_exited?
+
+        @process.stop STOP_TIMEOUT
+        @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
+      end
+
+      def stop_server
+        return if process_exited?
+
+        connect_to_server do |http|
+          headers = WebDriver::Remote::Http::Common::DEFAULT_HEADERS.dup
+          http.get('/shutdown', headers)
+        end
+      end
+
+      def process_running?
+        defined?(@process) && @process&.alive?
+      end
+
+      def process_exited?
+        @process.nil? || @process.exited?
+      end
+
+      def connect_until_stable
+        socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
+        return if socket_poller.connected?
+
+        raise Error::WebDriverError, cannot_connect_error_text
+      end
+
+      def cannot_connect_error_text
+        "unable to connect to #{@executable_path} #{@host}:#{@port}"
+      end
+
+      def socket_lock
+        @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
+      end
+    end # Service
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/socket_lock.rb

@@ -69,8 +69,8 @@ module Selenium
         ChildProcess.close_on_exec @server
 
         true
-      rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => ex
-        WebDriver.logger.debug("#{self}: #{ex.message}")
+      rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => e
+        WebDriver.logger.debug("#{self}: #{e.message}")
         false
       end
 

data/lib/selenium/webdriver/common/wait.rb

@@ -55,7 +55,7 @@ module Selenium
           begin
             result = yield
             return result if result
-          rescue *@ignored => last_error
+          rescue *@ignored => last_error # rubocop:disable Naming/RescuedExceptionsVariableName
             # swallowed
           end
 

data/lib/selenium/webdriver/devtools.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+Dir["#{__dir__}/devtools/*"].sort.each { |f| require f }
+
+module Selenium
+  module WebDriver
+    class DevTools
+
+      def initialize(url)
+        @messages = []
+        @uri = URI("http://#{url}")
+
+        process_handshake
+        attach_socket_listener
+
+        target.attach_to_target(target_id: page_target['id'])
+        target.set_auto_attach(auto_attach: true, wait_for_debugger_on_start: false)
+      end
+
+      def callbacks
+        @callbacks ||= Hash.new { |callbacks, event| callbacks[event] = [] }
+      end
+
+      def send_cmd(method, **params)
+        id = next_id
+        data = JSON.generate(id: id, method: method, params: params.reject { |_, v| v.nil? })
+
+        out_frame = WebSocket::Frame::Outgoing::Client.new(version: ws.version, data: data, type: 'text')
+        socket.write(out_frame.to_s)
+
+        message = wait.until do
+          @messages.find { |m| m['id'] == id }
+        end
+
+        raise Error::WebDriverError, error_message(message['error']) if message['error']
+
+        message
+      end
+
+      private
+
+      def process_handshake
+        socket.print(ws.to_s)
+        ws << socket.readpartial(1024)
+      end
+
+      def attach_socket_listener
+        socket_listener = Thread.new do
+          until socket.eof?
+            incoming_frame << socket.readpartial(1024)
+
+            while (frame = incoming_frame.next)
+              message = JSON.parse(frame.to_s)
+              @messages << message
+              next unless message['method']
+
+              callbacks[message['method']].each do |callback|
+                callback.call(message['params'])
+              end
+            end
+          end
+        end
+        socket_listener.abort_on_exception = true
+      end
+
+      def incoming_frame
+        @incoming_frame ||= WebSocket::Frame::Incoming::Client.new(version: ws.version)
+      end
+
+      def wait
+        @wait ||= Wait.new(timeout: 10, interval: 0.1)
+      end
+
+      def socket
+        @socket ||= TCPSocket.new(ws.host, ws.port)
+      end
+
+      def ws
+        @ws ||= WebSocket::Handshake::Client.new(url: page_target['webSocketDebuggerUrl'])
+      end
+
+      def page_target
+        @page_target ||= begin
+          response = Net::HTTP.get(@uri.hostname, '/json', @uri.port)
+          targets = JSON.parse(response)
+          targets.find { |target| target['type'] == 'page' }
+        end
+      end
+
+      def next_id
+        @id ||= 0
+        @id += 1
+      end
+
+      def error_message(error)
+        [error['code'], error['message'], error['data']].join(': ')
+      end
+
+    end # DevTools
+  end # WebDriver
+end # Selenium