Class: Puppeteer::FrameManager

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

Defined Under Namespace

Classes: FrameNotFoundError, 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
 
# 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

  # Keeps track of OOPIF targets/frames (target ID == frame ID for OOPIFs)
  # that are being initialized.
  @frames_pending_target_init = {}

  # Keeps track of frames that are in the process of being attached in #onFrameAttached.
  @frames_pending_attachment = {}

  setup_listeners(@client)
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



73
74
75
 
# File 'lib/puppeteer/frame_manager.rb', line 73

def client
  @client
end

#network_manager ⇒ Object (readonly)

Returns the value of attribute network_manager.



103
104
105
 
# File 'lib/puppeteer/frame_manager.rb', line 103

def network_manager
  @network_manager
end

#timeout_settings ⇒ Object (readonly)

Returns the value of attribute timeout_settings.



73
74
75
 
# File 'lib/puppeteer/frame_manager.rb', line 73

def timeout_settings
  @timeout_settings
end

Instance Method Details

#execution_context_by_id(context_id, session) ⇒ Object 



464
465
466
467
 
# File 'lib/puppeteer/frame_manager.rb', line 464

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

#frame(frame_id) ⇒ ?Frame

Parameters:

  • frameId (!string)

Returns:



255
256
257
 
# File 'lib/puppeteer/frame_manager.rb', line 255

def frame(frame_id)
  @frames[frame_id]
end

#frames ⇒ !Array<!Frame>

Returns:



249
250
251
 
# File 'lib/puppeteer/frame_manager.rb', line 249

def frames
  @frames.values
end

#handle_attached_to_target(target) ⇒ Object

Parameters:

  • event (Hash) 


181
182
183
184
185
186
187
188
189
 
# File 'lib/puppeteer/frame_manager.rb', line 181

def handle_attached_to_target(target)
  return if target.target_info.type != 'iframe'

  frame = @frames[target.target_info.target_id]
  session = target.session
  frame&.send(:update_client, session)
  setup_listeners(session)
  async_init(target.target_info.target_id, session)
end

#handle_detached_from_target(target) ⇒ Object

Parameters:

  • event (Hash) 


192
193
194
195
196
197
198
199
 
# File 'lib/puppeteer/frame_manager.rb', line 192

def handle_detached_from_target(target)
  frame = @frames[target.target_id]
  if frame && frame.oop_frame?
    # When an OOP iframe is removed from the page, it
    # will only get a Target.detachedFromTarget event.
    remove_frame_recursively(frame)
  end
end

#handle_execution_context_created(context_payload, session) ⇒ Object

Parameters:

  • context_payload (Hash) 


404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/puppeteer/frame_manager.rb', line 404

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

  world = nil
  if frame
    # commented out the original implementation for allowing us to use Frame#evaluate on OOP iframe.
    #
    # # Only care about execution contexts created for the current session.
    # return if @client != session

    if context_payload.dig('auxData', 'isDefault')
      world = frame.main_world
    elsif context_payload['name'] == UTILITY_WORLD_NAME && !frame.puppeteer_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.puppeteer_world
    end
  end

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

  context = Puppeteer::ExecutionContext.new(frame&._client || @client, context_payload, world)
  if world
    world.context = context
  end
  key = "#{session.id}:#{context_payload['id']}"
  @context_id_to_context[key] = context
end

#handle_execution_context_destroyed(execution_context_id, session) ⇒ Object

Parameters:

  • execution_context_id (Integer)
  • session (Puppeteer::CDPSEssion) 


438
439
440
441
442
443
444
445
446
 
# File 'lib/puppeteer/frame_manager.rb', line 438

def handle_execution_context_destroyed(execution_context_id, session)
  key = "#{session.id}:#{execution_context_id}"
  context = @context_id_to_context[key]
  return unless context
  @context_id_to_context.delete(key)
  if context.world
    context.world.delete_context(execution_context_id)
  end
end

#handle_execution_contexts_cleared(session) ⇒ Object

Parameters:



449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/puppeteer/frame_manager.rb', line 449

def handle_execution_contexts_cleared(session)
  @context_id_to_context.select! do |execution_context_id, context|
    # Make sure to only clear execution contexts that belong
    # to the current session.
    if context.client != session
      true # keep
    else
      if context.world
        context.world.delete_context(execution_context_id)
      end
      false # remove
    end
  end
end

#handle_frame_attached(session, frame_id, parent_frame_id) ⇒ Object

Parameters:

Raises:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/puppeteer/frame_manager.rb', line 262

