puppeteer-ruby 0.0.6 → 0.0.8

data/docs/top-level-namespace.html

@@ -116,7 +116,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon May 25 23:22:48 2020 by
+  Generated on Thu Jun  4 23:54:40 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.6.3).
 </div>

data/lib/puppeteer.rb

@@ -25,6 +25,7 @@ require 'puppeteer/devices'
 require 'puppeteer/dom_world'
 require 'puppeteer/emulation_manager'
 require 'puppeteer/execution_context'
+require 'puppeteer/file_chooser'
 require 'puppeteer/frame'
 require 'puppeteer/frame_manager'
 require 'puppeteer/js_handle'
@@ -142,7 +143,12 @@ class Puppeteer
       default_viewport: default_viewport,
       slow_mo: slow_mo,
     }.compact
-    launcher.connect(options)
+    browser = launcher.connect(options)
+    if block_given?
+      yield(browser)
+    else
+      browser
+    end
   end
 
   # @return {string}

data/lib/puppeteer/browser_runner.rb

@@ -147,7 +147,7 @@ class Puppeteer::BrowserRunner
   end
 
   private def wait_for_ws_endpoint(browser_process, timeout, preferred_revision)
-    Timeout.timeout(timeout / 1000) do
+    Timeout.timeout(timeout / 1000.0) do
       loop do
         line = browser_process.stderr.readline
         /^DevTools listening on (ws:\/\/.*)$/.match(line) do |m|

data/lib/puppeteer/dom_world.rb

@@ -355,18 +355,15 @@ class Puppeteer::DOMWorld
   #   await handle.dispose();
   # }
 
-  # /**
-  #  * @param {string} selector
-  #  * @param {!Array<string>} values
-  #  * @return {!Promise<!Array<string>>}
-  #  */
-  # async select(selector, ...values) {
-  #   const handle = await this.$(selector);
-  #   assert(handle, 'No node found for selector: ' + selector);
-  #   const result = await handle.select(...values);
-  #   await handle.dispose();
-  #   return result;
-  # }
+  # @param selector [String]
+  # @return [Array<String>]
+  def select(selector, *values)
+    handle = S(selector)
+    result = handle.select(*values)
+    handle.dispose
+
+    result
+  end
 
   # @param selector [String]
   def tap(selector)

data/lib/puppeteer/element_handle.rb

@@ -1,3 +1,5 @@
+require 'mime/types'
+
 class Puppeteer::ElementHandle < Puppeteer::JSHandle
   include Puppeteer::IfPresent
   using Puppeteer::AsyncAwaitBehavior
@@ -155,74 +157,77 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     click(delay: delay, button: button, click_count: click_count)
   end
 
-  #  /**
-  #   * @param {!Array<string>} values
-  #   * @return {!Promise<!Array<string>>}
-  #   */
-  #  async select(...values) {
-  #    for (const value of values)
-  #      assert(helper.isString(value), 'Values must be strings. Found value "' + value + '" of type "' + (typeof value) + '"');
-  #    return this.evaluate((element, values) => {
-  #      if (element.nodeName.toLowerCase() !== 'select')
-  #        throw new Error('Element is not a <select> element.');
-
-  #      const options = Array.from(element.options);
-  #      element.value = undefined;
-  #      for (const option of options) {
-  #        option.selected = values.includes(option.value);
-  #        if (option.selected && !element.multiple)
-  #          break;
-  #      }
-  #      element.dispatchEvent(new Event('input', { bubbles: true }));
-  #      element.dispatchEvent(new Event('change', { bubbles: true }));
-  #      return options.filter(option => option.selected).map(option => option.value);
-  #    }, values);
-  #  }
+  # @return [Array<String>]
+  def select(*values)
+    if nonstring = values.find { |value| !value.is_a?(String) }
+      raise ArgumentError.new("Values must be strings. Found value \"#{nonstring}\" of type \"#{nonstring.class}\"")
+    end
 
