puppeteer-ruby 0.0.23 → 0.29.0

data/lib/puppeteer/execution_context.rb

@@ -12,10 +12,21 @@ class Puppeteer::ExecutionContext
     @client = client
     @world = world
     @context_id = context_payload['id']
+    @context_name = context_payload['name']
   end
 
   attr_reader :client, :world
 
+  # only used in DOMWorld
+  private def _context_id
+    @context_id
+  end
+
+  # only used in DOMWorld::BindingFunction#add_binding_to_context
+  private def _context_name
+    @context_name
+  end
+
   # @return [Puppeteer::Frame]
   def frame
     if_present(@world) do |world|
@@ -223,6 +234,7 @@ class Puppeteer::ExecutionContext
       remote_object: Puppeteer::RemoteObject.new(response["object"]),
     )
   end
+  private define_async_method :async_adopt_backend_node_id
 
   # @param element_handle [Puppeteer::ElementHandle]
   # @return [Puppeteer::ElementHandle]

data/lib/puppeteer/launcher/chrome.rb

@@ -92,7 +92,7 @@ module Puppeteer::Launcher
           '--disable-default-apps',
           '--disable-dev-shm-usage',
           '--disable-extensions',
-          '--disable-features=TranslateUI',
+          '--disable-features=Translate',
           '--disable-hang-monitor',
           '--disable-ipc-flooding-protection',
           '--disable-popup-blocking',
@@ -105,6 +105,9 @@ module Puppeteer::Launcher
           '--enable-automation',
           '--password-store=basic',
           '--use-mock-keychain',
+          # TODO(sadym): remove '--enable-blink-features=IdleDetection'
+          # once IdleDetection is turned on by default.
+          '--enable-blink-features=IdleDetection',
         ]
 
         if chrome_arg_options.user_data_dir

data/lib/puppeteer/page.rb

@@ -3,6 +3,7 @@ require "stringio"
 
 require_relative './page/pdf_options'
 require_relative './page/screenshot_options'
+require_relative './page/screenshot_task_queue'
 
 class Puppeteer::Page
   include Puppeteer::EventCallbackable
@@ -13,10 +14,9 @@ class Puppeteer::Page
   # @param {!Puppeteer.Target} target
   # @param {boolean} ignoreHTTPSErrors
   # @param {?Puppeteer.Viewport} defaultViewport
-  # @param {!Puppeteer.TaskQueue} screenshotTaskQueue
   # @return {!Promise<!Page>}
-  def self.create(client, target, ignore_https_errors, default_viewport, screenshot_task_queue)
-    page = Puppeteer::Page.new(client, target, ignore_https_errors, screenshot_task_queue)
+  def self.create(client, target, ignore_https_errors, default_viewport)
+    page = Puppeteer::Page.new(client, target, ignore_https_errors)
     page.init
     if default_viewport
       page.viewport = default_viewport
@@ -27,8 +27,7 @@ class Puppeteer::Page
   # @param {!Puppeteer.CDPSession} client
   # @param {!Puppeteer.Target} target
   # @param {boolean} ignoreHTTPSErrors
-  # @param {!Puppeteer.TaskQueue} screenshotTaskQueue
-  def initialize(client, target, ignore_https_errors, screenshot_task_queue)
+  def initialize(client, target, ignore_https_errors)
     @closed = false
     @client = client
     @target = target
@@ -43,7 +42,7 @@ class Puppeteer::Page
     @page_bindings = {}
     # @coverage = Coverage.new(client)
     @javascript_enabled = true
-    @screenshot_task_queue = screenshot_task_queue
+    @screenshot_task_queue = ScreenshotTaskQueue.new
 
     @workers = {}
     @client.on_event('Target.attachedToTarget') do |event|
@@ -341,47 +340,34 @@ class Puppeteer::Page
 
   define_async_method :async_Sx
 
-  # /**
-  #  * @param {!Array<string>} urls
-  #  * @return {!Promise<!Array<Network.Cookie>>}
-  #  */
-  # async cookies(...urls) {
-  #   return (await this._client.send('Network.getCookies', {
-  #     urls: urls.length ? urls : [this.url()]
-  #   })).cookies;
-  # }
+  # @return [Array<Hash>]
+  def cookies(*urls)
+    @client.send_message('Network.getCookies', urls: (urls.empty? ? [url] : urls))['cookies']
+  end
 
-  # /**
-  #  * @param {Array<Protocol.Network.deleteCookiesParameters>} cookies
-  #  */
-  # async deleteCookie(...cookies) {
-  #   const pageURL = this.url();
-  #   for (const cookie of cookies) {
-  #     const item = Object.assign({}, cookie);
-  #     if (!cookie.url && pageURL.startsWith('http'))
-  #       item.url = pageURL;
-  #     await this._client.send('Network.deleteCookies', item);
-  #   }
-  # }
+  def delete_cookie(*cookies)
+    page_url = url
+    starts_with_http = page_url.start_with?("http")
+    cookies.each do |cookie|
+      item = (starts_with_http ? { url: page_url } : {}).merge(cookie)
+      @client.send_message("Network.deleteCookies", item)
+    end
+  end
 
-  # /**
-  #  * @param {Array<Network.CookieParam>} cookies
-  #  */
-  # async setCookie(...cookies) {
-  #   const pageURL = this.url();
-  #   const startsWithHTTP = pageURL.startsWith('http');
-  #   const items = cookies.map(cookie => {
-  #     const item = Object.assign({}, cookie);
-  #     if (!item.url && startsWithHTTP)
-  #       item.url = pageURL;
-  #     assert(item.url !== 'about:blank', `Blank page can not have cookie "${item.name}"`);
-  #     assert(!String.prototype.startsWith.call(item.url || '', 'data:'), `Data URL page can not have cookie "${item.name}"`);
-  #     return item;
-  #   });
-  #   await this.deleteCookie(...items);
-  #   if (items.length)
-  #     await this._client.send('Network.setCookies', { cookies: items });
-  # }
+  def set_cookie(*cookies)
+    page_url = url
+    starts_with_http = page_url.start_with?("http")
+    items = cookies.map do |cookie|
+      (starts_with_http ? { url: page_url } : {}).merge(cookie).tap do |item|
+        raise ArgumentError.new("Blank page can not have cookie \"#{item[:name]}\"") if item[:url] == "about:blank"
+        raise ArgumetnError.new("Data URL page can not have cookie \"#{item[:name]}\"") if item[:url]&.start_with?("data:")
+      end
+    end
+    delete_cookie(*items)
+    unless items.empty?
+      @client.send_message("Network.setCookies", cookies: items)
+    end
+  end
 
   class ScriptTag
     # @param {!{content?: string, path?: string, type?: string, url?: string}} options
@@ -843,6 +829,21 @@ class Puppeteer::Page
     end
   end
 
+  # @param is_user_active [Boolean]
+  # @param is_screen_unlocked [Boolean]
+  def emulate_idle_state(is_user_active: nil, is_screen_unlocked: nil)
+    overrides = {
+      isUserActive: is_user_active,
+      isScreenUnlocked: is_screen_unlocked,
+    }.compact
+
+    if overrides.empty?
+      @client.send_message('Emulation.clearIdleOverride')
+    else
+      @client.send_message('Emulation.setIdleOverride', overrides)
+    end
+  end
+
   # @param viewport [Viewport]
   def viewport=(viewport)
     needs_reload = @emulation_manager.emulate_viewport(viewport)
@@ -880,15 +881,28 @@ class Puppeteer::Page
     main_frame.title
   end
 
-  # /**
-  #  * @param {!ScreenshotOptions=} options
-  #  * @return {!Promise<!Buffer|!String>}
-  #  */
-  def screenshot(options = {})
+  # @param type [String] "png"|"jpeg"
+  # @param path [String]
+  # @param full_page [Boolean]
+  # @param clip [Hash]
+  # @param quality [Integer]
+  # @param omit_background [Boolean]
+  # @param encoding [String]
+  def screenshot(type: nil, path: nil, full_page: nil, clip: nil, quality: nil, omit_background: nil, encoding: nil)
+    options = {
+      type: type,
+      path: path,
+      full_page: full_page,
+      clip: clip,
+      quality:  quality,
+      omit_background: omit_background,
+      encoding: encoding,
+    }.compact
     screenshot_options = ScreenshotOptions.new(options)
 
-    # @screenshot_task_queue.post_task(-> { screenshot_task(screenshot_options.type, screenshot_options) })
-    screenshot_task(screenshot_options.type, screenshot_options)
+    @screenshot_task_queue.post_task do
+      screenshot_task(screenshot_options.type, screenshot_options)
+    end
   end
 
   # @param {"png"|"jpeg"} format

data/lib/puppeteer/page/screenshot_options.rb

