eyes_core 4.1.1 → 4.1.4.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c116a6e522739b1716552ad9e5c33e64b19c9a3f5bf4f0adef899d5384813647
-  data.tar.gz: b2fcacf6df345e0b2c74f428c64883cca0e5f38468f330ff0ea26c29793f4e7a
+  metadata.gz: '06873812db14dca17bf822afa62312ce9b96ded582806d2e385563d6883e835a'
+  data.tar.gz: 3d47f41090e024ac372221896fe2363a0e37b5cb8e16cf7538a95a18cece20f8
 SHA512:
-  metadata.gz: 677efbddf2a5eab5e782e08a8eeb6f9107aa7bd40ecf96509688cd67205d767093fa48da27a21ec24a6fe0fef0f223d22150773fee985fb2699abf74b3238780
-  data.tar.gz: 3dc4ebbf3e97e32c1d15b809ed78f48011de9b7e2cfe49114a683d73ce0cd3b26167101c8e419d8253c0f71278d34e43a014db256605d9cf622747a5cc885967
+  metadata.gz: 99cb64b1acd89cf34cce08e8eaac564f8b41bfe934080abae0e318023e3c151f0319455e16840a04bf89e7d596be8adea29f97c91d97f250972196906b369d70
+  data.tar.gz: 7e7ebc80521f3f44e3f492789efe3bac61292d229f16c601e3b12eab48d56d0dcb729f843f58b6e73ef0495aa69f196eabab551de87773a8edfea7ad8af48486

data/lib/applitools/core/padding_bounds.rb

@@ -23,5 +23,15 @@ module Applitools
 
     ZERO_PADDING = PaddingBounds.new(0, 0, 0, 0).freeze
     PIXEL_PADDING = PaddingBounds.new(1, 1, 1, 1).freeze
+
+    def to_hash
+      {
+        left: padding_left,
+        top: padding_top,
+        right: padding_right,
+        bottom: padding_bottom
+      }
+    end
+
   end
 end

data/lib/applitools/universal_sdk/executable_finder.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Applitools::Connectivity
+  module UniversalServerGemFinder
+    extend self
+
+    SERVER_GEM_NAME = 'eyes_universal'
+
+    def filepath
+      server_lib ? File.join(server_lib.gem_dir, 'ext', 'eyes-universal', filename) : ''
+    end
+
+    def executable_filepath
+      raise 'Universal server unrecognized' unless File.exist?(filepath) && File.executable?(filepath)
+      filepath
+    end
+
+    private
+
+    def server_lib
+      Gem::Specification.find_by_name(SERVER_GEM_NAME)
+    rescue Gem::MissingSpecError
+      nil
+    end
+
+    def filename
+      return 'eyes-universal-win.exe' if Gem.win_platform?
+      case RUBY_PLATFORM
+        when /mswin|windows|mingw/i
+          'eyes-universal-win.exe'
+        when /musl/i
+          'eyes-universal-alpine'
+        when /linux|arch/i
+          'eyes-universal-linux'
+        when /darwin/i
+          'eyes-universal-macos'
+        else
+          raise 'Unsupported platform'
+      end
+    end
+
+  end
+end

data/lib/applitools/universal_sdk/universal_client.rb

@@ -132,7 +132,8 @@ module Applitools::Connectivity
 
 
     def prepare_socket
-      @web_socket = ::Applitools::Connectivity::UniversalServer.check_or_run
+      @universal_server_control = Applitools::Connectivity::UniversalServerControl.instance
+      @web_socket = @universal_server_control.new_server_socket_connection
       socket_handshake
       session_init
       # connect_and_configure_socket(socket_uri)
@@ -165,9 +166,7 @@ module Applitools::Connectivity
 
 
     def socket_handshake
-      ip = @web_socket.remote_address.ip_address
-      port = @web_socket.remote_address.ip_port
-      socket_uri = "ws://#{ip}:#{port}/eyes"
+      socket_uri = "ws://#{@web_socket.remote_address.inspect_sockaddr}/eyes"
       handshake = WebSocket::Handshake::Client.new(url: socket_uri)
       @web_socket.write(handshake)
       web_socket_result = receive_result('handshake')
@@ -234,10 +233,54 @@ module Applitools::Connectivity
       end
     end
 
