Option for raw v8 script coverage (#2487)

kblok · web-flow · commit 7f2d09364bee · 2024-03-07T19:41:55.000-03:00
* Synchronize frame tree with the events processing

* Option for raw V8 script coverage

* fix a test
diff --git a/lib/PuppeteerSharp.Tests/CoverageTests/IncludeRawScriptCoverageTests.cs b/lib/PuppeteerSharp.Tests/CoverageTests/IncludeRawScriptCoverageTests.cs
@@ -0,0 +1,33 @@
+using System.Threading.Tasks;
+using NUnit.Framework;
+using PuppeteerSharp.Nunit;
+using PuppeteerSharp.PageCoverage;
+
+namespace PuppeteerSharp.Tests.CoverageTests
+{
+    public class IncludeRawScriptCoverageTests : PuppeteerPageBaseTest
+    {
+        [Test, Retry(2), PuppeteerTest("coverage.spec", "Coverage specs JSCoverage includeRawScriptCoverage", "should not include rawScriptCoverage field when disabled")]
+        public async Task ShouldNotIncludeRawScriptCoverageFieldWhenDisabled()
+        {
+            await Page.Coverage.StartJSCoverageAsync();
+            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/simple.html", WaitUntilNavigation.Networkidle0);
+            var coverage = await Page.Coverage.StopJSCoverageAsync();
+            Assert.That(coverage, Has.Exactly(1).Items);
+            Assert.IsNull(coverage[0].RawScriptCoverage);
+        }
+
+        [Test, Retry(2), PuppeteerTest("coverage.spec", "Coverage specs JSCoverage includeRawScriptCoverage", "should include rawScriptCoverage field when enabled")]
+        public async Task ShouldIncludeRawScriptCoverageFieldWhenEnabled()
+        {
+            await Page.Coverage.StartJSCoverageAsync(new CoverageStartOptions
+            {
+                IncludeRawScriptCoverage = true
+            });
+            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/simple.html", WaitUntilNavigation.Networkidle0);
+            var coverage = await Page.Coverage.StopJSCoverageAsync();
+            Assert.That(coverage, Has.Exactly(1).Items);
+            Assert.IsNotNull(coverage[0].RawScriptCoverage);
+        }
+    }
+}
diff --git a/lib/PuppeteerSharp.Tests/CoverageTests/JSCoverageTests.cs b/lib/PuppeteerSharp.Tests/CoverageTests/JSCoverageTests.cs
@@ -134,6 +134,7 @@ public async Task ShouldWorkWithConditionals()
         {
             const string involved = @"[
               {
+                ""RawScriptCoverage"": null,
                 ""Url"": ""http://localhost:<PORT>/jscoverage/involved.html"",
                 ""Ranges"": [
                   {
diff --git a/lib/PuppeteerSharp.Tests/CoverageTests/JSResetOnNavigationTests.cs b/lib/PuppeteerSharp.Tests/CoverageTests/JSResetOnNavigationTests.cs
@@ -7,10 +7,6 @@ namespace PuppeteerSharp.Tests.CoverageTests
 {
     public class JSResetOnNavigationTests : PuppeteerPageBaseTest
     {
-        public JSResetOnNavigationTests() : base()
-        {
-        }
-
         [Test, Retry(2), PuppeteerTest("coverage.spec", "Coverage specs resetOnNavigation", "should report scripts across navigations when disabled")]
         public async Task ShouldReportScriptsAcrossNavigationsWhenDisabled()
         {
diff --git a/lib/PuppeteerSharp/Messaging/CoverageResponseRange.cs b/lib/PuppeteerSharp/Messaging/CoverageResponseRange.cs
diff --git a/lib/PuppeteerSharp/Messaging/ProfilerTakePreciseCoverageResponse.cs b/lib/PuppeteerSharp/Messaging/ProfilerTakePreciseCoverageResponse.cs
@@ -1,19 +1,9 @@
+using PuppeteerSharp.PageCoverage;
+
 namespace PuppeteerSharp.Messaging
 {
     internal class ProfilerTakePreciseCoverageResponse
     {
-        public ProfilerTakePreciseCoverageResponseItem[] Result { get; set; }
-
-        internal class ProfilerTakePreciseCoverageResponseItem
-        {
-            public string ScriptId { get; set; }
-
-            public ProfilerTakePreciseCoverageResponseFunction[] Functions { get; set; }
-        }
-
-        internal class ProfilerTakePreciseCoverageResponseFunction
-        {
-            public CoverageResponseRange[] Ranges { get; set; }
-        }
+        public ScriptCoverage[] Result { get; set; }
     }
 }
diff --git a/lib/PuppeteerSharp/PageCoverage/CSSCoverage.cs b/lib/PuppeteerSharp/PageCoverage/CSSCoverage.cs
@@ -68,17 +68,17 @@ await Task.WhenAll(
                 _client.SendAsync("CSS.disable"),
                 _client.SendAsync("DOM.disable")).ConfigureAwait(false);
 
-            var styleSheetIdToCoverage = new Dictionary<string, List<CoverageResponseRange>>();
+            var styleSheetIdToCoverage = new Dictionary<string, List<CoverageRange>>();
             foreach (var entry in trackingResponse.RuleUsage)
             {
                 styleSheetIdToCoverage.TryGetValue(entry.StyleSheetId, out var ranges);
                 if (ranges == null)
                 {
-                    ranges = new List<CoverageResponseRange>();
+                    ranges = new List<CoverageRange>();
                     styleSheetIdToCoverage[entry.StyleSheetId] = ranges;
                 }
 
-                ranges.Add(new CoverageResponseRange
+                ranges.Add(new CoverageRange
                 {
                     StartOffset = entry.StartOffset,
                     EndOffset = entry.EndOffset,
@@ -93,7 +93,7 @@ await Task.WhenAll(
                 var url = kv.Value.Url;
                 var text = kv.Value.Source;
                 styleSheetIdToCoverage.TryGetValue(styleSheetId, out var responseRanges);
-                var ranges = Coverage.ConvertToDisjointRanges(responseRanges ?? new List<CoverageResponseRange>());
+                var ranges = Coverage.ConvertToDisjointRanges(responseRanges ?? new List<CoverageRange>());
                 coverage.Add(new CoverageEntry
                 {
                     Url = url,
diff --git a/lib/PuppeteerSharp/PageCoverage/Coverage.cs b/lib/PuppeteerSharp/PageCoverage/Coverage.cs
@@ -22,7 +22,7 @@ public Task StartJSCoverageAsync(CoverageStartOptions options = null)
             => _jsCoverage.StartAsync(options ?? new CoverageStartOptions());
 
         /// <inheritdoc/>
-        public Task<CoverageEntry[]> StopJSCoverageAsync() => _jsCoverage.StopAsync();
+        public Task<JSCoverageEntry[]> StopJSCoverageAsync() => _jsCoverage.StopAsync();
 
         /// <inheritdoc/>
         public Task StartCSSCoverageAsync(CoverageStartOptions options = null)
@@ -31,7 +31,7 @@ public Task StartCSSCoverageAsync(CoverageStartOptions options = null)
         /// <inheritdoc/>
         public Task<CoverageEntry[]> StopCSSCoverageAsync() => _cssCoverage.StopAsync();
 
-        internal static CoverageEntryRange[] ConvertToDisjointRanges(List<CoverageResponseRange> nestedRanges)
+        internal static CoverageEntryRange[] ConvertToDisjointRanges(List<CoverageRange> nestedRanges)
         {
             var points = new List<CoverageEntryPoint>();
             foreach (var range in nestedRanges)
diff --git a/lib/PuppeteerSharp/PageCoverage/CoverageEntry.cs b/lib/PuppeteerSharp/PageCoverage/CoverageEntry.cs
@@ -1,11 +1,9 @@
-using System.Collections.Generic;
-
 namespace PuppeteerSharp.PageCoverage
 {
     /// <summary>
     /// Coverage report for all non-anonymous scripts.
     /// </summary>
-    public class CoverageEntry
+    public record CoverageEntry
     {
         /// <summary>
         /// Script URL.
diff --git a/lib/PuppeteerSharp/PageCoverage/CoverageEntryPoint.cs b/lib/PuppeteerSharp/PageCoverage/CoverageEntryPoint.cs
@@ -9,7 +9,7 @@ internal class CoverageEntryPoint : IComparable<CoverageEntryPoint>
 
         public int Type { get; internal set; }
 
-        public CoverageResponseRange Range { get; internal set; }
+        public CoverageRange Range { get; internal set; }
 
         public int CompareTo(CoverageEntryPoint other)
         {
diff --git a/lib/PuppeteerSharp/PageCoverage/CoverageEntryRange.cs b/lib/PuppeteerSharp/PageCoverage/CoverageEntryRange.cs
@@ -3,7 +3,7 @@ namespace PuppeteerSharp.PageCoverage
     /// <summary>
     /// Script range.
     /// </summary>
-    public class CoverageEntryRange
+    public record CoverageEntryRange
     {
         /// <summary>
         /// A start offset in text, inclusive.
@@ -16,23 +16,5 @@ public class CoverageEntryRange
         /// </summary>
         /// <value>End offset.</value>
         public int End { get; internal set; }
-
-        /// <inheritdoc/>
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "Exceptions should not be raised in this type of method.")]
-        public override bool Equals(object obj)
-        {
-            if (obj == null && GetType() != obj.GetType())
-            {
-                return false;
-            }
-
-            var range = obj as CoverageEntryRange;
-
-            return range.Start == Start &&
-               range.End == End;
-        }
-
-        /// <inheritdoc/>
-        public override int GetHashCode() => Start.GetHashCode() * 397 ^ End.GetHashCode() * 397;
     }
 }
diff --git a/lib/PuppeteerSharp/PageCoverage/CoverageRange.cs b/lib/PuppeteerSharp/PageCoverage/CoverageRange.cs
@@ -0,0 +1,23 @@
+namespace PuppeteerSharp.PageCoverage
+{
+    /// <summary>
+    /// Coverage data for a source range.
+    /// </summary>
+    public record CoverageRange
+    {
+        /// <summary>
+        /// JavaScript script source offset for the range start.
+        /// </summary>
+        public int StartOffset { get; set; }
+
+        /// <summary>
+        /// JavaScript script source offset for the range end.
+        /// </summary>
+        public int EndOffset { get; set; }
+
+        /// <summary>
+        /// Collected execution count of the source range.
+        /// </summary>
+        public int Count { get; set; }
+    }
+}
diff --git a/lib/PuppeteerSharp/PageCoverage/CoverageStartOptions.cs b/lib/PuppeteerSharp/PageCoverage/CoverageStartOptions.cs
@@ -19,5 +19,10 @@ public class CoverageStartOptions
         /// If <see cref="ReportAnonymousScripts"/> is set to `true`, anonymous scripts will have `__puppeteer_evaluation_script__` as their URL.
         /// </remarks>
         public bool ReportAnonymousScripts { get; set; }
+
+        /// <summary>
+        /// Whether the result includes raw V8 script coverage entries.
+        /// </summary>
+        public bool IncludeRawScriptCoverage { get; set; }
     }
 }
diff --git a/lib/PuppeteerSharp/PageCoverage/FunctionCoverage.cs b/lib/PuppeteerSharp/PageCoverage/FunctionCoverage.cs
@@ -0,0 +1,22 @@
+namespace PuppeteerSharp.PageCoverage;
+
+/// <summary>
+/// Coverage data for a JavaScript function.
+/// </summary>
+public record FunctionCoverage
+{
+    /// <summary>
+    /// JavaScript function name.
+    /// </summary>
+    public string FunctionName { get; set; }
+
+    /// <summary>
+    /// Source ranges inside the function with coverage data.
+    /// </summary>
+    public CoverageRange[] Ranges { get; set; }
+
+    /// <summary>
+    /// Whether coverage data for this function has block granularity.
+    /// </summary>
+    public bool IsBlockCoverage { get; set; }
+}
diff --git a/lib/PuppeteerSharp/PageCoverage/ICoverage.cs b/lib/PuppeteerSharp/PageCoverage/ICoverage.cs
@@ -37,6 +37,6 @@ public interface ICoverage
         /// <remarks>
         /// JavaScript Coverage doesn't include anonymous scripts by default; however, scripts with sourceURLs are reported.
         /// </remarks>
-        Task<CoverageEntry[]> StopJSCoverageAsync();
+        Task<JSCoverageEntry[]> StopJSCoverageAsync();
     }
 }
diff --git a/lib/PuppeteerSharp/PageCoverage/JSCoverage.cs b/lib/PuppeteerSharp/PageCoverage/JSCoverage.cs
@@ -18,6 +18,7 @@ internal class JSCoverage
         private bool _enabled;
         private bool _resetOnNavigation;
         private bool _reportAnonymousScripts;
+        private bool _includeRawScriptCoverage;
 
         public JSCoverage(CDPSession client)
         {
@@ -39,6 +40,7 @@ internal Task StartAsync(CoverageStartOptions options)
 
             _resetOnNavigation = options.ResetOnNavigation;
             _reportAnonymousScripts = options.ReportAnonymousScripts;
+            _includeRawScriptCoverage = options.IncludeRawScriptCoverage;
             _enabled = true;
             _scriptURLs.Clear();
             _scriptSources.Clear();
@@ -49,14 +51,14 @@ internal Task StartAsync(CoverageStartOptions options)
                 _client.SendAsync("Profiler.enable"),
                 _client.SendAsync("Profiler.startPreciseCoverage", new ProfilerStartPreciseCoverageRequest
                 {
-                    CallCount = false,
+                    CallCount = _includeRawScriptCoverage,
                     Detailed = true,
                 }),
                 _client.SendAsync("Debugger.enable"),
                 _client.SendAsync("Debugger.setSkipAllPauses", new DebuggerSetSkipAllPausesRequest { Skip = true }));
         }
 
-        internal async Task<CoverageEntry[]> StopAsync()
+        internal async Task<JSCoverageEntry[]> StopAsync()
         {
             if (!_enabled)
             {
@@ -73,7 +75,7 @@ await Task.WhenAll(
                _client.SendAsync("Debugger.disable")).ConfigureAwait(false);
             _client.MessageReceived -= Client_MessageReceived;
 
-            var coverage = new List<CoverageEntry>();
+            var coverage = new List<JSCoverageEntry>();
             foreach (var entry in profileResponseTask.Result.Result)
             {
                 _scriptURLs.TryGetValue(entry.ScriptId, out var url);
@@ -90,11 +92,12 @@ await Task.WhenAll(
 
                 var flattenRanges = entry.Functions.SelectMany(f => f.Ranges).ToList();
                 var ranges = Coverage.ConvertToDisjointRanges(flattenRanges);
-                coverage.Add(new CoverageEntry
+                coverage.Add(new JSCoverageEntry
                 {
                     Url = url,
                     Ranges = ranges,
                     Text = text,
+                    RawScriptCoverage = _includeRawScriptCoverage ? entry : null,
                 });
             }
 
diff --git a/lib/PuppeteerSharp/PageCoverage/JSCoverageEntry.cs b/lib/PuppeteerSharp/PageCoverage/JSCoverageEntry.cs
@@ -0,0 +1,34 @@
+// * MIT License
+//  *
+//  * Copyright (c) Darío Kondratiuk
+//  *
+//  * Permission is hereby granted, free of charge, to any person obtaining a copy
+//  * of this software and associated documentation files (the "Software"), to deal
+//  * in the Software without restriction, including without limitation the rights
+//  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  * copies of the Software, and to permit persons to whom the Software is
+//  * furnished to do so, subject to the following conditions:
+//  *
+//  * The above copyright notice and this permission notice shall be included in all
+//  * copies or substantial portions of the Software.
+//  *
+//  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  * SOFTWARE.
+
+namespace PuppeteerSharp.PageCoverage;
+
+/// <summary>
+/// The CoverageEntry class for JavaScript.
+/// </summary>
+public record JSCoverageEntry : CoverageEntry
+{
+    /// <summary>
+    /// Raw V8 script coverage entry.
+    /// </summary>
+    public ScriptCoverage RawScriptCoverage { get; set; }
+}
diff --git a/lib/PuppeteerSharp/PageCoverage/ScriptCoverage.cs b/lib/PuppeteerSharp/PageCoverage/ScriptCoverage.cs
@@ -0,0 +1,22 @@
+namespace PuppeteerSharp.PageCoverage;
+
+/// <summary>
+/// Coverage data for a JavaScript script.
+/// </summary>
+public record ScriptCoverage
+{
+    /// <summary>
+    /// JavaScript script id.
+    /// </summary>
+    public string ScriptId { get; set; }
+
+    /// <summary>
+    /// JavaScript script name or url.
+    /// </summary>
+    public string Url { get; set; }
+
+    /// <summary>
+    /// Functions contained in the script that has coverage data.
+    /// </summary>
+    public FunctionCoverage[] Functions { get; set; }
+}

Original file line number	Diff line number	Diff line change
`@@ -134,6 +134,7 @@ public async Task ShouldWorkWithConditionals()`
`134`	`134`	`{`
`135`	`135`	`const string involved = @"[`
`136`	`136`	`{`
	`137`	`+ ""RawScriptCoverage"": null,`
`137`	`138`	`""Url"": ""http://localhost:<PORT>/jscoverage/involved.html"",`
`138`	`139`	`""Ranges"": [`
`139`	`140`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,6 @@ namespace PuppeteerSharp.Tests.CoverageTests`
`7`	`7`	`{`
`8`	`8`	`public class JSResetOnNavigationTests : PuppeteerPageBaseTest`
`9`	`9`	`{`
`10`		`- public JSResetOnNavigationTests() : base()`
`11`		`- {`
`12`		`- }`
`13`		`-`
`14`	`10`	`[Test, Retry(2), PuppeteerTest("coverage.spec", "Coverage specs resetOnNavigation", "should report scripts across navigations when disabled")]`
`15`	`11`	`public async Task ShouldReportScriptsAcrossNavigationsWhenDisabled()`
`16`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,19 +1,9 @@`
	`1`	`+using PuppeteerSharp.PageCoverage;`
	`2`	`+`
`1`	`3`	`namespace PuppeteerSharp.Messaging`
`2`	`4`	`{`
`3`	`5`	`internal class ProfilerTakePreciseCoverageResponse`
`4`	`6`	`{`
`5`		`- public ProfilerTakePreciseCoverageResponseItem[] Result { get; set; }`
`6`		`-`
`7`		`- internal class ProfilerTakePreciseCoverageResponseItem`
`8`		`- {`
`9`		`- public string ScriptId { get; set; }`
`10`		`-`
`11`		`- public ProfilerTakePreciseCoverageResponseFunction[] Functions { get; set; }`
`12`		`- }`
`13`		`-`
`14`		`- internal class ProfilerTakePreciseCoverageResponseFunction`
`15`		`- {`
`16`		`- public CoverageResponseRange[] Ranges { get; set; }`
`17`		`- }`
	`7`	`+ public ScriptCoverage[] Result { get; set; }`
`18`	`8`	`}`
`19`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,17 +68,17 @@ await Task.WhenAll(`
`68`	`68`	`_client.SendAsync("CSS.disable"),`
`69`	`69`	`_client.SendAsync("DOM.disable")).ConfigureAwait(false);`
`70`	`70`
`71`		`- var styleSheetIdToCoverage = new Dictionary<string, List<CoverageResponseRange>>();`
	`71`	`+ var styleSheetIdToCoverage = new Dictionary<string, List<CoverageRange>>();`
`72`	`72`	`foreach (var entry in trackingResponse.RuleUsage)`
`73`	`73`	`{`
`74`	`74`	`styleSheetIdToCoverage.TryGetValue(entry.StyleSheetId, out var ranges);`
`75`	`75`	`if (ranges == null)`
`76`	`76`	`{`
`77`		`- ranges = new List<CoverageResponseRange>();`
	`77`	`+ ranges = new List<CoverageRange>();`
`78`	`78`	`styleSheetIdToCoverage[entry.StyleSheetId] = ranges;`
`79`	`79`	`}`
`80`	`80`
`81`		`- ranges.Add(new CoverageResponseRange`
	`81`	`+ ranges.Add(new CoverageRange`
`82`	`82`	`{`
`83`	`83`	`StartOffset = entry.StartOffset,`
`84`	`84`	`EndOffset = entry.EndOffset,`
`@@ -93,7 +93,7 @@ await Task.WhenAll(`
`93`	`93`	`var url = kv.Value.Url;`
`94`	`94`	`var text = kv.Value.Source;`
`95`	`95`	`styleSheetIdToCoverage.TryGetValue(styleSheetId, out var responseRanges);`
`96`		`- var ranges = Coverage.ConvertToDisjointRanges(responseRanges ?? new List<CoverageResponseRange>());`
	`96`	`+ var ranges = Coverage.ConvertToDisjointRanges(responseRanges ?? new List<CoverageRange>());`
`97`	`97`	`coverage.Add(new CoverageEntry`
`98`	`98`	`{`
`99`	`99`	`Url = url,`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,9 @@`
`1`		`-using System.Collections.Generic;`
`2`		`-`
`3`	`1`	`namespace PuppeteerSharp.PageCoverage`
`4`	`2`	`{`
`5`	`3`	`/// <summary>`
`6`	`4`	`/// Coverage report for all non-anonymous scripts.`
`7`	`5`	`/// </summary>`
`8`		`- public class CoverageEntry`
	`6`	`+ public record CoverageEntry`
`9`	`7`	`{`
`10`	`8`	`/// <summary>`
`11`	`9`	`/// Script URL.`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ internal class CoverageEntryPoint : IComparable<CoverageEntryPoint>`
`9`	`9`
`10`	`10`	`public int Type { get; internal set; }`
`11`	`11`
`12`		`- public CoverageResponseRange Range { get; internal set; }`
	`12`	`+ public CoverageRange Range { get; internal set; }`
`13`	`13`
`14`	`14`	`public int CompareTo(CoverageEntryPoint other)`
`15`	`15`	`{`