Class: Puppeteer::FrameManager

Inherits:
Object
  • Object
show all
Includes:
DebugPrint, EventCallbackable, IfPresent
Defined in:
lib/puppeteer/frame_manager.rb

Defined Under Namespace

Classes: NavigationError

Constant Summary collapse

UTILITY_WORLD_NAME = 
'__puppeteer_utility_world__'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from EventCallbackable

#add_event_listener, #emit_event, #observe_first, #on_event, #remove_event_listener

Methods included from IfPresent

#if_present

Methods included from DebugPrint

#debug_print, #debug_puts

Constructor Details

#initialize(client, page, ignore_https_errors, timeout_settings) ⇒ FrameManager

Returns a new instance of FrameManager.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/puppeteer/frame_manager.rb', line 15

def initialize(client, page, ignore_https_errors, timeout_settings)
  @client = client
  @page = page
  @network_manager = Puppeteer::NetworkManager.new(client, ignore_https_errors, self)
  @timeout_settings = timeout_settings

  # @type {!Map<string, !Frame>}
  @frames = {}

  # @type {!Map<number, !ExecutionContext>}
  @context_id_to_context = {}

  # @type {!Set<string>}
  @isolated_worlds = Set.new

  @client.on_event 'Page.frameAttached' do |event|
    handle_frame_attached(event['frameId'], event['parentFrameId'])
  end
  @client.on_event 'Page.frameNavigated' do |event|
    handle_frame_navigated(event['frame'])
  end
  @client.on_event 'Page.navigatedWithinDocument' do |event|
    handle_frame_navigated_within_document(event['frameId'], event['url'])
  end
  @client.on_event 'Page.frameDetached' do |event|
    handle_frame_detached(event['frameId'])
  end
  @client.on_event 'Page.frameStoppedLoading' do |event|
    handle_frame_stopped_loading(event['frameId'])
  end
  @client.on_event 'Runtime.executionContextCreated' do |event|
    handle_execution_context_created(event['context'])
  end
  @client.on_event 'Runtime.executionContextDestroyed' do |event|
    handle_execution_context_destroyed(event['executionContextId'])
  end
  @client.on_event 'Runtime.executionContextsCleared' do |event|
    handle_execution_contexts_cleared
  end
  @client.on_event 'Page.lifecycleEvent' do |event|
    handle_lifecycle_event(event)
  end
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



59
60
61
 
# File 'lib/puppeteer/frame_manager.rb', line 59

def client
  @client
end

#network_manager ⇒ Object (readonly)

Returns the value of attribute network_manager.



78
79
80
 
# File 'lib/puppeteer/frame_manager.rb', line 78

def network_manager
  @network_manager
end

#timeout_settings ⇒ Object (readonly)

Returns the value of attribute timeout_settings.



59
60
61
 
# File 'lib/puppeteer/frame_manager.rb', line 59

def timeout_settings
  @timeout_settings
end

Instance Method Details

#ensure_isolated_world(name) ⇒ Object

Parameters:

  • name (String) 


259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/puppeteer/frame_manager.rb', line 259

def ensure_isolated_world(name)
  return if @isolated_worlds.include?(name)
  @isolated_worlds << name

  @client.send_message('Page.addScriptToEvaluateOnNewDocument',
    source: "//# sourceURL=#{Puppeteer::ExecutionContext::EVALUATION_SCRIPT_URL}",
    worldName: name,
  )
  create_isolated_worlds_promises = frames.map do |frame|
    @client.async_send_message('Page.createIsolatedWorld',
      frameId: frame.id,
      grantUniveralAccess: true,
      worldName: name,
    )
  end
  await_all(*create_isolated_worlds_promises)
end

#execution_context_by_id(context_id) ⇒ Object 



341
342
343
 
# File 'lib/puppeteer/frame_manager.rb', line 341

def execution_context_by_id(context_id)
  @context_id_to_context[context_id] or raise "INTERNAL ERROR: missing context with id = #{context_id}"
end

#frame(frame_id) ⇒ ?Frame

Parameters:

  • frameId (!string)

Returns:



199
200
201
 
# File 'lib/puppeteer/frame_manager.rb', line 199

def frame(frame_id)
  @frames[frame_id]
end

#frames ⇒ !Array<!Frame>

Returns:



193
194
195
 
# File 'lib/puppeteer/frame_manager.rb', line 193

def frames
  @frames.values
end

#handle_execution_context_created(context_payload) ⇒ Object

