eyes_core 3.17.12 → 3.17.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49e2fc2ad1689f2affe7804c5d863027a2459d1bdc4f2a64394f9d0a5215f3b2
-  data.tar.gz: 209aea197b10dabd0c461622dbe548fc185572a8359eb59dc14acfa607edeb11
+  metadata.gz: bec0e3de9fa596430d8a46e5274359fafb24bf610223181263cc74c7da18cc74
+  data.tar.gz: 2949d1c8638ecb578569fd55b69e3eaafdfc81fd7ad05cd35f0f5dc9c17bba7e
 SHA512:
-  metadata.gz: 21a8fe311c21258adc0d75a18d7272609ab466a16ee55d1d3db7020d6d93b554c55a56ef72a5951a20f7b19ca2d6c3cafc892304c5ccaabb05c39aaf8873eb01
-  data.tar.gz: cbf5ebb40d5cc26442e6e289aac57f679d5966a6e9f8e778f6d53b13bdbcbf77b59a42fd9db7c63fbb4d68cf9b0bc3eaaf93e863630210cb87a6ad89c8c6c463
+  metadata.gz: d79a7817840dafdd6102d6442a71f63fd5db7885e6de70432d9fd0f43c66805f533e0c439f25330253ca17b87e05c752996ea6001a0a63ecb5b74e690704780a
+  data.tar.gz: 214446f6d9a8e1fafe461970f560a9b65d353578a820ad18fb0dae523752f0dd7f3eab74ca530d2400198f97d9f7f5731f79bbf77e85d4949b051c7940607b5b

data/lib/applitools/core/app_output.rb

@@ -2,14 +2,16 @@
 
 module Applitools
   class AppOutput
-    attr_reader :title, :screenshot64, :location
+    attr_reader :title, :screenshot64, :location, :screenshot_url_getter, :dom_url_getter
 
-    attr_accessor :dom_url, :screenshot_url
+    attr_accessor :dom_url, :screenshot_url, :visual_viewport
 
     def initialize(title, screenshot64)
       @title = title
       @screenshot64 = screenshot64
       @location = Applitools::Location::TOP_LEFT
+      @screenshot_url_getter = nil
+      @dom_url_getter = nil
     end
 
     def location=(value)
@@ -17,14 +19,27 @@ module Applitools
       @location = value
     end
 
+    def on_need_screenshot_url(&block)
+      @screenshot_url_getter = block if block_given?
+    end
+
+    def on_need_dom_url(&block)
+      @dom_url_getter = block if block_given?
+    end
+
+    def dom_url
+      @dom_url ||= (@dom_url_getter && @dom_url_getter.call)
+    end
+
     def to_hash
       result = {
         Title: title,
         Screenshot64: nil,
         Location: location.to_hash,
-        ScreenshotUrl: screenshot_url
+        ScreenshotUrl: screenshot_url || (screenshot_url_getter && screenshot_url_getter.call)
       }
       result[:DomUrl] = dom_url if dom_url
+      result[:visualViewport] = visual_viewport if visual_viewport
       result
     end
   end

data/lib/applitools/core/batch_info.rb

@@ -6,17 +6,19 @@ require_relative 'helpers'
 module Applitools
   class BatchInfo
     extend Helpers
-    attr_accessor :started_at, :id
+    attr_accessor :started_at, :id, :notify_on_completion
 
     environment_attribute :name, 'APPLITOOLS_BATCH_NAME'
     environment_attribute :id, 'APPLITOOLS_BATCH_ID'
     environment_attribute :sequence_name, 'APPLITOOLS_BATCH_SEQUENCE'
-    environment_attribute :notify_on_completion, 'APPLITOOLS_BATCH_NOTIFY'
+    environment_attribute :env_notify_on_completion, 'APPLITOOLS_BATCH_NOTIFY'
+
 
     def initialize(name = nil, started_at = Time.now)
       self.name = name if name
       @started_at = started_at
       self.id = SecureRandom.uuid unless id
+      self.notify_on_completion = 'true'.casecmp(env_notify_on_completion || '') == 0 ? true : false
     end
 
     def json_data
@@ -25,7 +27,7 @@ module Applitools
           'name' => name,
           'startedAt' => @started_at.iso8601,
           'batchSequenceName' => sequence_name,
-          'notifyOnCompletion' => 'true'.casecmp(notify_on_completion || '') == 0 ? true : false
+          'notifyOnCompletion' => notify_on_completion
       }
     end
 

data/lib/applitools/core/eyes_base.rb

@@ -280,7 +280,6 @@ module Applitools
           self.last_screenshot = result.screenshot
         end
 
-        self.should_match_window_run_once_on_timeout = true
         self.failed = true
         logger.info "Mistmatch! #{tag}" unless running_session.new_session?
 
@@ -614,27 +613,7 @@ module Applitools
     end
 
     def get_app_output_with_screenshot(region_provider, _last_screenshot)
-      dom_url = ''
       captured_dom_data = dom_data
-      unless captured_dom_data.empty?
-        begin
-          logger.info 'Processing DOM..'
-          dom_url = server_connector.post_dom_json(captured_dom_data, runner.rendering_info(server_connector)) do |json|
-            io = StringIO.new
-            gz = Zlib::GzipWriter.new(io)
-            gz.write(json.encode('UTF-8'))
-            gz.close
-            result = io.string
-            io.close
-            result
-          end
-          logger.info 'Done'
-          logger.info dom_url
-        rescue Applitools::EyesError => e
-          logger.warn e.message
-          dom_url = nil
-        end
-      end
       logger.info 'Getting screenshot...'
       screenshot = capture_screenshot
       logger.info 'Done getting screenshot!'
@@ -646,21 +625,41 @@ module Applitools
 
       screenshot = yield(screenshot) if block_given?
 
-      if screenshot
-        self.screenshot_url = server_connector.put_screenshot(
-          runner.rendering_info(server_connector),
-          screenshot
-        )
-      end
-
       logger.info 'Getting title...'
       a_title = title
       logger.info 'Done!'
       Applitools::AppOutputWithScreenshot.new(
         Applitools::AppOutput.new(a_title, screenshot).tap do |o|
           o.location = region.location unless region.empty?
-          o.dom_url = dom_url unless dom_url && dom_url.empty?
-          o.screenshot_url = screenshot_url if respond_to?(:screenshot_url) && !screenshot_url.nil?
+          o.on_need_screenshot_url do
+            return unless screenshot
+            server_connector.put_screenshot(
+              runner.rendering_info(server_connector),
+              screenshot
+            )
+          end
+          o.on_need_dom_url do
+            unless captured_dom_data.empty?
+              begin
+                logger.info 'Processing DOM..'
+                dom_url = server_connector.post_dom_json(captured_dom_data, runner.rendering_info(server_connector)) do |json|
+                  io = StringIO.new
+                  gz = Zlib::GzipWriter.new(io)
+                  gz.write(json.encode('UTF-8'))
+                  gz.close
+                  result = io.string
+                  io.close
+                  result
+                end
+                logger.info 'Done'
+                logger.info dom_url
+              rescue Applitools::EyesError => e
+                logger.warn e.message
+                dom_url = nil
+              end
+              dom_url
+            end
+          end
         end,
         screenshot,
         allow_empty_screenshot

data/lib/applitools/core/match_window_data.rb

@@ -24,6 +24,7 @@ module Applitools
             'ForceMismatch' => false,
             'IgnoreMatch' => false,
             'IgnoreMismatch' => false,
+            'ReplaceLast' => false,
             'Trim' => {
               'Enabled' => false
             },
@@ -140,7 +141,7 @@ module Applitools
       Applitools::ArgumentGuard.is_a? value, 'value', Applitools::AppOutputWithScreenshot
       @app_output = value
       hash_value = Applitools::Utils.capitalize_hash_keys(value.to_hash)
-      [:Screenshot64, :ScreenshotUrl, :Title, :IsPrimary, :Elapsed, :Location, :DomUrl].each do |key|
+      [:Screenshot64, :ScreenshotUrl, :Title, :IsPrimary, :Elapsed, :Location, :DomUrl, :VisualViewport].each do |key|
         next if hash_value[key].nil?
         current_data['AppOutput'][key.to_s] = case hash_value[key]
                                               when Hash
@@ -313,6 +314,15 @@ module Applitools
       current_data['IgnoreMismatch']
     end
 
+    def replace_last
+      current_data['Options']['ReplaceLast']
+    end
+
+    def replace_last=(value)
+      Applitools::ArgumentGuard.one_of?(value, 'value', [TrueClass, FalseClass])
+      current_data['Options']['ReplaceLast'] = value
+    end
+
     def tag
       current_data['Tag']
     end
@@ -376,12 +386,12 @@ module Applitools
             Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
             Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
           )
