puppeteer-ruby 0.0.12 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b420fde6222d1e26a5e8dc72b893a85e460b6db90483fcff3f97b7705b72a099
-  data.tar.gz: 54dc20b27ccc4898e3e7281d224080d4eec966a41eeefa058b1243e32d3b639b
+  metadata.gz: 2277fda99720c2566927af9a2acfc56da2b8e87ee10521871c368fd4a05649b2
+  data.tar.gz: 59636e168935b0fb6c964cd62355ae3becf8199ed2ee1af58cb512ccacc9d7cb
 SHA512:
-  metadata.gz: 65c9af35923c198fc9e17e5097f2258518f150f77056490065f820ba26703c2b239c86f8f0997d8f7ba51b8fb51f56e6f781a4ab0633b034ac04c462fe935f3c
-  data.tar.gz: 52fa2316e02d9f28791f1750d3ddd7f0d3ae434d2890c409fef2b3135394f54fec40c9570d440a9608fb8ffcbd41a200d55a0b56c348141887d158fe5efd6bef
+  metadata.gz: b45495a2ae160e740e242bc04bb81bfa493c1101583393f78e8e7ff3d065c00594fe0196b8225ac73e281a17428127597d11c8f8323ba6b58d64b437e2979d97
+  data.tar.gz: 72c9bd1ca17f37927ceb51a79904583c638066e29cdb08cc2534e77bcc7b3ee348e53e69546ecd579917bd6d8db9c4413d4a63cf617ffa33b8c69c756603439e

data/.circleci/config.yml

@@ -13,21 +13,10 @@ jobs:
       - run:
           name: rspec
           command: |
-            bundle exec rspec --profile 10 \
+            DEBUG=1 bundle exec rspec --profile 10 \
               --format RspecJunitFormatter \
               --out test_results/rspec.xml \
-              --format progress
-
-  rubocop:
-    docker:
-      - image: circleci/ruby:2.6.3-stretch-node
-    executor: ruby/default
-    steps:
-      - checkout
-      - ruby/bundle-install
-      - run:
-          name: rubocop
-          command: bundle exec rubocop
+              --format documentation
 
   deploy:
     docker:
@@ -60,7 +49,6 @@ workflows:
   ci:
     jobs:
       - rspec
-      - rubocop
   rubygems-deploy:
     jobs:
       - deploy:

data/.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: update docs
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update-docs:
+    name: update docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install dependencies
+        run: |
+          gem uninstall bundler
+          gem install bundler -v 1.17
+          bundle install
+
+      - name: Deploy Configuration
+        run: |
+          mkdir ~/.ssh
+          ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
+          echo "${{ secrets.DOCS_DEPLOY_SSH_RSA }}" | base64 -d > ~/.ssh/id_rsa
+          chmod 400 ~/.ssh/id_rsa
+
+      - name: Build and Push
+        run: |
+          git clone git@github.com:YusukeIwaki/puppeteer-ruby-docs.git docs
+          rm -rf docs/*
+          bundle exec yardoc -o docs
+          cp puppeteer-ruby.png docs/
+          cd docs/
+          git add -A
+          git config user.name github
+          git config user.email github@example.com
+          git commit -m ${{ github.sha }}
+          git push origin master

data/.github/workflows/reviewdog.yml

@@ -0,0 +1,15 @@
+name: reviewdog
+on: [pull_request]
+jobs:
+  rubocop:
+    name: runner / rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: rubocop
+        uses: reviewdog/action-rubocop@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          reporter: github-pr-review
+          rubocop_version: 0.86.0

data/README.md

@@ -47,9 +47,60 @@ end
 
 More usage examples can be found [here](https://github.com/YusukeIwaki/puppeteer-ruby-example)
 
+## Collaboration with Selenium or Capybara
+
+It is really remarkable that we can use puppeteer functions in existing Selenium or Capybara codes, with a few configuration in advance.
+
+```ruby
+require 'spec_helper'
+
+RSpec.describe 'hotel.testplanisphere.dev', type: :feature do
+  before {
+    visit 'https://hotel.testplanisphere.dev/'
+
+    # acquire Puppeteer::Browser instance, by connecting Chrome with DevTools Protocol.
+    @browser = Puppeteer.connect(
+                 browser_url: 'http://localhost:9222',
+                 default_viewport: Puppeteer::Viewport.new(width: 1280, height: 800))
+  }
+
+  after {
+    # release Puppeteer::Browser reesource.
+    @browser.disconnect
+  }
+
+  it 'can be handled with puppeteer and assert with Capybara' do
+    # automation with puppeteer
+    puppeteer_page = @browser.pages.first
+    puppeteer_page.wait_for_selector('li.nav-item')
+
+    reservation_link = puppeteer_page.SS('li.nav-item')[1]
+
+    await_all(
+      puppeteer_page.async_wait_for_navigation,
+      reservation_link.async_click,
+    )
+
+    # expectation with Capybara DSL
+    expect(page).to have_text('宿泊プラン一覧')
+  end
+
+  it 'can be handled with Capybara and assert with puppeteer' do
+    # automation with Capybara
+    page.all('li.nav-item')[1].click
+
+    # expectation with puppeteer
+    puppeteer_page = @browser.pages.first
+    body_text = puppeteer_page.Seval('body', '(el) => el.textContent')
+    expect(body_text).to include('宿泊プラン一覧')
+  end
+```
+
+The detailed step of configuration can be found [here](https://github.com/YusukeIwaki/puppeteer-ruby-example/tree/master/_with_capybara-rspec).
+
 ## API
 
-https://yusukeiwaki.github.io/puppeteer-ruby/
+https://yusukeiwaki.github.io/puppeteer-ruby-docs/
 
 ## Contributing
 

data/lib/puppeteer.rb

@@ -2,14 +2,16 @@ require 'concurrent'
 
 class Puppeteer; end
 
+require 'puppeteer/env'
+
 # Custom data types.
 require 'puppeteer/device'
 require 'puppeteer/errors'
 require 'puppeteer/viewport'
 
 # Modules
-require 'puppeteer/async_await_behavior'
 require 'puppeteer/concurrent_ruby_utils'
+require 'puppeteer/define_async_method'
 require 'puppeteer/debug_print'
 require 'puppeteer/event_callbackable'
 require 'puppeteer/if_present'
@@ -36,6 +38,8 @@ require 'puppeteer/mouse'
 require 'puppeteer/network_manager'
 require 'puppeteer/page'
 require 'puppeteer/remote_object'
+require 'puppeteer/request'
+require 'puppeteer/response'
 require 'puppeteer/target'
 require 'puppeteer/timeout_settings'
 require 'puppeteer/touch_screen'
@@ -166,7 +170,11 @@ class Puppeteer
     }.compact
     browser = launcher.connect(options)
     if block_given?
-      yield(browser)
+      begin
+        yield(browser)
+      ensure
+        browser.disconnect
+      end
     else
       browser
     end

data/lib/puppeteer/browser.rb

@@ -5,7 +5,7 @@ class Puppeteer::Browser
   include Puppeteer::DebugPrint
   include Puppeteer::EventCallbackable
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.Connection} connection
   # @param {!Array<string>} contextIds
@@ -43,7 +43,7 @@ class Puppeteer::Browser
     @default_context = Puppeteer::BrowserContext.new(@connection, self, nil)
     @contexts = {}
     context_ids.each do |context_id|
-      @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self. context_id)
+      @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id)
     end
     @targets = {}
     @connection.on_event 'Events.Connection.Disconnected' do
@@ -70,6 +70,15 @@ class Puppeteer::Browser
     add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
   end
 
+  # @param event_name [Symbol]
+  def once(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
   # @return [Puppeteer::BrowserRunner::BrowserProcess]
   def process
     @process
@@ -94,7 +103,13 @@ class Puppeteer::Browser
   # @param context_id [String]
   def dispose_context(context_id)
     @connection.send_message('Target.disposeBrowserContext', browserContextId: context_id)
-    @contexts.remove(context_id)
+    @contexts.delete(context_id)
+  end
+
+  class TargetAlreadyExistError < StandardError
+    def initialize
+      super('Target should not exist before targetCreated')
+    end
   end
 
   # @param {!Protocol.Target.targetCreatedPayload} event
@@ -108,6 +123,9 @@ class Puppeteer::Browser
         @default_context
       end
 
+    if @targets[target_info.target_id]
+      raise TargetAlreadyExistError.new
+    end
     target = Puppeteer::Target.new(
       target_info: target_info,
       browser_context: context,
@@ -122,13 +140,8 @@ class Puppeteer::Browser
       emit_event 'Events.Browser.TargetCreated', target
       context.emit_event 'Events.BrowserContext.TargetCreated', target
     end
-
-    if_present(pending_target_info_changed_event.delete(target_info.target_id)) do |pending_event|
-      handle_target_info_changed(pending_event)
-    end
   end
 
-
   # @param {{targetId: string}} event
   def handle_target_destroyed(event)
     target_id = event['targetId']
@@ -142,24 +155,16 @@ class Puppeteer::Browser
     end
   end
 
+  class TargetNotExistError < StandardError
+    def initialize
+      super('target should exist before targetInfoChanged')
+    end
+  end
+
   # @param {!Protocol.Target.targetInfoChangedPayload} event
   def handle_target_info_changed(event)
     target_info = Puppeteer::Target::TargetInfo.new(event['targetInfo'])
-    target = @targets[target_info.target_id]
-    if !target
-      # targetCreated is sometimes notified after targetInfoChanged.
-      # We don't raise error. Instead, keep the event as a pending change,
-      # and handle it on handle_target_created.
-      #
-      # D, [2020-04-22T00:22:26.630328 #79646] DEBUG -- : RECV << {"method"=>"Target.targetInfoChanged", "params"=>{"targetInfo"=>{"targetId"=>"8068CED48357B9557EEC85AA62165A8E", "type"=>"iframe", "title"=>"", "url"=>"", "attached"=>true, "browserContextId"=>"7895BFB24BF22CE40584808713D96E8D"}}}
-      # E, [2020-04-22T00:22:26.630448 #79646] ERROR -- : target should exist before targetInfoChanged (StandardError)
-      # D, [2020-04-22T00:22:26.630648 #79646] DEBUG -- : RECV << {"method"=>"Target.targetCreated", "params"=>{"targetInfo"=>{"targetId"=>"8068CED48357B9557EEC85AA62165A8E", "type"=>"iframe", "title"=>"", "url"=>"", "attached"=>false, "browserContextId"=>"7895BFB24BF22CE40584808713D96E8D"}}}
-      pending_target_info_changed_event[target_info.target_id] = event
-      return
-      # original implementation is:
-      #
-      # raise StandardError.new('target should exist before targetInfoChanged')
-    end
+    target = @targets[target_info.target_id] or raise TargetNotExistError.new
     previous_url = target.url
     was_initialized = target.initialized?
     target.handle_target_info_changed(target_info)
@@ -169,12 +174,8 @@ class Puppeteer::Browser
     end
   end
 
-  private def pending_target_info_changed_event
-    @pending_target_info_changed_event ||= {}
-  end
-
   # @return [String]
-  def websocket_endpoint
+  def ws_endpoint
     @connection.url
   end
 
@@ -204,7 +205,7 @@ class Puppeteer::Browser
 
   # @return {!Target}
   def target
-    targets.first { |target| target.type == 'browser' }
+    targets.find { |target| target.type == 'browser' }
   end
 
   # used only in Target#opener
@@ -212,12 +213,11 @@ class Puppeteer::Browser
     @targets[target_id]
   end
 
-  # @param {function(!Target):boolean} predicate
-  # @param {{timeout?: number}=} options
-  # @return {!Promise<!Target>}
+  # @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
-    existing_target = targets.first { |target| predicate.call(target) }
+    existing_target = targets.find { |target| predicate.call(target) }
     return existing_target if existing_target
 
     event_listening_ids = []
@@ -241,11 +241,18 @@ class Puppeteer::Browser
       else
         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
   end
 
+  # @!method async_wait_for_target(predicate:, timeout: nil)
+  #
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  define_async_method :async_wait_for_target
+
   # @return {!Promise<!Array<!Puppeteer.Page>>}
   def pages
     browser_contexts.flat_map(&:pages)
@@ -274,7 +281,19 @@ class Puppeteer::Browser
     !@connection.closed?
   end
 
+  class Version
+    def initialize(hash)
+      @protocol_version = hash['protocolVersion']
+      @product = hash['product']
+      @revision = hash['revision']
+      @user_agent = hash['userAgent']
+      @js_version = hash['jsVersion']
+    end
+
+    attr_reader :protocol_version, :product, :revision, :user_agent, :js_version
+  end
+
   private def get_version
-    @connection.send_message('Browser.getVersion')
+    Version.new(@connection.send_message('Browser.getVersion'))
   end
 end

data/lib/puppeteer/browser_context.rb

@@ -1,5 +1,6 @@
 class Puppeteer::BrowserContext
   include Puppeteer::EventCallbackable
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.Connection} connection
   # @param {!Browser} browser
@@ -10,14 +11,38 @@ class Puppeteer::BrowserContext
     @id = context_id
   end
 
+  EVENT_MAPPINGS = {
+    disconnected: 'Events.BrowserContext.Disconnected',
+    targetcreated: 'Events.BrowserContext.TargetCreated',
+    targetchanged: 'Events.BrowserContext.TargetChanged',
+    targetdestroyed: 'Events.BrowserContext.TargetDestroyed',
+  }
+
+  # @param event_name [Symbol] either of :disconnected, :targetcreated, :targetchanged, :targetdestroyed
+  def on(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
+  # @param event_name [Symbol]
+  def once(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
   # @return {!Array<!Target>} target
   def targets
     @browser.targets.select { |target| target.browser_context == self }
   end
 
-  # @param {function(!Target):boolean} predicate
-  # @param {{timeout?: number}=} options
-  # @return {!Promise<!Target>}
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  # @return [Puppeteer::Target]
   def wait_for_target(predicate:, timeout: nil)
     @browser.wait_for_target(
       predicate: ->(target) { target.browser_context == self && predicate.call(target) },
@@ -25,13 +50,18 @@ class Puppeteer::BrowserContext
     )
   end
 
+  # @!method async_wait_for_target(predicate:, timeout: nil)
+  #
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  define_async_method :async_wait_for_target
+
   # @return {!Promise<!Array<!Puppeteer.Page>>}
   def pages
     targets.select { |target| target.type == 'page' }.map(&:page).reject { |page| !page }
   end
 
   def incognito?
-    !@id
+    !!@id
   end
 
   # /**
@@ -82,7 +112,7 @@ class Puppeteer::BrowserContext
   end
 
   def close
-    if !@id
+    unless @id
       raise 'Non-incognito profiles cannot be closed!'
     end
     @browser.dispose_context(@id)