Merge pull request #168 from everdimension/update-payload-id-generator

Improve payloadId generator

Author: ganchoradkov

jsonrpc/utils/src/format.ts

@@ -2,14 +2,34 @@ import { getError, getErrorByCode, isReservedErrorCode } from "./error";
 import { INTERNAL_ERROR, SERVER_ERROR } from "./constants";
 import { ErrorResponse, JsonRpcError, JsonRpcRequest, JsonRpcResult } from "./types";
 
-export function payloadId(entropy = 3): number {
-  const date = Date.now() * Math.pow(10, entropy);
-  const extra = Math.floor(Math.random() * Math.pow(10, entropy));
+class IncrementalRandomGenerator {
+  private initialValue: number;
+  private i = 1;
+
+  constructor(bits: 8 | 16 | 32) {
+    const typedArray =
+      bits === 8 ? new Uint8Array(1) : bits === 16 ? new Uint16Array(1) : new Uint32Array(1);
+    this.initialValue = crypto.getRandomValues(typedArray)[0];
+  }
+
+  getNextValue() {
+    return this.initialValue + this.i++;
+  }
+}
+
+const uint8Generator = new IncrementalRandomGenerator(8);
+const uint16Generator = new IncrementalRandomGenerator(16);
+
+export function payloadId(): number {
+  const date = Date.now() * 1000;
+  const extra = uint8Generator.getNextValue();
   return date + extra;
 }
 
-export function getBigIntRpcId(entropy = 6): bigint {
-  return BigInt(payloadId(entropy));
+export function getBigIntRpcId(): bigint {
+  const date = BigInt(Date.now()) * BigInt(1000000);
+  const extra = BigInt(uint16Generator.getNextValue());
+  return date + extra;
 }
 
 export function formatJsonRpcRequest<T = any>(

jsonrpc/utils/test/payloadId.test.ts

@@ -25,10 +25,6 @@ describe("Payload Id", () => {
     chai.expect(payloadId().toString().length).to.equal(16);
   });
 
-  it("returns a bigint with 19 digits", () => {
-    chai.expect(getBigIntRpcId().toString().length).to.equal(19);
-  });
-
   // Context: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
   it("returns a safe integer", () => {
     chai.expect(Number.isSafeInteger(payloadId())).to.be.true;
@@ -46,4 +42,67 @@ describe("Payload Id", () => {
     const duplicates = findDuplicates(results);
     chai.expect(duplicates.length === 0).to.be.true;
   });
+
+  it("generates increasing values when called within same tick", () => {
+    let i = 0;
+    while (i++ < 10000) {
+      const value1 = payloadId();
+      const value2 = payloadId();
+      const value3 = payloadId();
+      const value4 = payloadId();
+      if (value1 >= value2 || value2 >= value3 || value3 >= value4) {
+        chai.assert.fail("Not increasing values");
+      }
+    }
+    chai.assert.isOk("Pass");
+  });
+
+  it("generates non-repeating values when called within same tick", () => {
+    let i = 0;
+    while (i++ < 10000) {
+      const values = [payloadId(), payloadId(), payloadId(), payloadId()];
+      const set = new Set(values);
+      if (set.size !== values.length) {
+        chai.assert.fail("Not unique values");
+      }
+    }
+    chai.assert.isOk("Pass");
+  });
+});
+
+describe("Get BigInt Rpc Id", () => {
+  it("returns a bigint", () => {
+    const value = getBigIntRpcId();
+    chai.expect(typeof value === "bigint").to.be.true;
+  });
+
+  it("returns a bigint with 19 digits", () => {
+    chai.expect(getBigIntRpcId().toString().length).to.equal(19);
+  });
+
+  it("generates increasing values when called within same tick", () => {
+    let i = 0;
+    while (i++ < 10000) {
+      const value1 = getBigIntRpcId();
+      const value2 = getBigIntRpcId();
+      const value3 = getBigIntRpcId();
+      const value4 = getBigIntRpcId();
+      if (value1 >= value2 || value2 >= value3 || value3 >= value4) {
+        chai.assert.fail("Not increasing values");
+      }
+    }
+    chai.assert.isOk("Pass");
+  });
+
+  it("generates non-repeating values when called within same tick", () => {
+    let i = 0;
+    while (i++ < 10000) {
+      const values = [getBigIntRpcId(), getBigIntRpcId(), getBigIntRpcId(), getBigIntRpcId()];
+      const set = new Set(values);
+      if (set.size !== values.length) {
+        chai.assert.fail("Not unique values");
+      }
+    }
+    chai.assert.isOk("Pass");
+  });
 });