percy-selenium 1.1.3.pre.beta.1 → 1.1.4.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 599af2bc8ab99bf3bb74f396232a4be8a6fd7cac209f9a159a5a2e9850581139
-  data.tar.gz: 38a4b597b1ed391675bc6ce07e6bba7b6820691ecf969a84bfd98a8609b4de50
+  metadata.gz: 964b34504d72f46df90ac38f0c122efb350e6a46673899855cbf668523d93349
+  data.tar.gz: 7f2cbab4d9f0228ce5b29d24601a04dea8f11dfb2a359dea52eddfe741463c85
 SHA512:
-  metadata.gz: 8d0dbb6269542d41b36883985f7ffd390b5d74595752a7604eceaf26dda0503817b15fc3b129f24f3ec2f64e46715b8fc9a2768390e07ec53f22a57a43c1fe89
-  data.tar.gz: f0960498a183952e6f7fdc7c9a8d5a84125bffa11ac34e3f5b4ba781ec9bd3596c45e07b11a39120723e8e35884eb1288d44e7bf1bd9506f667e926600ebc9da
+  metadata.gz: e4914dc15a922d03df46fa24a68576d89e784314d9e40c55b1dd3f3e2b32a746a94eca1e55c7f54a204046a3a98c13954d3e29200ebfbae8fe8f49c7e9d5fc74
+  data.tar.gz: b562acce5038bbaf57e50767d6c9a1cf10e19beabe46f97686576e427071a37492ea0b90b9936dec6ad7c9e5ee9c545283ae766744d79290984c82c17cb664d5

data/.github/workflows/test.yml

@@ -51,16 +51,25 @@ jobs:
       - run: yarn
       - name: Set up @percy/cli from git
         if: ${{ github.event_name == 'workflow_dispatch' }}
+        env:
+          BRANCH: ${{ github.event.inputs.branch }}
         run: |
           cd /tmp
-          git clone --branch ${{ github.event.inputs.branch }} --depth 1 https://github.com/percy/cli
+          git clone --branch "$BRANCH" --depth 1 https://github.com/percy/cli
           cd cli
           PERCY_PACKAGES=`find packages -mindepth 1 -maxdepth 1 -type d | sed -e 's/packages/@percy/g' | tr '\n' ' '`
           git log -1
           yarn
           yarn build
           yarn global:link
-          cd ${{ github.workspace }} 
-          yarn remove @percy/cli && yarn link `echo $PERCY_PACKAGES`
-          npx percy --version
+          # Expose the freshly built `percy` on PATH. yarn link symlinks the
+          # package but not its bin, so `npx percy` would miss it and download
+          # the unrelated public `percy`. Link is best-effort; PATH is what
+          # makes percy resolvable.
+          echo "$(yarn global bin)" >> "$GITHUB_PATH"
+          export PATH="$(yarn global bin):$PATH"
+          cd ${{ github.workspace }}
+          yarn remove @percy/cli >/dev/null 2>&1 || true
+          yarn link `echo $PERCY_PACKAGES` >/dev/null 2>&1 || true
+          percy --version
       - run: npx percy exec --testing -- bundle exec rspec

data/lib/percy.rb

@@ -66,6 +66,25 @@ module Percy
     region
   end
 
+  # Recursively convert all Hash keys (at every nesting level) to symbols so
+  # config (string keys from JSON) and per-call options (symbol keys) merge on
+  # consistent keys. Arrays are walked; scalars are returned as-is.
+  def self.deep_symbolize(obj)
+    case obj
+    when Hash then obj.each_with_object({}) { |(k, v), h| h[k.to_sym] = deep_symbolize(v) }
+    when Array then obj.map { |e| deep_symbolize(e) }
+    else obj
+    end
+  end
+
+  # Deep-merge `override` onto `base`: nested Hashes merge recursively, while
+  # arrays and scalars from `override` replace those in `base`.
+  def self.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
+
   def self.snapshot(driver, name, options = {})
     return unless percy_enabled?
 
@@ -79,10 +98,20 @@ module Percy
     begin
       percy_dom_script = fetch_percy_dom
       driver.execute_script(percy_dom_script)
-      dom_snapshot = if responsive_snapshot_capture?(options)
-        capture_responsive_dom(driver, options, percy_dom_script: percy_dom_script)
+
+      # Merge .percy.yml config options with snapshot options (snapshot options take priority)
+      config_options = @cli_config&.dig('snapshot') || {}
+      # Config keys are strings (JSON parse); per-call options use symbols, as
+      # do downstream consumers (responsive_snapshot_capture?, capture_responsive_dom).
+      # Deep-symbolize both sides so nested keys are consistent, then deep-merge
+      # so nested Hashes merge recursively (per-call wins at leaves; arrays/scalars
+      # replace) instead of a shallow top-level overwrite dropping config siblings.
+      merged_options = deep_merge_options(deep_symbolize(config_options), deep_symbolize(options))
+
+      dom_snapshot = if responsive_snapshot_capture?(merged_options)
+        capture_responsive_dom(driver, merged_options, percy_dom_script: percy_dom_script)
       else
-        get_serialized_dom(driver, options, percy_dom_script: percy_dom_script)
+        get_serialized_dom(driver, merged_options, percy_dom_script: percy_dom_script)
       end
 
       # Strip `readiness` before POSTing -- SDK-local config that the CLI

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Percy
-  VERSION = '1.1.3-beta.1'.freeze
+  VERSION = '1.1.4-beta.1'.freeze
 end

data/spec/lib/percy/percy_spec.rb

@@ -342,6 +342,85 @@ RSpec.describe Percy, type: :feature do
 
       expect(data).to eq('sync_data')
     end
+
+    it 'merges .percy.yml config with per-snapshot options (per-call wins)' do
+      # Healthcheck returns a config whose `snapshot` block carries a
+      # config-only key (enableJavaScript) and a percyCSS value that the
+      # per-snapshot call will override.
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
+        .to_return(
+          status: 200,
+          body: {
+            success: true,
+            config: {'snapshot' => {'enableJavaScript' => true, 'percyCSS' => 'FROM_CONFIG'}},
+          }.to_json,
+          headers: {'x-percy-core-version': '1.0.0'},
+        )
+
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/dom.js")
+        .to_return(status: 200, body: fetch_script_string, headers: {})
+
+      stub_request(:post, 'http://localhost:5338/percy/snapshot')
+        .to_return(status: 200, body: '{"success":true}', headers: {})
+
+      # Capture the argument passed to PercyDOM.serialize so we can assert how
+      # config and per-call options were merged before serialization.
+      captured_serialize_call = nil
+      allow(page).to receive(:execute_script).and_wrap_original do |original, script, *args|
+        captured_serialize_call = script if script.to_s.include?('PercyDOM.serialize')
+        original.call(script, *args)
+      end
+
+      visit 'index.html'
+      Percy.snapshot(page, 'Name', percyCSS: 'FROM_CALL')
+
+      expect(captured_serialize_call).to_not be_nil
+      serialized = JSON.parse(captured_serialize_call[/PercyDOM\.serialize\((.*)\)/m, 1])
+      # Config-only key still reaches serialize...
+      expect(serialized['enableJavaScript']).to eq(true)
+      # ...and the per-call option wins over the config value.
+      expect(serialized['percyCSS']).to eq('FROM_CALL')
+    end
+
+    it 'deep-merges nested config and per-snapshot options (sibling kept, leaf overridden)' do
+      # Config `snapshot` block carries a nested `discovery` hash; the per-call
+      # discovery only overrides one leaf, so the sibling key must survive.
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
+        .to_return(
+          status: 200,
+          body: {
+            success: true,
+            config: {
+              'snapshot' => {
+                'discovery' => {'networkIdleTimeout' => 50, 'disableCache' => false},
+              },
+            },
+          }.to_json,
+          headers: {'x-percy-core-version': '1.0.0'},
+        )
+
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/dom.js")
+        .to_return(status: 200, body: fetch_script_string, headers: {})
+
+      stub_request(:post, 'http://localhost:5338/percy/snapshot')
+        .to_return(status: 200, body: '{"success":true}', headers: {})
+
+      captured_serialize_call = nil
+      allow(page).to receive(:execute_script).and_wrap_original do |original, script, *args|
+        captured_serialize_call = script if script.to_s.include?('PercyDOM.serialize')
+        original.call(script, *args)
+      end
+
+      visit 'index.html'
+      Percy.snapshot(page, 'Name', discovery: {disableCache: true})
+
+      expect(captured_serialize_call).to_not be_nil
+      serialized = JSON.parse(captured_serialize_call[/PercyDOM\.serialize\((.*)\)/m, 1])
+      # Sibling from config survives; per-call leaf overrides the config value.
+      expect(serialized['discovery']).to eq(
+        'networkIdleTimeout' => 50, 'disableCache' => true,
+      )
+    end
   end
 end
 

data/spec/spec_helper.rb

@@ -35,8 +35,35 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 
   # See https://github.com/teamcapybara/capybara#selecting-the-driver for other options
-  Capybara.default_driver = :selenium_headless
-  Capybara.javascript_driver = :selenium_headless
+  # Default to Firefox headless (matches CI), but when a Chromium/Chrome binary is
+  # provided via CHROME_BIN (e.g. the containerised e2e image), register and use a
+  # headless Chrome driver pointing at it instead.
+  if ENV['CHROME_BIN'] && !ENV['CHROME_BIN'].empty?
+    Capybara.register_driver :selenium_chrome_headless_bin do |app|
+      options = Selenium::WebDriver::Chrome::Options.new
+      options.binary = ENV['CHROME_BIN']
+      options.add_argument('--headless=new')
+      options.add_argument('--no-sandbox')
+      options.add_argument('--disable-gpu')
+      options.add_argument('--disable-dev-shm-usage')
+      Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+    end
+    Capybara.default_driver = :selenium_chrome_headless_bin
+    Capybara.javascript_driver = :selenium_chrome_headless_bin
+  else
+    Capybara.default_driver = :selenium_headless
+    Capybara.javascript_driver = :selenium_headless
+  end
+
+  # Capybara's built-in :selenium_headless driver still passes `options:` to
+  # driver init, which newer selenium-webdriver logs as a [DEPRECATION]
+  # [:browser_options] warning on first use. The suite asserts exact stdout
+  # via `output(...).to_stdout`, so any example that first boots the driver
+  # inside such a block fails on that extra line (seed-dependent). Silence
+  # just that deprecation id.
+  if Selenium::WebDriver.logger.respond_to?(:ignore)
+    Selenium::WebDriver.logger.ignore(:browser_options)
+  end
 
   # Setup for Capybara to test Jekyll static files served by Rack
   Capybara.server_port = 3003

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: percy-selenium
 version: !ruby/object:Gem::Version
-  version: 1.1.3.pre.beta.1
+  version: 1.1.4.pre.beta.1
 platform: ruby
 authors:
 - Perceptual Inc.