puppeteer-core
Version:
A high-level API to control headless Chrome over the DevTools Protocol
114 lines • 3.8 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Tracing = void 0;
const util_js_1 = require("../common/util.js");
const assert_js_1 = require("../util/assert.js");
const Deferred_js_1 = require("../util/Deferred.js");
const ErrorLike_js_1 = require("../util/ErrorLike.js");
/**
* The Tracing class exposes the tracing audit interface.
* @remarks
* You can use `tracing.start` and `tracing.stop` to create a trace file
* which can be opened in Chrome DevTools or {@link https://chromedevtools.github.io/timeline-viewer/ | timeline viewer}.
*
* @example
*
* ```ts
* await page.tracing.start({path: 'trace.json'});
* await page.goto('https://www.google.com');
* await page.tracing.stop();
* ```
*
* @public
*/
class Tracing {
#client;
#recording = false;
#path;
/**
* @internal
*/
constructor(client) {
this.#client = client;
}
/**
* @internal
*/
updateClient(client) {
this.#client = client;
}
/**
* Starts a trace for the current page.
* @remarks
* Only one trace can be active at a time per browser.
*
* @param options - Optional `TracingOptions`.
*/
async start(options = {}) {
(0, assert_js_1.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',
];
const { path, screenshots = false, categories = defaultCategories } = options;
if (screenshots) {
categories.push('disabled-by-default-devtools.screenshot');
}
const excludedCategories = categories
.filter(cat => {
return cat.startsWith('-');
})
.map(cat => {
return cat.slice(1);
});
const includedCategories = categories.filter(cat => {
return !cat.startsWith('-');
});
this.#path = path;
this.#recording = true;
await this.#client.send('Tracing.start', {
transferMode: 'ReturnAsStream',
traceConfig: {
excludedCategories,
includedCategories,
},
});
}
/**
* Stops a trace started with the `start` method.
* @returns Promise which resolves to buffer with trace data.
*/
async stop() {
const contentDeferred = Deferred_js_1.Deferred.create();
this.#client.once('Tracing.tracingComplete', async (event) => {
try {
(0, assert_js_1.assert)(event.stream, 'Missing "stream"');
const readable = await (0, util_js_1.getReadableFromProtocolStream)(this.#client, event.stream);
const typedArray = await (0, util_js_1.getReadableAsTypedArray)(readable, this.#path);
contentDeferred.resolve(typedArray ?? undefined);
}
catch (error) {
if ((0, ErrorLike_js_1.isErrorLike)(error)) {
contentDeferred.reject(error);
}
else {
contentDeferred.reject(new Error(`Unknown error: ${error}`));
}
}
});
await this.#client.send('Tracing.end');
this.#recording = false;
return await contentDeferred.valueOrThrow();
}
}
exports.Tracing = Tracing;
//# sourceMappingURL=Tracing.js.map