Merge pull request #3024 from preactjs/log-dir-per-bench

Create separate trace log directories per benchmark

Author: marvinhagemeister

benches/.gitignore

@@ -1,5 +1,6 @@
 dist/
 results/
 logs/
+logs-saved/
 node_modules/
 proxy-packages/*/package-lock.json

benches/package-lock.json

@@ -21,6 +21,7 @@
 		"escalade": "^3.0.2",
 		"escape-string-regexp": "^4.0.0",
 		"globby": "^11.0.0",
+		"prompts": "^2.4.0",
 		"sade": "^1.7.3",
 		"strip-ansi": "^6.0.0",
 		"tachometer": "^0.5.7",

benches/package.json

@@ -1,6 +1,7 @@
+import { existsSync } from 'fs';
 import { readFile, readdir } from 'fs/promises';
-import { frameworks } from './config.js';
-import { benchesRoot } from './utils.js';
+import prompts from 'prompts';
+import { baseTraceLogDir, frameworks } from './config.js';
 
 // @ts-ignore
 import tachometerStats from 'tachometer/lib/stats.js';
@@ -290,15 +291,43 @@ export async function analyze() {
 		'duration'
 	];
 
+	if (!existsSync(baseTraceLogDir())) {
+		console.log(
+			`Could not find log directory: "${baseTraceLogDir()}". Did you run the benchmarks?`
+		);
+		return;
+	}
+
+	const benchmarkNames = await readdir(baseTraceLogDir());
+	let selectedBench;
+	if (benchmarkNames.length == 0) {
+		console.log(`No benchmarks or results found in "${baseTraceLogDir()}".`);
+		return;
+	} else if (benchmarkNames.length == 1) {
+		selectedBench = benchmarkNames[0];
+	} else {
+		selectedBench = (
+			await prompts({
+				type: 'select',
+				name: 'value',
+				message: "Which benchmark's results would you like to analyze?",
+				choices: benchmarkNames.map(name => ({
+					title: name,
+					value: name
+				}))
+			})
+		).value;
+	}
+
 	/** @type {Map<string, ResultStats[]>} */
 	const resultStatsMap = new Map();
 	for (let framework of frameworkNames) {
-		const logDir = benchesRoot('logs', framework);
+		const logDir = baseTraceLogDir(selectedBench, framework);
 
 		let logFilePaths;
 		try {
 			logFilePaths = (await readdir(logDir)).map(fn =>
-				benchesRoot('logs', framework, fn)
+				baseTraceLogDir(selectedBench, framework, fn)
 			);
 		} catch (e) {
 			// If directory doesn't exist or we fail to read it, just skip

benches/scripts/analyze.js

@@ -32,6 +32,14 @@ export const defaultBenchOptions = {
 export async function runBenches(bench1 = 'all', opts) {
 	const globs = bench1 === 'all' ? allBenches : [bench1].concat(opts._);
 	const benchesToRun = await globSrc(globs);
+
+	if (benchesToRun.length == 0) {
+		console.log('No benchmarks found matching patterns:', globs);
+	} else {
+		console.log('Running benchmarks:', benchesToRun.join(', '));
+		console.log();
+	}
+
 	const configFileTasks = benchesToRun.map(async (benchPath, i) => {
 		return generateConfig(benchesRoot('src', benchPath), {
 			...opts,

benches/scripts/bench.js

@@ -10,7 +10,8 @@ const warnings = new Set([]);
 const TACH_SCHEMA =
 	'https://raw.githubusercontent.com/Polymer/tachometer/master/config.schema.json';
 
-const traceLogDir = benchesRoot('logs');
+export const baseTraceLogDir = (...args) =>
+	path.join(benchesRoot('logs'), ...args);
 
 /**
  * @param {ConfigFileBenchmark["packageVersions"]["dependencies"]["framework"]} framework
@@ -171,6 +172,7 @@ export async function generateConfig(benchPath, options) {
 	}
 
 	if (browser.name == 'chrome' && options.trace) {
+		const traceLogDir = baseTraceLogDir(baseBenchConfig.name);
 		await del('**/*', { cwd: traceLogDir });
 		await mkdir(traceLogDir, { recursive: true });