Add response handler

SeleniumHQ · aguspe · Jan 23, 2025 · Dec 14, 2024 · Dec 18, 2024 · Dec 18, 2024
commit 7ef9d83c1b5e789f8af9881c0f0a9770c0445669
diff --git a/rb/lib/selenium/webdriver/bidi/network.rb b/rb/lib/selenium/webdriver/bidi/network.rb
@@ -72,6 +72,18 @@ def continue_with_request(**args)
           )
         end
 
+        def continue_with_response(**args)
+          @bidi.send_cmd(
+            'network.continueWithResponse',
+            response: args[:response_id],
+            'body' => args[:body],
+            'cookies' => args[:cookies],
+            'credentials' => args[:credentials],
+            'headers' => args[:headers],
+            'status' => args[:status]
+          )
+        end
+
         def on(event, &)
           event = EVENTS[event] if event.is_a?(Symbol)
           @bidi.add_callback(event, &)

diff --git a/rb/lib/selenium/webdriver/common/network.rb b/rb/lib/selenium/webdriver/common/network.rb
@@ -27,6 +27,16 @@ def initialize(bridge)
         @callbacks = {}
       end
 
+      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
+
       def add_authentication_handler(username, password)
         intercept = @network.add_intercept(phases: [BiDi::Network::PHASES[:auth_required]])
         auth_id = @network.on(:auth_required) do |event|
@@ -38,16 +48,6 @@ def add_authentication_handler(username, password)
         auth_id
       end
 
-      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
-
       def add_request_handler
         intercept = @network.add_intercept(phases: [BiDi::Network::PHASES[:before_request]])
         request_id = @network.on(:before_request) do |event|
@@ -59,6 +59,18 @@ def add_request_handler
 
         request_id
       end
+
+      def add_response_handler
+        intercept = @network.add_intercept(phases: [BiDi::Network::PHASES[:response_started]])
+        response_id = @network.on(:response_started) do |event|
+          request_id = event['requestId']
+          @network.continue_with_response(request_id: request_id)
+        end
+
+        @callbacks[response_id] = intercept
+
+        response_id
+      end
     end # Network
   end # WebDriver
 end # Selenium
diff --git a/rb/sig/lib/selenium/webdriver/bidi/network.rbs b/rb/sig/lib/selenium/webdriver/bidi/network.rbs
@@ -12,7 +12,9 @@ module Selenium
 
         def add_intercept: (?phases: Array[String], ?contexts: BrowsingContext?, ?url_patterns: untyped?) -> Hash[String, String]
 
-        def continue_with_request: -> untyped
+        def continue_with_request: (**untyped args) -> untyped
+
+        def continue_with_response: (**untyped args) -> untyped
 
         def remove_intercept: (String intercept) -> untyped
 

diff --git a/rb/sig/lib/selenium/webdriver/common/network.rbs b/rb/sig/lib/selenium/webdriver/common/network.rbs
@@ -13,6 +13,8 @@ module Selenium
 
       def add_request_handler: -> Integer
 
+      def add_response_handler: -> String
+
       def clear_handlers: -> Hash[nil, nil]
 
       def remove_handler: (Integer id) -> nil

diff --git a/rb/spec/integration/selenium/webdriver/bidi/network_spec.rb b/rb/spec/integration/selenium/webdriver/bidi/network_spec.rb
@@ -17,7 +17,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-
 require_relative '../spec_helper'
 
 module Selenium
@@ -70,6 +69,20 @@ class BiDi
             expect(driver.find_element(name: 'login')).to be_displayed
           end
         end
+
+        it 'continues with response' do
+          reset_driver!(web_socket_url: true) do |driver|
+            network = described_class.new(driver.bidi)
+            network.add_intercept(phases: [described_class::PHASES[:response_started]])
+            network.on(:response_started) do |event|
+              request_id = event['requestId']
+              network.continue_with_response(request_id: request_id)
+            end
+
+            driver.navigate.to url_for('formPage.html')
+            expect(driver.find_element(name: 'login')).to be_displayed
+          end
+        end
       end
     end
   end

diff --git a/rb/spec/integration/selenium/webdriver/network_spec.rb b/rb/spec/integration/selenium/webdriver/network_spec.rb
@@ -79,6 +79,33 @@ module WebDriver
           expect(network.callbacks.count).to be 0
         end
       end
+
+      it 'adds a response handler' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_response_handler
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
+      it 'removes a response handler' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          id = network.add_response_handler
+          network.remove_handler(id)
+          expect(network.callbacks.count).to be 0
+        end
+      end
+
+      it 'clears all response handlers' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_response_handler
+          network.add_response_handler
+          network.clear_handlers
+          expect(network.callbacks.count).to be 0
+        end
+      end
     end
   end
 end