feat: add several code refactor/fixes (#123)

* fix(clock): use util.debuglog and declare plugin template vars

Replace incorrect util.debug usage with util.debuglog('benchmark') and declare newCode/functionToCall during plugin template generation.

* fix(plugins): declare loop variable in validatePlugins

Use 'for (const p of plugins)' to avoid leaking loop variable.

* fix(reporter): format ops/sec as numbers for Intl.NumberFormat

Pass numbers (not stringified .toFixed) to Intl.NumberFormat for consistent formatting.

* fix(html): avoid timer shadowing and use real timer.format

Import real timer from clock and rename local number formatter; use timer.format for ns min/max.

* fix(validation): enforce exclusive minTime > 1e-6 and min bounds

Make minTime strictly greater than 1e-6; enforce repeatSuite and minSamples minimums.

* test(copy): increase minSamples to reduce variance

Raise minSamples to stabilize same-function comparison.

Author: RafaelGSS

lib/clock.js

@@ -1,9 +1,7 @@
-const { debug, types } = require("node:util");
+const { debuglog } = require("node:util");
 const { validateNumber } = require("./validators");
 
-let debugBench = debug("benchmark", (fn) => {
-	debugBench = fn;
-});
+const debugBench = debuglog("benchmark");
 
 const kUnmanagedTimerResult = Symbol("kUnmanagedTimerResult");
 
@@ -137,7 +135,7 @@ const duration = Number(${varNames.timer}.now() - startedAt);
 
 	for (const p of bench.plugins) {
 		if (typeof p.afterClockTemplate === "function") {
-			[newCode] = p.afterClockTemplate(varNames);
+			const [newCode] = p.afterClockTemplate(varNames);
 			code += newCode;
 		}
 	}
@@ -163,7 +161,7 @@ let ${varNames.context} = {};
 	const wrapFunctions = [];
 	for (const p of bench.plugins) {
 		if (typeof p.beforeClockTemplate === "function") {
-			[newCode, functionToCall] = p.beforeClockTemplate(varNames);
+			const [newCode, functionToCall] = p.beforeClockTemplate(varNames);
 			code += newCode;
 			if (functionToCall) {
 				wrapFunctions.push(functionToCall);
@@ -180,7 +178,7 @@ const result = ${varNames.timer}[kUnmanagedTimerResult](${varNames.context});
 `;
 	for (const p of bench.plugins) {
 		if (typeof p.afterClockTemplate === "function") {
-			[newCode] = p.afterClockTemplate(varNames);
+			const [newCode] = p.afterClockTemplate(varNames);
 			code += newCode;
 		}
 	}

lib/index.js

@@ -153,22 +153,15 @@ class Suite {
 				...defaultBenchOptions,
 				...options,
 			};
+			// Enforce strict minimum (> 1e-6s). Using EPSILON to make boundary exclusive.
 			validateNumber(
 				options.minTime,
 				"options.minTime",
-				timer.resolution * 1e3,
+				timer.resolution * 1e3 + Number.EPSILON,
 			);
 			validateNumber(options.maxTime, "options.maxTime", options.minTime);
-			validateNumber(
-				options.repeatSuite,
-				"options.repeatSuite",
-				options.repeatSuite,
-			);
-			validateNumber(
-				options.minSamples,
-				"options.minSamples",
-				options.minSamples,
-			);
+			validateNumber(options.repeatSuite, "options.repeatSuite", 1);
+			validateNumber(options.minSamples, "options.minSamples", 1);
 		}
 		validateFunction(fn, "fn");
 

lib/plugins.js

@@ -13,7 +13,7 @@ const { validateFunction, validateArray } = require("./validators");
  * @throws {Error} If any plugin doesn't meet the requirements or isn't supported
  */
 function validatePlugins(plugins) {
-	for (p of plugins) {
+	for (const p of plugins) {
 		validateFunction(p.isSupported, "Plugins must have a isSupported method.");
 		validateFunction(p.toString, "Plugins must have a toString() method.");
 

lib/reporter/chart.js

@@ -27,7 +27,8 @@ function drawBar(
 
 	if (metric === "opsSec") {
 		percentage = value / total; // Higher ops/sec is better
-		const valueReported = value < 100 ? value.toFixed(2) : value.toFixed(0);
+		const valueReported =
+			value < 100 ? Number(value.toFixed(2)) : Math.round(value);
 		displayedValue = styleText(["yellow"], formatter.format(valueReported));
 		displayedMetric = "ops/sec";
 	} else {

lib/reporter/html.js

@@ -2,13 +2,14 @@ const { platform, arch, availableParallelism, totalmem } = require("node:os");
 const fs = require("node:fs");
 const path = require("node:path");
 const { summarize } = require("../utils/analyze");
+const { timer } = require("../clock");
 
 const formatter = Intl.NumberFormat(undefined, {
 	notation: "standard",
 	maximumFractionDigits: 3,
 });
 
-const timer = Intl.NumberFormat(undefined, {
+const timeNumberFormat = Intl.NumberFormat(undefined, {
 	minimumFractionDigits: 3,
 	maximumFractionDigits: 3,
 });

lib/reporter/pretty.js

@@ -146,9 +146,11 @@ function printResult(result, prefixLength) {
 
 	if (result.opsSec !== undefined) {
 		const opsSecReported =
-			result.opsSec < 100 ? result.opsSec.toFixed(2) : result.opsSec.toFixed(0);
+			result.opsSec < 100
+				? Number(result.opsSec.toFixed(2))
+				: Math.round(result.opsSec);
 		process.stdout.write(
-			styleText([color, "bold"], `${formatter.format(opsSecReported)} ops/sec`),
+			styleText(["bold"], `${formatter.format(opsSecReported)} ops/sec`),
 		);
 	} else if (result.totalTime !== undefined) {
 		let timeFormatted;

lib/reporter/text.js

@@ -21,8 +21,8 @@ function textReport(results, options = {}) {
 		if (result.opsSec !== undefined) {
 			const opsSecReported =
 				result.opsSec < 100
-					? result.opsSec.toFixed(2)
-					: result.opsSec.toFixed(0);
+					? Number(result.opsSec.toFixed(2))
+					: Math.round(result.opsSec);
 			process.stdout.write(
 				styleText(
 					["blue", "bold"],

test/fixtures/copy.js

@@ -3,17 +3,17 @@ const { Suite } = require("../../lib");
 const suite = new Suite({ reporter: false });
 
 suite
-	.add("Using includes", () => {
+	.add("Using includes", { minSamples: 20 }, () => {
 		const text =
 			"text/html,application/xhtml+xml,application/xml;application/json;q=0.9,image/avif,image/webp,*/*;q=0.8";
 		const r = text.includes("application/json");
 	})
-	.add("Using includes 2", () => {
+	.add("Using includes 2", { minSamples: 20 }, () => {
 		const text =
 			"text/html,application/xhtml+xml,application/xml;application/json;q=0.9,image/avif,image/webp,*/*;q=0.8";
 		const r = text.includes("application/json");
 	})
-	.add("Using includes 3", () => {
+	.add("Using includes 3", { minSamples: 20 }, () => {
 		const text =
 			"text/html,application/xhtml+xml,application/xml;application/json;q=0.9,image/avif,image/webp,*/*;q=0.8";
 		const r = text.includes("application/json");