selenium-webdriver 4.28.0 → 4.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71aab5006f9982b59f81f1ba39119f70b84fec2603143f4445f4e0d8752169e5
-  data.tar.gz: 79dcff0ad7a8a73789a7e4bbc415098736aaa21f292be121bae398c71f086434
+  metadata.gz: c7bd6340cd61180fd4c0c8753b7dd74972781b016492a8ef9f8c57ade61d26ea
+  data.tar.gz: 0f44ea455592315221ba1e994f353b7d6d359fe88a093e25bf558bb7f286258f
 SHA512:
-  metadata.gz: d72ff0f3a97097dd479ad3bf0e7ad5f4d9b58d8c40545afd912ae0e211727ffd5da1cd3d52a8ec2973f8f86694424fd89ebb6fc394bac1171f6682ef5af6a6dd
-  data.tar.gz: 9e21d1c768e945fb445d652a49f85a05f9e85e3cb1f5f60eed5b213fec43562857702a12c8624a3523e381082990ff87bc521519930a85bc3f708cd05c71967c
+  metadata.gz: 8bc2ad2827460f67b298abc21740300382957d1dddc97f5708f89571d68ba9f479d21d8131c838b8430a291dc0bb0eaef02f961f83186603540967f01bf8749d
+  data.tar.gz: 1b532269414d71bad4c262bb2fb4a34b084bac4fa39b341f16305265fffb1c2f9e47fc399bf8e97f06212d37d15fec9f6361df4d5d4a480896a61ecc126e7a3b

data/CHANGES

