bench: adding dummy benchmark

Author: tegefaulkes

benches/exec.ts

@@ -0,0 +1,26 @@
+import path from 'node:path';
+import url from 'node:url';
+import b from 'benny';
+import { suiteCommon } from './utils/index.js';
+
+const filePath = url.fileURLToPath(import.meta.url);
+
+async function main() {
+  const summary = await b.suite(
+    path.basename(filePath, path.extname(filePath)),
+    b.add('stub', () => {
+      1 + 1;
+    }),
+    ...suiteCommon,
+  );
+  return summary;
+}
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
+}
+
+export default main;

benches/index.ts

@@ -0,0 +1,54 @@
+#!/usr/bin/env tsx
+
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
+import si from 'systeminformation';
+import { benchesPath } from './utils/utils.js';
+import exec from './exec.js';
+
+async function main(): Promise<void> {
+  await fs.promises.mkdir(path.join(benchesPath, 'results'), {
+    recursive: true,
+  });
+  await exec();
+  const resultFilenames = await fs.promises.readdir(
+    path.join(benchesPath, 'results'),
+  );
+  const metricsFile = await fs.promises.open(
+    path.join(benchesPath, 'results', 'metrics.txt'),
+    'w',
+  );
+  let concatenating = false;
+  for (const resultFilename of resultFilenames) {
+    if (/.+_metrics\.txt$/.test(resultFilename)) {
+      const metricsData = await fs.promises.readFile(
+        path.join(benchesPath, 'results', resultFilename),
+      );
+      if (concatenating) {
+        await metricsFile.write('\n');
+      }
+      await metricsFile.write(metricsData);
+      concatenating = true;
+    }
+  }
+  await metricsFile.close();
+  const systemData = await si.get({
+    cpu: '*',
+    osInfo: 'platform, distro, release, kernel, arch',
+    system: 'model, manufacturer',
+  });
+  await fs.promises.writeFile(
+    path.join(benchesPath, 'results', 'system.json'),
+    JSON.stringify(systemData, null, 2),
+  );
+}
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
+}
+
+export default main;

benches/utils/index.ts

@@ -0,0 +1 @@
+export * from './utils.js';

benches/utils/utils.ts

@@ -0,0 +1,66 @@
+import fs from 'fs';
+import path from 'path';
+import url from 'node:url';
+import b from 'benny';
+import { codeBlock } from 'common-tags';
+import packageJson from '../../package.json';
+
+const benchesPath = path.dirname(
+  path.dirname(url.fileURLToPath(import.meta.url)),
+);
+
+const suiteCommon = [
+  b.cycle(),
+  b.complete(),
+  b.save({
+    file: (summary) => summary.name,
+    folder: path.join(benchesPath, 'results'),
+    version: packageJson.version,
+    details: true,
+  }),
+  b.save({
+    file: (summary) => summary.name,
+    folder: path.join(benchesPath, 'results'),
+    version: packageJson.version,
+    format: 'chart.html',
+  }),
+  b.complete((summary) => {
+    const filePath = path.join(
+      benchesPath,
+      'results',
+      summary.name + '_metrics.txt',
+    );
+    fs.writeFileSync(
+      filePath,
+      codeBlock`
+      # TYPE ${summary.name}_ops gauge
+      ${summary.results
+        .map(
+          (result) =>
+            `${summary.name}_ops{name="${result.name}"} ${result.ops}`,
+        )
+        .join('\n')}
+
+      # TYPE ${summary.name}_margin gauge
+      ${summary.results
+        .map(
+          (result) =>
+            `${summary.name}_margin{name="${result.name}"} ${result.margin}`,
+        )
+        .join('\n')}
+
+      # TYPE ${summary.name}_samples counter
+      ${summary.results
+        .map(
+          (result) =>
+            `${summary.name}_samples{name="${result.name}"} ${result.samples}`,
+        )
+        .join('\n')}
+      ` + '\n',
+    );
+    // eslint-disable-next-line no-console
+    console.log('\nSaved to:', path.resolve(filePath));
+  }),
+];
+
+export { benchesPath, suiteCommon };