-
-
Notifications
You must be signed in to change notification settings - Fork 36
/
browser.rb
330 lines (287 loc) · 10.8 KB
/
browser.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
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
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
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
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
261
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
290
291
292
293
294
295
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
321
322
323
324
325
326
327
328
329
330
require 'thread'
require 'timeout'
class Puppeteer::Browser
include Puppeteer::DebugPrint
include Puppeteer::EventCallbackable
include Puppeteer::IfPresent
using Puppeteer::DefineAsyncMethod
# @param {!Puppeteer.Connection} connection
# @param {!Array<string>} contextIds
# @param {boolean} ignoreHTTPSErrors
# @param {?Puppeteer.Viewport} defaultViewport
# @param process [Puppeteer::BrowserRunner::BrowserProcess|NilClass]
# @param {function()=} closeCallback
def self.create(connection:,
context_ids:,
ignore_https_errors:,
default_viewport:,
process:,
close_callback:,
target_filter_callback:,
is_page_target_callback:)
browser = Puppeteer::Browser.new(
connection: connection,
context_ids: context_ids,
ignore_https_errors: ignore_https_errors,
default_viewport: default_viewport,
process: process,
close_callback: close_callback,
target_filter_callback: target_filter_callback,
is_page_target_callback: is_page_target_callback,
)
connection.send_message('Target.setDiscoverTargets', discover: true)
browser
end
# @param {!Puppeteer.Connection} connection
# @param {!Array<string>} contextIds
# @param {boolean} ignoreHTTPSErrors
# @param {?Puppeteer.Viewport} defaultViewport
# @param {?Puppeteer.ChildProcess} process
# @param {(function():Promise)=} closeCallback
def initialize(connection:,
context_ids:,
ignore_https_errors:,
default_viewport:,
process:,
close_callback:,
target_filter_callback:,
is_page_target_callback:)
@ignore_https_errors = ignore_https_errors
@default_viewport = default_viewport
@process = process
@connection = connection
@close_callback = close_callback
@target_filter_callback = target_filter_callback || method(:default_target_filter_callback)
@is_page_target_callback = is_page_target_callback || method(:default_is_page_target_callback)
@default_context = Puppeteer::BrowserContext.new(@connection, self, nil)
@contexts = {}
context_ids.each do |context_id|
@contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id)
end
@targets = {}
@wait_for_creating_targets = {}
@connection.on_event(ConnectionEmittedEvents::Disconnected) do
emit_event(BrowserEmittedEvents::Disconnected)
end
@connection.on_event('Target.targetCreated', &method(:handle_target_created))
@connection.on_event('Target.targetDestroyed', &method(:handle_target_destroyed))
@connection.on_event('Target.targetInfoChanged', &method(:handle_target_info_changed))
end
private def default_target_filter_callback(target_info)
true
end
private def default_is_page_target_callback(target_info)
['page', 'background_page', 'webview'].include?(target_info.type)
end
# @param event_name [Symbol] either of :disconnected, :targetcreated, :targetchanged, :targetdestroyed
def on(event_name, &block)
unless BrowserEmittedEvents.values.include?(event_name.to_s)
raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}")
end
super(event_name.to_s, &block)
end
# @param event_name [Symbol]
def once(event_name, &block)
unless BrowserEmittedEvents.values.include?(event_name.to_s)
raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}")
end
super(event_name.to_s, &block)
end
# @return [Puppeteer::BrowserRunner::BrowserProcess]
def process
@process
end
# @return [Puppeteer::BrowserContext]
def create_incognito_browser_context
result = @connection.send_message('Target.createBrowserContext')
browser_context_id = result['browserContextId']
@contexts[browser_context_id] = Puppeteer::BrowserContext.new(@connection, self, browser_context_id)
end
def browser_contexts
[@default_context].concat(@contexts.values)
end
# @return [Puppeteer::BrowserContext]
def default_browser_context
@default_context
end
# @param context_id [String]
def dispose_context(context_id)
@connection.send_message('Target.disposeBrowserContext', browserContextId: context_id)
@contexts.delete(context_id)
end
class TargetAlreadyExistError < StandardError
def initialize
super('Target should not exist before targetCreated')
end
end
# @param {!Protocol.Target.targetCreatedPayload} event
def handle_target_created(event)
target_info = Puppeteer::Target::TargetInfo.new(event['targetInfo'])
browser_context_id = target_info.browser_context_id
context =
if browser_context_id && @contexts.has_key?(browser_context_id)
@contexts[browser_context_id]
else
@default_context
end
if @targets[target_info.target_id]
raise TargetAlreadyExistError.new
end
return unless @target_filter_callback.call(target_info)
target = Puppeteer::Target.new(
target_info: target_info,
browser_context: context,
session_factory: -> { @connection.create_session(target_info) },
ignore_https_errors: @ignore_https_errors,
default_viewport: @default_viewport,
is_page_target_callback: @is_page_target_callback,
)
@targets[target_info.target_id] = target
if_present(@wait_for_creating_targets.delete(target_info.target_id)) do |promise|
promise.fulfill(target)
end
if await target.initialized_promise
emit_event(BrowserEmittedEvents::TargetCreated, target)
context.emit_event(BrowserContextEmittedEvents::TargetCreated, target)
end
end
# @param {{targetId: string}} event
def handle_target_destroyed(event)
target_id = event['targetId']
target = @targets[target_id]
target.ignore_initialize_callback_promise
@targets.delete(target_id)
if_present(@wait_for_creating_targets.delete(target_id)) do |promise|
promise.reject('target destroyed')
end
target.closed_callback
if await target.initialized_promise
emit_event(BrowserEmittedEvents::TargetDestroyed, target)
target.browser_context.emit_event(BrowserContextEmittedEvents::TargetDestroyed, target)
end
end
class TargetNotExistError < StandardError
def initialize
super('target should exist before targetInfoChanged')
end
end
# @param {!Protocol.Target.targetInfoChangedPayload} event
def handle_target_info_changed(event)
target_info = Puppeteer::Target::TargetInfo.new(event['targetInfo'])
target = @targets[target_info.target_id] or raise TargetNotExistError.new
previous_url = target.url
was_initialized = target.initialized?
target.handle_target_info_changed(target_info)
if was_initialized && previous_url != target.url
emit_event(BrowserEmittedEvents::TargetChanged, target)
target.browser_context.emit_event(BrowserContextEmittedEvents::TargetChanged, target)
end
end
# @return [String]
def ws_endpoint
@connection.url
end
def new_page
@default_context.new_page
end
# @param {?string} contextId
# @return {!Promise<!Puppeteer.Page>}
def create_page_in_context(context_id)
create_target_params = { url: 'about:blank' }
if context_id
create_target_params[:browserContextId] = context_id
end
result = @connection.send_message('Target.createTarget', **create_target_params)
target_id = result['targetId']
target = @targets[target_id]
unless target
# Target.targetCreated is often notified before the response of Target.createdTarget.
# https://github.com/YusukeIwaki/puppeteer-ruby/issues/91
# D, [2021-04-07T03:00:10.125241 #187] DEBUG -- : SEND >> {"method":"Target.createTarget","params":{"url":"about:blank","browserContextId":"56A86FC3391B50180CF9A6450A0D8C21"},"id":3}
# D, [2021-04-07T03:00:10.142396 #187] DEBUG -- : RECV << {"id"=>3, "result"=>{"targetId"=>"A518447C415A1A3E1A8979454A155632"}}
# D, [2021-04-07T03:00:10.145360 #187] DEBUG -- : RECV << {"method"=>"Target.targetCreated", "params"=>{"targetInfo"=>{"targetId"=>"A518447C415A1A3E1A8979454A155632", "type"=>"page", "title"=>"", "url"=>"", "attached"=>false, "canAccessOpener"=>false, "browserContextId"=>"56A86FC3391B50180CF9A6450A0D8C21"}}}
# This is just a workaround logic...
@wait_for_creating_targets[target_id] = resolvable_future
target = await @wait_for_creating_targets[target_id]
end
await target.initialized_promise
await target.page
end
# @return {!Array<!Target>}
def targets
@targets.values.select { |target| target.initialized? }
end
# @return {!Target}
def target
targets.find { |target| target.type == 'browser' }
end
# used only in Target#opener
private def find_target_by_id(target_id)
@targets[target_id]
end
# @param predicate [Proc(Puppeteer::Target -> Boolean)]
# @return [Puppeteer::Target]
def wait_for_target(predicate:, timeout: nil)
timeout_helper = Puppeteer::TimeoutHelper.new('target', timeout_ms: timeout, default_timeout_ms: 30000)
existing_target = targets.find { |target| predicate.call(target) }
return existing_target if existing_target
event_listening_ids = []
target_promise = resolvable_future
event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetCreated) do |target|
if predicate.call(target)
target_promise.fulfill(target)
end
end
event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetChanged) do |target|
if predicate.call(target)
target_promise.fulfill(target)
end
end
begin
timeout_helper.with_timeout do
target_promise.value!
end
ensure
remove_event_listener(*event_listening_ids)
end
end
# @!method async_wait_for_target(predicate:, timeout: nil)
#
# @param predicate [Proc(Puppeteer::Target -> Boolean)]
define_async_method :async_wait_for_target
# @return {!Promise<!Array<!Puppeteer.Page>>}
def pages
browser_contexts.flat_map(&:pages)
end
# @return [String]
def version
get_version.product
end
# @return [String]
def user_agent
get_version.user_agent
end
def close
@close_callback.call
disconnect
end
def disconnect
@connection.dispose
end
def connected?
!@connection.closed?
end
class Version
def initialize(hash)
@protocol_version = hash['protocolVersion']
@product = hash['product']
@revision = hash['revision']
@user_agent = hash['userAgent']
@js_version = hash['jsVersion']
end
attr_reader :protocol_version, :product, :revision, :user_agent, :js_version
end
private def get_version
Version.new(@connection.send_message('Browser.getVersion'))
end
end