Class: Puppeteer::JSCoverage

Inherits:
Object
  • Object
show all
Includes:
Coverage::UtilFunctions
Defined in:
lib/puppeteer/js_coverage.rb

Defined Under Namespace

Classes: Item

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ JSCoverage

Returns a new instance of JSCoverage.

Parameters:



16
17
18
19
20
21
 
# File 'lib/puppeteer/js_coverage.rb', line 16

def initialize(client)
  @client = client
  @enabled = false
  @script_urls = {}
  @script_sources = {}
end

Instance Method Details

#start(reset_on_navigation: nil, report_anonymous_scripts: nil) ⇒ Object 



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

def start(reset_on_navigation: nil, report_anonymous_scripts: nil)
  raise 'JSCoverage is already enabled' if @enabled

  @reset_on_navigation =
    if [true, false].include?(reset_on_navigation)
      reset_on_navigation
    else
      true
    end
  @report_anonymous_scripts = report_anonymous_scripts || false
  @enabled = true
  @script_urls.clear
  @script_sources.clear
  @event_listeners = []
  @event_listeners << @client.add_event_listener('Debugger.scriptParsed') do |event|
    future { on_script_parsed(event) }
  end
  @event_listeners << @client.add_event_listener('Runtime.executionContextsCleared') do
    on_execution_contexts_cleared
  end
  await_all(
    @client.async_send_message('Profiler.enable'),
    @client.async_send_message('Profiler.startPreciseCoverage',
      callCount: false,
      detailed: true,
    ),
    @client.async_send_message('Debugger.enable'),
    @client.async_send_message('Debugger.setSkipAllPauses', skip: true),
  )
end

#stop ⇒ Object 



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

def stop
  raise 'JSCoverage is not enabled' unless @enabled
  @enabled = false

  results = await_all(
    @client.async_send_message('Profiler.takePreciseCoverage'),
    @client.async_send_message('Profiler.stopPreciseCoverage'),
    @client.async_send_message('Profiler.disable'),
    @client.async_send_message('Debugger.disable'),
  )
  @client.remove_event_listener(*@event_listeners)

  coverage = []
  profile_response = results.first
  profile_response['result'].each do |entry|
    url = @script_urls[entry['scriptId']]

    if @report_anonymous_scripts
      url ||= "debugger://VM#{entry['scriptId']}"
    end

    text = @script_sources[entry['scriptId']]
    next if !text || !url

    flatten_ranges = []
    entry['functions'].each do |func|
      func['ranges'].each do |range|
        flatten_ranges << range
      end
    end

    coverage << Item.new(
      url: url,
      ranges: convert_to_disjoint_ranges(flatten_ranges),
      text: text,
    )
  end

  coverage
end