Use crypto unbiased random integer generator
authorJérôme Benoit <jerome.benoit@sap.com>
Sun, 22 Jan 2023 19:32:29 +0000 (20:32 +0100)
committerJérôme Benoit <jerome.benoit@sap.com>
Sun, 22 Jan 2023 19:32:29 +0000 (20:32 +0100)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/utils/Constants.ts
src/utils/Utils.ts
test/utils/UtilsTest.ts

index c7e767eb49690fa6177b2d3b939978f0574ed0ef..241018fca18fff398590e56b1440ec6d3b260827 100644 (file)
@@ -45,6 +45,8 @@ export default class Constants {
 
   static readonly UNKNOWN_COMMAND = 'unknown command';
 
+  static readonly MAX_RANDOM_INTEGER = 281474976710654;
+
   private constructor() {
     // This is intentional
   }
index 8f63eb681940925a075c0ae6f29fc66f7781e4a3..203054dc40d4682d1b9b74c2f7dfb60c7a346737 100644 (file)
@@ -3,6 +3,7 @@ import util from 'node:util';
 
 import clone from 'just-clone';
 
+import Constants from './Constants';
 import { WebSocketCloseEventStatusString } from '../types/WebSocket';
 
 export default class Utils {
@@ -129,16 +130,13 @@ export default class Utils {
     return sign * (randomPositiveFloat * (max - min) + min);
   }
 
-  public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number {
-    if (max < min || max < 0 || min < 0) {
-      throw new RangeError('Invalid interval');
-    }
+  public static getRandomInteger(max = Constants.MAX_RANDOM_INTEGER, min = 0): number {
     max = Math.floor(max);
     if (!Utils.isNullOrUndefined(min) && min !== 0) {
       min = Math.ceil(min);
-      return Math.floor(Utils.secureRandom() * (max - min + 1)) + min;
+      return Math.floor(crypto.randomInt(min, max + 1));
     }
-    return Math.floor(Utils.secureRandom() * (max + 1));
+    return Math.floor(crypto.randomInt(max + 1));
   }
 
   public static roundTo(numberValue: number, scale: number): number {
@@ -259,6 +257,7 @@ export default class Utils {
       setTimeout(() => {
         if (Utils.isPromisePending(promise)) {
           timeoutCallback();
+          // FIXME: The original promise shall be canceled
         }
         reject(timeoutError);
       }, timeoutMs);
index 45ba4eb03bba02b78277c0cf6998934e89096d50..a826b36742258844189a954235b9b12036b653b6 100644 (file)
@@ -1,5 +1,6 @@
 import expect from 'expect';
 
+import Constants from '../../src/utils/Constants';
 import Utils from '../../src/utils/Utils';
 
 describe('Utils test suite', () => {
@@ -107,11 +108,19 @@ describe('Utils test suite', () => {
     let randomInteger = Utils.getRandomInteger();
     expect(Number.isSafeInteger(randomInteger)).toBe(true);
     expect(randomInteger).toBeGreaterThanOrEqual(0);
-    expect(randomInteger).toBeLessThanOrEqual(Number.MAX_SAFE_INTEGER);
+    expect(randomInteger).toBeLessThanOrEqual(Constants.MAX_RANDOM_INTEGER);
     expect(randomInteger).not.toEqual(Utils.getRandomInteger());
-    expect(() => Utils.getRandomInteger(0, 1)).toThrowError(new RangeError('Invalid interval'));
-    expect(() => Utils.getRandomInteger(-1)).toThrowError(new RangeError('Invalid interval'));
-    expect(() => Utils.getRandomInteger(0, -1)).toThrowError(new RangeError('Invalid interval'));
+    expect(() => Utils.getRandomInteger(0, 1)).toThrowError(
+      'The value of "max" is out of range. It must be greater than the value of "min" (1). Received 1'
+    );
+    expect(() => Utils.getRandomInteger(-1)).toThrowError(
+      'The value of "max" is out of range. It must be greater than the value of "min" (0). Received 0'
+    );
+    expect(() => Utils.getRandomInteger(Constants.MAX_RANDOM_INTEGER + 1)).toThrowError(
+      `The value of "max" is out of range. It must be <= ${
+        Constants.MAX_RANDOM_INTEGER + 1
+      }. Received 281_474_976_710_656`
+    );
     randomInteger = Utils.getRandomInteger(2, 1);
     expect(randomInteger).toBeGreaterThanOrEqual(1);
     expect(randomInteger).toBeLessThanOrEqual(2);