feat: add testing coverage and corner case tests

Author: gagik

packages/machine-id/README.md

@@ -28,7 +28,6 @@ const id = getMachineID({ raw: true });
 console.log('Original Machine ID:', id);
 ```
 
-
 ## Supported Platforms
 
 - **macOS**: Uses the `IOPlatformUUID` from the `IOKit` framework (Supported on macOS 12.0 and later).
@@ -44,19 +43,19 @@ Here's a table of performance comparisons between the two libraries, based on th
 | Test        | node-machine-id | @mongodb-js/machine-id | Improvement |
 | ----------- | --------------- | ---------------------- | ----------- |
 | **Mac**     |
-| Raw      | 10.71ms          | 0.0072ms              | 1494x        |
-| Hashed   | 12.42ms          | 0.0176ms                 | 707x        |
+| 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        |
+| 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        |
-
-\* - Windows tests may be inaccurate due to potential caching. 
+| Raw         | 45.36ms\*       | 0.0122ms               | 3704x       |
+| Hashed      | 28.66ms\*       | 0.0272ms               | 1053x       |
 
+\* - 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
@@ -66,11 +65,14 @@ import { getMachineId } from '@mongodb-js/machine-id';
 function machineIdSync(original: boolean): string | undefined {
   const rawMachineId = getMachineId({ raw: true }).toLowerCase();
 
-  return original ? rawMachineId : createHash('sha256').update(rawMachineId).digest('hex');
+  return original
+    ? rawMachineId
+    : createHash('sha256').update(rawMachineId).digest('hex');
 }
 ```
 
 ## Credits
+
 Influenced by the work from [denisbrodbeck/machineid](https://github.com/denisbrodbeck/machineid) and [automation-stack/node-machine-id](https://github.com/automation-stack/node-machine-id).
 
 ## License

packages/machine-id/package.json

@@ -9,7 +9,8 @@
     "bootstrap": "npm run compile",
     "pretest": "npm run compile",
     "test": "mocha",
-    "test-ci": "npm run test",
+    "test-cov": "nyc -x \"**/*.spec.*\" --reporter=lcov --reporter=text --reporter=html npm run test",
+    "test-ci": "npm run test-cov",
     "lint": "eslint . && prettier --check .",
     "check": "npm run lint && npm run test",
     "prepublishOnly": "npm run compile",

packages/machine-id/src/bin/machine-id.ts

@@ -1,12 +1,7 @@
 #!/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';
+const id = getMachineId({ raw: process.argv.includes('--raw') }) || '';
 
 // eslint-disable-next-line no-console
 console.log(id);

packages/machine-id/src/index.spec.ts

@@ -1,8 +1,13 @@
 /* eslint-disable no-console */
 import { getMachineId } from '.';
 import { machineIdSync as otherMachineId } from 'node-machine-id';
-import { expect } from 'chai';
+import chai, { expect } from 'chai';
 import { createHash } from 'crypto';
+import sinonChai from 'sinon-chai';
+import sinon from 'sinon';
+import bindings from 'bindings';
+
+chai.use(sinonChai);
 
 describe('machine-id', function () {
   this.timeout(5_000);
@@ -53,6 +58,43 @@ describe('machine-id', function () {
       const hashRegex = /^[0-9a-f]{64}$/i;
 
       expect(hashRegex.test(id));
+
+      expect(id).equals(
+        createHash('sha256')
+          .update(getMachineId({ raw: true }) || '')
+          .digest('hex'),
+      );
+    });
+  });
+
+  describe('edge cases', function () {
+    afterEach(function () {
+      sinon.restore();
+    });
+
+    describe('returns undefined', function () {
+      it('if something goes wrong with the binding function', function () {
+        sinon
+          .stub(bindings('machine_id'), 'getMachineId')
+          .throws(new Error('Binding error'));
+
+        expect(getMachineId({ raw: true })).to.be.undefined;
+        expect(getMachineId()).to.be.undefined;
+      });
+
+      it('if the binding function returns an empty string', function () {
+        sinon.stub(bindings('machine_id'), 'getMachineId').returns('');
+
+        expect(getMachineId({ raw: true })).to.be.undefined;
+        expect(getMachineId()).to.be.undefined;
+      });
+
+      it('if the binding function returns undefined', function () {
+        sinon.stub(bindings('machine_id'), 'getMachineId').returns(undefined);
+
+        expect(getMachineId({ raw: true })).to.be.undefined;
+        expect(getMachineId()).to.be.undefined;
+      });
     });
   });
 });

packages/machine-id/src/index.ts

@@ -15,7 +15,14 @@ export type GetMachineIdOptions = {
 export function getMachineId({ raw = false }: GetMachineIdOptions = {}):
   | string
   | undefined {
-  const machineId: string | undefined = binding.getMachineId();
+  let machineId: string | undefined;
+
+  try {
+    machineId = binding.getMachineId();
+  } catch {
+    // If the binding fails, we can assume the machine ID is not available.
+    return undefined;
+  }
 
   if (!machineId) {
     return undefined;