+    def get_command_result(name, key)
+      web_socket_result = receive_result(name)
+      results = convert_web_socket_result(web_socket_result)
+
+      this_key_responses, other_responses = results.partition {|h| h['name'] === name && h['key'] === key}
+      process_other_responses other_responses
+
+      if this_key_responses.empty?
+        get_command_result(name, key)
+      elsif this_key_responses.size === 1
+        convert_responses(this_key_responses)
+      else # size > 1
+        raise Applitools::EyesError.new "Result mismatch : #{name} #{key} (#{this_key_responses})"
+      end
+    end
+
+    def convert_web_socket_result(web_socket_result)
+      encoded_frame = WebSocket::Frame::Incoming::Client.new(version: @handshake_version)
+      encoded_frame << web_socket_result
+      decoded_frames = []
+      until (decoded_frame = encoded_frame.next).nil?
+        decoded_frames.push(decoded_frame)
+      end
+      decoded_frames.map {|frame| JSON.parse(frame.to_s)}
+    end
+
+    def process_other_responses(other_responses)
+      other_responses.each do |incoming_json|
+        if incoming_json['name'] === 'Server.log'
+          if ENV['APPLITOOLS_SHOW_UNIVERSAL_LOGS']
+            Applitools::EyesLogger.logger.debug "[Server.log] #{incoming_json['payload']['message']}"
+          end
+        else
+          Applitools::EyesLogger.logger.info "[Server.info] #{incoming_json}"
+        end
+      end
+    end
+
+    def convert_responses(one_response_array)
+      incoming_json = one_response_array.first
+      incoming_payload = incoming_json['payload']
+      result = incoming_payload.key?('error') ? incoming_payload['error'] : incoming_payload['result']
+      Applitools::Utils.deep_symbolize_keys result
+    end
+
     def command_with_result name, payload, key = SecureRandom.uuid
       command(name, payload, key)
-      web_socket_result = receive_result(name)
-      format_result(name, key, web_socket_result)
+      get_command_result(name, key)
     end
 
   end

data/lib/applitools/universal_sdk/universal_server_control.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Applitools::Connectivity
+  class UniversalServerControl
+
+    include Singleton
+
+    DEFAULT_SERVER_IP = '127.0.0.1'
+    EXECUTABLE_FILEPATH = Applitools::Connectivity::UniversalServerGemFinder.executable_filepath
+
+    def initialize
+      @control_pipe = nil
+      @port_pipe = nil
+      @usdk_pid = nil
+      @monitoring_thread = nil
+      @port = nil
+      start_server_with_pipe
+      @sockets = []
+    end
+
+    def server_port
+      @port
+    end
+
+    def new_server_socket_connection
+      begin
+        socket = TCPSocket.new(DEFAULT_SERVER_IP, @port)
+        @sockets.push(socket)
+        socket
+      rescue Errno::ECONNREFUSED
+        nil
+      end
+    end
+
+    def server_running?
+      return false if @monitoring_thread.nil?
+      monitoring_result = @monitoring_thread.join(1)
+      monitoring_result.nil?
+    end
+
+    def stop_server
+      return if @control_pipe.nil?
+      @control_pipe.close_write
+      @sockets.each {|socket| socket.close unless socket.closed? }
+      sleep(1)
+    end
+
+    def to_s # for test & debug
+      "SDKServer(port=#{@port}; pid=#{@usdk_pid})"
+    end
+
+    private
+
+    def start_server_with_pipe
+      in_pipe, @control_pipe = IO.pipe
+      @port_pipe, port_w = IO.pipe
+
+      @usdk_pid = spawn(
+        EXECUTABLE_FILEPATH, '--no-singleton', '--shutdown-mode', 'stdin',
+        in: in_pipe, out: port_w, err: port_w,
+        # close_others: true
+      )
+      in_pipe.close_read
+      port_w.close_write
+
+      @monitoring_thread = Process.detach(@usdk_pid)
+
+      @port = @port_pipe.readline.strip.to_i
+      @port_pipe.close_read
+
+      if ENV['APPLITOOLS_SHOW_LOGS']
+        Applitools::EyesLogger.logger.debug("Started Universal SDK server at #{@port} pid = #{@usdk_pid}")
+      end
+    end
+
+  end
+end

data/lib/applitools/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '4.1.1'.freeze
-  UNIVERSAL_VERSION = '2.8.0'.freeze
+  VERSION = '4.1.4.beta'.freeze
+  UNIVERSAL_VERSION = '2.10.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.1.4.beta
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.10.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -386,6 +386,7 @@ files:
 - lib/applitools/method_tracer.rb
 - lib/applitools/rspec/target_matcher.rb
 - lib/applitools/sauce.rb
+- lib/applitools/universal_sdk/executable_finder.rb
 - lib/applitools/universal_sdk/universal_check_settings.rb
 - lib/applitools/universal_sdk/universal_client.rb
 - lib/applitools/universal_sdk/universal_client_socket.rb
@@ -394,6 +395,7 @@ files:
 - lib/applitools/universal_sdk/universal_eyes_manager.rb
 - lib/applitools/universal_sdk/universal_eyes_manager_config.rb
 - lib/applitools/universal_sdk/universal_server.rb
+- lib/applitools/universal_sdk/universal_server_control.rb
 - lib/applitools/utils/eyes_selenium_utils.rb
 - lib/applitools/utils/image_delta_compressor.rb
 - lib/applitools/utils/image_utils.rb
@@ -420,9 +422,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.14
 signing_key: