feat: Add ability to connect to iframe targets

Author: route

lib/ferrum/browser/options/chrome.rb

@@ -78,7 +78,7 @@ def merge_required(flags, options, user_data_dir)
         def merge_default(flags, options)
           defaults = except("headless", "disable-gpu") if options.headless == false
           defaults ||= DEFAULT_OPTIONS
-          # On Windows, the --disable-gpu flag is a temporary work around for a few bugs.
+          # On Windows, the --disable-gpu flag is a temporary workaround for a few bugs.
           # See https://bugs.chromium.org/p/chromium/issues/detail?id=737678 for more information.
           defaults = defaults.merge("disable-gpu" => nil) if Utils::Platform.windows?
           # Use Metal on Apple Silicon

lib/ferrum/context.rb

@@ -13,7 +13,7 @@ def initialize(client, contexts, id)
       @client = client
       @contexts = contexts
       @targets = Concurrent::Map.new
-      @pendings = Concurrent::MVar.new
+      @pendings = Concurrent::Map.new
     end
 
     def default_target
@@ -29,7 +29,7 @@ def pages
     end
 
     # When we call `page` method on target it triggers ruby to connect to given
-    # page by WebSocket, if there are many opened windows but we need only one
+    # page by WebSocket, if there are many opened windows, but we need only one
     # it makes more sense to get and connect to the needed one only which
     # usually is the last one.
     def windows(pos = nil, size = 1)
@@ -46,19 +46,26 @@ def create_page(**options)
     end
 
     def create_target
-      @client.command("Target.createTarget", browserContextId: @id, url: "about:blank")
-      target = @pendings.take(@client.timeout)
-      raise NoSuchTargetError unless target.is_a?(Target)
+      target_id = @client.command("Target.createTarget", browserContextId: @id, url: "about:blank")["targetId"]
 
-      target
+      new_pending = Concurrent::IVar.new
+      pending = @pendings.put_if_absent(target_id, new_pending) || new_pending
+      resolved = pending.value(@client.timeout)
+      raise NoSuchTargetError unless resolved
+
+      @pendings.delete(target_id)
+      @targets[target_id]
     end
 
     def add_target(params:, session_id: nil)
       new_target = Target.new(@client, session_id, params)
-      target = @targets.put_if_absent(new_target.id, new_target)
-      target ||= new_target # `put_if_absent` returns nil if added a new value or existing if there was one already
-      @pendings.put(target, @client.timeout) if @pendings.empty?
-      target
+      # `put_if_absent` returns nil if added a new value or existing if there was one already
+      target = @targets.put_if_absent(new_target.id, new_target) || new_target
+
+      new_pending = Concurrent::IVar.new
+      pending = @pendings.put_if_absent(target.id, new_pending) || new_pending
+      pending.try_set(true)
+      true
     end
 
     def update_target(target_id, params)
@@ -69,6 +76,21 @@ def delete_target(target_id)
       @targets.delete(target_id)
     end
 
+    def attach_target(target_id)
+      target = @targets[target_id]
+      raise NoSuchTargetError unless target
+
+      session = @client.command("Target.attachToTarget", targetId: target_id, flatten: true)
+      target.session_id = session["sessionId"]
+      true
+    end
+
+    def find_target
+      @targets.each_value { |t| return t if yield(t) }
+
+      nil
+    end
+
     def close_targets_connection
       @targets.each_value do |target|
         next unless target.connected?

lib/ferrum/contexts.rb

@@ -70,7 +70,7 @@ def size
     def subscribe
       @client.on("Target.attachedToTarget") do |params|
         info, session_id = params.values_at("targetInfo", "sessionId")
-        next unless info["type"] == "page"
+        next unless %w[page iframe].include?(info["type"])
 
         context_id = info["browserContextId"]
         @contexts[context_id]&.add_target(session_id: session_id, params: info)
@@ -81,15 +81,21 @@ def subscribe
 
       @client.on("Target.targetCreated") do |params|
         info = params["targetInfo"]
-        next unless info["type"] == "page"
+        next unless %w[page iframe].include?(info["type"])
 
         context_id = info["browserContextId"]
-        @contexts[context_id]&.add_target(params: info)
+
+        if info["type"] == "iframe" &&
+           (target = @contexts[context_id].find_target { |t| t.connected? && t.page.frame_by(id: info["targetId"]) })
+          @contexts[context_id]&.add_target(session_id: target.page.client.session_id, params: info)
+        else
+          @contexts[context_id]&.add_target(params: info)
+        end
       end
 
       @client.on("Target.targetInfoChanged") do |params|
         info = params["targetInfo"]
-        next unless info["type"] == "page"
+        next unless %w[page iframe].include?(info["type"])
 
         context_id, target_id = info.values_at("browserContextId", "targetId")
         @contexts[context_id]&.update_target(target_id, info)

lib/ferrum/target.rb

@@ -8,7 +8,8 @@ class Target
     # where we enhance page class and build page ourselves.
     attr_writer :page
 
-    attr_reader :session_id, :options
+    attr_reader :options
+    attr_accessor :session_id
 
     def initialize(browser_client, session_id = nil, params = nil)
       @page = nil
@@ -67,11 +68,19 @@ def window?
       !!opener_id
     end
 
+    def iframe?
+      type == "iframe"
+    end
+
     def maybe_sleep_if_new_window
       # Dirty hack because new window doesn't have events at all
       sleep(NEW_WINDOW_WAIT) if window?
     end
 
+    def command(...)
+      client.command(...)
+    end
+
     private
 
     def build_client