mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
5a6488883a
This patch adds `categories` option to the `page.tracing.start` method that allows to override default tracing categories. References #1300, #854
90 lines
2.7 KiB
JavaScript
90 lines
2.7 KiB
JavaScript
/**
|
|
* Copyright 2017 Google Inc. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
const {helper} = require('./helper');
|
|
const fs = require('fs');
|
|
|
|
const openAsync = helper.promisify(fs.open);
|
|
const writeAsync = helper.promisify(fs.write);
|
|
const closeAsync = helper.promisify(fs.close);
|
|
|
|
class Tracing {
|
|
/**
|
|
* @param {!Puppeteer.Session} client
|
|
*/
|
|
constructor(client) {
|
|
this._client = client;
|
|
this._recording = false;
|
|
this._path = '';
|
|
}
|
|
|
|
/**
|
|
* @param {!Object} options
|
|
*/
|
|
async start(options) {
|
|
console.assert(!this._recording, 'Cannot start recording trace while already recording trace.');
|
|
console.assert(options.path, 'Must specify a path to write trace file to.');
|
|
|
|
const defaultCategories = [
|
|
'-*', 'devtools.timeline', 'v8.execute', 'disabled-by-default-devtools.timeline',
|
|
'disabled-by-default-devtools.timeline.frame', 'toplevel',
|
|
'blink.console', 'blink.user_timing', 'latencyInfo', 'disabled-by-default-devtools.timeline.stack',
|
|
'disabled-by-default-v8.cpu_profiler'
|
|
];
|
|
const categoriesArray = options.categories || defaultCategories;
|
|
|
|
if (options.screenshots)
|
|
categoriesArray.push('disabled-by-default-devtools.screenshot');
|
|
|
|
this._path = options.path;
|
|
this._recording = true;
|
|
await this._client.send('Tracing.start', {
|
|
transferMode: 'ReturnAsStream',
|
|
categories: categoriesArray.join(',')
|
|
});
|
|
}
|
|
|
|
async stop() {
|
|
let fulfill;
|
|
const contentPromise = new Promise(x => fulfill = x);
|
|
this._client.once('Tracing.tracingComplete', event => {
|
|
this._readStream(event.stream, this._path).then(fulfill);
|
|
});
|
|
await this._client.send('Tracing.end');
|
|
this._recording = false;
|
|
return contentPromise;
|
|
}
|
|
|
|
/**
|
|
* @param {string} handle
|
|
* @param {string} path
|
|
*/
|
|
async _readStream(handle, path) {
|
|
let eof = false;
|
|
const file = await openAsync(path, 'w');
|
|
while (!eof) {
|
|
const response = await this._client.send('IO.read', {handle});
|
|
eof = response.eof;
|
|
if (path)
|
|
await writeAsync(file, response.data);
|
|
}
|
|
await closeAsync(file);
|
|
await this._client.send('IO.close', {handle});
|
|
}
|
|
}
|
|
helper.tracePublicAPI(Tracing);
|
|
|
|
module.exports = Tracing;
|