selenium-webdriver 4.27.0 → 4.32.0

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

@@ -94,6 +94,21 @@ module Selenium
           result = @bidi.send_cmd('browsingContext.create', type: type.to_s, referenceContext: context_id)
           result['context']
         end
+
+        def set_viewport(context_id: nil, width: nil, height: nil, device_pixel_ratio: nil)
+          context_id ||= @bridge.window_handle
+          params = {context: context_id, viewport: {width:, height:}, device_pixel_ratio:}
+          @bidi.send_cmd('browsingContext.setViewport', **params)
+        end
+
+        def handle_user_prompt(context_id, accept: true, text: nil)
+          @bidi.send_cmd('browsingContext.handleUserPrompt', context: context_id, accept: accept, text: text)
+        end
+
+        def activate(context_id: nil)
+          context_id ||= @bridge.window_handle
+          @bidi.send_cmd('browsingContext.activate', context: context_id)
+        end
       end
     end # BiDi
   end # WebDriver

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

@@ -79,7 +79,7 @@ module Selenium
           end
         end
 
-        def on_log(filter_by = nil, &)
+        def on_log(filter_by = nil, &block)
           unless filter_by.nil?
             check_valid_filter(filter_by)
 
@@ -89,14 +89,14 @@ module Selenium
             return
           end
 
-          on(:entry_added, &)
+          on(:entry_added, &block)
         end
 
         private
 
-        def on(event, &)
+        def on(event, &block)
           event = EVENTS[event] if event.is_a?(Symbol)
-          @bidi.add_callback("log.#{event}", &)
+          @bidi.add_callback("log.#{event}", &block)
         end
 
         def check_valid_filter(filter_by)

data/lib/selenium/webdriver/{common/html5/session_storage.rb → bidi/network/cookies.rb}

@@ -19,43 +19,20 @@
 
 module Selenium
   module WebDriver
-    module HTML5
-      class SessionStorage
-        include Enumerable
-        include SharedWebStorage
-
-        def [](key)
-          @bridge.session_storage_item key
-        end
-
-        def []=(key, value)
-          @bridge.session_storage_item key, value
-        end
-
-        def delete(key)
-          @bridge.remove_session_storage_item key
-        end
-
-        def clear
-          @bridge.clear_session_storage
-        end
-
-        def size
-          @bridge.session_storage_size
-        end
-
-        def keys
-          @bridge.session_storage_keys.reverse
+    class BiDi
+      class Cookies < Hash
+        def initialize(cookies = {})
+          super()
+          merge!(cookies)
         end
 
-        #
-        # @api private
-        #
+        def as_json
+          self[:name] = self[:name].to_s
+          self[:value] = {type: 'string', value: self[:value].to_s}
 
-        def initialize(bridge)
-          @bridge = bridge
+          [compact]
         end
-      end # SessionStorage
-    end # HTML5
+      end
+    end # BiDi
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/{common/html5/local_storage.rb → bidi/network/credentials.rb}

@@ -19,41 +19,25 @@
 
 module Selenium
   module WebDriver
-    module HTML5
-      class LocalStorage
-        include SharedWebStorage
+    class BiDi
+      class Credentials
+        attr_accessor :username, :password
 
-        #
-        # @api private
-        #
-        def initialize(bridge)
-          @bridge = bridge
+        def initialize(username: nil, password: nil)
+          @username = username
+          @password = password
         end
 
-        def [](key)
-          @bridge.local_storage_item key
-        end
-
-        def []=(key, value)
-          @bridge.local_storage_item key, value
-        end
-
-        def delete(key)
-          @bridge.remove_local_storage_item key
-        end
-
-        def clear
-          @bridge.clear_local_storage
-        end
-
-        def size
-          @bridge.local_storage_size
-        end
+        def as_json
+          return nil unless username && password
 
-        def keys
-          @bridge.local_storage_keys.reverse
+          {
+            type: 'password',
+            username: username,
+            password: password
+          }
         end
-      end # LocalStorage
-    end # HTML5
+      end
+    end # BiDi
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/bidi/network/headers.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 BiDi
+      class Headers < Hash
+        def as_json
+          map do |name, val|
+            {
+              name: name.to_s,
+              value: {
+                type: 'string',
+                value: val.to_s
+              }
+            }
+          end
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{common/html5/shared_web_storage.rb → bidi/network/intercepted_auth.rb}

@@ -19,35 +19,20 @@
 
 module Selenium
   module WebDriver
-    module HTML5
-      module SharedWebStorage
-        include Enumerable
-
-        def key?(key)
-          keys.include? key
+    class BiDi
+      class InterceptedAuth < InterceptedItem
+        def authenticate(username, password)
+          network.continue_with_auth(id, username, password)
         end
-        alias member? key?
-        alias has_key? key?
-
-        def fetch(key)
-          return self[key] if key? key
-          return yield(key) if block_given?
 
-          raise KeyError, "missing key #{key.inspect}"
+        def skip
+          network.continue_without_auth(id)
         end
 
-        def empty?
-          to_a.empty?
-        end
-
-        def each
-          return enum_for(:each) unless block_given?
-
-          keys.each do |k|
-            yield k, self[k]
-          end
+        def cancel
+          network.cancel_auth(id)
         end
