Class: Applitools::Connectivity::ServerConnector

Inherits:
Object
  • Object
show all
Extended by:
Helpers
Defined in:
lib/applitools/connectivity/server_connector.rb

Defined Under Namespace

Classes: ScreenshotUploadError

Constant Summary collapse

DEFAULT_SERVER_URL = 
'https://eyesapi.applitools.com'.freeze
SSL_CERT = 
File.join(File.dirname(File.expand_path(__FILE__)), '../../../certs/cacert.pem').to_s.freeze
DEFAULT_TIMEOUT = 
300
API_SESSIONS = 
'/api/sessions'.freeze
API_SESSIONS_RUNNING = 
API_SESSIONS + '/running/'.freeze
API_SINGLE_TEST = 
API_SESSIONS + '/'.freeze
RENDER_INFO_PATH = 
API_SESSIONS + '/renderinfo'.freeze
RENDER = 
'/render'.freeze
RESOURCES_SHA_256 = 
'/resources/sha256/'.freeze
RENDER_STATUS = 
'/render-status'.freeze
CLOSE_BATCH = 
'/api/sessions/batches/%s/close/bypointerid'.freeze
HTTP_STATUS_CODES = 
{
  created: 201,
  accepted: 202,
  ok: 200,
  gone: 410
}.freeze
RETRY_DELAY = 
0.5
RETRY_STEP_FACTOR = 
1.5
RETRY_MAX_DELAY = 
5

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers

abstract_attr_accessor, abstract_method, env_variable, environment_attribute, environment_variables

Constructor Details

#initialize(url = nil) ⇒ ServerConnector

Returns a new instance of ServerConnector.



42
43
44
 
# File 'lib/applitools/connectivity/server_connector.rb', line 42

def initialize(url = nil)
  self.server_url = url
end

Instance Attribute Details

#endpoint_url ⇒ Object (readonly)

Returns the value of attribute endpoint_url.



38
39
40
 
# File 'lib/applitools/connectivity/server_connector.rb', line 38

def endpoint_url
  @endpoint_url
end

#proxy ⇒ Object

Returns the value of attribute proxy.



39
40
41
 
# File 'lib/applitools/connectivity/server_connector.rb', line 39

def proxy
  @proxy
end

#server_url ⇒ Object

Returns the value of attribute server_url.



37
38
39
 
# File 'lib/applitools/connectivity/server_connector.rb', line 37

def server_url
  @server_url
end

Instance Method Details

#close_batch(batch_id) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/applitools/connectivity/server_connector.rb', line 176

def close_batch(batch_id)
  if 'true'.casecmp(ENV['APPLITOOLS_DONT_CLOSE_BATCHES'] || '') == 0
    return Applitools::EyesLogger.info(
      'APPLITOOLS_DONT_CLOSE_BATCHES environment variable set to true. Doing nothing.'
    ) && false
  end
  Applitools::ArgumentGuard.not_nil(batch_id, 'batch_id')
  Applitools::EyesLogger.info("Called with #{batch_id}")
  url = CLOSE_BATCH % batch_id
  response = delete(URI.join(endpoint_url, url))
  Applitools::EyesLogger.info "delete batch is done with #{response.status} status"
end

#download_resource(url, ua_string = nil) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/applitools/connectivity/server_connector.rb', line 153

def download_resource(url, ua_string = nil)
  Applitools::EyesLogger.debug "Fetching #{url}..."
  resp_proc = proc do |u|
    Faraday::Connection.new(
      u,
      ssl: { ca_file: SSL_CERT },
      proxy: @proxy.nil? ? nil : @proxy.to_hash
    ).send(:get) do |req|
      req.options.timeout = DEFAULT_TIMEOUT
      req.headers['Accept-Encoding'] = 'identity'
      req.headers['User-Agent'] = ua_string if ua_string
    end
  end
  response = resp_proc.call(url)
  redirect_count = 10
  while response.status == 301 && redirect_count > 0
    redirect_count -= 1
    response = resp_proc.call(response.headers['location'])
  end
  Applitools::EyesLogger.debug 'Done!'
  response
end

#match_single_window(data) ⇒ Object 



264
265
266
267
 
# File 'lib/applitools/connectivity/server_connector.rb', line 264

def match_single_window(data)
  res = match_single_window_data(data)
  Applitools::TestResults.new Oj.load(res.body)
end