@@ -1,3 +1,11 @@
+4.29.0 (2025-02-17)
+=========================
+* Add CDP for Chrome 133 and remove 130
+* [rb] Add Bidi Network Response Handler (#14900)
+* [rb] Remove Firefox CDP (#15200)
+* [rb][BiDi] Add support for provide response command (#15080)
+* [rb][BiDi] Add set cache behaviour (#15114)
+
 4.28.0 (2025-01-16)
 =========================
 * Add CDP for Chrome 132 and remove 129

data/lib/selenium/webdriver/bidi/network/cookies.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 Cookies < Hash
+        def initialize(cookies = {})
+          super()
+          merge!(cookies)
+        end
+
+        def as_json
+          self[:name] = self[:name].to_s
+          self[:value] = {type: 'string', value: self[:value].to_s}
+
+          [compact]
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,43 @@
+# 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 Credentials
+        attr_accessor :username, :password
+
+        def initialize(username: nil, password: nil)
+          @username = username
+          @password = password
+        end
+
+        def as_json
+          return nil unless username && password
+
+          {
+            type: 'password',
+            username: username,
+            password: password
+          }
+        end
+      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/bidi/network/intercepted_auth.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 InterceptedAuth < InterceptedItem
+        def authenticate(username, password)
+          network.continue_with_auth(id, username, password)
+        end
+
+        def skip
+          network.continue_without_auth(id)
+        end
+
+        def cancel
+          network.cancel_auth(id)
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/network/intercepted_item.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 BiDi
+      class InterceptedItem
+        attr_reader :network, :request
+
+        def initialize(network, request)
+          @network = network
+          @request = request
+        end
+
+        def id
+          @id ||= @request['request']
+        end
+      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
@@ -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,31 +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 continue_with_request(**args)
+        def continue_without_auth(request_id)
           @bidi.send_cmd(
-            'network.continueWithRequest',
-            request: args[:request_id],
-            'body' => args[:body],
-            'cookies' => args[:cookies],
-            'headers' => args[:headers],
-            'method' => args[:method],
-            'url' => args[:url]
+            '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, &)
           event = EVENTS[event] if event.is_a?(Symbol)
           @bidi.add_callback(event, &)
+          @bidi.session.subscribe(event)
         end
       end # Network
     end # BiDi

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)

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

@@ -17,47 +17,85 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'forwardable'
+
 module Selenium
   module WebDriver
     class Network
-      attr_reader :callbacks
+      extend Forwardable
+
+      attr_reader :callbacks, :network
+      alias bidi network
+
+      def_delegators :network, :continue_with_auth, :continue_with_request, :continue_with_response
 
       def initialize(bridge)
         @network = BiDi::Network.new(bridge.bidi)
         @callbacks = {}
       end
 
-      def add_authentication_handler(username, password)
-        intercept = @network.add_intercept(phases: [BiDi::Network::PHASES[:auth_required]])
-        auth_id = @network.on(:auth_required) do |event|
-          request_id = event['requestId']
-          @network.continue_with_auth(request_id, username, password)
-        end
-        @callbacks[auth_id] = intercept
+      def remove_handler(id)
+        intercept = callbacks[id]
+        network.remove_intercept(intercept['intercept'])
+        callbacks.delete(id)
+      end
+
+      def clear_handlers
+        callbacks.each_key { |id| remove_handler(id) }
+      end
 
-        auth_id
+      def add_authentication_handler(username = nil, password = nil, *filter, pattern_type: nil, &block)
+        selected_block =
+          if username && password
+            proc { |auth| auth.authenticate(username, password) }
+          else
+            block
+          end
+
+        add_handler(
+          :auth_required,
+          BiDi::Network::PHASES[:auth_required],
+          BiDi::InterceptedAuth,
+          filter,
+          pattern_type: pattern_type,
+          &selected_block
+        )
       end
 
-      def remove_handler(id)
-        intercept = @callbacks[id]
-        @network.remove_intercept(intercept['intercept'])
-        @callbacks.delete(id)
+      def add_request_handler(*filter, pattern_type: nil, &)
+        add_handler(
+          :before_request,
+          BiDi::Network::PHASES[:before_request],
+          BiDi::InterceptedRequest,
+          filter,
+          pattern_type: pattern_type,
+          &
+        )
       end
 
-      def clear_handlers
-        @callbacks.each_key { |id| remove_handler(id) }
+      def add_response_handler(*filter, pattern_type: nil, &)
+        add_handler(
+          :response_started,
+          BiDi::Network::PHASES[:response_started],
+          BiDi::InterceptedResponse,
+          filter,
+          pattern_type: pattern_type,
+          &
+        )
       end
 
-      def add_request_handler
-        intercept = @network.add_intercept(phases: [BiDi::Network::PHASES[:before_request]])
-        request_id = @network.on(:before_request) do |event|
-          request_id = event['requestId']
-          @network.continue_with_request(request_id: request_id)
-        end
+      private
 
-        @callbacks[request_id] = intercept
+      def add_handler(event_type, phase, intercept_type, filter, pattern_type: nil)
+        intercept = network.add_intercept(phases: [phase], url_patterns: [filter].flatten, pattern_type: pattern_type)
+        callback_id = network.on(event_type) do |event|
+          request = event['request']
+          intercepted_item = intercept_type.new(network, request)
+          yield(intercepted_item)
+        end
 
-        request_id
+        callbacks[callback_id] = intercept
+        callback_id
       end
     end # Network
   end # WebDriver

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

@@ -30,7 +30,6 @@ module Selenium
                       DriverExtensions::FullPageScreenshot,
                       DriverExtensions::HasContext,
                       DriverExtensions::HasBiDi,
-                      DriverExtensions::HasDevTools,
                       DriverExtensions::HasLogEvents,
                       DriverExtensions::HasNetworkInterception,
                       DriverExtensions::HasWebStorage,
@@ -46,23 +45,6 @@ module Selenium
         def browser
           :firefox
         end
-
-        private
-
-        def devtools_url
-          if capabilities['moz:debuggerAddress'].nil?
-            raise(Error::WebDriverError, 'DevTools is not supported by this version of Firefox; use v85 or higher')
-          end
-
-          uri = URI("http://#{capabilities['moz:debuggerAddress']}")
-          response = Net::HTTP.get(uri.hostname, '/json/version', uri.port)
-
-          JSON.parse(response)['webSocketDebuggerUrl']
-        end
-
-        def devtools_version
-          Firefox::DEVTOOLS_VERSION
-        end
       end # Driver
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.28.0'
+    VERSION = '4.29.0'
   end # WebDriver
 end # Selenium

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.28.0
+  version: 4.29.0
 platform: ruby
 authors:
 - Alex Rodionov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -298,6 +298,14 @@ files:
 - lib/selenium/webdriver/bidi/log_handler.rb
 - lib/selenium/webdriver/bidi/log_inspector.rb
 - lib/selenium/webdriver/bidi/network.rb
+- lib/selenium/webdriver/bidi/network/cookies.rb
+- lib/selenium/webdriver/bidi/network/credentials.rb
+- lib/selenium/webdriver/bidi/network/headers.rb
+- lib/selenium/webdriver/bidi/network/intercepted_auth.rb
+- lib/selenium/webdriver/bidi/network/intercepted_item.rb
+- lib/selenium/webdriver/bidi/network/intercepted_request.rb
+- lib/selenium/webdriver/bidi/network/intercepted_response.rb
+- lib/selenium/webdriver/bidi/network/url_pattern.rb
 - lib/selenium/webdriver/bidi/session.rb
 - lib/selenium/webdriver/bidi/struct.rb
 - lib/selenium/webdriver/chrome.rb