@@ -32,14 +32,14 @@ class Puppeteer::Page
       @type ||= 'png'
 
       if options[:quality]
-        unless @type == 'png'
+        unless @type == 'jpeg'
           raise ArgumentError.new("options.quality is unsupported for the #{@type} screenshots")
         end
         unless options[:quality].is_a?(Numeric)
           raise ArgumentError.new("Expected options.quality to be a number but found #{options[:quality].class}")
         end
         quality = options[:quality].to_i
-        unless (0..100).include?(qualizy)
+        unless (0..100).include?(quality)
           raise ArgumentError.new("Expected options.quality to be between 0 and 100 (inclusive), got #{quality}")
         end
         @quality = quality

data/lib/puppeteer/page/screenshot_task_queue.rb

@@ -0,0 +1,13 @@
+class Puppeteer::Page
+  class ScreenshotTaskQueue
+    def initialize
+      @chain = Concurrent::Promises.fulfilled_future(nil)
+    end
+
+    def post_task(&block)
+      result = @chain.then { block.call }
+      @chain = result.rescue { nil }
+      result.value!
+    end
+  end
+end

data/lib/puppeteer/query_handler_manager.rb

@@ -0,0 +1,65 @@
+require 'singleton'
+
+class Puppeteer::QueryHandlerManager
+  include Singleton
+
+  def query_handlers
+    @query_handlers ||= {
+      aria: Puppeteer::AriaQueryHandler.new,
+    }
+  end
+
+  private def default_handler
+    @default_handler ||= Puppeteer::CustomQueryHandler.new(
+      query_one: '(element, selector) => element.querySelector(selector)',
+      query_all: '(element, selector) => element.querySelectorAll(selector)',
+    )
+  end
+
+  class Result
+    def initialize(query_handler:, selector:)
+      @query_handler = query_handler
+      @selector = selector
+    end
+
+    def query_one(element_handle)
+      @query_handler.query_one(element_handle, @selector)
+    end
+
+    def wait_for(dom_world, visible:, hidden:, timeout:)
+      @query_handler.wait_for(dom_world, @selector, visible: visible, hidden: hidden, timeout: timeout)
+    end
+
+    def query_all(element_handle)
+      @query_handler.query_all(element_handle, @selector)
+    end
+
+    def query_all_array(element_handle)
+      @query_handler.query_all_array(element_handle, @selector)
+    end
+  end
+
+  def detect_query_handler(selector)
+    unless /^[a-zA-Z]+\// =~ selector
+      return Result.new(
+        query_handler: default_handler,
+        selector: selector,
+      )
+    end
+
+    chunk = selector.split("/")
+    name = chunk.shift
+    updated_selector = chunk.join("/")
+
+    query_handler = query_handlers[name.to_sym]
+
+    unless query_handler
+      raise ArgumentError.new("Query set to use \"#{name}\", but no query handler of that name was found")
+    end
+
+    Result.new(
+      query_handler: query_handler,
+      selector: updated_selector,
+    )
+  end
+end

data/lib/puppeteer/remote_object.rb

@@ -97,6 +97,18 @@ class Puppeteer::RemoteObject
     nil
   end
 
+  # used in ElementHandle#query_ax_tree
+  def query_ax_tree(client, accessible_name: nil, role: nil)
+    result = client.send_message('Accessibility.queryAXTree', {
+      objectId: @object_id,
+      accessibleName: accessible_name,
+      role: role,
+    }.compact)
+
+    result['nodes'].reject do |node|
+      node['role']['value'] == 'text'
+    end
+  end
 
   # helper#valueFromRemoteObject
   def value

data/lib/puppeteer/target.rb

@@ -18,15 +18,13 @@ class Puppeteer::Target
   # @param {!function():!Promise<!Puppeteer.CDPSession>} sessionFactory
   # @param {boolean} ignoreHTTPSErrors
   # @param {?Puppeteer.Viewport} defaultViewport
-  # @param {!Puppeteer.TaskQueue} screenshotTaskQueue
-  def initialize(target_info:, browser_context:, session_factory:, ignore_https_errors:, default_viewport:, screenshot_task_queue:)
+  def initialize(target_info:, browser_context:, session_factory:, ignore_https_errors:, default_viewport:)
     @target_info = target_info
     @browser_context = browser_context
     @target_id = target_info.target_id
     @session_factory = session_factory
     @ignore_https_errors = ignore_https_errors
     @default_viewport = default_viewport
