puppeteer-ruby 0.31.3 → 0.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c29d76a1dd9f52a59eecdb311ab8c110a3393bc1500aea3df7d5defdc469d4f
-  data.tar.gz: 296188c1573813718e0f3d320ceff5bbd8f036f8326f04499e6d81a77ca92051
+  metadata.gz: 9f7d2798e0f07a51bd53367bcfc86ada958490b9122c44fb85c2b3732000d402
+  data.tar.gz: 7ded942ec52ace5eaed09898167e4bc46810d41b483c90331da849c4654486ee
 SHA512:
-  metadata.gz: 25411b18a7d0279ebc736981cc47db542340d49c01429b8419e95e3f3d3c66ce633de11c8b645a0eb1643dc41adedb215522d0f2a06d173cd6140aeedb44156f
-  data.tar.gz: e1cc9c01f114534c4c44df4f036a9c9743b7330c1cfee710799381d9cdafe736d2c04498c673e3d79cd64671d4f270fcd37fc7cd0cbebf07d423736a5705851f
+  metadata.gz: 974171fa712907022449619056dedf0560501b34a388db71a948b7e3bdbdd4c783201810563d0e72b121c076d613a7c380d774bf8e2fc93350a4d0c9136d9ce3
+  data.tar.gz: 360be9be4c17223a36812abdbaf1f1fe9fbd8f020d2a1aa079f4019ac4ac6be600cbeb6dd42c28764b64306f673aacd295bdcb585594511b5302ff66e954405d

data/CHANGELOG.md

@@ -1,7 +1,42 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.3...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.32.1...master)]
 
 * xxx
 
+### 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)
+
+### 0.32.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.6...0.32.0)]
+
+New features:
+
+* Tracing
+* JS/CSS coverages
+
+Improvement:
+
+* 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)
+
+### 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.
+
+### 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.
+
 ### 0.31.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.1...0.31.3)]
 
 Bugfix:

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
 - Puppeteer version: v8.0.0
-- puppeteer-ruby version: 0.31.3
+- puppeteer-ruby version: 0.32.1
 
 ## Puppeteer
 
@@ -124,7 +124,7 @@
 * target
 * title
 * ~~touchscreen~~
-* ~~tracing~~
+* tracing
 * type => `#type_text`
 * url
 * viewport
@@ -170,10 +170,10 @@
 
 * ~~tap~~
 
-## ~~Tracing~~
+## Tracing
 
-* ~~start~~
-* ~~stop~~
+* start
+* stop
 
 ## FileChooser
 
@@ -337,12 +337,12 @@
 * detach
 * send
 
-## ~~Coverage~~
+## Coverage
 
-* ~~startCSSCoverage~~
-* ~~startJSCoverage~~
-* ~~stopCSSCoverage~~
-* ~~stopJSCoverage~~
+* startCSSCoverage => `#start_css_coverage`
+* startJSCoverage => `#start_js_coverage`
+* stopCSSCoverage => `#stop_css_coverage`
+* stopJSCoverage => `#stop_js_coverage`
 
 ## TimeoutError
 

data/lib/puppeteer.rb

@@ -26,6 +26,8 @@ require 'puppeteer/browser_runner'
 require 'puppeteer/cdp_session'
 require 'puppeteer/connection'
 require 'puppeteer/console_message'
+require 'puppeteer/coverage'
+require 'puppeteer/css_coverage'
 require 'puppeteer/custom_query_handler'
 require 'puppeteer/devices'
 require 'puppeteer/dialog'
@@ -36,6 +38,7 @@ require 'puppeteer/execution_context'
 require 'puppeteer/file_chooser'
 require 'puppeteer/frame'
 require 'puppeteer/frame_manager'
+require 'puppeteer/js_coverage'
 require 'puppeteer/js_handle'
 require 'puppeteer/keyboard'
 require 'puppeteer/launcher'
@@ -43,12 +46,14 @@ require 'puppeteer/lifecycle_watcher'
 require 'puppeteer/mouse'
 require 'puppeteer/network_manager'
 require 'puppeteer/page'
