10929854965

Committed 18 Sep 2024 08:45PM UTC coverage: 31.84% (-0.03%) from 31.871%

Build # 10929854965

Build Type

Pull #9714

github

Committed by

rjmk

Commit Message

Merge master

Pull Request Pull Request #9714: Doppel comments

Run Details

5078 of 41454 branches covered (12.25%)

Branch coverage included in aggregate %.

66 of 187 new or added lines in 16 files covered. (35.29%)

1058 existing lines in 45 files now uncovered.

29501 of 67147 relevant lines covered (43.93%)

185.21 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.0

/packages/lesswrong/lib/random.ts

import seedrandom from "./seedrandom";

const crypto = bundleIsServer ? require('crypto') : null;

// Excludes 0O1lIUV
const unmistakableChars = "abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTWXYZ23456789";

export type RandIntCallback = (max: number) => number;

/**
 * A random integer in [0,max). Not cryptographically secure.
 */
export const randInt: RandIntCallback = (max: number) => {
  return Math.floor(Math.random() * max);
}

/**
 * A seeded random integer in [0,max). Not cryptographically secure.
 */
export const seededRandInt = (seed: string): RandIntCallback => {
  const rng = seedrandom(seed);
  return (max: number) => Math.floor(rng() * max);
}

export const ID_LENGTH = 17;

/**
 * A random 17-digit string, using characters that are hard to confuse with each
 * other. If run on the server and not supplying a custom RNG then it's
 * cryptographically secure, otherwise it's not.
 */
export const randomId = (length=ID_LENGTH, randIntCallback?: RandIntCallback) => {
  if (bundleIsServer && !randIntCallback) {
    const bytes = crypto.randomBytes(length);
    const result: Array<string> = [];
    for (let byte of bytes) {
      // Discards part of each byte and has modulo bias. Doesn't matter in
      // this context.
      result.push(unmistakableChars[byte % unmistakableChars.length]);
    }
    return result.join('');
  } else {
    const rand = randIntCallback ?? randInt;
    const result: Array<string> = [];
    for (let i=0; i<length; i++)
      result.push(unmistakableChars[rand(unmistakableChars.length)]);
    return result.join('');
  }
}

/**
 * Detects whether the given string could *not* have been generated by the `randomId()` function.
 */
export const isNotRandomId = (id: string, length=ID_LENGTH): boolean => {
  const regex = new RegExp(`^[${unmistakableChars}]{${length}}$`);
  return !regex.test(id);
}

/**
 * A 30 digit (15 byte) random hexadecimal string, generated from a CSPRNG.
 * Not available on the client (throws an exception).
 */
export const randomSecret = () => {
  if (bundleIsServer) {
    return crypto.randomBytes(15).toString('hex');
  } else {
    throw new Error("No CSPRNG available on the client");
  }
}

export const seededShuffle = <T>(arr: T[], seed: string): T[] => {
  const rng = seedrandom(seed);
  const withRandoms = arr.map((item) => ({ item, random: rng() }));
  const sorted = withRandoms.sort((a, b) => a.random - b.random);
  return sorted.map(({ item }) => item);
}

1	import seedrandom from "./seedrandom";	6,456✔
2
3	const crypto = bundleIsServer ? require('crypto') : null;	48!
4
5	// Excludes 0O1lIUV
6	const unmistakableChars = "abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTWXYZ23456789";	48✔
7
8	export type RandIntCallback = (max: number) => number;
9
10	/**
11	* A random integer in [0,max). Not cryptographically secure.
12	*/
13	export const randInt: RandIntCallback = (max: number) => {	48✔
14	return Math.floor(Math.random() * max);	×
15	}
16
17	/**
18	* A seeded random integer in [0,max). Not cryptographically secure.
19	*/
20	export const seededRandInt = (seed: string): RandIntCallback => {	48✔
21	const rng = seedrandom(seed);	174✔
22	return (max: number) => Math.floor(rng() * max);	917✔
23	}
24
25	export const ID_LENGTH = 17;	48✔
26
27	/**
28	* A random 17-digit string, using characters that are hard to confuse with each
29	* other. If run on the server and not supplying a custom RNG then it's
30	* cryptographically secure, otherwise it's not.
31	*/
32	export const randomId = (length=ID_LENGTH, randIntCallback?: RandIntCallback) => {	48✔
33	if (bundleIsServer && !randIntCallback) {	2,213✔
34	const bytes = crypto.randomBytes(length);	2,030✔
35	const result: Array<string> = [];	2,030✔
36	for (let byte of bytes) {	2,030✔
37	// Discards part of each byte and has modulo bias. Doesn't matter in
38	// this context.
39	result.push(unmistakableChars[byte % unmistakableChars.length]);	34,510✔
40	}
41	return result.join('');	2,030✔
42	} else {
43	const rand = randIntCallback ?? randInt;	183!
44	const result: Array<string> = [];	183✔
45	for (let i=0; i<length; i++)	183✔
46	result.push(unmistakableChars[rand(unmistakableChars.length)]);	915✔
47	return result.join('');	183✔
48	}
49	}
50
51	/**
52	* Detects whether the given string could not have been generated by the `randomId()` function.
53	*/
54	export const isNotRandomId = (id: string, length=ID_LENGTH): boolean => {	48✔
55	const regex = new RegExp(`^[${unmistakableChars}]{${length}}$`);	5✔
56	return !regex.test(id);	5✔
57	}
58
59	/**
60	* A 30 digit (15 byte) random hexadecimal string, generated from a CSPRNG.
61	* Not available on the client (throws an exception).
62	*/
63	export const randomSecret = () => {	48✔
64	if (bundleIsServer) {	103!
65	return crypto.randomBytes(15).toString('hex');	103✔
66	} else {
67	throw new Error("No CSPRNG available on the client");	×
68	}
69	}
70
71	export const seededShuffle = <T>(arr: T[], seed: string): T[] => {	48✔
NEW 72	const rng = seedrandom(seed);	×
NEW 73	const withRandoms = arr.map((item) => ({ item, random: rng() }));	×
NEW 74	const sorted = withRandoms.sort((a, b) => a.random - b.random);	×
NEW 75	return sorted.map(({ item }) => item);	×
76	}

ForumMagnum / ForumMagnum / 10929854965

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous