@esposter/shared-node 4.1.2 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esposter/shared-node",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "description": "Node-only shared tooling: the machine-wide download cache, hidden-window child processes, and benchmark reporting reused across packages.",
   "keywords": [
     "benchmark",
@@ -52,10 +52,10 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@esposter/shared": "4.1.2"
+    "@esposter/shared": "4.2.0"
   },
   "devDependencies": {
-    "@esposter/configuration": "4.1.2",
+    "@esposter/configuration": "4.2.0",
     "@types/node": "^26.6.5",
     "tsdown": "^0.23.1"
   },
@@ -67,5 +67,5 @@
       "optional": true
     }
   },
-  "gitHead": "144e3f98570b015e3181bfbc6cb70d346ce826b5"
+  "gitHead": "fef4971cf6a621a2c1850f32fcec19ee4ec0de99"
 }

package/dist/bench.d.ts

@@ -1,5 +0,0 @@
-import { BenchCompareOptions } from "vitest";
-//#region src/services/constants.d.ts
-export declare const BASELINE_TASK_NAME = "native";
-export declare const BENCHMARK_RUN_OPTIONS: BenchCompareOptions;
-//#endregion

package/dist/bench.js

@@ -1,10 +0,0 @@
-//#region src/services/constants.ts
-const BASELINE_TASK_NAME = "native";
-const BENCHMARK_RUN_OPTIONS = {
-	iterations: 10,
-	time: 0,
-	warmupIterations: 5,
-	warmupTime: 0
-};
-//#endregion
-export { BASELINE_TASK_NAME, BENCHMARK_RUN_OPTIONS };

package/dist/cache.d.ts

@@ -1,7 +0,0 @@
-//#region src/services/cache/constants.d.ts
-export declare const CACHE_ROOT: string;
-export declare const CONTENT_CACHE_DIRECTORY: string;
-//#endregion
-//#region src/services/cache/readContentAddressedObject.d.ts
-export declare const readContentAddressedObject: (hash: string, download: () => Promise<Uint8Array>, directory?: string) => Promise<Buffer>;
-//#endregion

package/dist/cache.js

@@ -1,27 +0,0 @@
-import { InvalidOperationError, Operation, SITE_NAME, getResultAsync, noop } from "@esposter/shared";
-import { homedir } from "node:os";
-import { join } from "node:path";
-import { createHash } from "node:crypto";
-import { existsSync } from "node:fs";
-import { mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
-//#region src/services/cache/constants.ts
-const CACHE_ROOT = join(homedir(), SITE_NAME, "cache");
-const CONTENT_CACHE_DIRECTORY = join(CACHE_ROOT, "content");
-//#endregion
-//#region src/services/cache/readContentAddressedObject.ts
-const readContentAddressedObject = async (hash, download, directory = CONTENT_CACHE_DIRECTORY) => {
-	const path = join(directory, hash);
-	if (existsSync(path)) return readFile(path);
-	const bytes = Buffer.from(await download());
-	if (createHash("sha256").update(bytes).digest("hex") !== hash) throw new InvalidOperationError(Operation.Read, hash, "does not hash to its name");
-	await mkdir(directory, { recursive: true });
-	const temporaryPath = `${path}.${crypto.randomUUID()}.part`;
-	await writeFile(temporaryPath, bytes);
-	await getResultAsync(() => rename(temporaryPath, path)).match(noop, async (error) => {
-		await rm(temporaryPath, { force: true });
-		if (!existsSync(path)) throw error;
-	});
-	return bytes;
-};
-//#endregion
-export { CACHE_ROOT, CONTENT_CACHE_DIRECTORY, readContentAddressedObject };

package/dist/child-process.d.ts

@@ -1,16 +0,0 @@
-import { execFile as execFile$1, execFileSync as execFileSync$1, execSync as execSync$1, spawn as spawn$1, spawnSync as spawnSync$1 } from "node:child_process";
-//#region src/services/childProcess/execFile.d.ts
-export declare const execFile: typeof execFile$1;
-//#endregion
-//#region src/services/childProcess/execFileSync.d.ts
-export declare const execFileSync: typeof execFileSync$1;
-//#endregion
-//#region src/services/childProcess/execSync.d.ts
-export declare const execSync: typeof execSync$1;
-//#endregion
-//#region src/services/childProcess/spawn.d.ts
-export declare const spawn: typeof spawn$1;
-//#endregion
-//#region src/services/childProcess/spawnSync.d.ts
-export declare const spawnSync: typeof spawnSync$1;
-//#endregion

package/dist/child-process.js

@@ -1,17 +0,0 @@
-import { n as withHiddenWindow, t as execSync } from "./execSync-CtM99iYq.js";
-import { execFile as execFile$1, execFileSync as execFileSync$1, spawn as spawn$1, spawnSync as spawnSync$1 } from "node:child_process";
-import { promisify } from "node:util";
-//#region src/services/childProcess/execFile.ts
-const execFile = ((file, ...parameters) => execFile$1(file, ...withHiddenWindow(parameters)));
-Object.defineProperty(execFile, promisify.custom, { value: (file, ...parameters) => promisify(execFile$1)(file, ...withHiddenWindow(parameters)) });
-//#endregion
-//#region src/services/childProcess/execFileSync.ts
-const execFileSync = ((file, ...parameters) => execFileSync$1(file, ...withHiddenWindow(parameters)));
-//#endregion
-//#region src/services/childProcess/spawn.ts
-const spawn = ((file, ...parameters) => spawn$1(file, ...withHiddenWindow(parameters)));
-//#endregion
-//#region src/services/childProcess/spawnSync.ts
-const spawnSync = ((file, ...parameters) => spawnSync$1(file, ...withHiddenWindow(parameters)));
-//#endregion
-export { execFile, execFileSync, execSync, spawn, spawnSync };

package/dist/execSync-CtM99iYq.js

@@ -1,17 +0,0 @@
-import { execSync } from "node:child_process";
-//#region src/services/childProcess/withHiddenWindow.ts
-const withHiddenWindow = (parameters) => {
-	const optionsIndex = Array.isArray(parameters[0]) || parameters[0] === void 0 && parameters.length > 1 ? 1 : 0;
-	const options = parameters[optionsIndex];
-	if (typeof options === "object" && options !== null) return parameters.toSpliced(optionsIndex, 1, {
-		...options,
-		windowsHide: true
-	});
-	const isPlaceholder = options === void 0 && optionsIndex < parameters.length;
-	return parameters.toSpliced(optionsIndex, Number(isPlaceholder), { windowsHide: true });
-};
-//#endregion
-//#region src/services/childProcess/execSync.ts
-const execSync$1 = ((command, ...parameters) => execSync(command, ...withHiddenWindow(parameters)));
-//#endregion
-export { withHiddenWindow as n, execSync$1 as t };

package/dist/reporter.d.ts

@@ -1,6 +0,0 @@
-import { Reporter, TestModule } from "vitest/node";
-//#region src/services/BenchmarkMarkdownReporter.d.ts
-export default class BenchmarkMarkdownReporter implements Reporter {
-  onTestRunEnd(testModules: readonly TestModule[]): Promise<void>;
-}
-//#endregion

package/dist/reporter.js

@@ -1,133 +0,0 @@
-import "./bench.js";
-import { t as execSync } from "./execSync-CtM99iYq.js";
-import { GIBIBYTE, InvalidOperationError, Operation, getResult, getResultAsync, noop, normalizeString, takeOne } from "@esposter/shared";
-import { arch, cpus, platform, release, totalmem } from "node:os";
-import { writeFile } from "node:fs/promises";
-//#region src/services/readBenchmarkEnvironment.ts
-const readCommit = () => getResult(() => execSync("git rev-parse --short HEAD", {
-	encoding: "utf8",
-	stdio: "pipe"
-})).match((stdout) => normalizeString(stdout), () => "unknown");
-const readBenchmarkEnvironment = () => {
-	const cpu = cpus();
-	return [
-		`- Date: ${(/* @__PURE__ */ new Date()).toISOString()}`,
-		`- Commit: ${readCommit()}`,
-		`- Node: ${process.version}`,
-		`- OS: ${platform()} ${release()} (${arch()})`,
-		`- CPU: ${normalizeString(cpu[0]?.model) || "unknown"} × ${cpu.length}`,
-		`- RAM: ${(totalmem() / GIBIBYTE).toFixed(1)} GiB`
-	].join("\n");
-};
-//#endregion
-//#region src/services/buildBenchmarkFileReport.ts
-const getGroupName = (testCase, benchmarkName, benchmarkCount) => benchmarkCount > 1 ? `${testCase.fullName} > ${benchmarkName}` : testCase.fullName;
-const buildBenchmarkFileReport = (filepath, testCases) => {
-	const groups = [];
-	for (const testCase of testCases) {
-		const testCaseBenchmarks = testCase.benchmarks();
-		for (const { name, tasks } of testCaseBenchmarks) {
-			const benchmarks = [];
-			for (const task of tasks.toSorted((firstTask, secondTask) => firstTask.rank - secondTask.rank)) {
-				if (!Number.isFinite(task.latency.mean)) throw new InvalidOperationError(Operation.Read, testCase.fullName, `benchmark "${task.name}" produced no samples — it likely threw on every iteration`);
-				benchmarks.push({
-					mean: task.latency.mean,
-					name: task.name,
-					p99: task.latency.p99,
-					rme: task.latency.rme,
-					sampleCount: task.latency.samplesCount
-				});
-			}
-			if (benchmarks.length > 0) groups.push({
-				benchmarks,
-				fullName: getGroupName(testCase, name, testCaseBenchmarks.length)
-			});
-		}
-	}
-	return { files: [{
-		filepath,
-		groups
-	}] };
-};
-//#endregion
-//#region src/services/formatBenchmarkMarkdown.ts
-const getBaseline = (benchmarks) => benchmarks.find(({ name }) => name === "native") ?? benchmarks[0];
-const formatRelative = (baselineMean, mean) => {
-	const ratio = baselineMean / mean;
-	return `${ratio >= 1 ? ratio.toFixed(2) : Number(ratio.toPrecision(2))}×`;
-};
-const HEADER = [
-	"task",
-	"vs base",
-	"mean (ms)",
-	"±rme",
-	"p99 (ms)",
-	"samples"
-];
-const formatTable = (rows) => {
-	const widths = rows.reduce((accumulator, row) => accumulator.map((width, index) => Math.max(width, takeOne(row, index).length)), HEADER.map((header) => header.length));
-	const formatRow = (cells) => `| ${cells.map((cell, index) => cell.padEnd(takeOne(widths, index))).join(" | ")} |`;
-	return [
-		formatRow(HEADER),
-		`| ${widths.map((width) => "-".repeat(width)).join(" | ")} |`,
-		...rows.map((row) => formatRow(row))
-	];
-};
-const formatBenchmarkMarkdown = (report, environment) => {
-	return [
-		"# Benchmark results",
-		"",
-		"Auto-generated by the BenchmarkMarkdownReporter on `pnpm bench`, colocated beside the bench file (a",
-		"`.bench.json` sits next to it). Diff over time to catch regressions. Tasks are listed fastest first.",
-		"`vs base` is a throughput multiplier against each group's baseline (the `native` task, else the",
-		"fastest): `1.00×` is the baseline, higher is faster, lower is slower — a fast task drifting back",
-		"toward `1.00×` is a regression. `±rme` is the relative margin of error.",
-		"Numbers are machine- and commit-dependent (see Environment); only compare runs from the same host.",
-		"",
-		"## Environment",
-		"",
-		environment,
-		"",
-		...report.files.flatMap((file) => file.groups.map((group) => {
-			const baselineMean = getBaseline(group.benchmarks)?.mean ?? NaN;
-			const rows = group.benchmarks.map(({ mean, name, p99, rme, sampleCount }) => [
-				name.replaceAll("|", String.raw`\|`),
-				formatRelative(baselineMean, mean),
-				mean.toFixed(4),
-				`±${rme.toFixed(2)}%`,
-				p99.toFixed(4),
-				`${sampleCount}`
-			]);
-			return [
-				`## ${group.fullName}`,
-				"",
-				...formatTable(rows),
-				""
-			].join("\n");
-		}))
-	].join("\n");
-};
-//#endregion
-//#region src/services/writeBenchmarkReport.ts
-const TS_EXTENSION_REGEX = /\.ts$/u;
-const writeFileOrThrow = (path, contents) => getResultAsync(() => writeFile(path, contents)).match(noop, (error) => {
-	throw new InvalidOperationError(Operation.Create, path, error.message);
-});
-const writeBenchmarkReport = async (moduleId, relativeModuleId, testCases, environment) => {
-	const report = buildBenchmarkFileReport(relativeModuleId, testCases);
-	const [benchmarkFile] = report.files;
-	if (benchmarkFile === void 0 || benchmarkFile.groups.length === 0) return;
-	const basePath = moduleId.replace(TS_EXTENSION_REGEX, "");
-	const reportPath = basePath.endsWith(".platform.bench") ? `${basePath}.${process.platform}` : basePath;
-	await Promise.all([writeFileOrThrow(`${reportPath}.json`, `${JSON.stringify(report, null, 2)}\n`), writeFileOrThrow(`${reportPath}.md`, formatBenchmarkMarkdown(report, environment))]);
-};
-//#endregion
-//#region src/services/BenchmarkMarkdownReporter.ts
-var BenchmarkMarkdownReporter = class {
-	async onTestRunEnd(testModules) {
-		const environment = readBenchmarkEnvironment();
-		await Promise.all(testModules.map((testModule) => writeBenchmarkReport(testModule.moduleId, testModule.relativeModuleId, testModule.children.allTests(), environment)));
-	}
-};
-//#endregion
-export { BenchmarkMarkdownReporter as default };