puppeteer-ruby 0.29.0 → 0.31.4

data/lib/puppeteer.rb

@@ -1,6 +1,6 @@
 require 'concurrent'
 
-class Puppeteer; end
+module Puppeteer; end
 
 require 'puppeteer/env'
 
@@ -43,6 +43,7 @@ require 'puppeteer/lifecycle_watcher'
 require 'puppeteer/mouse'
 require 'puppeteer/network_manager'
 require 'puppeteer/page'
+require 'puppeteer/puppeteer'
 require 'puppeteer/query_handler_manager'
 require 'puppeteer/remote_object'
 require 'puppeteer/request'
@@ -59,9 +60,9 @@ require 'puppeteer/web_socket_transport'
 require 'puppeteer/element_handle'
 
 # ref: https://github.com/puppeteer/puppeteer/blob/master/lib/Puppeteer.js
-class Puppeteer
-  def self.method_missing(method, *args, **kwargs, &block)
-    @puppeteer ||= Puppeteer.new(
+module Puppeteer
+  module_function def method_missing(method, *args, **kwargs, &block)
+    @puppeteer ||= ::Puppeteer::Puppeteer.new(
       project_root: __dir__,
       preferred_revision: '706915',
       is_puppeteer_core: true,
@@ -73,167 +74,4 @@ class Puppeteer
       @puppeteer.public_send(method, *args, **kwargs, &block)
     end
   end
-
-  # @param project_root [String]
-  # @param prefereed_revision [String]
-  # @param is_puppeteer_core [String]
-  def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
-    @project_root = project_root
-    @preferred_revision = preferred_revision
-    @is_puppeteer_core = is_puppeteer_core
-  end
-
-  # @param product [String]
-  # @param executable_path [String]
-  # @param ignore_default_args [Array<String>|nil]
-  # @param handle_SIGINT [Boolean]
-  # @param handle_SIGTERM [Boolean]
-  # @param handle_SIGHUP [Boolean]
-  # @param timeout [Integer]
-  # @param dumpio [Boolean]
-  # @param env [Hash]
-  # @param pipe [Boolean]
-  # @param args [Array<String>]
-  # @param user_data_dir [String]
-  # @param devtools [Boolean]
-  # @param headless [Boolean]
-  # @param ignore_https_errors [Boolean]
-  # @param default_viewport [Puppeteer::Viewport|nil]
-  # @param slow_mo [Integer]
-  # @return [Puppeteer::Browser]
-  def launch(
-    product: nil,
-    executable_path: nil,
-    ignore_default_args: nil,
-    handle_SIGINT: nil,
-    handle_SIGTERM: nil,
-    handle_SIGHUP: nil,
-    timeout: nil,
-    dumpio: nil,
-    env: nil,
-    pipe: nil,
-    args: nil,
-    user_data_dir: nil,
-    devtools: nil,
-    headless: nil,
-    ignore_https_errors: nil,
-    default_viewport: nil,
-    slow_mo: nil
-  )
-    options = {
-      executable_path: executable_path,
-      ignore_default_args: ignore_default_args,
-      handle_SIGINT: handle_SIGINT,
-      handle_SIGTERM: handle_SIGTERM,
-      handle_SIGHUP: handle_SIGHUP,
-      timeout: timeout,
-      dumpio: dumpio,
-      env: env,
-      pipe: pipe,
-      args: args,
-      user_data_dir: user_data_dir,
-      devtools: devtools,
-      headless: headless,
-      ignore_https_errors: ignore_https_errors,
-      default_viewport: default_viewport,
-      slow_mo: slow_mo,
-    }
-
-    @product_name ||= product
-    browser = launcher.launch(options)
-    if block_given?
-      begin
-        yield(browser)
-      ensure
-        browser.close
-      end
-    else
-      browser
-    end
-  end
-
-  # @param browser_ws_endpoint [String]
-  # @param browser_url [String]
-  # @param transport [Puppeteer::WebSocketTransport]
-  # @param ignore_https_errors [Boolean]
-  # @param default_viewport [Puppeteer::Viewport|nil]
-  # @param slow_mo [Integer]
-  # @return [Puppeteer::Browser]
-  def connect(
-    browser_ws_endpoint: nil,
-    browser_url: nil,
-    transport: nil,
-    ignore_https_errors: nil,
-    default_viewport: nil,
-    slow_mo: nil
-  )
-    options = {
-      browser_ws_endpoint: browser_ws_endpoint,
-      browser_url: browser_url,
-      transport: transport,
-      ignore_https_errors: ignore_https_errors,
-      default_viewport: default_viewport,
-      slow_mo: slow_mo,
-    }.compact
-    browser = launcher.connect(options)
-    if block_given?
-      begin
-        yield(browser)
-      ensure
-        browser.disconnect
-      end
-    else
-      browser
-    end
-  end
-
-  # @return [String]
-  def executable_path
-    launcher.executable_path
-  end
-
-  private def launcher
-    @launcher ||= Puppeteer::Launcher.new(
-      project_root: @project_root,
-      preferred_revision: @preferred_revision,
-      is_puppeteer_core: @is_puppeteer_core,
-      product: @product_name,
-    )
-  end
-
-  # @return [String]
-  def product
-    launcher.product
-  end
-
-  # @return [Puppeteer::Devices]
-  def devices
-    Puppeteer::Devices
-  end
-
-  # # @return {Object}
-  # def errors
-  #   # ???
-  # end
-
-  # @param args [Array<String>]
-  # @param user_data_dir [String]
-  # @param devtools [Boolean]
-  # @param headless [Boolean]
-  # @return [Array<String>]
-  def default_args(args: nil, user_data_dir: nil, devtools: nil, headless: nil)
-    options = {
-      args: args,
-      user_data_dir: user_data_dir,
-      devtools: devtools,
-      headless: headless,
-    }.compact
-    launcher.default_args(options)
-  end
-
-  # @param {!BrowserFetcher.Options=} options
-  # @return {!BrowserFetcher}
-  def createBrowserFetcher(options = {})
-    BrowserFetcher.new(@project_root, options)
-  end
 end

data/lib/puppeteer/browser_runner.rb

@@ -111,7 +111,7 @@ class Puppeteer::BrowserRunner
       end
     end
 
-    if @launch_options.handle_SIGHUP?
+    if @launch_options.handle_SIGHUP? && !Puppeteer.env.windows?
       trap(:HUP) do
         close
       end

data/lib/puppeteer/connection.rb

@@ -273,6 +273,16 @@ class Puppeteer::Connection
   def create_session(target_info)
     result = send_message('Target.attachToTarget', targetId: target_info.target_id, flatten: true)
     session_id = result['sessionId']
-    @sessions[session_id]
+
+    # 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
   end
 end

data/lib/puppeteer/dom_world.rb

@@ -126,12 +126,13 @@ class Puppeteer::DOMWorld
     execution_context.evaluate(page_function, *args)
   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)
-    document.S(selector)
+  def query_selector(selector)
+    document.query_selector(selector)
   end
+  alias_method :S, :query_selector
 
   private def evaluate_document
     # sometimes execution_context.evaluate_handle('document') returns null object.
@@ -158,30 +159,33 @@ class Puppeteer::DOMWorld
     document.Sx(expression)
   end
 
-  # `$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)
-    document.Seval(selector, page_function, *args)
+  def eval_on_selector(selector, page_function, *args)
+    document.eval_on_selector(selector, page_function, *args)
   end
+  alias_method :Seval, :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)
-    document.SSeval(selector, page_function, *args)
+  def eval_on_selector_all(selector, page_function, *args)
+    document.eval_on_selector_all(selector, page_function, *args)
   end
+  alias_method :SSeval, :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)
-    document.SS(selector)
+  def query_selector_all(selector)
+    document.query_selector_all(selector)
   end
+  alias_method :SS, :query_selector_all
 
   # @return [String]
   def content
@@ -226,144 +230,127 @@ class Puppeteer::DOMWorld
     end
   end
 
-  # /**
-  #  * @param {!{url?: string, path?: string, content?: string, type?: string}} options
-  #  * @return {!Promise<!Puppeteer.ElementHandle>}
-  #  */
-  # async addScriptTag(options) {
-  #   const {
-  #     url = null,
-  #     path = null,
-  #     content = null,
-  #     type = ''
-  #   } = options;
-  #   if (url !== null) {
-  #     try {
-  #       const context = await this.executionContext();
-  #       return (await context.evaluateHandle(addScriptUrl, url, type)).asElement();
-  #     } catch (error) {
-  #       throw new Error(`Loading script from ${url} failed`);
-  #     }
-  #   }
-
-  #   if (path !== null) {
-  #     let contents = await readFileAsync(path, 'utf8');
-  #     contents += '//# sourceURL=' + path.replace(/\n/g, '');
-  #     const context = await this.executionContext();
-  #     return (await context.evaluateHandle(addScriptContent, contents, type)).asElement();
-  #   }
-
-  #   if (content !== null) {
-  #     const context = await this.executionContext();
-  #     return (await context.evaluateHandle(addScriptContent, content, type)).asElement();
-  #   }
-
-  #   throw new Error('Provide an object with a `url`, `path` or `content` property');
-
-  #   /**
-  #    * @param {string} url
-  #    * @param {string} type
-  #    * @return {!Promise<!HTMLElement>}
-  #    */
-  #   async function addScriptUrl(url, type) {
-  #     const script = document.createElement('script');
-  #     script.src = url;
-  #     if (type)
-  #       script.type = type;
-  #     const promise = new Promise((res, rej) => {
-  #       script.onload = res;
-  #       script.onerror = rej;
-  #     });
-  #     document.head.appendChild(script);
-  #     await promise;
-  #     return script;
-  #   }
-
-  #   /**
-  #    * @param {string} content
-  #    * @param {string} type
-  #    * @return {!HTMLElement}
-  #    */
-  #   function addScriptContent(content, type = 'text/javascript') {
-  #     const script = document.createElement('script');
-  #     script.type = type;
-  #     script.text = content;
-  #     let error = null;
-  #     script.onerror = e => error = e;
-  #     document.head.appendChild(script);
-  #     if (error)
-  #       throw error;
-  #     return script;
-  #   }
-  # }
+  # @param url [String?]
+  # @param path [String?]
+  # @param content [String?]
+  # @param type [String?]
+  def add_script_tag(url: nil, path: nil, content: nil, type: nil)
+    if url
+      begin
+        return execution_context.
+          evaluate_handle(ADD_SCRIPT_URL, url, type || '').
+          as_element
+      rescue Puppeteer::ExecutionContext::EvaluationError # for Chrome
+        raise "Loading script from #{url} failed"
+      rescue Puppeteer::Connection::ProtocolError # for Firefox
+        raise "Loading script from #{url} failed"
+      end
+    end
 
