selenium-webdriver 3.142.7 → 4.16.0

data/lib/selenium/webdriver/atoms.rb

@@ -20,6 +20,10 @@
 module Selenium
   module WebDriver
     module Atoms
+      def atom_script(function_name)
+        format("/* #{function_name} */return (%<atom>s).apply(null, arguments)",
+               atom: read_atom(function_name))
+      end
 
       private
 
@@ -28,10 +32,8 @@ module Selenium
       end
 
       def execute_atom(function_name, *arguments)
-        script = format("return (%<atom>s).apply(null, arguments)", atom: read_atom(function_name))
-        execute_script(script, *arguments)
+        execute_script(atom_script(function_name), *arguments)
       end
-
     end # Atoms
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/bidi/browsing_context.rb

@@ -0,0 +1,88 @@
+# 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_relative 'navigate_result'
+require_relative 'browsing_context_info'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class BrowsingContext
+        attr_accessor :id
+
+        READINESS_STATE = {
+          none: 'none',
+          interactive: 'interactive',
+          complete: 'complete'
+        }.freeze
+
+        def initialize(driver:, browsing_context_id: nil, type: nil, reference_context: nil)
+          unless driver.capabilities.web_socket_url
+            raise Error::WebDriverError,
+                  'WebDriver instance must support BiDi protocol'
+          end
+
+          unless type.nil? || %i[window tab].include?(type)
+            raise ArgumentError,
+                  "Valid types are :window & :tab. Received: #{type.inspect}"
+          end
+
+          @bidi = driver.bidi
+          @id = browsing_context_id.nil? ? create(type, reference_context)['context'] : browsing_context_id
+        end
+
+        def navigate(url:, readiness_state: nil)
+          unless readiness_state.nil? || READINESS_STATE.key?(readiness_state)
+            raise ArgumentError,
+                  "Valid readiness states are :none, :interactive & :complete. Received: #{readiness_state.inspect}"
+          end
+
+          navigate_result = @bidi.send_cmd('browsingContext.navigate', context: @id, url: url,
+                                                                       wait: READINESS_STATE[readiness_state])
+
+          NavigateResult.new(
+            url: navigate_result['url'],
+            navigation_id: navigate_result['navigation']
+          )
+        end
+
+        def get_tree(max_depth: nil)
+          result = @bidi.send_cmd('browsingContext.getTree', root: @id, maxDepth: max_depth).dig('contexts', 0)
+
+          BrowsingContextInfo.new(
+            id: result['context'],
+            url: result['url'],
+            children: result['children'],
+            parent_context: result['parent']
+          )
+        end
+
+        def close
+          @bidi.send_cmd('browsingContext.close', context: @id)
+        end
+
+        private
+
+        def create(type, reference_context)
+          @bidi.send_cmd('browsingContext.create', type: type.to_s, referenceContext: reference_context)
+        end
+      end # BrowsingContext
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/browsing_context_info.rb

@@ -0,0 +1,35 @@
+# 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 BiDi
+      class BrowsingContextInfo
+        attr_accessor :id, :url, :children, :parent_browsing_context
+
+        def initialize(id:, url:, children:, parent_context:)
+          @id = id
+          @url = url
+          @children = children
+          @parent_browsing_context = parent_context
+        end
+      end # BrowsingContextInfo
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/base_log_entry.rb

@@ -0,0 +1,35 @@
+# 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 BiDi
+      class BaseLogEntry
+        attr_accessor :level, :text, :timestamp, :stack_trace
+
+        def initialize(level:, text:, timestamp:, stack_trace:)
+          @level = level
+          @text = text
+          @timestamp = timestamp
+          @stack_trace = stack_trace
+        end
+      end # BaseLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/console_log_entry.rb

@@ -0,0 +1,35 @@
+# 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 BiDi
+      class ConsoleLogEntry < GenericLogEntry
+        attr_accessor :method, :realm, :args
+
+        def initialize(method:, realm:, args:, **opts)
+          super(**opts)
+          @method = method
+          @realm = realm
+          @args = args
+        end
+      end # ConsoleLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/filter_by.rb

