nanoid 3.1.12 → 3.1.16

package/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 3.1.16
+* Speed up Nano ID 4 times (by Peter Boyer).
+
+## 3.1.15
+* Fixed `package.types` path.
+
+## 3.1.14
+* Added `package.types`.
+
+## 3.1.13
+* Removed Node.js 15.0.0 with `randomFillSync` regression from `engines.node`.
+
 ## 3.1.12
-* Improve IE 11 docs.
+* Improved IE 11 docs.
 
 ## 3.1.11
 * Fixed asynchronous `customAlphabet` in browser (by @LoneRifle).

package/README.md

@@ -46,6 +46,7 @@ Supports modern browsers, IE [with Babel], Node.js and React Native.
   * [React](#react)
   * [Create React App](#create-react-app)
   * [React Native](#react-native)
+  * [Rollup](#rollup)
   * [Expo](#expo)
   * [PouchDB and CouchDB](#pouchdb-and-couchdb)
   * [Mongoose](#mongoose)
@@ -81,27 +82,27 @@ There are three main differences between Nano ID and UUID v4:
 ## Benchmark
 
 ```rust
-$ ./test/benchmark
-nanoid                      655,798 ops/sec
-customAlphabet              635,421 ops/sec
-uid.sync                    375,816 ops/sec
-uuid v4                     396,756 ops/sec
-secure-random-string        366,434 ops/sec
-cuid                        183,998 ops/sec
-shortid                      59,343 ops/sec
+$ node ./test/benchmark.js
+nanoid                    2,280,683 ops/sec
+customAlphabet            1,851,117 ops/sec
+uid.sync                    313,306 ops/sec
+uuid v4                   1,348,425 ops/sec
+secure-random-string        294,161 ops/sec
+cuid                        158,988 ops/sec
+shortid                      37,222 ops/sec
 
 Async:
-async nanoid                101,966 ops/sec
-async customAlphabet        102,471 ops/sec
-async secure-random-string   97,206 ops/sec
-uid                          91,291 ops/sec
+async nanoid                 95,500 ops/sec
+async customAlphabet         93,800 ops/sec
+async secure-random-string   90,316 ops/sec
+uid                          85,583 ops/sec
 
 Non-secure:
-non-secure nanoid         2,754,423 ops/sec
-rndm                      2,437,262 ops/sec
+non-secure nanoid         2,641,654 ops/sec
+rndm                      2,447,086 ops/sec
 ```
 
-Test configuration: Dell XPS 2-in-a 7390, Fedora 32, Node.js 13.11.
+Test configuration: Dell XPS 2-in-1 7390, Fedora 32, Node.js 15.1.
 
 
 ## Tools
@@ -150,7 +151,7 @@ with 21 characters (to have a collision probability similar to UUID v4).
 
 ```js
 import { nanoid } from 'nanoid'
-model.id = nanoid() //=> "Uakgb_J5m9g-0JDMbcJqLJ"
+model.id = nanoid() //=> "V1StGXR8_Z5jdHi6B-myT"
 ```
 
 If you want to reduce the ID size (and increase collisions probability),
@@ -226,12 +227,10 @@ with ES modules packages.
 TypeError: (0 , _nanoid.nanoid) is not a function
 ```
 
-If you have an error above, here is temporary fix:
+[Pull request](https://github.com/facebook/create-react-app/pull/8768) was sent,
+but it was still not released.
 
-1. Use Nano ID 2 instead of 3: `npm i nanoid@^2.0.0`.
-2. Vote for
-   [pull request](https://github.com/facebook/create-react-app/pull/8768),
-   that fix dual packages support.
+Use Nano ID 2 `npm i nanoid@^2.0.0` until Create React App 4.0 release.
 
 
 ### React Native
@@ -251,6 +250,22 @@ For Expo framework see the next section.
 [`react-native-get-random-values`]: https://github.com/LinusU/react-native-get-random-values
 
 
+### Rollup
+
+For Rollup you will need [`@rollup/plugin-replace`] to replace
+`process.env.NODE_ENV`:
+
+```js
+  plugins: [
+    replace({
+      'process.env.NODE_ENV': JSON.stringify(process.env.NODE)
+    })
+  ]
+```
+
+[`@rollup/plugin-replace`]: https://github.com/rollup/plugins/tree/master/packages/replace
+
+
 ### Expo
 
 If you use Expo in React Native, you need a different workaround.
@@ -400,7 +415,7 @@ async function createUser () {
 ```
 
 Unfortunately, you will lose Web Crypto API advantages in a browser
-if you the asynchronous API. So, currently, in the browser, you are limited
+if you use the asynchronous API. So, currently, in the browser, you are limited
 with either security or asynchronous behavior.
 
 

package/index.cjs

@@ -2,19 +2,27 @@ let crypto = require('crypto')
 
 let { urlAlphabet } = require('./url-alphabet/index.cjs')
 
-// We reuse buffers with the same size to avoid memory fragmentations
-// for better performance.
-let buffers = {}
+// It is best to make fewer, larger requests to the crypto module to
+// avoid system call overhead. So, random numbers are generated in a
+// pool. The pool is a Buffer that is larger than the initial random
+// request size by this multiplier. The pool is enlarged if subsequent
+// requests exceed the maximum buffer size.
+const POOL_SIZE_MULTIPLIER = 32
+let pool, poolOffset
+
 let random = bytes => {
-  let buffer = buffers[bytes]
-  if (!buffer) {
-    // `Buffer.allocUnsafe()` is faster because it doesn’t flush the memory.
-    // Memory flushing is unnecessary since the buffer allocation itself resets
-    // the memory with the new bytes.
-    buffer = Buffer.allocUnsafe(bytes)
-    if (bytes <= 255) buffers[bytes] = buffer
+  if (!pool || pool.length < bytes) {
+    pool = Buffer.allocUnsafe(bytes * POOL_SIZE_MULTIPLIER)
+    crypto.randomFillSync(pool)
+    poolOffset = 0
+  } else if (poolOffset + bytes > pool.length) {
+    crypto.randomFillSync(pool)
+    poolOffset = 0
   }
-  return crypto.randomFillSync(buffer)
+
+  let res = pool.subarray(poolOffset, poolOffset + bytes)
+  poolOffset += bytes
+  return res
 }
 
 let customRandom = (alphabet, size, getRandom) => {

package/index.js

@@ -2,19 +2,27 @@ import crypto from 'crypto'
 
 import { urlAlphabet } from './url-alphabet/index.js'
 
-// We reuse buffers with the same size to avoid memory fragmentations
-// for better performance.
-let buffers = {}
+// It is best to make fewer, larger requests to the crypto module to
+// avoid system call overhead. So, random numbers are generated in a
+// pool. The pool is a Buffer that is larger than the initial random
+// request size by this multiplier. The pool is enlarged if subsequent
+// requests exceed the maximum buffer size.
+const POOL_SIZE_MULTIPLIER = 32
+let pool, poolOffset
+
 let random = bytes => {
-  let buffer = buffers[bytes]
-  if (!buffer) {
-    // `Buffer.allocUnsafe()` is faster because it doesn’t flush the memory.
-    // Memory flushing is unnecessary since the buffer allocation itself resets
-    // the memory with the new bytes.
-    buffer = Buffer.allocUnsafe(bytes)
-    if (bytes <= 255) buffers[bytes] = buffer
+  if (!pool || pool.length < bytes) {
+    pool = Buffer.allocUnsafe(bytes * POOL_SIZE_MULTIPLIER)
+    crypto.randomFillSync(pool)
+    poolOffset = 0
+  } else if (poolOffset + bytes > pool.length) {
+    crypto.randomFillSync(pool)
+    poolOffset = 0
   }
-  return crypto.randomFillSync(buffer)
+
+  let res = pool.subarray(poolOffset, poolOffset + bytes)
+  poolOffset += bytes
+  return res
 }
 
 let customRandom = (alphabet, size, getRandom) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nanoid",
-  "version": "3.1.12",
+  "version": "3.1.16",
   "description": "A tiny (108 bytes), secure URL-friendly unique string ID generator",
   "keywords": [
     "uuid",
@@ -9,7 +9,7 @@
     "url"
   ],
   "engines": {
-    "node": "^10 || ^12 || >=13.7"
+    "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1"
   },
   "author": "Andrey Sitnik <andrey@sitnik.ru>",
   "license": "MIT",
@@ -20,6 +20,7 @@
   "react-native": "index.js",
   "bin": "./bin/nanoid.cjs",
   "sideEffects": false,
+  "types": "./index.d.ts",
   "type": "module",
   "main": "index.cjs",
   "module": "index.js",
@@ -27,7 +28,8 @@
     ".": {
       "browser": "./index.browser.js",
       "require": "./index.cjs",
-      "import": "./index.js"
+      "import": "./index.js",
+      "types": "./index.d.ts"
     },
     "./package.json": "./package.json",
     "./async/package.json": "./async/package.json",
@@ -45,6 +47,7 @@
     "./url-alphabet": {
       "require": "./url-alphabet/index.cjs",
       "import": "./url-alphabet/index.js"
-    }
+    },
+    "./index.d.ts": "./index.d.ts"
   }
 }