-  #  /**
-  #   * @param {!Array<string>} filePaths
-  #   */
-  #  async uploadFile(...filePaths) {
-  #    const isMultiple = await this.evaluate(element => element.multiple);
-  #    assert(filePaths.length <= 1 || isMultiple, 'Multiple file uploads only work with <input type=file multiple>');
-  #    // These imports are only needed for `uploadFile`, so keep them
-  #    // scoped here to avoid paying the cost unnecessarily.
-  #    const path = require('path');
-  #    const mime = require('mime-types');
-  #    const fs = require('fs');
-  #    const readFileAsync = helper.promisify(fs.readFile);
-
-  #    const promises = filePaths.map(filePath => readFileAsync(filePath));
-  #    const files = [];
-  #    for (let i = 0; i < filePaths.length; i++) {
-  #      const buffer = await promises[i];
-  #      const filePath = path.basename(filePaths[i]);
-  #      const file = {
-  #        name: filePath,
-  #        content: buffer.toString('base64'),
-  #        mimeType: mime.lookup(filePath),
-  #      };
-  #      files.push(file);
-  #    }
-  #    await this.evaluateHandle(async(element, files) => {
-  #      const dt = new DataTransfer();
-  #      for (const item of files) {
-  #        const response = await fetch(`data:${item.mimeType};base64,${item.content}`);
-  #        const file = new File([await response.blob()], item.name);
-  #        dt.items.add(file);
-  #      }
-  #      element.files = dt.files;
-  #      element.dispatchEvent(new Event('input', { bubbles: true }));
-  #      element.dispatchEvent(new Event('change', { bubbles: true }));
-  #    }, files);
-  #  }
+    fn = <<~JAVASCRIPT
+    (element, values) => {
+      if (element.nodeName.toLowerCase() !== 'select') {
+        throw new Error('Element is not a <select> element.');
+      }
+
+      const options = Array.from(element.options);
+      element.value = undefined;
+      for (const option of options) {
+        option.selected = values.includes(option.value);
+        if (option.selected && !element.multiple) {
+          break;
+        }
+      }
+      element.dispatchEvent(new Event('input', { bubbles: true }));
+      element.dispatchEvent(new Event('change', { bubbles: true }));
+      return options.filter(option => option.selected).map(option => option.value);
+    }
+    JAVASCRIPT
+    evaluate(fn, values)
+  end
+
+  # @param file_paths [Array<String>]
+  def upload_file(*file_paths)
+    is_multiple = evaluate("el => el.multiple")
+    if !is_multiple && file_paths.length >= 2
+      raise ArgumentError.new('Multiple file uploads only work with <input type=file multiple>')
+    end
+
+    if error_path = file_paths.find { |file_path| !File.exist?(file_path) }
+      raise ArgmentError.new("#{error_path} does not exist or is not readable")
+    end
+
+    backend_node_id = @remote_object.node_info(@client)["node"]["backendNodeId"]
+
+    # The zero-length array is a special case, it seems that DOM.setFileInputFiles does
+    # not actually update the files in that case, so the solution is to eval the element
+    # value to a new FileList directly.
+    if file_paths.empty?
+      fn = <<~JAVASCRIPT
+      (element) => {
+        element.files = new DataTransfer().files;
+
+        // Dispatch events for this case because it should behave akin to a user action.
+        element.dispatchEvent(new Event('input', { bubbles: true }));
+        element.dispatchEvent(new Event('change', { bubbles: true }));
+      }
+      JAVASCRIPT
+      await this.evaluate(fn)
+    else
+      @remote_object.set_file_input_files(@client, file_paths, backend_node_id)
+    end
+  end
+
+  def tap(&block)
+    return super(&block) if block
 
-  def tap
     scroll_into_view_if_needed
     point = clickable_point
     @page.touchscreen.tap(point.x, point.y)
   end
 
+  async def async_tap
+    tap
+  end
 
   def focus
     evaluate('element => element.focus()')
@@ -393,6 +398,14 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     result
   end
 
