puppeteer-ruby 0.0.12 → 0.0.17

data/lib/puppeteer/emulation_manager.rb

@@ -1,5 +1,5 @@
 class Puppeteer::EmulationManager
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.CDPSession} client
   def initialize(client)
@@ -38,9 +38,5 @@ class Puppeteer::EmulationManager
     reload_needed
   end
 
-  # @param viewport [Puppeteer::Viewport]
-  # @return [Future<true|false>]
-  async def async_emulate_viewport(viewport)
-    emulate_viewport(viewport)
-  end
+  define_async_method :async_emulate_viewport
 end

data/lib/puppeteer/env.rb

@@ -0,0 +1,18 @@
+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
+end
+
+class Puppeteer
+  def self.env
+    Puppeteer::Env.new
+  end
+end

data/lib/puppeteer/execution_context.rb

@@ -1,6 +1,6 @@
 class Puppeteer::ExecutionContext
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   EVALUATION_SCRIPT_URL = '__puppeteer_evaluation_script__'
   SOURCE_URL_REGEX = /^[\040\t]*\/\/[@#] sourceURL=\s*(\S*?)\s*$/m
@@ -16,11 +16,6 @@ class Puppeteer::ExecutionContext
 
   attr_reader :client, :world
 
-  # only used in DomWorld#delete_context
-  def _context_id
-    @context_id
-  end
-
   # @return [Puppeteer::Frame]
   def frame
     if_present(@world) do |world|

data/lib/puppeteer/frame.rb

@@ -1,5 +1,5 @@
 class Puppeteer::Frame
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!FrameManager} frameManager
   # @param {!Puppeteer.CDPSession} client
@@ -39,12 +39,7 @@ class Puppeteer::Frame
     @frame_manager.wait_for_frame_navigation(self, timeout: timeout, wait_until: wait_until)
   end
 
-  # @param timeout [number|nil]
-  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @return [Future]
-  async def async_wait_for_navigation(timeout: nil, wait_until: nil)
-    wait_for_navigation(timeout: timeout, wait_until: wait_until)
-  end
+  define_async_method :async_wait_for_navigation
 
   def execution_context
     @main_world.execution_context
@@ -56,12 +51,16 @@ class Puppeteer::Frame
     @main_world.evaluate_handle(page_function, *args)
   end
 
+  define_async_method :async_evaluate_handle
+
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   def evaluate(page_function, *args)
     @main_world.evaluate(page_function, *args)
   end
 
+  define_async_method :async_evaluate
+
   # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<?Puppeteer.ElementHandle>}
@@ -69,6 +68,7 @@ class Puppeteer::Frame
     @main_world.S(selector)
   end
 
+  define_async_method :async_S
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -77,6 +77,7 @@ class Puppeteer::Frame
     @main_world.Sx(expression)
   end
 
+  define_async_method :async_Sx
 
   # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
@@ -87,6 +88,8 @@ class Puppeteer::Frame
     @main_world.Seval(selector, page_function, *args)
   end
 
+  define_async_method :async_Seval
+
   # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @param {Function|string} pageFunction
@@ -96,6 +99,8 @@ class Puppeteer::Frame
     @main_world.SSeval(selector, page_function, *args)
   end
 
+  define_async_method :async_SSeval
+
   # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
@@ -103,12 +108,16 @@ class Puppeteer::Frame
     @main_world.SS(selector)
   end
 
+  define_async_method :async_SS
+
+  # @return [String]
   def content
     @secondary_world.content
   end
 
-  # @param {string} html
-  # @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
+  # @param html [String]
+  # @param timeout [Integer]
+  # @param wait_until [String|Array<String>]
   def set_content(html, timeout: nil, wait_until: nil)
     @secondary_world.set_content(html, timeout: timeout, wait_until: wait_until)
   end
@@ -152,15 +161,6 @@ class Puppeteer::Frame
     @main_world.add_style_tag(style_tag)
   end
 
-  # @param selector [String]
-  # @param delay [Number]
-  # @param button [String] "left"|"right"|"middle"
-  # @param click_count [Number]
-  # @return [Future]
-  async def async_click(selector, delay: nil, button: nil, click_count: nil)
-    click(selector, delay: delay, button: button, click_count: click_count)
-  end
-
   # @param selector [String]
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
@@ -169,11 +169,15 @@ class Puppeteer::Frame
     @secondary_world.click(selector, delay: delay, button: button, click_count: click_count)
   end
 
+  define_async_method :async_click
+
   # @param {string} selector
   def focus(selector)
     @secondary_world.focus(selector)
   end
 
+  define_async_method :async_focus
+
   # @param {string} selector
   def hover(selector)
     @secondary_world.hover(selector)
@@ -186,11 +190,15 @@ class Puppeteer::Frame
     @secondary_world.select(selector, *values)
   end
 
+  define_async_method :async_select
+
   # @param {string} selector
   def tap(selector)
     @secondary_world.tap(selector)
   end
 
+  define_async_method :async_tap
+
   # @param selector [String]
   # @param text [String]
   # @param delay [Number]
