puppeteer-ruby 0.0.15 → 0.0.20

data/lib/puppeteer/browser_runner.rb

@@ -156,6 +156,6 @@ class Puppeteer::BrowserRunner
       end
     end
   rescue Timeout::Error
-    raise Puppeteer::TimeoutError.new("Timed out after #{timeout} ms while trying to connect to the browser! Only Chrome at revision r#{preferredRevision} is guaranteed to work.")
+    raise Puppeteer::TimeoutError.new("Timed out after #{timeout} ms while trying to connect to the browser! Only Chrome at revision r#{preferred_revision} is guaranteed to work.")
   end
 end

data/lib/puppeteer/cdp_session.rb

@@ -81,4 +81,14 @@ class Puppeteer::CDPSession
     @connection = nil
     emit_event 'Events.CDPSession.Disconnected'
   end
+
+  # @param event_name [String]
+  def on(event_name, &block)
+    add_event_listener(event_name, &block)
+  end
+
+  # @param event_name [String]
+  def once(event_name, &block)
+    observe_first(event_name, &block)
+  end
 end

data/lib/puppeteer/connection.rb

@@ -49,13 +49,18 @@ class Puppeteer::Connection
       async_handle_message(message)
     end
     @transport.on_close do |reason, code|
-      handle_close(reason, code)
+      handle_close
     end
 
     @sessions = {}
     @closed = false
   end
 
+  # used only in Browser#connected?
+  def closed?
+    @closed
+  end
+
   private def sleep_before_handling_message(message)
     # Puppeteer doesn't handle any Network monitoring responses.
     # So we don't have to sleep.
@@ -199,8 +204,8 @@ class Puppeteer::Connection
           callback.reject(
             ProtocolError.new(
               method: callback.method,
-              error_message: response['error']['message'],
-              error_data: response['error']['data']))
+              error_message: message['error']['message'],
+              error_data: message['error']['data']))
         else
           callback.resolve(message['result'])
         end

data/lib/puppeteer/debug_print.rb

@@ -1,9 +1,9 @@
 require 'logger'
 
 module Puppeteer::DebugPrint
-  if ['1', 'true'].include?(ENV['DEBUG'])
+  if Puppeteer.env.debug?
     def debug_puts(*args, **kwargs)
-      @__debug_logger ||= Logger.new(STDOUT)
+      @__debug_logger ||= Logger.new($stdout)
       @__debug_logger.debug(*args, **kwargs)
     end
 

data/lib/puppeteer/define_async_method.rb

@@ -14,7 +14,7 @@ module Puppeteer::DefineAsyncMethod
         Concurrent::Promises.future do
           original_method.bind(self).call(*args)
         rescue => err
-          Logger.new(STDERR).warn(err)
+          Logger.new($stderr).warn(err)
           raise err
         end
       end

data/lib/puppeteer/dialog.rb

@@ -0,0 +1,34 @@
+class Puppeteer::Dialog
+  def initialize(client, type:, message:, default_value:)
+    @client = client
+    @type = type
+    @message = message
+    @default_value = default_value || ''
+  end
+
+  attr_reader :type, :message, :default_value
+
+  # @param prompt_text - optional text that will be entered in the dialog
+  # prompt. Has no effect if the dialog's type is not `prompt`.
+  #
+  # @returns A promise that resolves when the dialog has been accepted.
+  def accept(prompt_text = nil)
+    if @handled
+      raise 'Cannot accept dialog which is already handled!'
+    end
+    @handled = true
+    @client.send_message('Page.handleJavaScriptDialog', {
+      accept: true,
+      promptText: prompt_text,
+    }.compact)
+  end
+
+  # @returns A promise which will resolve once the dialog has been dismissed
+  def dismiss
+    if @handled
+      raise 'Cannot accept dialog which is already handled!'
+    end
+    @handled = true
+    @client.send_message('Page.handleJavaScriptDialog', accept: false)
+  end
+end

data/lib/puppeteer/dom_world.rb

@@ -314,25 +314,28 @@ class Puppeteer::DOMWorld
   #   }
   # }
 
+  class ElementNotFoundError < StandardError
+    def initialize(selector)
+      super("No node found for selector: #{selector}")
+    end
+  end
+
   # @param selector [String]
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
   # @param click_count [Number]
   def click(selector, delay: nil, button: nil, click_count: nil)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     handle.click(delay: delay, button: button, click_count: click_count)
     handle.dispose
   end
 
-  # /**
-  #  * @param {string} selector
-  #  */
-  # async focus(selector) {
-  #   const handle = await this.$(selector);
-  #   assert(handle, 'No node found for selector: ' + selector);
-  #   await handle.focus();
-  #   await handle.dispose();
-  # }
+  # @param selector [String]
+  def focus(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
+    handle.focus
+    handle.dispose
+  end
 
   # /**
   #  * @param {string} selector
@@ -347,7 +350,7 @@ class Puppeteer::DOMWorld
   # @param selector [String]
   # @return [Array<String>]
   def select(selector, *values)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     result = handle.select(*values)
     handle.dispose
 
@@ -356,7 +359,7 @@ class Puppeteer::DOMWorld
 
   # @param selector [String]
   def tap(selector)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     handle.tap
     handle.dispose
   end
@@ -365,7 +368,7 @@ class Puppeteer::DOMWorld
   # @param text [String]
   # @param delay [Number]
   def type_text(selector, text, delay: nil)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     handle.type_text(text, delay: delay)
     handle.dispose
   end
@@ -399,6 +402,26 @@ class Puppeteer::DOMWorld
   #   return new WaitTask(this, pageFunction, 'function', polling, timeout, ...args).promise;
   # }
 
+  # @param page_function [String]
+  # @param args [Array]
+  # @param polling [Integer|String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    option_polling = polling || 'raf'
+    option_timeout = timeout || @timeout_settings.timeout
+
+    Puppeteer::WaitTask.new(
+      dom_world: self,
+      predicate_body: page_function,
+      title: 'function',
+      polling: option_polling,
+      timeout: option_timeout,
+      args: args,
+    ).await_promise
+  end
+
+
   # @return [String]
   def title
     evaluate('() => document.title')
@@ -424,7 +447,7 @@ class Puppeteer::DOMWorld
 
     wait_task = Puppeteer::WaitTask.new(
       dom_world: self,
-      predicate_body: "return (#{PREDICATE})(...args)",
+      predicate_body: PREDICATE,
       title: title,
       polling: polling,
       timeout: option_timeout,

data/lib/puppeteer/element_handle.rb

@@ -3,6 +3,7 @@ require_relative './element_handle/box_model'
 require_relative './element_handle/point'
 
 class Puppeteer::ElementHandle < Puppeteer::JSHandle
+  include Puppeteer::DebugPrint
   include Puppeteer::IfPresent
   using Puppeteer::DefineAsyncMethod
 
@@ -23,7 +24,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   end
 
   def content_frame
-    node_info = @remote_object.node_info
+    node_info = @remote_object.node_info(@client)
     frame_id = node_info['node']['frameId']
     if frame_id.is_a?(String)
       @frame_manager.frame(frame_id)
@@ -42,7 +43,24 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
         if (element.nodeType !== Node.ELEMENT_NODE)
           return 'Node is not of type HTMLElement';
 
-        element.scrollIntoViewIfNeeded({block: 'center', inline: 'center', behavior: 'instant'});
+        if (element.scrollIntoViewIfNeeded) {
+          element.scrollIntoViewIfNeeded({block: 'center', inline: 'center', behavior: 'instant'});
+        } else {
+          // force-scroll if page's javascript is disabled.
+          if (!pageJavascriptEnabled) {
+            element.scrollIntoView({block: 'center', inline: 'center', behavior: 'instant'});
+            return false;
+          }
+          const visibleRatio = await new Promise(resolve => {
+            const observer = new IntersectionObserver(entries => {
+              resolve(entries[0].intersectionRatio);
+              observer.disconnect();
+            });
+            observer.observe(element);
+          });
+          if (visibleRatio !== 1.0)
+            element.scrollIntoView({block: 'center', inline: 'center', behavior: 'instant'});
+        }
         return false;
       }
     JAVASCRIPT
@@ -62,7 +80,14 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   end
 
   def clickable_point
-    result = @remote_object.content_quads(@client)
+    result =
+      begin
+        @remote_object.content_quads(@client)
+      rescue => err
+        debug_puts(err)
+        nil
+      end
+
     if !result || result["quads"].empty?
       raise ElementNotVisibleError.new
     end
@@ -208,10 +233,11 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   define_async_method :async_type_text
 
   # @param key [String]
+  # @param text [String]
   # @param delay [number|nil]
-  def press(key, delay: nil)
+  def press(key, delay: nil, text: nil)
     focus
-    @page.keyboard.press(key, delay: delay)
+    @page.keyboard.press(key, delay: delay, text: text)
   end
 
   define_async_method :async_press
@@ -379,21 +405,24 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
 
   define_async_method :async_Sx
 
-  #  /**
-  #   * @returns {!Promise<boolean>}
-  #   */
-  #  isIntersectingViewport() {
-  #    return this.evaluate(async element => {
-  #      const visibleRatio = await new Promise(resolve => {
-  #        const observer = new IntersectionObserver(entries => {
-  #          resolve(entries[0].intersectionRatio);
-  #          observer.disconnect();
-  #        });
-  #        observer.observe(element);
-  #      });
-  #      return visibleRatio > 0;
-  #    });
-  #  }
+  # in JS, #isIntersectingViewport.
+  # @return [Boolean]
+  def intersecting_viewport?
+    js = <<~JAVASCRIPT
+    async element => {
+      const visibleRatio = await new Promise(resolve => {
+        const observer = new IntersectionObserver(entries => {
+          resolve(entries[0].intersectionRatio);
+          observer.disconnect();
+        });
+        observer.observe(element);
+      });
+      return visibleRatio > 0;
+    }
+    JAVASCRIPT
+
+    evaluate(js)
+  end
 
   # @param quad [Array<Point>]
   private def compute_quad_area(quad)

data/lib/puppeteer/env.rb

@@ -0,0 +1,23 @@
+class Puppeteer::Env
+  # indicates whether DEBUG=1 is specified.
+  #
+  # @return [Boolean]
+  def debug?
+    ['1', 'true'].include?(ENV['DEBUG'].to_s)
+  end
+
+  def ci?
+    ['1', 'true'].include?(ENV['CI'].to_s)
+  end
+
+  # check if running on macOS
+  def darwin?
+    RUBY_PLATFORM.include?('darwin')
+  end
+end
+
+class Puppeteer
+  def self.env
+    Puppeteer::Env.new
+  end
+end

data/lib/puppeteer/frame.rb

@@ -142,7 +142,7 @@ class Puppeteer::Frame
   end
 
   def child_frames
-    @child_frames.dup
+    @child_frames.to_a
   end
 
   def detached?
@@ -208,28 +208,6 @@ class Puppeteer::Frame
 
   define_async_method :async_type_text
 
-  # /**
-  #  * @param {(string|number|Function)} selectorOrFunctionOrTimeout
-  #  * @param {!Object=} options
-  #  * @param {!Array<*>} args
-  #  * @return {!Promise<?Puppeteer.JSHandle>}
-  #  */
-  # waitFor(selectorOrFunctionOrTimeout, options = {}, ...args) {
-  #   const xPathPattern = '//';
-
-  #   if (helper.isString(selectorOrFunctionOrTimeout)) {
-  #     const string = /** @type {string} */ (selectorOrFunctionOrTimeout);
-  #     if (string.startsWith(xPathPattern))
-  #       return this.waitForXPath(string, options);
-  #     return this.waitForSelector(string, options);
-  #   }
-  #   if (helper.isNumber(selectorOrFunctionOrTimeout))
-  #     return new Promise(fulfill => setTimeout(fulfill, /** @type {number} */ (selectorOrFunctionOrTimeout)));
-  #   if (typeof selectorOrFunctionOrTimeout === 'function')
-  #     return this.waitForFunction(selectorOrFunctionOrTimeout, options, ...args);
-  #   return Promise.reject(new Error('Unsupported target type: ' + (typeof selectorOrFunctionOrTimeout)));
-  # }
-
   # @param selector [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
   # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
@@ -247,6 +225,11 @@ class Puppeteer::Frame
 
   define_async_method :async_wait_for_selector
 
+  # @param milliseconds [Integer] the number of milliseconds to wait.
+  def wait_for_timeout(milliseconds)
+    sleep(milliseconds / 1000.0)
+  end
+
   # @param xpath [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
   # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
@@ -264,12 +247,13 @@ class Puppeteer::Frame
 
   define_async_method :async_wait_for_xpath
 
-  # @param {Function|string} pageFunction
-  # @param {!{polling?: string|number, timeout?: number}=} options
-  # @param {!Array<*>} args
-  # @return {!Promise<!Puppeteer.JSHandle>}
-  def wait_for_function(page_function, options = {}, *args)
-    @main_world.wait_for_function(page_function, options, *args)
+  # @param page_function [String]
+  # @param args [Integer|Array]
+  # @param polling [String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    @main_world.wait_for_function(page_function, args: args, polling: polling, timeout: timeout)
   end
 
   define_async_method :async_wait_for_function
@@ -282,9 +266,7 @@ class Puppeteer::Frame
   # @param frame_payload [Hash]
   def navigated(frame_payload)
     @name = frame_payload['name']
-    # TODO(lushnikov): remove this once requestInterception has loaderId exposed.
-    @navigation_url = frame_payload['url']
-    @url = frame_payload['url']
+    @url = "#{frame_payload['url']}#{frame_payload['urlFragment']}"
 
     # Ensure loaderId updated.
     # The order of [Page.lifecycleEvent name="init"] and [Page.frameNavigated] is random... for some reason...

data/lib/puppeteer/js_handle.rb

@@ -1,5 +1,6 @@
 class Puppeteer::JSHandle
   using Puppeteer::DefineAsyncMethod
+  include Puppeteer::IfPresent
 
   # @param context [Puppeteer::ExecutionContext]
   # @param remote_object [Puppeteer::RemoteObject]
@@ -57,21 +58,29 @@ class Puppeteer::JSHandle
 
   define_async_method :async_evaluate_handle
 
-  # /**
-  #  * @param {string} propertyName
-  #  * @return {!Promise<?JSHandle>}
-  #  */
-  # async getProperty(propertyName) {
-  #   const objectHandle = await this.evaluateHandle((object, propertyName) => {
-  #     const result = {__proto__: null};
-  #     result[propertyName] = object[propertyName];
-  #     return result;
-  #   }, propertyName);
-  #   const properties = await objectHandle.getProperties();
-  #   const result = properties.get(propertyName) || null;
-  #   await objectHandle.dispose();
-  #   return result;
-  # }
+  # getProperty(propertyName) in JavaScript
+  # @param name [String]
+  # @return [Puppeteer::JSHandle]
+  def property(name)
+    js = <<~JAVASCRIPT
+    (object, propertyName) => {
+      const result = {__proto__: null};
+      result[propertyName] = object[propertyName];
+      return result;
+    }
+    JAVASCRIPT
+    object_handle = evaluate_handle(js, name)
+    properties = object_handle.properties
+    result = properties[name]
+    object_handle.dispose
+    result
+  end
+
+  # @param name [String]
+  # @return [Puppeteer::JSHandle]
+  def [](name)
+    property(name)
+  end
 
   # getProperties in JavaScript.
   # @return [Hash<String, JSHandle>]
@@ -101,7 +110,7 @@ class Puppeteer::JSHandle
     #
     # However it would be better that RemoteObject is responsible for
     # the logic `if (this._remoteObject.objectId) { ... }`.
-    @remote_object.evaluate_self(@client) || @remote_object.value
+    @remote_object.evaluate_self(@client)&.value || @remote_object.value
   end
 
   def as_element
@@ -119,15 +128,16 @@ class Puppeteer::JSHandle
     @disposed
   end
 
-  # /**
-  #  * @override
-  #  * @return {string}
-  #  */
-  # toString() {
-  #   if (this._remoteObject.objectId) {
-  #     const type =  this._remoteObject.subtype || this._remoteObject.type;
-  #     return 'JSHandle@' + type;
-  #   }
-  #   return 'JSHandle:' + helper.valueFromRemoteObject(this._remoteObject);
-  # }
+  def to_s
+    # original logic was:
+    #   if (this._remoteObject.objectId) {
+    #     const type =  this._remoteObject.subtype || this._remoteObject.type;
+    #     return 'JSHandle@' + type;
+    #   }
+    #   return 'JSHandle:' + helper.valueFromRemoteObject(this._remoteObject);
+    #
+    # However it would be better that RemoteObject is responsible for
+    # the logic `if (this._remoteObject.objectId) { ... }`.
+    if_present(@remote_object.type_str) { |type_str| "JSHandle@#{type_str}" } || "JSHandle:#{@remote_object.value || 'undefined'}"
+  end
 end