+require 'puppeteer/protocol_stream_reader'
 require 'puppeteer/puppeteer'
 require 'puppeteer/query_handler_manager'
 require 'puppeteer/remote_object'
 require 'puppeteer/request'
 require 'puppeteer/response'
 require 'puppeteer/target'
+require 'puppeteer/tracing'
 require 'puppeteer/timeout_settings'
 require 'puppeteer/touch_screen'
 require 'puppeteer/version'

data/lib/puppeteer/browser.rb

@@ -45,6 +45,7 @@ class Puppeteer::Browser
       @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id)
     end
     @targets = {}
+    @wait_for_creating_targets = {}
     @connection.on_event(ConnectionEmittedEvents::Disconnected) do
       emit_event(BrowserEmittedEvents::Disconnected)
     end
@@ -125,8 +126,10 @@ class Puppeteer::Browser
       ignore_https_errors: @ignore_https_errors,
       default_viewport: @default_viewport,
     )
-    #   assert(!this._targets.has(event.targetInfo.targetId), 'Target should not exist before targetCreated');
     @targets[target_info.target_id] = target
+    if_present(@wait_for_creating_targets.delete(target_info.target_id)) do |promise|
+      promise.fulfill(target)
+    end
     if await target.initialized_promise
       emit_event(BrowserEmittedEvents::TargetCreated, target)
       context.emit_event(BrowserContextEmittedEvents::TargetCreated, target)
@@ -139,6 +142,9 @@ class Puppeteer::Browser
     target = @targets[target_id]
     target.ignore_initialize_callback_promise
     @targets.delete(target_id)
+    if_present(@wait_for_creating_targets.delete(target_id)) do |promise|
+      promise.reject('target destroyed')
+    end
     target.closed_callback
     if await target.initialized_promise
       emit_event(BrowserEmittedEvents::TargetDestroyed, target)
@@ -184,6 +190,16 @@ class Puppeteer::Browser
     result = @connection.send_message('Target.createTarget', **create_target_params)
     target_id = result['targetId']
     target = @targets[target_id]
+    unless target
+      # Target.targetCreated is often notified before the response of Target.createdTarget.
+      # https://github.com/YusukeIwaki/puppeteer-ruby/issues/91
+      # D, [2021-04-07T03:00:10.125241 #187] DEBUG -- : SEND >> {"method":"Target.createTarget","params":{"url":"about:blank","browserContextId":"56A86FC3391B50180CF9A6450A0D8C21"},"id":3}
+      # D, [2021-04-07T03:00:10.142396 #187] DEBUG -- : RECV << {"id"=>3, "result"=>{"targetId"=>"A518447C415A1A3E1A8979454A155632"}}
+      # D, [2021-04-07T03:00:10.145360 #187] DEBUG -- : RECV << {"method"=>"Target.targetCreated", "params"=>{"targetInfo"=>{"targetId"=>"A518447C415A1A3E1A8979454A155632", "type"=>"page", "title"=>"", "url"=>"", "attached"=>false, "canAccessOpener"=>false, "browserContextId"=>"56A86FC3391B50180CF9A6450A0D8C21"}}}
+      # This is just a workaround logic...
+      @wait_for_creating_targets[target_id] = resolvable_future
+      target = await @wait_for_creating_targets[target_id]
+    end
     await target.initialized_promise
     await target.page
   end

data/lib/puppeteer/connection.rb

@@ -46,7 +46,11 @@ class Puppeteer::Connection
     @transport.on_message do |data|
       message = JSON.parse(data)
       sleep_before_handling_message(message)
-      async_handle_message(message)
+      if should_handle_synchronously?(message)
+        handle_message(message)
+      else
+        async_handle_message(message)
+      end
     end
     @transport.on_close do |reason, code|
       handle_close
@@ -71,6 +75,40 @@ class Puppeteer::Connection
     sleep 0.004
   end
 