-  # /**
-  #  * @param {!{url?: string, path?: string, content?: string}} options
-  #  * @return {!Promise<!Puppeteer.ElementHandle>}
-  #  */
-  # async addStyleTag(options) {
-  #   const {
-  #     url = null,
-  #     path = null,
-  #     content = null
-  #   } = options;
-  #   if (url !== null) {
-  #     try {
-  #       const context = await this.executionContext();
-  #       return (await context.evaluateHandle(addStyleUrl, url)).asElement();
-  #     } catch (error) {
-  #       throw new Error(`Loading style from ${url} failed`);
-  #     }
-  #   }
-
-  #   if (path !== null) {
-  #     let contents = await readFileAsync(path, 'utf8');
-  #     contents += '/*# sourceURL=' + path.replace(/\n/g, '') + '*/';
-  #     const context = await this.executionContext();
-  #     return (await context.evaluateHandle(addStyleContent, contents)).asElement();
-  #   }
-
-  #   if (content !== null) {
-  #     const context = await this.executionContext();
-  #     return (await context.evaluateHandle(addStyleContent, content)).asElement();
-  #   }
-
-  #   throw new Error('Provide an object with a `url`, `path` or `content` property');
-
-  #   /**
-  #    * @param {string} url
-  #    * @return {!Promise<!HTMLElement>}
-  #    */
-  #   async function addStyleUrl(url) {
-  #     const link = document.createElement('link');
-  #     link.rel = 'stylesheet';
-  #     link.href = url;
-  #     const promise = new Promise((res, rej) => {
-  #       link.onload = res;
-  #       link.onerror = rej;
-  #     });
-  #     document.head.appendChild(link);
-  #     await promise;
-  #     return link;
-  #   }
-
-  #   /**
-  #    * @param {string} content
-  #    * @return {!Promise<!HTMLElement>}
-  #    */
-  #   async function addStyleContent(content) {
-  #     const style = document.createElement('style');
-  #     style.type = 'text/css';
-  #     style.appendChild(document.createTextNode(content));
-  #     const promise = new Promise((res, rej) => {
-  #       style.onload = res;
-  #       style.onerror = rej;
-  #     });
-  #     document.head.appendChild(style);
-  #     await promise;
-  #     return style;
-  #   }
-  # }
+    if path
+      contents = File.read(path)
+      contents += "//# sourceURL=#{path.gsub(/\n/, '')}"
+      return execution_context.
+        evaluate_handle(ADD_SCRIPT_CONTENT, contents, type || '').
+        as_element
+    end
+
+    if content
+      return execution_context.
+        evaluate_handle(ADD_SCRIPT_CONTENT, content, type || '').
+        as_element
+    end
+
+    raise ArgumentError.new('Provide an object with a `url`, `path` or `content` property')
+  end
+
+  ADD_SCRIPT_URL = <<~JAVASCRIPT
+  async (url, type) => {
+    const script = document.createElement('script');
+    script.src = url;
+    if (type)
+      script.type = type;
+    const promise = new Promise((res, rej) => {
+      script.onload = res;
+      script.onerror = rej;
+    });
+    document.head.appendChild(script);
+    await promise;
+    return script;
+  }
+  JAVASCRIPT
+
+  ADD_SCRIPT_CONTENT = <<~JAVASCRIPT
+  (content, type) => {
+    if (type === undefined) type = 'text/javascript';
+    const script = document.createElement('script');
+    script.type = type;
+    script.text = content;
+    let error = null;
+    script.onerror = e => error = e;
+    document.head.appendChild(script);
+    if (error)
+      throw error;
+    return script;
+  }
+  JAVASCRIPT
+
+  # @param url [String?]
+  # @param path [String?]
+  # @param content [String?]
+  def add_style_tag(url: nil, path: nil, content: nil)
+    if url
+      begin
+        return execution_context.evaluate_handle(ADD_STYLE_URL, url).as_element
+      rescue Puppeteer::ExecutionContext::EvaluationError # for Chrome
+        raise "Loading style from #{url} failed"
+      rescue Puppeteer::Connection::ProtocolError # for Firefox
+        raise "Loading style from #{url} failed"
+      end
+    end
+
+    if path
+      contents = File.read(path)
+      contents += "/*# sourceURL=#{path.gsub(/\n/, '')}*/"
+      return execution_context.evaluate_handle(ADD_STYLE_CONTENT, contents).as_element
+    end
+
+    if content
+      return execution_context.evaluate_handle(ADD_STYLE_CONTENT, content).as_element
+    end
+
+    raise ArgumentError.new('Provide an object with a `url`, `path` or `content` property')
+  end
+
+  ADD_STYLE_URL = <<~JAVASCRIPT
+    async (url) => {
+      const link = document.createElement('link');
+      link.rel = 'stylesheet';
+      link.href = url;
+      const promise = new Promise((res, rej) => {
+        link.onload = res;
+        link.onerror = rej;
+      });
+      document.head.appendChild(link);
+      await promise;
+      return link;
+    }
+  JAVASCRIPT
+
+  ADD_STYLE_CONTENT = <<~JAVASCRIPT
+    async (content) => {
+      const style = document.createElement('style');
+      style.type = 'text/css';
+      style.appendChild(document.createTextNode(content));
+      const promise = new Promise((res, rej) => {
+        style.onload = res;
+        style.onerror = rej;
+      });
+      document.head.appendChild(style);
+      await promise;
+      return style;
+    }
+  JAVASCRIPT
 
   class ElementNotFoundError < StandardError
     def initialize(selector)
