selenium-webdriver 4.0.0.alpha6 → 4.0.0.beta4

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

@@ -57,6 +57,8 @@ module Selenium
           :jenkins
         elsif ENV['APPVEYOR']
           :appveyor
+        elsif ENV['GITHUB_ACTIONS']
+          :github
         end
       end
 
@@ -95,7 +97,7 @@ module Selenium
       def wsl?
         return false unless linux?
 
-        File.read('/proc/version').include?('Microsoft')
+        File.read('/proc/version').downcase.include?('microsoft')
       rescue Errno::EACCES
         # the file cannot be accessed on Linux on DeX
         false

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

@@ -127,7 +127,10 @@ module Selenium
       end
 
       def type=(type)
-        raise ArgumentError, "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}" unless TYPES.key? type
+        unless TYPES.key? type
+          raise ArgumentError,
+                "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}"
+        end
 
         if defined?(@type) && type != @type
           raise ArgumentError, "incompatible proxy type #{type.inspect} (already set to #{@type.inspect})"
@@ -138,10 +141,10 @@ module Selenium
 
       def as_json(*)
         json_result = {
-          'proxyType' => TYPES[type],
+          'proxyType' => TYPES[type].downcase,
           'ftpProxy' => ftp,
           'httpProxy' => http,
-          'noProxy' => no_proxy,
+          'noProxy' => no_proxy.is_a?(String) ? no_proxy.split(', ') : no_proxy,
           'proxyAutoconfigUrl' => pac,
           'sslProxy' => ssl,
           'autodetect' => auto_detect,

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

@@ -93,7 +93,10 @@ module Selenium
         when 1
           arg = args.first
 
-          raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift" unless arg.respond_to?(:shift)
+          unless arg.respond_to?(:shift)
+            raise ArgumentError,
+                  "expected #{arg.inspect}:#{arg.class} to respond to #shift"
+          end
 
           # this will be a single-entry hash, so use #shift over #first or #[]
           arr = arg.dup.shift

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

@@ -44,14 +44,7 @@ module Selenium
         def edge(**opts)
           Edge::Service.new(**opts)
         end
-
-        def edge_chrome(**opts)
-          EdgeChrome::Service.new(**opts)
-        end
-
-        def edge_html(**opts)
-          EdgeHtml::Service.new(**opts)
-        end
+        alias_method :microsoftedge, :edge
 
         def safari(**opts)
           Safari::Service.new(**opts)

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

@@ -103,7 +103,7 @@ module Selenium
 
       def start_process
         @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-        # Note: this is a bug only in Windows 7
+        # NOTE: this is a bug only in Windows 7
         @process.leader = true unless Platform.windows?
         @process.start
       end

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

@@ -65,37 +65,26 @@ module Selenium
         arr << Errno::EALREADY if Platform.wsl?
       }.freeze
 
-      if Platform.jruby?
-        # we use a plain TCPSocket here since JRuby has issues closing socket
-        # see https://github.com/jruby/jruby/issues/5709
-        def listening?
-          TCPSocket.new(@host, @port).close
-          true
-        rescue *NOT_CONNECTED_ERRORS
-          false
-        end
-      else
-        def listening?
-          addr     = Socket.getaddrinfo(@host, @port, Socket::AF_INET, Socket::SOCK_STREAM)
-          sock     = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
-          sockaddr = Socket.pack_sockaddr_in(@port, addr[0][3])
-
-          begin
-            sock.connect_nonblock sockaddr
-          rescue Errno::EINPROGRESS
-            retry if socket_writable?(sock) && conn_completed?(sock)
-            raise Errno::ECONNREFUSED
-          rescue *CONNECTED_ERRORS
-            # yay!
-          end
-
-          sock.close
-          true
-        rescue *NOT_CONNECTED_ERRORS
-          sock&.close
-          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
-          false
+      def listening?
+        addr     = Socket.getaddrinfo(@host, @port, Socket::AF_INET, Socket::SOCK_STREAM)
+        sock     = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+        sockaddr = Socket.pack_sockaddr_in(@port, addr[0][3])
+
+        begin
+          sock.connect_nonblock sockaddr
+        rescue Errno::EINPROGRESS
+          retry if socket_writable?(sock) && conn_completed?(sock)
+          raise Errno::ECONNREFUSED
+        rescue *CONNECTED_ERRORS
+          # yay!
         end
+
+        sock.close
+        true
+      rescue *NOT_CONNECTED_ERRORS
+        sock&.close
+        WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
+        false
       end
 
       def socket_writable?(sock)

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

@@ -0,0 +1,66 @@
+# 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
+    #
+    # @api private
+    #
+    module TakesScreenshot
+      #
+      # Save a PNG screenshot of the viewport to the given path
+      #
+      # @api public
+      #
+
+      def save_screenshot(png_path, full_page: false)
+        extension = File.extname(png_path).downcase
+        if extension != '.png'
+          WebDriver.logger.warn "name used for saved screenshot does not match file type. "\
+                                "It should end with .png extension",
+                                id: :screenshot
+        end
+        File.open(png_path, 'wb') { |f| f << screenshot_as(:png, full_page: full_page) }
+      end
+
+      #
+      # Return a PNG screenshot in the given format as a string
+      #
+      # @param [:base64, :png] format
+      # @param [Boolean] full_page allows taking full page screenshots if supported
+      # @return String screenshot
+      #
+      # @api public
+
+      def screenshot_as(format, full_page: false)
+        case format
+        when :base64
+          full_page ? full_screenshot : screenshot
+        when :png
+          screenshot_as(:base64, full_page: full_page).unpack1('m')
+        else
+          raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
+        end
+      rescue NameError
+        raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
+      end
+
+    end # TakesScreenshot
+  end # WebDriver
+end # Selenium

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

@@ -57,10 +57,10 @@ module Selenium
       def window(id)
         if block_given?
           original = begin
-                       @bridge.window_handle
-                     rescue Error::NoSuchWindowError
-                       nil
-                     end
+            @bridge.window_handle
+          rescue Error::NoSuchWindowError
+            nil
+          end
 
           unless @bridge.window_handles.include? id
             raise Error::NoSuchWindowError, "The specified identifier '#{id}' is not found in the window handle list"

data/lib/selenium/webdriver/devtools.rb

@@ -17,21 +17,22 @@
 # specific language governing permissions and limitations
 # under the License.
 
-Dir["#{__dir__}/devtools/*"].sort.each { |f| require f }
-
 module Selenium
   module WebDriver
     class DevTools
+      autoload :ConsoleEvent, 'selenium/webdriver/devtools/console_event'
+      autoload :ExceptionEvent, 'selenium/webdriver/devtools/exception_event'
+      autoload :MutationEvent, 'selenium/webdriver/devtools/mutation_event'
+      autoload :Request, 'selenium/webdriver/devtools/request'
 
-      def initialize(url)
+      def initialize(url:)
         @messages = []
-        @uri = URI("http://#{url}")
+        @session_id = nil
+        @url = 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)
+        start_session
       end
 
       def callbacks
@@ -40,7 +41,10 @@ module Selenium
 
       def send_cmd(method, **params)
         id = next_id
-        data = JSON.generate(id: id, method: method, params: params.reject { |_, v| v.nil? })
+        data = {id: id, method: method, params: params.reject { |_, v| v.nil? }}
+        data[:sessionId] = @session_id if @session_id
+        data = JSON.generate(data)
+        WebDriver.logger.debug "DevTools -> #{data}"
 
         out_frame = WebSocket::Frame::Outgoing::Client.new(version: ws.version, data: data, type: 'text')
         socket.write(out_frame.to_s)
@@ -54,6 +58,24 @@ module Selenium
         message
       end
 
+      def method_missing(method, *_args)
+        desired_class = "Selenium::DevTools::V#{Selenium::DevTools.version}::#{method.capitalize}"
+        return unless Object.const_defined?(desired_class)
+
+        self.class.class_eval do
+          define_method(method) do
+            Object.const_get(desired_class).new(self)
+          end
+        end
+
+        send(method)
+      end
+
+      def respond_to_missing?(method, *_args)
+        desired_class = "Selenium::DevTools::V#{Selenium::DevTools.version}::#{method.capitalize}"
+        Object.const_defined?(desired_class)
+      end
+
       private
 
       def process_handshake
@@ -67,12 +89,17 @@ module Selenium
             incoming_frame << socket.readpartial(1024)
 
             while (frame = incoming_frame.next)
+              # Firefox will periodically fail on unparsable empty frame
+              break if frame.to_s.empty?
+
               message = JSON.parse(frame.to_s)
               @messages << message
+              WebDriver.logger.debug "DevTools <- #{message}"
               next unless message['method']
 
               callbacks[message['method']].each do |callback|
-                callback.call(message['params'])
+                params = message['params'] # take in current thread!
+                Thread.new { callback.call(params) }
               end
             end
           end
@@ -80,6 +107,13 @@ module Selenium
         socket_listener.abort_on_exception = true
       end
 
+      def start_session
+        targets = target.get_targets.dig('result', 'targetInfos')
+        page_target = targets.find { |target| target['type'] == 'page' }
+        session = target.attach_to_target(target_id: page_target['targetId'], flatten: true)
+        @session_id = session.dig('result', 'sessionId')
+      end
+
       def incoming_frame
         @incoming_frame ||= WebSocket::Frame::Incoming::Client.new(version: ws.version)
       end
@@ -93,15 +127,7 @@ module Selenium
       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
+        @ws ||= WebSocket::Handshake::Client.new(url: @url)
       end
 
       def next_id

data/lib/selenium/webdriver/devtools/console_event.rb

@@ -0,0 +1,38 @@
+# 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
+    class DevTools
+      class ConsoleEvent
+
+        attr_accessor :type, :timestamp, :args
+
+        def initialize(type:, timestamp:, args:)
+          @type = type.to_sym
+          @timestamp = Time.at(timestamp / 1000)
+          @args = args.map do |arg|
+            arg.key?('value') ? arg['value'] : arg
+          end
+        end
+
+      end # ConsoleEvent
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/exception_event.rb

@@ -0,0 +1,36 @@
+# 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
+    class DevTools
+      class ExceptionEvent
+
+        attr_accessor :description, :timestamp, :stacktrace
+
+        def initialize(description:, timestamp:, stacktrace:)
+          @description = description
+          @timestamp = Time.at(timestamp / 1000)
+          @stacktrace = stacktrace
+        end
+
+      end # ExceptionEvent
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/mutation_event.rb

@@ -0,0 +1,37 @@
+# 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
+    class DevTools
+      class MutationEvent
+
+        attr_accessor :element, :attribute_name, :current_value, :old_value
+
+        def initialize(element:, attribute_name:, current_value:, old_value:)
+          @element = element
+          @attribute_name = attribute_name
+          @current_value = current_value
+          @old_value = old_value
+        end
+
+      end # MutationEvent
+    end # DevTools
+  end # WebDriver
+end # Selenium