Class: Puppeteer::Target

Inherits:
Object
  • Object
show all
Defined in:
lib/puppeteer/target.rb

Overview

github.com/puppeteer/puppeteer/blob/master/lib/Target.js

Defined Under Namespace

Classes: InitializeFailure, TargetInfo

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_info:, session:, browser_context:, target_manager:, session_factory:, ignore_https_errors:, default_viewport:, network_enabled:, is_page_target_callback:) ⇒ Target

Returns a new instance of Target.

Parameters:



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
 
# File 'lib/puppeteer/target.rb', line 22

def initialize(target_info:,
               session:,
               browser_context:,
               target_manager:,
               session_factory:,
               ignore_https_errors:,
               default_viewport:,
               network_enabled:,
               is_page_target_callback:)
  @session = session
  @target_manager = target_manager
  @target_info = target_info
  @browser_context = browser_context
  @target_id = target_info.target_id
  @session_factory = session_factory
  @ignore_https_errors = ignore_https_errors
  @default_viewport = default_viewport
  @network_enabled = network_enabled
  @is_page_target_callback = is_page_target_callback
  @worker = nil

  #    /** @type {?Promise<!Puppeteer.Page>} */
  #    this._pagePromise = null;
  #    /** @type {?Promise<!Worker>} */
  #    this._workerPromise = null;
  @initialize_callback_promise = Async::Promise.new
  @initialized_promise = Async::Promise.new
  @is_closed_promise = Async::Promise.new

  Async do
    @initialized_promise.resolve(handle_initialized(@initialize_callback_promise.wait))
  rescue => err
    @initialized_promise.reject(err)
  end

  @is_initialized = !@is_page_target_callback.call(@target_info) || !@target_info.url.empty?

  if @is_initialized
    @initialize_callback_promise.resolve(true)
  end
end

Instance Attribute Details

#initialized_promise ⇒ Object (readonly)

Returns the value of attribute initialized_promise.



64
65
66
 
# File 'lib/puppeteer/target.rb', line 64

def initialized_promise
  @initialized_promise
end

#is_closed_promise ⇒ Object (readonly)

Returns the value of attribute is_closed_promise.



64
65
66
 
# File 'lib/puppeteer/target.rb', line 64

def is_closed_promise
  @is_closed_promise
end

#target_id ⇒ Object (readonly)

Returns the value of attribute target_id.



64
65
66
 
# File 'lib/puppeteer/target.rb', line 64

def target_id
  @target_id
end

#target_info ⇒ Object (readonly)

Returns the value of attribute target_info.



64
65
66
 
# File 'lib/puppeteer/target.rb', line 64

def target_info
  @target_info
end

Instance Method Details

#==(other) ⇒ Object 



66
67
68
69
70
71
72
73
 
# File 'lib/puppeteer/target.rb', line 66

def ==(other)
  other = other.__getobj__ if other.is_a?(Puppeteer::ReactorRunner::Proxy)
  return true if equal?(other)
  return false unless other.is_a?(Puppeteer::Target)
  return false if target_id.nil? || other.target_id.nil?

  target_id == other.target_id
end

#as_page ⇒ Puppeteer::Page

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/puppeteer/target.rb', line 146

def as_page
  existing_page = page
  return existing_page if existing_page
  return @as_page if @as_page

  client = @session || @session_factory.call(false)
  client.wait_for_ready if client.respond_to?(:wait_for_ready)
  @as_page = Puppeteer::Page.create(
    client,
    self,
    @ignore_https_errors,
    nil,
    network_enabled: @network_enabled,
  )
end

#browser ⇒ !Puppeteer.Browser

Returns:



210
211
212
 
# File 'lib/puppeteer/target.rb', line 210

def browser
  @browser_context.browser
end

#browser_context ⇒ !Puppeteer.BrowserContext

Returns:



215
216
217
 
# File 'lib/puppeteer/target.rb', line 215

def browser_context
  @browser_context
end

#closed_callback ⇒ Object 



83
84
85
 
# File 'lib/puppeteer/target.rb', line 83

