percy-selenium 1.0.2 → 1.1.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d5089e6a2652952602feef700b0e9aa1a1345ef6c8b464c2c85646e8a36679
-  data.tar.gz: 2c9a17360becb96df488b8ae678172a89bad4ffbb596b05cf560e9a0a66fbcd6
+  metadata.gz: 84e0ed534fb2da64081b19d4c0b13e837e4c8800d3ed12e61c4e827e80c94e70
+  data.tar.gz: 8785427dd5e88ba487e55d14b3c0d634680737eee895971dd742e81efe7a3aca
 SHA512:
-  metadata.gz: bca3d0f5ebce8d35f9bffc7727b8af1b42c5fb19c30b6a578a1ff7573b50e5d3613f26885227f3d906c8cd5b7677302af4cb31b20ae0651564a61fc7c5f784b4
-  data.tar.gz: 0f6631b9d1ca037ff738c59ff5a8d3fd9abecde33a71b4bbae266748bd00b8269bb0cc9ed4c674bcc646fde837a8bcfa370b06d3b150165c6a0f5faf4f4a6789
+  metadata.gz: d6d71138d3d1267f8924858ee6f94a6a9969e3ce5b4e377d0f484194c5b595e99124f74a24e30761c611a730ee78f08b8542b51870c74b1c90d318935bdf2352
+  data.tar.gz: 9ece4fe3dd36379e07bc1024a3cc35aa005ab9fad3aedd42f26ed16e58b2bfee4445ce95adb71780a0cc2b3f38be2a519028d6c597ef7c16c911967809f15108

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,7 +11,7 @@ assignees: ''
 
 There are common setup gotchas that happen with Percy's SDKs, it would be worth reading
 the debugging document, which might already answer your question:
-https://docs.percy.io/docs/debugging-sdk
+https://www.browserstack.com/docs/percy/integrate/percy-sdk-workflow#debugging-sdks
 
 ## Reach out to Percy support instead?
 
