eyes_selenium 3.18.2 → 3.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2405810aec21e6cc3e6f1a156954a7d11f08cda1
-  data.tar.gz: 547bbe8ccae2009b5f2490952e9af6f7531f8bf4
+  metadata.gz: 23704229caa8ee5060d9c78411063827f0691448
+  data.tar.gz: c4e009752f305985d82633d2cd7428e482a98ae2
 SHA512:
-  metadata.gz: 01d7d9768fea60aba826d73283c900f9d8c6e7722989d24cb07c997b1268141d1dca183f4fe7b8f3358d4e359784e28704ae8b35cd9b4a6aa1d248f2e9dc0535
-  data.tar.gz: ad39a605cfe410bb028bbd57ec39837a9db61d4f722b88069ed133057b060578b82a8e95962aec77584d31034f1ed16bff73c4a91aa96f7cf32ef37c5fb50044
+  metadata.gz: 257658592ad5d264372947bc2d51113dfdccca6a6ae87f812fbc4d57f8541d50df838bc832e38992c5197c6e28d4ac44818077a46675ec73b9ec1e3fcac979b8
+  data.tar.gz: e6d0593683515bdd315129917eda167a0e1df25521d49e5c30fc36d7ccd86b716849539e75e22f351008aae7ddf63a01d132f84086e4d97727d2f361004f37a1

