refactor: move performance tests to a script

Author: gagik

package-lock.json

@@ -1,6 +1,6 @@
 # @mongodb-js/machine-id
 
-> Cross-platform module to retrieve unique machine IDs across desktop operating systems without admin privileges or child processes.
+> Native implementation for retrieving unique machine ID without admin privileges or child processes for desktop platforms. Faster and more reliable alternative to node-machine-id.
 
 ## Installation
 
@@ -28,21 +28,36 @@ const id = getMachineID({ raw: true });
 console.log('Original Machine ID:', id);
 ```
 
-### As a CLI
 
-After installing globally, run:
-
-```
-machine-id
-```
+## Supported Platforms
 
-This will print the machine ID to the console.
+- **macOS**: Uses the `IOPlatformUUID` from the `IOKit` framework (Supported on macOS 12.0 and later).
+- **Linux**: Uses the `/var/lib/dbus/machine-id` file to retrieve the machine ID. If this file does not exist, it falls back to `/etc/machine-id`.
+- **Windows**: Uses the `MachineGuid` from the `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography` registry.
 
 ## Comparison with `node-machine-id`
 
-This module provides similar functionality to [node-machine-id](https://www.npmjs.com/package/node-machine-id), but **using native access to system APIs without the need for child processes**.
+This module provides similar functionality to [node-machine-id](https://www.npmjs.com/package/node-machine-id), but **using native access to system APIs without the need for child processes**, making it much faster and reliable.
+
+Here's a table of performance comparisons between the two libraries, based on the average runtime from 1000 iterations of the `getMachineId` and `machineIdSync` functions, from `scripts/benchmark.ts`:
+
+| Test        | node-machine-id | @mongodb-js/machine-id | Improvement |
+| ----------- | --------------- | ---------------------- | ----------- |
+| **Mac**     |
+| Raw      | 10.71ms          | 0.0072ms              | 1494x        |
+| Hashed   | 12.42ms          | 0.0176ms                 | 707x        |
+| **Linux**   |
+| Raw         | 3.26ms      | 0.0059ms               | 557x        |
+| Hashed      | 3.25ms        | 0.0088ms                 | 368x        |
+| **Windows** |
+| Raw         | 45.36ms*          | 0.0122ms               | 3704x        |
+| Hashed      | 28.66ms*          | 0.0272ms                 | 1053x        |
 
-If you were previously using `node-machine-id`, you can use the following mapping to get a result that uses the same hashing transformation. This helps create more consistent results as before but it is not guaranteed to be the same for all cases.
+\* - Windows tests may be inaccurate due to potential caching. 
+
+
+### Migrating from `node-machine-id`
+If you were previously using `node-machine-id`, you can use the following mapping to get a result with the following hashing transformation. This is not guaranteed always to 1:1 match the output of `node-machine-id` for all cases. For example on Linux, it falls back to `/etc/machine-id` if `/var/lib/dbus/machine-id` is not available.
 
 ```ts
 import { createHash } from 'crypto';
