Skip to content

Commit

Permalink
Lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@chinmay-browserstack
chinmay-browserstack committed Oct 1, 2024
1 parent 31696eb commit d9d0bf0
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 46 deletions.
59 changes: 30 additions & 29 deletions lib/percy.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ def self.snapshot(driver, name, options = {})

begin
driver.execute_script(fetch_percy_dom)
dom_snapshot = nil
if is_responsive_snapshot_capture?(options)
dom_snapshot = capture_responsive_dom(driver, options)
dom_snapshot = if responsive_snapshot_capture?(options)
capture_responsive_dom(driver, options)
else
dom_snapshot = get_serialized_dom(driver, options)
get_serialized_dom(driver, options)
end

response = fetch('percy/snapshot',
Expand All @@ -42,15 +41,16 @@ def self.snapshot(driver, name, options = {})
body['data']
rescue StandardError => e
log("Could not take DOM snapshot '#{name}'")
log(e, "debug")
log(e, 'debug')
end
end

def self.get_browser_instance(driver)
if driver.is_a?(Capybara::Session)
return driver.driver.browser.manage
end
return driver.manage

driver.manage
end

def self.get_serialized_dom(driver, options)
Expand All @@ -59,77 +59,78 @@ def self.get_serialized_dom(driver, options)
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
})
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 }
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, current_height = window_size.width, window_size.height
current_width = window_size.width
current_height = window_size.height
last_window_width = current_width
resize_count = 0
driver.execute_script("PercyDOM.waitForResize()")
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

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
end

def self.is_responsive_snapshot_capture?(options)
def self.responsive_snapshot_capture?(options)
# Don't run responsive snapshot capture when defer uploads is enabled
return false if @cli_config && @cli_config.dig('percy', 'deferUploads')
return false if @cli_config&.dig('percy', 'deferUploads')

options[:responsive_snapshot_capture] ||
options[:responsiveSnapshotCapture] ||
(@cli_config && @cli_config.dig('snapshot', 'responsiveSnapshotCapture'))
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
Expand Down Expand Up @@ -157,7 +158,7 @@ def self.percy_enabled?

response_body = JSON.parse(response.body)
@eligible_widths = response_body['widths']
@cli_config = response_body["config"]
@cli_config = response_body['config']
@percy_enabled = true
true
rescue StandardError => e
Expand All @@ -179,7 +180,7 @@ def self.fetch_percy_dom
def self.log(msg, lvl = 'info')
msg = "#{LABEL} #{msg}"
begin
fetch('percy/log', { message: msg, level: lvl })
fetch('percy/log', {message: msg, level: lvl})
rescue StandardError => e
if PERCY_DEBUG
puts "Sending log to CLI Failed #{e}"
Expand Down
59 changes: 42 additions & 17 deletions spec/lib/percy/percy_spec.rb
View file
Original file line number Diff line number Diff line change
@@ -1,8 +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)
stub_request(:post, 'http://localhost:5338/percy/log').to_raise(StandardError)
Percy._clear_cache!
end

Expand Down Expand Up @@ -60,12 +75,13 @@

it 'logs an error when sending a snapshot fails' do
stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
.to_return(status: 200, body: '{"success": "true" }', 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: () => { return { html: document.documentElement.outerHTML, cookies: "" } }};',
body: fetch_script_string,
headers: {},
)

Expand All @@ -78,12 +94,14 @@

it 'sends snapshots to the local server' do
stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
.to_return(status: 200, body: '{"success": "true" }', 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: () => { return { html: document.documentElement.outerHTML, cookies: "" } }};',
body: fetch_script_string,
headers: {},
)

Expand All @@ -99,7 +117,7 @@
name: 'Name',
url: 'http://127.0.0.1:3003/index.html',
dom_snapshot:
{ "cookies": [], "html": "<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],
Expand All @@ -110,35 +128,41 @@
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/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: 'window.PercyDOM = { serialize: () => { return { html: document.documentElement.outerHTML, cookies: "" } }, waitForResize: () => { if(!window.resizeCount) { window.addEventListener(\'resize\', () => window.resizeCount++) } window.resizeCount = 0; }};',
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 })
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': "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>", 'width': 390 },
{ 'cookies': [], 'html': "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>", 'width': 765 },
{ 'cookies': [], 'html': "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>", 'width': 1280 }
{'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
responsive_snapshot_capture: true,
}.to_json,
).once

Expand All @@ -147,12 +171,13 @@

it 'sends snapshots for sync' do
stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
.to_return(status: 200, body: '{"success": "true" }', 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: () => { return { html: document.documentElement.outerHTML, cookies: "" } }}',
body: fetch_script_string,
headers: {},
)

Expand All @@ -168,7 +193,7 @@
name: 'Name',
url: 'http://127.0.0.1:3003/index.html',
dom_snapshot:
{ "cookies" => [], "html" => "<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}",
sync: true,
Expand Down

0 comments on commit d9d0bf0

Please sign in to comment.