selenium-webdriver 4.0.0.alpha4 → 4.0.0.beta2

data/lib/selenium/webdriver/devtools.rb

@@ -0,0 +1,144 @@
+# 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'
+      autoload :Request, 'selenium/webdriver/devtools/request'
+
+      def initialize(url:)
+        @messages = []
+        @session_id = nil
+        @url = url
+
+        process_handshake
+        attach_socket_listener
+        start_session
+      end
+
+      def callbacks
+        @callbacks ||= Hash.new { |callbacks, event| callbacks[event] = [] }
+      end
+
+      def send_cmd(method, **params)
+        id = next_id
+        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)
+
+        message = wait.until do
+          @messages.find { |m| m['id'] == id }
+        end
+
+        raise Error::WebDriverError, error_message(message['error']) if message['error']
+
+        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
+        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|
+                params = message['params'] # take in current thread!
+                Thread.new { callback.call(params) }
+              end
+            end
+          end
+        end
+        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
+
+      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: @url)
+      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/{edge_html/driver.rb → devtools/exception_event.rb}

@@ -19,21 +19,18 @@
 
 module Selenium
   module WebDriver
-    module EdgeHtml
+    class DevTools
+      class ExceptionEvent
 
-      #
-      # Driver implementation for Microsoft Edge.
-      # @api private
-      #
+        attr_accessor :description, :timestamp, :stacktrace
 
-      class Driver < WebDriver::Driver
-        include DriverExtensions::HasWebStorage
-        include DriverExtensions::TakesScreenshot
-
-        def browser
-          :edge
+        def initialize(description:, timestamp:, stacktrace:)
+          @description = description
+          @timestamp = Time.at(timestamp / 1000)
+          @stacktrace = stacktrace
         end
-      end # Driver
-    end # EdgeHtml
+
+      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/request.rb

@@ -0,0 +1,57 @@
+# 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 Request
+
+        attr_reader :url, :method, :headers
+
+        def initialize(devtools:, id:, url:, method:, headers:)
+          @devtools = devtools
+          @id = id
+          @url = url
+          @method = method
+          @headers = headers
+        end
+
+        def continue
+          @devtools.fetch.continue_request(request_id: @id)
+        end
+
+        def respond(code: 200, headers: {}, body: '')
+          @devtools.fetch.fulfill_request(
+            request_id: @id,
+            body: Base64.strict_encode64(body),
+            response_code: code,
+            response_headers: headers.map do |k, v|
+              {name: k, value: v}
+            end
+          )
+        end
+
+        def inspect
+          %(#<#{self.class.name} @method="#{method}" @url="#{url}")
+        end
+
+      end # Request
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/edge.rb

@@ -21,32 +21,12 @@ require 'net/http'
 
 module Selenium
   module WebDriver
-    module EdgeHtml
-      autoload :Driver, 'selenium/webdriver/edge_html/driver'
-      autoload :Options, 'selenium/webdriver/edge_html/options'
-      autoload :Service, 'selenium/webdriver/edge_html/service'
-
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path=',
-                                   'Selenium::WebDriver::Edge::Service#driver_path=',
-                                   id: :driver_path
-        Selenium::WebDriver::Edge::Service.driver_path = path
-      end
-
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path',
-                                   'Selenium::WebDriver::Edge::Service#driver_path',
-                                   id: :driver_path
-        Selenium::WebDriver::Edge::Service.driver_path
-      end
-    end # EdgeHtml
-
-    module EdgeChrome
-      autoload :Bridge, 'selenium/webdriver/edge_chrome/bridge'
-      autoload :Driver, 'selenium/webdriver/edge_chrome/driver'
-      autoload :Profile, 'selenium/webdriver/edge_chrome/profile'
-      autoload :Options, 'selenium/webdriver/edge_chrome/options'
-      autoload :Service, 'selenium/webdriver/edge_chrome/service'
+    module Edge
+      autoload :Features, 'selenium/webdriver/edge/features'
+      autoload :Driver, 'selenium/webdriver/edge/driver'
+      autoload :Profile, 'selenium/webdriver/edge/profile'
+      autoload :Options, 'selenium/webdriver/edge/options'
+      autoload :Service, 'selenium/webdriver/edge/service'
 
       def self.path=(path)
         Platform.assert_executable path
@@ -56,8 +36,6 @@ module Selenium
       def self.path
         @path ||= nil
       end
-    end # EdgeChrome
-
-    Edge = EdgeHtml # Alias EdgeHtml as Edge for now
+    end # Edge
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/{edge_chrome → edge}/driver.rb

@@ -21,18 +21,24 @@ require 'selenium/webdriver/chrome/driver'
 
 module Selenium
   module WebDriver
-    module EdgeChrome
+    module Edge
 
       #
-      # Driver implementation for EdgeChrome.
+      # Driver implementation for Microsoft Edge.
       # @api private
       #
 
       class Driver < Selenium::WebDriver::Chrome::Driver
         def browser
-          :edge_chrome
+          :edge
+        end
+
+        private
+
+        def devtools_address
+          "http://#{capabilities['ms:edgeOptions']['debuggerAddress']}"
         end
       end # Driver
-    end # EdgeChrome
+    end # Edge
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/edge/features.rb

@@ -0,0 +1,39 @@
+# 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.
+
+require 'selenium/webdriver/chrome/features'
+
+module Selenium
+  module WebDriver
+    module Edge
+      module Features
+
+        include WebDriver::Chrome::Features
+
+        EDGE_COMMANDS = {
+          send_command: [:post, 'session/:session_id/ms/cdp/execute']
+        }.freeze
+
+        def commands(command)
+          EDGE_COMMANDS[command] || Chrome::Features::CHROME_COMMANDS[command] || self.class::COMMANDS[command]
+        end
+      end # Bridge
+    end # Edge
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{edge_chrome → edge}/options.rb

@@ -21,14 +21,23 @@ require 'selenium/webdriver/chrome/options'
 
 module Selenium
   module WebDriver
-    module EdgeChrome
+    module Edge
       class Options < Selenium::WebDriver::Chrome::Options
+        KEY = 'ms:edgeOptions'
+        BROWSER = 'MicrosoftEdge'
+
+        protected
+
+        def enable_logging(browser_options)
+          browser_options['ms:loggingPrefs'] = @logging_prefs
+        end
+
         private
 
         def binary_path
-          EdgeChrome.path
+          Edge.path
         end
       end # Options
-    end # EdgeChrome
+    end # Edge
   end # WebDriver
 end # Selenium