From 3a033f6bab6bb3780ece6d645b902548043280bc Mon Sep 17 00:00:00 2001 From: Damian Kaczmarek Date: Thu, 2 Dec 2021 16:43:13 -0600 Subject: [PATCH] feat: optimize uuid.v1 by 1.3x uuid.v4 by 4.3x (430%) (#597) This skips input validation when stringifying UUIDs that we _know_ are valid. --- src/stringify.js | 7 +++-- src/v1.js | 4 +-- src/v35.js | 4 +-- src/v4.js | 4 +-- test/unit/stringify.test.js | 60 +++++++++++++++++++++---------------- 5 files changed, 45 insertions(+), 34 deletions(-) diff --git a/src/stringify.js b/src/stringify.js index 42fd4ecd..d74b8e1d 100644 --- 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 index 0643675e..85b7a7a8 100644 --- 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 index 34d9b1f3..35a7ee63 100644 --- 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 index dbe76993..dc21c59f 100644 --- 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 index 1c1753cd..812a1386 100644 --- 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)); + }); }); });