@@ -43,7 +43,7 @@ If necessary, describe the problem you have been experiencing in more detail.
 ## Debug logs
 
 If you are reporting a bug, _always_ include logs! [Give the "Debugging SDKs"
-document a quick read for how to gather logs](https://docs.percy.io/docs/debugging-sdks#debugging-sdks)
+document a quick read for how to gather logs](https://www.browserstack.com/docs/percy/integrate/percy-sdk-workflow#debugging-sdks)
 
 Please do not trim or edit these logs, often times there are hints in the full
 logs that help debug what is going on.

data/README.md

@@ -61,4 +61,4 @@ $ percy exec -- [ruby test command]
 
 - `driver` (**required**) - A selenium-webdriver driver instance
 - `name` (**required**) - The snapshot name; must be unique to each snapshot
-- `options` - [See per-snapshot configuration options](https://docs.percy.io/docs/cli-configuration#per-snapshot-configuration)
+- `options` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)

data/lib/percy.rb

@@ -11,6 +11,7 @@ module Percy
   PERCY_DEBUG = ENV['PERCY_LOGLEVEL'] == 'debug'
   PERCY_SERVER_ADDRESS = ENV['PERCY_SERVER_ADDRESS'] || 'http://localhost:5338'
   LABEL = "[\u001b[35m" + (PERCY_DEBUG ? 'percy:ruby' : 'percy') + "\u001b[39m]"
+  RESONSIVE_CAPTURE_SLEEP_TIME = ENV['RESONSIVE_CAPTURE_SLEEP_TIME']
 
   # Take a DOM snapshot and post it to the snapshot endpoint
   def self.snapshot(driver, name, options = {})
@@ -18,7 +19,11 @@ module Percy
 
     begin
       driver.execute_script(fetch_percy_dom)
-      dom_snapshot = driver.execute_script("return PercyDOM.serialize(#{options.to_json})")
+      dom_snapshot = if responsive_snapshot_capture?(options)
+        capture_responsive_dom(driver, options)
+      else
+        get_serialized_dom(driver, options)
+      end
 
       response = fetch('percy/snapshot',
         name: name,
@@ -36,9 +41,96 @@ module Percy
       body['data']
     rescue StandardError => e
       log("Could not take DOM snapshot '#{name}'")
+      log(e, 'debug')
+    end
+  end
+
+  def self.get_browser_instance(driver)
+    if driver.is_a?(Capybara::Session)
+      return driver.driver.browser.manage
+    end
+
+    driver.manage
+  end
+
+  def self.get_serialized_dom(driver, options)
+    dom_snapshot = driver.execute_script("return PercyDOM.serialize(#{options.to_json})")
+
+    dom_snapshot['cookies'] = get_browser_instance(driver).all_cookies
+    dom_snapshot
+  end
+
+  def self.get_widths_for_multi_dom(options)
+    user_passed_widths = options[:widths] || []
+
+    # Deep copy mobile widths otherwise it will get overridden
+    all_widths = @eligible_widths['mobile']&.dup || []
+    if user_passed_widths.any?
+      all_widths.concat(user_passed_widths)
+    else
+      all_widths.concat(@eligible_widths['config'] || [])
+    end
+
+    all_widths.uniq
+  end
+
+  def self.change_window_dimension_and_wait(driver, width, height, resize_count)
+    begin
+      if driver.capabilities.browser_name == 'chrome' && driver.respond_to?(:execute_cdp)
+        driver.execute_cdp('Emulation.setDeviceMetricsOverride', {
+                             height: height, width: width, deviceScaleFactor: 1, mobile: false,
+                           },)
+      else
+        get_browser_instance(driver).window.resize_to(width, height)
+      end
+    rescue StandardError => e
+      log("Resizing using cdp failed, falling back to driver for width #{width} #{e}", 'debug')
+      get_browser_instance(driver).window.resize_to(width, height)
+    end
+
+    begin
+      wait = Selenium::WebDriver::Wait.new(timeout: 1)
+      wait.until { driver.execute_script('return window.resizeCount') == resize_count }
+    rescue Selenium::WebDriver::Error::TimeoutError
+      log("Timed out waiting for window resize event for width #{width}", 'debug')
+    end
+  end
+
+  def self.capture_responsive_dom(driver, options)
+    widths = get_widths_for_multi_dom(options)
+    dom_snapshots = []
+    window_size = get_browser_instance(driver).window.size
+    current_width = window_size.width
+    current_height = window_size.height
+    last_window_width = current_width
+    resize_count = 0
+    driver.execute_script('PercyDOM.waitForResize()')
+
+    widths.each do |width|
+      if last_window_width != width
+        resize_count += 1
+        change_window_dimension_and_wait(driver, width, current_height, resize_count)
+        last_window_width = width
+      end
 
-      if PERCY_DEBUG then log(e) end
+      sleep(RESONSIVE_CAPTURE_SLEEP_TIME.to_i) if defined?(RESONSIVE_CAPTURE_SLEEP_TIME)
+
+      dom_snapshot = get_serialized_dom(driver, options)
+      dom_snapshot['width'] = width
+      dom_snapshots << dom_snapshot
     end
+
+    change_window_dimension_and_wait(driver, current_width, current_height, resize_count + 1)
+    dom_snapshots
+  end
+
+  def self.responsive_snapshot_capture?(options)
+    # Don't run responsive snapshot capture when defer uploads is enabled
+    return false if @cli_config&.dig('percy', 'deferUploads')
+
+    options[:responsive_snapshot_capture] ||
+      options[:responsiveSnapshotCapture] ||
+      @cli_config&.dig('snapshot', 'responsiveSnapshotCapture')
   end
 
   # Determine if the Percy server is running, caching the result so it is only checked once
@@ -53,7 +145,7 @@ module Percy
         log('You may be using @percy/agent ' \
             'which is no longer supported by this SDK. ' \
             'Please uninstall @percy/agent and install @percy/cli instead. ' \
-            'https://docs.percy.io/docs/migrating-to-percy-cli')
+            'https://www.browserstack.com/docs/percy/migration/migrate-to-cli')
         @percy_enabled = false
         return false
       end
@@ -64,12 +156,14 @@ module Percy
         return false
       end
 
+      response_body = JSON.parse(response.body)
+      @eligible_widths = response_body['widths']
+      @cli_config = response_body['config']
       @percy_enabled = true
       true
     rescue StandardError => e
       log('Percy is not running, disabling snapshots')
-
-      if PERCY_DEBUG then log(e) end
+      log(e, 'debug')
       @percy_enabled = false
       false
     end
@@ -83,8 +177,19 @@ module Percy
     @percy_dom = response.body
   end
 
-  def self.log(msg)
-    puts "#{LABEL} #{msg}"
+  def self.log(msg, lvl = 'info')
+    msg = "#{LABEL} #{msg}"
+    begin
+      fetch('percy/log', {message: msg, level: lvl})
+    rescue StandardError => e
+      if PERCY_DEBUG
+        puts "Sending log to CLI Failed #{e}"
+      end
+    ensure
+      if lvl != 'debug' || PERCY_DEBUG
+        puts msg
+      end
+    end
   end
 
   # Make an HTTP request (GET,POST) using Ruby's Net::HTTP. If `data` is present,
@@ -112,5 +217,7 @@ module Percy
   def self._clear_cache!
     @percy_dom = nil
     @percy_enabled = nil
+    @eligible_widths = nil
+    @cli_config = nil
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Percy
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0-beta.1'.freeze
 end

data/package.json

@@ -1,10 +1,9 @@
 {
-    "private": true,
-    "scripts": {
-      "test": "percy exec --testing -- bundle exec rspec"
-    },
-    "devDependencies": {
-      "@percy/cli": "^1.28.0"
-    }
+  "private": true,
+  "scripts": {
+    "test": "percy exec --testing -- bundle exec rspec"
+  },
+  "devDependencies": {
+    "@percy/cli": "^1.29.5-beta.0"
   }
-  
+}

data/spec/lib/percy/percy_spec.rb

@@ -1,7 +1,23 @@
 # rubocop:disable RSpec/MultipleDescribes
 RSpec.describe Percy, type: :feature do
+  dom_string = "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>"
+  fetch_script_string = 'window.PercyDOM = {' \
+  'serialize: () => {' \
+    'return {' \
+      'html: document.documentElement.outerHTML,' \
+      'cookies: ""' \
+    '}' \
+  '},' \
+  'waitForResize: () => {' \
+    'if(!window.resizeCount) {' \
+      'window.addEventListener(\'resize\', () => window.resizeCount++)' \
+    '}' \
+    'window.resizeCount = 0;' \
+  '}};'
+
   before(:each) do
     WebMock.disable_net_connect!(allow: '127.0.0.1', disallow: 'localhost')
+    stub_request(:post, 'http://localhost:5338/percy/log').to_raise(StandardError)
     Percy._clear_cache!
   end
 
@@ -23,7 +39,7 @@ RSpec.describe Percy, type: :feature do
           "#{Percy::LABEL} You may be using @percy/agent which" \
           ' is no longer supported by this SDK. Please uninstall' \
           ' @percy/agent and install @percy/cli instead.' \
-          " https://docs.percy.io/docs/migrating-to-percy-cli\n",
+          " https://www.browserstack.com/docs/percy/migration/migrate-to-cli\n",
         ).to_stdout
     end
 
