Class: Applitools::Selenium::DomSnapshotScript::RecursiveSnapshotter

Inherits:
Object
  • Object
show all
Defined in:
lib/applitools/selenium/visual_grid/dom_snapshot_script.rb

Constant Summary collapse

POLL_INTERVAL_MS = 
0.5

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(driver, script, cross_origin_rendering, use_cookies) ⇒ RecursiveSnapshotter

Returns a new instance of RecursiveSnapshotter.



101
102
103
104
105
106
107
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 101

def initialize(driver, script, cross_origin_rendering, use_cookies)
  self.should_skip_failed_frames = true
  self.driver = driver
  self.script = script
  self.cross_origin_rendering = cross_origin_rendering
  self.use_cookies = use_cookies
end

Instance Attribute Details

#cross_origin_rendering ⇒ Object

Returns the value of attribute cross_origin_rendering.



99
100
101
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 99

def cross_origin_rendering
  @cross_origin_rendering
end

#driver ⇒ Object

Returns the value of attribute driver.



99
100
101
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 99

def driver
  @driver
end

#script ⇒ Object

Returns the value of attribute script.



99
100
101
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 99

def script
  @script
end

#should_skip_failed_frames ⇒ Object

Returns the value of attribute should_skip_failed_frames.



97
98
99
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 97

def should_skip_failed_frames
  @should_skip_failed_frames
end

#use_cookies ⇒ Object

Returns the value of attribute use_cookies.



99
100
101
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 99

def use_cookies
  @use_cookies
end

Instance Method Details

#create_cross_frames_dom_snapshots ⇒ Object 



109
110
111
112
113
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 109

def create_cross_frames_dom_snapshots
  dom = create_dom_snapshot_threaded
  process_dom_snapshot_frames dom
  dom
end

#create_dom_snapshot_threaded ⇒ Object 



115
116
117
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 115

def create_dom_snapshot_threaded
  script.run
end

#process_dom_snapshot_frames(dom) ⇒ Object 



119
120
121
122
123
124
125
126
127
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
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 119

def process_dom_snapshot_frames dom
  dom["cookies"] = driver.manage.all_cookies if use_cookies

  dom["frames"].each do |frame|
    selector = frame['selector']
    unless selector
      Applitools::EyesLogger.warn "inner frame with null selector"
      next
    end
    begin
      original_frame_chain = driver.frame_chain
      frame_element = driver.find_element(:css, selector)
      frame_src = frame_element.attribute('src')
      Applitools::EyesLogger.info "process_dom_snapshot_frames src = #{frame_src}"
      driver.switch_to.frame(frame_element)

      process_dom_snapshot_frames frame

      driver.switch_to.default_content
      unless original_frame_chain.empty?
        driver.switch_to.frames frame_chain: original_frame_chain
      end
    rescue StandardError => e
      Applitools::EyesLogger.error e.class.to_s
      Applitools::EyesLogger.error e.message
      if should_skip_failed_frames
        Applitools::EyesLogger.warn "failed switching to frame #{selector}"
      else
        raise ::Applitools::EyesError.new 'failed switching to frame'
      end
    end
  end

  self.snapshot_and_process_cors_frames(dom) if self.cross_origin_rendering
end

#snapshot_and_process_cors_frames(dom) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/applitools/selenium/visual_grid/dom_snapshot_script.rb', line 155

def snapshot_and_process_cors_frames(dom)
  dom["crossFrames"].each do |frame|
    selector = frame['selector']
    unless selector
      Applitools::EyesLogger.warn "cross frame with null selector"
      next
    end
    frame_index = frame['index']
    begin
      original_frame_chain = driver.frame_chain
      frame_element = driver.find_element(:css, selector) #
      frame_src = frame_element.attribute('src')
      Applitools::EyesLogger.info "snapshot_and_process_cors_frames src = #{frame_src}"
      driver.switch_to.frame(frame_element)

      frame_dom = create_cross_frames_dom_snapshots
      dom['frames'] ||= []
      dom['frames'].push frame_dom
      frame_url = frame_dom['url']
      dom['cdt'][frame_index]['attributes'].push({ 'name' => 'data-applitools-src', 'value' => frame_url })
      Applitools::EyesLogger.info "Created cross origin frame snapshot #{frame_url}"
      process_dom_snapshot_frames frame_dom

      driver.switch_to.default_content
      unless original_frame_chain.empty?
        driver.switch_to.frames(frame_chain: original_frame_chain)
      end
    rescue StandardError => e
      Applitools::EyesLogger.error e.class.to_s
      Applitools::EyesLogger.error e.message
      if should_skip_failed_frames
        Applitools::EyesLogger.warn "failed extracting and processing cross frame #{selector}"
      else
        raise ::Applitools::EyesError.new 'failed switching to frame'
      end
    end
  end
end