Class: Puppeteer::LifecycleWatcher

Inherits:
Object
  • Object
show all
Includes:
IfPresent
Defined in:
lib/puppeteer/lifecycle_watcher.rb

Overview

https://github.com/puppeteer/puppeteer/blob/master/lib/LifecycleWatcher.js

Defined Under Namespace

Classes: ExpectedLifecycle, FrameDetachedError, TerminatedError

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from IfPresent

#if_present

Constructor Details

#initialize(frame_manager, frame, wait_until, timeout) ⇒ LifecycleWatcher

  • @param Puppeteer::LifecycleWatcher.!Puppeteer!Puppeteer.FrameManager frameManager
  • @param Puppeteer::LifecycleWatcher.!Puppeteer!Puppeteer.Frame frame
  • @param string|!Array<string> waitUntil
  • @param number timeout


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
98
99
100
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 64

def initialize(frame_manager, frame, wait_until, timeout)
  @expected_lifecycle = ExpectedLifecycle.new(wait_until)
  @frame_manager = frame_manager
  @frame = frame
  @initial_loader_id = frame.loader_id
  @timeout = timeout

  @listener_ids = {}
  connection = @frame_manager.client.respond_to?(:connection) ? @frame_manager.client.connection : nil
  if connection
    @listener_ids['connection'] = connection.add_event_listener(ConnectionEmittedEvents::Disconnected) do
      terminate(TerminatedError.new('Navigation failed because browser has disconnected!'))
    end
  end
  @listener_ids['frame_manager'] = [
    @frame_manager.add_event_listener(FrameManagerEmittedEvents::LifecycleEvent) do |_|
      check_lifecycle_complete
    end,
    @frame_manager.add_event_listener(FrameManagerEmittedEvents::FrameNavigatedWithinDocument, &method(:navigated_within_document)),
    @frame_manager.add_event_listener(FrameManagerEmittedEvents::FrameNavigated, &method(:navigated)),
    @frame_manager.add_event_listener(FrameManagerEmittedEvents::FrameSwapped, &method(:handle_frame_swapped)),
    @frame_manager.add_event_listener(FrameManagerEmittedEvents::FrameSwappedByActivation, &method(:handle_frame_swapped)),
    @frame_manager.add_event_listener(FrameManagerEmittedEvents::FrameDetached, &method(:handle_frame_detached)),
  ]
  @listener_ids['network_manager'] = [
    @frame_manager.network_manager.add_event_listener(NetworkManagerEmittedEvents::Request, &method(:handle_request)),
    @frame_manager.network_manager.add_event_listener(NetworkManagerEmittedEvents::Response, &method(:handle_response)),
    @frame_manager.network_manager.add_event_listener(NetworkManagerEmittedEvents::RequestFailed, &method(:handle_request_failed)),
  ]

  @same_document_navigation_promise = Async::Promise.new
  @lifecycle_promise = Async::Promise.new
  @new_document_navigation_promise = Async::Promise.new
  @termination_promise = Async::Promise.new
  @navigation_response_received = Async::Promise.new.tap { |promise| promise.resolve(nil) }
  check_lifecycle_complete
end

Instance Attribute Details

#new_document_navigation_promise ⇒ Object (readonly)

Returns the value of attribute new_document_navigation_promise.



158
159
160
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 158

def new_document_navigation_promise
  @new_document_navigation_promise
end

#same_document_navigation_promise ⇒ Object (readonly)

Returns the value of attribute same_document_navigation_promise.



158
159
160
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 158

def same_document_navigation_promise
  @same_document_navigation_promise
end

Instance Method Details

#dispose ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 209

def dispose
  if_present(@listener_ids['frame_manager']) do |ids|
    @frame_manager.remove_event_listener(*ids)
  end
  if_present(@listener_ids['connection']) do |id|
    connection = @frame_manager.client.respond_to?(:connection) ? @frame_manager.client.connection : nil
    connection&.remove_event_listener(id)
  end
  if_present(@listener_ids['network_manager']) do |ids|
    @frame_manager.network_manager.remove_event_listener(*ids)
  end
end

#handle_frame_detached(frame) ⇒ Object

Parameters:



134
135
136
137
138
139
140
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 134

def handle_frame_detached(frame)
  if @frame == frame
    @termination_promise.reject(FrameDetachedError.new)
    return
  end
  check_lifecycle_complete
end

#handle_request(request) ⇒ Object

Parameters:



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

def handle_request(request)
  return if request.frame != @frame || !request.navigation_request?
  if @navigation_request && request.redirect_chain.empty?
    return
  end
  @navigation_request = request
  # Resolve previous navigation response in case there are multiple
  # navigation requests reported by the backend. This generally should not
  # happen by it looks like it's possible.
  @navigation_response_received.resolve(nil) if @navigation_response_received && !@navigation_response_received.resolved?
  @navigation_response_received = Async::Promise.new
  if request.response && !@navigation_response_received.resolved?
    @navigation_response_received.resolve(nil)
  end
end

#handle_request_failed(request) ⇒ Object

Parameters:



120
121
122
123
124
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 120

def handle_request_failed(request)
  return if @navigation_request&.internal&.request_id != request.internal.request_id

  @navigation_response_received.resolve(nil) unless @navigation_response_received.resolved?
end

#handle_response(response) ⇒ Object

Parameters:



127
128
129
130
131
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 127

def handle_response(response)
  return if @navigation_request&.internal&.request_id != response.request.internal.request_id

  @navigation_response_received.resolve(nil) unless @navigation_response_received.resolved?
end

#navigation_response ⇒ Puppeteer::HTTPResponse

Returns:



143
144
145
146
147
148
149
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 143

def navigation_response
  # Continue with a possibly null response.
  @navigation_response_received.wait rescue nil
  if_present(@navigation_request) do |request|
    request.response
  end
end

#timeout_or_termination_promise ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/puppeteer/lifecycle_watcher.rb', line 164

def timeout_or_termination_promise
  if @timeout > 0
    -> do
      begin
        Puppeteer::AsyncUtils.async_timeout(@timeout, @termination_promise).wait
      rescue Async::TimeoutError
        raise Puppeteer::TimeoutError.new("Navigation timeout of #{@timeout} ms exceeded")
      end
    end
  else
    @termination_promise
  end
end