Class: Puppeteer::FrameManager

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

Defined Under Namespace

Classes: FrameNotFoundError, NavigationError

Constant Summary collapse

UTILITY_WORLD_NAME = 
'__puppeteer_utility_world__'
CHROME_EXTENSION_PREFIX = 
'chrome-extension://'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from EventCallbackable

#add_event_listener, #emit_event, #observe_first, #off, #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, network_enabled: true) ⇒ 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
 
# File 'lib/puppeteer/frame_manager.rb', line 15

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

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

  @frame_naviigated_received = Set.new

  # @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 = {}
  @frame_tree_handled_promise = nil
  @queued_frame_events = []
  @frame_tree_mutex = Mutex.new

  setup_listeners(@client)
  setup_client_disconnect_listener(@client)
end

Instance Attribute Details

#client ⇒ Puppeteer::CDPSession (readonly)

Returns the value of attribute client.

Returns:



99
100
101
 
# File 'lib/puppeteer/frame_manager.rb', line 99

def client
  @client
end

#network_manager ⇒ Object (readonly)

Returns the value of attribute network_manager.

Returns:

  • (Object) 


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

def network_manager
  @network_manager
end

#timeout_settings ⇒ Object (readonly)

Returns the value of attribute timeout_settings.

Returns:

  • (Object) 


99
100
101
 
# File 'lib/puppeteer/frame_manager.rb', line 99

def timeout_settings
  @timeout_settings
end

Instance Method Details

#assert_no_legacy_navigation_options(wait_until:) ⇒ void

This method returns an undefined value.

Parameters:

  • wait_until: (String, Array[String], nil) 


678
679
680
681
682
 
# File 'lib/puppeteer/frame_manager.rb', line 678

private def assert_no_legacy_navigation_options(wait_until:)
  if wait_until == 'networkidle'
    raise ArgumentError.new('ERROR: "networkidle" option is no longer supported. Use "networkidle2" instead')
  end
end

#attach_child_frame(parent_frame, parent_frame_id, frame_id, session) ⇒ void

This method returns an undefined value.

Parameters:



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

private def attach_child_frame(parent_frame, parent_frame_id, frame_id, session)
  unless parent_frame
    raise FrameNotFoundError.new("Parent frame #{parent_frame_id} not found.")
  end

  frame = Puppeteer::Frame.new(self, parent_frame, frame_id, session)
  @frames[frame.id] = frame
  emit_event(FrameManagerEmittedEvents::FrameAttached, frame)
  frame
end

#blocked_url? ⇒ Boolean

Parameters:

  • url (String, nil)

Returns:

  • (Boolean) 


198
 
# File 'sig/_supplementary.rbs', line 198

def blocked_url?: (String? url) -> bool

#ensure_isolated_world(session, name) ⇒ void

This method returns an undefined value.

Parameters:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/puppeteer/frame_manager.rb', line 519

private def ensure_isolated_world(session, name)
  key = "#{session.id}:#{name}"
  return if @isolated_worlds.include?(key)

  session.send_message('Page.addScriptToEvaluateOnNewDocument',
    source: "//# sourceURL=#{Puppeteer::ExecutionContext::EVALUATION_SCRIPT_URL}",
    worldName: name,
  )
  create_isolated_worlds_promises = frames.
    select { |frame| frame._client == session }.
    map do |frame|
      Async do
        session.send_message('Page.createIsolatedWorld',
          frameId: frame.id,
          grantUniveralAccess: true,
          worldName: name,
        )
      rescue => err
        debug_puts(err)
      end
    end
  Puppeteer::AsyncUtils.await_promise_all(*create_isolated_worlds_promises)
  @isolated_worlds << key
end

#execution_context_by_id(context_id, session) ⇒ Puppeteer::ExecutionContext

Parameters:

Returns:



657
658
659
660
 
# File 'lib/puppeteer/frame_manager.rb', line 657

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

#extension_origin?(origin) ⇒ Boolean

Parameters:

  • origin (Object)

Returns:

  • (Boolean) 


616
617
618
 
# File 'lib/puppeteer/frame_manager.rb', line 616

private def extension_origin?(origin)
  origin.is_a?(String) && origin.start_with?(CHROME_EXTENSION_PREFIX)
end

#extract_extension_id(origin) ⇒ String?

Parameters:

  • origin (Object)

Returns:

  • (String, nil) 


620
621
622
623
624
625
626
627
 
# File 'lib/puppeteer/frame_manager.rb', line 620

