Handle requests and responses in block

Author: aguspe

rb/lib/selenium/webdriver/bidi.rb

@@ -26,6 +26,10 @@ class BiDi
       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)

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

@@ -91,7 +91,7 @@ def continue_with_request(**args)
         def continue_with_response(**args)
           @bidi.send_cmd(
             'network.continueResponse',
-            request: args[:request_id],
+            request: args[:response_id],
             'body' => args[:body],
             'cookies' => args[:cookies],
             'credentials' => args[:credentials],

rb/lib/selenium/webdriver/bidi/network/intercepted_auth.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.
+
+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
+

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

@@ -0,0 +1,46 @@
+# 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
+
+        def headers
+          request['headers']
+        end
+
+        def headers=(new_headers)
+          request['headers'] = new_headers
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium
+

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

@@ -0,0 +1,31 @@
+# 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 InterceptedRequest < InterceptedItem
+        def continue
+          network.continue_with_request(request_id: id)
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium
+

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

@@ -0,0 +1,31 @@
+# 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 InterceptedResponse < InterceptedItem
+        def continue
+          network.continue_with_response(response_id: id)
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium
+

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

@@ -44,37 +44,30 @@ def clear_handlers
         callbacks.each_key { |id| remove_handler(id) }
       end
 
-      def add_authentication_handler(username, password)
-        intercept = network.add_intercept(phases: [Selenium::WebDriver::BiDi::Network::PHASES[:auth_required]])
-        auth_id = network.on(:auth_required) do |event|
-          request_id = fetch_id(event)
-          network.continue_with_auth(request_id, username, password)
-        end
-
-        callbacks[auth_id] = intercept
-        auth_id
+      def add_authentication_handler(&)
+        add_handler(:auth_required, BiDi::Network::PHASES[:auth_required], BiDi::InterceptedAuth, &)
       end
 
       def add_request_handler(&)
-        intercept = network.add_intercept(phases: [BiDi::Network::PHASES[:before_request]])
-        request_id = network.on(:before_request, &)
-
-        callbacks[request_id] = intercept
-
-        request_id
+        add_handler(:before_request, BiDi::Network::PHASES[:before_request], BiDi::InterceptedRequest, &)
       end
 
       def add_response_handler(&)
-        intercept = network.add_intercept(phases: [BiDi::Network::PHASES[:response_started]])
-        response_id = network.on(:response_started, &)
+        add_handler(:response_started, BiDi::Network::PHASES[:response_started], BiDi::InterceptedResponse, &)
+      end
 
-        callbacks[response_id] = intercept
+      private
 
-        response_id
-      end
+      def add_handler(event_type, phase, intercept_type, &block)
+        intercept = network.add_intercept(phases: [phase])
+        callback_id = network.on(event_type) do |event|
+          request = event['request']
+          intercepted_item = intercept_type.new(network, request)
+          block.call(intercepted_item)
+        end
 
-      def fetch_id(event)
-        event['request']['request']
+        callbacks[callback_id] = intercept
+        callback_id
       end
     end # Network
   end # WebDriver

rb/spec/integration/selenium/webdriver/network_spec.rb

@@ -29,7 +29,9 @@ module WebDriver
       it 'adds an auth handler' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          network.add_authentication_handler(username, password)
+          network.add_authentication_handler do |response|
+            response.authenticate(username, password)
+          end
           driver.navigate.to url_for('basicAuth')
           expect(driver.find_element(tag_name: 'h1').text).to eq('authorized')
           expect(network.callbacks.count).to be 1
@@ -39,7 +41,9 @@ module WebDriver
       it 'removes an auth handler' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          id = network.add_authentication_handler(username, password)
+          id = network.add_authentication_handler do |response|
+            response.authenticate(username, password)
+          end
           network.remove_handler(id)
           expect(network.callbacks.count).to be 0
         end
@@ -48,17 +52,37 @@ module WebDriver
       it 'clears all auth handlers' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          network.add_authentication_handler(username, password)
-          network.add_authentication_handler(username, password)
+          2.times do
+            network.add_authentication_handler do |response|
+              response.authenticate(username, password)
+            end
+          end
           network.clear_handlers
           expect(network.callbacks.count).to be 0
         end
       end
 
+      it 'continues without auth' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_authentication_handler(&:skip)
+          expect { driver.navigate.to url_for('basicAuth') }.to raise_error(Error::WebDriverError)
+        end
+      end
+
+      it 'cancels auth' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_authentication_handler(&:cancel)
+          driver.navigate.to url_for('basicAuth')
+          expect(driver.find_element(tag_name: 'pre').text).to eq('Login please')
+        end
+      end
+
       it 'adds a request handler' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          network.add_request_handler { |event| network.continue_with_request(request_id: network.fetch_id(event)) }
+          network.add_request_handler(&:continue)
           driver.navigate.to url_for('formPage.html')
           expect(driver.find_element(name: 'login')).to be_displayed
           expect(network.callbacks.count).to be 1
@@ -68,7 +92,7 @@ module WebDriver
       it 'removes a request handler' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          id = network.add_request_handler
+          id = network.add_request_handler(&:continue)
           network.remove_handler(id)
           expect(network.callbacks.count).to be 0
         end
@@ -77,8 +101,7 @@ module WebDriver
       it 'clears all request handlers' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          network.add_request_handler
-          network.add_request_handler
+          2.times { network.add_request_handler(&:continue) }
           network.clear_handlers
           expect(network.callbacks.count).to be 0
         end
@@ -87,7 +110,7 @@ module WebDriver
       it 'adds a response handler' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          network.add_response_handler { |event| network.continue_with_response(request_id: network.fetch_id(event)) }
+          network.add_response_handler(&:continue)
           driver.navigate.to url_for('formPage.html')
           expect(driver.find_element(name: 'login')).to be_displayed
           expect(network.callbacks.count).to be 1
@@ -97,17 +120,17 @@ module WebDriver
       it 'removes a response handler' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
-          id = network.add_response_handler
+          id = network.add_response_handler(&:continue)
           network.remove_handler(id)
+          network.clear_handlers
           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
+          2.times { network.add_response_handler(&:continue) }
           network.clear_handlers
           expect(network.callbacks.count).to be 0
         end