b34d9aba25
This introduces basic tracing enabled in our tests. What is captured: - network resources; - snapshots at the start of most actions; - snapshot after the test failure. How this integrates with test runner: - context fixture calls private method context._initSnapshotter() and uses Tracer to trace all events; - all tests share a single test-results/trace-storage directory to store blobs; - each test has its own trace file. - npm run show-trace opens a bare-minimum trace viewer that renders snapshots.
108 lines
3.7 KiB
TypeScript
108 lines
3.7 KiB
TypeScript
/**
|
|
* Copyright 2017 Google Inc. All rights reserved.
|
|
* Modifications 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 { EventEmitter } from 'events';
|
|
import * as removeFolder from 'rimraf';
|
|
import * as util from 'util';
|
|
import * as types from './types';
|
|
import { Progress } from './progress';
|
|
|
|
const removeFolderAsync = util.promisify(removeFolder);
|
|
|
|
export type RegisteredListener = {
|
|
emitter: EventEmitter;
|
|
eventName: (string | symbol);
|
|
handler: (...args: any[]) => void;
|
|
};
|
|
|
|
class Helper {
|
|
static addEventListener(
|
|
emitter: EventEmitter,
|
|
eventName: (string | symbol),
|
|
handler: (...args: any[]) => void): RegisteredListener {
|
|
emitter.on(eventName, handler);
|
|
return { emitter, eventName, handler };
|
|
}
|
|
|
|
static removeEventListeners(listeners: Array<{
|
|
emitter: EventEmitter;
|
|
eventName: (string | symbol);
|
|
handler: (...args: any[]) => void;
|
|
}>) {
|
|
for (const listener of listeners)
|
|
listener.emitter.removeListener(listener.eventName, listener.handler);
|
|
listeners.splice(0, listeners.length);
|
|
}
|
|
|
|
static completeUserURL(urlString: string): string {
|
|
if (urlString.startsWith('localhost') || urlString.startsWith('127.0.0.1'))
|
|
urlString = 'http://' + urlString;
|
|
return urlString;
|
|
}
|
|
|
|
static enclosingIntRect(rect: types.Rect): types.Rect {
|
|
const x = Math.floor(rect.x + 1e-3);
|
|
const y = Math.floor(rect.y + 1e-3);
|
|
const x2 = Math.ceil(rect.x + rect.width - 1e-3);
|
|
const y2 = Math.ceil(rect.y + rect.height - 1e-3);
|
|
return { x, y, width: x2 - x, height: y2 - y };
|
|
}
|
|
|
|
static enclosingIntSize(size: types.Size): types.Size {
|
|
return { width: Math.floor(size.width + 1e-3), height: Math.floor(size.height + 1e-3) };
|
|
}
|
|
|
|
static getViewportSizeFromWindowFeatures(features: string[]): types.Size | null {
|
|
const widthString = features.find(f => f.startsWith('width='));
|
|
const heightString = features.find(f => f.startsWith('height='));
|
|
const width = widthString ? parseInt(widthString.substring(6), 10) : NaN;
|
|
const height = heightString ? parseInt(heightString.substring(7), 10) : NaN;
|
|
if (!Number.isNaN(width) && !Number.isNaN(height))
|
|
return { width, height };
|
|
return null;
|
|
}
|
|
|
|
static async removeFolders(dirs: string[]) {
|
|
await Promise.all(dirs.map(dir => {
|
|
return removeFolderAsync(dir).catch((err: Error) => console.error(err));
|
|
}));
|
|
}
|
|
|
|
static waitForEvent(progress: Progress | null, emitter: EventEmitter, event: string | symbol, predicate?: Function): { promise: Promise<any>, dispose: () => void } {
|
|
const listeners: RegisteredListener[] = [];
|
|
const promise = new Promise((resolve, reject) => {
|
|
listeners.push(helper.addEventListener(emitter, event, eventArg => {
|
|
try {
|
|
if (predicate && !predicate(eventArg))
|
|
return;
|
|
helper.removeEventListeners(listeners);
|
|
resolve(eventArg);
|
|
} catch (e) {
|
|
helper.removeEventListeners(listeners);
|
|
reject(e);
|
|
}
|
|
}));
|
|
});
|
|
const dispose = () => helper.removeEventListeners(listeners);
|
|
if (progress)
|
|
progress.cleanupWhenAborted(dispose);
|
|
return { promise, dispose };
|
|
}
|
|
}
|
|
|
|
export const helper = Helper;
|