private def extract_extension_id(origin)
  return nil unless extension_origin?(origin)

  path_part = origin[CHROME_EXTENSION_PREFIX.length..]
  return nil unless path_part
  slash_index = path_part.index('/')
  slash_index ? path_part[0...slash_index] : path_part
end

#finish_frame_tree_handling ⇒ void

This method returns an undefined value.



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/puppeteer/frame_manager.rb', line 355

private def finish_frame_tree_handling
  queued = nil
  @frame_tree_mutex.synchronize do
    return unless @frame_tree_handled_promise
    @frame_tree_handled_promise.resolve(nil) unless @frame_tree_handled_promise.resolved?
    queued = @queued_frame_events
    @queued_frame_events = []
  end
  queued&.each(&:call)
end

#frame(frame_id) ⇒ ?Frame

Parameters:

  • frameId (!string)
  • frame_id (String)

Returns:



414
415
416
 
# File 'lib/puppeteer/frame_manager.rb', line 414

def frame(frame_id)
  @frames[frame_id]
end

#frames ⇒ !Array<!Frame>

Returns:



408
409
410
 
# File 'lib/puppeteer/frame_manager.rb', line 408

def frames
  @frames.values
end

#handle_attached_to_target(target) ⇒ void

This method returns an undefined value.

Parameters:



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/puppeteer/frame_manager.rb', line 294

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 do
    async_init(target.target_info.target_id, session).wait
  rescue => err
    debug_puts(err)
  end
end

#handle_client_disconnect(client) ⇒ void

This method returns an undefined value.

A disconnected primary client can mean either that the page closed or that a prerendered target is about to replace it. Wait for one of those events instead of guessing with a timer.

Parameters:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/puppeteer/frame_manager.rb', line 139

private def handle_client_disconnect(client)
  frame = @main_frame
  return unless frame
  return unless @client == client

  unless @page.browser.connected? && !@page.closed?
    remove_frame_recursively(frame)
    return
  end

  frame.child_frames.each { |child| remove_frame_recursively(child) }
  swapped = Async::Promise.new
  swap_listener_id = add_event_listener(FrameManagerEmittedEvents::FrameSwappedByActivation) do |swapped_frame|
    swapped.resolve(true) if swapped_frame == frame && !swapped.resolved?
  end
  close_listener_id = @page.add_event_listener(PageEmittedEvents::Close) do
    swapped.resolve(false) unless swapped.resolved?
  end

  remove_frame_recursively(frame) unless swapped.wait
ensure
  remove_event_listener(swap_listener_id) if swap_listener_id
  @page.remove_event_listener(close_listener_id) if close_listener_id
end

#handle_detached_from_target(target) ⇒ void

This method returns an undefined value.

Parameters:



309
310
311
312
313
314
315
316
 
# File 'lib/puppeteer/frame_manager.rb', line 309

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) ⇒ void

This method returns an undefined value.

Parameters:



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/puppeteer/frame_manager.rb', line 572

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

  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
    elsif extension_origin?(origin)
      extension_id = extract_extension_id(origin)
      if extension_id
        world = frame.extension_worlds[extension_id]
        unless world
          world = Puppeteer::IsolaatedWorld.new(frame._client || @client, self, frame, @timeout_settings)
          frame.extension_worlds[extension_id] = world
        end
        world.origin = origin
        world.world_id = extension_id
      end
    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) ⇒ void

This method returns an undefined value.

Parameters:

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


631
632
633
634
635
636
637
638
 
# File 'lib/puppeteer/frame_manager.rb', line 631

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)
  context.dispose
  context.world&.delete_context(context)
end

#handle_execution_contexts_cleared(session) ⇒ void

This method returns an undefined value.

Parameters:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/puppeteer/frame_manager.rb', line 641

def handle_execution_contexts_cleared(session)
  session_id = session.id
  @context_id_to_context.select! do |execution_context_id, context|
    key_session_id, _context_id = execution_context_id.split(':', 2)
    # Make sure to only clear execution contexts that belong
    # to the current session.
    if key_session_id != session_id
      true # keep
    else
      context.dispose
      context.world&.delete_context(context)
      false # remove
    end
  end
end

#handle_frame_attached(session, frame_id, parent_frame_id) ⇒ void

This method returns an undefined value.

Parameters:

  • session (Puppeteer::CDPSession)
  • frameId (String)
  • parentFrameId (String)
  • frame_id (String)
  • parent_frame_id (String, nil)

