feat: optimize uuid.v1 by 1.3x uuid.v4 by 4.3x (430%) (#597)

Rush · web-flow · commit 3a033f6bab6b · 2021-12-02T23:43:13.000+01:00
This skips input validation when stringifying UUIDs that we _know_ are valid.
diff --git a/src/stringify.js b/src/stringify.js
@@ -10,10 +10,10 @@ for (let i = 0; i < 256; ++i) {
   byteToHex.push((i + 0x100).toString(16).substr(1));
 }
 
-function stringify(arr, offset = 0) {
+export function unsafeStringify(arr, offset = 0) {
   // Note: Be careful editing this code!  It's been tuned for performance
   // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
-  const uuid = (
+  return (
     byteToHex[arr[offset + 0]] +
     byteToHex[arr[offset + 1]] +
     byteToHex[arr[offset + 2]] +
@@ -35,7 +35,10 @@ function stringify(arr, offset = 0) {
     byteToHex[arr[offset + 14]] +
     byteToHex[arr[offset + 15]]
   ).toLowerCase();
+}
 
+function stringify(arr, offset = 0) {
+  const uuid = unsafeStringify(arr, offset);
   // Consistency check for valid UUID.  If this throws, it's likely due to one
   // of the following:
   // - One or more input array values don't map to a hex octet (leading to
diff --git a/src/v1.js b/src/v1.js
@@ -1,5 +1,5 @@
 import rng from './rng.js';
-import stringify from './stringify.js';
+import { unsafeStringify } from './stringify.js';
 
 // **`v1()` - Generate time-based UUID**
 //
@@ -109,7 +109,7 @@ function v1(options, buf, offset) {
     b[i + n] = node[n];
   }
 
-  return buf || stringify(b);
+  return buf || unsafeStringify(b);
 }
 
 export default v1;
diff --git a/src/v35.js b/src/v35.js
@@ -1,4 +1,4 @@
-import stringify from './stringify.js';
+import { unsafeStringify } from './stringify.js';
 import parse from './parse.js';
 
 function stringToBytes(str) {
@@ -51,7 +51,7 @@ export default function v35(name, version, hashfunc) {
       return buf;
     }
 
-    return stringify(bytes);
+    return unsafeStringify(bytes);
   }
 
   // Function#name is not settable on some platforms (#270)
diff --git a/src/v4.js b/src/v4.js
@@ -1,6 +1,6 @@
 import native from './native.js';
 import rng from './rng.js';
-import stringify from './stringify.js';
+import { unsafeStringify } from './stringify.js';
 
 function v4(options, buf, offset) {
   if (native.randomUUID && !buf && !options) {
@@ -26,7 +26,7 @@ function v4(options, buf, offset) {
     return buf;
   }
 
-  return stringify(rnds);
+  return unsafeStringify(rnds);
 }
 
 export default v4;
diff --git a/test/unit/stringify.test.js b/test/unit/stringify.test.js
@@ -1,40 +1,48 @@
 import assert from 'assert';
-import stringify from '../../src/stringify.js';
+import stringify, { unsafeStringify } from '../../src/stringify.js';
 
 const BYTES = [
   0x0f, 0x5a, 0xbc, 0xd1, 0xc1, 0x94, 0x47, 0xf3, 0x90, 0x5b, 0x2d, 0xf7, 0x26, 0x3a, 0x08, 0x4b,
 ];
 
-describe('stringify', () => {
-  test('Stringify Array', () => {
-    assert.equal(stringify(BYTES), '0f5abcd1-c194-47f3-905b-2df7263a084b');
-  });
+describe('unsafeStringify', () => {
+  describe('default', () => {
+    test('Stringify Array', () => {
+      assert.equal(unsafeStringify(BYTES), '0f5abcd1-c194-47f3-905b-2df7263a084b');
+    });
 
-  test('Stringify TypedArray', () => {
-    assert.equal(stringify(Uint8Array.from(BYTES)), '0f5abcd1-c194-47f3-905b-2df7263a084b');
-    assert.equal(stringify(Int32Array.from(BYTES)), '0f5abcd1-c194-47f3-905b-2df7263a084b');
-  });
+    test('Stringify TypedArray', () => {
+      assert.equal(unsafeStringify(Uint8Array.from(BYTES)), '0f5abcd1-c194-47f3-905b-2df7263a084b');
+      assert.equal(unsafeStringify(Int32Array.from(BYTES)), '0f5abcd1-c194-47f3-905b-2df7263a084b');
+    });
 
-  test('Stringify w/ offset', () => {
-    assert.equal(stringify([0, 0, 0, ...BYTES], 3), '0f5abcd1-c194-47f3-905b-2df7263a084b');
+    test('Stringify w/ offset', () => {
+      assert.equal(unsafeStringify([0, 0, 0, ...BYTES], 3), '0f5abcd1-c194-47f3-905b-2df7263a084b');
+    });
   });
 
-  test('Throws on not enough values', () => {
-    const bytes = [...BYTES];
-    bytes.length = 15;
-    assert.throws(() => stringify(bytes));
-  });
+  describe('safe', () => {
+    test('Stringify Array', () => {
+      assert.equal(stringify(BYTES), '0f5abcd1-c194-47f3-905b-2df7263a084b');
+    });
 
-  test('Throws on undefined value', () => {
-    const bytes = [...BYTES];
-    delete bytes[3];
-    bytes.length = 15;
-    assert.throws(() => stringify(bytes));
-  });
+    test('Throws on not enough values', () => {
+      const bytes = [...BYTES];
+      bytes.length = 15;
+      assert.throws(() => stringify(bytes));
+    });
+
+    test('Throws on undefined value', () => {
+      const bytes = [...BYTES];
+      delete bytes[3];
+      bytes.length = 15;
+      assert.throws(() => stringify(bytes));
+    });
 
-  test('Throws on invalid value', () => {
-    const bytes = [...BYTES];
-    bytes[3] = 256;
-    assert.throws(() => stringify(bytes));
+    test('Throws on invalid value', () => {
+      const bytes = [...BYTES];
+      bytes[3] = 256;
+      assert.throws(() => stringify(bytes));
+    });
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import rng from './rng.js';`
`2`		`-import stringify from './stringify.js';`
	`2`	`+import { unsafeStringify } from './stringify.js';`
`3`	`3`
`4`	`4`	// `v1()` - Generate time-based UUID
`5`	`5`	`//`
`@@ -109,7 +109,7 @@ function v1(options, buf, offset) {`
`109`	`109`	`b[i + n] = node[n];`
`110`	`110`	`}`
`111`	`111`
`112`		`- return buf \|\| stringify(b);`
	`112`	`+ return buf \|\| unsafeStringify(b);`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`export default v1;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import stringify from './stringify.js';`
	`1`	`+import { unsafeStringify } from './stringify.js';`
`2`	`2`	`import parse from './parse.js';`
`3`	`3`
`4`	`4`	`function stringToBytes(str) {`
`@@ -51,7 +51,7 @@ export default function v35(name, version, hashfunc) {`
`51`	`51`	`return buf;`
`52`	`52`	`}`
`53`	`53`
`54`		`- return stringify(bytes);`
	`54`	`+ return unsafeStringify(bytes);`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`// Function#name is not settable on some platforms (#270)`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import native from './native.js';`
`2`	`2`	`import rng from './rng.js';`
`3`		`-import stringify from './stringify.js';`
	`3`	`+import { unsafeStringify } from './stringify.js';`
`4`	`4`
`5`	`5`	`function v4(options, buf, offset) {`
`6`	`6`	`if (native.randomUUID && !buf && !options) {`
`@@ -26,7 +26,7 @@ function v4(options, buf, offset) {`
`26`	`26`	`return buf;`
`27`	`27`	`}`
`28`	`28`
`29`		`- return stringify(rnds);`
	`29`	`+ return unsafeStringify(rnds);`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`export default v4;`