-    @screenshot_task_queue = screenshot_task_queue
 
 
     #    /** @type {?Promise<!Puppeteer.Page>} */
@@ -87,7 +85,7 @@ class Puppeteer::Target
   def page
     if ['page', 'background_page', 'webview'].include?(@target_info.type) && @page.nil?
       client = @session_factory.call
-      @page = Puppeteer::Page.create(client, self, @ignore_https_errors, @default_viewport, @screenshot_task_queue)
+      @page = Puppeteer::Page.create(client, self, @ignore_https_errors, @default_viewport)
     end
     @page
   end

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 class Puppeteer
-  VERSION = '0.0.23'
+  VERSION = '0.29.0'
 end

data/lib/puppeteer/wait_task.rb

@@ -9,7 +9,7 @@ class Puppeteer::WaitTask
     end
   end
 
-  def initialize(dom_world:, predicate_body:, title:, polling:, timeout:, args: [])
+  def initialize(dom_world:, predicate_body:, title:, polling:, timeout:, args: [], binding_function: nil)
     if polling.is_a?(String)
       if polling != 'raf' && polling != 'mutation'
         raise ArgumentError.new("Unknown polling option: #{polling}")
@@ -27,8 +27,12 @@ class Puppeteer::WaitTask
     @timeout = timeout
     @predicate_body = "return (#{predicate_body})(...args);"
     @args = args
+    @binding_function = binding_function
     @run_count = 0
-    @dom_world._wait_tasks.add(self)
+    @dom_world.send(:_wait_tasks).add(self)
+    if binding_function
+      @dom_world.send(:_bound_functions)[binding_function.name] = binding_function
+    end
     @promise = resolvable_future
 
     # Since page navigation requires us to re-install the pageScript, we should track
@@ -53,8 +57,16 @@ class Puppeteer::WaitTask
 
   def rerun
     run_count = (@run_count += 1)
+    context = @dom_world.execution_context
+
+    return if @terminated || run_count != @run_count
+    if @binding_function
+      @dom_world.add_binding_to_context(context, @binding_function)
+    end
+    return if @terminated || run_count != @run_count
+
     begin
-      success = @dom_world.execution_context.evaluate_handle(
+      success = context.evaluate_handle(
         WAIT_FOR_PREDICATE_PAGE_FUNCTION,
         @predicate_body,
         @polling,
@@ -103,7 +115,7 @@ class Puppeteer::WaitTask
 
   private def cleanup
     @timeout_cleared = true
-    @dom_world._wait_tasks.delete(self)
+    @dom_world.send(:_wait_tasks).delete(self)
   end
 
   private define_async_method :async_rerun

data/puppeteer-ruby.gemspec

@@ -21,13 +21,15 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'concurrent-ruby', '~> 1.1.0'
   spec.add_dependency 'websocket-driver', '>= 0.6.0'
   spec.add_dependency 'mime-types', '>= 3.0'
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '~> 2.2.3'
+  spec.add_development_dependency 'chunky_png'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.10.0 '
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 0.90.0'
+  spec.add_development_dependency 'rubocop', '~> 1.10.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'webrick'
   spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.29.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +214,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/stale.yml"
 - ".github/workflows/docs.yml"
 - ".github/workflows/reviewdog.yml"
@@ -193,6 +223,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Dockerfile
 - Gemfile
 - README.md
@@ -201,6 +232,7 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/puppeteer.rb
+- lib/puppeteer/aria_query_handler.rb
 - lib/puppeteer/browser.rb
 - lib/puppeteer/browser_context.rb
 - lib/puppeteer/browser_fetcher.rb
@@ -209,6 +241,7 @@ files:
 - lib/puppeteer/concurrent_ruby_utils.rb
 - lib/puppeteer/connection.rb
 - lib/puppeteer/console_message.rb
+- lib/puppeteer/custom_query_handler.rb
 - lib/puppeteer/debug_print.rb
 - lib/puppeteer/define_async_method.rb
 - lib/puppeteer/device.rb
@@ -248,6 +281,8 @@ files:
 - lib/puppeteer/page.rb
 - lib/puppeteer/page/pdf_options.rb
 - lib/puppeteer/page/screenshot_options.rb
+- lib/puppeteer/page/screenshot_task_queue.rb
+- lib/puppeteer/query_handler_manager.rb
 - lib/puppeteer/remote_object.rb
 - lib/puppeteer/request.rb
 - lib/puppeteer/response.rb