chore: debug was moved to ferrum, inspector is retired

Author: route

CHANGELOG.md

@@ -3,8 +3,10 @@
 ### Added
 
 ### Changed
+- `:inspector` option is retired
 
 ### Fixed
+- Correctly open devtools page when calling `debug` [#296, #297]
 
 ### Removed
 
@@ -14,11 +16,9 @@
 ### Added
 
 ### Changed
-
 - `wait_for_network_idle` doesn't raise error, instead simply returns `nil`
 
 ### Fixed
-
 - Assigning broken unicode to a node directly from JS can lead to `JSON::ParserError: incomplete surrogate pair at ...` error
 
 ### Removed
@@ -27,7 +27,6 @@
 ## [0.15.1](https://github.com/rubycdp/ferrum/compare/v0.15...0.15.1) - (Jun 15, 2024) ##
 
 ### Added
-
 - Support for `Driver#send_keys`, the `:focused` filter, and `Driver#active_element` [#261]
 
 ### Changed

README.md

@@ -67,18 +67,8 @@ end
 
 ## Debugging
 
-If you pass `inspector` option, remote debugging will be enabled if you run
-tests with `INSPECTOR=true`. Then you can put `page.driver.debug` or
-`page.driver.debug(binding)` in your test to pause it. This will launch the
-browser where you can inspect the content.
-
-```ruby
-Capybara.register_driver :cuprite do |app|
-  Capybara::Cuprite::Driver.new(app, inspector: ENV['INSPECTOR'])
-end
-```
-
-then somewhere in the test:
+You can put `page.driver.debug` or `page.driver.debug(binding)` in your test to pause it.
+This will launch the browser where you can inspect the content.
 
 ```ruby
 it "does something useful" do

cuprite.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.7.0"
 
   s.add_dependency "capybara", "~> 3.0"
-  s.add_dependency "ferrum",   "~> 0.16.0"
+  s.add_dependency "ferrum",   "~> 0.17.0"
 end

lib/capybara/cuprite/driver.rb

@@ -274,32 +274,8 @@ def basic_authorize(user, password)
       end
       alias authorize basic_authorize
 
-      def debug_url
-        response = JSON.parse(Net::HTTP.get(URI(build_remote_debug_url(path: "/json"))))
-
-        devtools_frontend_path = response[0]&.[]("devtoolsFrontendUrl")
-        raise "Could not generate debug url for remote debugging session" unless devtools_frontend_path
-
-        build_remote_debug_url(path: devtools_frontend_path)
-      end
-
-      def debug(binding = nil)
-        if @options[:inspector]
-          Process.spawn(browser.process.path, debug_url)
-
-          if binding.respond_to?(:pry)
-            Pry.start(binding)
-          elsif binding.respond_to?(:irb)
-            binding.irb
-          else
-            pause
-          end
-        else
-          raise Error, "To use the remote debugging, you have to launch " \
-                       "the driver with `inspector: ENV['INSPECTOR']` " \
-                       "configuration option and run your test suite passing " \
-                       "env variable"
-        end
+      def debug(...)
+        browser.debug(...)
       end
 
       def pause
@@ -378,14 +354,6 @@ def dismiss_modal(type, options = {})
 
       private
 
-      def build_remote_debug_url(path:)
-        uri = URI.parse(path)
-        uri.scheme ||= "http"
-        uri.host ||= browser.process.host
-        uri.port ||= browser.process.port
-        uri.to_s
-      end
-
       def default_domain
         if @started
           URI.parse(browser.current_url).host

spec/features/driver_spec.rb

@@ -1605,15 +1605,6 @@ def create_screenshot(file, *args)
 
         expect(@session).to have_content("test_cookie")
       end
-
-      it "has a working debug_url" do
-        session = Capybara::Session.new(:cuprite_with_inspector, TestApp)
-        session.visit "/cuprite/arbitrary_path/200"
-
-        expect do
-          URI.parse(session.driver.debug_url)
-        end.not_to raise_error
-      end
     end
   end
 end

spec/lib/driver_spec.rb

@@ -29,32 +29,6 @@
     end
   end
 
-  describe "debug_url" do
-    it "parses the devtools frontend url correctly when devtoolsFrontendUrl is relative" do
-      driver = described_class.new(nil, { port: 12_345 })
-      driver.browser # initialize browser before stubbing Net::HTTP as it also calls it
-      uri = instance_double(URI)
-
-      allow(driver).to receive(:URI).with("http://127.0.0.1:12345/json").and_return(uri)
-      allow(Net::HTTP).to receive(:get).with(uri).and_return(%([{"devtoolsFrontendUrl":"/works"}]))
-
-      expect(driver.debug_url).to eq("http://127.0.0.1:12345/works")
-    end
-
-    it "parses the devtools frontend url correctly when devtoolsFrontendUrl is fully qualified" do
-      driver = described_class.new(nil, { port: 12_346 })
-      driver.browser # initialize browser before stubbing Net::HTTP as it also calls it
-      uri = instance_double(URI)
-
-      allow(driver).to receive(:URI).with("http://127.0.0.1:12346/json").and_return(uri)
-      allow(Net::HTTP).to receive(:get).with(uri).and_return(
-        %([{"devtoolsFrontendUrl":"https://chrome-devtools-frontend.appspot.com/serve_rev?ws=123"}])
-      )
-
-      expect(driver.debug_url).to eq("https://chrome-devtools-frontend.appspot.com/serve_rev?ws=123")
-    end
-  end
-
   private
 
   def with_capybara_save_path(path)

spec/spec_helper.rb

@@ -24,16 +24,11 @@
 
 Capybara.register_driver(:cuprite) do |app|
   options = {}
-  options.merge!(inspector: true) if ENV["INSPECTOR"]
   options.merge!(logger: StringIO.new) if ENV["CI"]
   options.merge!(headless: false) if ENV["HEADLESS"] == "false"
   Capybara::Cuprite::Driver.new(app, options)
 end
 
-Capybara.register_driver(:cuprite_with_inspector) do |app|
-  Capybara::Cuprite::Driver.new(app, { inspector: true })
-end
-
 module TestSessions
   Cuprite = Capybara::Session.new(:cuprite, TestApp)
 end