def handle_frame_attached(session, frame_id, parent_frame_id)
  if @frames.has_key?(frame_id)
    frame = @frames[frame_id]
    if session && frame.oop_frame?
      # If an OOP iframes becomes a normal iframe again
      # it is first attached to the parent page before
      # the target is removed.
      frame.send(:update_client, session)
    end
    return
  end
  parent_frame = @frames[parent_frame_id]
  if parent_frame
    attach_child_frame(parent_frame, parent_frame_id, frame_id, session)
    return
  end

  if @frames_pending_target_init[parent_frame_id]
    @frames_pending_attachment[frame_id] ||= resolvable_future
    @frames_pending_target_init[parent_frame_id].then do |_|
      attach_child_frame(@frames[parent_frame_id], parent_frame_id, frame_id, session)
      @frames_pending_attachment.delete(frame_id)&.fulfill(nil)
    end
    return
  end

  raise FrameNotFoundError.new("Parent frame #{parent_frame_id} not found.")
end

#handle_frame_detached(frame_id, reason) ⇒ Object

Parameters:

  • frame_id (String)
  • reason (String) 


388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/puppeteer/frame_manager.rb', line 388

def handle_frame_detached(frame_id, reason)
  frame = @frames[frame_id]
  if reason == 'remove'
    # Only remove the frame if the reason for the detached event is
    # an actual removement of the frame.
    # For frames that become OOP iframes, the reason would be 'swap'.
    if frame
      remove_frame_recursively(frame)
    end
  elsif reason == 'swap'
    emit_event(FrameManagerEmittedEvents::FrameSwapped, frame)
  end
end

#handle_frame_navigated(frame_payload) ⇒ Object

Parameters:

  • frame_payload (Hash) 


305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/puppeteer/frame_manager.rb', line 305

def handle_frame_navigated(frame_payload)
  frame_id = frame_payload['id']
  is_main_frame = !frame_payload['parentId']


  if @frames_pending_attachment[frame_id]
    @frames_pending_attachment[frame_id].then do |_|
      frame = is_main_frame ? @main_frame : @frames[frame_id]
      reattach_frame(frame, frame_id, is_main_frame, frame_payload)
    end
  else
    frame = is_main_frame ? @main_frame : @frames[frame_id]
    reattach_frame(frame, frame_id, is_main_frame, frame_payload)
  end
end

#handle_frame_navigated_within_document(frame_id, url) ⇒ Object

Parameters:

  • frame_id (String)
  • url (String) 


378
379
380
381
382
383
384
 
# File 'lib/puppeteer/frame_manager.rb', line 378

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

#handle_frame_started_loading(frame_id) ⇒ Object

Parameters:

  • frame_id (String) 


210
211
212
213
214
 
# File 'lib/puppeteer/frame_manager.rb', line 210

def handle_frame_started_loading(frame_id)
  frame = @frames[frame_id]
  return if !frame
  frame.handle_loading_started
end

#handle_frame_stopped_loading(frame_id) ⇒ Object

Parameters:

  • frame_id (String) 


217
218
219
220
221
222
 
# File 'lib/puppeteer/frame_manager.rb', line 217

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

#handle_frame_tree(session, frame_tree) ⇒ Object

Parameters:



226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/puppeteer/frame_manager.rb', line 226

def handle_frame_tree(session, frame_tree)
  if frame_tree['frame']['parentId']
    handle_frame_attached(session, 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(session, child)
  end
end

#handle_lifecycle_event(event) ⇒ Object

Parameters:

  • event (Hash) 


202
203
204
205
206
207
 
# File 'lib/puppeteer/frame_manager.rb', line 202

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

#main_frame ⇒ !Frame

Returns:



244
245
246
 
# File 'lib/puppeteer/frame_manager.rb', line 244

def main_frame
  @main_frame
end

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

Parameters:

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

Returns:



111
112
113
114
115
116
117
118
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
154
 
# File 'lib/puppeteer/frame_manager.rb', line 111

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,
    )

    await_any(
      watcher.timeout_or_termination_promise,
      if ensure_new_document_navigation
        watcher.new_document_navigation_promise
      else
        watcher.same_document_navigation_promise
      end,
    )

    watcher.navigation_response
  rescue Puppeteer::TimeoutError => err
    raise NavigationError.new(err)
  ensure
    watcher.dispose
  end
end

#page ⇒ !Puppeteer.Page

Returns:



239
240
241
 
# File 'lib/puppeteer/frame_manager.rb', line 239

def page
  @page
end

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

Parameters:

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

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

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/puppeteer/frame_manager.rb', line 159

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,
    )

    watcher.navigation_response
  rescue Puppeteer::TimeoutError => err
    raise NavigationError.new(err)
  ensure
    watcher.dispose
  end
end