puppeteer-ruby 0.0.10 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b43e26ef1313e3be7dddacb20ef524d8312f2b4149af75a48c68038d84dadadf
-  data.tar.gz: 0fb91daee496531b0be5026bbe562bcc532ad312a75874b98f3332f3a8235d19
+  metadata.gz: 9bff69308f1dc62011bd6278beb2883c5f16b42dfae0d138c8a442c0ed78cd93
+  data.tar.gz: f336776cfc903db13391c11110650d8103e0eb291fa9a9d79366c9b0f9544b9e
 SHA512:
-  metadata.gz: 243c3f594ea951b40abbe861f46a3a0b0feafb5eedb37b173eea480808f345d9e1f6c67fceb1a1aca7f967a25676c59078bf09d222f64053344891fd08f8ecb0
-  data.tar.gz: 96d8a363bc14ab00099b3f4e514d53d29c32fb1c4105966cb8059f20259773ab65ff2e600a48657442ea819f7f8bb3b379e8df3903550d010d753a156451194d
+  metadata.gz: fe90923f1c31681ec8bc0c092a9ca59976d18f682a99491de57f764f76b35ce27482f47b08348adc84f0b09e215c8cfe788730cb53d776b4922d1e397509ab23
+  data.tar.gz: ea4cb7f51c4944d082592c2a6fad51c69e8c3e6f356d6c5e6867cf9da3821249e346db7beee103e96a74f517ee929dcc1c865f79a07837a5f8c10efac357f748

data/.circleci/config.yml

@@ -18,17 +18,6 @@ jobs:
               --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
-
   deploy:
     docker:
       - image: circleci/ruby:2.6.3-stretch-node
@@ -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

@@ -2,6 +2,8 @@
 
 A Ruby port of [puppeteer](https://pptr.dev/).
 
+![logo](puppeteer-ruby.png)
+
 REMARK: This Gem is NOT production-ready!!
 
 ## Getting Started
@@ -45,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

@@ -8,8 +8,8 @@ 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'
@@ -63,17 +63,33 @@ class Puppeteer
     end
   end
 
-  # @param {string} projectRoot
-  # @param {string} preferredRevision
-  # @param {boolean} isPuppeteerCore
+  # @param project_root [String]
+  # @param prefereed_revision [String]
+  # @param is_puppeteer_core [String]
   def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
     @project_root = project_root
     @preferred_revision = preferred_revision
     @is_puppeteer_core = is_puppeteer_core
   end
 
-  # @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions & {product?: string, extraPrefsFirefox?: !object})=} options
-  # @return {!Promise<!Puppeteer.Browser>}
+  # @param product [String]
+  # @param executable_path [String]
+  # @param ignore_default_args [Array<String>|nil]
+  # @param handle_SIGINT [Boolean]
+  # @param handle_SIGTERM [Boolean]
+  # @param handle_SIGHUP [Boolean]
+  # @param timeout [Integer]
+  # @param dumpio [Boolean]
+  # @param env [Hash]
+  # @param pipe [Boolean]
+  # @param args [Array<String>]
+  # @param user_data_dir [String]
+  # @param devtools [Boolean]
+  # @param headless [Boolean]
+  # @param ignore_https_errors [Boolean]
+  # @param default_viewport [Puppeteer::Viewport|nil]
+  # @param slow_mo [Integer]
+  # @return [Puppeteer::Browser]
   def launch(
     product: nil,
     executable_path: nil,
@@ -125,8 +141,13 @@ class Puppeteer
     end
   end
 
-  # @param {!(Launcher.BrowserOptions & {browserWSEndpoint?: string, browserURL?: string, transport?: !Puppeteer.ConnectionTransport})} options
-  # @return {!Promise<!Puppeteer.Browser>}
+  # @param browser_ws_endpoint [String]
+  # @param browser_url [String]
+  # @param transport [Puppeteer::WebSocketTransport]
+  # @param ignore_https_errors [Boolean]
+  # @param default_viewport [Puppeteer::Viewport|nil]
+  # @param slow_mo [Integer]
+  # @return [Puppeteer::Browser]
   def connect(
     browser_ws_endpoint: nil,
     browser_url: nil,
@@ -151,7 +172,7 @@ class Puppeteer
     end
   end
 
-  # @return {string}
+  # @return [String]
   def executable_path
     launcher.executable_path
   end
@@ -165,12 +186,12 @@ class Puppeteer
     )
   end
 
-  # @return {string}
+  # @return [String]
   def product
     launcher.product
   end
 
-  # @return {Puppeteer::Devices}
+  # @return [Puppeteer::Devices]
   def devices
     Puppeteer::Devices
   end
@@ -180,8 +201,11 @@ class Puppeteer
   #   # ???
   # end
 
-  # @param {!Launcher.ChromeArgOptions=} options
-  # @return {!Array<string>}
+  # @param args [Array<String>]
+  # @param user_data_dir [String]
+  # @param devtools [Boolean]
+  # @param headless [Boolean]
+  # @return [Array<String>]
   def default_args(args: nil, user_data_dir: nil, devtools: nil, headless: nil)
     options = {
       args: args,

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
@@ -46,7 +46,7 @@ class Puppeteer::Browser
       @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self. context_id)
     end
     @targets = {}
-    @connection.on_event 'Events.CDPSession.Disconnected' do
+    @connection.on_event 'Events.Connection.Disconnected' do
       emit_event 'Events.Browser.Disconnected'
     end
     @connection.on_event 'Target.targetCreated', &method(:handle_target_created)
@@ -54,6 +54,22 @@ class Puppeteer::Browser
     @connection.on_event 'Target.targetInfoChanged', &method(:handle_target_info_changed)
   end
 
+  EVENT_MAPPINGS = {
+    disconnected: 'Events.Browser.Disconnected',
+    targetcreated: 'Events.Browser.TargetCreated',
+    targetchanged: 'Events.Browser.TargetChanged',
+    targetdestroyed: 'Events.Browser.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
+
   # @return [Puppeteer::BrowserRunner::BrowserProcess]
   def process
     @process
@@ -81,6 +97,12 @@ class Puppeteer::Browser
     @contexts.remove(context_id)
   end
 
+  class TargetAlreadyExistError < StandardError
+    def initialize
+      super('Target should not exist before targetCreated')
+    end
+  end
+
   # @param {!Protocol.Target.targetCreatedPayload} event
   def handle_target_created(event)
     target_info = Puppeteer::Target::TargetInfo.new(event['targetInfo'])
@@ -92,6 +114,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,
@@ -106,13 +131,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']
@@ -126,24 +146,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)
@@ -153,10 +165,6 @@ class Puppeteer::Browser
     end
   end
 
-  private def pending_target_info_changed_event
-    @pending_target_info_changed_event ||= {}
-  end
-
   # @return [String]
   def websocket_endpoint
     @connection.url
@@ -191,6 +199,11 @@ class Puppeteer::Browser
     targets.first { |target| target.type == 'browser' }
   end
 
+  # used only in Target#opener
+  private def find_target_by_id(target_id)
+    @targets[target_id]
+  end
+
   # @param {function(!Target):boolean} predicate
   # @param {{timeout?: number}=} options
   # @return {!Promise<!Target>}

data/lib/puppeteer/cdp_session.rb

@@ -1,7 +1,7 @@
 class Puppeteer::CDPSession
   include Puppeteer::DebugPrint
   include Puppeteer::EventCallbackable
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   class Error < StandardError; end
 
@@ -13,7 +13,6 @@ class Puppeteer::CDPSession
     @connection = connection
     @target_type = target_type
     @session_id = session_id
-    @pending_messages = {}
   end
 
   attr_reader :connection
@@ -35,12 +34,7 @@ class Puppeteer::CDPSession
     id = @connection.raw_send(message: { sessionId: @session_id, method: method, params: params })
     promise = resolvable_future
     callback = Puppeteer::Connection::MessageCallback.new(method: method, promise: promise)
-    if pending_message = @pending_messages.delete(id)
-      debug_puts "Pending message (id: #{id}) is handled"
-      callback_with_message(callback, pending_message)
-    else
-      @callbacks[id] = callback
-    end
+    @callbacks[id] = callback
     promise
   end
 
@@ -50,17 +44,7 @@ class Puppeteer::CDPSession
       if callback = @callbacks.delete(message['id'])
         callback_with_message(callback, message)
       else
-        debug_puts "unknown id: #{id}. Store it into pending message"
-
-        # RECV is often notified before SEND.
-        # Wait about 10 frames before throwing an error.
-        message_id = message['id']
-        @pending_messages[message_id] = message
-        Concurrent::Promises.schedule(0.16, message_id) do |id|
-          if @pending_messages.delete(id)
-            raise Error.new("unknown id: #{id}")
-          end
-        end
+        raise Error.new("unknown id: #{id}")
       end
     else
       emit_event message['method'], message['params']