chore: Add basic collision probabilities script

package.json

@@ -28,12 +28,14 @@
     "eslint": "^8.14.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "fast-stats": "^0.0.6",
     "is-email": "^1.0.2",
     "is-mac-address": "^1.0.4",
     "jest": "^28.0.1",
     "prettier": "^2.6.2",
     "typescript": "^4.6.3",
-    "user-agent-is-browser": "^0.1.0"
+    "user-agent-is-browser": "^0.1.0",
+    "worker-farm": "^1.7.0"
   },
   "scripts": {
     "build": "yarn build:js && yarn build:types",

scripts/collisions.js

@@ -0,0 +1,114 @@
+const workerFarm = require('worker-farm')
+const { promisify } = require('util')
+const { v4: uuid } = require('uuid')
+const Stats = require('fast-stats').Stats
+
+const { TRANSFORMATIONS } = require('../dist/testutils')
+
+const METHODS = [
+  'email',
+  'int',
+  'dateString',
+  'ipv4',
+  'mac',
+  'float',
+  'fullName',
+  'streetAddress',
+  'postalAddress',
+  'password',
+  'uuid',
+]
+
+const MAX_N = +(process.env.MAX_N ?? 999999)
+const MIN_RUNS = Math.max(2, +(process.env.MIN_RUNS ?? 100))
+const MAX_SUM = +(process.env.MAX_SUM ?? MAX_N)
+const LO_MOE = +(process.env.MOE ?? 0.05)
+const HI_MOE = +(process.env.MOE ?? 0.10)
+
+const workerOptions = {
+  workerOptions: {
+    env: {
+      IS_WORKER: '1',
+    },
+  }
+}
+
+const workers = workerFarm(workerOptions, require.resolve(__filename))
+
+const runWorker = promisify(workers)
+
+const findFirstCollisionN = (methodName) => {
+  const fn = TRANSFORMATIONS[methodName]
+  let i = -1
+  const seen = new Set()
+  let firstCollisionN = null
+
+  while (++i < MAX_N && firstCollisionN == null) {
+    const result = fn(uuid()).toString()
+    if (seen.has(result)) {
+      firstCollisionN = i
+    } else {
+      seen.add(result)
+    }
+  }
+
+  return firstCollisionN
+}
+
+const worker = (methodName, done) => {
+  const stats = new Stats()
+  let hasCollided = false
+  let sum = 0
+
+  const isComplete = () => {
+    const moe = stats.length > 2
+      ? stats.moe() / stats.amean()
+      : null
+
+    return stats.length >= MIN_RUNS && (moe != null && (moe <= LO_MOE || (moe <= HI_MOE && sum >= MAX_SUM)))
+  }
+
+  while (!isComplete()) {
+    const firstCollisionN = findFirstCollisionN(methodName)
+
+    if (findFirstCollisionN != null) {
+      hasCollided = true
+      sum += firstCollisionN
+    } else {
+      sum = MAX_N
+    }
+
+    stats.push(firstCollisionN)
+  }
+
+  const [min, max] = stats.range()
+
+  done(null, {
+    methodName,
+    mean: stats.amean().toFixed(2),
+    stddev: stats.stddev().toFixed(2),
+    moe: (stats.moe() / stats.amean()).toFixed(2),
+    runs: stats.length,
+    min,
+    max,
+    sum,
+    hasCollided,
+  })
+}
+
+async function main() {
+  await Promise.all(
+    METHODS.map(async (methodName) => {
+      const results = await runWorker(methodName)
+      console.log(JSON.stringify(results))
+    })
+  )
+
+  workerFarm.end(workers)
+}
+
+module.exports = worker
+
+if (require.main === module && !process.env.IS_WORKER) {
+  main()
+}

yarn.lock

@@ -1436,6 +1436,13 @@ end-of-stream@^1.1.0:
   dependencies:
     once "^1.4.0"
 
+errno@~0.1.7:
+  version "0.1.8"
+  resolved "https://registry.yarnpkg.com/errno/-/errno-0.1.8.tgz#8bb3e9c7d463be4976ff888f76b4809ebc2e811f"
+  integrity sha512-dJ6oBr5SQ1VSd9qkk7ByRgb/1SH4JZjCHSW/mr63/QcXO9zLVxvJ6Oy13nio03rxpSnVDDjFor75SjVeZWPW/A==
+  dependencies:
+    prr "~1.0.1"
+
 error-ex@^1.3.1:
   version "1.3.2"
   resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf"
@@ -1849,6 +1856,11 @@ fast-levenshtein@^2.0.6:
   resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917"
   integrity sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=
 
+fast-stats@^0.0.6:
+  version "0.0.6"
+  resolved "https://registry.yarnpkg.com/fast-stats/-/fast-stats-0.0.6.tgz#949e7a97ef12effba710c6322a1fad3fcc8609e7"
+  integrity sha512-m0zkwa7Z07Wc4xm1YtcrCHmhzNxiYRrrfUyhkdhSZPzaAH/Ewbocdaq7EPVBFz19GWfIyyPcLfRHjHJYe83jlg==
+
 fastq@^1.6.0:
   version "1.13.0"
   resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c"
@@ -3307,6 +3319,11 @@ prompts@^2.0.1:
     kleur "^3.0.3"
     sisteransi "^1.0.5"
 
+prr@~1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/prr/-/prr-1.0.1.tgz#d3fc114ba06995a45ec6893f484ceb1d78f5f476"
+  integrity sha512-yPw4Sng1gWghHQWj0B3ZggWUm4qVbPwPFcRG8KyxiU7J2OHFSoEHKS+EZ3fv5l1t9CyCiop6l/ZYeWbrgoQejw==
+
 pump@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64"
@@ -3895,6 +3912,13 @@ word-wrap@^1.2.3:
   resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"
   integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==
 
+worker-farm@^1.7.0:
+  version "1.7.0"
+  resolved "https://registry.yarnpkg.com/worker-farm/-/worker-farm-1.7.0.tgz#26a94c5391bbca926152002f69b84a4bf772e5a8"
+  integrity sha512-rvw3QTZc8lAxyVrqcSGVm5yP/IJ2UcB3U0graE3LCFoZ0Yn2x4EoVSqJKdB/T5M+FLcRPjz4TDacRf3OCfNUzw==
+  dependencies:
+    errno "~0.1.7"
+
 wrap-ansi@^7.0.0:
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"