puppeteer-ruby 0.0.25 → 0.30.0

data/lib/puppeteer/element_handle.rb

@@ -314,33 +314,23 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
-  # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  private def query_handler_manager
+    Puppeteer::QueryHandlerManager.instance
+  end
+
+  # `$()` in JavaScript.
   # @param selector [String]
-  def S(selector)
-    handle = evaluate_handle(
-      '(element, selector) => element.querySelector(selector)',
-      selector,
-    )
-    element = handle.as_element
-
-    if element
-      return element
-    end
-    handle.dispose
-    nil
+  def query_selector(selector)
+    query_handler_manager.detect_query_handler(selector).query_one(self)
   end
+  alias_method :S, :query_selector
 
-  # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$()` in JavaScript.
   # @param selector [String]
-  def SS(selector)
-    handles = evaluate_handle(
-      '(element, selector) => element.querySelectorAll(selector)',
-      selector,
-    )
-    properties = handles.properties
-    handles.dispose
-    properties.values.map(&:as_element).compact
+  def query_selector_all(selector)
+    query_handler_manager.detect_query_handler(selector).query_all(self)
   end
+  alias_method :SS, :query_selector_all
 
   class ElementNotFoundError < StandardError
     def initialize(selector)
@@ -348,12 +338,12 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def Seval(selector, page_function, *args)
-    element_handle = S(selector)
+  def eval_on_selector(selector, page_function, *args)
+    element_handle = query_selector(selector)
     unless element_handle
       raise ElementNotFoundError.new(selector)
     end
@@ -362,25 +352,24 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
 
     result
   end
+  alias_method :Seval, :eval_on_selector
 
-  define_async_method :async_Seval
+  define_async_method :async_eval_on_selector
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def SSeval(selector, page_function, *args)
-    handles = evaluate_handle(
-      '(element, selector) => Array.from(element.querySelectorAll(selector))',
-      selector,
-    )
+  def eval_on_selector_all(selector, page_function, *args)
+    handles = query_handler_manager.detect_query_handler(selector).query_all_array(self)
     result = handles.evaluate(page_function, *args)
     handles.dispose
 
     result
   end
+  alias_method :SSeval, :eval_on_selector_all
 
-  define_async_method :async_SSeval
+  define_async_method :async_eval_on_selector_all
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param expression [String]
@@ -430,4 +419,10 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     # https://en.wikipedia.org/wiki/Polygon#Simple_polygons
     quad.zip(quad.rotate).map { |p1, p2| (p1.x * p2.y - p2.x * p1.y) / 2 }.reduce(:+).abs
   end
+
+  # used in AriaQueryHandler
+  def query_ax_tree(accessible_name: nil, role: nil)
+    @remote_object.query_ax_tree(@client,
+    accessible_name: accessible_name, role: role)
+  end
 end

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/frame.rb

@@ -61,14 +61,15 @@ class Puppeteer::Frame
 
   define_async_method :async_evaluate
 
-  # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<?Puppeteer.ElementHandle>}
-  def S(selector)
-    @main_world.S(selector)
+  def query_selector(selector)
+    @main_world.query_selector(selector)
   end
+  alias_method :S, :query_selector
 
-  define_async_method :async_S
+  define_async_method :async_query_selector
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -79,36 +80,39 @@ class Puppeteer::Frame
 
   define_async_method :async_Sx
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$eval()` in JavaScript.
   # @param {string} selector
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   # @return {!Promise<(!Object|undefined)>}
-  def Seval(selector, page_function, *args)
-    @main_world.Seval(selector, page_function, *args)
+  def eval_on_selector(selector, page_function, *args)
+    @main_world.eval_on_selector(selector, page_function, *args)
   end
+  alias_method :Seval, :eval_on_selector
 
-  define_async_method :async_Seval
+  define_async_method :async_eval_on_selector
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$eval()` in JavaScript.
   # @param {string} selector
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   # @return {!Promise<(!Object|undefined)>}
-  def SSeval(selector, page_function, *args)
-    @main_world.SSeval(selector, page_function, *args)
+  def eval_on_selector_all(selector, page_function, *args)
+    @main_world.eval_on_selector_all(selector, page_function, *args)
   end
+  alias_method :SSeval, :eval_on_selector_all
 
-  define_async_method :async_SSeval
+  define_async_method :async_eval_on_selector_all
 
-  # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
-  def SS(selector)
-    @main_world.SS(selector)
+  def query_selector_all(selector)
+    @main_world.query_selector_all(selector)
   end
+  alias_method :SS, :query_selector_all
 
-  define_async_method :async_SS
+  define_async_method :async_query_selector_all
 
   # @return [String]
   def content

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|
@@ -277,23 +276,25 @@ class Puppeteer::Page
     @timeout_settings.default_timeout = timeout
   end
 
-  # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<?Puppeteer.ElementHandle>}
-  def S(selector)
-    main_frame.S(selector)
+  def query_selector(selector)
+    main_frame.query_selector(selector)
   end
+  alias_method :S, :query_selector
 
-  define_async_method :async_S
+  define_async_method :async_query_selector
 
-  # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
-  def SS(selector)
-    main_frame.SS(selector)
+  def query_selector_all(selector)
+    main_frame.query_selector_all(selector)
   end
+  alias_method :SS, :query_selector_all
 
-  define_async_method :async_SS
+  define_async_method :async_query_selector_all
 
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
@@ -312,25 +313,27 @@ class Puppeteer::Page
     context.query_objects(prototype_handle)
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def Seval(selector, page_function, *args)
-    main_frame.Seval(selector, page_function, *args)
+  def eval_on_selector(selector, page_function, *args)
+    main_frame.eval_on_selector(selector, page_function, *args)
   end
+  alias_method :Seval, :eval_on_selector
 
-  define_async_method :async_Seval
+  define_async_method :async_eval_on_selector
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def SSeval(selector, page_function, *args)
-    main_frame.SSeval(selector, page_function, *args)
+  def eval_on_selector_all(selector, page_function, *args)
+    main_frame.eval_on_selector_all(selector, page_function, *args)
   end
+  alias_method :SSeval, :eval_on_selector_all
 
-  define_async_method :async_SSeval
+  define_async_method :async_eval_on_selector_all
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -830,6 +833,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)
@@ -867,15 +885,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