+  private def should_handle_synchronously?(message)
+    return true if message['id']
+
+    case message['method']
+    when nil
+      false
+    when /^Network\./
+      # Puppeteer doesn't handle any Network monitoring responses.
+      # So we don't care their handling order.
+      false
+    when /^Page\.frame/
+      # Page.frameAttached
+      # Page.frameNavigated
+      # Page.frameDetached
+      # Page.frameStoppedLoading
+      true
+    when 'Page.lifecycleEvent'
+      true
+    when /^Runtime\.executionContext/
+      # - Runtime.executionContextCreated
+      # - Runtime.executionContextDestroyed
+      # - Runtime.executionContextsCleared
+      # These events should be strictly ordered.
+      true
+    when 'Target.attachedToTarget', 'Target.detachedFromTarget'
+      true
+    when 'Target.targetCreated'
+      # type=page must be handled asynchronously for avoiding wait timeout...
+      message.dig('params', 'targetInfo', 'type') == 'browser'
+    else
+      false
+    end
+  end
+
   def self.from_session(session)
     session.connection
   end
@@ -273,16 +311,6 @@ class Puppeteer::Connection
   def create_session(target_info)
     result = send_message('Target.attachToTarget', targetId: target_info.target_id, flatten: true)
     session_id = result['sessionId']
-
-    # Target.attachedToTarget is often notified after the result of Target.attachToTarget.
-    # D, [2020-04-04T23:04:30.736311 #91875] DEBUG -- : RECV << {"id"=>2, "result"=>{"sessionId"=>"DA002F8A95B04710502CB40D8430B95A"}}
-    # D, [2020-04-04T23:04:30.736649 #91875] DEBUG -- : RECV << {"method"=>"Target.attachedToTarget", "params"=>{"sessionId"=>"DA002F8A95B04710502CB40D8430B95A", "targetInfo"=>{"targetId"=>"EBAB949A7DE63F12CB94268AD3A9976B", "type"=>"page", "title"=>"about:blank", "url"=>"about:blank", "attached"=>true, "browserContextId"=>"46D23767E9B79DD9E589101121F6DADD"}, "waitingForDebugger"=>false}}
-    # So we have to wait for "Target.attachedToTarget" a bit.
-    20.times do
-      if @sessions[session_id]
-        return @sessions[session_id]
-      end
-      sleep 0.1
-    end
+    @sessions[session_id]
   end
 end

data/lib/puppeteer/coverage.rb

@@ -0,0 +1,106 @@
+class Puppeteer::Coverage
+  # @param client [Puppeteer::CDPSession]
+  def initialize(client)
+    @js = Puppeteer::JSCoverage.new(client)
+    @css = Puppeteer::CSSCoverage.new(client)
+  end
+
+  def start_js_coverage(reset_on_navigation: nil, report_anonymous_scripts: nil)
+    @js.start(
+      reset_on_navigation: reset_on_navigation,
+      report_anonymous_scripts: report_anonymous_scripts,
+    )
+  end
+
+  def stop_js_coverage
+    @js.stop
+  end
+
+  def js_coverage(reset_on_navigation: nil, report_anonymous_scripts: nil, &block)
+    unless block
+      raise ArgumentError.new('Block must be given')
+    end
+
+    start_js_coverage(
+      reset_on_navigation: reset_on_navigation,
+      report_anonymous_scripts: report_anonymous_scripts,
+    )
+    block.call
+    stop_js_coverage
+  end
+
+  def start_css_coverage(reset_on_navigation: nil)
+    @css.start(reset_on_navigation: reset_on_navigation)
+  end
+
+  def stop_css_coverage
+    @css.stop
+  end
+
+  def css_coverage(reset_on_navigation: nil, &block)
+    unless block
+      raise ArgumentError.new('Block must be given')
+    end
+
+    start_css_coverage(reset_on_navigation: reset_on_navigation)
+    block.call
+    stop_css_coverage
+  end
+
+  module UtilFunctions
+    private def convert_to_disjoint_ranges(nested_ranges)
+      points = []
+      nested_ranges.each do |range|
+        points << { offset: range['startOffset'], type: 0, range: range }
+        points << { offset: range['endOffset'], type: 1, range: range }
+      end
+
+      # Sort points to form a valid parenthesis sequence.
+      points.sort! do |a, b|
+        if a[:offset] != b[:offset]
+          # Sort with increasing offsets.
+          a[:offset] <=> b[:offset]
+        elsif a[:type] != b[:type]
+          # All "end" points should go before "start" points.
+          b[:type] <=> a[:type]
+        else
+          alength = a[:range]['endOffset'] - a[:range]['startOffset']
+          blength = b[:range]['endOffset'] - b[:range]['startOffset']
+          if a[:type] == 0
+            # For two "start" points, the one with longer range goes first.
+            blength <=> alength
+          else
+            # For two "end" points, the one with shorter range goes first.
+            alength <=> blength
+          end
+        end
+      end
+
+      hit_count_stack = []
+      results = []
+      last_offset = 0
+      # Run scanning line to intersect all ranges.
+      points.each do |point|
+        if !hit_count_stack.empty? && last_offset < point[:offset] && hit_count_stack.last > 0
+          last_result = results.last
+          if last_result && last_result[:end] == last_offset
+            last_result[:end] = point[:offset]
+          else
+            results << { start: last_offset, end: point[:offset] }
+          end
+        end
+        last_offset = point[:offset]
+        if point[:type] == 0
+          hit_count_stack << point[:range]['count']
+        else
+          hit_count_stack.pop
+        end
+      end
+
+      # Filter out empty ranges.
+      results.select do |range|
+        range[:end] - range[:start] > 1
+      end
+    end
+  end
+end

