puppeteer-ruby 0.36.0 → 0.37.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4af926ca9ad39046dcc4ce9507622bf72c3263b747516ee1ba642c02e8e38d
-  data.tar.gz: 3eff89952883a47270dee6a9ee7281609dbbe7bac197eada9e6b6dcabbaa1f78
+  metadata.gz: 84ede7b4fc083303903e960a08d2a21b44866b2b47662489005e09e6e955df01
+  data.tar.gz: aba2c71b916d6779560a200fff6685cb9f4ba83dc2b04e092926fb121add3155
 SHA512:
-  metadata.gz: d83085eb31bb6d0d9f125e4c82fe172f46676bc373bd7652b2be430984570f7facff20bd3b1da20dbcb41beca52a740064b9b6d5cb6f51a69bf8f4f97e699947
-  data.tar.gz: 141bed0475d5e40a0ddb9ec0cb2a82f44313a14e835a7d5cc271a413dad0c9881658a81f0ec0567d7896a7658539fc131bb5069c1c07c6573f6b633c99a53f8e
+  metadata.gz: 3b6a5cc66476c8954ab1ae942df3be6ad161ffe3aeb9b1ea51bde681f6cd9cf32d61d251980ab5d7f0907923b5ac42871cd7e99fbb55f0c00205ee231190f595
+  data.tar.gz: 7329fc6a4f8d1933efee34180c6d051e73613da2189b2af5226629d681c9f4b52abadf5eb548f45cb3af37d3ab1f093067b5e67e10e8c3cde09815a4fa3a0e4c

data/CHANGELOG.md

@@ -1,51 +1,75 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.36.0...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.3...master)]
 
-* xxx
+- xxx
+
+### 0.37.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.2...0.37.3)]
+
+Improvement:
+
+- Improve the logic of detection of Chrome/Firefox executable path on Linux.
+
+### 0.37.2 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.1...0.37.2)]
+
+Bugfix:
+
+- `timeout: 0` did set the timeout value to zero. Now it disables the timeout as expected.
+
+### 0.37.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.0...0.37.1)]
+
+Bugfix:
+
+- Fix handle_SIGINT, handle_SIGTERM, handle_SIGHUP options to work with `false` value specified.
+
+### 0.37.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.36.0...0.37.0)]
+
+New features:
+
+- Some features introduced in Puppeteer 10.4
 
 ### 0.36.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.35.1...0.36.0)]
 
 New features:
 
-* Drag and Drop feature introduced in Puppeteer 10.1
-* `Page#emulateNetworkConditions`, `Page#emulateCPUThrottling`
-* `Page#exposeFunction`
-* Metrics
+- Drag and Drop feature introduced in Puppeteer 10.1
+- `Page#emulateNetworkConditions`, `Page#emulateCPUThrottling`
+- `Page#exposeFunction`
+- Metrics
 
 ### 0.35.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.35.0...0.35.1)]
 
 New features:
 
-* Allow Rails users to use this library without `require 'puppeteer'`.
+- Allow Rails users to use this library without `require 'puppeteer'`.
 
 ### 0.35.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.3...0.35.0)]
 
 New features:
 
-* Add `channel` parameter for Puppeteer.launch. Now `channel: chrome` or `channel: chrome-canary` (chrome-beta, chrome-dev is also available) automatically detects the executablePath of Google Chrome. Windows/macOS users can also use `channel: msedge`.
+- Add `channel` parameter for Puppeteer.launch. Now `channel: chrome` or `channel: chrome-canary` (chrome-beta, chrome-dev is also available) automatically detects the executablePath of Google Chrome. Windows/macOS users can also use `channel: msedge`.
 
 ### 0.34.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.2...0.34.3)]
 
 Bugfix:
 
-* Fix wait_for_xxx's timeout error type.
+- Fix wait_for_xxx's timeout error type.
 
 ### 0.34.2 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.1...0.34.2)]
 
 New features:
 
-* Add `Page#bring_to_front`.
+- Add `Page#bring_to_front`.
 
 ### 0.34.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.0...0.34.1)]
 
 Bugfix:
 
-* Fix `Page#pdf` to work without `path` parameter.
+- Fix `Page#pdf` to work without `path` parameter.
 
 ### 0.34.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.33.0...0.34.0)]
 
 New features:
 
-* Sync API with block
+- Sync API with block
 
 ### 0.33.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.32.4...0.33.0)]
 
@@ -53,170 +77,169 @@ NOTE: Requires Ruby version >= 2.6 explicitly since this version.
 
 Bugfix:
 
-* Fix PDF options to work correctly on decimal numbers specified.
+- Fix PDF options to work correctly on decimal numbers specified.
 
 ### 0.32.4 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.32.3...0.32.4)]
 
 Bugfix:
 
-* Fix `#type_text` to input '<' correctly.
+- Fix `#type_text` to input '<' correctly.
 
 ### 0.32.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.32.2...0.32.3)]
 
 Bugfix:
 
-* Fix puppeteer-ruby to work on Rails in development mode.
-
+- Fix puppeteer-ruby to work on Rails in development mode.
 
 ### 0.32.2 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.32.1...0.32.2)]
 
 Bugfix:
 
-* Fix full_page option in screenshot.
+- Fix full_page option in screenshot.
 
 ### 0.32.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.32.0...0.32.1)]
 
 Bugfix:
 
-* Fix WebSocket to work with `wss://...` endpoint (ex. browserless.io)
+- Fix WebSocket to work with `wss://...` endpoint (ex. browserless.io)
 
 ### 0.32.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.6...0.32.0)]
 
 New features:
 
-* Tracing
-* JS/CSS coverages
+- Tracing
+- JS/CSS coverages
 
 Improvement:
 