@@ -59,12 +75,13 @@ RSpec.describe Percy, type: :feature do
 
     it 'logs an error  when sending a snapshot fails' do
       stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
-        .to_return(status: 200, body: '', headers: {'x-percy-core-version': '1.0.0'})
+        .to_return(status: 200, body: '{"success": "true" }',
+                   headers: {'x-percy-core-version': '1.0.0'},)
 
       stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/dom.js")
         .to_return(
           status: 200,
-          body: 'window.PercyDOM = { serialize: () => document.documentElement.outerHTML };',
+          body: fetch_script_string,
           headers: {},
         )
 
@@ -77,12 +94,14 @@ RSpec.describe Percy, type: :feature do
 
     it 'sends snapshots to the local server' do
       stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
-        .to_return(status: 200, body: '', headers: {'x-percy-core-version': '1.0.0'})
+        .to_return(status: 200, body: '{"success": "true" }', headers: {
+                     'x-percy-core-version': '1.0.0',
+                   },)
 
       stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/dom.js")
         .to_return(
           status: 200,
-          body: 'window.PercyDOM = { serialize: () => document.documentElement.outerHTML };',
+          body: fetch_script_string,
           headers: {},
         )
 
@@ -98,7 +117,7 @@ RSpec.describe Percy, type: :feature do
             name: 'Name',
             url: 'http://127.0.0.1:3003/index.html',
             dom_snapshot:
-              "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>",
+              {"cookies": [], "html": dom_string},
             client_info: "percy-selenium-ruby/#{Percy::VERSION}",
             environment_info: "selenium/#{Selenium::WebDriver::VERSION} ruby/#{RUBY_VERSION}",
             widths: [944],
@@ -108,14 +127,106 @@ RSpec.describe Percy, type: :feature do
       expect(data).to eq(nil)
     end
 
