Class: Applitools::Selenium::RenderTask

Inherits:
VGTask
  • Object
show all
Includes:
Jsonable
Defined in:
lib/applitools/selenium/visual_grid/render_task.rb

Constant Summary collapse

MAX_FAILS_COUNT = 
5
MAX_ITERATIONS = 
100

Instance Attribute Summary collapse

Attributes inherited from VGTask

#name, #uuid

Instance Method Summary collapse

Methods inherited from VGTask

#call, #on_task_completed, #on_task_error, #on_task_succeeded

Constructor Details

#initialize(name, script_result, running_test, resource_cache, put_cache, rendering_info, server_connector, region_selectors, size_mode, region, script_hooks, mod = nil) ⇒ RenderTask

Returns a new instance of RenderTask.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 15

def initialize(name, script_result, running_test, resource_cache, put_cache, rendering_info, server_connector, region_selectors, size_mode, region, script_hooks, mod = nil)
  self.result = nil
  self.script = script_result
  self.running_test = running_test
  self.resource_cache = resource_cache
  self.put_cache = put_cache
  self.server_connector = server_connector
  self.rendering_info = rendering_info
  self.region_selectors = region_selectors
  self.size_mode = size_mode
  self.region_to_check = region
  self.script_hooks = script_hooks if script_hooks.is_a?(Hash)

  self.dom_url_mod = mod
  super(name) do
    perform
  end
end

Instance Attribute Details

#all_blobs ⇒ Object

Returns the value of attribute all_blobs.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def all_blobs
  @all_blobs
end

#dom_url_mod ⇒ Object

Returns the value of attribute dom_url_mod.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def dom_url_mod
  @dom_url_mod
end

#put_cache ⇒ Object

Returns the value of attribute put_cache.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def put_cache
  @put_cache
end

#region_selectors ⇒ Object

Returns the value of attribute region_selectors.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def region_selectors
  @region_selectors
end

#region_to_check ⇒ Object

Returns the value of attribute region_to_check.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def region_to_check
  @region_to_check
end

#rendering_info ⇒ Object

Returns the value of attribute rendering_info.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def rendering_info
  @rendering_info
end

#request_resources ⇒ Object

Returns the value of attribute request_resources.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def request_resources
  @request_resources
end

#resource_cache ⇒ Object

Returns the value of attribute resource_cache.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def resource_cache
  @resource_cache
end

#resource_urls ⇒ Object

Returns the value of attribute resource_urls.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def resource_urls
  @resource_urls
end

#result ⇒ Object

Returns the value of attribute result.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def result
  @result
end

#running_test ⇒ Object

Returns the value of attribute running_test.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def running_test
  @running_test
end

#script ⇒ Object

Returns the value of attribute script.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def script
  @script
end

#script_hooks ⇒ Object

Returns the value of attribute script_hooks.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def script_hooks
  @script_hooks
end

#server_connector ⇒ Object

Returns the value of attribute server_connector.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def server_connector
  @server_connector
end

#size_mode ⇒ Object

Returns the value of attribute size_mode.



11
12
13
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 11

def size_mode
  @size_mode
end

Instance Method Details

#perform ⇒ Object

Raises:

  • (Applitools::EyesError) 


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 34

def perform
  requests = Applitools::Selenium::RenderRequests.new
  rq = prepare_data_for_rg(script_data)
  requests << rq
  fetch_fails = 0
  # still_running = false
  # need_more_dom = false
  begin
    response = nil
    begin
      response = server_connector.render(rendering_info['serviceUrl'], rendering_info['accessToken'], requests)
    # rescue StandardError => _e
    #   response = server_connector.render(rendering_info['serviceUrl'], rendering_info['accessToken'], requests)
    rescue StandardError => e
      Applitools::EyesLogger.error(e.message)
      fetch_fails += 1
      sleep 2
    end
    next unless response
    running_render = response.first
    rq.render_id = running_render['renderId']
    need_more_dom = running_render['needMoreDom']
    need_more_resources = running_render['renderStatus'] == 'need-more-resources'
    still_running = need_more_resources || need_more_dom || fetch_fails > MAX_FAILS_COUNT

    dom_resource = rq.dom.resource

    cache_key = URI(dom_resource.url)
    cache_key.query = "modifier=#{dom_url_mod}" if dom_url_mod

    running_render['needMoreResources'].each do |resource_url|
      put_cache.fetch_and_store(URI(resource_url)) do |_s|
        server_connector.render_put_resource(
            rendering_info['serviceUrl'],
            rendering_info['accessToken'],
            request_resources[URI(resource_url)],
            running_render
        )
      end
    end if need_more_resources

    if need_more_dom
      put_cache.fetch_and_store(cache_key) do |_s|
        server_connector.render_put_resource(
            rendering_info['serviceUrl'],
            rendering_info['accessToken'],
            dom_resource,
            running_render
        )
      end
      put_cache[cache_key]
    end

  end while(still_running)
  statuses = poll_render_status(rq)
  raise Applitools::EyesError, "Render failed for #{statuses.first['renderId']} with the message: " \
    "#{statuses.first['error']}" if statuses.first['status'] == 'error'
  self.result = statuses.first
  statuses