data/lib/applitools/selenium/visual_grid/dom_snapshot_script.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: false
+
+require 'selenium-webdriver'
+
+
+module Applitools
+  module Selenium
+    class DomSnapshotScript
+
+      attr_accessor :driver
+
+      def initialize(driver)
+        self.driver = driver
+      end
+
+      def create_dom_snapshot(
+        dont_fetch_resources,
+        urls_to_skip,
+        cross_origin_rendering,
+        use_cookies
+      )
+        serialize_resources = true
+        compress_resources = false
+        script = DomSnapshotScript.new(driver, urls_to_skip, dont_fetch_resources, serialize_resources, compress_resources)
+        snapshotter = RecursiveSnapshotter.new(driver, script, cross_origin_rendering, use_cookies)
+
+        begin
+          snapshotter.create_cross_frames_dom_snapshots
+        rescue StandardError => e
+          Applitools::EyesLogger.error e.class.to_s
+          Applitools::EyesLogger.error e.message
+          raise ::Applitools::EyesError.new 'Error while getting dom snapshot!'
+        end
+
+      end
+
+      class DomSnapshotScript
+        DOM_EXTRACTION_TIMEOUT = 300
+
+        attr_accessor :driver, :urls_to_skip, :dont_fetch_resources, :serialize_resources, :compress_resources
+
+        def initialize(driver, urls_to_skip, dont_fetch_resources, serialize_resources = false, compress_resources = false)
+          self.driver = driver
+          self.urls_to_skip = urls_to_skip
+          self.dont_fetch_resources = dont_fetch_resources
+          self.compress_resources = compress_resources
+          self.serialize_resources = serialize_resources
+        end
+
+        def process_page_script
+          Applitools::Selenium::Scripts::PROCESS_PAGE_AND_POLL
+        end
+
+        def script_options
+          options = []
+          options.push("dontFetchResources: #{dont_fetch_resources}")
+          options.push("skipResources: [#{urls_to_skip}]")
+          options.push("compressResources: #{compress_resources}")
+          options.push("serializeResources: #{serialize_resources}")
+          "{#{options.join(', ')}}"
+        end
+
+        def script
+          "#{process_page_script} return __processPageAndSerializePoll(#{script_options});"
+        end
+
+        def run
+          Applitools::EyesLogger.info 'Trying to get DOM snapshot...'
+
+          script_thread = Thread.new do
+            result = {}
+            while result['status'] != 'SUCCESS'
+              Thread.current[:script_result] = driver.execute_script(script)
+              begin
+                Thread.current[:result] = result = Oj.load(Thread.current[:script_result])
+                sleep 0.5
+              rescue Oj::ParseError => e
+                Applitools::EyesLogger.warn e.message
+              end
+            end
+          end
+          sleep 0.5
+          script_thread_result = script_thread.join(DOM_EXTRACTION_TIMEOUT)
+          raise ::Applitools::EyesError.new 'Timeout error while getting dom snapshot!' unless script_thread_result
+          Applitools::EyesLogger.info 'Done!'
+
+          script_thread_result[:result]['value']
+        end
+
+      end
+
+
+      class RecursiveSnapshotter
+
+        POLL_INTERVAL_MS = 0.5
+
+        attr_accessor :should_skip_failed_frames
+
+        attr_accessor :driver, :script, :cross_origin_rendering, :use_cookies
+
+        def initialize(driver, script, cross_origin_rendering, use_cookies)
+          self.should_skip_failed_frames = true
+          self.driver = driver
+          self.script = script
+          self.cross_origin_rendering = cross_origin_rendering
+          self.use_cookies = use_cookies
+        end
+
+        def create_cross_frames_dom_snapshots
+          dom = create_dom_snapshot_threaded
+          process_dom_snapshot_frames dom
+          dom
+        end
+
+        def create_dom_snapshot_threaded
+          script.run
+        end
+
+        def process_dom_snapshot_frames dom
+          dom["cookies"] = driver.manage.all_cookies if use_cookies
+
+          dom["frames"].each do |frame|
+            selector = frame['selector']
+            unless selector
+              Applitools::EyesLogger.warn "inner frame with null selector"
+              next
+            end
+            begin
+              original_frame_chain = driver.frame_chain
+              frame_element = driver.find_element(:css, selector)
+              frame_src = frame_element.attribute('src')
+              Applitools::EyesLogger.info "process_dom_snapshot_frames src = #{frame_src}"
+              driver.switch_to.frame(frame_element)
+
+              process_dom_snapshot_frames frame
+
+              driver.switch_to.default_content
+              unless original_frame_chain.empty?
+                driver.switch_to.frames frame_chain: original_frame_chain
+              end
+            rescue StandardError => e
+              Applitools::EyesLogger.error e.class.to_s
+              Applitools::EyesLogger.error e.message
+              if should_skip_failed_frames
+                Applitools::EyesLogger.warn "failed switching to frame #{selector}"
+              else
+                raise ::Applitools::EyesError.new 'failed switching to frame'
+              end
+            end
+          end
+
+          self.snapshot_and_process_cors_frames(dom) if self.cross_origin_rendering
+        end
+
+        def snapshot_and_process_cors_frames(dom)
+          dom["crossFrames"].each do |frame|
+            selector = frame['selector']
+            unless selector
+              Applitools::EyesLogger.warn "cross frame with null selector"
+              next
+            end
+            frame_index = frame['index']
+            begin
+              original_frame_chain = driver.frame_chain
+              frame_element = driver.find_element(:css, selector) #
+              frame_src = frame_element.attribute('src')
+              Applitools::EyesLogger.info "snapshot_and_process_cors_frames src = #{frame_src}"
+              driver.switch_to.frame(frame_element)
+
+              frame_dom = create_cross_frames_dom_snapshots
+              dom['frames'] ||= []
+              dom['frames'].push frame_dom
+              frame_url = frame_dom['url']
+              dom['cdt'][frame_index]['attributes'].push({ 'name' => 'data-applitools-src', 'value' => frame_url })
+              Applitools::EyesLogger.info "Created cross origin frame snapshot #{frame_url}"
+              process_dom_snapshot_frames frame_dom
+
+              driver.switch_to.default_content
+              unless original_frame_chain.empty?
+                driver.switch_to.frames(frame_chain: original_frame_chain)
+              end
+            rescue StandardError => e
+              Applitools::EyesLogger.error e.class.to_s
+              Applitools::EyesLogger.error e.message
+              if should_skip_failed_frames
+                Applitools::EyesLogger.warn "failed extracting and processing cross frame #{selector}"
+              else
+                raise ::Applitools::EyesError.new 'failed switching to frame'
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/applitools/selenium/visual_grid/render_task.rb

@@ -188,12 +188,13 @@ module Applitools
         end
 
         fetch_block = proc do |_s, key|
-          resp_proc = proc { |u| server_connector.download_resource(u, ua_string) }
+          resp_proc = proc { |u, cookies| server_connector.download_resource(u, ua_string, cookies) }
           retry_count = 3
+          matching_cookies = data['cookies'].to_a.select {|c| is_cookie_for_url(c, key)}
           response = nil
           loop do
             retry_count -= 1
