Merge pull request #252 from YusukeIwaki/split_connector_class

Introduce BrowserConnector
YusukeIwaki · Sep 12, 2022 · 1fff72d · 1fff72d
2 parents dc1c1e9 + fdcdcfc
commit 1fff72d
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 119 deletions.
diff --git a/lib/puppeteer.rb b/lib/puppeteer.rb
@@ -22,6 +22,7 @@ module Puppeteer; end
 require 'puppeteer/browser'
 require 'puppeteer/browser_context'
 require 'puppeteer/browser_runner'
+require 'puppeteer/browser_connector'
 require 'puppeteer/cdp_session'
 require 'puppeteer/chrome_target_manager'
 require 'puppeteer/connection'

diff --git a/lib/puppeteer/browser.rb b/lib/puppeteer/browser.rb
@@ -326,12 +326,12 @@ def pages
 
   # @return [String]
   def version
-    get_version.product
+    Version.fetch(@connection).product
   end
 
   # @return [String]
   def user_agent
-    get_version.user_agent
+    Version.fetch(@connection).user_agent
   end
 
   def close
@@ -349,6 +349,10 @@ def connected?
   end
 
   class Version
+    def self.fetch(connection)
+      new(connection.send_message('Browser.getVersion'))
+    end
+
     def initialize(hash)
       @protocol_version = hash['protocolVersion']
       @product = hash['product']
@@ -359,8 +363,4 @@ def initialize(hash)
 
     attr_reader :protocol_version, :product, :revision, :user_agent, :js_version
   end
-
-  private def get_version
-    Version.new(@connection.send_message('Browser.getVersion'))
-  end
 end
diff --git a/lib/puppeteer/browser_connector.rb b/lib/puppeteer/browser_connector.rb
@@ -0,0 +1,67 @@
+require_relative './browser'
+require_relative './launcher/browser_options'
+
+class Puppeteer::BrowserConnector
+  def initialize(options)
+    @browser_options = Puppeteer::Launcher::BrowserOptions.new(options)
+    @browser_ws_endpoint = options[:browser_ws_endpoint]
+    @browser_url = options[:browser_url]
+    @transport = options[:transport]
+  end
+
+  # @return [Puppeteer::Browser]
+  def connect_to_browser
+    version = Puppeteer::Browser::Version.fetch(connection)
+    product = version.product.downcase.include?('firefox') ? 'firefox' : 'chrome'
+
+    result = connection.send_message('Target.getBrowserContexts')
+    browser_context_ids = result['browserContextIds']
+
+    Puppeteer::Browser.create(
+      product: product,
+      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') },
+      target_filter_callback: @browser_options.target_filter,
+      is_page_target_callback: @browser_options.is_page_target,
+    )
+  end
+
+  private def connection
+    @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
+  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)
+    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]
+  private def connect_with_transport(transport)
+    Puppeteer::Connection.new('', transport, @browser_options.slow_mo)
+  end
+end
diff --git a/lib/puppeteer/launcher/chrome.rb b/lib/puppeteer/launcher/chrome.rb
@@ -182,62 +182,6 @@ def default_args(options = nil)
       DefaultArgs.new(ChromeArgOptions.new(options || {}))
     end
 
-    # @return [Puppeteer::Browser]
-    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(
-        product: product,
-        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') },
-        target_filter_callback: @browser_options.target_filter,
-        is_page_target_callback: @browser_options.is_page_target,
-      ).tap(&:pages)
-    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)
-      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]
-    private def connect_with_transport(transport)
-      Puppeteer::Connection.new('', transport, @browser_options.slow_mo)
-    end
-
     # @return {string}
     def executable_path(channel: nil)
       if channel

diff --git a/lib/puppeteer/launcher/firefox.rb b/lib/puppeteer/launcher/firefox.rb
@@ -107,62 +107,6 @@ def launch(options = {})
       browser
     end
 
-    # @return [Puppeteer::Browser]
-    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(
-        product: product,
-        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') },
-        target_filter_callback: nil,
-        is_page_target_callback: nil,
-      )
-    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)
-      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]
-    private def connect_with_transport(transport)
-      Puppeteer::Connection.new('', transport, @browser_options.slow_mo)
-    end
-
     # @return {string}
     def executable_path(channel: nil)
       if channel

diff --git a/lib/puppeteer/puppeteer.rb b/lib/puppeteer/puppeteer.rb
@@ -110,7 +110,7 @@ def connect(
       default_viewport: default_viewport,
       slow_mo: slow_mo,
     }.compact
-    browser = launcher.connect(options)
+    browser = Puppeteer::BrowserConnector.new(options).connect_to_browser
     if block_given?
       begin
         yield(browser)