puppeteer-ruby 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c440ee3ee2c46ab3b4639855bb08497063338c8cc4458fa4e1d4eeba8fd7c65
-  data.tar.gz: 0d380b3fc666f05402676ba85f278f42cce9b271bd713cffd938d0fefd39be71
+  metadata.gz: 0a500508a5a1d88ed4694c5614c7c70bdae06d4d5cb10f81c1237ebd25a6623f
+  data.tar.gz: 338b902e3c64d9f96e7b7822353a7b664ab112cd3993e7a7ec06cda41752521e
 SHA512:
-  metadata.gz: a6018e2425cc73f5d3a850169041906d9f6eb50f0398690df3f4bef871960834c4aaf07ae14f439e854f7069e33691575e29c1153b379ed22dbab6120c34731c
-  data.tar.gz: 6ba30ed2dddb60113bb6e8f1341b7e326901a4c4ebcf8c61734a93c114dcd667954ce442bcbc4d44d5f951537ff65458ac34dcedf23747182b45a86920f67245
+  metadata.gz: 51ea52a62c04917d5ec62c4224ffe91cacf3ccd3cfc796d94d975c309971dc0e789fdec7f4fabcc37f51619d833f070e7d6136f18cdb7113721382392456dd88
+  data.tar.gz: ef643098e96d3d1794470f38befb55039916c13b35d7d133596acf42d7217c302d1de4865c62c178e758aa619063ee9469bbbfcda1665c3e19fcca26aaee12ce

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

@@ -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

@@ -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'

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
@@ -97,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'])
@@ -108,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,
@@ -122,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']
@@ -142,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)
@@ -169,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

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']

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -1,5 +1,8 @@
 # utility methods for Concurrent::Promises.
 module Puppeteer::ConcurrentRubyUtils
+  # wait for all promises.
+  # REMARK: This method doesn't assure the order of calling.
+  # for example, await_all(async1, async2) calls calls2 -> calls1 often.
   def await_all(*args)
     if args.length == 1 && args[0].is_a?(Enumerable)
       Concurrent::Promises.zip(*(args[0])).value!
@@ -8,6 +11,9 @@ module Puppeteer::ConcurrentRubyUtils
     end
   end
 
+  # wait for first promises.
+  # REMARK: This method doesn't assure the order of calling.
+  # for example, await_all(async1, async2) calls calls2 -> calls1 often.
   def await_any(*args)
     if args.length == 1 && args[0].is_a?(Enumerable)
       Concurrent::Promises.any(*(args[0])).value!

data/lib/puppeteer/connection.rb

@@ -3,7 +3,7 @@ require 'json'
 class Puppeteer::Connection
   include Puppeteer::DebugPrint
   include Puppeteer::EventCallbackable
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   class ProtocolError < StandardError
     def initialize(method:, error_message:, error_data: nil)
@@ -210,9 +210,7 @@ class Puppeteer::Connection
     end
   end
 
-  private async def async_handle_message(message)
-    handle_message(message)
-  end
+  private define_async_method :async_handle_message
 
   private def handle_close
     return if @closed
@@ -251,16 +249,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/define_async_method.rb

@@ -0,0 +1,23 @@
+module Puppeteer::DefineAsyncMethod
+  refine Class do
+    def define_async_method(async_method_name)
+      unless async_method_name.to_s.start_with?('async_')
+        raise ArgumentError.new('async method name should start with "async_"')
+      end
+
+      if method_defined?(async_method_name) || private_method_defined?(async_method_name)
+        raise ArgumentError.new("#{async_method_name} is already defined")
+      end
+
+      original_method = instance_method(async_method_name[6..-1])
+      define_method(async_method_name) do |*args|
+        Concurrent::Promises.future do
+          original_method.bind(self).call(*args)
+        rescue => err
+          Logger.new(STDERR).warn(err)
+          raise err
+        end
+      end
+    end
+  end
+end

data/lib/puppeteer/dom_world.rb

@@ -2,7 +2,7 @@ require 'thread'
 
 # https://github.com/puppeteer/puppeteer/blob/master/src/DOMWorld.js
 class Puppeteer::DOMWorld
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.FrameManager} frameManager
   # @param {!Puppeteer.Frame} frame
@@ -12,7 +12,6 @@ class Puppeteer::DOMWorld
     @frame = frame
     @timeout_settings = timeout_settings
     @context_promise = resolvable_future
-    @pending_destroy = []
     @wait_tasks = Set.new
     @detached = false
   end
@@ -24,22 +23,12 @@ class Puppeteer::DOMWorld
     @wait_tasks
   end
 
-  # @param {?Puppeteer.ExecutionContext} context
+  # @param context [Puppeteer::ExecutionContext]
   def context=(context)
-    # D, [2020-04-12T22:45:03.938754 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextCreated", "params"=>{"context"=>{"id"=>3, "origin"=>"https://github.com", "name"=>"", "auxData"=>{"isDefault"=>true, "type"=>"default", "frameId"=>"3AD7F1E82BCBA88BFE31D03BC49FF6CB"}}}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.938856 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextCreated", "params"=>{"context"=>{"id"=>4, "origin"=>"://", "name"=>"__puppeteer_utility_world__", "auxData"=>{"isDefault"=>false, "type"=>"isolated", "frameId"=>"3AD7F1E82BCBA88BFE31D03BC49FF6CB"}}}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.938960 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextDestroyed", "params"=>{"executionContextId"=>1}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.939110 #46154] DEBUG -- : RECV << {"method"=>"Page.frameNavigated", "params"=>{"frame"=>{"id"=>"3AD7F1E82BCBA88BFE31D03BC49FF6CB", "loaderId"=>"301B349884E582986C502CBE020966DF", "url"=>"https://github.com/", "securityOrigin"=>"https://github.com", "mimeType"=>"text/html"}}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.939793 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextDestroyed", "params"=>{"executionContextId"=>2}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # executionContextDestroyed is often notified after executionContextCreated.
-
     if context
-      if @context_promise.fulfilled?
-        @pending_destroy << context._context_id
-        @document = nil
-        @context_promise = resolvable_future
+      unless @context_promise.resolved?
+        @context_promise.fulfill(context)
       end
-      @context_promise.fulfill(context)
       @wait_tasks.each(&:async_rerun)
     else
       raise ArgumentError.new("context should now be nil. Use #delete_context for clearing document.")
@@ -47,12 +36,8 @@ class Puppeteer::DOMWorld
   end
 
   def delete_context(execution_context_id)
-    if @pending_destroy.include?(execution_context_id)
-      @pending_destroy.delete(execution_context_id)
-    else
-      @document = nil
-      @context_promise = resolvable_future
-    end
+    @document = nil
+    @context_promise = resolvable_future
   end
 
   def has_context?