-            response = resp_proc.call(key.dup)
+            response = resp_proc.call(key.dup, matching_cookies)
             break unless response.status != 200 && retry_count > 0
           end
           Applitools::Selenium::VGResource.parse_response(
@@ -287,6 +288,24 @@ module Applitools
         running_tests << running_test
         running_tests.length - 1
       end
+
+      def is_cookie_for_url(cookie, url)
+        return false if cookie[:secure] && url.scheme != 'https'
+        return false if cookie[:expires] && DateTime.now > cookie[:expires]
+
+        subdomains_allowed = cookie[:domain].start_with? '.'
+        domain = subdomains_allowed ? cookie[:domain][1..-1] : cookie[:domain]
+        domain_match = url.hostname === domain
+        subdomain_match = url.hostname.end_with?('.' + domain)
+        return false unless domain_match || (subdomains_allowed && subdomain_match)
+
+        path = cookie[:path]
+        path = path.end_with?('/') ? path[0..-2] : path
+
+        return true if url.path === path
+        return true if url.path.start_with?(path + '/')
+        false
+      end
     end
   end
 end

data/lib/applitools/selenium/visual_grid/visual_grid_eyes.rb

@@ -8,7 +8,6 @@ module Applitools
   module Selenium
     class VisualGridEyes
       include Applitools::Selenium::Concerns::SeleniumEyes
-      DOM_EXTRACTION_TIMEOUT = 300 # seconds or 5 minutes
       USE_DEFAULT_MATCH_TIMEOUT = -1
       extend Forwardable
 
@@ -125,9 +124,6 @@ module Applitools
           tag = first_arg[:name] || first_arg[:tag]
         end
 
-        script = <<-END
-          #{Applitools::Selenium::Scripts::PROCESS_PAGE_AND_POLL} return __processPageAndSerializePoll(document, {skipResources: [#{visual_grid_manager.resource_cache.urls_to_skip}]});
-        END
         render_task = nil
         target.default_full_page_for_vg
 
@@ -136,31 +132,33 @@ module Applitools
           check_in_frame(target_frames: target_to_check.frames) do
             sleep wait_before_screenshots
             Applitools::EyesLogger.info 'Trying to get DOM snapshot...'
-
-            script_thread = Thread.new do
-              result = {}
-              while result['status'] != 'SUCCESS'
-                Thread.current[:script_result] = driver.execute_script(script)
-                begin
-                  Thread.current[:result] = result = Oj.load(Thread.current[:script_result])
-                  sleep 0.5
-                rescue Oj::ParseError => e
-                  Applitools::EyesLogger.warn e.message
-                end
-              end
+            begin
+              dont_fetch_resources = self.dont_fetch_resources
+              enable_cross_origin_rendering = self.enable_cross_origin_rendering
+              use_cookies = !self.dont_use_cookies
+              urls_to_skip = visual_grid_manager.resource_cache.urls_to_skip
+              dom_script = Applitools::Selenium::DomSnapshotScript.new driver
+
+              script_dom = dom_script.create_dom_snapshot(
+                dont_fetch_resources,
+                urls_to_skip,
+                enable_cross_origin_rendering,
+                use_cookies
+              )
+            rescue StandardError => e
+              Applitools::EyesLogger.error e.class.to_s
+              Applitools::EyesLogger.error e.message
+              raise ::Applitools::EyesError.new 'Error while getting dom snapshot!'
             end
-            sleep 0.5
-            script_thread_result = script_thread.join(DOM_EXTRACTION_TIMEOUT)
-            raise ::Applitools::EyesError.new 'Timeout error while getting dom snapshot!' unless script_thread_result
             Applitools::EyesLogger.info 'Done!'
 
-            mod = Digest::SHA2.hexdigest(script_thread_result[:script_result])
+            mod = Digest::SHA2.hexdigest(script_dom.to_s)
 
             region_x_paths = get_regions_x_paths(target_to_check)
 
             render_task = RenderTask.new(
               "Render #{config.short_description} - #{tag}",
-              script_thread_result[:result]['value'],
+              script_dom,
               visual_grid_manager,
               server_connector,
               region_x_paths,

data/lib/applitools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '3.18.2'.freeze
+  VERSION = '3.18.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.18.2
+  version: 3.18.3
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.18.2
+        version: 3.18.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.18.2
+        version: 3.18.3
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,7 @@ files:
 - lib/applitools/selenium/viewport_size.rb
 - lib/applitools/selenium/visual_grid/chrome_emulation_info.rb
 - lib/applitools/selenium/visual_grid/desktop_browser_info.rb
+- lib/applitools/selenium/visual_grid/dom_snapshot_script.rb
 - lib/applitools/selenium/visual_grid/emulation_base_info.rb
 - lib/applitools/selenium/visual_grid/eyes_connector.rb
 - lib/applitools/selenium/visual_grid/i_render_browser_info.rb