feat: add opsSecPerRun result (#74)

* feat: add opsSecPerRun array

This will be useful when comparing runs (statisticallanalysis)

* fixup! feat: add opsSecPerRun array

---------

Co-authored-by: RafaelGSS <rafael.nunu@hotmail.com>

Author: Cesar-M-Diaz

README.md

@@ -95,6 +95,7 @@ A `Suite` manages and executes benchmark functions. It provides two methods: `ad
     * `results` {Object[]} Array of benchmark results:
       * `name` {string} Benchmark name.
       * `opsSec` {string} Operations per second.
+      * `opsSecPerRun` {Array} Array of operations per second (useful when repeatSuite > 1).
       * `iterations` {Number} Number of iterations.
       * `histogram` {Histogram} Histogram instance.
   * `benchmarkMode` {string} Benchmark mode to use. Can be 'ops' or 'time'. **Default:** `'ops'`.

lib/lifecycle.js

@@ -164,6 +164,8 @@ async function runBenchmark(
 
 	let totalIterations = 0;
 	let totalTimeSpent = 0;
+	const opsSecPerRun = [];
+
 	for (let i = 0; i < repeatSuite; ++i) {
 		const { iterations, timeSpent } = await runBenchmarkOnce(
 			bench,
@@ -175,6 +177,10 @@ async function runBenchmark(
 			},
 			benchmarkMode,
 		);
+
+		const runOpsSec = iterations / (timeSpent / timer.scale);
+		opsSecPerRun.push(runOpsSec);
+
 		totalTimeSpent += timeSpent;
 		totalIterations += iterations;
 	}
@@ -206,6 +212,7 @@ async function runBenchmark(
 		);
 	} else {
 		result.opsSec = opsSec;
+		result.opsSecPerRun = opsSecPerRun;
 		debugBench(
 			`${bench.name} completed ${sampleData.length} samples with ${opsSec.toFixed(2)} ops/sec`,
 		);

test/basic.js

@@ -204,6 +204,48 @@ describe("simple usage", async () => {
 		assert.ok(bench1.iterations >= 10);
 		assert.ok(bench2.iterations >= 10);
 	});
+
+	it("opsSecPerRun should exist when repeatSuite is 1", async () => {
+		assert.ok(
+			Array.isArray(bench1.opsSecPerRun),
+			"opsSecPerRun should be an array",
+		);
+		assert.ok(
+			Array.isArray(bench2.opsSecPerRun),
+			"opsSecPerRun should be an array",
+		);
+	});
+});
+
+describe("repeat suite", async () => {
+	const repeatCount = 3;
+	const bench = new Suite({ reporter: noop });
+	bench.add("Repeat ops test", { repeatSuite: repeatCount }, () => {
+		// Simple operation
+		const x = 1 + 1;
+	});
+
+	const results = await bench.run();
+
+	it("should include opsSecPerRun when repeatSuite is greater than 1", async () => {
+		assert.strictEqual(results.length, 1);
+		assert.ok(results[0].opsSec !== undefined, "opsSec should be defined");
+		assert.ok(
+			Array.isArray(results[0].opsSecPerRun),
+			"opsSecPerRun should be an array",
+		);
+		assert.strictEqual(
+			results[0].opsSecPerRun.length,
+			repeatCount,
+			`opsSecPerRun should have ${repeatCount} elements`,
+		);
+		for (const opsSec of results[0].opsSecPerRun) {
+			assert.ok(
+				typeof opsSec === "number" && !Number.isNaN(opsSec),
+				"each element should be a valid number",
+			);
+		}
+	});
 });
 
 describe("throws when a benchmark task throw", async () => {