Raises:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/puppeteer/frame_manager.rb', line 421

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] ||= Async::Promise.new
    Async do
      @frames_pending_target_init[parent_frame_id].wait
      attach_child_frame(@frames[parent_frame_id], parent_frame_id, frame_id, session)
      @frames_pending_attachment.delete(frame_id)&.resolve(nil)
    end
    return
  end

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

#handle_frame_detached(frame_id, reason) ⇒ void

This method returns an undefined value.

Parameters:

  • frame_id (String)
  • reason (String) 


556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/puppeteer/frame_manager.rb', line 556

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) ⇒ void

This method returns an undefined value.

Parameters:

  • frame_payload (Hash) 


465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/puppeteer/frame_manager.rb', line 465

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


  if @frames_pending_attachment[frame_id]
    Async do
      @frames_pending_attachment[frame_id].wait
      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) ⇒ void

This method returns an undefined value.

Parameters:

  • frame_id (String)
  • url (String) 


546
547
548
549
550
551
552
 
# File 'lib/puppeteer/frame_manager.rb', line 546

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) ⇒ void

This method returns an undefined value.

Parameters:

  • frame_id (String) 


367
368
369
370
371
 
# File 'lib/puppeteer/frame_manager.rb', line 367

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) ⇒ void

This method returns an undefined value.

Parameters:

  • frame_id (String) 


374
375
376
377
378
379
 
# File 'lib/puppeteer/frame_manager.rb', line 374

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) ⇒ void

This method returns an undefined value.

Parameters:



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/puppeteer/frame_manager.rb', line 383

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
  unless @frame_naviigated_received.delete?(frame_tree['frame']['id'])
    handle_frame_navigated(frame_tree['frame'])
  end
  return if !frame_tree['childFrames']

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

#handle_lifecycle_event(event) ⇒ void

This method returns an undefined value.

Parameters:

  • event (Hash) 


319
320
321
322
323
324
 
# File 'lib/puppeteer/frame_manager.rb', line 319

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

#init(target_id, cdp_session = nil) ⇒ void

This method returns an undefined value.

Parameters:



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
193
194
195
 
# File 'lib/puppeteer/frame_manager.rb', line 164

private def init(target_id, cdp_session = nil)
  @frames_pending_target_init[target_id] ||= Async::Promise.new
  client = cdp_session || @client

  prepare_frame_tree_handling
  promises = [
    client.async_send_message('Page.enable'),
    client.async_send_message('Page.getFrameTree'),
  ].compact
  results = Puppeteer::AsyncUtils.await_promise_all(*promises)
  frame_tree = results[1]['frameTree']
  handle_frame_tree(client, frame_tree)
  finish_frame_tree_handling
  Puppeteer::AsyncUtils.await_promise_all(
    client.async_send_message('Page.setLifecycleEventsEnabled', enabled: true),
    client.async_send_message('Runtime.enable'),
    @page.browser.issues_enabled? ? client.async_send_message('Audits.enable') : nil,
  )
  ensure_isolated_world(client, UTILITY_WORLD_NAME)
  @network_manager.init unless cdp_session
rescue => err
  # The target might have been closed before the initialization finished.
  if err.message.include?('Target closed') || err.message.include?('Session closed')
    finish_frame_tree_handling
    return
  end

  raise
ensure
  finish_frame_tree_handling if @frame_tree_handled_promise && !@frame_tree_handled_promise.resolved?
  @frames_pending_target_init.delete(target_id)&.resolve(nil)
end

#main_frame ⇒ !Frame

Returns:



403
404
405
 
# File 'lib/puppeteer/frame_manager.rb', line 403

def main_frame
  @main_frame
end

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

Parameters:

  • frame (Puppeteer::Frame)
  • url (String)
  • options (!{referer?: string, referrerPolicy?: string, timeout?: number, waitUntil?: string|!Array<string>}=)
  • referer: (String, nil) (defaults to: nil)
  • referrer_policy: (String, nil) (defaults to: nil)
  • timeout: (Numeric, nil) (defaults to: nil)
  • wait_until: (String, Array[String], nil) (defaults to: nil)

Returns:



207
208
209
210
211
212
213
214
215
216
217
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
257
258
259
260
 
# File 'lib/puppeteer/frame_manager.rb', line 207

