perfrunner-core
Version:
Automated UI performance test tool to measure performance changes for the web apps and sites
128 lines (127 loc) • 6.27 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.runProfilingSession = void 0;
const puppeteer_1 = __importDefault(require("puppeteer"));
const logger_1 = require("../logger");
const trace_1 = require("./trace");
const setup_1 = require("./setup");
const extractor_1 = require("./extractor");
const utils_1 = require("../utils");
const performance_observers_1 = require("./performance-observers");
const MAX_RETRIES = 1;
function warmingBrowser(url, pageInstance) {
return __awaiter(this, void 0, void 0, function* () {
(0, logger_1.debug)('warming up page');
yield pageInstance.goto(url.href, { waitUntil: 'networkidle0' });
(0, logger_1.debug)('warming finished, closing page');
yield pageInstance.close();
});
}
function runApplication(url, page, options) {
return __awaiter(this, void 0, void 0, function* () {
(0, logger_1.debug)('launching the app');
const { waitFor, afterPageLoaded } = options || {};
yield page.goto(url.href, { waitUntil: 'networkidle0' });
if (typeof waitFor === 'number' && waitFor != 0 && !isNaN(waitFor)) {
(0, logger_1.debug)(`waiting for timer: ${waitFor} the app`);
yield page.waitFor(waitFor);
}
if (typeof waitFor === 'string' && waitFor.trim() !== '') {
(0, logger_1.debug)(`waiting for selector: ${waitFor} the app`);
yield page.waitForSelector(waitFor);
}
if (typeof afterPageLoaded === 'function') {
yield page.evaluate(afterPageLoaded);
}
});
}
function newPage(browser, timeout) {
return __awaiter(this, void 0, void 0, function* () {
const newPage = yield browser.newPage();
newPage.setDefaultTimeout(timeout);
return newPage;
});
}
function profilePage(browser, params, traceTo, timeout, retries = 0) {
var _a;
return __awaiter(this, void 0, void 0, function* () {
const { useCache, url, throttlingRate, network, waitFor, afterPageLoaded } = params;
const tracer = new trace_1.Tracer(traceTo);
let page = null;
try {
page = yield newPage(browser, timeout);
yield (0, setup_1.setpPerformanceConditions)(page, { useCache, throttlingRate, network });
yield tracer.start(page);
yield runApplication(url, page, { waitFor, afterPageLoaded });
const trace = yield tracer.stop();
const result = yield (0, extractor_1.extractPerformanceMetrics)(page, trace);
yield page.close();
const fcp = result.performanceEntries.find((x) => x.name === 'first-contentful-paint');
(0, logger_1.debug)(`fcp: ${fcp ? fcp.startTime : 'not recorded'}`);
const lcp = result.performanceEntries.find((x) => x.entryType === performance_observers_1.LARGEST_CONTENTFUL_PAINT);
(0, logger_1.log)(`lcp: ${lcp ? lcp.startTime : 'not recorded'}`);
return result;
}
catch (error) {
if (page) {
yield page.close();
}
if (retries < MAX_RETRIES) {
(0, logger_1.log)(`Spotted an error, doing retry #${retries + 1}`);
const errorMessage = typeof error === 'object' && (error === null || error === void 0 ? void 0 : error.message)
? (_a = error === null || error === void 0 ? void 0 : error.message) === null || _a === void 0 ? void 0 : _a.toString()
: typeof error === 'string'
? error
: 'unknown error';
(0, logger_1.debug)(`Error message: ${errorMessage}`);
return yield profilePage(browser, params, traceTo, timeout, retries + 1);
}
(0, logger_1.log)(`Retrying limit exceeded, aborting profiling`);
throw error;
}
});
}
function runProfilingSession(browserLaunchOptions, profileOptions, numberOfRuns, outputTracesTo) {
return __awaiter(this, void 0, void 0, function* () {
const { args, headless, timeout, ignoreDefaultArgs, product, executablePath } = browserLaunchOptions;
(0, logger_1.debug)(`starting browser with args: ${args && args.length ? args : `no args provided`}`);
let browser = null;
try {
browser = yield puppeteer_1.default.launch({
headless,
timeout,
ignoreHTTPSErrors: true,
ignoreDefaultArgs,
args,
product,
executablePath,
});
// We need only one warmup for the browser
yield warmingBrowser(profileOptions.url, yield newPage(browser, timeout));
const params = new Array(numberOfRuns).fill(profileOptions);
const resultSequence = (0, utils_1.iterateAsync)(params, (options, i) => {
(0, logger_1.log)(`running test #${i + 1}`);
return profilePage(browser, options, outputTracesTo, timeout);
});
return yield (0, utils_1.asyncToArray)(resultSequence);
}
finally {
if (browser) {
browser.close();
}
}
});
}
exports.runProfilingSession = runProfilingSession;