data/lib/puppeteer/css_coverage.rb

@@ -0,0 +1,110 @@
+require_relative './coverage'
+
+class Puppeteer::CSSCoverage
+  include Puppeteer::Coverage::UtilFunctions
+
+  class Item
+    def initialize(url:, ranges:, text:)
+      @url = url
+      @ranges = ranges
+      @text = text
+    end
+    attr_reader :url, :ranges, :text
+  end
+
+  # @param client [Puppeteer::CDPSession]
+  def initialize(client)
+    @client = client
+    @enabled = false
+    @stylesheet_urls = {}
+    @stylesheet_sources = {}
+  end
+
+  def start(reset_on_navigation: nil)
+    raise 'CSSCoverage is already enabled' if @enabled
+
+    @reset_on_navigation =
+      if [true, false].include?(reset_on_navigation)
+        reset_on_navigation
+      else
+        true
+      end
+
+    @enabled = true
+    @stylesheet_urls.clear
+    @stylesheet_sources.clear
+    @event_listeners = []
+    @event_listeners << @client.add_event_listener('CSS.styleSheetAdded') do |event|
+      future { on_stylesheet(event) }
+    end
+    @event_listeners << @client.add_event_listener('Runtime.executionContextsCleared') do
+      on_execution_contexts_cleared
+    end
+    await_all(
+      @client.async_send_message('DOM.enable'),
+      @client.async_send_message('CSS.enable'),
+      @client.async_send_message('CSS.startRuleUsageTracking'),
+    )
+  end
+
+  private def on_execution_contexts_cleared
+    return unless @reset_on_navigation
+    @stylesheet_urls.clear
+    @stylesheet_sources.clear
+  end
+
+  private def on_stylesheet(event)
+    header = event['header']
+    source_url =
+      if header['sourceURL'] == ""
+        nil
+      else
+        header['sourceURL']
+      end
+
+    # Ignore anonymous scripts
+    return if !source_url
+
+    response = @client.send_message('CSS.getStyleSheetText', styleSheetId: header['styleSheetId'])
+    @stylesheet_urls[header['styleSheetId']] = source_url
+    @stylesheet_sources[header['styleSheetId']] = response['text']
+  end
+
+
+  def stop
+    raise 'CSSCoverage is not enabled' unless @enabled
+    @enabled = false
+
+    rule_tracking_response = @client.send_message('CSS.stopRuleUsageTracking')
+    await_all(
+      @client.async_send_message('CSS.disable'),
+      @client.async_send_message('DOM.disable'),
+    )
+    @client.remove_event_listener(*@event_listeners)
+
+    # aggregate by styleSheetId
+    stylesheet_id_to_coverage = {}
+    rule_tracking_response['ruleUsage'].each do |entry|
+      ranges = stylesheet_id_to_coverage[entry['styleSheetId']]
+      unless ranges
+        ranges = []
+        stylesheet_id_to_coverage[entry['styleSheetId']] = ranges
+      end
+
+      ranges << {
+        'startOffset' => entry['startOffset'],
+        'endOffset' => entry['endOffset'],
+        'count' => entry['used'] ? 1 : 0,
+      }
+    end
+
+    coverage = []
+    @stylesheet_urls.each do |stylesheet_id, url|
+      text = @stylesheet_sources[stylesheet_id]
+      ranges = convert_to_disjoint_ranges(stylesheet_id_to_coverage[stylesheet_id] || [])
+      coverage << Item.new(url: url, ranges: ranges, text: text)
+    end
+
+    coverage
+  end
+end