@@ -0,0 +1,40 @@
+# 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 BiDi
+      class FilterBy
+        attr_accessor :level
+
+        def initialize(level)
+          @level = level
+        end
+
+        def self.log_level(level = nil)
+          unless %w[debug error info warning].include?(level)
+            raise Error::WebDriverError,
+                  "Valid log levels are 'debug', 'error', 'info' and 'warning'. Received: #{level}"
+          end
+          FilterBy.new(level)
+        end
+      end # FilterBy
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/generic_log_entry.rb

@@ -0,0 +1,33 @@
+# 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 BiDi
+      class GenericLogEntry < BaseLogEntry
+        attr_accessor :type
+
+        def initialize(level:, text:, timestamp:, type:, stack_trace:)
+          super(level: level, text: text, timestamp: timestamp, stack_trace: stack_trace)
+          @type = type
+        end
+      end # GenericLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/javascript_log_entry.rb

@@ -0,0 +1,33 @@
+# 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 BiDi
+      class JavascriptLogEntry < GenericLogEntry
+        attr_accessor :type
+
+        def initialize(level:, text:, timestamp:, type:, stack_trace:)
+          super(level: level, text: text, timestamp: timestamp, type: type, stack_trace: stack_trace)
+          @type = 'javascript'
+        end
+      end # JavascriptLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log_inspector.rb

@@ -0,0 +1,143 @@
+# 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!
+
+require_relative 'log/base_log_entry'
+require_relative 'log/generic_log_entry'
+require_relative 'log/console_log_entry'
+require_relative 'log/javascript_log_entry'
+require_relative 'log/filter_by'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class LogInspector
+        EVENTS = {
+          entry_added: 'entryAdded'
+        }.freeze
+
+        LOG_LEVEL = {
+          DEBUG: 'debug',
+          ERROR: 'error',
+          INFO: 'info',
+          WARNING: 'warning'
+        }.freeze
+
+        def initialize(driver, browsing_context_ids = nil)
+          unless driver.capabilities.web_socket_url
+            raise Error::WebDriverError,
+                  'WebDriver instance must support BiDi protocol'
+          end
+
+          @bidi = driver.bidi
+          @bidi.session.subscribe('log.entryAdded', browsing_context_ids)
+        end
+
+        def on_console_entry(filter_by = nil, &block)
+          check_valid_filter(filter_by)
+
+          on_log do |params|
+            type = params['type']
+            console_log_events(params, filter_by, &block) if type.eql?('console')
+          end
+        end
+
+        def on_javascript_log(filter_by = nil, &block)
+          check_valid_filter(filter_by)
+
+          on_log do |params|
+            type = params['type']
+            javascript_log_events(params, filter_by, &block) if type.eql?('javascript')
+          end
+        end
+
+        def on_javascript_exception(&block)
+          on_log do |params|
+            type = params['type']
+            javascript_log_events(params, FilterBy.log_level('error'), &block) if type.eql?('javascript')
+          end
+        end
+
+        def on_log(filter_by = nil, &block)
+          unless filter_by.nil?
+            check_valid_filter(filter_by)
+
+            on(:entry_added) do |params|
+              yield(params) if params['level'] == filter_by.level
+            end
+            return
+          end
+
+          on(:entry_added, &block)
+        end
+
+        private
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @bidi.callbacks["log.#{event}"] << block
+        end
+
+        def check_valid_filter(filter_by)
+          return if filter_by.nil? || filter_by.instance_of?(FilterBy)
+
+          raise "Pass valid FilterBy object. Received: #{filter_by.inspect}"
+        end
+
+        def console_log_events(params, filter_by)
+          event = ConsoleLogEntry.new(
+            level: params['level'],
+            text: params['text'],
+            timestamp: params['timestamp'],
+            type: params['type'],
+            method: params['method'],
+            realm: params['realm'],
+            args: params['args'],
+            stack_trace: params['stackTrace']
+          )
+
+          unless filter_by.nil?
+            yield(event) if params['level'] == filter_by.level
+            return
+          end
+
+          yield(event)
+        end
+
+        def javascript_log_events(params, filter_by)
+          event = JavascriptLogEntry.new(
+            level: params['level'],
+            text: params['text'],
+            timestamp: params['timestamp'],
+            type: params['type'],
+            stack_trace: params['stackTrace']
+          )
+
+          unless filter_by.nil?
+            yield(event) if params['level'] == filter_by.level
+            return
+          end
+
+          yield(event)
+        end
+      end # LogInspector
+    end # Bidi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/navigate_result.rb