-          updated_region.to_hash
+
           Applitools::FloatingRegion.new(
             updated_region.left,
             updated_region.top,
-            r.width,
-            r.height,
+            updated_region.width,
+            updated_region.height,
             r.max_left_offset,
             r.max_top_offset,
             r.max_right_offset,

data/lib/applitools/core/match_window_task.rb

@@ -48,10 +48,11 @@ module Applitools
         match_window_data.convert_strict_regions_coordinates
         match_window_data.convert_content_regions_coordinates
         match_window_data.convert_accessibility_regions_coordinates
+        match_window_data.replace_last = false
         match_result = perform_match(match_window_data)
       else
-        passed_ignore_mismatch = match_window_data.ignore_mismatch
         app_output = app_output_provider.app_output(region_provider, last_screenshot)
+        last_image_digest = app_output.screenshot.image.sha256
         match_window_data.app_output = app_output
         match_window_data.convert_ignored_regions_coordinates
         match_window_data.convert_floating_regions_coordinates
@@ -59,44 +60,37 @@ module Applitools
         match_window_data.convert_strict_regions_coordinates
         match_window_data.convert_content_regions_coordinates
         match_window_data.convert_accessibility_regions_coordinates
-        match_window_data.ignore_mismatch = true
-        start = Time.now
+        match_window_data.replace_last = false
         match_result = perform_match(match_window_data)
-        retry_time = Time.now - start
 
         block_retry = if block_given?
                         yield(match_result)
                       else
                         false
                       end
+        start = Time.now
+        retry_time = 0
 
         while retry_time < retry_timeout && !(block_retry || match_result.as_expected?)
           sleep MATCH_INTERVAL
           app_output = app_output_provider.app_output(region_provider, last_screenshot)
-          match_window_data.app_output = app_output
-          match_window_data.convert_ignored_regions_coordinates
-          match_window_data.convert_floating_regions_coordinates
-          match_window_data.convert_layout_regions_coordinates
-          match_window_data.convert_strict_regions_coordinates
-          match_window_data.convert_content_regions_coordinates
-          match_window_data.convert_accessibility_regions_coordinates
-          match_window_data.ignore_mismatch = true
-          match_result = perform_match(match_window_data)
+          image_digest = app_output.screenshot.image.sha256
+          if image_digest == last_image_digest
+            logger.info('Got the same screenshot in retry. Not sending to the server.')
+          else
+            match_window_data.app_output = app_output
+            match_window_data.convert_ignored_regions_coordinates
+            match_window_data.convert_floating_regions_coordinates
+            match_window_data.convert_layout_regions_coordinates
+            match_window_data.convert_strict_regions_coordinates
+            match_window_data.convert_content_regions_coordinates
+            match_window_data.convert_accessibility_regions_coordinates
+            match_window_data.replace_last = true
+            match_result = perform_match(match_window_data)
+          end
+          last_image_digest = image_digest
           retry_time = Time.now - start
         end
-
-        unless block_retry || match_result.as_expected?
-          app_output = app_output_provider.app_output(region_provider, last_screenshot)
-          match_window_data.app_output = app_output
-          match_window_data.convert_ignored_regions_coordinates
-          match_window_data.convert_floating_regions_coordinates
-          match_window_data.convert_layout_regions_coordinates
-          match_window_data.convert_strict_regions_coordinates
-          match_window_data.convert_content_regions_coordinates
-          match_window_data.convert_accessibility_regions_coordinates
-          match_window_data.ignore_mismatch = passed_ignore_mismatch
-          match_result = perform_match(match_window_data)
-        end
       end
 
       logger.info "Completed in #{format('%.2f', Time.now - elapsed_time_start)} seconds"

data/lib/applitools/core/screenshot.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'digest'
 
 module Applitools
   class Screenshot < Delegator
@@ -91,6 +92,10 @@ module Applitools
       def restore
         ::ChunkyPNG::Image.from_datastream @datastream
       end
+
+      def sha256
+        Digest::SHA2.new(256).hexdigest(@datastream.to_s)
+      end
     end
 
     class Image < self
@@ -115,6 +120,10 @@ module Applitools
       def __setobj__(obj)
         @image = obj
       end
+
+      def sha256
+        Digest::SHA2.new(256).hexdigest(@image.to_datastream.to_s)
+      end
     end
   end
 end

data/lib/applitools/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.17.12
+  version: 3.17.17
 platform: ruby
 authors:
 - Applitools Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png