feat: ESM migration

Author: tegefaulkes

.eslintignore

@@ -7,18 +7,18 @@
     "jest": true
   },
   "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "tsconfig.json",
+    "sourceType": "module"
+  },
+  "plugins": [
+    "import"
+  ],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended"
   ],
-  "plugins": [
-    "import"
-  ],
-  "parserOptions": {
-    "project": "tsconfig.json",
-    "sourceType": "module"
-  },
   "rules": {
     "linebreak-style": ["error", "unix"],
     "no-empty": 1,

.eslintrc

@@ -58,7 +58,7 @@ npm install
 # build the dist
 npm run build
 # run the repl (this allows you to import from ./src)
-npm run ts-node
+npm run tsx
 # run the tests
 npm run test
 # lint the source code

README.md

@@ -1,10 +1,14 @@
+import url from 'node:url';
+import path from 'node:path';
 import b from 'benny';
-import { summaryName, suiteCommon } from '../../utils';
+import { suiteCommon } from './utils/utils.js';
+
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   const buf = Buffer.allocUnsafe(64);
   const summary = await b.suite(
-    summaryName(__filename),
+    path.basename(filename, path.extname(filename)),
     b.add('JSON stringify and parse buffer', () => {
       const bufJSON = JSON.stringify(buf);
       Buffer.from(JSON.parse(bufJSON));
@@ -22,8 +26,11 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
-  void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
 }
 
 export default main;

…suites/basic/buffer_encoding_decoding.ts benches/basic_buffer_encoding_decoding.tsbenches/suites/basic/buffer_encoding_decoding.ts renamed to benches/basic_buffer_encoding_decoding.ts benches/suites/basic/buffer_encoding_decoding.ts renamed to benches/basic_buffer_encoding_decoding.ts

@@ -1,13 +1,17 @@
+import url from 'node:url';
+import path from 'node:path';
 import b from 'benny';
-import { summaryName, suiteCommon } from '../../utils';
+import { suiteCommon } from './utils/utils.js';
+
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   let map = new Map();
   let obj = {};
   let arr: any = [];
   let set = new Set();
   const summary = await b.suite(
-    summaryName(__filename),
+    path.basename(filename, path.extname(filename)),
     b.add('map', async () => {
       map = new Map();
       return async () => {
@@ -83,8 +87,11 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
-  void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
 }
 
 export default main;

benches/suites/git/gitgc.ts benches/git_garbage_collection.tsbenches/suites/git/gitgc.ts renamed to benches/git_garbage_collection.ts

@@ -1,56 +1,76 @@
 #!/usr/bin/env ts-node
 
-import type { Summary } from 'benny/lib/internal/common-types';
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
 import si from 'systeminformation';
-import { fsWalk, resultsPath, suitesPath } from './utils';
+import { benchesPath } from './utils/utils.js';
+import basicBufferEncodingDecoding from './basic_buffer_encoding_decoding.js';
+import gitGarbageCollection from './git_garbage_collection.js';
+import keysAsymmetricCrypto from './keys_asymmetric_crypto.js';
+import keysKeyGeneration from './keys_key_generation.js';
+import keysKeyringLifecycle from './keys_keyring_lifecycle.js';
+import keysPasswordHashing from './keys_password_hashing.js';
+import keysRandomBytes from './keys_random_bytes.js';
+import keysRecoveryCode from './keys_recovery_code.js';
+import keysSymmetricCrypto from './keys_symmetric_crypto.js';
+import keysX509 from './keys_x509.js';
+import workersKeys from './workers_keys.js';
+import workersOverhead from './workers_overhead.js';
 
 async function main(): Promise<void> {
-  await fs.promises.mkdir(path.join(__dirname, 'results'), { recursive: true });
-  // Running all suites
-  for await (const suitePath of fsWalk(suitesPath)) {
-    // Skip over non-ts and non-js files
-    const ext = path.extname(suitePath);
-    if (ext !== '.ts' && ext !== '.js') {
-      continue;
-    }
-    const suite: () => Promise<Summary> = (await import(suitePath)).default;
-    // Skip default exports that are not functions and are not called "main"
-    // They might be utility files
-    if (typeof suite === 'function' && suite.name === 'main') {
-      await suite();
-    }
-  }
-  // Concatenating metrics
-  const metricsPath = path.join(resultsPath, 'metrics.txt');
-  await fs.promises.rm(metricsPath, { force: true });
+  await fs.promises.mkdir(path.join(benchesPath, 'results'), {
+    recursive: true,
+  });
+  await basicBufferEncodingDecoding();
+  await gitGarbageCollection();
+  await keysAsymmetricCrypto();
+  await keysKeyGeneration();
+  await keysKeyringLifecycle();
+  await keysPasswordHashing();
+  await keysRandomBytes();
+  await keysRecoveryCode();
+  await keysSymmetricCrypto();
+  await keysX509();
+  await workersKeys();
+  await workersOverhead();
+  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 await (const metricPath of fsWalk(resultsPath)) {
-    // Skip over non-metrics files
-    if (!metricPath.endsWith('_metrics.txt')) {
-      continue;
+  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;
     }
-    const metricData = await fs.promises.readFile(metricPath);
-    if (concatenating) {
-      await fs.promises.appendFile(metricsPath, '\n');
-    }
-    await fs.promises.appendFile(metricsPath, metricData);
-    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(__dirname, 'results', 'system.json'),
+    path.join(benchesPath, 'results', 'system.json'),
     JSON.stringify(systemData, null, 2),
   );
 }
 
-if (require.main === module) {
-  void main();
+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

@@ -1,8 +1,12 @@
+import url from 'node:url';
+import path from 'node:path';
 import b from 'benny';
-import * as random from '@/keys/utils/random';
-import * as generate from '@/keys/utils/generate';
-import * as asymmetric from '@/keys/utils/asymmetric';
-import { summaryName, suiteCommon } from '../../utils';
+import { suiteCommon } from './utils/utils.js';
+import * as random from '#keys/utils/random.js';
+import * as generate from '#keys/utils/generate.js';
+import * as asymmetric from '#keys/utils/asymmetric.js';
+
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   const keyPair = generate.generateKeyPair();
@@ -34,7 +38,7 @@ async function main() {
     plain10KiB,
   );
   const summary = await b.suite(
-    summaryName(__filename),
+    path.basename(filename, path.extname(filename)),
     b.add('encrypt 512 B of data', () => {
       asymmetric.encryptWithPublicKey(keyPair.publicKey, plain512B);
     }),
@@ -88,8 +92,11 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
-  void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
 }
 
 export default main;

benches/suites/keys/asymmetric_crypto.ts benches/keys_asymmetric_crypto.tsbenches/suites/keys/asymmetric_crypto.ts renamed to benches/keys_asymmetric_crypto.ts

@@ -1,12 +1,16 @@
+import url from 'node:url';
+import path from 'node:path';
 import b from 'benny';
-import * as generate from '@/keys/utils/generate';
-import * as recoveryCode from '@/keys/utils/recoveryCode';
-import { summaryName, suiteCommon } from '../../utils';
+import { suiteCommon } from './utils/utils.js';
+import * as generate from '#keys/utils/generate.js';
+import * as recoveryCode from '#keys/utils/recoveryCode.js';
+
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   const code = recoveryCode.generateRecoveryCode(24);
   const summary = await b.suite(
-    summaryName(__filename),
+    path.basename(filename, path.extname(filename)),
     b.add('generate root asymmetric keypair', () => {
       generate.generateKeyPair();
     }),
@@ -21,8 +25,11 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
-  void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
 }
 
 export default main;

benches/suites/keys/key_generation.ts benches/keys_key_generation.tsbenches/suites/keys/key_generation.ts renamed to benches/keys_key_generation.ts

@@ -1,14 +1,17 @@
-import fs from 'fs';
-import os from 'os';
-import path from 'path';
+import fs from 'node:fs';
+import os from 'node:os';
+import url from 'node:url';
+import path from 'node:path';
 import b from 'benny';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
-import KeyRing from '@/keys/KeyRing';
-import { summaryName, suiteCommon } from '../../utils';
+import { suiteCommon } from './utils/utils.js';
+import KeyRing from '#keys/KeyRing.js';
+
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   const summary = await b.suite(
-    summaryName(__filename),
+    path.basename(filename, path.extname(filename)),
     b.add('KeyRing fresh creation', async () => {
       const dataDir = await fs.promises.mkdtemp(
         path.join(os.tmpdir(), 'polykey-bench-'),
@@ -52,8 +55,11 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
-  void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
 }
 
 export default main;

benches/suites/keys/keyring_lifecycle.ts benches/keys_keyring_lifecycle.tsbenches/suites/keys/keyring_lifecycle.ts renamed to benches/keys_keyring_lifecycle.ts

@@ -1,10 +1,14 @@
+import url from 'node:url';
+import path from 'node:path';
 import b from 'benny';
-import * as password from '@/keys/utils/password';
-import { summaryName, suiteCommon } from '../../utils';
+import { suiteCommon } from './utils/utils.js';
+import * as password from '#keys/utils/password.js';
+
+const filename = url.fileURLToPath(new URL(import.meta.url));
 
 async function main() {
   const summary = await b.suite(
-    summaryName(__filename),
+    path.basename(filename, path.extname(filename)),
     b.add('password hashing - min', () => {
       password.hashPassword(
         'password',
@@ -42,8 +46,11 @@ async function main() {
   return summary;
 }
 
-if (require.main === module) {
-  void main();
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    void main();
+  }
 }
 
 export default main;