+  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # @param selector [String]
+  # @param page_function [String]
+  # @return [Object]
+  async def async_Seval(selector, page_function, *args)
+    Seval(selector, page_function, *args)
+  end
+
   # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param selector [String]
   # @param page_function [String]
@@ -408,6 +421,14 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     result
   end
 
+  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # @param selector [String]
+  # @param page_function [String]
+  # @return [Object]
+  async def async_SSeval(selector, page_function, *args)
+    SSeval(selector, page_function, *args)
+  end
+
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param expression [String]
   # @return [Array<ElementHandle>]

data/lib/puppeteer/execution_context.rb

@@ -216,6 +216,19 @@ class Puppeteer::ExecutionContext
   #   return createJSHandle(this, response.objects);
   # }
 
+  # @param backend_node_id [Integer]
+  # @return [Puppeteer::ElementHandle]
+  def adopt_backend_node_id(backend_node_id)
+    response = @client.send_message('DOM.resolveNode',
+      backendNodeId: backend_node_id,
+      executionContextId: @context_id,
+    )
+    Puppeteer::JSHandle.create(
+      context: self,
+      remote_object: Puppeteer::RemoteObject.new(response["object"]),
+    )
+  end
+
   # @param element_handle [Puppeteer::ElementHandle]
   # @return [Puppeteer::ElementHandle]
   def adopt_element_handle(element_handle)

data/lib/puppeteer/file_chooser.rb

@@ -0,0 +1,29 @@
+class Puppeteer::FileChooser
+  # @param element [Puppeteer::ElementHandle]
+  # @param event [Hash]
+  def initialize(element, event)
+    @element = element
+    @multiple = event['mode'] != 'selectSingle'
+    @handled = false
+  end
+
+  def multiple?
+    @multiple
+  end
+
+  # @param file_paths [Array<String>]
+  def accept(file_paths)
+    if @handled
+      raise 'Cannot accept FileChooser which is already handled!'
+    end
+    @handled = true
+    @element.upload_file(*file_paths)
+  end
+
+  def cancel
+    if @handled
+      raise 'Cannot cancel FileChooser which is already handled!'
+    end
+    @handled = true
+  end
+end

data/lib/puppeteer/frame_manager.rb

@@ -285,8 +285,6 @@ class Puppeteer::FrameManager
     frame.navigated_within_document(url)
     emit_event 'Events.FrameManager.FrameNavigatedWithinDocument', frame
     emit_event 'Events.FrameManager.FrameNavigated', frame
-    handle_frame_manager_frame_navigated_within_document(frame)
-    handle_frame_manager_frame_navigated(frame)
   end
 
   # @param frame_id [String]

data/lib/puppeteer/launcher/chrome.rb

@@ -149,8 +149,54 @@ module Puppeteer::Launcher
 
     # @param {!(Launcher.BrowserOptions & {browserWSEndpoint?: string, browserURL?: string, transport?: !Puppeteer.ConnectionTransport})} options
     # @return {!Promise<!Browser>}
-    def connect(options)
-      raise NotImplementedError.new('Puppeteer.connect is not implemented yet')
+    def connect(options = {})
+      @browser_options = BrowserOptions.new(options)
+      browser_ws_endpoint = options[:browser_ws_endpoint]
+      browser_url = options[:browser_url]
+      transport = options[:transport]
+
+      connection =
+        if browser_ws_endpoint && browser_url.nil? && transport.nil?
+          connect_with_browser_ws_endpoint(browser_ws_endpoint)
+        elsif browser_ws_endpoint.nil? && browser_url && transport.nil?
+          connect_with_browser_url(browser_url)
+        elsif browser_ws_endpoint.nil? && browser_url.nil? && transport
+          connect_with_transport(transport)
+        else
+          raise ArgumentError.new("Exactly one of browserWSEndpoint, browserURL or transport must be passed to puppeteer.connect")
+        end
+
+      result = connection.send_message('Target.getBrowserContexts')
+      browser_context_ids = result['browserContextIds']
+
+      Puppeteer::Browser.create(
+        connection: connection,
+        context_ids: browser_context_ids,
+        ignore_https_errors: @browser_options.ignore_https_errors?,
+        default_viewport: @browser_options.default_viewport,
+        process: nil,
+        close_callback: -> { connection.send_message('Browser.close') },
+      )
+    end
+
+    # @return [Puppeteer::Connection]
+    private def connect_with_browser_ws_endpoint(browser_ws_endpoint)
+      transport = Puppeteer::WebSocketTransport.create(browser_ws_endpoint)
+      Puppeteer::Connection.new(browser_ws_endpoint, transport, @browser_options.slow_mo)
+    end
+
+    # @return [Puppeteer::Connection]
+    private def connect_with_browser_url(browser_url)
+      raise NotImplementedError.new('Puppeteer#connect with browserUrl is not implemented yet.')
+      # const connectionURL = await getWSEndpoint(browserURL);
+      # const connectionTransport = await WebSocketTransport.create(
+      #   connectionURL
+      # );
+    end
+
+    # @return [Puppeteer::Connection]
+    private def connect_with_transport(transport)
+      Puppeteer::Connection.new('', transport, @browser_options.slow_mo)
     end
 
     # @return {string}

data/lib/puppeteer/page.rb

@@ -88,8 +88,8 @@ class Puppeteer::Page
     network_manager.on_event 'Events.NetworkManager.RequestFinished' do |event|
       emit_event 'Events.Page.RequestFinished', event
     end
-    # this._fileChooserInterceptionIsDisabled = false;
-    # this._fileChooserInterceptors = new Set();
+    @file_chooser_interception_is_disabled = false
+    @file_chooser_interceptors = Set.new
 
     @client.on_event 'Page.domContentEventFired' do |event|
       emit_event 'Events.Page.DOMContentLoaded'
@@ -106,7 +106,9 @@ class Puppeteer::Page
     @client.on_event 'Log.entryAdded' do |event|
       handle_log_entry_added(event)
     end
-    # client.on('Page.fileChooserOpened', event => this._onFileChooser(event));
+    @client.on_event 'Page.fileChooserOpened' do |event|
+      handle_file_chooser(event)
+    end
     @target.on_close do
       emit_event 'Events.Page.Close'
       @closed = true
@@ -122,41 +124,53 @@ class Puppeteer::Page
     )
   end
 
-  # /**
-  #  * @param {!Protocol.Page.fileChooserOpenedPayload} event
-  #  */
-  # async _onFileChooser(event) {
-  #   if (!this._fileChooserInterceptors.size)
-  #     return;
-  #   const frame = this._frameManager.frame(event.frameId);
-  #   const context = await frame.executionContext();
-  #   const element = await context._adoptBackendNodeId(event.backendNodeId);
-  #   const interceptors = Array.from(this._fileChooserInterceptors);
-  #   this._fileChooserInterceptors.clear();
-  #   const fileChooser = new FileChooser(this._client, element, event);
-  #   for (const interceptor of interceptors)
-  #     interceptor.call(null, fileChooser);
-  # }
+  def handle_file_chooser(event)
+    return if @file_chooser_interceptors.empty?
+
+    frame = @frame_manager.frame(event['frameId'])
+    context = frame.execution_context
+    element = context.adopt_backend_node_id(event['backendNodeId'])
+    interceptors = @file_chooser_interceptors.to_a
+    @file_chooser_interceptors.clear
+    file_chooser = Puppeteer::FileChooser.new(element, event)
+    interceptors.each do |promise|
+      promise.fulfill(file_chooser)
+    end
+  end
 
-  # /**
-  #  * @param {!{timeout?: number}=} options
-  #  * @return !Promise<!FileChooser>}
-  #  */
-  # async waitForFileChooser(options = {}) {
-  #   if (!this._fileChooserInterceptors.size)
-  #     await this._client.send('Page.setInterceptFileChooserDialog', {enabled: true});
+  class FileChooserTimeoutError < StandardError
+    def initialize(timeout:)
+      super("waiting for filechooser failed: timeout #{timeout}ms exceeded")
+    end
+  end
 