def navigate_frame(frame, url, referer: nil, referrer_policy: nil, timeout: nil, wait_until: nil)
  assert_no_legacy_navigation_options(wait_until: wait_until)
  unless @page.browser.url_allowed?(url)
    raise Puppeteer::Error.new(
      "Navigation to #{url} is blocked by blocklist/allowlist rules",
    )
  end

  referrer_policy ||= @network_manager.extra_http_headers['referer-policy']
  protocol_referrer_policy = referrer_policy_to_protocol(referrer_policy)
  navigate_params = {
    url: url,
    referrer: referer || @network_manager.extra_http_headers['referer'],
    referrerPolicy: protocol_referrer_policy,
    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 = Async do
      Puppeteer::AsyncUtils.future_with_logging do
        result = @client.send_message('Page.navigate', navigate_params)
        loader_id = result['loaderId']
        ensure_new_document_navigation = !!loader_id
        if result['errorText'] && result['errorText'] != 'net::ERR_HTTP_RESPONSE_CODE_FAILURE'
          raise NavigationError.new("#{result['errorText']} at #{url}")
        end
      end.call
    end
    Puppeteer::AsyncUtils.await_promise_race(
      navigate,
      watcher.timeout_or_termination_promise,
    )

    Puppeteer::AsyncUtils.await_promise_race(
      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 err
  ensure
    watcher.dispose
  end
end

#page ⇒ !Puppeteer.Page

Returns:



398
399
400
 
# File 'lib/puppeteer/frame_manager.rb', line 398

def page
  @page
end

#prepare_frame_tree_handling ⇒ void

This method returns an undefined value.



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/puppeteer/frame_manager.rb', line 342

private def prepare_frame_tree_handling
  queued = nil
  @frame_tree_mutex.synchronize do
    if @frame_tree_handled_promise && !@frame_tree_handled_promise.resolved?
      @frame_tree_handled_promise.resolve(nil)
      queued = @queued_frame_events
    end
    @queued_frame_events = []
    @frame_tree_handled_promise = Async::Promise.new
  end
  queued&.each(&:call)
end

#reattach_frame(frame, frame_id, is_main_frame, frame_payload) ⇒ void

This method returns an undefined value.

Parameters:

  • frame (Puppeteer::Frame)
  • frame_id (String)
  • is_main_frame (Boolean)
  • frame_payload (Hash[String, untyped]) 


482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/puppeteer/frame_manager.rb', line 482

private def reattach_frame(frame, frame_id, is_main_frame, frame_payload)
  if !is_main_frame && !frame
    raise "Missing frame isMainFrame=#{is_main_frame}, frameId=#{frame_id}"
  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.
      if frame.id != frame_id
        old_frame_id = frame.id
        @frames.delete(old_frame_id)
        frame.id = frame_id
      end
    else
      # Initial main frame navigation.
      frame = Puppeteer::Frame.new(self, nil, frame_id, @client)
    end
    @frames[frame_id] = frame
    @main_frame = frame
  end

  # Update frame payload.
  frame.navigated(frame_payload)

  emit_event(FrameManagerEmittedEvents::FrameNavigated, frame)
end

#referrer_policy_to_protocol(referrer_policy) ⇒ String?

Parameters:

  • referrer_policy (String, nil)

Returns:

  • (String, nil) 


672
673
674
675
676
 
# File 'lib/puppeteer/frame_manager.rb', line 672

private def referrer_policy_to_protocol(referrer_policy)
  return nil if referrer_policy.nil?

  referrer_policy.to_s.gsub(/-([a-z])/) { Regexp.last_match(1).upcase }
end

#register_speculative_session(client) ⇒ void

This method returns an undefined value.

Parameters:



122
123
124
 
# File 'lib/puppeteer/frame_manager.rb', line 122

def register_speculative_session(client)
  @network_manager.add_client(client)
end

#remove_frame_recursively(frame) ⇒ void

This method returns an undefined value.

Parameters:



663
664
665
666
667
668
669
670
 
# File 'lib/puppeteer/frame_manager.rb', line 663

private def remove_frame_recursively(frame)
  frame.child_frames.each do |child|
    remove_frame_recursively(child)
  end
  frame.detach
  @frames.delete(frame.id)
  emit_event(FrameManagerEmittedEvents::FrameDetached, frame)
end

#setup_client_disconnect_listener(client) ⇒ void

This method returns an undefined value.

Parameters:



126
127
128
129
130
131
132
133
134
 
# File 'lib/puppeteer/frame_manager.rb', line 126

private def setup_client_disconnect_listener(client)
  client.once(CDPSessionEmittedEvents::Disconnected) do
    Async do
      handle_client_disconnect(client)
    rescue => err
      debug_puts(err)
    end
  end
end

#setup_listeners(client) ⇒ void

This method returns an undefined value.

Parameters:



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
94
95
96
97
 
# File 'lib/puppeteer/frame_manager.rb', line 46

private def setup_listeners(client)
  client.on_event('Page.frameAttached') do |event|
    with_frame_tree_handled do
      handle_frame_attached(client, event['frameId'], event['parentFrameId'])
    end
  end
  client.on_event('Page.frameNavigated') do |event|
    with_frame_tree_handled do
      @frame_naviigated_received << event['frame']['id']
      handle_frame_navigated(event['frame'])
    end
  end
  client.on_event('Page.navigatedWithinDocument') do |event|
    with_frame_tree_handled do
      handle_frame_navigated_within_document(event['frameId'], event['url'])
    end
  end
  client.on_event('Page.frameDetached') do |event|
    with_frame_tree_handled do
      handle_frame_detached(event['frameId'], event['reason'])
    end
  end
  client.on_event('Page.frameStartedLoading') do |event|
    with_frame_tree_handled do
      handle_frame_started_loading(event['frameId'])
    end
  end
  client.on_event('Page.frameStoppedLoading') do |event|
    with_frame_tree_handled do
      handle_frame_stopped_loading(event['frameId'])
    end
  end
  client.on_event('Runtime.executionContextCreated') do |event|
    with_frame_tree_handled do
      handle_execution_context_created(event['context'], client)
    end
  end
  client.on_event('Runtime.executionContextDestroyed') do |event|
    handle_execution_context_destroyed(event['executionContextId'], client)
  end
  client.on_event('Runtime.executionContextsCleared') do |event|
    handle_execution_contexts_cleared(client)
  end
  client.on_event('Page.lifecycleEvent') do |event|
    with_frame_tree_handled do
      handle_lifecycle_event(event)
    end
  end
  client.on_event('Audits.issueAdded') do |event|
    @page.emit_event(PageEmittedEvents::Issue, Puppeteer::Issue.new(event['issue']))
  end
end

#swap_frame_tree(client) ⇒ void

This method returns an undefined value.

When the main frame is replaced by another main frame, preserve the existing Frame object while replacing its ID, client, and frame tree.

Parameters:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/puppeteer/frame_manager.rb', line 103

def swap_frame_tree(client)
  @client = client
  frame = @main_frame
  if frame
    target_id = client.target.target_id
    @frame_naviigated_received << target_id
    @frames.delete(frame.id)
    frame.id = target_id
    @frames[target_id] = frame
    frame.send(:update_client, client)
  end

  setup_listeners(client)
  setup_client_disconnect_listener(client)
  init(client.target.target_id, client)
  @network_manager.add_client(client)
  emit_event(FrameManagerEmittedEvents::FrameSwappedByActivation, frame) if frame
end

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

Parameters:

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

    'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'

  • frame (Puppeteer::Frame)
  • timeout: (Numeric, nil) (defaults to: nil)
  • wait_until: (String, Array[String], nil) (defaults to: nil)
  • ignore_same_document_navigation: (Boolean) (defaults to: false)

Returns:



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
290
291
 
# File 'lib/puppeteer/frame_manager.rb', line 265

def wait_for_frame_navigation(frame, timeout: nil, wait_until: nil, ignore_same_document_navigation: false)
  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
    if ignore_same_document_navigation
      Puppeteer::AsyncUtils.await_promise_race(
        watcher.timeout_or_termination_promise,
        watcher.new_document_navigation_promise,
      )
    else
      Puppeteer::AsyncUtils.await_promise_race(
        watcher.timeout_or_termination_promise,
        watcher.same_document_navigation_promise,
        watcher.new_document_navigation_promise,
      )
    end

    watcher.navigation_response
  rescue Puppeteer::TimeoutError => err
    raise err
  ensure
    watcher.dispose
  end
end

#with_frame_tree_handled { ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Returns:

  • (void) 


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/puppeteer/frame_manager.rb', line 326

private def with_frame_tree_handled(&block)
  promise = @frame_tree_handled_promise
  if promise && !promise.resolved?
    queued = false
    @frame_tree_mutex.synchronize do
      promise = @frame_tree_handled_promise
      if promise && !promise.resolved?
        @queued_frame_events << block
        queued = true
      end
    end
    return if queued
  end
  block.call
end