#match_single_window_data(data) ⇒ Object

Raises:

  • (Applitools::EyesError) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/applitools/connectivity/server_connector.rb', line 236

def match_single_window_data(data)
  # Notice that this does not include the screenshot.
  json_data = Oj.dump(data.to_hash).force_encoding('BINARY')
  body = [json_data.length].pack('L>') + json_data + data.screenshot
  # Applitools::EyesLogger.debug json_data
  begin
    Applitools::EyesLogger.debug 'Sending match data...'
    res = long_post(
      @single_check_endpoint_url,
      content_type: 'application/octet-stream',
      body: body,
      query: { agent_id: data.agent_id }
    )
  rescue Errno::EWOULDBLOCK, Faraday::ConnectionFailed
    @delays ||= request_delay(RETRY_DELAY, RETRY_STEP_FACTOR, RETRY_MAX_DELAY)
    begin
      sleep @delays.next
    rescue StopIteration
      raise Applitools::UnknownNetworkStackError.new('Unknown network stack error')
    end
    res = match_single_window_data(data)
  ensure
    @delays = nil
  end
  raise Applitools::EyesError.new("Request failed: #{res.status} #{res.headers} #{res.body}") unless res.success?
  res
end

#match_window(session, data) ⇒ Object

Raises:

  • (Applitools::EyesError) 


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/applitools/connectivity/server_connector.rb', line 212

def match_window(session, data)
  # Notice that this does not include the screenshot.
  json_data = Oj.dump(Applitools::Utils.camelcase_hash_keys(data.to_hash)).force_encoding('BINARY')

  body = if data.screenshot && data.app_output.screenshot_url.nil?
           content_type = 'application/octet-stream'
           [json_data.length].pack('L>') + json_data + data.screenshot
         else
           content_type = 'application/json'
           json_data
         end

  Applitools::EyesLogger.debug 'Sending match data...'
  Applitools::EyesLogger.debug json_data
  res = long_post(URI.join(endpoint_url, session.id.to_s), content_type: content_type, body: body)
  raise Applitools::EyesError.new("Request failed: #{res.status} #{res.headers}") unless res.success?
  # puts Oj.load(res.body)
  Applitools::MatchResult.new Oj.load(res.body)
end

#post_dom_json(dom_data, rendering_info) ⇒ Object 



290
291
292
293
294
295
296
297
298
 
# File 'lib/applitools/connectivity/server_connector.rb', line 290

def post_dom_json(dom_data, rendering_info)
  Applitools::EyesLogger.debug 'About to send captured DOM...'
  request_body = dom_data
  Applitools::EyesLogger.debug request_body
  processed_request_body = yield(request_body) if block_given?
  location = put_dom(rendering_info, processed_request_body)
  Applitools::EyesLogger.debug 'Done!'
  location
end

#put_data(rendering_info, data, content_type, log_message_entity) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/applitools/connectivity/server_connector.rb', line 78

def put_data(rendering_info, data, content_type, log_message_entity)
  uuid = SecureRandom.uuid
  upload_path = URI.parse(rendering_info.results_url.gsub(/__random__/, uuid))
  retry_count = 3
  wait = 0.5
  loop do
    raise ScreenshotUploadError, "Error uploading #{log_message_entity} (#{upload_path})" if retry_count <= 0
    Applitools::EyesLogger.info("Trying to upload #{log_message_entity} (#{upload_path})...")
    begin
      response = dummy_put(
        upload_path,
        body: data,
        headers: {
          'x-ms-blob-type': 'BlockBlob',
          'X-Auth-Token': rendering_info.access_token
        },
        query: URI.decode_www_form(upload_path.query).to_h,
        content_type: content_type
      )
      break if response.status == HTTP_STATUS_CODES[:created]
      Applitools::EyesLogger.info("Failed. Retrying in #{wait} seconds")
      sleep(wait)
    rescue StandardError => e
      Applitools::EyesLogger.error(e.class.to_s)
      Applitools::EyesLogger.error(e.message)
      Applitools::EyesLogger.info("Failed. Retrying in #{wait} seconds")
      sleep(wait)
    ensure
      retry_count -= 1
      wait *= 2
    end
  end
  Applitools::EyesLogger.info('Done.')
  upload_path.to_s
end

#put_dom(rendering_info, dom_data) ⇒ Object 



74
75
76
 
