percy-capybara 5.0.1.pre.1 → 5.0.1.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b09892a41c8741ae0fc2df13506fea8cf230eed9378c88959e162d472e45920a
-  data.tar.gz: ad15f33efc210f01b3c41bb22105ccd1d09b789ab1ab17aa598c9184ddcd8b1f
+  metadata.gz: 55183f20f35bdf96129984ea3eafb21f484bf7d8abd648a07a5da0f9cbed8b20
+  data.tar.gz: 9f2338e88239dcb83767bfa8c0edac9a8e0cbe311c341fa2a43f0540dee295d7
 SHA512:
-  metadata.gz: cd030fd64faa05dd1bb59d75003615280ad8aa53eec6d295843b2b750b9ae298a4ee2171ffd291c3571af57a9feff127c45a2ea6deb02b77fc78bdcb6ab0ecd3
-  data.tar.gz: cda536b6071654fe1be5e359bf72c737c303fdb23822f863796d6163959ca5b5e4e4b609a4f5d2348111147f050c9323e5e49be517fa67a38d189f04aa3067e4
+  metadata.gz: 5638fbbfc7505c07fa32a638a415f8ff0dc46ffcdb4d74695800158e8ee85ec011eea3cee429495baf24f34aba256b370e2cc73f0c7c6369a72a143ee638780f
+  data.tar.gz: 51aa201e617f53d1e75592cb64f4920f7c1717966e5f990b12c977b819fca7a37a7a812e7e100c727f1d96fd61da63800ea3666f99d21e1e17bb1920a8b60581

data/lib/percy/capybara.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'net/http'
 require 'uri'
 require 'capybara/dsl'
@@ -14,6 +15,12 @@ module PercyCapybara
   private_constant :CLIENT_INFO
   private_constant :ENV_INFO
 
+  UNSUPPORTED_IFRAME_SRCS = %w[
+    about:blank about:srcdoc javascript: data: blob: vbscript: chrome: chrome-extension:
+  ].freeze
+
+  private_constant :UNSUPPORTED_IFRAME_SRCS
+
   # Take a DOM snapshot and post it to the snapshot endpoint
   def percy_snapshot(name, options = {})
     return unless percy_enabled?
@@ -21,6 +28,9 @@ module PercyCapybara
     page = Capybara.current_session
 
     begin
+      percy_dom_script = fetch_percy_dom
+      page.evaluate_script(percy_dom_script)
+      dom_snapshot = get_serialized_dom(page, options, percy_dom_script)
       page.evaluate_script(fetch_percy_dom)
 
       # Readiness gate -- runs before serialize when CLI supports it.
@@ -29,8 +39,14 @@ module PercyCapybara
       # older CLIs that lack waitForReady.
       readiness_diagnostics = wait_for_ready(page, options)
 
+      # Merge .percy.yml config options with snapshot options (snapshot options take priority).
+      # Deep merge with consistent string keys at all levels: nested Hashes merge
+      # recursively, per-call wins at leaves, arrays/scalars replace.
+      config_options = @cli_config&.dig('snapshot') || {}
+      merged_options = deep_merge_options(config_options, deep_stringify(options))
+
       dom_snapshot = page
-        .evaluate_script("(function() { return PercyDOM.serialize(#{options.to_json}) })()")
+        .evaluate_script("(function() { return PercyDOM.serialize(#{merged_options.to_json}) })()")
 
       if readiness_diagnostics && dom_snapshot.is_a?(Hash)
         dom_snapshot['readiness_diagnostics'] = readiness_diagnostics
@@ -44,7 +60,16 @@ module PercyCapybara
         environment_info: ENV_INFO,
         **options,)
 
-      unless response.body.to_json['success']
+      data =
+        begin
+          JSON.parse(response.body)
+        rescue JSON::ParserError => e
+          log("Could not parse snapshot response for '#{name}': invalid JSON")
+          if PERCY_DEBUG then log(e) end
+          return
+        end
+
+      unless data['success']
         raise StandardError, data['error']
       end
     rescue StandardError => e
@@ -54,6 +79,135 @@ module PercyCapybara
     end
   end
 
