/** * Copyright (c) Microsoft Corporation. * * 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. */ import * as api from '../../types/types'; import * as channels from '../protocol/channels'; import { Artifact } from './artifact'; import { BrowserContext } from './browserContext'; import fs from 'fs'; import path from 'path'; import yauzl from 'yauzl'; import yazl from 'yazl'; import { assert, calculateSha1 } from '../utils/utils'; import { ManualPromise } from '../utils/async'; import EventEmitter from 'events'; import { ClientInstrumentationListener } from './clientInstrumentation'; import { ParsedStackTrace } from '../utils/stackTrace'; export class Tracing implements api.Tracing { private _context: BrowserContext; private _sources = new Set(); private _instrumentationListener: ClientInstrumentationListener; constructor(channel: BrowserContext) { this._context = channel; this._instrumentationListener = { onApiCallBegin: (apiCall: string, stackTrace: ParsedStackTrace | null) => { for (const frame of stackTrace?.frames || []) this._sources.add(frame.file); } }; } async start(options: { name?: string, title?: string, snapshots?: boolean, screenshots?: boolean, sources?: boolean } = {}) { if (options.sources) this._context._instrumentation!.addListener(this._instrumentationListener); await this._context._wrapApiCall(async (channel: channels.BrowserContextChannel) => { await channel.tracingStart(options); await channel.tracingStartChunk({ title: options.title }); }); } async startChunk(options: { title?: string } = {}) { this._sources = new Set(); await this._context._wrapApiCall(async (channel: channels.BrowserContextChannel) => { await channel.tracingStartChunk(options); }); } async stopChunk(options: { path?: string } = {}) { await this._context._wrapApiCall(async (channel: channels.BrowserContextChannel) => { await this._doStopChunk(channel, options.path); }); } async stop(options: { path?: string } = {}) { await this._context._wrapApiCall(async (channel: channels.BrowserContextChannel) => { await this._doStopChunk(channel, options.path); await channel.tracingStop(); }); } private async _doStopChunk(channel: channels.BrowserContextChannel, filePath: string | undefined) { const sources = this._sources; this._sources = new Set(); this._context._instrumentation!.removeListener(this._instrumentationListener); const skipCompress = !this._context._connection.isRemote(); const result = await channel.tracingStopChunk({ save: !!filePath, skipCompress }); if (!filePath) { // Not interested in artifacts. return; } // If we don't have anything locally and we run against remote Playwright, compress on remote side. if (!skipCompress && !sources) { const artifact = Artifact.from(result.artifact!); await artifact.saveAs(filePath); await artifact.delete(); return; } // We either have sources to append or we were running locally, compress on client side const promise = new ManualPromise(); const zipFile = new yazl.ZipFile(); (zipFile as any as EventEmitter).on('error', error => promise.reject(error)); // Add sources. if (sources) { for (const source of sources) { try { if (fs.statSync(source).isFile()) zipFile.addFile(source, 'resources/src@' + calculateSha1(source) + '.txt'); } catch (e) { } } } await fs.promises.mkdir(path.dirname(filePath), { recursive: true }); if (skipCompress) { // Local scenario, compress the entries. for (const entry of result.entries!) zipFile.addFile(entry.value, entry.name); zipFile.end(undefined, () => { zipFile.outputStream.pipe(fs.createWriteStream(filePath)).on('close', () => promise.resolve()); }); return promise; } // Remote scenario, repack. const artifact = Artifact.from(result.artifact!); const tmpPath = filePath! + '.tmp'; await artifact.saveAs(tmpPath); await artifact.delete(); yauzl.open(tmpPath!, (err, inZipFile) => { if (err) { promise.reject(err); return; } assert(inZipFile); let pendingEntries = inZipFile.entryCount; inZipFile.on('entry', entry => { inZipFile.openReadStream(entry, (err, readStream) => { if (err) { promise.reject(err); return; } zipFile.addReadStream(readStream!, entry.fileName); if (--pendingEntries === 0) { zipFile.end(undefined, () => { zipFile.outputStream.pipe(fs.createWriteStream(filePath)).on('close', () => { fs.promises.unlink(tmpPath).then(() => { promise.resolve(); }); }); }); } }); }); }); return promise; } }