+    it 'sends multiple dom snapshots to the local server' do
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck").to_return(
+        status: 200,
+        body: '{"success": "true", "widths": { "mobile": [390], "config": [765, 1280]} }',
+        headers: {
+          'x-percy-core-version': '1.0.0',
+          'config': {}, 'widths': {'mobile': [375], 'config': [765, 1280]},
+        },
+      )
+
+      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: {})
+
+      visit 'index.html'
+      data = Percy.snapshot(page, 'Name', {responsive_snapshot_capture: true})
+
+      expect(WebMock).to have_requested(:post, "#{Percy::PERCY_SERVER_ADDRESS}/percy/snapshot")
+        .with(
+          body: {
+            name: 'Name',
+            url: 'http://127.0.0.1:3003/index.html',
+            dom_snapshot: [
+              {'cookies': [], 'html': dom_string, 'width': 390},
+              {'cookies': [], 'html': dom_string, 'width': 765},
+              {'cookies': [], 'html': dom_string, 'width': 1280},
+            ],
+            client_info: "percy-selenium-ruby/#{Percy::VERSION}",
+            environment_info: "selenium/#{Selenium::WebDriver::VERSION} ruby/#{RUBY_VERSION}",
+            responsive_snapshot_capture: true,
+          }.to_json,
+        ).once
+
+      expect(data).to eq(nil)
+    end
+
+    it 'sends multiple dom snapshots to the local server using selenium' do
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck").to_return(
+        status: 200,
+        body: '{"success": "true", "widths": { "mobile": [390], "config": [765, 1280]} }',
+        headers: {
+          'x-percy-core-version': '1.0.0',
+          'config': {}, 'widths': {'mobile': [375], 'config': [765, 1280]},
+        },
+      )
+
+      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: {})
+
+      driver = Selenium::WebDriver.for :firefox
+
+      driver.navigate.to 'http://localhost:5338/test/snapshot'
+      driver.manage.add_cookie({name: 'cookie-name', value: 'cookie-value'})
+      data = Percy.snapshot(driver, 'Name', {responsive_snapshot_capture: true})
+
+      expected_cookie = {name: 'cookie-name', value: 'cookie-value', path: '/',
+                         domain: 'localhost', "expires": nil, "same_site": 'Lax',
+                         "http_only": false, "secure": false,}
+      expected_dom = '<html><head></head><body><p>Snapshot Me!</p></body></html>'
+      expect(WebMock).to have_requested(:post, "#{Percy::PERCY_SERVER_ADDRESS}/percy/snapshot")
+        .with(
+          body: {
+            name: 'Name',
+            url: 'http://localhost:5338/test/snapshot',
+            dom_snapshot: [
+              {'cookies': [expected_cookie], 'html': expected_dom, 'width': 390},
+              {'cookies': [expected_cookie], 'html': expected_dom, 'width': 765},
+              {'cookies': [expected_cookie], 'html': expected_dom, 'width': 1280},
+            ],
+            client_info: "percy-selenium-ruby/#{Percy::VERSION}",
+            environment_info: "selenium/#{Selenium::WebDriver::VERSION} ruby/#{RUBY_VERSION}",
+            responsive_snapshot_capture: true,
+          }.to_json,
+        ).once
+
+      expect(data).to eq(nil)
+    end
+
     it 'sends snapshots for sync' do
       stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
-        .to_return(status: 200, body: '', headers: {'x-percy-core-version': '1.0.0'})
+        .to_return(status: 200, body: '{"success": "true" }',
+                   headers: {'x-percy-core-version': '1.0.0'},)
 
       stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/dom.js")
         .to_return(
           status: 200,
-          body: 'window.PercyDOM = { serialize: () => document.documentElement.outerHTML };',
+          body: fetch_script_string,
           headers: {},
         )
 
@@ -131,10 +242,10 @@ RSpec.describe Percy, type: :feature do
             name: 'Name',
             url: 'http://127.0.0.1:3003/index.html',
             dom_snapshot:
-              "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>",
+            {'cookies' => [], 'html' => dom_string},
             client_info: "percy-selenium-ruby/#{Percy::VERSION}",
             environment_info: "selenium/#{Selenium::WebDriver::VERSION} ruby/#{RUBY_VERSION}",
-            widths: [944],
+            sync: true,
           }.to_json,
         ).once
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-selenium
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0.pre.beta.1
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -145,11 +145,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Percy visual testing for Ruby Selenium