@@ -198,27 +206,7 @@ class Puppeteer::Frame
     @main_world.type_text(selector, text, delay: delay)
   end
 
-  # /**
-  #  * @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)));
-  # }
+  define_async_method :async_type_text
 
   # @param selector [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
@@ -235,6 +223,8 @@ class Puppeteer::Frame
     result
   end
 
+  define_async_method :async_wait_for_selector
+
   # @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.
@@ -250,6 +240,8 @@ class Puppeteer::Frame
     result
   end
 
+  define_async_method :async_wait_for_xpath
+
   # @param {Function|string} pageFunction
   # @param {!{polling?: string|number, timeout?: number}=} options
   # @param {!Array<*>} args
@@ -258,6 +250,9 @@ class Puppeteer::Frame
     @main_world.wait_for_function(page_function, options, *args)
   end
 
+  define_async_method :async_wait_for_function
+
+  # @return [String]
   def title
     @secondary_world.title
   end

data/lib/puppeteer/frame_manager.rb

@@ -4,7 +4,7 @@ class Puppeteer::FrameManager
   include Puppeteer::DebugPrint
   include Puppeteer::IfPresent
   include Puppeteer::EventCallbackable
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   UTILITY_WORLD_NAME = '__puppeteer_utility_world__'
 
@@ -23,7 +23,6 @@ class Puppeteer::FrameManager
 
     # @type {!Map<number, !ExecutionContext>}
     @context_id_to_context = {}
-    @context_id_created = {}
 
     # @type {!Set<string>}
     @isolated_worlds = Set.new
@@ -74,9 +73,7 @@ class Puppeteer::FrameManager
     @network_manager.init
   end
 
-  async def async_init
-    init
-  end
+  define_async_method :async_init
 
   attr_reader :network_manager
 
@@ -281,7 +278,7 @@ class Puppeteer::FrameManager
   # @param url [String]
   def handle_frame_navigated_within_document(frame_id, url)
     frame = @frames[frame_id]
-    return if !frame
+    return unless frame
     frame.navigated_within_document(url)
     emit_event 'Events.FrameManager.FrameNavigatedWithinDocument', frame
     emit_event 'Events.FrameManager.FrameNavigated', frame
@@ -320,44 +317,29 @@ class Puppeteer::FrameManager
       world.context = context
     end
     @context_id_to_context[context_payload['id']] = context
-    @context_id_created[context_payload['id']] = Time.now
   end
 
   # @param {number} executionContextId
   def handle_execution_context_destroyed(execution_context_id)
     context = @context_id_to_context[execution_context_id]
-    return if !context
+    return unless context
     @context_id_to_context.delete(execution_context_id)
-    @context_id_created.delete(execution_context_id)
     if context.world
       context.world.delete_context(execution_context_id)
     end
   end
 
   def handle_execution_contexts_cleared
-    # executionContextsCleared is often notified after executionContextCreated.
-    #   D, [2020-04-06T01:47:03.101227 #13823] DEBUG -- : RECV << {"method"=>"Runtime.executionContextCreated", "params"=>{"context"=>{"id"=>5, "origin"=>"https://github.com", "name"=>"", "auxData"=>{"isDefault"=>true, "type"=>"default", "frameId"=>"71C347B70848B89DDDEFAA8AB5B0BC92"}}}, "sessionId"=>"53F088EED260C28001D26A019F95D9E3"}
-    #   D, [2020-04-06T01:47:03.101439 #13823] DEBUG -- : RECV << {"method"=>"Page.frameNavigated", "params"=>{"frame"=>{"id"=>"71C347B70848B89DDDEFAA8AB5B0BC92", "loaderId"=>"80338225D035AC96BAE8F6D4E81C7D51", "url"=>"https://github.com/search?q=puppeteer", "securityOrigin"=>"https://github.com", "mimeType"=>"text/html"}}, "sessionId"=>"53F088EED260C28001D26A019F95D9E3"}
-    #   D, [2020-04-06T01:47:03.101325 #13823] DEBUG -- : RECV << {"method"=>"Target.targetInfoChanged", "params"=>{"targetInfo"=>{"targetId"=>"71C347B70848B89DDDEFAA8AB5B0BC92", "type"=>"page", "title"=>"https://github.com/search?q=puppeteer", "url"=>"https://github.com/search?q=puppeteer", "attached"=>true, "browserContextId"=>"AF37BC660284CE1552B4ECB147BE9305"}}}
-    #   D, [2020-04-06T01:47:03.101269 #13823] DEBUG -- : RECV << {"method"=>"Runtime.executionContextsCleared", "params"=>{}, "sessionId"=>"53F088EED260C28001D26A019F95D9E3"}
-    # it unexpectedly clears the created execution context.
-    # To avoid the problem, just skip recent created ids.
-    now = Time.now
-    context_ids_to_skip = @context_id_created.select { |k, v| now - v < 1 }.keys
-    @context_id_to_context.reject { |k, v| context_ids_to_skip.include?(k) }.each do |execution_context_id, context|
+    @context_id_to_context.each do |execution_context_id, context|
       if context.world
         context.world.delete_context(execution_context_id)
       end
     end