Parameters:

  • context_payload (Hash) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/puppeteer/frame_manager.rb', line 296

def handle_execution_context_created(context_payload)
  frame = if_present(context_payload.dig('auxData', 'frameId')) { |frame_id| @frames[frame_id] }

  world = nil
  if frame
    if context_payload.dig('auxData', 'isDefault')
      world = frame.main_world
    elsif context_payload['name'] == UTILITY_WORLD_NAME && !frame.secondary_world.has_context?
      # In case of multiple sessions to the same target, there's a race between
      # connections so we might end up creating multiple isolated worlds.
      # We can use either.
      world = frame.secondary_world
    end
  end

  if context_payload.dig('auxData', 'type') == 'isolated'
    @isolated_worlds << context_payload['name']
  end

  context = Puppeteer::ExecutionContext.new(@client, context_payload, world)
  if world
    world.context = context
  end
  @context_id_to_context[context_payload['id']] = context
end

#handle_execution_context_destroyed(execution_context_id) ⇒ Object

Parameters:

  • executionContextId (number) 


323
324
325
326
327
328
329
330
 
# File 'lib/puppeteer/frame_manager.rb', line 323

def handle_execution_context_destroyed(execution_context_id)
  context = @context_id_to_context[execution_context_id]
  return unless context
  @context_id_to_context.delete(execution_context_id)
  if context.world
    context.world.delete_context(execution_context_id)
  end
end

#handle_execution_contexts_cleared ⇒ Object 



332
333
334
335
336
337
338
339
 
# File 'lib/puppeteer/frame_manager.rb', line 332

def handle_execution_contexts_cleared
  @context_id_to_context.each do |execution_context_id, context|
    if context.world
      context.world.delete_context(execution_context_id)
    end
  end
  @context_id_to_context.clear
end

#handle_frame_attached(frame_id, parent_frame_id) ⇒ Object

Parameters:

  • frameId (string)
  • parentFrameId (?string) 


205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/puppeteer/frame_manager.rb', line 205

def handle_frame_attached(frame_id, parent_frame_id)
  return if @frames.has_key?(frame_id)
  if !parent_frame_id
    raise ArgymentError.new('parent_frame_id must not be nil')
  end
  parent_frame = @frames[parent_frame_id]
  frame = Puppeteer::Frame.new(self, @client, parent_frame, frame_id)
  @frames[frame_id] = frame

  emit_event 'Events.FrameManager.FrameAttached', frame
end

#handle_frame_detached(frame_id) ⇒ Object

Parameters:

  • frame_id (String) 


288
289
290
291
292
293
 
# File 'lib/puppeteer/frame_manager.rb', line 288

def handle_frame_detached(frame_id)
  frame = @frames[frame_id]
  if frame
    remove_frame_recursively(frame)
  end
end

#handle_frame_navigated(frame_payload) ⇒ Object

Parameters:

  • frame_payload (Hash) 


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/puppeteer/frame_manager.rb', line 218

def handle_frame_navigated(frame_payload)
  is_main_frame = !frame_payload['parentId']
  frame =
    if is_main_frame
      @main_frame
    else
      @frames[frame_payload['id']]
    end

  if !is_main_frame && !frame
    raise ArgumentError.new('We either navigate top level or have old version of the navigated frame')
  end

  # Detach all child frames first.
  if frame
    frame.child_frames.each do |child|
      remove_frame_recursively(child)
    end
  end

  # Update or create main frame.
  if is_main_frame
    if frame
      # Update frame id to retain frame identity on cross-process navigation.
      @frames.delete(frame.id)
      frame.id = frame_payload['id']
    else
      # Initial main frame navigation.
      frame = Puppeteer::Frame.new(self, @client, nil, frame_payload['id'])
    end
    @frames[frame_payload['id']] = frame
    @main_frame = frame
  end

  # Update frame payload.
  frame.navigated(frame_payload)

  emit_event 'Events.FrameManager.FrameNavigated', frame
end

#handle_frame_navigated_within_document(frame_id, url) ⇒ Object

Parameters:

  • frame_id (String)
  • url (String) 


279
280
281
282
283
284
285
 
# File 'lib/puppeteer/frame_manager.rb', line 279

def handle_frame_navigated_within_document(frame_id, url)
  frame = @frames[frame_id]
  return unless frame
  frame.navigated_within_document(url)
  emit_event 'Events.FrameManager.FrameNavigatedWithinDocument', frame
  emit_event 'Events.FrameManager.FrameNavigated', frame