data/lib/puppeteer/element_handle.rb

@@ -183,7 +183,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
 
     if error_path = file_paths.find { |file_path| !File.exist?(file_path) }
-      raise ArgmentError.new("#{error_path} does not exist or is not readable")
+      raise ArgumentError.new("#{error_path} does not exist or is not readable")
     end
 
     backend_node_id = @remote_object.node_info(@client)["node"]["backendNodeId"]
@@ -201,9 +201,9 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
         element.dispatchEvent(new Event('change', { bubbles: true }));
       }
       JAVASCRIPT
-      await this.evaluate(fn)
+      await evaluate(fn)
     else
-      @remote_object.set_file_input_files(@client, file_paths, backend_node_id)
+      @remote_object.set_file_input_files(@client, file_paths.map { |path| File.expand_path(path) }, backend_node_id)
     end
   end
 

data/lib/puppeteer/js_coverage.rb

@@ -0,0 +1,119 @@
+require_relative './coverage'
+
+class Puppeteer::JSCoverage
+  include Puppeteer::Coverage::UtilFunctions
+
+  class Item
+    def initialize(url:, ranges:, text:)
+      @url = url
+      @ranges = ranges
+      @text = text
+    end
+    attr_reader :url, :ranges, :text
+  end
+
+  # @param client [Puppeteer::CDPSession]
+  def initialize(client)
+    @client = client
+    @enabled = false
+    @script_urls = {}
+    @script_sources = {}
+  end
+
+  def start(reset_on_navigation: nil, report_anonymous_scripts: nil)
+    raise 'JSCoverage is already enabled' if @enabled
+
+    @reset_on_navigation =
+      if [true, false].include?(reset_on_navigation)
+        reset_on_navigation
+      else
+        true
+      end
+    @report_anonymous_scripts = report_anonymous_scripts || false
+    @enabled = true
+    @script_urls.clear
+    @script_sources.clear
+    @event_listeners = []
+    @event_listeners << @client.add_event_listener('Debugger.scriptParsed') do |event|
+      future { on_script_parsed(event) }
+    end
+    @event_listeners << @client.add_event_listener('Runtime.executionContextsCleared') do
+      on_execution_contexts_cleared
+    end
+    await_all(
+      @client.async_send_message('Profiler.enable'),
+      @client.async_send_message('Profiler.startPreciseCoverage',
+        callCount: false,
+        detailed: true,
+      ),
+      @client.async_send_message('Debugger.enable'),
+      @client.async_send_message('Debugger.setSkipAllPauses', skip: true),
+    )
+  end
+
+  private def on_execution_contexts_cleared
+    return unless @reset_on_navigation
+    @script_urls.clear
+    @script_sources.clear
+  end
+
+  private def on_script_parsed(event)
+    url =
+      if event['url'] == ""
+        nil
+      else
+        event['url']
+      end
+
+    # Ignore puppeteer-injected scripts
+    return if url == Puppeteer::ExecutionContext::EVALUATION_SCRIPT_URL
+
+    # Ignore other anonymous scripts unless the reportAnonymousScripts option is true.
+    return if !url && !@report_anonymous_scripts
+
+    response = @client.send_message('Debugger.getScriptSource', scriptId: event['scriptId'])
+    @script_urls[event['scriptId']] = url
+    @script_sources[event['scriptId']] = response['scriptSource']
+  end
+
+  def stop
+    raise 'JSCoverage is not enabled' unless @enabled
+    @enabled = false
+
+    results = await_all(
+      @client.async_send_message('Profiler.takePreciseCoverage'),
+      @client.async_send_message('Profiler.stopPreciseCoverage'),
+      @client.async_send_message('Profiler.disable'),
+      @client.async_send_message('Debugger.disable'),
+    )
+    @client.remove_event_listener(*@event_listeners)
+
+    coverage = []
+    profile_response = results.first
+    profile_response['result'].each do |entry|
+      url = @script_urls[entry['scriptId']]
+
+      if @report_anonymous_scripts
+        url ||= "debugger://VM#{entry['scriptId']}"
+      end
+
+      text = @script_sources[entry['scriptId']]
+      next if !text || !url
+
+      flatten_ranges = []
+      entry['functions'].each do |func|
+        func['ranges'].each do |range|
+          flatten_ranges << range
+        end
+      end
+
+      coverage << Item.new(
+        url: url,
+        ranges: convert_to_disjoint_ranges(flatten_ranges),
+        text: text,
+      )
+    end
+
+    coverage
+  end
+end