@@ -51,20 +66,10 @@ import { getMachineId } from '@mongodb-js/machine-id';
 function machineIdSync(original: boolean): string | undefined {
   const rawMachineId = getMachineId({ raw: true }).toLowerCase();
 
-  if (original) {
-    return rawMachineId;
-  }
-
-  return createHash('sha256').update(rawMachineId).digest('hex');
+  return original ? rawMachineId : createHash('sha256').update(rawMachineId).digest('hex');
 }
 ```
 
-## Supported Platforms
-
-- **macOS**: Uses the `IOPlatformUUID` from the `IOKit` framework (Supported on macOS 12.0 and later).
-- **Linux**: Uses the `/etc/machine-id` file to retrieve the machine ID. If this file does not exist, it falls back to `/var/lib/dbus/machine-id`.
-- **Windows**: Uses the `MachineGuid` from the `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography` registry.
-
 ## License
 
 Apache-2.0

packages/machine-id/README.md

@@ -1,7 +1,7 @@
 {
   "name": "@mongodb-js/machine-id",
   "version": "1.0.0",
-  "description": "Cross-platform native module to retrieve machine/device identifiers",
+  "description": "Native implementation for retrieving unique machine ID without admin privileges or child processes for desktop platforms. Faster and more reliable alternative to node-machine-id.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -33,12 +33,12 @@
   },
   "bugs": "https://jira.mongodb.org/projects/COMPASS/issues",
   "bin": {
-    "machine-id": "lib/bin/machine-id.js"
+    "machine-id": "dist/bin/machine-id.js"
   },
   "files": [
     "binding.cc",
     "binding.gyp",
-    "lib",
+    "dist",
     "LICENSE"
   ],
   "devDependencies": {
@@ -55,6 +55,7 @@
     "mocha": "^8.4.0",
     "chai": "^4.5.0",
     "node-machine-id": "^1.1.12",
-    "typescript": "^5.0.4"
+    "typescript": "^5.0.4",
+    "ts-node": "^10.9.2"
   }
 }

packages/machine-id/bin/machine-id.js

@@ -12,7 +12,6 @@ import { machineIdSync } from 'node-machine-id';
 
 // Configuration
 const ITERATIONS = 100;
-const WARMUP_ITERATIONS = 10;
 
 // Utility to format time
 function formatTime(ms: number): string {
@@ -40,15 +39,8 @@ function runBenchmark() {
   console.log(`Test iterations: ${ITERATIONS}`);
   console.log('----------------------------------------');
 
-  // Warm-up
-  console.log('Warming up...');
-  for (let i = 0; i < WARMUP_ITERATIONS; i++) {
-    getMachineId({ raw: true });
-    machineIdSync(true);
-  }
-
   // Test raw mode (no hashing)
-  console.log('\nRaw machine ID retrieval:');
+  console.log('Raw:');
 
   const startOursRaw = process.hrtime.bigint();
   for (let i = 0; i < ITERATIONS; i++) {
@@ -75,8 +67,10 @@ function runBenchmark() {
     `Comparison: @mongodb-js/machine-id is ${formatComparison(ourTimeRaw, otherTimeRaw)}`,
   );
 
+  console.log('----------------------------------------');
+
   // Test hashed mode
-  console.log('\nHashed machine ID:');
+  console.log('Hashed:');
 
   // @mongodb-js/machine-id
   const startOursHashed = process.hrtime.bigint();
@@ -103,8 +97,6 @@ function runBenchmark() {
   console.log(
     `Comparison: @mongodb-js/machine-id is ${formatComparison(ourTimeHashed, otherTimeHashed)}`,
   );
-
-  console.log('\n========================================');
 }
 
 // Run the benchmark

packages/machine-id/package.json

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import { getMachineId } from '..';
+
+// Check if --raw flag is provided
+const rawFlag = process.argv.includes('--raw');
+
+// Get the machine ID, passing the raw option if requested
+const id =
+  getMachineId({ raw: rawFlag }) || 'Machine ID not available on this platform';
+
+// eslint-disable-next-line no-console
+console.log(id);

packages/machine-id/scripts/benchmark.ts

@@ -55,89 +55,4 @@ describe('machine-id', function () {
       expect(hashRegex.test(id));
     });
   });
-
-  describe('performance comparison', function () {
-    // Increase timeout for performance tests
-    this.timeout(100_000);
-
-    it('performs faster than node-machine-id (raw)', function () {
-      const iterations = 1000;
-
-      // Warm-up run to account for initial load time
-      getMachineId({ raw: true });
-      otherMachineId(true);
-
-      // Test  implementation
-      const startOurs = process.hrtime.bigint();
-      for (let i = 0; i < iterations; i++) {
-        getMachineId({ raw: true });
-      }
-      const endOurs = process.hrtime.bigint();
-      const ourTime = Number(endOurs - startOurs) / 1_000_000; // Convert to ms
-
-      // Test node-machine-id
-      const startOther = process.hrtime.bigint();
-      for (let i = 0; i < iterations; i++) {
-        otherMachineId(true);
-      }
-      const endOther = process.hrtime.bigint();
-      const otherTime = Number(endOther - startOther) / 1_000_000; // Convert to ms
-
-      console.log(
-        `Performance comparison (raw mode, ${iterations} iterations):`,
-      );
-      console.log(
-        `- Our implementation: ${ourTime.toFixed(4)}ms (${(ourTime / iterations).toFixed(4)}ms per call)`,
-      );
-      console.log(
-        `- node-machine-id: ${otherTime.toFixed(4)}ms (${(otherTime / iterations).toFixed(4)}ms per call)`,
-      );
-      console.log(
-        `- Difference: ${ourTime < otherTime ? 'Ours is ' + (otherTime / ourTime).toFixed(2) + 'x faster' : 'node-machine-id is ' + (ourTime / otherTime).toFixed(2) + 'x faster'}`,
-      );
-
-      // We expect our native implementation to be faster
-      // but don't fail the test if it's not, just report the measurements
-    });
-
-    it('performs faster than node-machine-id (hashed)', function () {
-      const iterations = 1000;
-
-      // Warm-up run
-      getMachineId();
-      otherMachineId();
-
-      // Test our implementation
-      const startOurs = process.hrtime.bigint();
-      for (let i = 0; i < iterations; i++) {
-        getMachineId();
-      }
-      const endOurs = process.hrtime.bigint();
-      const ourTime = Number(endOurs - startOurs) / 1_000_000; // Convert to ms
-
-      // Test node-machine-id
-      const startOther = process.hrtime.bigint();
-      for (let i = 0; i < iterations; i++) {
-        otherMachineId();
-      }
-      const endOther = process.hrtime.bigint();
-      const otherTime = Number(endOther - startOther) / 1_000_000; // Convert to ms
-
-      console.log(
-        `Performance comparison (hashed mode, ${iterations} iterations):`,
-      );
-      console.log(
-        `- Our implementation: ${ourTime.toFixed(4)}ms (${(ourTime / iterations).toFixed(4)}ms per call)`,
-      );
-      console.log(
-        `- node-machine-id: ${otherTime.toFixed(4)}ms (${(otherTime / iterations).toFixed(4)}ms per call)`,
-      );
-      console.log(
-        `- Difference: ${ourTime < otherTime ? 'Ours is ' + (otherTime / ourTime).toFixed(2) + 'x faster' : 'node-machine-id is ' + (ourTime / otherTime).toFixed(2) + 'x faster'}`,
-      );
-
-      // We expect our native implementation to be faster
-      // but don't fail the test if it's not, just report the measurements
-    });
-  });
 });