@@ -376,14 +363,14 @@ class Puppeteer::DOMWorld
   # @param button [String] "left"|"right"|"middle"
   # @param click_count [Number]
   def click(selector, delay: nil, button: nil, click_count: nil)
-    handle = S(selector) or raise ElementNotFoundError.new(selector)
+    handle = query_selector(selector) or raise ElementNotFoundError.new(selector)
     handle.click(delay: delay, button: button, click_count: click_count)
     handle.dispose
   end
 
   # @param selector [String]
   def focus(selector)
-    handle = S(selector) or raise ElementNotFoundError.new(selector)
+    handle = query_selector(selector) or raise ElementNotFoundError.new(selector)
     handle.focus
     handle.dispose
   end
@@ -401,7 +388,7 @@ class Puppeteer::DOMWorld
   # @param selector [String]
   # @return [Array<String>]
   def select(selector, *values)
-    handle = S(selector) or raise ElementNotFoundError.new(selector)
+    handle = query_selector(selector) or raise ElementNotFoundError.new(selector)
     result = handle.select(*values)
     handle.dispose
 
@@ -410,7 +397,7 @@ class Puppeteer::DOMWorld
 
   # @param selector [String]
   def tap(selector)
-    handle = S(selector) or raise ElementNotFoundError.new(selector)
+    handle = query_selector(selector) or raise ElementNotFoundError.new(selector)
     handle.tap
     handle.dispose
   end
@@ -419,7 +406,7 @@ class Puppeteer::DOMWorld
   # @param text [String]
   # @param delay [Number]
   def type_text(selector, text, delay: nil)
-    handle = S(selector) or raise ElementNotFoundError.new(selector)
+    handle = query_selector(selector) or raise ElementNotFoundError.new(selector)
     handle.type_text(text, delay: delay)
     handle.dispose
   end