require 'thread' require 'timeout' class Puppeteer::Browser include Puppeteer::DebugPrint include Puppeteer::EventCallbackable include Puppeteer::IfPresent using Puppeteer::DefineAsyncMethod # @param product [String|nil] 'chrome' or 'firefox' # @param {!Puppeteer.Connection} connection # @param {!Array} contextIds # @param {boolean} ignoreHTTPSErrors # @param {?Puppeteer.Viewport} defaultViewport # @param process [Puppeteer::BrowserRunner::BrowserProcess|NilClass] # @param {function()=} closeCallback def self.create(product:, connection:, context_ids:, ignore_https_errors:, default_viewport:, process:, close_callback:, target_filter_callback:, is_page_target_callback:) browser = Puppeteer::Browser.new( product: product, connection: connection, context_ids: context_ids, ignore_https_errors: ignore_https_errors, default_viewport: default_viewport, process: process, close_callback: close_callback, target_filter_callback: target_filter_callback, is_page_target_callback: is_page_target_callback, ) browser.send(:attach) browser end # @param product [String|nil] 'chrome' or 'firefox' # @param {!Puppeteer.Connection} connection # @param {!Array} contextIds # @param {boolean} ignoreHTTPSErrors # @param {?Puppeteer.Viewport} defaultViewport # @param {?Puppeteer.ChildProcess} process # @param {(function():Promise)=} closeCallback def initialize(product:, connection:, context_ids:, ignore_https_errors:, default_viewport:, process:, close_callback:, target_filter_callback:, is_page_target_callback:) @product = product || 'chrome' @ignore_https_errors = ignore_https_errors @default_viewport = default_viewport @process = process @connection = connection @close_callback = close_callback @target_filter_callback = target_filter_callback || method(:default_target_filter_callback) @is_page_target_callback = is_page_target_callback || method(:default_is_page_target_callback) @default_context = Puppeteer::BrowserContext.new(@connection, self, nil) @contexts = {} context_ids.each do |context_id| @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id) end if @product == 'firefox' @target_manager = Puppeteer::FirefoxTargetManager.new( connection: connection, target_factory: method(:create_target), target_filter_callback: @target_filter_callback, ) else @target_manager = Puppeteer::ChromeTargetManager.new( connection: connection, target_factory: method(:create_target), target_filter_callback: @target_filter_callback, ) end end private def default_target_filter_callback(target_info) true end private def default_is_page_target_callback(target_info) ['page', 'background_page', 'webview'].include?(target_info.type) end attr_reader :is_page_target_callback # @param event_name [Symbol] either of :disconnected, :targetcreated, :targetchanged, :targetdestroyed def on(event_name, &block) unless BrowserEmittedEvents.values.include?(event_name.to_s) raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}") end super(event_name.to_s, &block) end # @param event_name [Symbol] def once(event_name, &block) unless BrowserEmittedEvents.values.include?(event_name.to_s) raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}") end super(event_name.to_s, &block) end private def attach @connection_event_listeners ||= [] @connection_event_listeners << @connection.add_event_listener(ConnectionEmittedEvents::Disconnected) do emit_event(BrowserEmittedEvents::Disconnected) end @target_manager_event_listeners ||= [] @target_manager.add_event_listener( TargetManagerEmittedEvents::TargetAvailable, &method(:handle_attached_to_target) ) @target_manager.add_event_listener( TargetManagerEmittedEvents::TargetGone, &method(:handle_detached_from_target) ) @target_manager.add_event_listener( TargetManagerEmittedEvents::TargetChanged, &method(:handle_target_changed) ) @target_manager.add_event_listener( TargetManagerEmittedEvents::TargetDiscovered, &method(:handle_target_discovered) ) @target_manager.init end private def detach @connection.remove_event_listener(*@connection_event_listeners) @target_manager.remove_event_listener(*@target_manager_event_listeners) end # @return [Puppeteer::BrowserRunner::BrowserProcess] def process @process end private def target_manager @target_manager end # @return [Puppeteer::BrowserContext] def create_incognito_browser_context result = @connection.send_message('Target.createBrowserContext') browser_context_id = result['browserContextId'] @contexts[browser_context_id] = Puppeteer::BrowserContext.new(@connection, self, browser_context_id) end def browser_contexts [@default_context].concat(@contexts.values) end # @return [Puppeteer::BrowserContext] def default_browser_context @default_context end # @param context_id [String] def dispose_context(context_id) return unless context_id @connection.send_message('Target.disposeBrowserContext', browserContextId: context_id) @contexts.delete(context_id) end class MissingBrowserContextError < StandardError ; end # @param target_info [Puppeteer::Target::TargetInfo] # @param session [CDPSession|nil] def create_target(target_info, session) browser_context_id = target_info.browser_context_id context = if browser_context_id && @contexts.has_key?(browser_context_id) @contexts[browser_context_id] else @default_context end unless context raise MissingBrowserContextError.new('Missing browser context') end Puppeteer::Target.new( target_info: target_info, session: session, browser_context: context, target_manager: @target_manager, session_factory: -> { @connection.create_session(target_info) }, ignore_https_errors: @ignore_https_errors, default_viewport: @default_viewport, is_page_target_callback: @is_page_target_callback, ) end private def handle_attached_to_target(target) if target.initialized_promise.value! emit_event(BrowserEmittedEvents::TargetCreated, target) target.browser_context.emit_event(BrowserContextEmittedEvents::TargetCreated, target) end end private def handle_detached_from_target(target) target.ignore_initialize_callback_promise target.closed_callback if target.initialized_promise.value! emit_event(BrowserEmittedEvents::TargetDestroyed, target) target.browser_context.emit_event(BrowserContextEmittedEvents::TargetDestroyed, target) end end private def handle_target_changed(target, target_info) previous_url = target.url was_initialized = target.initialized? target.handle_target_info_changed(target_info) if was_initialized && previous_url != target.url emit_event(BrowserEmittedEvents::TargetChanged, target) target.browser_context.emit_event(BrowserContextEmittedEvents::TargetChanged, target) end end private def handle_target_discovered(target_info) emit_event('targetdiscovered', target_info) end # @return [String] def ws_endpoint @connection.url end def new_page @default_context.new_page end class MissingTargetError < StandardError ; end class CreatePageError < StandardError ; end # @param {?string} contextId # @return {!Promise} def create_page_in_context(context_id) create_target_params = { url: 'about:blank', browserContextId: context_id, }.compact result = @connection.send_message('Target.createTarget', **create_target_params) target_id = result['targetId'] target = @target_manager.available_targets[target_id] unless target raise MissingTargetError.new("Missing target for page (id = #{target_id})") end unless target.initialized_promise.value! raise CreatePageError.new("Failed to create target for page (id = #{target_id})") end page = target.page unless page raise CreatePageError.new("Failed to create a page for context (id = #{context_id})") end page end # All active targets inside the Browser. In case of multiple browser contexts, returns # an array with all the targets in all browser contexts. def targets @target_manager.available_targets.values.select { |target| target.initialized? } end # The target associated with the browser. def target targets.find { |target| target.type == 'browser' } or raise 'Browser target is not found' end # used only in Target#opener private def find_target_by_id(target_id) @target_manager.available_targets[target_id] end # @param predicate [Proc(Puppeteer::Target -> Boolean)] # @return [Puppeteer::Target] def wait_for_target(predicate:, timeout: nil) timeout_helper = Puppeteer::TimeoutHelper.new('target', timeout_ms: timeout, default_timeout_ms: 30000) existing_target = targets.find { |target| predicate.call(target) } return existing_target if existing_target event_listening_ids = [] target_promise = resolvable_future event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetCreated) do |target| if predicate.call(target) target_promise.fulfill(target) end end event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetChanged) do |target| if predicate.call(target) target_promise.fulfill(target) end end begin timeout_helper.with_timeout do target_promise.value! end ensure remove_event_listener(*event_listening_ids) end end # @!method async_wait_for_target(predicate:, timeout: nil) # # @param predicate [Proc(Puppeteer::Target -> Boolean)] define_async_method :async_wait_for_target # @return {!Promise>} def pages browser_contexts.flat_map(&:pages) end # @return [String] def version Version.fetch(@connection).product end # @return [String] def user_agent Version.fetch(@connection).user_agent end def close @close_callback.call disconnect end def disconnect @target_manager.dispose @connection.dispose end def connected? !@connection.closed? end class Version def self.fetch(connection) new(connection.send_message('Browser.getVersion')) end def initialize(hash) @protocol_version = hash['protocolVersion'] @product = hash['product'] @revision = hash['revision'] @user_agent = hash['userAgent'] @js_version = hash['jsVersion'] end attr_reader :protocol_version, :product, :revision, :user_agent, :js_version end end