data/lib/puppeteer/page.rb

@@ -39,9 +39,9 @@ class Puppeteer::Page
     # @accessibility = Accessibility.new(client)
     @frame_manager = Puppeteer::FrameManager.new(client, self, ignore_https_errors, @timeout_settings)
     @emulation_manager = Puppeteer::EmulationManager.new(client)
-    # @tracing = Tracing.new(client)
+    @tracing = Puppeteer::Tracing.new(client)
     @page_bindings = {}
-    # @coverage = Coverage.new(client)
+    @coverage = Puppeteer::Coverage.new(client)
     @javascript_enabled = true
     @screenshot_task_queue = ScreenshotTaskQueue.new
 
@@ -245,7 +245,7 @@ class Puppeteer::Page
     @frame_manager.main_frame
   end
 
-  attr_reader :touch_screen, :coverage, :accessibility
+  attr_reader :touch_screen, :coverage, :tracing, :accessibility
 
   def keyboard(&block)
     @keyboard.instance_eval(&block) unless block.nil?
@@ -587,6 +587,16 @@ class Puppeteer::Page
     emit_event(PageEmittedEvents::Dialog, dialog)
   end
 
+  private def set_transparent_background_color(&block)
+    @client.send_message(
+      'Emulation.setDefaultBackgroundColorOverride',
+      color: { r: 0, g: 0, b: 0, a: 0 })
+  end
+
+  private def reset_default_background_color(&block)
+    @client.send_message('Emulation.setDefaultBackgroundColorOverride')
+  end
+
   # @return [String]
   def url
     main_frame.url
@@ -949,18 +959,14 @@ class Puppeteer::Page
     end
 
     should_set_default_background = screenshot_options.omit_background? && format == 'png'
-    if should_set_default_background
-      @client.send_message('Emulation.setDefaultBackgroundColorOverride', color: { r: 0, g: 0, b: 0, a: 0 })
-    end
+    set_transparent_background_color if should_set_default_background
     screenshot_params = {
       format: format,
       quality: screenshot_options.quality,
       clip: clip,
     }.compact
     result = @client.send_message('Page.captureScreenshot', screenshot_params)
-    if should_set_default_background
-      @client.send_message('Emulation.setDefaultBackgroundColorOverride')
-    end
+    reset_default_background_color if should_set_default_background
 
     if screenshot_options.full_page? && @viewport
       self.viewport = @viewport
@@ -980,35 +986,6 @@ class Puppeteer::Page
     buffer
   end
 
-  class ProtocolStreamReader
-    def initialize(client:, handle:, path:)
-      @client = client
-      @handle = handle
-      @path = path
-    end
-
-    def read
-      out = StringIO.new
-      File.open(@path, 'wb') do |file|
-        eof = false
-        until eof
-          response = @client.send_message('IO.read', handle: @handle)
-          eof = response['eof']
-          data =
-            if response['base64Encoded']
-              Base64.decode64(response['data'])
-            else
-              response['data']
-            end
-          out.write(data)
-          file.write(data)
-        end
-      end
-      @client.send_message('IO.close', handle: @handle)
-      out.read
-    end
-  end
-
   class PrintToPdfIsNotImplementedError < StandardError
     def initialize
       super('pdf() is only available in headless mode. See https://github.com/puppeteer/puppeteer/issues/1829')
@@ -1018,8 +995,11 @@ class Puppeteer::Page
   # @return [String]
   def pdf(options = {})
     pdf_options = PDFOptions.new(options)