+  private def get_serialized_dom(page, options, percy_dom_script)
+    dom_snapshot = page
+      .evaluate_script("(function() { return PercyDOM.serialize(#{options.to_json}) })()")
+
+    driver = page.driver.browser
+    begin
+      page_origin = get_origin(page.current_url)
+      iframes = driver.find_elements(:tag_name, 'iframe')
+      log("Found #{iframes.length} total iframe(s) on page") if PERCY_DEBUG
+
+      processed_frames = []
+      iframes.each do |frame|
+        frame_src = frame.attribute('src')
+
+        if unsupported_iframe_src?(frame_src)
+          log("Skipping unsupported iframe src: #{frame_src}") if PERCY_DEBUG && frame_src
+          next
+        end
+
+        begin
+          frame_origin = get_origin(URI.join(page.current_url, frame_src).to_s)
+        rescue StandardError => e
+          log("Skipping iframe with invalid URL \"#{frame_src}\": #{e}") if PERCY_DEBUG
+          next
+        end
+
+        if frame_origin == page_origin
+          log("Skipping same-origin iframe: #{frame_src}") if PERCY_DEBUG
+          next
+        end
+
+        # Pre-flight check: avoid the switch/serialize round-trip if there's no
+        # data-percy-element-id, since process_frame would discard the snapshot
+        # anyway and we'd silently waste a frame switch.
+        unless frame.attribute('data-percy-element-id')
+          log("Skipping iframe #{frame_src}: no data-percy-element-id found") if PERCY_DEBUG
+          next
+        end
+
+        result = process_frame(driver, frame, options, percy_dom_script)
+        processed_frames << result if result
+      end
+
+      if processed_frames.any?
+        dom_snapshot['corsIframes'] = processed_frames
+        log("Captured #{processed_frames.length} cross-origin iframe(s)")
+      end
+    rescue StandardError => e
+      log("Failed to process cross-origin iframes: #{e}") if PERCY_DEBUG
+      begin
+        driver.switch_to.default_content
+      rescue StandardError
+        nil
+      end
+    end
+
+    dom_snapshot
+  end
+
+  private def unsupported_iframe_src?(src)
+    return true if src.nil? || src.empty?
+
+    UNSUPPORTED_IFRAME_SRCS.any? { |prefix| src == prefix || src.start_with?(prefix) }
+  end
+
+  private def get_origin(url)
+    uri = URI.parse(url)
+    raise URI::InvalidURIError, "no host in #{url}" if uri.host.nil?
+
+    default_ports = {'http' => 80, 'https' => 443}
+    netloc = uri.host.to_s
+    netloc += ":#{uri.port}" if uri.port && uri.port != default_ports[uri.scheme]
+    "#{uri.scheme}://#{netloc}"
+  end
+
+  private def process_frame(driver, frame_element, options, percy_dom_script)
+    frame_url = frame_element.attribute('src') || 'unknown-src'
+    log("Processing cross-origin iframe: #{frame_url}") if PERCY_DEBUG
+
+    begin
+      driver.switch_to.frame(frame_element)
+      begin
+        driver.execute_script(percy_dom_script)
+        iframe_options = options.merge('enableJavaScript' => true)
+        iframe_snapshot =
+          driver.execute_script("return PercyDOM.serialize(#{iframe_options.to_json})")
+        log("Serialized cross-origin iframe: #{frame_url}") if PERCY_DEBUG
+      rescue StandardError => e
+        log("Failed to serialize cross-origin iframe #{frame_url}: #{e}") if PERCY_DEBUG
+        return nil
+      ensure
+        begin
+          driver.switch_to.default_content
+        rescue StandardError
+          begin
+            driver.switch_to.parent_frame
+          rescue StandardError
+            nil
+          end
+        end
+      end
+    rescue StandardError => e
+      log("Failed to switch to frame #{frame_url}: #{e}") if PERCY_DEBUG
+      begin
+        driver.switch_to.default_content
+      rescue StandardError
+        nil
+      end
+      return nil
+    end
+
+    percy_element_id = frame_element.attribute('data-percy-element-id')
+    unless percy_element_id
+      log("Skipping frame #{frame_url}: no data-percy-element-id found") if PERCY_DEBUG
+      return nil
+    end
+
+    if PERCY_DEBUG
+      log("Successfully captured cross-origin iframe: #{frame_url} " \
+          "(percyElementId: #{percy_element_id})")
+    end
+
+    {
+      'iframeData' => {'percyElementId' => percy_element_id},
+      'iframeSnapshot' => iframe_snapshot,
+      'frameUrl' => frame_url,
+    }
+  end
+
   # Determine if the Percy server is running, caching the result so it is only checked once
   private def percy_enabled?
     return @percy_enabled unless @percy_enabled.nil?
@@ -77,6 +231,8 @@ module PercyCapybara
         return false
       end
 
+      body = response.body.to_s.empty? ? {} : JSON.parse(response.body)
+      @cli_config = body['config'] || {}
       @percy_enabled = true
       true
     rescue StandardError => e
@@ -129,6 +285,24 @@ module PercyCapybara
     end
   end
 
+  # Recursively stringify all Hash keys so per-call options match the
+  # string-keyed config parsed from .percy.yml JSON at every nesting level.
+  private def deep_stringify(obj)
+    case obj
+    when Hash then obj.each_with_object({}) { |(k, v), h| h[k.to_s] = deep_stringify(v) }
+    when Array then obj.map { |e| deep_stringify(e) }
+    else obj
+    end
+  end
+
+  # Deep-merge two string-keyed Hashes: nested Hashes merge recursively,
+  # per-call (override) wins at the leaves, arrays/scalars replace.
+  private def deep_merge_options(base, override)
+    base.merge(override) do |_key, old_val, new_val|
+      old_val.is_a?(Hash) && new_val.is_a?(Hash) ? deep_merge_options(old_val, new_val) : new_val
+    end
+  end
+
   private def log(msg)
     puts "#{PERCY_LABEL} #{msg}"
   end

data/lib/percy/version.rb

@@ -1,3 +1,3 @@
 module PercyCapybara
-  VERSION = '5.0.1.pre.1'.freeze
+  VERSION = '5.0.1.pre.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 5.0.1.pre.1
+  version: 5.0.1.pre.3
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-04 00:00:00.000000000 Z
+date: 2026-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara