eyes_core 4.5.5 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2648f7486047fa1520639c3a2e84507709e3f2b562a2f7e3d8e9f98ea5632240
-  data.tar.gz: dfcb438452a8e03b8de9b7134edf6b62c62e79efb92a86b1ab0d0fd6a2ce8c50
+  metadata.gz: 4259f81f87552a4729eee89d697e1d534ffae9c2e448251d2310dd05860f0df5
+  data.tar.gz: d241c44d26afd831d18b9c48c04fef94878a520198736b6e5ecfd58f9b65d0c7
 SHA512:
-  metadata.gz: 043b6990d1b7efbea9d1c6ba440f8964ec5809d5b1cf58539ba6e733c1c883e644ac8db61db78f8ebbab02b827ff6fafef316d0f1d8be28724f660b367600122
-  data.tar.gz: f45b7146e913fe8b2d7b6d84dde8927ef54d586e349772800535464c348357852d22da66f9846ecdbe9829fd5868b09288c03f575ef5bef51d94888506deb501
+  metadata.gz: 61ab67a89de0e6d138e2b9cfc9dfa9318b52a49d4cc292996da92489c1bb9ea81ef759ceecd80c167cf37098f324e976171de1d3a7a7c4c0a7bb63ce2150dac7
+  data.tar.gz: b487a9aa5139df95d5af1deeb8e3876d7db3ba8323e182da94a4f4155748b8f5b74793fce814e808ab458f7ee05d0359dceef677b003e2930a3653d967022e70

data/lib/applitools/appium/eyes.rb

@@ -36,6 +36,8 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
     self.tag_for_debug = name
     Applitools::ArgumentGuard.one_of? target, 'target', [Applitools::Selenium::Target, Applitools::Appium::Target]
 
+    # target.fully(false) if target.options[:stitch_content].nil?
+
     return universal_check(name, target)
     return check_native(name, target) if native_app?
     super

data/lib/applitools/appium/target.rb

@@ -27,6 +27,13 @@ module Applitools
         reset_floating
         self
       end
+
+      def webview(value = true)
+        options[:webview] = value.is_a?(String) ? value : !!value
+        # options[:stitch_content] = false if options[:stitch_content].nil?
+        self
+      end
+
     # class Target
     #   include Applitools::FluentInterface
     #   attr_accessor :region_to_check, :options, :ignored_regions, :floating_regions, :layout_regions, :content_regions, :strict_regions, :accessibility_regions

data/lib/applitools/core/argument_guard.rb

@@ -37,7 +37,7 @@ module Applitools
     def one_of?(param, param_name, klasses)
       return true if klasses.detect { |a| param.is_a? a }
       raise Applitools::EyesIllegalArgument.new "Expected #{param_name} to be" \
-        " instance of one of this classes: [#{klass}], but got #{param.class.name} instead"
+        " instance of one of this classes: [#{klasses}], but got #{param.class.name} instead"
     end
 
     def raise_argument_error(error)

data/lib/applitools/core/eyes_base.rb

@@ -57,6 +57,17 @@ module Applitools
           raise Applitools::EyesError.new 'Failed to set viewport size!'
         end
       end
+
+      def get_execution_cloud_url(*args)
+        options = Applitools::Utils.extract_options!(args)
+        default_configs = Applitools::EyesBaseConfiguration::DEFAULT_CONFIG
+        server_url = options[:server_url] || default_configs[:server_url]
+        api_key = options[:api_key] || default_configs[:api_key]
+        proxy = options[:proxy]
+        @universal_client = Applitools::Connectivity::UniversalClient.new
+        core_ec_client = @universal_client.core_make_ec_client(server_url, api_key, proxy)
+        core_ec_client[:url]
+      end
     end
 
     attr_accessor :config
@@ -451,7 +462,8 @@ module Applitools
       # logger.info "Automatically save test? #{save}"
 
       # U-Notes : universal server returns Array ; keys as sym
-      universal_results = universal_eyes.close # Array even for one test
+      universal_eyes.close # nil
+      universal_results = universal_eyes.eyes_get_results # Array even for one test
       # require 'pry'
       # binding.pry
       key_transformed_results = Applitools::Utils.deep_stringify_keys(universal_results)

data/lib/applitools/core/test_result_summary.rb

@@ -19,6 +19,7 @@ module Applitools
     def old_style_results_array
       Applitools::Utils.deep_stringify_keys(results).map do |e|
         r = e['result'] ? e['result'] : {}
+        r['isAborted'] = true unless e['error'].nil? # fix for get_all_test_results
         Applitools::TestResults.new(r)
       end
     end

data/lib/applitools/core/universal_eyes_open.rb

@@ -61,7 +61,9 @@ module Applitools
       end
       # raise Applitools::EyesNotOpenException.new('Eyes not open!') if @eyes.nil?
       return if @universal_eyes.nil?
-      result = @universal_eyes.abort
+      @universal_eyes.abort
+      result = @universal_eyes.eyes_get_results
+      result = result[0] if result.is_a?(Array)
 
       if result.is_a? Hash
         logger.info "---Test aborted" if !result[:message] && !result[:stack]

data/lib/applitools/universal_sdk/executable_finder.rb

@@ -24,18 +24,18 @@ module Applitools::Connectivity
     end
 
     def filename
-      return 'eyes-universal-win.exe' if Gem.win_platform?
+      return 'core-win.exe' if Gem.win_platform?
       case RUBY_PLATFORM
         when /darwin/i
-          'eyes-universal-macos'
+          'core-macos'
         when /arm/i
-          'eyes-universal-linux-arm64'
+          'core-linux-arm64'
         when /mswin|windows|mingw/i
-          'eyes-universal-win.exe'
+          'core-win.exe'
         when /musl/i
-          'eyes-universal-alpine'
+          'core-alpine'
         when /linux|arch/i
-          'eyes-universal-linux'
+          'core-linux'
         else
           raise 'Unsupported platform'
       end

data/lib/applitools/universal_sdk/universal_check_settings.rb

@@ -18,6 +18,7 @@ module Applitools
     #     waitBeforeCapture?: number,
     #     lazyLoad?: boolean | LazyLoadOptions
     #   }
+    # webview?: boolean | string
     json_fields :name,
       :disableBrowserFetching,
       :layoutBreakpoints,
@@ -28,7 +29,8 @@ module Applitools
       :variationGroupId,
       :timeout,
       :waitBeforeCapture,
-      :lazyLoad
+      :lazyLoad,
+      :webview
 
     # export type MatchSettings<TRegion> = {
     #   exact?: {
@@ -161,6 +163,7 @@ module Applitools
       self.variation_group_id = target.options[:variation_group_id]
       self.wait_before_capture = target.options[:wait_before_capture]
       self.lazy_load = target.options[:lazy_load]
+      self.webview = target.options[:webview]
       self.page_id = target.options[:page_id]
 
       self.scroll_root_element = target.options[:scroll_root_element] || eyes.scroll_root_element

data/lib/applitools/universal_sdk/universal_client.rb

@@ -16,6 +16,7 @@ module Applitools::Connectivity
     extend Forwardable
     def_delegators 'Applitools::EyesLogger', :logger
 
+    CORE_MAKE_EC_CLIENT = 'Core.makeECClient'
     SESSION_INIT = 'Core.makeCore'
 
     CORE_MAKE_MANAGER = 'Core.makeManager'
@@ -25,14 +26,17 @@ module Applitools::Connectivity
     CORE_DELETE_TEST = 'Core.deleteTest'
 
     EYES_MANAGER_MAKE_EYES = 'EyesManager.openEyes'
-    EYES_MANAGER_CLOSE_ALL_EYES = 'EyesManager.closeManager'
+    EYES_MANAGER_CLOSE_ALL_EYES = 'EyesManager.getResults'
     EYES_CHECK = 'Eyes.check'
     EYES_CHECK_AND_CLOSE = 'Eyes.checkAndClose' # ...
     EYES_LOCATE = 'Core.locate'
-    EYES_EXTRACT_TEXT_REGIONS = 'Eyes.locateText'
-    EYES_EXTRACT_TEXT = 'Eyes.extractText'
+    EYES_EXTRACT_TEXT_REGIONS = 'Core.locateText'
+    EYES_EXTRACT_TEXT = 'Core.extractText'
     EYES_CLOSE = 'Eyes.close'
     EYES_ABORT = 'Eyes.abort'
+    EYES_GET_RESULTS = 'Eyes.getResults'
+
+    SERVER_LOG_EVENT_NAME = 'Logger.log'
 
     attr_accessor :commands_config
 
@@ -49,6 +53,37 @@ module Applitools::Connectivity
       }
     end
 
+    def core_make_ec_client(server_url, api_key, proxy)
+      # ECClientSettings
+      #
+      # {
+      #   "capabilities": { // default capabilities that will be used if user do not provide `applitools:` caps
+      #     "serverUrl": "https://eyesapi.applitools.com/",
+      #     "apiKey": "DFH$HJD%77333J355",
+      #   },
+      #   "proxy": {
+      #     "url": "http://localhost:8080",
+      #     "username": "username",
+      #     "password": "Pa$$w0rD"
+      #   },
+      # }
+      ec_client_capabilities = {}
+      ec_client_capabilities[:serverUrl] = server_url unless server_url.nil?
+      ec_client_capabilities[:apiKey] = api_key unless api_key.nil?
+      ec_client_settings = {}
+      ec_client_settings[:capabilities] = ec_client_capabilities unless ec_client_capabilities.empty?
+      ec_client_settings[:proxy] = proxy unless proxy.nil?
+      make_ec_client_request_payload = {settings: ec_client_settings}
+      # interface MakeECClientRequestPayload {
+      #   settings?: ECClientSettings
+      # }
+      #
+      # interface MakeECClientResponsePayload {
+      #   url: string
+      # }
+      command_with_result(CORE_MAKE_EC_CLIENT, make_ec_client_request_payload)
+    end
+
     def make_manager(eyes_manager_config)
       Applitools::EyesLogger.logger.debug "EyesManager config: #{eyes_manager_config}"
       eyes_manager = core_make_manager(eyes_manager_config)
@@ -134,18 +169,18 @@ module Applitools::Connectivity
     end
 
     def eyes_manager_close_all_eyes(manager)
-      # interface CloseManagerRequestPayload {
+      # interface GetManagerResultsRequestPayload {
       #   manager: Ref<EyesManager>
       #   settings?: {throwErr?: boolean}
       # }
       #
-      # interface CloseManagerResponsePayload {
-      #   results: Array<{
+      # interface GetManagerResultsResponsePayload {
+      #   results: {
       #     error?: Error
       #     result?: TestResult
       #     renderer?: TType extends 'ufg' ? Renderer : never
       #     userTestId: string
-      #   }>
+      #   }[]
       #   passed: number
       #   unresolved: number
       #   failed: number
@@ -154,7 +189,19 @@ module Applitools::Connectivity
       #   missing: number
       #   matches: number
       # }
-      command_with_result(EYES_MANAGER_CLOSE_ALL_EYES, {manager: manager, config: commands_config})
+      settings = {throwErr: false}
+      command_with_result(EYES_MANAGER_CLOSE_ALL_EYES, {manager: manager, settings: settings})
+    end
+
+    def eyes_get_results(eyes)
+      # interface GetEyesResultsPayload {
+      #   eyes: Ref<Eyes>
+      #   settings?: GetResultsSettings
+      # }
+      #
+      # type GetEyesResultsResponsePayload = TestResult[]
+      settings = {throwErr: false}
+      command_with_result(EYES_GET_RESULTS, {eyes: eyes, settings: settings})
     end
 
     def eyes_check(eyes, settings, image_target = {})
@@ -187,28 +234,26 @@ module Applitools::Connectivity
 
     def eyes_extract_text_regions(eyes, settings, driver_target)
       # interface LocateTextRequestPayload {
-      #   eyes: Ref<Eyes>
       #   target?: ImageTarget | DriverTarget
       #   settings?: LocateTextSettings
       #   config?: Config
       # }
       #
-      # type LocateTextResponcePayload = Record<string, Array<{text: string, x: number, y: number, width: number, hieght: number}>>
-      payload = {eyes: eyes, target: driver_target, settings: settings, config: commands_config}
+      # type LocateTextResponsePayload = Record<string, {text: string, x: number, y: number, width: number, height: number}[]>
+      payload = {target: driver_target, settings: settings, config: commands_config}
       payload.delete(:target) if driver_target.nil? || driver_target.empty?
       command_with_result(EYES_EXTRACT_TEXT_REGIONS, payload)
     end
 
     def eyes_extract_text(eyes, regions, driver_target)
       # interface ExtractTextRequestPayload {
-      #   eyes: Ref<Eyes>
       #   target?: ImageTarget | DriverTarget
       #   settings?: ExtractTextSettings | ExtractTextSettings[]
       #   config?: Config
       # }
       #
-      # type ExtractTextResponcePayload = string[]
-      payload = {eyes: eyes, target: driver_target, settings: regions, config: commands_config}
+      # type ExtractTextResponsePayload = string[]
+      payload = {target: driver_target, settings: regions, config: commands_config}
       payload.delete(:settings) if regions.empty?
       command_with_result(EYES_EXTRACT_TEXT, payload)
     end
@@ -220,19 +265,32 @@ module Applitools::Connectivity
       #   config?: Config
       # }
       #
-      # type CloseResponsePayload = TestResult[]
-      settings = {throwErr: false}
-
+      # type CloseResponsePayload = void
+      settings = commands_config[:close]
+      # CloseSettings
+      #
+      # {
+      #   "updateBaselineIfNew": true,
+      #   "updateBaselineIfDifferent": true
+      # }
       command_with_result(EYES_CLOSE, {eyes: eyes, settings: settings, config: commands_config})
     end
 
     def eyes_abort(eyes)
       # interface AbortPayload {
       #   eyes: Ref<Eyes>
+      #   settings?: CloseSettings
       # }
       #