-  #   const {
-  #     timeout = this._timeoutSettings.timeout(),
-  #   } = options;
-  #   let callback;
-  #   const promise = new Promise(x => callback = x);
-  #   this._fileChooserInterceptors.add(callback);
-  #   return helper.waitWithTimeout(promise, 'waiting for file chooser', timeout).catch(e => {
-  #     this._fileChooserInterceptors.delete(callback);
-  #     throw e;
-  #   });
-  # }
+  # @param timeout [Integer]
+  # @return [Puppeteer::FileChooser]
+  def wait_for_file_chooser(timeout: nil)
+    if @file_chooser_interceptors.empty?
+      @client.send_message('Page.setInterceptFileChooserDialog', enabled: true)
+    end
+
+    option_timeout = timeout || @timeout_settings.timeout
+    promise = resolvable_future
+    @file_chooser_interceptors << promise
+
+    begin
+      Timeout.timeout(option_timeout / 1000.0) do
+        promise.value!
+      end
+    rescue Timeout::Error
+      raise FileChooserTimeoutError.new(timeout: option_timeout)
+    ensure
+      @file_chooser_interceptors.delete(promise)
+    end
+  end
+
+  # @param timeout [Integer]
+  # @return [Future<Puppeteer::FileChooser>]
+  async def async_wait_for_file_chooser(timeout: nil)
+    wait_for_file_chooser(timeout: timeout)
+  end
 
 
   # /**
@@ -275,23 +289,37 @@ class Puppeteer::Page
   end
 
   # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param {string} selector
-  # @param {Function|string} pageFunction
-  # @param {!Array<*>} args
-  # @return {!Promise<(!Object|undefined)>}
+  # @param selector [String]
+  # @param page_function [String]
+  # @return [Object]
   def Seval(selector, page_function, *args)
     main_frame.Seval(selector, page_function, *args)
   end
 
+  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # @param selector [String]
+  # @param page_function [String]
+  # @return [Future]
+  async def async_Seval(selector, page_function, *args)
+    Seval(selector, page_function, *args)
+  end
+
   # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param {string} selector
-  # @param {Function|string} pageFunction
-  # @param {!Array<*>} args
-  # @return {!Promise<(!Object|undefined)>}
+  # @param selector [String]
+  # @param page_function [String]
+  # @return [Object]
   def SSeval(selector, page_function, *args)
     main_frame.SSeval(selector, page_function, *args)
   end
 
+  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # @param selector [String]
+  # @param page_function [String]
+  # @return [Future]
+  async def async_SSeval(selector, page_function, *args)
+    SSeval(selector, page_function, *args)
+  end
+
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
@@ -610,14 +638,14 @@ class Puppeteer::Page
     main_frame.goto(url, referer: referer, timeout: timeout, wait_until: wait_until)
   end
 
-  # @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
-  # @return {!Promise<?Puppeteer.Response>}
+  # @param timeout [number|nil]
+  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
+  # @return [Puppeteer::Response]
   def reload(timeout: nil, wait_until: nil)
-    # const [response] = await Promise.all([
-    #   this.waitForNavigation(options),
-    #   this._client.send('Page.reload')
-    # ]);
-    # return response;
+    await_all(
+      async_wait_for_navigation(timeout: timeout, wait_until: wait_until),
+      @client.async_send_message('Page.reload'),
+    ).first
   end
 
   # @param timeout [number|nil]
@@ -968,11 +996,16 @@ class Puppeteer::Page
     main_frame.select(selector, *values)
   end
 
-  # @param {string} selector
+  # @param selector [String]
   def tap(selector)
     main_frame.tap(selector)
   end
 
+  # @param selector [String]
+  async def async_tap(selector)
+    tap(selector)
+  end
+
   # @param selector [String]
   # @param text [String]
   # @param delay [Number]