end

#handle_frame_stopped_loading(frame_id) ⇒ Object

Parameters:

  • frameId (string) 


162
163
164
165
166
167
 
# File 'lib/puppeteer/frame_manager.rb', line 162

def handle_frame_stopped_loading(frame_id)
  frame = @frames[frame_id]
  return if !frame
  frame.handle_loading_stopped
  emit_event 'Events.FrameManager.LifecycleEvent', frame
end

#handle_frame_tree(frame_tree) ⇒ Object

Parameters:

  • frame_tree (Hash) 


170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/puppeteer/frame_manager.rb', line 170

def handle_frame_tree(frame_tree)
  if frame_tree['frame']['parentId']
    handle_frame_attached(frame_tree['frame']['id'], frame_tree['frame']['parentId'])
  end
  handle_frame_navigated(frame_tree['frame'])
  return if !frame_tree['childFrames']

  frame_tree['childFrames'].each do |child|
    handle_frame_tree(child)
  end
end

#handle_lifecycle_event(event) ⇒ Object

Parameters:

  • event (Hash) 


154
155
156
157
158
159
 
# File 'lib/puppeteer/frame_manager.rb', line 154

def handle_lifecycle_event(event)
  frame = @frames[event['frameId']]
  return if !frame
  frame.handle_lifecycle_event(event['loaderId'], event['name'])
  emit_event 'Events.FrameManager.LifecycleEvent', frame
end

#main_frame ⇒ !Frame

Returns:



188
189
190
 
# File 'lib/puppeteer/frame_manager.rb', line 188

def main_frame
  @main_frame
end

#navigate_frame(frame, url, referer: nil, timeout: nil, wait_until: nil) ⇒ Puppeteer::Response

Parameters:

  • frame (Puppeteer::Frame)
  • url (String)
  • options (!{referer?: string, timeout?: number, waitUntil?: string|!Array<string>}=)

Returns:



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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/puppeteer/frame_manager.rb', line 86

def navigate_frame(frame, url, referer: nil, timeout: nil, wait_until: nil)
  assert_no_legacy_navigation_options(wait_until: wait_until)

  navigate_params = {
    url: url,
    referer: referer || @network_manager.extra_http_headers['referer'],
    frameId: frame.id,
  }.compact
  option_wait_until = wait_until || ['load']
  option_timeout = timeout || @timeout_settings.navigation_timeout

  watcher = Puppeteer::LifecycleWatcher.new(self, frame, option_wait_until, option_timeout)
  ensure_new_document_navigation = false

  begin
    navigate = future do
      result = @client.send_message('Page.navigate', navigate_params)
      loader_id = result['loaderId']
      ensure_new_document_navigation = !!loader_id
      if result['errorText']
        raise NavigationError.new("#{result['errorText']} at #{url}")
      end
    end
    await_any(
      navigate,
      watcher.timeout_or_termination_promise,
    )

    document_navigation_promise =
      if ensure_new_document_navigation
        watcher.new_document_navigation_promise
      else
        watcher.same_document_navigation_promise
      end
    await_any(
      document_navigation_promise,
      watcher.timeout_or_termination_promise,
    )
  ensure
    watcher.dispose
  end

  watcher.navigation_response
end

#page ⇒ !Puppeteer.Page

Returns:



183
184
185
 
# File 'lib/puppeteer/frame_manager.rb', line 183

def page
  @page
end

#wait_for_frame_navigation(frame, timeout: nil, wait_until: nil) ⇒ Puppeteer::Response

Parameters:

  • timeout (number|nil) (defaults to: nil)
  • wait_until (string|nil) (defaults to: nil) —

    ‘load’ | ‘domcontentloaded’ | ‘networkidle0’ | ‘networkidle2’

Returns:



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

def wait_for_frame_navigation(frame, timeout: nil, wait_until: nil)
  assert_no_legacy_navigation_options(wait_until: wait_until)

  option_wait_until = wait_until || ['load']
  option_timeout = timeout || @timeout_settings.navigation_timeout
  watcher = Puppeteer::LifecycleWatcher.new(self, frame, option_wait_until, option_timeout)
  begin
    await_any(
      watcher.timeout_or_termination_promise,
      watcher.same_document_navigation_promise,
      watcher.new_document_navigation_promise,
    )
  ensure
    watcher.dispose
  end

  watcher.navigation_response
end