-* Increase stability [#92](https://github.com/YusukeIwaki/puppeteer-ruby/pull/92)
+- Increase stability [#92](https://github.com/YusukeIwaki/puppeteer-ruby/pull/92)
 
 ### 0.31.6 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.5...0.31.6)]
 
 Improvement:
 
-* Increase stability [#87](https://github.com/YusukeIwaki/puppeteer-ruby/pull/87)
+- Increase stability [#87](https://github.com/YusukeIwaki/puppeteer-ruby/pull/87)
 
 ### 0.31.5 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.4...0.31.5)]
 
 Bugfix:
 
-* Fix file uploading to work without crash.
+- Fix file uploading to work without crash.
 
 ### 0.31.4 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.3...0.31.4)]
 
 Bugfix:
 
-* Fix PDF options (format, margin, omit_background) to work.
+- Fix PDF options (format, margin, omit_background) to work.
 
 ### 0.31.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.1...0.31.3)]
 
 Bugfix:
 
-* Fix `wait_for_selector` to work. *It is strongly recommended to update for 0.29.0-0.31.x users.*
+- Fix `wait_for_selector` to work. _It is strongly recommended to update for 0.29.0-0.31.x users._
 
 ### 0.31.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.0...0.31.1)]
 
 Bugfix:
 
-* Fix `Page#pdf` to work on Windows.
+- Fix `Page#pdf` to work on Windows.
 
 ### 0.31.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.30.0...0.31.0)]
 
 New features:
 
-* Now puppeteer-ruby is compatible with Windows
+- Now puppeteer-ruby is compatible with Windows
 
 Bugfix:
 
-* Fix `Page#add_script_tag` and `Page#add_style_tag` to work
+- Fix `Page#add_script_tag` and `Page#add_style_tag` to work
 
 ### 0.30.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.29.0...0.30.0)]
 
 New features:
 
-* S, SS, Seval, SSeval is renamed to query_selector, query_selector_all, eval_on_selector, eval_on_selector_all
+- S, SS, Seval, SSeval is renamed to query_selector, query_selector_all, eval_on_selector, eval_on_selector_all
 
 ### 0.29.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.28.1...0.29.0)]
 
 New features:
 
-* Add `AriaQueryHandler`. Now we can use "aria/...." for selectors.
+- Add `AriaQueryHandler`. Now we can use "aria/...." for selectors.
 
 ### 0.28.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.27...0.28.1)]
 
 New features:
 
-* Add `Page#emulate_idle_state`
-* Change versioning rule.
+- Add `Page#emulate_idle_state`
+- Change versioning rule.
 
 ### 0.0.27 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.26...0.0.27)]
 
 New features:
 
-* Now puppeteer-ruby is Ruby 3.0 compatible!
+- Now puppeteer-ruby is Ruby 3.0 compatible!
 
 ### 0.0.26 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.25...0.0.26)]
 
 Bugfix:
 
-* Fix `Page#screenshot` working correctly with `quality` parameter.
+- Fix `Page#screenshot` working correctly with `quality` parameter.
 
 ### 0.0.25 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.23...0.0.25)]
 
 New feature:
 
-* **Cookie** feature: `Page#set_cookie`, `Page#cookies`
+- **Cookie** feature: `Page#set_cookie`, `Page#cookies`
 
 ### 0.0.23 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.22...0.0.23)]
 
 New feature:
 
-* **GeoLocation** feature
-* grant/clear permission
+- **GeoLocation** feature
+- grant/clear permission
 
 Bugfix/Improvement:
 
-* Refactoring for events ([#31](https://github.com/YusukeIwaki/puppeteer-ruby/pull/31))
-* Improve SEND/RECV handling in CDPSession ([#34](https://github.com/YusukeIwaki/puppeteer-ruby/pull/34))
+- Refactoring for events ([#31](https://github.com/YusukeIwaki/puppeteer-ruby/pull/31))
+- Improve SEND/RECV handling in CDPSession ([#34](https://github.com/YusukeIwaki/puppeteer-ruby/pull/34))
 
 ### 0.0.22 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.21...0.0.22)]
 
 Bugfix
 
-* Make `Puppeteer#default_args` to work
-* Respect Firefox launch options
-* Respect `default_viewport: nil`
+- Make `Puppeteer#default_args` to work
+- Respect Firefox launch options
+- Respect `default_viewport: nil`
 
 ### 0.0.21 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.20...0.0.21)]
 
 Bugfix/Improvement:
 
-* Update DeviceDescriptors (list of emulatable devices)
-* Fix bug on inputing "(" ([#25](https://github.com/YusukeIwaki/puppeteer-ruby/pull/25))
+- Update DeviceDescriptors (list of emulatable devices)
+- Fix bug on inputing "(" ([#25](https://github.com/YusukeIwaki/puppeteer-ruby/pull/25))
 
 ### 0.0.20 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.19...0.0.20)]
 
 New feature
 
-* Dialog-handling feature
+- Dialog-handling feature
 
 ### 0.0.19 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.18...0.0.19)]
 
 New feature
 
-* **Firefox support**
+- **Firefox support**
 
 Bugfix/Improvement
 
-* Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))
+- Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))
 
 ### 0.0.18 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.17...0.0.18)]
 
 New feature
 
-* **Firefox support**
+- **Firefox support**
 
 Bugfix/Improvement
 
-* Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))
+- Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))

data/README.md

@@ -41,7 +41,7 @@ NOTE: `require 'puppeteer-ruby'` is not necessary in Rails.
 ```ruby
 require 'puppeteer-ruby'
 
-Puppeteer.launch(headless: false, slow_mo: 50, args: ['--guest', '--window-size=1280,800']) do |browser|
+Puppeteer.launch(headless: false, slow_mo: 50, args: ['--window-size=1280,800']) do |browser|
   page = browser.new_page
   page.viewport = Puppeteer::Viewport.new(width: 1280, height: 800)
   page.goto("https://github.com/", wait_until: 'domcontentloaded')
@@ -156,6 +156,75 @@ RSpec.describe 'hotel.testplanisphere.dev', type: :feature do
 
 The detailed step of configuration can be found [here](https://github.com/YusukeIwaki/puppeteer-ruby-example/tree/master/_with_capybara-rspec).
 
+## :bulb: Use Puppeteer methods simply without Capybara::DSL
+
+We can also use puppeteer-ruby as it is without Capybara DSL. When you want to just test a Rails application simply with Puppeteer, refer this section.
+
+Also, if you have trouble with handling flaky/unstable testcases in existing feature/system specs, consider replacing Capybara::DSL with raw puppeteer-ruby codes like `page.wait_for_selector(...)` or `page.wait_for_navigation { ... }`.
+
+Capybara prepares test server even when Capybara DSL is not used.
+
+Sample configuration is shown below. You can use it by putting the file at `spec/support/puppeteer_ruby.rb` or another location where RSpec loads on initialization.
+
+```ruby
+RSpec.configure do |config|
+  require 'capybara'
+
+  # This driver only requests Capybara to launch test server.
+  # Remark that no Capybara::DSL is available with this driver.
+  class CapybaraNullDriver < Capybara::Driver::Base
+    def needs_server?
+      true
+    end
+  end
+
+  Capybara.register_driver(:null) { CapybaraNullDriver.new }
+
+  config.around(driver: :null) do |example|
+    Capybara.current_driver = :null
+
+    # Rails server is launched here,
+    # (at the first time of accessing Capybara.current_session.server)
+    @base_url = Capybara.current_session.server.base_url
+
+    require 'puppeteer'
+    launch_options = {
+      # Use launch options as you like.
+      channel: :chrome,
+      headless: false,
+    }
+    Puppeteer.launch(**launch_options) do |browser|
+      @puppeteer_page = browser.new_page
+      example.run
+    end
+
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
+  end
+end
+```
+
+Now, we can work with integration test using `Puppeteer::Page` in puppeteer-ruby.
+
+```ruby
+RSpec.describe 'Sample integration tests', driver: :null do
+  let(:page) { @puppeteer_page }
+  let(:base_url) { @base_url }
+
+  it 'should work with Puppeteer' do
+    # null driver only launches server, and Capybara::DSL is unavailable.
+    expect { visit '/' }.to raise_error(/NotImplementedError/)
+
+    page.goto("#{base_url}/")
+
+    # Automation with Puppeteer
+    h1_text = page.eval_on_selector('h1', '(el) => el.textContent')
+    expect(h1_text).to eq('It works!')
+  end
+end
+```
+
+
 ## API
 
 https://yusukeiwaki.github.io/puppeteer-ruby-docs/

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
-- Puppeteer version: v10.2.0
-- puppeteer-ruby version: 0.36.0
+- Puppeteer version: v12.0.0
+- puppeteer-ruby version: 0.37.3
 
 ## Puppeteer
 
@@ -134,8 +134,10 @@
 * viewport
 * ~~waitFor~~
 * waitForFileChooser => `#wait_for_file_chooser`
+* ~~waitForFrame~~
 * waitForFunction => `#wait_for_function`
 * waitForNavigation => `#wait_for_navigation`
+* ~~waitForNetworkIdle~~
 * waitForRequest => `#wait_for_request`
 * waitForResponse => `#wait_for_response`
 * waitForSelector => `#wait_for_selector`
@@ -225,6 +227,7 @@
 * goto
 * hover
 * isDetached => `#detached?`
+* ~~isOOPFrame~~
 * name
 * parentFrame => `#parent_frame`
 * select
@@ -294,43 +297,44 @@
 * type => `#type_text`
 * uploadFile => `#upload_file`
 
-## ~~HTTPRequest~~
-
-* ~~abort~~
-* ~~abortErrorReason~~
-* ~~continue~~
-* ~~continueRequestOverrides~~
-* ~~enqueueInterceptAction~~
-* ~~failure~~
-* ~~finalizeInterceptions~~
-* ~~frame~~
-* ~~headers~~
-* ~~isNavigationRequest~~
-* ~~method~~
-* ~~postData~~
-* ~~redirectChain~~
-* ~~resourceType~~
-* ~~respond~~
-* ~~response~~
-* ~~responseForRequest~~
-* ~~url~~
+## HTTPRequest
+
+* abort
+* abortErrorReason => `#abort_error_reason`
+* continue
+* continueRequestOverrides => `#continue_request_overrides`
+* enqueueInterceptAction => `#enqueue_intercept_action`
+* failure
+* finalizeInterceptions => `#finalize_interceptions`
+* frame
+* headers
+* ~~initiator~~
+* isNavigationRequest => `#navigation_request?`
+* method
+* postData => `#post_data`
+* redirectChain => `#redirect_chain`
+* resourceType => `#resource_type`
+* respond
+* response
+* responseForRequest => `#response_for_request`
+* url
 
-## ~~HTTPResponse~~
+## HTTPResponse
 
-* ~~buffer~~
-* ~~frame~~
+* buffer
+* frame
 * ~~fromCache~~
 * ~~fromServiceWorker~~
-* ~~headers~~
-* ~~json~~
+* headers
+* json
 * ~~ok~~
-* ~~remoteAddress~~
-* ~~request~~
-* ~~securityDetails~~
-* ~~status~~
-* ~~statusText~~
-* ~~text~~
-* ~~url~~
+* remoteAddress => `#remote_address`
+* request
+* securityDetails => `#security_details`
+* status
+* statusText => `#status_text`
+* text
+* url
 
 ## ~~SecurityDetails~~
 
@@ -356,6 +360,7 @@
 
 * connection
 * detach
+* ~~id~~
 * send
 
 ## Coverage

data/lib/puppeteer/browser.rb

@@ -223,7 +223,7 @@ class Puppeteer::Browser
   # @param predicate [Proc(Puppeteer::Target -> Boolean)]
   # @return [Puppeteer::Target]
   def wait_for_target(predicate:, timeout: nil)
-    timeout_in_sec = (timeout || 30000).to_i / 1000.0
+    timeout_helper = Puppeteer::TimeoutHelper.new('target', timeout_ms: timeout, default_timeout_ms: 30000)
     existing_target = targets.find { |target| predicate.call(target) }
     return existing_target if existing_target
 
@@ -241,15 +241,9 @@ class Puppeteer::Browser
     end
 
     begin
-      if timeout_in_sec > 0
-        Timeout.timeout(timeout_in_sec) do
-          target_promise.value!
-        end
-      else
+      timeout_helper.with_timeout do
         target_promise.value!
       end
-    rescue Timeout::Error
-      raise Puppeteer::TimeoutError.new("waiting for target failed: timeout #{timeout}ms exceeded")
     ensure
       remove_event_listener(*event_listening_ids)
     end

data/lib/puppeteer/browser_context.rb

@@ -74,6 +74,7 @@ class Puppeteer::BrowserContext
     'clipboard-read' => 'clipboardReadWrite',
     'clipboard-write' => 'clipboardReadWrite',
     'payment-handler' => 'paymentHandler',
+    'persistent-storage' => 'durableStorage',
     'idle-detection' => 'idleDetection',
     # chrome-specific permissions we have.
     'midi-sysex' => 'midiSysex',

data/lib/puppeteer/browser_runner.rb

@@ -94,7 +94,7 @@ class Puppeteer::BrowserRunner
         FileUtils.rm_rf(@temp_directory)
       end
     }
-    trap(:EXIT) do
+    at_exit do
       kill
     end
 

data/lib/puppeteer/coverage.rb

@@ -5,10 +5,14 @@ class Puppeteer::Coverage
     @css = Puppeteer::CSSCoverage.new(client)
   end
 
-  def start_js_coverage(reset_on_navigation: nil, report_anonymous_scripts: nil)
+  def start_js_coverage(
+        reset_on_navigation: nil,
+        report_anonymous_scripts: nil,
+        include_raw_script_coverage: nil)
     @js.start(
       reset_on_navigation: reset_on_navigation,
       report_anonymous_scripts: report_anonymous_scripts,
+      include_raw_script_coverage: include_raw_script_coverage,
     )
   end
 
@@ -16,7 +20,11 @@ class Puppeteer::Coverage
     @js.stop
   end
 
-  def js_coverage(reset_on_navigation: nil, report_anonymous_scripts: nil, &block)
+  def js_coverage(
+        reset_on_navigation: nil,
+        report_anonymous_scripts: nil,
+        include_raw_script_coverage: nil,
+        &block)
     unless block
       raise ArgumentError.new('Block must be given')
     end
@@ -24,6 +32,7 @@ class Puppeteer::Coverage
     start_js_coverage(
       reset_on_navigation: reset_on_navigation,
       report_anonymous_scripts: report_anonymous_scripts,
+      include_raw_script_coverage: include_raw_script_coverage,
     )
     block.call
     stop_js_coverage