replace hexoid with equivalent functionality (#441)

Author: Uzlopak

benchmark/generateId.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const { Suite } = require('benchmark')
+const { generateId } = require('../lib/generateId')
+
+const suite = new Suite()
+
+suite.add('id', generateId)
+
+suite
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+  })
+  .on('complete', function () {
+    console.log('Fastest is ' + this.filter('fastest').map('name'))
+    console.log('Slowest is ' + this.filter('slowest').map('name'))
+  })
+  .run()

index.js

@@ -7,7 +7,7 @@ const eos = require('end-of-stream')
 const { createWriteStream } = require('fs')
 const { unlink } = require('fs').promises
 const path = require('path')
-const hexoid = require('hexoid')
+const { generateId } = require('./lib/generateId')
 const util = require('util')
 const createError = require('@fastify/error')
 const sendToWormhole = require('stream-wormhole')
@@ -222,8 +222,6 @@ function fastifyMultipart (fastify, options, done) {
     await request.cleanRequestFiles()
   })
 
-  const toID = hexoid()
-
   function isMultipart () {
     return this.raw[kMultipart] || false
   }
@@ -538,7 +536,7 @@ function fastifyMultipart (fastify, options, done) {
     const tmpdir = (options && options.tmpdir) || os.tmpdir()
     this.tmpUploads = []
     for await (const file of files) {
-      const filepath = path.join(tmpdir, toID() + path.extname(file.filename))
+      const filepath = path.join(tmpdir, generateId() + path.extname(file.filename))
       const target = createWriteStream(filepath)
       try {
         await pump(file.file, target)

lib/generateId.js

@@ -0,0 +1,44 @@
+'use strict'
+
+const HEX = [
+  '00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '0a', '0b', '0c', '0d', '0e', '0f',
+  '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '1a', '1b', '1c', '1d', '1e', '1f',
+  '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '2a', '2b', '2c', '2d', '2e', '2f',
+  '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '3a', '3b', '3c', '3d', '3e', '3f',
+  '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '4a', '4b', '4c', '4d', '4e', '4f',
+  '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '5a', '5b', '5c', '5d', '5e', '5f',
+  '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '6a', '6b', '6c', '6d', '6e', '6f',
+  '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '7a', '7b', '7c', '7d', '7e', '7f',
+  '80', '81', '82', '83', '84', '85', '86', '87', '88', '89', '8a', '8b', '8c', '8d', '8e', '8f',
+  '90', '91', '92', '93', '94', '95', '96', '97', '98', '99', '9a', '9b', '9c', '9d', '9e', '9f',
+  'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'a7', 'a8', 'a9', 'aa', 'ab', 'ac', 'ad', 'ae', 'af',
+  'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'b7', 'b8', 'b9', 'ba', 'bb', 'bc', 'bd', 'be', 'bf',
+  'c0', 'c1', 'c2', 'c3', 'c4', 'c5', 'c6', 'c7', 'c8', 'c9', 'ca', 'cb', 'cc', 'cd', 'ce', 'cf',
+  'd0', 'd1', 'd2', 'd3', 'd4', 'd5', 'd6', 'd7', 'd8', 'd9', 'da', 'db', 'dc', 'dd', 'de', 'df',
+  'e0', 'e1', 'e2', 'e3', 'e4', 'e5', 'e6', 'e7', 'e8', 'e9', 'ea', 'eb', 'ec', 'ed', 'ee', 'ef',
+  'f0', 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'fa', 'fb', 'fc', 'fd', 'fe', 'ff'
+]
+
+const random = Math.random
+
+function seed () {
+  return (
+    HEX[0xff * random() | 0] +
+    HEX[0xff * random() | 0] +
+    HEX[0xff * random() | 0] +
+    HEX[0xff * random() | 0] +
+    HEX[0xff * random() | 0] +
+    HEX[0xff * random() | 0] +
+    HEX[0xff * random() | 0]
+  )
+}
+
+module.exports.generateId = (function generateIdFn () {
+  let num = 0
+  let str = seed()
+  return function generateId () {
+    return (num === 255) // eslint-disable-line no-return-assign
+      ? (str = seed()) + HEX[num = 0]
+      : str + HEX[++num]
+  }
+})()

package.json

@@ -12,7 +12,6 @@
     "@fastify/swagger-ui": "^1.8.0",
     "end-of-stream": "^1.4.4",
     "fastify-plugin": "^4.0.0",
-    "hexoid": "^1.0.0",
     "secure-json-parse": "^2.4.0",
     "stream-wormhole": "^1.1.0"
   },
@@ -21,6 +20,7 @@
     "@types/node": "^20.1.0",
     "@typescript-eslint/eslint-plugin": "^5.30.7",
     "@typescript-eslint/parser": "^5.30.7",
+    "benchmark": "^2.1.4",
     "climem": "^1.0.3",
     "concat-stream": "^2.0.0",
     "eslint": "^8.20.0",

test/generate-id.test.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const { test } = require('tap')
+const { generateId } = require('../lib/generateId')
+
+test('returns', t => {
+  t.plan(3)
+  t.type(generateId, 'function', 'is a function')
+  t.type(generateId(), 'string', '~> returns a string')
+  t.equal(generateId().length, 16, '~> has 16 characters (default)')
+})
+
+test('length', t => {
+  const iterations = 1e3
+  t.plan(iterations)
+
+  let i = 0
+  let tmp = ''
+  for (; i < iterations; ++i) {
+    tmp = generateId()
+    t.equal(tmp.length, 16, `"${tmp}" is 16 characters`)
+  }
+})
+
+test('unique /1', t => {
+  t.plan(1)
+  t.not(generateId(), generateId(), '~> single')
+})
+
+test('unique /2', t => {
+  t.plan(1)
+  const items = new Set()
+  for (let i = 5e6; i--;) items.add(generateId())
+  t.equal(items.size, 5e6, '~> 5,000,000 unique ids')
+})