-      end # SharedWebStorage
-    end # HTML5
+      end
+    end # BiDi
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/{common/driver_extensions/has_web_storage.rb → bidi/network/intercepted_item.rb}

@@ -19,20 +19,19 @@
 
 module Selenium
   module WebDriver
-    #
-    # @api private
-    #
+    class BiDi
+      class InterceptedItem
+        attr_reader :network, :request
 
-    module DriverExtensions
-      module HasWebStorage
-        def local_storage
-          HTML5::LocalStorage.new @bridge
+        def initialize(network, request)
+          @network = network
+          @request = request
         end
 
-        def session_storage
-          HTML5::SessionStorage.new @bridge
+        def id
+          @id ||= @request['request']
         end
-      end # HasWebStorage
-    end # DriverExtensions
+      end
+    end # BiDi
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/bidi/network/intercepted_request.rb

@@ -0,0 +1,69 @@
+# 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 'cookies'
+require_relative 'headers'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class InterceptedRequest < InterceptedItem
+        attr_accessor :method, :url
+        attr_reader :body
+
+        def initialize(network, request)
+          super
+          @method = nil
+          @url = nil
+          @body = nil
+        end
+
+        def continue
+          network.continue_request(
+            id: id,
+            body: body,
+            cookies: cookies.as_json,
+            headers: headers.as_json,
+            method: method,
+            url: url
+          )
+        end
+
+        def fail
+          network.fail_request(id)
+        end
+
+        def body=(value)
+          @body = {
+            type: 'string',
+            value: value.to_json
+          }
+        end
+
+        def headers
+          @headers ||= Headers.new
+        end
+
+        def cookies(cookies = {})
+          @cookies ||= Cookies.new(cookies)
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/network/intercepted_response.rb

@@ -0,0 +1,81 @@
+# 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 'credentials'
+require_relative 'headers'
+require_relative 'cookies'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class InterceptedResponse < InterceptedItem
+        attr_accessor :reason, :status
+        attr_reader :body
+
+        def initialize(network, request)
+          super
+          @reason = nil
+          @status = nil
+          @body = nil
+        end
+
+        def continue
+          network.continue_response(
+            id: id,
+            cookies: cookies.as_json,
+            headers: headers.as_json,
+            credentials: credentials.as_json,
+            reason: reason,
+            status: status
+          )
+        end
+
+        def provide_response
+          network.provide_response(
+            id: id,
+            cookies: cookies.as_json,
+            headers: headers.as_json,
+            body: body,
+            reason: reason,
+            status: status
+          )
+        end
+
+        def credentials(username: nil, password: nil)
+          @credentials ||= Credentials.new(username: username, password: password)
+        end
+
+        def headers
+          @headers ||= Headers.new
+        end
+
+        def cookies(cookies = {})
+          @cookies ||= Cookies.new(cookies)
+        end
+
+        def body=(value)
+          @body = {
+            type: 'string',
+            value: value.to_json
+          }
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/network/url_pattern.rb

@@ -0,0 +1,65 @@
+# 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 'uri'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      module UrlPattern
+        module_function
+
+        def format_pattern(url_patterns, pattern_type)
+          case pattern_type
+          when :string
+            to_url_string_pattern(url_patterns)
+          when :url
+            to_url_pattern(url_patterns)
+          else
+            raise ArgumentError, "Unknown pattern type: #{pattern_type}"
+          end
+        end
+
+        def to_url_pattern(*url_patterns)
+          url_patterns.flatten.map do |url_pattern|
+            uri = URI.parse(url_pattern)
+
+            {
+              type: 'pattern',
+              protocol: uri.scheme || '',
+              hostname: uri.host || '',
+              port: uri.port.to_s || '',
+              pathname: uri.path || '',
+              search: uri.query || ''
+            }
+          end
+        end
+
+        def to_url_string_pattern(*url_patterns)
+          url_patterns.flatten.map do |url_pattern|
+            {
+              type: 'string',
+              pattern: url_pattern
+            }
+          end
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

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

@@ -16,6 +16,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+require_relative 'network/url_pattern'
 
 module Selenium
   module WebDriver
@@ -26,7 +27,7 @@ module Selenium
           response_started: 'network.responseStarted',
           response_completed: 'network.responseCompleted',
           auth_required: 'network.authRequired',
