Add filtering an url pattern support

Author: aguspe

rb/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 @@ def initialize(bidi)
           @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)

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+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
+  end
+end

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

@@ -44,29 +44,50 @@ def clear_handlers
         callbacks.each_key { |id| remove_handler(id) }
       end
 
-      def add_authentication_handler(username = nil, password = nil, &block)
+      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, &selected_block)
+        add_handler(
+          :auth_required,
+          BiDi::Network::PHASES[:auth_required],
+          BiDi::InterceptedAuth,
+          filter,
+          pattern_type: pattern_type,
+          &selected_block
+        )
       end
 
-      def add_request_handler(&)
-        add_handler(:before_request, BiDi::Network::PHASES[:before_request], BiDi::InterceptedRequest, &)
+      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 add_response_handler(&)
-        add_handler(:response_started, BiDi::Network::PHASES[:response_started], BiDi::InterceptedResponse, &)
+      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
 
       private
 
-      def add_handler(event_type, phase, intercept_type)
-        intercept = network.add_intercept(phases: [phase])
+      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)

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

@@ -14,12 +14,14 @@ module Selenium
 
         def cancel_auth: -> untyped
 
-        def continue_with_request: (**untyped args) -> untyped
+        def continue_request: -> untyped
 
-        def continue_with_response: (**untyped args) -> untyped
+        def continue_response: -> untyped
 
         def continue_without_auth: -> untyped
 
+        def fail_request: -> untyped
+
         def remove_intercept: (String intercept) -> untyped
 
         def continue_with_auth: (String request_id, String username, String password) -> untyped

rb/sig/lib/selenium/webdriver/bidi/network/cookies.rbs

@@ -0,0 +1,13 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      module Cookies
+        def add_cookie: (untyped name, untyped value) -> untyped
+
+        def remove_cookie: (untyped name) -> untyped
+
+        def set_cookie_header: (**untyped args) -> untyped
+      end
+    end
+  end
+end

rb/sig/lib/selenium/webdriver/bidi/network/headers.rbs

@@ -0,0 +1,11 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      module Headers
+        def add_header: (untyped name, untyped value) -> untyped
+
+        def remove_header: (untyped name) -> untyped
+      end
+    end
+  end
+end

rb/sig/lib/selenium/webdriver/bidi/network/url_pattern.rbs

@@ -0,0 +1,13 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      module UrlPattern
+        def self?.format_pattern: (untyped url_patterns, untyped pattern_type) -> untyped
+
+        def self?.to_url_pattern: (*untyped url_patterns) -> untyped
+
+        def self?.to_url_string_pattern: (*untyped url_patterns) -> untyped
+      end
+    end
+  end
+end

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

@@ -21,9 +21,11 @@ module Selenium
 
       def clear_handlers: -> Hash[nil, nil]
 
-      def fetch_id: -> String
-
       def remove_handler: (Integer id) -> nil
+
+      private
+
+      def add_handler: -> untyped
     end
   end
 end

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

@@ -32,6 +32,26 @@ class BiDi
           end
         end
 
+        it 'adds an intercept with a default pattern type' do
+          reset_driver!(web_socket_url: true) do |driver|
+            network = described_class.new(driver.bidi)
+            pattern = 'http://localhost:4444/formPage.html'
+            intercept = network.add_intercept(phases: [described_class::PHASES[:before_request]], url_patterns: pattern)
+            expect(intercept).not_to be_nil
+          end
+        end
+
+        it 'adds an intercept with a url pattern' do
+          reset_driver!(web_socket_url: true) do |driver|
+            network = described_class.new(driver.bidi)
+            pattern = 'http://localhost:4444/formPage.html'
+            intercept = network.add_intercept(phases: [described_class::PHASES[:before_request]],
+                                              url_patterns: pattern,
+                                              pattern_type: :url)
+            expect(intercept).not_to be_nil
+          end
+        end
+
         it 'removes an intercept' do
           reset_driver!(web_socket_url: true) do |driver|
             network = described_class.new(driver.bidi)

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

@@ -36,6 +36,36 @@ module WebDriver
         end
       end
 
+      it 'adds an auth handler with a filter' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_authentication_handler(username, password, url_for('basicAuth'))
+          driver.navigate.to url_for('basicAuth')
+          expect(driver.find_element(tag_name: 'h1').text).to eq('authorized')
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
+      it 'adds an auth handler with multiple filters' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_authentication_handler(username, password, url_for('basicAuth'), url_for('formPage.html'))
+          driver.navigate.to url_for('basicAuth')
+          expect(driver.find_element(tag_name: 'h1').text).to eq('authorized')
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
+      it 'adds an auth handler with a pattern type' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_authentication_handler(username, password, url_for('basicAuth'), pattern_type: :url)
+          driver.navigate.to url_for('basicAuth')
+          expect(driver.find_element(tag_name: 'h1').text).to eq('authorized')
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
       it 'removes an auth handler' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
@@ -81,6 +111,36 @@ module WebDriver
         end
       end
 
+      it 'adds a request handler with a filter' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_request_handler(url_for('formPage.html'), &:continue)
+          driver.navigate.to url_for('formPage.html')
+          expect(driver.find_element(name: 'login')).to be_displayed
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
+      it 'adds a request handler with multiple filters' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_request_handler(url_for('formPage.html'), url_for('basicAuth'), &:continue)
+          driver.navigate.to url_for('formPage.html')
+          expect(driver.find_element(name: 'login')).to be_displayed
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
+      it 'adds a request handler with a pattern type' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_request_handler(url_for('formPage.html'), pattern_type: :url, &:continue)
+          driver.navigate.to url_for('formPage.html')
+          expect(driver.find_element(name: 'login')).to be_displayed
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
       it 'adds a request handler with attributes' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)
@@ -158,6 +218,36 @@ module WebDriver
         end
       end
 
+      it 'adds a response handler with a filter' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_response_handler(url_for('formPage.html'), &:continue)
+          driver.navigate.to url_for('formPage.html')
+          expect(driver.find_element(name: 'login')).to be_displayed
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
+      it 'adds a response handler with multiple filters' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_response_handler(url_for('formPage.html'), url_for('basicAuth'), &:continue)
+          driver.navigate.to url_for('formPage.html')
+          expect(driver.find_element(name: 'login')).to be_displayed
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
+      it 'adds a response handler with a pattern type' do
+        reset_driver!(web_socket_url: true) do |driver|
+          network = described_class.new(driver)
+          network.add_response_handler(url_for('formPage.html'), pattern_type: :url, &:continue)
+          driver.navigate.to url_for('formPage.html')
+          expect(driver.find_element(name: 'login')).to be_displayed
+          expect(network.callbacks.count).to be 1
+        end
+      end
+
       it 'adds a response handler with attributes' do
         reset_driver!(web_socket_url: true) do |driver|
           network = described_class.new(driver)