eyes_core 3.17.13 → 3.17.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3658cedca7dcf9d3e5f1e7c6032c26c39663c3c7a45fcb3182d4f9d580e97ecd
-  data.tar.gz: 9b5258d94211854de60052c9455a55ce6330353fac485acdf8f3aa1aec432fa9
+  metadata.gz: 61272f8c794f0a12c2eb824d096987716ddfbc0e4a7fd9346687a4ebc71cc95f
+  data.tar.gz: 22a3c71582d53d02dc6bfd0911c094830483f8fe9738ed445e7636304ab96752
 SHA512:
-  metadata.gz: b330fb7b8315afcb21b4d8ecf74477f7c1fc888df88774c113e76acbbe9a60b73b109ec941e4b808ed9323d176e6ae531f7c4818361393e1ef6b9180b1918c9c
-  data.tar.gz: e865e1039f8b32c4d9ee369c2a7c21c60f9de2f9f5a2b7a2083c651b9529a27a698a9ec25b2d645a9743abc6b7ca198cd460700fdcf4eca73aa7e05d4e502df8
+  metadata.gz: b46455cced31d0443c153654f657087ae06c37501d62de78a1cddaac33a4e81045f5876c24e4c11bd91a4b252de546c09c5a65c9c1c47907b59b94a7b76c9975
+  data.tar.gz: 46d878ddb0273372f69d835127dc86becbd190cbe34e77fc838b1e66c8d00f28838540ae226175f1395385ff334afa2af398de55d21ff2ec087b83dcc135c217

data/lib/applitools/appium/android_region_provider.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'region_provider'
+module Applitools
+  module Appium
+    class AndroidRegionProvider < ::Applitools::Appium::RegionProvider
+      private
+
+      def convert_element_coordinates
+        Applitools::Region.from_location_size(eye_region.location, eye_region.size)
+      end
+
+      def convert_viewport_rect_coordinates
+        region  = viewport_rect
+        Applitools::Region.new(
+            region['left'],
+            region['top'],
+            region['width'],
+            region['height']
+        )
+      end
+    end
+  end
+end

data/lib/applitools/appium/eyes.rb

@@ -2,6 +2,7 @@
 
 class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
   attr_accessor :status_bar_height
+
   def perform_driver_settings_for_appium_driver
     self.region_visibility_strategy = Applitools::Selenium::NopRegionVisibilityStrategy.new
     self.force_driver_resolution_as_viewport_size = true
@@ -51,7 +52,7 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
 
     eyes_element = target_to_check.region_to_check.call(driver)
     self.eyes_element_to_check = eyes_element
