[Live Now] Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Join for FREE! Join TestMu Conference

How to use JSCoverage method of PuppeteerSharp.PageCoverage.JSCoverage class

Best Puppeteer-sharp code snippet using PuppeteerSharp.PageCoverage.JSCoverage.JSCoverage

JSCoverageTests.cs

Source:JSCoverageTests.cs

...5using Newtonsoft.Json;6using PuppeteerSharp.PageCoverage;7using Xunit;8using Xunit.Abstractions;9namespace PuppeteerSharp.Tests.JSCoverageTests10{11    [Collection("PuppeteerLoaderFixture collection")]12    public class JSCoverageTests : PuppeteerPageBaseTest13    {14        public JSCoverageTests(ITestOutputHelper output) : base(output)15        {16        }17        [Fact]18        public async Task ShouldWork()19        {20            await Page.Coverage.StartJSCoverageAsync();21            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/simple.html");22            var coverage = await Page.Coverage.StopJSCoverageAsync();23            Assert.Single(coverage);24            Assert.Contains("/jscoverage/simple.html", coverage[0].Url);25            Assert.Equal(new CoverageEntryRange[]26            {27                new CoverageEntryRange28                {29                    Start = 0,30                    End = 1731                },32                new CoverageEntryRange33                {34                    Start = 35,35                    End = 6136                },37            }, coverage[0].Ranges);38        }39        [Fact]40        public async Task ShouldReportSourceUrls()41        {42            await Page.Coverage.StartJSCoverageAsync();43            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/sourceurl.html");44            var coverage = await Page.Coverage.StopJSCoverageAsync();45            Assert.Single(coverage);46            Assert.Equal("nicename.js", coverage[0].Url);47        }48        [Fact]49        public async Task ShouldIgnoreAnonymousScripts()50        {51            await Page.Coverage.StartJSCoverageAsync();52            await Page.GoToAsync(TestConstants.EmptyPage);53            await Page.EvaluateExpressionAsync("console.log(1);");54            var coverage = await Page.Coverage.StopJSCoverageAsync();55            Assert.Empty(coverage);56        }57        [Fact]58        public async Task ShouldReportMultipleScripts()59        {60            await Page.Coverage.StartJSCoverageAsync();61            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/multiple.html");62            var coverage = await Page.Coverage.StopJSCoverageAsync();63            Assert.Equal(2, coverage.Length);64            var orderedList = coverage.OrderBy(c => c.Url);65            Assert.Contains("/jscoverage/script1.js", orderedList.ElementAt(0).Url);66            Assert.Contains("/jscoverage/script2.js", orderedList.ElementAt(1).Url);67        }68        [Fact]69        public async Task ShouldReportRightRanges()70        {71            await Page.Coverage.StartJSCoverageAsync();72            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/ranges.html");73            var coverage = await Page.Coverage.StopJSCoverageAsync();74            Assert.Single(coverage);75            var entry = coverage[0];76            Assert.Single(entry.Ranges);77            var range = entry.Ranges[0];78            Assert.Equal("console.log('used!');", entry.Text.Substring(range.Start, range.End - range.Start));79        }80        [Fact]81        public async Task ShouldReportScriptsThatHaveNoCoverage()82        {83            await Page.Coverage.StartJSCoverageAsync();84            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/unused.html");85            var coverage = await Page.Coverage.StopJSCoverageAsync();86            Assert.Single(coverage);87            var entry = coverage[0];88            Assert.Contains("unused.html", entry.Url);89            Assert.Empty(entry.Ranges);90        }91        [Fact]92        public async Task ShouldWorkWithConditionals()93        {94            const string involved = @"[95              {96                ""Url"": ""http://localhost:<PORT>/jscoverage/involved.html"",97                ""Ranges"": [98                  {99                    ""Start"": 0,100                    ""End"": 35101                  },102                  {103                    ""Start"": 50,104                    ""End"": 100105                  },106                  {107                    ""Start"": 107,108                    ""End"": 141109                  },110                  {111                    ""Start"": 148,112                    ""End"": 160113                  },114                  {115                    ""Start"": 168,116                    ""End"": 207117                  }118                ],119                ""Text"": ""\nfunction foo() {\n  if (1 > 2)\n    console.log(1);\n  if (1 < 2)\n    console.log(2);\n  let x = 1 > 2 ? 'foo' : 'bar';\n  let y = 1 < 2 ? 'foo' : 'bar';\n  let z = () => {};\n  let q = () => {};\n  q();\n}\n\nfoo();\n""120              }121            ]";122            await Page.Coverage.StartJSCoverageAsync();123            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/involved.html");124            var coverage = await Page.Coverage.StopJSCoverageAsync();125            Assert.Equal(126                TestUtils.CompressText(involved),127                Regex.Replace(TestUtils.CompressText(JsonConvert.SerializeObject(coverage)), @"\d{4}\/", "<PORT>/"));128        }129    }130}...

JSCoverage.cs

Source:JSCoverage.cs

...6using PuppeteerSharp.Helpers;7using PuppeteerSharp.Messaging;8namespace PuppeteerSharp.PageCoverage9{10    internal class JSCoverage11    {12        private readonly CDPSession _client;13        private readonly Dictionary<string, string> _scriptURLs;14        private readonly Dictionary<string, string> _scriptSources;15        private readonly ILogger _logger;16        private bool _enabled;17        private bool _resetOnNavigation;18        private bool _reportAnonymousScripts;19        public JSCoverage(CDPSession client)20        {21            _client = client;22            _enabled = false;23            _scriptURLs = new Dictionary<string, string>();24            _scriptSources = new Dictionary<string, string>();25            _logger = _client.Connection.LoggerFactory.CreateLogger<JSCoverage>();26            _resetOnNavigation = false;27        }28        internal Task StartAsync(CoverageStartOptions options)29        {30            if (_enabled)31            {32                throw new InvalidOperationException("JSCoverage is already enabled");33            }34            _resetOnNavigation = options.ResetOnNavigation;35            _reportAnonymousScripts = options.ReportAnonymousScripts;36            _enabled = true;37            _scriptURLs.Clear();38            _scriptSources.Clear();39            _client.MessageReceived += client_MessageReceived;40            return Task.WhenAll(41                _client.SendAsync("Profiler.enable"),42                _client.SendAsync("Profiler.startPreciseCoverage", new { callCount = false, detailed = true }),43                _client.SendAsync("Debugger.enable"),44                _client.SendAsync("Debugger.setSkipAllPauses", new { skip = true })45            );46        }47        internal async Task<CoverageEntry[]> StopAsync()48        {49            if (!_enabled)50            {51                throw new InvalidOperationException("JSCoverage is not enabled");52            }53            _enabled = false;54            var profileResponseTask = _client.SendAsync<ProfilerTakePreciseCoverageResponse>("Profiler.takePreciseCoverage");55            await Task.WhenAll(56               profileResponseTask,57               _client.SendAsync("Profiler.stopPreciseCoverage"),58               _client.SendAsync("Profiler.disable"),59               _client.SendAsync("Debugger.disable")60           ).ConfigureAwait(false);61            _client.MessageReceived -= client_MessageReceived;62            var coverage = new List<CoverageEntry>();63            foreach (var entry in profileResponseTask.Result.Result)64            {65                _scriptURLs.TryGetValue(entry.ScriptId, out var url);...

Coverage.cs

Source:Coverage.cs

...8    /// gathers information about parts of JavaScript and CSS that were used by the page.9    /// </summary>10    public class Coverage11    {12        private readonly JSCoverage _jsCoverage;13        private readonly CSSCoverage _cssCoverage;14        internal Coverage(CDPSession client)15        {16            _jsCoverage = new JSCoverage(client);17            _cssCoverage = new CSSCoverage(client);18        }19        /// <summary>20        /// Starts JS coverage21        /// </summary>22        /// <param name="options">Set of configurable options for coverage</param>23        /// <returns>A task that resolves when coverage is started</returns>24        public Task StartJSCoverageAsync(CoverageStartOptions options = null)25            => _jsCoverage.StartAsync(options ?? new CoverageStartOptions());26        /// <summary>27        /// Stops JS coverage and returns coverage reports for all scripts28        /// </summary>29        /// <returns>Task that resolves to the array of coverage reports for all stylesheets</returns>30        /// <remarks>31        /// JavaScript Coverage doesn't include anonymous scripts by default; however, scripts with sourceURLs are reported.32        /// </remarks>33        public Task<CoverageEntry[]> StopJSCoverageAsync() => _jsCoverage.StopAsync();34        /// <summary>35        /// Starts CSS coverage36        /// </summary>37        /// <param name="options">Set of configurable options for coverage</param>38        /// <returns>A task that resolves when coverage is started</returns>39        public Task StartCSSCoverageAsync(CoverageStartOptions options = null)40            => _cssCoverage.StartAsync(options ?? new CoverageStartOptions());41        /// <summary>42        /// Stops JS coverage and returns coverage reports for all non-anonymous scripts43        /// </summary>44        /// <returns>Task that resolves to the array of coverage reports for all stylesheets</returns>45        /// <remarks>46        /// JavaScript Coverage doesn't include anonymous scripts; however, scripts with sourceURLs are reported.47        /// </remarks>...

JSResetOnNavigationTests.cs

Source:JSResetOnNavigationTests.cs

...4using Newtonsoft.Json;5using PuppeteerSharp.PageCoverage;6using Xunit;7using Xunit.Abstractions;8namespace PuppeteerSharp.Tests.JSCoverageTests9{10    [Collection("PuppeteerLoaderFixture collection")]11    public class JSResetOnNavigationTests : PuppeteerPageBaseTest12    {13        public JSResetOnNavigationTests(ITestOutputHelper output) : base(output)14        {15        }16        [Fact]17        public async Task ShouldReportScriptsAcrossNavigationsWhenDisabled()18        {19            await Page.Coverage.StartJSCoverageAsync(new CoverageStartOptions20            {21                ResetOnNavigation = false22            });23            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/multiple.html");24            await Page.GoToAsync(TestConstants.EmptyPage);25            var coverage = await Page.Coverage.StopJSCoverageAsync();26            Assert.Equal(2, coverage.Length);27        }28        [Fact]29        public async Task ShouldNotReportScriptsAcrossNavigationsWhenEnabled()30        {31            await Page.Coverage.StartJSCoverageAsync();32            await Page.GoToAsync(TestConstants.ServerUrl + "/jscoverage/multiple.html");33            await Page.GoToAsync(TestConstants.EmptyPage);34            var coverage = await Page.Coverage.StopJSCoverageAsync();35            Assert.Empty(coverage);36        }37    }38}...

JSCoverage

Using AI Code Generation

1using (var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true }))2{3    var page = await browser.NewPageAsync();4    var jsCoverage = await page.Coverage.StartJSCoverageAsync();5    await page.EvaluateFunctionAsync("() => alert('hello')");6    await page.Coverage.StopJSCoverageAsync();7}8using (var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true }))9{10    var page = await browser.NewPageAsync();11    var cssCoverage = await page.Coverage.StartCSSCoverageAsync();12    await page.EvaluateFunctionAsync("() => alert('hello')");13    await page.Coverage.StopCSSCoverageAsync();14}15using (var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true }))16{17    var page = await browser.NewPageAsync();18    var cssCoverage = await page.Coverage.StartCSSCoverageAsync();19    await page.EvaluateFunctionAsync("() => alert('hello')");20    await page.Coverage.StopCSSCoverageAsync();21}22using (var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true }))23{24    var page = await browser.NewPageAsync();25    var jsCoverage = await page.Coverage.StartJSCoverageAsync();26    await page.EvaluateFunctionAsync("() => alert('hello')");27    await page.Coverage.StopJSCoverageAsync();28}29using (var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true }))30{31    var page = await browser.NewPageAsync();

JSCoverage

Using AI Code Generation

1var page = await browser.NewPageAsync();2var coverage = await page.Coverage.StartJSCoverageAsync();3var jsCoverage = await page.Coverage.StopJSCoverageAsync();4var page = await browser.NewPageAsync();5var coverage = await page.Coverage.StartCSSCoverageAsync();6var cssCoverage = await page.Coverage.StopCSSCoverageAsync();7var page = await browser.NewPageAsync();8var coverage = await page.Coverage.StartJSCoverageAsync();9var jsCoverage = await page.Coverage.StopJSCoverageAsync();10var page = await browser.NewPageAsync();11var coverage = await page.Coverage.StartCSSCoverageAsync();12var cssCoverage = await page.Coverage.StopCSSCoverageAsync();13var page = await browser.NewPageAsync();14var coverage = await page.Coverage.StartJSCoverageAsync();15var jsCoverage = await page.Coverage.StopJSCoverageAsync();16var page = await browser.NewPageAsync();17var coverage = await page.Coverage.StartCSSCoverageAsync();18var cssCoverage = await page.Coverage.StopCSSCoverageAsync();

JSCoverage

Using AI Code Generation

1var page = await browser.NewPageAsync();2var jsCoverage = await page.Coverage.JSCoverage();3await jsCoverage.StartAsync();4var jsCoverageResult = await jsCoverage.StopAsync();5await page.CloseAsync();6var page = await browser.NewPageAsync();7var cssCoverage = await page.Coverage.CSSCoverage();8await cssCoverage.StartAsync();9var cssCoverageResult = await cssCoverage.StopAsync();10await page.CloseAsync();11var page = await browser.NewPageAsync();12await page.Coverage.StartJSCoverageAsync();13var jsCoverageResult = await page.Coverage.StopJSCoverageAsync();14await page.CloseAsync();15var page = await browser.NewPageAsync();16await page.Coverage.StartCSSCoverageAsync();17var cssCoverageResult = await page.Coverage.StopCSSCoverageAsync();18await page.CloseAsync();19var page = await browser.NewPageAsync();20await page.Coverage.StartJSCoverageAsync();21var jsCoverageResult = await page.Coverage.StopJSCoverageAsync();22await page.CloseAsync();23var page = await browser.NewPageAsync();24await page.Coverage.StartCSSCoverageAsync();

JSCoverage

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using PuppeteerSharp;7{8    {9        public static async Task<Dictionary<string, double>> GetCoverage(Page page)10        {11            var coverage = await page.Coverage.GetJSCoverageAsync();12            var result = new Dictionary<string, double>();13            foreach (var entry in coverage)14            {15                var url = entry.Url;16                var functions = entry.Functions;17                foreach (var function in functions)18                {19                    var functionName = function.FunctionName;20                    var range = function.Range;21                    var isBlockCoverage = function.IsBlockCoverage;22                    var ranges = function.Ranges;23                    var count = ranges.Count(a => a.Count > 0);24                    var total = ranges.Count;25                    var percent = (double)count / total;26                    var key = $"{url}::{functionName}";27                    result.Add(key, percent);28                }29            }30            return result;31        }32    }33}34using System;35using System.Collections.Generic;36using System.Linq;37using System.Text;38using System.Threading.Tasks;39using PuppeteerSharp;40{41    {42        public static async Task<Dictionary<string, double>> GetCoverage(Page page)43        {44            var coverage = await page.Coverage.GetJSCoverageAsync();45            var result = new Dictionary<string, double>();46            foreach (var entry in coverage)47            {48                var url = entry.Url;49                var functions = entry.Functions;50                foreach (var function in functions)51                {52                    var functionName = function.FunctionName;53                    var range = function.Range;54                    var isBlockCoverage = function.IsBlockCoverage;55                    var ranges = function.Ranges;56                    var count = ranges.Count(a => a.Count > 0);57                    var total = ranges.Count;58                    var percent = (double)count / total;59                    var key = $"{url}::{functionName}";60                    result.Add(key, percent);61                }62            }63            return result;64        }65    }66}

JSCoverage

Using AI Code Generation

1var jsCoverage = await page.JSCoverage.StartAsync();2var coverage = await jsCoverage.StopAsync();3Console.WriteLine("Coverage: " + coverage);4var cssCoverage = await page.CSSCoverage.StartAsync();5var coverage = await cssCoverage.StopAsync();6Console.WriteLine("Coverage: " + coverage);7var cssCoverage = await page.CSSCoverage.StartAsync();8var coverage = await cssCoverage.StopAsync();9Console.WriteLine("Coverage: " + coverage);10var jsCoverage = await page.JSCoverage.StartAsync();11var coverage = await jsCoverage.StopAsync();12Console.WriteLine("Coverage: " + coverage);13var cssCoverage = await page.CSSCoverage.StartAsync();14var coverage = await cssCoverage.StopAsync();15Console.WriteLine("Coverage: " + coverage);16var jsCoverage = await page.JSCoverage.StartAsync();17var coverage = await jsCoverage.StopAsync();18Console.WriteLine("Coverage: " + coverage);19var cssCoverage = await page.CSSCoverage.StartAsync();20var coverage = await cssCoverage.StopAsync();21Console.WriteLine("Coverage: " + coverage);22var cssCoverage = await page.CSSCoverage.StartAsync();23await page.GoToAsync("https

JSCoverage

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using PuppeteerSharp;4{5    {6        static async Task Main(string[] args)7        {8            await new BrowserFetcher().DownloadAsync(BrowserFetcher.DefaultRevision);9            var browser = await Puppeteer.LaunchAsync(new LaunchOptions10            {11            });12            var page = await browser.NewPageAsync();13            var coverage = await page.JSCoverage.StartAsync();14            await page.JSCoverage.StopAsync();15            await File.WriteAllTextAsync("coverage.json", JsonConvert.SerializeObject(coverage));16        }17    }18}

JSCoverage

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using PuppeteerSharp;4using System.IO;5using System.Text.Json;6using System.Text.Json.Serialization;7using System.Linq;8using System.Collections.Generic;9{10    {11        public static async Task GenerateCoverageReport(string url, string jsFilePath)12        {13            {14                Args = new string[] { "--no-sandbox" }15            };16            var browser = await Puppeteer.LaunchAsync(options);17            var page = await browser.NewPageAsync();18            await page.GoToAsync(url);19            await page.Coverage.StartJSCoverageAsync();20            await page.GoToAsync(url);21            var coverage = await page.Coverage.StopJSCoverageAsync();22            var jsFileName = Path.GetFileName(jsFilePath);23            var jsFileCoverage = coverage.Where(c => c.Url.Contains(jsFileName)).SingleOrDefault();24            if (jsFileCoverage != null)25            {26                var jsFileContent = File.ReadAllText(jsFilePath);27                var report = GenerateReport(jsFileCoverage, jsFileContent);28                File.WriteAllText("report.json", report);29            }30        }31        public static string GenerateReport(JSCoverageEntry coverage, string jsFileContent)32        {33            var lines = jsFileContent.Split(Environment.NewLine);34            var functions = new List<Function>();35            for (int i = 0; i < lines.Length; i++)36            {37                var line = lines[i];38                {39                };40                functions.Add(function);41            }42            foreach (var range in coverage.Functions)43            {44                var startLine = range.StartOffset;45                var endLine = range.EndOffset;46                for (int i = startLine; i <= endLine; i++)47                {48                    functions[i].Executed = true;49                }50            }51            {52            };53            return JsonSerializer.Serialize(report);54        }55    }56}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.