-      # type AbortResponsePayload = TestResult[]
-      command_with_result(EYES_ABORT, {eyes: eyes})
+      # type AbortResponsePayload = void
+      settings = commands_config[:close]
+      # CloseSettings
+      #
+      # {
+      #   "updateBaselineIfNew": true,
+      #   "updateBaselineIfDifferent": true
+      # }
+      command_with_result(EYES_ABORT, {eyes: eyes, settings: settings})
     end
 
     def core_get_viewport_size(driver)
@@ -324,12 +382,17 @@ module Applitools::Connectivity
     end
 
     def session_init
+      init_agent_id = "eyes.ruby-sdk/#{Applitools::VERSION}".freeze
       make_core_payload = {
-        name: :rb,
-        version: Applitools::VERSION,
-        protocol: :webdriver,
-        cwd: Dir.pwd
+        agentId: init_agent_id,
+        cwd: Dir.pwd,
+        spec: :webdriver
       }
+      # interface MakeCorePayload {
+      #   agentId: string
+      #   cwd: string
+      #   spec: 'webdriver' | string[]
+      # }
       command(SESSION_INIT, make_core_payload)
       # no response
     end
@@ -364,7 +427,7 @@ module Applitools::Connectivity
       encoded_frame << web_socket_result
       decoded_frame = encoded_frame.next
       incoming_json = JSON.parse(decoded_frame.to_s)
-      if incoming_json['name'] === 'Server.log'
+      if incoming_json['name'] === SERVER_LOG_EVENT_NAME
         incoming_payload = incoming_json['payload']
         # incoming_payload['level']
         puts incoming_payload['message']
@@ -411,9 +474,9 @@ module Applitools::Connectivity
 
     def process_other_responses(other_responses)
       other_responses.each do |incoming_json|
-        if incoming_json['name'] === 'Server.log'
+        if incoming_json['name'] === SERVER_LOG_EVENT_NAME
           if ENV['APPLITOOLS_SHOW_UNIVERSAL_LOGS']
-            Applitools::EyesLogger.logger.debug "[Server.log] #{incoming_json['payload']['message']}"
+            Applitools::EyesLogger.logger.debug "[#{SERVER_LOG_EVENT_NAME}] #{incoming_json['payload']['message']}"
           end
         else
           Applitools::EyesLogger.logger.info "[Server.info] #{incoming_json}"

data/lib/applitools/universal_sdk/universal_eyes.rb

@@ -28,6 +28,10 @@ module Applitools
       @universal_client.eyes_abort(@eyes)
     end
 
+    def eyes_get_results
+      @universal_client.eyes_get_results(@eyes)
+    end
+
     def locate(settings, driver_target)
       @universal_client.eyes_locate(@eyes, settings, driver_target)
     end

data/lib/applitools/universal_sdk/universal_eyes_manager.rb

@@ -11,6 +11,7 @@ module Applitools
     def initialize(manager, universal_client)
       @manager = manager
       @universal_client = universal_client
+      @opened_eyes = []
     end
 
     def open_eyes(driver_config_json, config)
@@ -31,10 +32,13 @@ module Applitools
 
       Applitools::EyesLogger.logger.debug "Eyes applitools-ref-id: #{@eyes[:"applitools-ref-id"]}"
       # U-Notes : !!! Eyes.new
-      Applitools::UniversalEyes.new(@eyes, @universal_client)
+      universal_eyes = Applitools::UniversalEyes.new(@eyes, @universal_client)
+      @opened_eyes.push(universal_eyes)
+      universal_eyes
     end
 
     def close_all_eyes
+      @opened_eyes.each {|universal_eye| universal_eye.close }
       @universal_client.eyes_manager_close_all_eyes(@manager)
     end
 

data/lib/applitools/universal_sdk/universal_server_control.rb

@@ -58,7 +58,7 @@ module Applitools::Connectivity
       @port_pipe, port_w = IO.pipe
 
       @usdk_pid = spawn(
-        EXECUTABLE_FILEPATH, '--no-singleton', '--shutdown-mode', 'stdin',
+        EXECUTABLE_FILEPATH, 'universal', '--no-singleton', '--shutdown-mode', 'stdin',
         in: in_pipe, out: port_w, err: port_w,
         # close_others: true
       )

data/lib/applitools/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '4.5.5'.freeze
-  IMAGES_VERSION = '4.1.2'.freeze
-  UNIVERSAL_VERSION = '3.2.2'.freeze
+  VERSION = '4.6.0'.freeze
+  IMAGES_VERSION = '4.2.0'.freeze
+  UNIVERSAL_VERSION = '3.3.0'.freeze
+  UNIVERSAL_CORE_VERSION = '2.3.10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 4.5.5
+  version: 4.6.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement