diff --git a/docs/api.md b/docs/api.md
index 6e4c0240..167b2d9d 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -199,7 +199,9 @@
* [target.type()](#targettype)
* [target.url()](#targeturl)
- [class: Coverage](#class-coverage)
+ * [coverage.startCSSCoverage(options)](#coveragestartcsscoverageoptions)
* [coverage.startJSCoverage(options)](#coveragestartjscoverageoptions)
+ * [coverage.stopCSSCoverage()](#coveragestopcsscoverage)
* [coverage.stopJSCoverage()](#coveragestopjscoverage)
@@ -2155,11 +2157,56 @@ Identifies what kind of target this is. Can be `"page"`, `"service_worker"`, or
### class: Coverage
+Coverage gathers information about parts of JavaScript and CSS that were used by the page.
+
+An example of using JavaScript and CSS coverage to get percentage of initially
+executed code:
+
+```js
+// Enable both JavaScript and CSS coverage
+await Promise.all([
+ page.startJSCoverage(),
+ page.startCSSCoverage()
+]);
+// Navigate to page
+await page.goto('https://example.com');
+// Disable both JavaScript and CSS coverage
+const [jsCoverage, cssCoverage] = await Promise.all([
+ page.stopJSCoverage(),
+ page.stopCSSCoverage(),
+]);
+let totalBytes = 0;
+let usedBytes = 0;
+const coverage = [].concat(jsCoverage, cssCoverage);
+for (const entry of coverage) {
+ totalBytes += entry.text.length;
+ for (const range of entry.ranges)
+ usedBytes += range.end - range.start - 1;
+}
+console.log(`Bytes used: ${usedBytes / totalBytes * 100}%`);
+```
+
+#### coverage.startCSSCoverage(options)
+- `options` <[Object]> Set of configurable options for coverage
+ - `resetOnNavigation` <[boolean]> Whether to reset coverage on every navigation. Defaults to `true`.
+- returns: <[Promise]> Promise that resolves when coverage is started
+
#### coverage.startJSCoverage(options)
- `options` <[Object]> Set of configurable options for coverage
- `resetOnNavigation` <[boolean]> Whether to reset coverage on every navigation. Defaults to `true`.
- returns: <[Promise]> Promise that resolves when coverage is started
+#### coverage.stopCSSCoverage()
+- returns: <[Promise]<[Array]<[Object]>>> Promise that resolves to the array of coverage reports for all stylesheets
+ - `url` <[string]> StyleSheet URL
+ - `text` <[string]> StyleSheet content
+ - `ranges` <[Array]<[Object]>> StyleSheet ranges that were used. Ranges are sorted and non-overlapping.
+ - `start` <[number]> A start offset in text, inclusive
+ - `end` <[number]> An end offset in text, exclusive
+
+> **NOTE** CSS Coverage doesn't include dynamically injected style tags without sourceURLs.
+
+
#### coverage.stopJSCoverage()
- returns: <[Promise]<[Array]<[Object]>>> Promise that resolves to the array of coverage reports for all non-anonymous scripts
- `url` <[string]> Script URL
@@ -2171,22 +2218,6 @@ Identifies what kind of target this is. Can be `"page"`, `"service_worker"`, or
> **NOTE** JavaScript Coverage doesn't include anonymous scripts; however, scripts with sourceURLs are
reported.
-An example of using JavaScript coverage to get percentage of executed
-code:
-
-```js
-await page.startJSCoverage();
-await page.goto('https://example.com');
-const coverage = await page.stopJSCoverage();
-let totalBytes = 0;
-let usedBytes = 0;
-for (const entry of coverage) {
- totalBytes += entry.text.length;
- for (const range of entry.ranges)
- usedBytes += range.end - range.start - 1;
-}
-console.log(`Coverage is ${usedBytes / totalBytes * 100}%`);
-```
[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
diff --git a/lib/Coverage.js b/lib/Coverage.js
index 195dd4ad..0a513d8b 100644
--- a/lib/Coverage.js
+++ b/lib/Coverage.js
@@ -16,12 +16,20 @@
const {helper, debugError} = require('./helper');
+/**
+ * @typedef {Object} CoverageEntry
+ * @property {string} url
+ * @property {string} text
+ * @property {!Array} ranges
+ */
+
class Coverage {
/**
* @param {!Puppeteer.Session} client
*/
constructor(client) {
this._jsCoverage = new JSCoverage(client);
+ this._cssCoverage = new CSSCoverage(client);
}
/**
@@ -31,9 +39,26 @@ class Coverage {
return await this._jsCoverage.start(options);
}
+ /**
+ * @return {!Promise>}
+ */
async stopJSCoverage() {
return await this._jsCoverage.stop();
}
+
+ /**
+ * @param {!Object} options
+ */
+ async startCSSCoverage(options) {
+ return await this._cssCoverage.start(options);
+ }
+
+ /**
+ * @return {!Promise>}
+ */
+ async stopCSSCoverage() {
+ return await this._cssCoverage.stop();
+ }
}
module.exports = {Coverage};
@@ -98,7 +123,7 @@ class JSCoverage {
}
/**
- * @return {!Promise}>>}
+ * @return {!Promise>}
*/
async stop() {
console.assert(this._enabled, 'JSCoverage is not enabled');
@@ -127,6 +152,104 @@ class JSCoverage {
}
}
+class CSSCoverage {
+ /**
+ * @param {!Puppeteer.Session} client
+ */
+ constructor(client) {
+ this._client = client;
+ this._enabled = false;
+ this._stylesheetURLs = new Map();
+ this._stylesheetSources = new Map();
+ this._eventListeners = [];
+ this._resetOnNavigation = false;
+ }
+
+ /**
+ * @param {!Object} options
+ */
+ async start(options = {}) {
+ console.assert(!this._enabled, 'CSSCoverage is already enabled');
+ this._resetOnNavigation = options.resetOnNavigation === undefined ? true : !!options.resetOnNavigation;
+ this._enabled = true;
+ this._stylesheetURLs.clear();
+ this._stylesheetSources.clear();
+ this._eventListeners = [
+ helper.addEventListener(this._client, 'CSS.styleSheetAdded', this._onStyleSheet.bind(this)),
+ helper.addEventListener(this._client, 'Runtime.executionContextsCleared', this._onExecutionContextsCleared.bind(this)),
+ ];
+ await Promise.all([
+ this._client.send('DOM.enable'),
+ this._client.send('CSS.enable'),
+ this._client.send('CSS.startRuleUsageTracking'),
+ ]);
+ }
+
+ _onExecutionContextsCleared() {
+ if (!this._resetOnNavigation)
+ return;
+ this._stylesheetURLs.clear();
+ this._stylesheetSources.clear();
+ }
+
+ /**
+ * @param {!Object} event
+ */
+ async _onStyleSheet(event) {
+ const header = event.header;
+ // Ignore anonymous scripts
+ if (!header.sourceURL)
+ return;
+ try {
+ const response = await this._client.send('CSS.getStyleSheetText', {styleSheetId: header.styleSheetId});
+ this._stylesheetURLs.set(header.styleSheetId, header.sourceURL);
+ this._stylesheetSources.set(header.styleSheetId, response.text);
+ } catch (e) {
+ // This might happen if the page has already navigated away.
+ debugError(e);
+ }
+ }
+
+ /**
+ * @return {!Promise>}
+ */
+ async stop() {
+ console.assert(this._enabled, 'CSSCoverage is not enabled');
+ this._enabled = false;
+ const [ruleTrackingResponse] = await Promise.all([
+ this._client.send('CSS.stopRuleUsageTracking'),
+ this._client.send('CSS.disable'),
+ this._client.send('DOM.disable'),
+ ]);
+ helper.removeEventListeners(this._eventListeners);
+
+ // aggregarte by styleSheetId
+ const styleSheetIdToCoverage = new Map();
+ for (const entry of ruleTrackingResponse.ruleUsage) {
+ let ranges = styleSheetIdToCoverage.get(entry.styleSheetId);
+ if (!ranges) {
+ ranges = [];
+ styleSheetIdToCoverage.set(entry.styleSheetId, ranges);
+ }
+ ranges.push({
+ startOffset: entry.startOffset,
+ endOffset: entry.endOffset,
+ count: entry.used ? 1 : 0,
+ });
+ }
+
+ const coverage = [];
+ for (const styleSheetId of this._stylesheetURLs.keys()) {
+ const url = this._stylesheetURLs.get(styleSheetId);
+ const text = this._stylesheetSources.get(styleSheetId);
+ const ranges = convertToDisjointRanges(styleSheetIdToCoverage.get(styleSheetId) || []);
+ coverage.push({url, ranges, text});
+ }
+
+ return coverage;
+ }
+}
+
/**
* @param {!Array} nestedRanges
* @return {!Array}
diff --git a/test/assets/csscoverage/Dosis-Regular.ttf b/test/assets/csscoverage/Dosis-Regular.ttf
new file mode 100644
index 00000000..4b208624
Binary files /dev/null and b/test/assets/csscoverage/Dosis-Regular.ttf differ
diff --git a/test/assets/csscoverage/OFL.txt b/test/assets/csscoverage/OFL.txt
new file mode 100644
index 00000000..35a72818
--- /dev/null
+++ b/test/assets/csscoverage/OFL.txt
@@ -0,0 +1,95 @@
+Copyright (c) 2011, Edgar Tolentino and Pablo Impallari (www.impallari.com|impallari@gmail.com),
+Copyright (c) 2011, Igino Marini. (www.ikern.com|mail@iginomarini.com),
+with Reserved Font Names "Dosis".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/test/assets/csscoverage/involved.html b/test/assets/csscoverage/involved.html
new file mode 100644
index 00000000..bcd9845b
--- /dev/null
+++ b/test/assets/csscoverage/involved.html
@@ -0,0 +1,26 @@
+
+
woof!
+fancy text
+
diff --git a/test/assets/csscoverage/media.html b/test/assets/csscoverage/media.html
new file mode 100644
index 00000000..bfb89f8f
--- /dev/null
+++ b/test/assets/csscoverage/media.html
@@ -0,0 +1,4 @@
+
+