mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
62da2366c6
Introduce `//lib/api.js` that declares a list of publicly exposed classes. The `//lib/api.js` list superceedes dynamic `helper.tracePublicAPI()` calls and is used in the following places: - [ASYNC STACKS]: generate "async stacks" for publicy exposed API in `//index.js` - [COVERAGE]: move coverage support from `//lib/helper` to `//test/utils` - [DOCLINT]: get rid of 'exluded classes' hardcoded list This will help us to re-use our coverage and doclint infrastructure for Puppeteer-Firefox. Drive-By: it turns out we didn't run coverage for `SecurityDetails` class, so we lack coverage for a few methods there. These are excluded for now, sanity tests will be added in a follow-up.
106 lines
3.0 KiB
JavaScript
106 lines
3.0 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, assert} = 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.CDPSession} client
|
|
*/
|
|
constructor(client) {
|
|
this._client = client;
|
|
this._recording = false;
|
|
this._path = '';
|
|
}
|
|
|
|
/**
|
|
* @param {!{path: string, screenshots?: boolean, categories?: !Array<string>}} options
|
|
*/
|
|
async start(options) {
|
|
assert(!this._recording, 'Cannot start recording trace while already recording trace.');
|
|
|
|
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', 'disabled-by-default-v8.cpu_profiler.hires'
|
|
];
|
|
const {
|
|
path = null,
|
|
screenshots = false,
|
|
categories = defaultCategories,
|
|
} = options;
|
|
|
|
if (screenshots)
|
|
categories.push('disabled-by-default-devtools.screenshot');
|
|
|
|
this._path = path;
|
|
this._recording = true;
|
|
await this._client.send('Tracing.start', {
|
|
transferMode: 'ReturnAsStream',
|
|
categories: categories.join(',')
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @return {!Promise<!Buffer>}
|
|
*/
|
|
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;
|
|
let file;
|
|
if (path)
|
|
file = await openAsync(path, 'w');
|
|
const bufs = [];
|
|
while (!eof) {
|
|
const response = await this._client.send('IO.read', {handle});
|
|
eof = response.eof;
|
|
bufs.push(Buffer.from(response.data));
|
|
if (path)
|
|
await writeAsync(file, response.data);
|
|
}
|
|
if (path)
|
|
await closeAsync(file);
|
|
await this._client.send('IO.close', {handle});
|
|
let resultBuffer = null;
|
|
try {
|
|
resultBuffer = Buffer.concat(bufs);
|
|
} finally {
|
|
return resultBuffer;
|
|
}
|
|
}
|
|
}
|
|
|
|
module.exports = Tracing;
|