entangld 2.7.0 → 2.7.1

package/lib/Datastore.js

@@ -1,4 +1,4 @@
-const { randomUUID: uuidv4 } = require("node:crypto");
+const uuidv4 = require("./uuid.js");
 const EventEmitter = require("events");
 const uuid_regex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 const MAX_TIMEOUT_MS = 2147483647; // Longer setTimeout delays fire after 1 ms

package/lib/Message.js

@@ -1,4 +1,4 @@
-const { randomUUID: uuidv4 } = require("node:crypto");
+const uuidv4 = require("./uuid.js");
 
 /**
  * Message class for Entangld.

package/lib/uuid.js

@@ -0,0 +1,51 @@
+/**
+ * A random (v4) uuid, in Node and in browsers.
+ *
+ * Browsers on secure pages and Node 19 and later have crypto.randomUUID() on
+ * globalThis. Node 18 has it in its crypto module, which the "browser" field in
+ * package.json leaves out of browser bundles. A browser page that isn't secure
+ * (plain http, not localhost) has only crypto.getRandomValues().
+ *
+ * @author Claude <noreply@anthropic.com>
+ * Reviewed-by: Jonathan D. B. Van Schenck <jvschenck@novadynamics.com>
+ */
+
+/**
+ * A v4 uuid from 16 random bytes.
+ *
+ * @param {Uint8Array} bytes
+ * @return {string}
+ */
+function format_v4(bytes) {
+    bytes[6] = (bytes[6] & 0x0f) | 0x40; // version 4
+    bytes[8] = (bytes[8] & 0x3f) | 0x80; // RFC 4122 variant
+    const hex = Array.from(bytes, (b) => b.toString(16).padStart(2, "0")).join("");
+    return `${hex.slice(0, 8)}-${hex.slice(8, 12)}-${hex.slice(12, 16)}-${hex.slice(16, 20)}-${hex.slice(20)}`;
+}
+
+/**
+ * Pick the uuid source for this runtime.
+ *
+ * @param {object} [web_crypto] - globalThis.crypto, if any.
+ * @param {Function} [load_node_crypto] - returns Node's crypto module, or {} in a browser bundle.
+ * @return {Function} returns a new uuid string.
+ */
+// randomUUID needs Node 14.17 anyway, which has globalThis
+function make_uuid(web_crypto = globalThis.crypto, load_node_crypto = () => require("crypto")) { // eslint-disable-line node/no-unsupported-features/es-builtins
+    if ( typeof web_crypto?.randomUUID == "function" ) return () => web_crypto.randomUUID();
+    let node_crypto = {};
+    try {
+        node_crypto = load_node_crypto() || {};
+    } catch (err) {
+        // Not in Node
+    }
+    if ( typeof node_crypto.randomUUID == "function" ) return () => node_crypto.randomUUID();
+    if ( typeof web_crypto?.getRandomValues == "function" ) {
+        return () => format_v4(web_crypto.getRandomValues(new Uint8Array(16)));
+    }
+    throw new Error("entangld needs crypto.randomUUID or crypto.getRandomValues");
+}
+
+module.exports = make_uuid();
+module.exports.make_uuid = make_uuid;
+module.exports.format_v4 = format_v4;

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "entangld",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "Synchronized key-value stores with RPCs and events",
   "main": "index.js",
+  "browser": {
+    "crypto": false
+  },
   "jshintConfig": {
     "esversion": 6,
     "unused": true

package/test/uuid.js

@@ -0,0 +1,37 @@
+const assert = require("assert");
+const uuidv4 = require("../lib/uuid.js");
+const { make_uuid } = uuidv4;
+
+const V4 = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/;
+const node_crypto = require("crypto");
+
+describe("uuid", () => {
+    it("makes distinct v4 uuids", () => {
+        const ids = new Set(Array.from({ length: 1000 }, () => uuidv4()));
+        assert.strictEqual(ids.size, 1000);
+        for ( const id of ids ) assert.match(id, V4);
+    });
+
+    it("uses globalThis.crypto.randomUUID when there is one (browsers, Node 19+)", () => {
+        const uuid = make_uuid({ randomUUID: () => "from-web-crypto" }, () => assert.fail("Node's crypto was loaded"));
+        assert.strictEqual(uuid(), "from-web-crypto");
+    });
+
+    it("falls back to Node's crypto module (Node 18)", () => {
+        const uuid = make_uuid(null, () => ({ randomUUID: () => "from-node-crypto" }));
+        assert.strictEqual(uuid(), "from-node-crypto");
+    });
+
+    it("builds one from getRandomValues on a page that isn't secure", () => {
+        // In a browser bundle, the "browser" field turns require("crypto") into {}
+        const page = { getRandomValues: (a) => node_crypto.getRandomValues(a) };
+        const uuid = make_uuid(page, () => ({}));
+        const ids = new Set(Array.from({ length: 1000 }, () => uuid()));
+        assert.strictEqual(ids.size, 1000);
+        for ( const id of ids ) assert.match(id, V4);
+    });
+
+    it("says what's missing when there's no crypto at all", () => {
+        assert.throws(() => make_uuid(null, () => { throw new Error("no module"); }), /crypto.randomUUID or crypto.getRandomValues/);
+    });
+});