Class: Puppeteer::JSCoverage

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

Defined Under Namespace

Classes: Item, ItemWithRawScriptCoverage

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ JSCoverage

Returns a new instance of JSCoverage.

Parameters:



24
25
26
27
28
29
30
 
# File 'lib/puppeteer/js_coverage.rb', line 24

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

Instance Method Details

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



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

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

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

#stop ⇒ Object 



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

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

  results = Puppeteer::AsyncUtils.await_promise_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

    if @include_raw_script_coverage
      coverage << ItemWithRawScriptCoverage.new(
        url: url,
        ranges: convert_to_disjoint_ranges(flatten_ranges),
        text: text,
        raw_script_coverage: entry,
      )
    else
      coverage << Item.new(
        url: url,
        ranges: convert_to_disjoint_ranges(flatten_ranges),
        text: text,
      )
    end
  end

  coverage
end