-          FETCH_ERROR: 'network.fetchError'
+          fetch_error: 'network.fetchError'
         }.freeze
 
         PHASES = {
@@ -39,8 +40,12 @@ module Selenium
           @bidi = bidi
         end
 
-        def add_intercept(phases: [], contexts: nil, url_patterns: nil)
-          @bidi.send_cmd('network.addIntercept', phases: phases, contexts: contexts, urlPatterns: url_patterns)
+        def add_intercept(phases: [], contexts: nil, url_patterns: nil, pattern_type: :string)
+          url_patterns = url_patterns && pattern_type ? UrlPattern.format_pattern(url_patterns, pattern_type) : nil
+          @bidi.send_cmd('network.addIntercept',
+                         phases: phases,
+                         contexts: contexts,
+                         urlPatterns: url_patterns)
         end
 
         def remove_intercept(intercept)
@@ -50,19 +55,83 @@ module Selenium
         def continue_with_auth(request_id, username, password)
           @bidi.send_cmd(
             'network.continueWithAuth',
-            'request' => request_id,
-            'action' => 'provideCredentials',
-            'credentials' => {
-              'type' => 'password',
-              'username' => username,
-              'password' => password
+            request: request_id,
+            action: 'provideCredentials',
+            credentials: {
+              type: 'password',
+              username: username,
+              password: password
             }
           )
         end
 
-        def on(event, &)
+        def continue_without_auth(request_id)
+          @bidi.send_cmd(
+            'network.continueWithAuth',
+            request: request_id,
+            action: 'default'
+          )
+        end
+
+        def cancel_auth(request_id)
+          @bidi.send_cmd(
+            'network.continueWithAuth',
+            request: request_id,
+            action: 'cancel'
+          )
+        end
+
+        def continue_request(**args)
+          @bidi.send_cmd(
+            'network.continueRequest',
+            request: args[:id],
+            body: args[:body],
+            cookies: args[:cookies],
+            headers: args[:headers],
+            method: args[:method],
+            url: args[:url]
+          )
+        end
+
+        def fail_request(request_id)
+          @bidi.send_cmd(
+            'network.failRequest',
+            request: request_id
+          )
+        end
+
+        def continue_response(**args)
+          @bidi.send_cmd(
+            'network.continueResponse',
+            request: args[:id],
+            cookies: args[:cookies],
+            credentials: args[:credentials],
+            headers: args[:headers],
+            reasonPhrase: args[:reason],
+            statusCode: args[:status]
+          )
+        end
+
+        def provide_response(**args)
+          @bidi.send_cmd(
+            'network.provideResponse',
+            request: args[:id],
+            body: args[:body],
+            cookies: args[:cookies],
+            headers: args[:headers],
+            reasonPhrase: args[:reason],
+            statusCode: args[:status]
+          )
+        end
+
+        def set_cache_behavior(behavior, *contexts)
+          @bidi.send_cmd('network.setCacheBehavior', cacheBehavior: behavior, contexts: contexts)
+        end
+
+        def on(event, &block)
           event = EVENTS[event] if event.is_a?(Symbol)
-          @bidi.add_callback(event, &)
+          @bidi.add_callback(event, &block)
+          @bidi.session.subscribe(event)
         end
       end # Network
     end # BiDi

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

@@ -23,7 +23,7 @@ module Selenium
       class Struct < ::Struct
         class << self
           def new(*args, &block)
-            super(*args) do
+            super do
               define_method(:initialize) do |**kwargs|
                 converted_kwargs = kwargs.transform_keys { |key| self.class.camel_to_snake(key.to_s).to_sym }
                 super(*converted_kwargs.values_at(*self.class.members))

data/lib/selenium/webdriver/bidi.rb

@@ -26,6 +26,10 @@ module Selenium
       autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
       autoload :Struct, 'selenium/webdriver/bidi/struct'
       autoload :Network, 'selenium/webdriver/bidi/network'
+      autoload :InterceptedRequest, 'selenium/webdriver/bidi/network/intercepted_request'
+      autoload :InterceptedResponse, 'selenium/webdriver/bidi/network/intercepted_response'
+      autoload :InterceptedAuth, 'selenium/webdriver/bidi/network/intercepted_auth'
+      autoload :InterceptedItem, 'selenium/webdriver/bidi/network/intercepted_item'
 
       def initialize(url:)
         @ws = WebSocketConnection.new(url: url)
@@ -39,8 +43,8 @@ module Selenium
         @ws.callbacks
       end
 
-      def add_callback(event, &)
-        @ws.add_callback(event, &)
+      def add_callback(event, &block)
+        @ws.add_callback(event, &block)
       end
 
       def remove_callback(event, id)

data/lib/selenium/webdriver/chromium/driver.rb

@@ -32,7 +32,6 @@ module Selenium
                       DriverExtensions::HasFedCmDialog,
                       DriverExtensions::HasNetworkConditions,
                       DriverExtensions::HasNetworkInterception,
-                      DriverExtensions::HasWebStorage,
                       DriverExtensions::HasLaunching,
                       DriverExtensions::HasPermissions,
                       DriverExtensions::DownloadsFiles,

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

@@ -104,15 +104,8 @@ module Selenium
       # @see Script
       #
 
-      def script(*args)
-        if args.any?
-          WebDriver.logger.deprecate('`Driver#script` as an alias for `#execute_script`',
-                                     '`Driver#execute_script`',
-                                     id: :driver_script)
-          execute_script(*args)
-        else
-          @script ||= WebDriver::Script.new(bridge)
-        end
+      def script
+        @script ||= WebDriver::Script.new(bridge)
       end
 
       #
@@ -188,7 +181,7 @@ module Selenium
         bridge.quit
       ensure
         @service_manager&.stop
-        @devtools&.close
+        @devtools&.each_value(&:close)
       end
 
       #