# File 'lib/applitools/connectivity/server_connector.rb', line 74

def put_dom(rendering_info, dom_data)
  put_data(rendering_info, dom_data, 'application/octet-stream', 'dom data')
end

#put_screenshot(rendering_info, screenshot) ⇒ Object 



70
71
72
 
# File 'lib/applitools/connectivity/server_connector.rb', line 70

def put_screenshot(rendering_info, screenshot)
  put_data(rendering_info, screenshot.image.to_blob, 'image/png', 'screenshot')
end

#render(service_url, access_key, requests) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/applitools/connectivity/server_connector.rb', line 54

def render(service_url, access_key, requests)
  uri = URI.join(URI(service_url), RENDER)
  response = dummy_post(
    uri,
    body: requests.json,
    headers: {
      'X-Auth-Token' => access_key
    },
    timeout: 10
  )
  unless response.status == HTTP_STATUS_CODES[:ok]
    raise Applitools::EyesError, "Error render processing (#{response.status}, #{response.body})"
  end
  Oj.load response.body
end

#render_put_resource(service_url, access_key, resource, render) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/applitools/connectivity/server_connector.rb', line 114

def render_put_resource(service_url, access_key, resource, render)
  uri = URI(service_url)
  uri.path = RESOURCES_SHA_256 + resource.hash
  Applitools::EyesLogger.debug("PUT resource: (#{resource.url}) - #{uri}")
  # Applitools::EyesLogger.debug("Resource content: #{resource.content}")
  response = dummy_put(
    uri,
    body: resource.content,
    content_type: resource.content_type,
    headers: {
      'X-Auth-Token' => access_key
    },
    query: { 'render-id' => render['renderId'] }
  )
  unless response.status == HTTP_STATUS_CODES[:ok]
    raise Applitools::EyesError, "Error putting resource: #{response.status}, #{response.body}"
  end
  resource.hash
end

#render_status_by_id(service_url, access_key, running_renders_json) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/applitools/connectivity/server_connector.rb', line 134

def render_status_by_id(service_url, access_key, running_renders_json)
  uri = URI(service_url)
  uri.path = RENDER_STATUS
  response = dummy_post(
    uri,
    body: running_renders_json,
    content_type: 'application/json',
    headers: {
      'X-Auth-Token' => access_key
    },
    timeout: 2
  )
  unless response.status == HTTP_STATUS_CODES[:ok]
    raise Applitools::EyesError, "Error getting server status, #{response.status} #{response.body}"
  end

  Oj.load(response.body)
end

#rendering_info ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/applitools/connectivity/server_connector.rb', line 46

def rendering_info
  response = long_get(URI.join(server_url, RENDER_INFO_PATH), content_type: 'application/json')
  unless response.status == HTTP_STATUS_CODES[:ok]
    raise Applitools::EyesError, "Error getting render info (#{response.status}})"
  end
  Oj.load response.body
end

#set_proxy(uri, user = nil, password = nil) ⇒ Object 



200
201
202
 
# File 'lib/applitools/connectivity/server_connector.rb', line 200

def set_proxy(uri, user = nil, password = nil)
  self.proxy = Proxy.new uri, user, password
end

#start_session(session_start_info) ⇒ Object

Raises:

  • (Applitools::EyesError) 


269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/applitools/connectivity/server_connector.rb', line 269

def start_session(session_start_info)
  request_body = Oj.dump(
    startInfo: Applitools::Utils.camelcase_hash_keys(session_start_info.to_hash)
  )
  res = long_post(
    endpoint_url, body: request_body
  )
  raise Applitools::EyesError.new("Request failed: #{res.status} #{res.body} #{request_body}") unless res.success?

  response = Oj.load(res.body)
  Applitools::Session.new(response['id'], response['url'], res.status == HTTP_STATUS_CODES[:created])
end

#stop_session(session, aborted = nil, save = false) ⇒ Object

Raises:

  • (Applitools::EyesError) 


282
283
284
285
286
287
288
 
# File 'lib/applitools/connectivity/server_connector.rb', line 282

def stop_session(session, aborted = nil, save = false)
  res = long_delete(URI.join(endpoint_url, session.id.to_s), query: { aborted: aborted, updateBaseline: save })
  raise Applitools::EyesError.new("Request failed: #{res.status}") unless res.success?

  response = Oj.load(res.body)
  Applitools::TestResults.new(response)
end