+    omit_background = options[:omit_background]
+    set_transparent_background_color if omit_background
     result = @client.send_message('Page.printToPDF', pdf_options.page_print_args)
-    ProtocolStreamReader.new(client: @client, handle: result['stream'], path: pdf_options.path).read
+    reset_default_background_color if omit_background
+    Puppeteer::ProtocolStreamReader.new(client: @client, handle: result['stream'], path: pdf_options.path).read
   rescue => err
     if err.message.include?('PrintToPDF is not implemented')
       raise PrintToPdfIsNotImplementedError.new

data/lib/puppeteer/page/pdf_options.rb

@@ -52,24 +52,24 @@ class Puppeteer::Page
     end
 
     PAPER_FORMATS = {
-      letter: PaperSize.new(width: 8.5, height: 11),
-      legal: PaperSize.new(width: 8.5, height: 14),
-      tabloid: PaperSize.new(width: 11, height: 17),
-      ledger: PaperSize.new(width: 17, height: 11),
-      a0: PaperSize.new(width: 33.1, height: 46.8),
-      a1: PaperSize.new(width: 23.4, height: 33.1),
-      a2: PaperSize.new(width: 16.54, height: 23.4),
-      a3: PaperSize.new(width: 11.7, height: 16.54),
-      a4: PaperSize.new(width: 8.27, height: 11.7),
-      a5: PaperSize.new(width: 5.83, height: 8.27),
-      a6: PaperSize.new(width: 4.13, height: 5.83),
+      'letter' => PaperSize.new(width: 8.5, height: 11),
+      'legal' => PaperSize.new(width: 8.5, height: 14),
+      'tabloid' => PaperSize.new(width: 11, height: 17),
+      'ledger' => PaperSize.new(width: 17, height: 11),
+      'a0' => PaperSize.new(width: 33.1, height: 46.8),
+      'a1' => PaperSize.new(width: 23.4, height: 33.1),
+      'a2' => PaperSize.new(width: 16.54, height: 23.4),
+      'a3' => PaperSize.new(width: 11.7, height: 16.54),
+      'a4' => PaperSize.new(width: 8.27, height: 11.7),
+      'a5' => PaperSize.new(width: 5.83, height: 8.27),
+      'a6' => PaperSize.new(width: 4.13, height: 5.83),
     }
 
     UNIT_TO_PIXELS = {
-      px: 1,
-      in: 96,
-      cm: 37.8,
-      mm: 3.78,
+      'px' => 1,
+      'in' => 96,
+      'cm' => 37.8,
+      'mm' => 3.78,
     }
 
     # @param parameter [String|Integer|nil]

data/lib/puppeteer/protocol_stream_reader.rb

@@ -0,0 +1,45 @@
+class Puppeteer::ProtocolStreamReader
+  def initialize(client:, handle:, path:)
+    @client = client
+    @handle = handle
+    @path = path
+  end
+
+  def read
+    StringIO.open do |out|
+      if @path
+        File.open(@path, 'wb') do |file|
+          io_read do |data|
+            out.write(data)
+            file.write(data)
+          end
+        end
+      else
+        io_read { |data| out.write(data) }
+      end
+      io_close
+
+      out.string
+    end
+  end
+
+  private def io_read(&block)
+    eof = false
+    until eof
+      response = @client.send_message('IO.read', handle: @handle)
+      eof = response['eof']
+      data =
+        if response['base64Encoded']
+          Base64.decode64(response['data'])
+        else
+          response['data']
+        end
+      block.call(data)
+    end
+  end
+
+
+  private def io_close
+    @client.send_message('IO.close', handle: @handle)
+  end
+end

data/lib/puppeteer/tracing.rb

@@ -0,0 +1,50 @@
+class Puppeteer::Tracing
+  # @param client [Puppeteer::CDPSession]
+  def initialize(client)
+    @client = client
+    @recording = false
+  end
+
+  DEFAULT_CATEGORIES = [
+    '-*',
+    'devtools.timeline',
+    'v8.execute',
+    'disabled-by-default-devtools.timeline',
+    'disabled-by-default-devtools.timeline.frame',
+    'toplevel',
+    'blink.console',
+    'blink.user_timing',
+    'latencyInfo',
+    'disabled-by-default-devtools.timeline.stack',
+    'disabled-by-default-v8.cpu_profiler',
+    'disabled-by-default-v8.cpu_profiler.hires',
+  ].freeze
+
+  def start(path: nil, screenshots: nil, categories: nil)
+    option_categories = categories || DEFAULT_CATEGORIES.dup
+
+    if screenshots
+      option_categories << 'disabled-by-default-devtools.screenshot'
+    end
+
+    @path = path
+    @recording = true
+    @client.send_message('Tracing.start',
+      transferMode: 'ReturnAsStream',
+      categories: option_categories.join(','),
+    )
+  end
+
+  def stop
+    stream_promise = resolvable_future do |f|
+      @client.once('Tracing.tracingComplete') do |event|
+        f.fulfill(event['stream'])
+      end
+    end
+    @client.send_message('Tracing.end')
+    @recording = false
+
+    stream = await stream_promise
+    Puppeteer::ProtocolStreamReader.new(client: @client, handle: stream, path: @path).read
+  end
+end

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.31.3'
+  VERSION = '0.32.1'
 end

data/lib/puppeteer/web_socket.rb

@@ -1,3 +1,4 @@
+require 'openssl'
 require 'socket'
 require 'websocket/driver'
 
@@ -5,11 +6,28 @@ require 'websocket/driver'
 # ref: https://github.com/cavalle/chrome_remote/blob/master/lib/chrome_remote/web_socket_client.rb
 class Puppeteer::WebSocket
   class DriverImpl # providing #url, #write(string)
+    class SecureSocketFactory
+      def initialize(host, port)
+        @host = host
+        @port = port || 443
+      end
+
+      def create
+        tcp_socket = TCPSocket.new(@host, @port)
+        OpenSSL::SSL::SSLSocket.new(tcp_socket).tap(&:connect)
+      end
+    end
+
     def initialize(url)
       @url = url
 
       endpoint = URI.parse(url)
-      @socket = TCPSocket.new(endpoint.host, endpoint.port)
+      @socket =
+        if endpoint.scheme == 'wss'
+          SecureSocketFactory.new(endpoint.host, endpoint.port).create
+        else
+          TCPSocket.new(endpoint.host, endpoint.port)
+        end
     end
 
     attr_reader :url

data/puppeteer-ruby.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rollbar'
   spec.add_development_dependency 'rspec', '~> 3.10.0 '
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
   spec.add_development_dependency 'rubocop', '~> 1.12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.31.3
+  version: 0.32.1
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -232,6 +246,7 @@ files:
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -248,6 +263,8 @@ files:
 - lib/puppeteer/concurrent_ruby_utils.rb
 - lib/puppeteer/connection.rb
 - lib/puppeteer/console_message.rb
+- lib/puppeteer/coverage.rb
+- lib/puppeteer/css_coverage.rb
 - lib/puppeteer/custom_query_handler.rb
 - lib/puppeteer/debug_print.rb
 - lib/puppeteer/define_async_method.rb
@@ -271,6 +288,7 @@ files:
 - lib/puppeteer/frame_manager.rb
 - lib/puppeteer/geolocation.rb
 - lib/puppeteer/if_present.rb
+- lib/puppeteer/js_coverage.rb
 - lib/puppeteer/js_handle.rb
 - lib/puppeteer/keyboard.rb
 - lib/puppeteer/keyboard/key_description.rb
@@ -289,6 +307,7 @@ files:
 - lib/puppeteer/page/pdf_options.rb
 - lib/puppeteer/page/screenshot_options.rb
 - lib/puppeteer/page/screenshot_task_queue.rb
+- lib/puppeteer/protocol_stream_reader.rb
 - lib/puppeteer/puppeteer.rb
 - lib/puppeteer/query_handler_manager.rb
 - lib/puppeteer/remote_object.rb
@@ -297,6 +316,7 @@ files:
 - lib/puppeteer/target.rb
 - lib/puppeteer/timeout_settings.rb
 - lib/puppeteer/touch_screen.rb
+- lib/puppeteer/tracing.rb
 - lib/puppeteer/version.rb
 - lib/puppeteer/viewport.rb
 - lib/puppeteer/wait_task.rb