chore: use blacklist/whitelist and proxy from ferrum

Author: route

.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         gemfile: [websocket-driver-0.6.x, websocket-driver-0.7.x]
-        ruby: [2.7, 3.0, 3.1]
+        ruby: [2.6, 2.7, 3.0, 3.1]
     runs-on: ubuntu-latest
     env:
       FERRUM_PROCESS_TIMEOUT: 20

README.md

@@ -183,6 +183,9 @@ Besides capybara screenshot method you can get image as Base64:
 ## Authorization
 
 * `page.driver.basic_authorize(user, password)`
+
+## Proxy
+
 * `page.driver.set_proxy(ip, port, type, user, password)`
 
 
@@ -192,14 +195,14 @@ Cuprite supports URL blacklisting, which allows you to prevent scripts from
 running on designated domains:
 
 ```ruby
-page.driver.browser.url_blacklist = ["http://www.example.com"]
+page.driver.browser.url_blacklist = %r{http://www.example.com}
 ```
 
 and also URL whitelisting, which allows scripts to only run on designated
 domains:
 
 ```ruby
-page.driver.browser.url_whitelist = ["http://www.example.com"]
+page.driver.browser.url_whitelist = %r{http://www.example.com}
 ```
 
 If you are experiencing slower run times, consider creating a URL whitelist of

lib/capybara/cuprite/browser.rb

@@ -46,13 +46,15 @@ def quit
 
       def url_whitelist=(patterns)
         @url_whitelist = prepare_wildcards(patterns)
-        page.network.intercept if @client && !@url_whitelist.empty?
+        page.network.whitelist = @url_whitelist if @client && @url_whitelist.any?
       end
+      alias url_allowlist= url_whitelist=
 
       def url_blacklist=(patterns)
         @url_blacklist = prepare_wildcards(patterns)
-        page.network.intercept if @client && !@url_blacklist.empty?
+        page.network.blacklist = @url_blacklist if @client && @url_blacklist.any?
       end
+      alias url_blocklist= url_blacklist=
 
       def visit(*args)
         goto(*args)
@@ -199,15 +201,22 @@ def find_all(method, selector, within = nil)
         raise
       end
 
-      def prepare_wildcards(wc)
-        Array(wc).map do |wildcard|
-          if wildcard.is_a?(Regexp)
-            wildcard
+      def prepare_wildcards(patterns)
+        string_passed = false
+
+        Array(patterns).map do |pattern|
+          if pattern.is_a?(Regexp)
+            pattern
           else
-            wildcard = wildcard.gsub("*", ".*")
-            Regexp.new(wildcard, Regexp::IGNORECASE)
+            string_passed = true
+            pattern = pattern.gsub("*", ".*")
+            Regexp.new(pattern, Regexp::IGNORECASE)
           end
         end
+      ensure
+        if string_passed
+          warn "Passing strings to blacklist/whitelist is deprecated, pass regexp at #{caller(4..4).first}"
+        end
       end
 
       def attach_page(target_id = nil)

lib/capybara/cuprite/driver.rb

@@ -3,9 +3,9 @@
 require "uri"
 require "forwardable"
 
+# rubocop:disable Metrics/ClassLength
 module Capybara
   module Cuprite
-    # rubocop:disable Metrics/ClassLength
     class Driver < Capybara::Driver::Base
       DEFAULT_MAXIMIZE_SCREEN_SIZE = [1366, 768].freeze
       EXTENSION = File.expand_path("javascripts/index.js", __dir__)
@@ -205,16 +205,7 @@ def clear_network_traffic
       end
 
       def set_proxy(host, port, user = nil, password = nil, bypass = nil)
-        browser_options = @options.fetch(:browser_options, {})
-        browser_options = browser_options.merge("proxy-server" => "#{host}:#{port}")
-        browser_options = browser_options.merge("proxy-bypass-list" => bypass) if bypass
-        @options[:browser_options] = browser_options
-
-        return unless user && password
-
-        browser.network.authorize(user: user, password: password, type: :proxy) do |request, _index, _total|
-          request.continue
-        end
+        @options.merge!(proxy: { host: host, port: port, user: user, password: password, bypass: bypass })
       end
 
       def headers
@@ -422,6 +413,6 @@ def pdf?(path, options)
           options[:format].to_s == "pdf"
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end
+# rubocop:enable Metrics/ClassLength

lib/capybara/cuprite/page.rb

@@ -17,6 +17,7 @@ def initialize(*args)
         @frame_stack = []
         @accept_modal = []
         @modal_messages = []
+        @modal_response = nil
         super
       end
 
@@ -130,35 +131,13 @@ def title
 
       private
 
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/PerceivedComplexity
-      # rubocop:disable Style/GuardClause
       def prepare_page
         super
 
-        network.intercept if !Array(@browser.url_whitelist).empty? ||
-                             !Array(@browser.url_blacklist).empty?
-
-        on(:request) do |request, index, total|
-          if @browser.url_blacklist && !@browser.url_blacklist.empty?
-            if @browser.url_blacklist.any? { |r| request.match?(r) }
-              request.abort and next
-            else
-              request.continue and next
-            end
-          elsif @browser.url_whitelist && !@browser.url_whitelist.empty?
-            if @browser.url_whitelist.any? { |r| request.match?(r) }
-              request.continue and next
-            else
-              request.abort and next
-            end
-          elsif index + 1 < total
-            # There are other callbacks that may handle this request
-            next
-          else
-            # If there are no callbacks then just continue
-            request.continue
-          end
+        if @browser.url_blacklist.any?
+          network.blacklist = @browser.url_blacklist
+        elsif @browser.url_whitelist.any?
+          network.whitelist = @browser.url_whitelist
         end
 
         on("Page.javascriptDialogOpening") do |params|
@@ -181,9 +160,6 @@ def prepare_page
           command("Page.handleJavaScriptDialog", **options)
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
-      # rubocop:enable Style/GuardClause
 
       def find_position(node, **options)
         node.find_position(**options)