def closed_callback
  @is_closed_promise.resolve(true) unless @is_closed_promise.resolved?
end

#create_cdp_session ⇒ Object 



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

def create_cdp_session
  session = @session_factory.call(false)
  session.target = self if session.respond_to?(:target=)
  session
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/puppeteer/target.rb', line 75

def eql?(other)
  self == other
end

#handle_target_info_changed(target_info) ⇒ Object

Parameters:



227
228
229
230
231
232
233
234
 
# File 'lib/puppeteer/target.rb', line 227

def handle_target_info_changed(target_info)
  @target_info = target_info

  if !@is_initialized && (!@is_page_target_callback.call(@target_info) || !@target_info.url.empty?)
    @is_initialized = true
    @initialize_callback_promise.resolve(true)
  end
end

#hash ⇒ Object 



79
80
81
 
# File 'lib/puppeteer/target.rb', line 79

def hash
  target_id ? target_id.hash : super
end

#ignore_initialize_callback_promise ⇒ Object 



89
90
91
92
93
 
# File 'lib/puppeteer/target.rb', line 89

def ignore_initialize_callback_promise
  unless @initialize_callback_promise.resolved?
    @initialize_callback_promise.resolve(false)
  end
end

#initialized? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/puppeteer/target.rb', line 111

def initialized?
  @is_initialized
end

#opener ⇒ ?Puppeteer.Target

Returns:



220
221
222
223
224
 
# File 'lib/puppeteer/target.rb', line 220

def opener
  opener_id = @target_info.opener_id
  return nil if opener_id.nil?
  browser.send(:find_target_by_id, opener_id)
end

#page ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/puppeteer/target.rb', line 130

def page
  if @is_page_target_callback.call(@target_info) && @page.nil?
    client = @session || @session_factory.call(true)
    client.wait_for_ready if client.respond_to?(:wait_for_ready)
    @page = Puppeteer::Page.create(
      client,
      self,
      @ignore_https_errors,
      @default_viewport,
      network_enabled: @network_enabled,
    )
  end
  @page
end

#raw_type ⇒ Object 



205
206
207
 
# File 'lib/puppeteer/target.rb', line 205

def raw_type
  @target_info.type
end

#session ⇒ CDPSession|nil

Returns:



116
117
118
 
# File 'lib/puppeteer/target.rb', line 116

def session
  @session
end

#target_manager ⇒ Object 



126
127
128
 
# File 'lib/puppeteer/target.rb', line 126

def target_manager
  @target_manager
end

#type ⇒ "page"|"background_page"|"service_worker"|"shared_worker"|"webview"|"tab"|"other"|"browser"

Returns:

  • ("page"|"background_page"|"service_worker"|"shared_worker"|"webview"|"tab"|"other"|"browser") 


195
196
197
198
199
200
201
202
 
# File 'lib/puppeteer/target.rb', line 195

def type
  type = @target_info.type
  if ['page', 'background_page', 'service_worker', 'shared_worker', 'webview', 'tab', 'browser'].include?(type)
    type
  else
    'other'
  end
end

#url ⇒ string

Returns:

  • (string) 


190
191
192
 
# File 'lib/puppeteer/target.rb', line 190

def url
  @target_info.url
end

#worker ⇒ Puppeteer::CdpWebWorker|nil

Returns:



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
 
# File 'lib/puppeteer/target.rb', line 163

def worker
  return nil unless ['service_worker', 'shared_worker'].include?(@target_info.type)
  return @worker if @worker

  if @target_info.type == 'service_worker'
    @target_manager&.wait_for_service_worker_detach(@target_id)
  end

  client =
    if @target_info.type == 'service_worker'
      @session_factory.call(false)
    else
      @session || @session_factory.call(false)
    end
  client.target = self if client.respond_to?(:target=)
  client.wait_for_ready if client.respond_to?(:wait_for_ready)
  @worker = Puppeteer::CdpWebWorker.new(
    client,
    @target_info.url,
    @target_id,
    @target_info.type,
    nil,
    nil,
  )
end