capybara-chrome_dev_tools 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0d10204e92fbd7b34ca84ec1a36c9bd2c258b5d
-  data.tar.gz: a3a5f57d5f82d507d7c8d11ae1830ade58aec9ef
+  metadata.gz: b2a0b532302f3f1b2e4c6c654893ef551c801d45
+  data.tar.gz: d3dbd664cef2aaf7970ac0c10a31dc4bdec1d147
 SHA512:
-  metadata.gz: 05dbdb5a1312649714ac33c3f4ad8581cfa13ab564380113ac57abaed6aecac9ae8af44784d68a1591dffbe5f8fce9e268f26651558dd97187769c4579769bae
-  data.tar.gz: 90ef9227ab6c4a5e8f77feb5f967d7109b82ea0f0147d6a1b67c870c36420ff3b8ac0f5f7041e3b56e3073cea85cfb4f07c34d70713123d3709da6962e8a73fb
+  metadata.gz: a7886d9a272805a7c06a700deaa5db7fe05f591f81adb94af2205f8ed197fee9f8c9c49f8e5f1bcb91b04a237a32b90484e572a9b21717d4fb9afb3ec2254039
+  data.tar.gz: 55c00a25215425d2bcbc483f5b015c0a4768739d82cc9b49f06f1261b7d97ce6fc5281d8d113014eed12ebf97f6e3a0d07f2b88ffb022c827c8d0bf98103a2b9

data/Readme.md

@@ -3,9 +3,24 @@
 Integrates [chrome_remote](https://github.com/cavalle/chrome_remote) (a Chrome DevTools Protocol
 client) with Capybara, letting you access Chrome DevTools via `driver.dev_tools`.
 
+## What it does for you
+
+- Finds a free port and sets Chrome's --remote-debugging-port to this known port
+- Starts [`crmux`](https://github.com/sidorares/crmux) so that you can make additional connections
+  to the Chrome DevTools/debugging port even while `chromedriver` continues to connect to the
+  `--remote-debugging-port` (Chrome normally only allows one debugging session to be connected to a
+  tab)
+- Lets you inspect the browser window your tests are running in — even if they are running in a
+  headless Chrome browser!
+- Exposes a `dev_tools` method that provides access to a `ChromeRemote` instance (see
+  [capybara-chrome_response_headers](https://github.com/TylerRick/capybara-chrome_response_headers),
+  for one possible use for that)
+
+Inspired by: https://stackoverflow.com/a/50876153/47185
+
 ## Installation
 
-Install crmux by running, for example:
+Install [`crmux`](https://github.com/sidorares/crmux) by running, for example:
 ```
 npm install crmux -g
 ```
@@ -27,6 +42,33 @@ gem 'capybara-chrome_dev_tools'
 
 ## Usage
 
+Enable this extension like so:
+```
+Capybara::ChromeDevTools.enabled = true
+```
+
+... before you do any action with Capybara that triggers it to use the Chrome driver/browser.
+
+### Accessing DevTools from another Chrome window
+
+Add some code to your test to make it _pause_ at the point where you want to inspect the state of
+the browser window. Otherwise, when the test finishes, it will close the window that you are
+inspecting and disconnect the DevTools frontend that you were using to view it.
+
+Look for the output which teels you which port it's listening to:
+
+```
+Started crmux [pid 56630], listening at http://localhost:35720, connected to localhost:35719
+```
+
+Now you can go to http://localhost:35720, choose which window to inspect, and inspect the Chrome
+window that your tests are running in — all from this other Chrome browser instance!
+
+You can also get the listen port from `driver.crmux_listen_port` if you want to
+automate things.
+
+### Accessing DevTools from Ruby
+
 Access a ChromeRemote instance with `dev_tools`.
 
 See [chrome_remote](https://github.com/cavalle/chrome_remote) for API documentation.
@@ -36,6 +78,16 @@ Example:
 dev_tools.send_cmd "Page.enable"
 ```
 
+## Status
+
+This project should be considered a proof of concept.
+
+It generally works, but isn't exceptionally resilient or stable.
+
+Sometimes you may get intermittent errors from `chrome_remote` or the WebSocket connection. There
+should probably be some handling of these errors (or better yet, figure out what's causing the
+errors).
+
 ## See also
 
 To get access to HTTP response status code, response headers, etc. from your tests, check out https://github.com/TylerRick/capybara-chrome_response_headers, which uses this gem.

data/lib/capybara/chrome_dev_tools.rb

@@ -5,9 +5,13 @@ module Capybara::ChromeDevTools
   autoload :DSL,              'capybara/chrome_dev_tools/dsl'
 
   class << self
+    attr_accessor :enabled
     attr_accessor :preferred_port
+    attr_accessor :verbose
   end
+  self.enabled = false
   self.preferred_port = 9222
+  self.verbose = 1
 end
 
 Capybara::Selenium::Driver.class_eval do

data/lib/capybara/chrome_dev_tools/driver_extensions.rb

@@ -6,9 +6,9 @@ module Capybara::ChromeDevTools
     attr_accessor :crmux_listen_port
 
     def initialize(app, opts)
-      puts "#{self.class}#initialize"
+      #puts "#{self.class}#initialize"
 
-      if opts[:browser] == :chrome
+      if opts[:browser] == :chrome and Capybara::ChromeDevTools.enabled
         start_crmux!(opts)
       end
 
@@ -43,7 +43,7 @@ module Capybara::ChromeDevTools
       command = "npx crmux #{'-d' if @debug_crmux} \
                    --port=#{chrome_debugging_port} \
                    --listen=#{crmux_listen_port}"
-      #puts %(command: #{command})
+      puts %(command: #{command}) if Capybara::ChromeDevTools.verbose >= 3
       if @debug_crmux
         spawn_opts = {[:out, :err] => 'log/crmux.log'}
       else
@@ -55,20 +55,20 @@ module Capybara::ChromeDevTools
       sleep 0.1
 
       at_exit do
-        puts "Killing crmux process #{@crmux_pid}..."
+        puts "Killing crmux process #{@crmux_pid}..." if Capybara::ChromeDevTools.verbose >= 1
         Process.kill 'TERM', @crmux_pid
       end
     end
 
     def browser
       super.tap do |browser|
-        dev_tools
+        dev_tools if Capybara::ChromeDevTools.enabled
       end
     end
 
     def dev_tools
       @dev_tools ||= (
-        #puts "Connecting to #{crmux_listen_port}..."
+        puts "Connecting to #{crmux_listen_port}..." if Capybara::ChromeDevTools.verbose >= 2
         ChromeRemote.client host: 'localhost', port: crmux_listen_port
       )
     end

data/lib/capybara/chrome_dev_tools/version.rb

@@ -1,7 +1,7 @@
 module Capybara
   module ChromeDevTools
     def self.version
-      "0.1.0"
+      "0.2.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-chrome_dev_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Rick