-    @context_id_to_context.select! { |k, v| context_ids_to_skip.include?(k) }
+    @context_id_to_context.clear
   end
 
   def execution_context_by_id(context_id)
-    context = @context_id_to_context[context_id]
-    if !context
-      raise "INTERNAL ERROR: missing context with id = #{context_id}"
-    end
-    context
+    @context_id_to_context[context_id] or raise "INTERNAL ERROR: missing context with id = #{context_id}"
   end
 
   # @param {!Frame} frame

data/lib/puppeteer/js_handle.rb

@@ -1,5 +1,5 @@
 class Puppeteer::JSHandle
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param context [Puppeteer::ExecutionContext]
   # @param remote_object [Puppeteer::RemoteObject]
@@ -46,11 +46,7 @@ class Puppeteer::JSHandle
     execution_context.evaluate(page_function, self, *args)
   end
 
-  # @param page_function [String]
-  # @return [Future<Object>]
-  async def async_evaluate(page_function, *args)
-    evaluate(page_function, *args)
-  end
+  define_async_method :async_evaluate
 
   # @param page_function [String]
   # @param args {Array<*>}
@@ -59,12 +55,7 @@ class Puppeteer::JSHandle
     execution_context.evaluate_handle(page_function, self, *args)
   end
 
-  # @param page_function [String]
-  # @param args {Array<*>}
-  # @return [Future<Puppeteer::JSHandle>]
-  async def async_evaluate_handle(page_function, *args)
-    evaluate_handle(page_function, *args)
-  end
+  define_async_method :async_evaluate_handle
 
   # /**
   #  * @param {string} propertyName

data/lib/puppeteer/keyboard.rb

@@ -2,7 +2,7 @@ require_relative './keyboard/key_description'
 require_relative './keyboard/us_keyboard_layout'
 
 class Puppeteer::Keyboard
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.CDPSession} client
   def initialize(client)
@@ -38,12 +38,7 @@ class Puppeteer::Keyboard
     @client.send_message('Input.dispatchKeyEvent', params)
   end
 
-  # @param key [String]
-  # @param text [String]
-  # @return [Future]
-  async def async_down(key, text: nil)
-    down(key, text)
-  end
+  define_async_method :async_down
 
   # @param {string} key
   # @return {number}
@@ -127,22 +122,14 @@ class Puppeteer::Keyboard
     )
   end
 
-  # @param key [String]
-  # @return [Future]
-  async def async_up(key)
-    up(key)
-  end
+  define_async_method :async_up
 
   # @param char [string]
   def send_character(char)
     @client.send_message('Input.insertText', text: char)
   end
 
-  # @param char [string]
-  # @return [Future]
-  async def async_send_character(char)
-    send_character(char)
-  end
+  define_async_method :async_send_character
 
   # @param text [String]
   # @return [Future]
@@ -159,25 +146,18 @@ class Puppeteer::Keyboard
     end
   end
 
-  # @param text [String]
-  # @return [Future]
-  async def async_type_text(text, delay: nil)
-    type_text(text, delay)
-  end
+  define_async_method :async_type_text
 
   # @param key [String]
+  # @param text [String]
   # @return [Future]
-  def press(key, delay: nil)
-    down(key)
+  def press(key, delay: nil, text: nil)
+    down(key, text: text)
     if delay
       sleep(delay.to_i / 1000.0)
     end
     up(key)
   end
 
-  # @param key [String]
-  # @return [Future]
-  async def async_press(key, delay: nil)
-    press(key, delay: delay)
-  end
+  define_async_method :async_press
 end

data/lib/puppeteer/launcher/chrome.rb

@@ -139,6 +139,7 @@ module Puppeteer::Launcher
       end
     end
 
+    # @return [DefaultArgs]
     def default_args(options = nil)
       if options.nil?
         @default_args ||= DefaultArgs.new(@chrome_arg_options)
@@ -147,8 +148,7 @@ module Puppeteer::Launcher
       end
     end
 
-    # @param {!(Launcher.BrowserOptions & {browserWSEndpoint?: string, browserURL?: string, transport?: !Puppeteer.ConnectionTransport})} options
-    # @return {!Promise<!Browser>}
+    # @return [Puppeteer::Browser]
     def connect(options = {})
       @browser_options = BrowserOptions.new(options)
       browser_ws_endpoint = options[:browser_ws_endpoint]
@@ -187,11 +187,13 @@ module Puppeteer::Launcher
 
     # @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
-      # );
+      require 'net/http'
+      uri = URI(browser_url)
+      uri.path = '/json/version'
+      response_body = Net::HTTP.get(uri)
+      json = JSON.parse(response_body)
+      connection_url = json['webSocketDebuggerUrl']
+      connect_with_browser_ws_endpoint(connection_url)
     end
 
     # @return [Puppeteer::Connection]