@@ -0,0 +1,33 @@
+# 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 BiDi
+      class NavigateResult
+        attr_accessor :url, :navigation_id
+
+        def initialize(url:, navigation_id:)
+          @url = url
+          @navigation_id = navigation_id
+        end
+      end # NavigateResult
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/session.rb

@@ -0,0 +1,51 @@
+# 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 BiDi
+      class Session
+        Status = Struct.new(:ready, :message)
+
+        def initialize(bidi)
+          @bidi = bidi
+        end
+
+        def status
+          status = @bidi.send_cmd('session.status')
+          Status.new(status['ready'], status['message'])
+        end
+
+        def subscribe(events, browsing_contexts = nil)
+          events_list = Array(events)
+          browsing_contexts_list = browsing_contexts.nil? ? nil : Array(browsing_contexts)
+
+          @bidi.send_cmd('session.subscribe', events: events_list, contexts: browsing_contexts_list)
+        end
+
+        def unsubscribe(events, browsing_contexts = nil)
+          events_list = Array(events)
+          browsing_contexts_list = browsing_contexts.nil? ? nil : Array(browsing_contexts)
+
+          @bidi.send_cmd('session.unsubscribe', events: events_list, contexts: browsing_contexts_list)
+        end
+      end # Session
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{common/keyboard.rb → bidi.rb}

@@ -19,52 +19,38 @@
 
 module Selenium
   module WebDriver
-    #
-    # @api private
-    # @see ActionBuilder
+    class BiDi
+      autoload :Session, 'selenium/webdriver/bidi/session'
+      autoload :LogInspector, 'selenium/webdriver/bidi/log_inspector'
+      autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
 
-    class Keyboard
-      def initialize(bridge)
-        @bridge = bridge
+      def initialize(url:)
+        @ws = WebSocketConnection.new(url: url)
       end
 
-      def send_keys(*keys)
-        @bridge.send_keys_to_active_element Keys.encode(keys)
+      def close
+        @ws.close
       end
 
-      #
-      # Press a modifier key
-      #
-      # @see Selenium::WebDriver::Keys
-      #
-
-      def press(key)
-        assert_modifier key
-
-        @bridge.send_keys_to_active_element Keys.encode([key])
+      def callbacks
+        @ws.callbacks
       end
 
-      #
-      # Release a modifier key
-      #
-      # @see Selenium::WebDriver::Keys
-      #
-
-      def release(key)
-        assert_modifier key
-
-        @bridge.send_keys_to_active_element Keys.encode([key])
+      def session
+        @session ||= Session.new(self)
       end
 
-      private
-
-      MODIFIERS = %i[control shift alt command meta].freeze
+      def send_cmd(method, **params)
+        data = {method: method, params: params.compact}
+        message = @ws.send_cmd(**data)
+        raise Error::WebDriverError, error_message(message) if message['error']
 
-      def assert_modifier(key)
-        return if MODIFIERS.include? key
+        message['result']
+      end
 
-        raise ArgumentError, "#{key.inspect} is not a modifier key, expected one of #{MODIFIERS.inspect}"
+      def error_message(message)
+        "#{message['error']}: #{message['message']}\n#{message['stacktrace']}"
       end
-    end # Keyboard
+    end # BiDi
   end # WebDriver
 end # Selenium