From d30cbf4d4df526beec697da1a836594ac344ff46 Mon Sep 17 00:00:00 2001
From: gagik <me@gagik.co>
Date: Fri, 2 May 2025 15:50:24 +0200
Subject: [PATCH 1/6] feat: add device ID hashing package
---
packages/device-id/.depcheckrc | 8 +
packages/device-id/.eslintignore | 2 +
packages/device-id/.eslintrc.js | 8 +
packages/device-id/.gitignore | 30 +++
packages/device-id/.mocharc.js | 1 +
packages/device-id/.prettierignore | 3 +
packages/device-id/.prettierrc.json | 1 +
packages/device-id/LICENSE | 201 +++++++++++++++++++
packages/device-id/README.md | 3 +
packages/device-id/package.json | 67 +++++++
packages/device-id/src/get-device-id.spec.ts | 85 ++++++++
packages/device-id/src/get-device-id.ts | 95 +++++++++
packages/device-id/src/index.ts | 1 +
packages/device-id/tsconfig-lint.json | 5 +
packages/device-id/tsconfig.json | 8 +
15 files changed, 518 insertions(+)
create mode 100644 packages/device-id/.depcheckrc
create mode 100644 packages/device-id/.eslintignore
create mode 100644 packages/device-id/.eslintrc.js
create mode 100644 packages/device-id/.gitignore
create mode 100644 packages/device-id/.mocharc.js
create mode 100644 packages/device-id/.prettierignore
create mode 100644 packages/device-id/.prettierrc.json
create mode 100644 packages/device-id/LICENSE
create mode 100644 packages/device-id/README.md
create mode 100644 packages/device-id/package.json
create mode 100644 packages/device-id/src/get-device-id.spec.ts
create mode 100644 packages/device-id/src/get-device-id.ts
create mode 100644 packages/device-id/src/index.ts
create mode 100644 packages/device-id/tsconfig-lint.json
create mode 100644 packages/device-id/tsconfig.json
diff --git a/packages/device-id/.depcheckrc b/packages/device-id/.depcheckrc
new file mode 100644
index 00000000..48bf9af6
--- /dev/null
+++ b/packages/device-id/.depcheckrc
@@ -0,0 +1,8 @@
+ignores:
+ - '@mongodb-js/prettier-config-devtools'
+ - '@mongodb-js/tsconfig-devtools'
+ - '@types/chai'
+ - '@types/sinon-chai'
+ - 'sinon'
+ignore-patterns:
+ - 'dist'
diff --git a/packages/device-id/.eslintignore b/packages/device-id/.eslintignore
new file mode 100644
index 00000000..85a8a75e
--- /dev/null
+++ b/packages/device-id/.eslintignore
@@ -0,0 +1,2 @@
+.nyc-output
+dist
diff --git a/packages/device-id/.eslintrc.js b/packages/device-id/.eslintrc.js
new file mode 100644
index 00000000..83296d73
--- /dev/null
+++ b/packages/device-id/.eslintrc.js
@@ -0,0 +1,8 @@
+module.exports = {
+ root: true,
+ extends: ['@mongodb-js/eslint-config-devtools'],
+ parserOptions: {
+ tsconfigRootDir: __dirname,
+ project: ['./tsconfig-lint.json'],
+ },
+};
diff --git a/packages/device-id/.gitignore b/packages/device-id/.gitignore
new file mode 100644
index 00000000..1d336b61
--- /dev/null
+++ b/packages/device-id/.gitignore
@@ -0,0 +1,30 @@
+npm-debug.log
+build
+dist
+node_modules
+.DS_Store
+.idea
+*.swp
+*.iml
+.cache*
+report.json
+.user-data
+.compiled-sources
+expansions.yml
+.nvmrc
+.vscode
+!.vscode/extentions.json
+.migration-cache
+lerna-debug.log
+packages/**/*.tgz
+packages/**/package-lock.json
+scripts/package-lock.json
+configs/**/package-lock.json
+tmp
+storage
+.nyc_output
+coverage
+.ackrc
+env-vars.sh
+mongocryptd.pid
+mongodb-csfle
diff --git a/packages/device-id/.mocharc.js b/packages/device-id/.mocharc.js
new file mode 100644
index 00000000..64afeb1f
--- /dev/null
+++ b/packages/device-id/.mocharc.js
@@ -0,0 +1 @@
+module.exports = require('@mongodb-js/mocha-config-devtools');
diff --git a/packages/device-id/.prettierignore b/packages/device-id/.prettierignore
new file mode 100644
index 00000000..4d28df66
--- /dev/null
+++ b/packages/device-id/.prettierignore
@@ -0,0 +1,3 @@
+.nyc_output
+dist
+coverage
diff --git a/packages/device-id/.prettierrc.json b/packages/device-id/.prettierrc.json
new file mode 100644
index 00000000..dfae21d0
--- /dev/null
+++ b/packages/device-id/.prettierrc.json
@@ -0,0 +1 @@
+"@mongodb-js/prettier-config-devtools"
diff --git a/packages/device-id/LICENSE b/packages/device-id/LICENSE
new file mode 100644
index 00000000..5e0fd33c
--- /dev/null
+++ b/packages/device-id/LICENSE
@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!) The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright {yyyy} {name of copyright owner}
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/packages/device-id/README.md b/packages/device-id/README.md
new file mode 100644
index 00000000..f6835c44
--- /dev/null
+++ b/packages/device-id/README.md
@@ -0,0 +1,3 @@
+# @mongodb-js/device-id
+
+Create a consistent, implementation-agnostic hash from a given raw machine ID. The machine ID should originate from `node-machine-id` or `native-machine-id` depending on the platform. The hash is generated using SHA-256 and is designed to be consistent with the Atlas CLI.
diff --git a/packages/device-id/package.json b/packages/device-id/package.json
new file mode 100644
index 00000000..97ba4074
--- /dev/null
+++ b/packages/device-id/package.json
@@ -0,0 +1,67 @@
+{
+ "name": "@mongodb-js/device-id",
+ "description": "Creates a consistent device ID hash across MongoDB tools.",
+ "author": {
+ "name": "MongoDB Inc",
+ "email": "compass@mongodb.com"
+ },
+ "publishConfig": {
+ "access": "public"
+ },
+ "bugs": {
+ "url": "https://jira.mongodb.org/projects/COMPASS/issues",
+ "email": "compass@mongodb.com"
+ },
+ "homepage": "https://github.com/mongodb-js/devtools-shared",
+ "version": "0.1.0",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/mongodb-js/devtools-shared.git"
+ },
+ "files": [
+ "dist"
+ ],
+ "license": "Apache-2.0",
+ "main": "dist/index.js",
+ "exports": {
+ "require": "./dist/index.js",
+ "import": "./dist/.esm-wrapper.mjs"
+ },
+ "types": "./dist/index.d.ts",
+ "scripts": {
+ "bootstrap": "npm run compile",
+ "prepublishOnly": "npm run compile",
+ "compile": "tsc -p tsconfig.json && gen-esm-wrapper . ./dist/.esm-wrapper.mjs",
+ "typecheck": "tsc --noEmit",
+ "eslint": "eslint",
+ "prettier": "prettier",
+ "lint": "npm run eslint . && npm run prettier -- --check .",
+ "depcheck": "depcheck",
+ "check": "npm run typecheck && npm run lint && npm run depcheck",
+ "check-ci": "npm run check",
+ "test": "mocha",
+ "test-cov": "nyc -x \"**/*.spec.*\" --reporter=lcov --reporter=text --reporter=html npm run test",
+ "test-watch": "npm run test -- --watch",
+ "test-ci": "npm run test-cov",
+ "reformat": "npm run prettier -- --write ."
+ },
+ "devDependencies": {
+ "@mongodb-js/eslint-config-devtools": "0.9.11",
+ "@mongodb-js/mocha-config-devtools": "^1.0.5",
+ "@mongodb-js/prettier-config-devtools": "^1.0.2",
+ "@mongodb-js/tsconfig-devtools": "^1.0.3",
+ "@types/chai": "^4.2.21",
+ "@types/mocha": "^9.1.1",
+ "@types/node": "^17.0.35",
+ "@types/sinon-chai": "^3.2.5",
+ "chai": "^4.5.0",
+ "depcheck": "^1.4.7",
+ "eslint": "^7.25.0",
+ "gen-esm-wrapper": "^1.1.3",
+ "mocha": "^8.4.0",
+ "nyc": "^15.1.0",
+ "prettier": "^3.5.3",
+ "sinon": "^9.2.3",
+ "typescript": "^5.0.4"
+ }
+}
diff --git a/packages/device-id/src/get-device-id.spec.ts b/packages/device-id/src/get-device-id.spec.ts
new file mode 100644
index 00000000..e487b872
--- /dev/null
+++ b/packages/device-id/src/get-device-id.spec.ts
@@ -0,0 +1,85 @@
+import { expect } from 'chai';
+import { getDeviceId } from './get-device-id';
+
+describe('getDeviceId', function () {
+ it('returns a hashed device id when machine id is available', async function () {
+ const mockMachineId = 'test-machine-id';
+ const getMachineId = () => Promise.resolve(mockMachineId);
+
+ const deviceId = await getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ }).value;
+
+ expect(deviceId).to.be.a('string');
+ expect(deviceId).to.have.lengthOf(64); // SHA-256 hex digest length
+ expect(deviceId).to.not.equal('unknown');
+ });
+
+ it('converts machine id to uppercase when using node-machine-id', async function () {
+ const mockMachineId = 'test-machine-id';
+ const getMachineId = () => Promise.resolve(mockMachineId);
+
+ const resultA = await getDeviceId({
+ getMachineId,
+ isNodeMachineId: true,
+ }).value;
+
+ const resultB = await getDeviceId({
+ getMachineId: () => Promise.resolve(mockMachineId.toUpperCase()),
+ isNodeMachineId: true,
+ }).value;
+
+ expect(resultA).to.equal(resultB);
+ });
+
+ it('returns "unknown" when machine id is not found', async function () {
+ const getMachineId = () => Promise.resolve(undefined);
+ let capturedError: Error | undefined;
+
+ const deviceId = await getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ onError: (error) => {
+ capturedError = error;
+ },
+ }).value;
+
+ expect(deviceId).to.equal('unknown');
+ expect(capturedError?.message).to.equal('Failed to resolve machine ID');
+ });
+
+ it('returns "unknown" and calls onError when getMachineId throws', async function () {
+ const error = new Error('Something went wrong');
+ const getMachineId = () => Promise.reject(error);
+ let capturedError: Error | undefined;
+
+ const result = await getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ onError: (err) => {
+ capturedError = err;
+ },
+ }).value;
+
+ expect(result).to.equal('unknown');
+ expect(capturedError).to.equal(error);
+ });
+
+ it('produces consistent hash for the same machine id', async function () {
+ const mockMachineId = 'test-machine-id';
+ const getMachineId = () => Promise.resolve(mockMachineId);
+
+ const resultA = await getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ }).value;
+
+ const resultB = await getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ }).value;
+
+ expect(resultA).to.equal(resultB);
+ });
+});
diff --git a/packages/device-id/src/get-device-id.ts b/packages/device-id/src/get-device-id.ts
new file mode 100644
index 00000000..6c2ebedc
--- /dev/null
+++ b/packages/device-id/src/get-device-id.ts
@@ -0,0 +1,95 @@
+import { createHmac } from 'crypto';
+
+export function getDeviceId({
+ getMachineId,
+ isNodeMachineId,
+ onError,
+ timeout = 3000,
+ onTimeout,
+}: GetDeviceIdOptions): {
+ /** A promise that resolves to the hashed device ID or `"unknown"` if an error or timeout occurs. */
+ value: Promise<string>;
+ /** A function which resolves the device ID promise. */
+ resolve: (value: string) => void;
+ /** A function which rejects the device ID promise. */
+ reject: (err: Error) => void;
+} {
+ let resolveDeviceId!: (value: string) => void;
+ let rejectDeviceId!: (err: Error) => void;
+ let timeoutId: NodeJS.Timeout | undefined;
+
+ const value = Promise.race([
+ resolveMachineId({
+ getMachineId,
+ isNodeMachineId,
+ onError,
+ }),
+ new Promise<string>((resolve, reject) => {
+ timeoutId = setTimeout(() => {
+ if (onTimeout) {
+ onTimeout(resolve, reject);
+ } else {
+ resolve('unknown');
+ }
+ }, timeout);
+
+ resolveDeviceId = resolve;
+ rejectDeviceId = reject;
+ }),
+ ]).finally(() => clearTimeout(timeoutId));
+
+ return {
+ value,
+ resolve: resolveDeviceId,
+ reject: rejectDeviceId,
+ };
+}
+
+export type GetDeviceIdOptions = {
+ /** A function that returns a raw machine ID. */
+ getMachineId: () => Promise<string | undefined>;
+ /** When using node-machine-id, the ID is made uppercase to be consistent with other libraries. */
+ isNodeMachineId: boolean;
+ /** Runs when an error occurs while getting the machine ID. */
+ onError?: (error: Error) => void;
+ /** Timeout in milliseconds. Defaults to 3000ms. Set to `undefined` to disable. */
+ timeout?: number | undefined;
+ /** Runs when the timeout is reached. By default, resolves to "unknown". */
+ onTimeout?: (
+ resolve: (value: string) => void,
+ reject: (err: Error) => void,
+ ) => void;
+};
+
+async function resolveMachineId({
+ getMachineId,
+ isNodeMachineId,
+ onError,
+}: GetDeviceIdOptions): Promise<string> {
+ try {
+ const originalId = isNodeMachineId
+ ? (await getMachineId())?.toUpperCase()
+ : await getMachineId();
+
+ if (!originalId) {
+ onError?.(new Error('Failed to resolve machine ID'));
+ return 'unknown';
+ }
+
+ // Create a hashed format from the machine ID
+ // to match it exactly with the denisbrodbeck/machineid library that Atlas CLI uses.
+ const hmac = createHmac(
+ 'sha256',
+ isNodeMachineId ? originalId : originalId,
+ );
+
+ /** This matches the message used to create the hashes in Atlas CLI */
+ const DEVICE_ID_HASH_MESSAGE = 'atlascli';
+
+ hmac.update(DEVICE_ID_HASH_MESSAGE);
+ return hmac.digest('hex');
+ } catch (error) {
+ onError?.(error as Error);
+ return 'unknown';
+ }
+}
diff --git a/packages/device-id/src/index.ts b/packages/device-id/src/index.ts
new file mode 100644
index 00000000..74afcada
--- /dev/null
+++ b/packages/device-id/src/index.ts
@@ -0,0 +1 @@
+export { getDeviceId, GetDeviceIdOptions } from './get-device-id';
diff --git a/packages/device-id/tsconfig-lint.json b/packages/device-id/tsconfig-lint.json
new file mode 100644
index 00000000..6bdef84f
--- /dev/null
+++ b/packages/device-id/tsconfig-lint.json
@@ -0,0 +1,5 @@
+{
+ "extends": "./tsconfig.json",
+ "include": ["**/*"],
+ "exclude": ["node_modules", "dist"]
+}
diff --git a/packages/device-id/tsconfig.json b/packages/device-id/tsconfig.json
new file mode 100644
index 00000000..836d247a
--- /dev/null
+++ b/packages/device-id/tsconfig.json
@@ -0,0 +1,8 @@
+{
+ "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
+ "compilerOptions": {
+ "outDir": "dist"
+ },
+ "include": ["src/**/*"],
+ "exclude": ["./src/**/*.spec.*"]
+}
From 9b64211fd5505dff40a32e47153198cde6fab277 Mon Sep 17 00:00:00 2001
From: gagik <me@gagik.co>
Date: Fri, 2 May 2025 16:05:40 +0200
Subject: [PATCH 2/6] fix: add timeout tests
---
packages/device-id/README.md | 2 +-
packages/device-id/package.json | 7 +-
packages/device-id/src/get-device-id.spec.ts | 68 ++++++++++++++++++++
3 files changed, 74 insertions(+), 3 deletions(-)
diff --git a/packages/device-id/README.md b/packages/device-id/README.md
index f6835c44..c5cea5b9 100644
--- a/packages/device-id/README.md
+++ b/packages/device-id/README.md
@@ -1,3 +1,3 @@
# @mongodb-js/device-id
-Create a consistent, implementation-agnostic hash from a given raw machine ID. The machine ID should originate from `node-machine-id` or `native-machine-id` depending on the platform. The hash is generated using SHA-256 and is designed to be consistent with the Atlas CLI.
+Create a consistent, implementation-agnostic hash from a given raw machine ID resolution function. The machine ID resolution function should come from `node-machine-id` or `native-machine-id` depending on the platform. The hash is generated using SHA-256 and is designed to be consistent with the Atlas CLI.
diff --git a/packages/device-id/package.json b/packages/device-id/package.json
index 97ba4074..a4d83ef7 100644
--- a/packages/device-id/package.json
+++ b/packages/device-id/package.json
@@ -24,8 +24,11 @@
"license": "Apache-2.0",
"main": "dist/index.js",
"exports": {
- "require": "./dist/index.js",
- "import": "./dist/.esm-wrapper.mjs"
+ ".": {
+ "require": "./dist/index.js",
+ "import": "./dist/.esm-wrapper.mjs",
+ "types": "./dist/index.d.ts"
+ }
},
"types": "./dist/index.d.ts",
"scripts": {
diff --git a/packages/device-id/src/get-device-id.spec.ts b/packages/device-id/src/get-device-id.spec.ts
index e487b872..bdbdc2bf 100644
--- a/packages/device-id/src/get-device-id.spec.ts
+++ b/packages/device-id/src/get-device-id.spec.ts
@@ -82,4 +82,72 @@ describe('getDeviceId', function () {
expect(resultA).to.equal(resultB);
});
+
+ it('handles timeout when getting machine id', async () => {
+ let timeoutId: NodeJS.Timeout;
+ const getMachineId = () =>
+ new Promise<string>((resolve) => {
+ timeoutId = setTimeout(() => resolve('delayed-id'), 10_000);
+ });
+
+ let errorCalled = false;
+ const result = await getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ onError: () => {
+ errorCalled = true;
+ },
+ timeout: 1,
+ }).value;
+
+ clearTimeout(timeoutId!);
+ expect(result).to.equal('unknown');
+ });
+
+ it('handles external promise resolution', async () => {
+ let timeoutId: NodeJS.Timeout;
+ const getMachineId = () =>
+ new Promise<string>((resolve) => {
+ timeoutId = setTimeout(() => resolve('delayed-id'), 10_000);
+ });
+
+ const { resolve, value } = getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ });
+
+ resolve('external-id');
+
+ const result = await value;
+
+ clearTimeout(timeoutId!);
+ expect(result).to.be.a('string');
+ expect(result).to.equal('external-id');
+ expect(result).to.not.equal('unknown');
+ });
+
+ it('handles external promise rejection', async () => {
+ let timeoutId: NodeJS.Timeout;
+ const getMachineId = () =>
+ new Promise<string>((resolve) => {
+ timeoutId = setTimeout(() => resolve('delayed-id'), 10_000);
+ });
+
+ const error = new Error('External rejection');
+
+ const { reject, value } = getDeviceId({
+ getMachineId,
+ isNodeMachineId: false,
+ });
+
+ reject(error);
+
+ clearTimeout(timeoutId!);
+ try {
+ await value;
+ expect.fail('Expected promise to be rejected');
+ } catch (e) {
+ expect(e).to.equal(error);
+ }
+ });
});
From a8118199ee5e59418579c0a9dd0cab33831fa8a3 Mon Sep 17 00:00:00 2001
From: gagik <me@gagik.co>
Date: Fri, 2 May 2025 16:08:16 +0200
Subject: [PATCH 3/6] docs: better wording
---
packages/device-id/README.md | 2 +-
packages/device-id/package.json | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/packages/device-id/README.md b/packages/device-id/README.md
index c5cea5b9..ffe2aa8a 100644
--- a/packages/device-id/README.md
+++ b/packages/device-id/README.md
@@ -1,3 +1,3 @@
# @mongodb-js/device-id
-Create a consistent, implementation-agnostic hash from a given raw machine ID resolution function. The machine ID resolution function should come from `node-machine-id` or `native-machine-id` depending on the platform. The hash is generated using SHA-256 and is designed to be consistent with the Atlas CLI.
+Creates a consistent, implementation-agnostic hash from a given raw machine ID resolution function. The machine ID resolution function should come from `node-machine-id` or `native-machine-id` depending on the platform. The hash is generated using SHA-256 and is designed to be consistent with the Atlas CLI.
diff --git a/packages/device-id/package.json b/packages/device-id/package.json
index a4d83ef7..8d90797d 100644
--- a/packages/device-id/package.json
+++ b/packages/device-id/package.json
@@ -1,6 +1,6 @@
{
"name": "@mongodb-js/device-id",
- "description": "Creates a consistent device ID hash across MongoDB tools.",
+ "description": "Creates a consistent, implementation-agnostic hash from a given raw machine ID resolution function. Designed to be used by MongoDB Tools.",
"author": {
"name": "MongoDB Inc",
"email": "compass@mongodb.com"
From f1d52f95a0ffe32a7e2da6dd55c0f1e39ed0bf7a Mon Sep 17 00:00:00 2001
From: gagik <me@gagik.co>
Date: Mon, 5 May 2025 10:27:05 +0200
Subject: [PATCH 4/6] fix: add unref
---
packages/device-id/src/get-device-id.ts | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/packages/device-id/src/get-device-id.ts b/packages/device-id/src/get-device-id.ts
index 6c2ebedc..6c49fa87 100644
--- a/packages/device-id/src/get-device-id.ts
+++ b/packages/device-id/src/get-device-id.ts
@@ -31,7 +31,7 @@ export function getDeviceId({
} else {
resolve('unknown');
}
- }, timeout);
+ }, timeout).unref?.();
resolveDeviceId = resolve;
rejectDeviceId = reject;
From d62892dfc2c4be8017a3a88449833e3907d4420e Mon Sep 17 00:00:00 2001
From: gagik <me@gagik.co>
Date: Mon, 5 May 2025 10:58:48 +0200
Subject: [PATCH 5/6] fix: update device ID
---
package-lock.json | 72 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 72 insertions(+)
diff --git a/package-lock.json b/package-lock.json
index 17195d60..0bc959ad 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -6974,6 +6974,10 @@
"react": "^17.0.2"
}
},
+ "node_modules/@mongodb-js/device-id": {
+ "resolved": "packages/device-id",
+ "link": true
+ },
"node_modules/@mongodb-js/devtools-connect": {
"resolved": "packages/devtools-connect",
"link": true
@@ -27690,6 +27694,44 @@
"prettier": "2.3.2"
}
},
+ "packages/device-id": {
+ "name": "@mongodb-js/device-id",
+ "version": "0.1.0",
+ "license": "Apache-2.0",
+ "devDependencies": {
+ "@mongodb-js/eslint-config-devtools": "0.9.11",
+ "@mongodb-js/mocha-config-devtools": "^1.0.5",
+ "@mongodb-js/prettier-config-devtools": "^1.0.2",
+ "@mongodb-js/tsconfig-devtools": "^1.0.3",
+ "@types/chai": "^4.2.21",
+ "@types/mocha": "^9.1.1",
+ "@types/node": "^17.0.35",
+ "@types/sinon-chai": "^3.2.5",
+ "chai": "^4.5.0",
+ "depcheck": "^1.4.7",
+ "eslint": "^7.25.0",
+ "gen-esm-wrapper": "^1.1.3",
+ "mocha": "^8.4.0",
+ "nyc": "^15.1.0",
+ "prettier": "^3.5.3",
+ "sinon": "^9.2.3",
+ "typescript": "^5.0.4"
+ }
+ },
+ "packages/device-id/node_modules/typescript": {
+ "version": "5.8.3",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz",
+ "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "bin": {
+ "tsc": "bin/tsc",
+ "tsserver": "bin/tsserver"
+ },
+ "engines": {
+ "node": ">=14.17"
+ }
+ },
"packages/devtools-connect": {
"name": "@mongodb-js/devtools-connect",
"version": "3.7.2",
@@ -35194,6 +35236,36 @@
"react-window": "^1.8.6"
}
},
+ "@mongodb-js/device-id": {
+ "version": "file:packages/device-id",
+ "requires": {
+ "@mongodb-js/eslint-config-devtools": "0.9.11",
+ "@mongodb-js/mocha-config-devtools": "^1.0.5",
+ "@mongodb-js/prettier-config-devtools": "^1.0.2",
+ "@mongodb-js/tsconfig-devtools": "^1.0.3",
+ "@types/chai": "^4.2.21",
+ "@types/mocha": "^9.1.1",
+ "@types/node": "^17.0.35",
+ "@types/sinon-chai": "^3.2.5",
+ "chai": "^4.5.0",
+ "depcheck": "^1.4.7",
+ "eslint": "^7.25.0",
+ "gen-esm-wrapper": "^1.1.3",
+ "mocha": "^8.4.0",
+ "nyc": "^15.1.0",
+ "prettier": "^3.5.3",
+ "sinon": "^9.2.3",
+ "typescript": "^5.0.4"
+ },
+ "dependencies": {
+ "typescript": {
+ "version": "5.8.3",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz",
+ "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==",
+ "dev": true
+ }
+ }
+ },
"@mongodb-js/devtools-connect": {
"version": "file:packages/devtools-connect",
"requires": {
From 115f688b218c40f55a36c7dc74465983784799d9 Mon Sep 17 00:00:00 2001
From: gagik <me@gagik.co>
Date: Mon, 5 May 2025 11:12:22 +0200
Subject: [PATCH 6/6] fix: correct style errors
---
packages/device-id/src/get-device-id.spec.ts | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/packages/device-id/src/get-device-id.spec.ts b/packages/device-id/src/get-device-id.spec.ts
index bdbdc2bf..d2e5bde2 100644
--- a/packages/device-id/src/get-device-id.spec.ts
+++ b/packages/device-id/src/get-device-id.spec.ts
@@ -83,7 +83,7 @@ describe('getDeviceId', function () {
expect(resultA).to.equal(resultB);
});
- it('handles timeout when getting machine id', async () => {
+ it('handles timeout when getting machine id', async function () {
let timeoutId: NodeJS.Timeout;
const getMachineId = () =>
new Promise<string>((resolve) => {
@@ -100,11 +100,13 @@ describe('getDeviceId', function () {
timeout: 1,
}).value;
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
clearTimeout(timeoutId!);
expect(result).to.equal('unknown');
+ expect(errorCalled).to.equal(false);
});
- it('handles external promise resolution', async () => {
+ it('handles external promise resolution', async function () {
let timeoutId: NodeJS.Timeout;
const getMachineId = () =>
new Promise<string>((resolve) => {
@@ -120,13 +122,14 @@ describe('getDeviceId', function () {
const result = await value;
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
clearTimeout(timeoutId!);
expect(result).to.be.a('string');
expect(result).to.equal('external-id');
expect(result).to.not.equal('unknown');
});
- it('handles external promise rejection', async () => {
+ it('handles external promise rejection', async function () {
let timeoutId: NodeJS.Timeout;
const getMachineId = () =>
new Promise<string>((resolve) => {
@@ -142,6 +145,7 @@ describe('getDeviceId', function () {
reject(error);
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
clearTimeout(timeoutId!);
try {
await value;