-    region_provider = Applitools::Appium::RegionProvider.new(driver, eyes_element)
+    region_provider = region_provider_class.new(driver, eyes_element)
     match_data.read_target(target_to_check, driver)
 
     check_window_base(
@@ -119,16 +120,19 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
 
   def viewport_screenshot
     logger.info 'Viewport screenshot requested...'
-
-    self.screenshot = screenshot_class.new(
-      Applitools::Screenshot.from_datastream(driver.screenshot_as(:png))
-    )
+    obtain_viewport_screenshot
   end
 
   def element_screenshot
     logger.info 'Element screenshot requested...'
+    obtain_viewport_screenshot
+  end
+
+  def obtain_viewport_screenshot
     self.screenshot = screenshot_class.new(
-      Applitools::Screenshot.from_datastream(driver.element_screenshot_as(eyes_element_to_check, :png))
+        Applitools::Screenshot.from_datastream(driver.screenshot_as(:png)),
+        status_bar_height: Applitools::Utils::EyesSeleniumUtils.status_bar_height(driver),
+        device_pixel_ratio: Applitools::Utils::EyesSeleniumUtils.device_pixel_ratio(driver)
     )
   end
 
@@ -137,4 +141,10 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
     return Applitools::Appium::AndroidScreenshot if Applitools::Utils::EyesSeleniumUtils.android?(Applitools::Appium::Driver::AppiumLib)
     raise Applitools::EyesError, 'Unknown device type'
   end
+
+  def region_provider_class
+    return Applitools::Appium::IosRegionProvider if Applitools::Utils::EyesSeleniumUtils.ios?(Applitools::Appium::Driver::AppiumLib)
+    return Applitools::Appium::AndroidRegionProvider if Applitools::Utils::EyesSeleniumUtils.android?(Applitools::Appium::Driver::AppiumLib)
+    raise Applitools::EyesError, 'Unknown device type'
+  end
 end

data/lib/applitools/appium/ios_region_provider.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+#
+require_relative 'region_provider'
+module Applitools
+  module Appium
+    class IosRegionProvider < ::Applitools::Appium::RegionProvider
+      private
+
+      def convert_element_coordinates
+        Applitools::Region.from_location_size(eye_region.location, eye_region.size).
+            scale_it!(scale_factor)
+      end
+
+      def convert_viewport_rect_coordinates
+        region  = viewport_rect
+        Applitools::Region.new(
+          region['left'],
+          region['top'],
+          region['width'],
+          region['height']
+        )
+      end
+    end
+  end
+end

data/lib/applitools/appium/region_provider.rb

@@ -3,23 +3,48 @@
 module Applitools
   module Appium
     class RegionProvider
-      attr_accessor :driver, :eye_region, :coordinate_type
+      attr_accessor :driver, :eye_region, :region_to_check
 
       def initialize(driver, eye_region)
         self.driver = driver
         self.eye_region = eye_region
+        self.region_to_check = Applitools::Region::EMPTY
+        convert_region_coordinates
       end
 
       def region
-        return Applitools::Region::EMPTY if
-            [::Selenium::WebDriver::Element, Applitools::Selenium::Element].include? eye_region.class
-        region = driver.session_capabilities['viewportRect']
-        Applitools::Region.new(
-          region['left'],
-          region['top'],
-          region['width'],
-          region['height']
-        )
+        region_to_check
+      end
+
+      def coordinate_type
+        nil
+      end
+
+      private
+
+      def viewport_rect
+        Applitools::Utils::EyesSeleniumUtils.viewport_rect(driver)
+      end
+
+      def convert_region_coordinates
+        self.region_to_check = case eye_region
+                               when ::Selenium::WebDriver::Element, Applitools::Selenium::Element
+                                  convert_element_coordinates
+                               else
+                                  convert_viewport_rect_coordinates
+                               end
+      end
+
+      def convert_element_coordinates
+        raise Applitools::AbstractMethodCalled.new(:convert_region_coordinates, 'Applitools::Appium::RegionProvider')
+      end
+
+      def convert_viewport_rect_coordinates
+        raise Applitools::AbstractMethodCalled.new(:convert_viewport_rect_coordinates, 'Applitools::Appium::RegionProvider')
+      end
+
+      def scale_factor
+        Applitools::Utils::EyesSeleniumUtils.device_pixel_ratio(driver)
       end
     end
   end

data/lib/applitools/appium/utils.rb

@@ -28,7 +28,7 @@ module Applitools::Appium
     def device_pixel_ratio(executor)
       session_info = session_capabilities(executor)
       return session_info['pixelRatio'].to_f if session_info['pixelRatio']
-      Applitools::Selenium::Eyes::UNKNOWN_DEVICE_PIXEL_RATIO
+      1
     end
 
     def status_bar_height(executor)
@@ -37,6 +37,17 @@ module Applitools::Appium
       0
     end
 
+    def viewport_rect(executor)
+      session_info = session_capabilities(executor)
+      return session_info['viewportRect'] if session_info['viewportRect']
+      {
+        'left' => 0,
+        'top' => 0,
+        'width' => 0,
+        'height' => 0
+      }
+    end
+
     def session_capabilities(executor)
        executor.session_capabilities if executor.respond_to? :session_capabilities
     end

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

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.13'.freeze
+  VERSION = '3.17.18'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.17.13
+  version: 3.17.18
 platform: ruby
 authors:
 - Applitools Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -260,11 +260,13 @@ files:
 - ext/eyes_core/extconf.rb
 - ext/eyes_core/eyes_core.c
 - ext/eyes_core/eyes_core.h
+- lib/applitools/appium/android_region_provider.rb
 - lib/applitools/appium/android_screenshot.rb
 - lib/applitools/appium/driver.rb
 - lib/applitools/appium/eyes.rb
 - lib/applitools/appium/initialize_1.9.rb
 - lib/applitools/appium/initialize_2.0.rb
+- lib/applitools/appium/ios_region_provider.rb
 - lib/applitools/appium/ios_screenshot.rb
 - lib/applitools/appium/region_provider.rb
 - lib/applitools/appium/screenshot.rb