end

#poll_render_status(rq) ⇒ Object

Raises:

  • (Applitools::EyesError) 


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 95

def poll_render_status(rq)
  iterations = 0
  statuses = []
  raise Applitools::EyesError, 'RenderStatus: Got empty renderId!' unless rq.render_id.is_a?(String) && !rq.render_id.empty?
  begin
    fails_count = 0
    proc = proc do
      server_connector.render_status_by_id(
          rendering_info['serviceUrl'],
          rendering_info['accessToken'],
          Oj.dump(json_value([rq.render_id]))
      )
    end
    begin
      statuses = proc.call
      fails_count = 0
    rescue StandardError => _e
      sleep 1
      fails_count = fails_count + 1
    ensure
      iterations+=1
      sleep 0.5
    end while(fails_count > 0 and fails_count < 3)
    finished = statuses.first.is_a?(Hash) && (statuses.first['status'] == 'error' || statuses.first['status'] == 'rendered' || iterations > MAX_ITERATIONS || false)
  end while(!finished)
  statuses
end

#prepare_data_for_rg(data) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 128

def prepare_data_for_rg(data)
  self.all_blobs = data["blobs"]
  self.resource_urls = data["resourceUrls"]
  self.request_resources = Applitools::Selenium::RenderResources.new

  all_blobs.map {|blob| Applitools::Selenium::VGResource.parse_blob_from_script(blob)}.each do |blob|
    request_resources[blob.url] = blob
  end
  resource_urls.each do |url|
    resource_cache.fetch_and_store(URI(url)) do |s|
      resp_proc = proc { |u| server_connector.download_resource(u) }
      retry_count = 3
      begin
        retry_count -= 1
        response = resp_proc.call(url)
      end while response.status != 200 && retry_count > 0
      s.synchronize do
        Applitools::Selenium::VGResource.parse_response(url, response)
      end
    end
  end

  resource_urls.each do |u|
    key = URI(u)
    request_resources[key] = resource_cache[key]
  end

  r_info = Applitools::Selenium::RenderInfo.new.tap do |r|
    r.width = running_test.browser_info.viewport_size.width
    r.height = running_test.browser_info.viewport_size.height
    r.size_mode = size_mode
    r.region = region_to_check
    r.emulation_info = running_test.browser_info.emulation_info if running_test.browser_info.emulation_info
  end

  dom = Applitools::Selenium::RGridDom.new(
    url: script_data["url"], dom_nodes: script_data['cdt'], resources: request_resources
  )

  Applitools::Selenium::RenderRequest.new(
    webhook: rendering_info["resultsUrl"],
    url: script_data["url"],
    dom: dom,
    resources: request_resources,
    render_info: r_info,
    browser: {name: running_test.browser_info.browser_type, platform: running_test.browser_info.platform},
    script_hooks: script_hooks,
    selectors_to_find_regions_for: region_selectors,
    send_dom: running_test.eyes.config.send_dom.nil? ? false.to_s : running_test.eyes.config.send_dom.to_s
  )
end

#script_data ⇒ Object 



123
124
125
126
 
# File 'lib/applitools/selenium/visual_grid/render_task.rb', line 123

def script_data
  # @script_data ||= Oj.load script
  @script_data ||= script
end