selenium-webdriver 4.0.0.alpha3 → 4.0.0.beta1

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/takes_screenshot.rb

@@ -0,0 +1,63 @@
+# 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 to the given path
+      #
+      # @api public
+      #
+
+      def save_screenshot(png_path)
+        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) }
+      end
+
+      #
+      # Return a PNG screenshot in the given format as a string
+      #
+      # @param [:base64, :png] format
+      # @return String screenshot
+      #
+      # @api public
+
+      def screenshot_as(format)
+        case format
+        when :base64
+          screenshot
+        when :png
+          screenshot.unpack1('m')
+        else
+          raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
+        end
+      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/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,135 @@
+# 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
+      autoload :ConsoleEvent, 'selenium/webdriver/devtools/console_event'
+      autoload :ExceptionEvent, 'selenium/webdriver/devtools/exception_event'
+      autoload :MutationEvent, 'selenium/webdriver/devtools/mutation_event'
+
+      SUPPORTED_VERSIONS = [85, 86, 87, 88].freeze
+
+      def initialize(url:, version:)
+        @messages = []
+        @uri = URI("http://#{url}")
+
+        load_devtools_version(version)
+        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? })
+        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)
+
+        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 load_devtools_version(version)
+        closest_version = SUPPORTED_VERSIONS.min_by { |v| (version - v).abs }
+        WebDriver.logger.info("Loading DevTools::V#{closest_version} for #{version}.")
+        Dir["#{__dir__}/devtools/v#{closest_version}/*"].sort.each do |f|
+          require f
+        end
+      end
+
+      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)
+              # 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|
+                Thread.new { 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/list', @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

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

data/lib/selenium/webdriver/devtools/v85/accessibility.rb

@@ -0,0 +1,64 @@
+# 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.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module WebDriver
+    class DevTools
+      def accessibility
+        @accessibility ||= V85::Accessibility.new(self)
+      end
+
+      module V85
+        class Accessibility
+
+          def initialize(devtools)
+            @devtools = devtools
+          end
+
+          def on(event, &block)
+            event = EVENTS[event] if event.is_a?(Symbol)
+            @devtools.callbacks["Accessibility.#{event}"] << block
+          end
+
+          def disable
+            @devtools.send_cmd('Accessibility.disable')
+          end
+
+          def enable
+            @devtools.send_cmd('Accessibility.enable')
+          end
+
+          def get_partial_ax_tree(node_id: nil, backend_node_id: nil, object_id: nil, fetch_relatives: nil)
+            @devtools.send_cmd('Accessibility.getPartialAXTree',
+                               nodeId: node_id,
+                               backendNodeId: backend_node_id,
+                               objectId: object_id,
+                               fetchRelatives: fetch_relatives)
+          end
+
+          def get_full_ax_tree
+            @devtools.send_cmd('Accessibility.getFullAXTree')
+          end
+
+        end # V85
+      end # Accessibility
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/v85/animation.rb

@@ -0,0 +1,100 @@
+# 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.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module WebDriver
+    class DevTools
+      def animation
+        @animation ||= V85::Animation.new(self)
+      end
+
+      module V85
+        class Animation
+          EVENTS = {
+            animation_canceled: 'animationCanceled',
+            animation_created: 'animationCreated',
+            animation_started: 'animationStarted',
+          }.freeze
+
+          def initialize(devtools)
+            @devtools = devtools
+          end
+
+          def on(event, &block)
+            event = EVENTS[event] if event.is_a?(Symbol)
+            @devtools.callbacks["Animation.#{event}"] << block
+          end
+
+          def disable
+            @devtools.send_cmd('Animation.disable')
+          end
+
+          def enable
+            @devtools.send_cmd('Animation.enable')
+          end
+
+          def get_current_time(id:)
+            @devtools.send_cmd('Animation.getCurrentTime',
+                               id: id)
+          end
+
+          def get_playback_rate
+            @devtools.send_cmd('Animation.getPlaybackRate')
+          end
+
+          def release_animations(animations:)
+            @devtools.send_cmd('Animation.releaseAnimations',
+                               animations: animations)
+          end
+
+          def resolve_animation(animation_id:)
+            @devtools.send_cmd('Animation.resolveAnimation',
+                               animationId: animation_id)
+          end
+
+          def seek_animations(animations:, current_time:)
+            @devtools.send_cmd('Animation.seekAnimations',
+                               animations: animations,
+                               currentTime: current_time)
+          end
+
+          def set_paused(animations:, paused:)
+            @devtools.send_cmd('Animation.setPaused',
+                               animations: animations,
+                               paused: paused)
+          end
+
+          def set_playback_rate(playback_rate:)
+            @devtools.send_cmd('Animation.setPlaybackRate',
+                               playbackRate: playback_rate)
+          end
+
+          def set_timing(animation_id:, duration:, delay:)
+            @devtools.send_cmd('Animation.setTiming',
+                               animationId: animation_id,
+                               duration: duration,
+                               delay: delay)
+          end
+
+        end # V85
+      end # Animation
+    end # DevTools
+  end # WebDriver
+end # Selenium