Skip to content

Commit

Permalink
Merge branch 'main' into drop-ie-11
Browse files Browse the repository at this point in the history
  • Loading branch information
broofa authored Mar 17, 2022
2 parents 43fc39c + fcd7388 commit 977aa8e
Show file tree
Hide file tree
Showing 12 changed files with 98 additions and 43 deletions.
Empty file added a
Empty file.
4 changes: 0 additions & 4 deletions examples/node-esmodules/example.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import {
version as uuidVersion,
} from 'uuid';
import * as uuid from 'uuid';
import pkg from 'uuid/package.json';

console.log('uuidv1()', uuidv1());

Expand Down Expand Up @@ -65,6 +64,3 @@ console.log('uuid.parse()', uuid.parse(MY_NAMESPACE));
console.log('uuid.stringify()', uuid.stringify(uuid.parse(MY_NAMESPACE)));
console.log('uuid.validate()', uuid.validate(MY_NAMESPACE));
console.log('uuid.version()', uuid.version(MY_NAMESPACE));

// Some tools like react-native need to introspect the package.json file
console.log('pkg.name', pkg.name);
4 changes: 3 additions & 1 deletion examples/node-esmodules/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
"version": "0.0.0",
"private": true,
"scripts": {
"test": "node --experimental-modules --experimental-json-modules example.mjs"
"test:package": "( node --version | grep -vq 'v16' ) || ( node --experimental-json-modules package.mjs )",
"test:example": "node example.mjs",
"test": "npm-run-all test:*"
},
"dependencies": {
"uuid": "file:../../.local/uuid"
Expand Down
4 changes: 4 additions & 0 deletions examples/node-esmodules/package.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import pkg from 'uuid/package.json' assert { type: 'json' };

// Some tools like react-native need to introspect the package.json file
console.log('pkg.name', pkg.name);
8 changes: 7 additions & 1 deletion scripts/testpack.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ mkdir -p ../test-pack

cp examples/node-commonjs/example.js ../test-pack/commonjs.js
cp examples/node-esmodules/example.mjs ../test-pack/esmodules.mjs
cp examples/node-esmodules/package.mjs ../test-pack/esmodules-package.mjs

cd ../test-pack

Expand All @@ -18,4 +19,9 @@ npm init -y
npm install ../uuid/uuid-*.tgz

node commonjs.js
node --experimental-json-modules esmodules.mjs
node esmodules.mjs

# Support for json esm imports requires import assertions starting in Node.js v16.14.0 which were
# not supported in earlier versions. Therefore we restrict the ESM test to more recent versions of
# Node.js:
( node --version | grep -vq 'v16' ) || ( node --experimental-json-modules esmodules-package.mjs )
9 changes: 6 additions & 3 deletions src/stringify.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import validate from './validate.js';
const byteToHex = [];

for (let i = 0; i < 256; ++i) {
byteToHex.push((i + 0x100).toString(16).substr(1));
byteToHex.push((i + 0x100).toString(16).slice(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]] +
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/v1.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import rng from './rng.js';
import stringify from './stringify.js';
import { unsafeStringify } from './stringify.js';

// **`v1()` - Generate time-based UUID**
//
Expand Down Expand Up @@ -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;
6 changes: 3 additions & 3 deletions src/v35.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import stringify from './stringify.js';
import { unsafeStringify } from './stringify.js';
import parse from './parse.js';

function stringToBytes(str) {
Expand Down Expand Up @@ -26,7 +26,7 @@ export default function v35(name, version, hashfunc) {
namespace = parse(namespace);
}

if (namespace.length !== 16) {
if (namespace?.length !== 16) {
throw TypeError('Namespace must be array-like (16 iterable integer values, 0-255)');
}

Expand All @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions src/v4.js
Original file line number Diff line number Diff line change
@@ -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) {
Expand All @@ -26,7 +26,7 @@ function v4(options, buf, offset) {
return buf;
}

return stringify(rnds);
return unsafeStringify(rnds);
}

export default v4;
2 changes: 1 addition & 1 deletion src/version.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ function version(uuid) {
throw TypeError('Invalid UUID');
}

return parseInt(uuid.substr(14, 1), 16);
return parseInt(uuid.slice(14, 15), 16);
}

export default version;
60 changes: 34 additions & 26 deletions test/unit/stringify.test.js
Original file line number Diff line number Diff line change
@@ -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));
});
});
});
36 changes: 36 additions & 0 deletions test/unit/v35.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,24 @@ describe('v35', () => {
assert.deepEqual(buf, ['landmaster', 'landmaster', 'landmaster'].concat(testBuf));
});

test('v3 undefined/null', () => {
assert.throws(() => {
v3();
});

assert.throws(() => {
v3('hello');
});

assert.throws(() => {
v3('hello.example.com', undefined);
});

assert.throws(() => {
v3('hello.example.com', null, new Array(16));
});
});

test('v5', () => {
// Expect to get the same results as http://tools.adjet.org/uuid-v5
assert.strictEqual(v5('hello.example.com', v5.DNS), 'fdda765f-fc57-5604-a269-52a7df8164ec');
Expand Down Expand Up @@ -229,6 +247,24 @@ describe('v35', () => {
assert.deepEqual(buf, ['landmaster', 'landmaster', 'landmaster'].concat(testBuf));
});

test('v5 undefined/null', () => {
assert.throws(() => {
v5();
});

assert.throws(() => {
v5('hello');
});

assert.throws(() => {
v5('hello.example.com', undefined);
});

assert.throws(() => {
v5('hello.example.com', null, new Array(16));
});
});

test('v3/v5 constants', () => {
assert.strictEqual(v3.DNS, '6ba7b810-9dad-11d1-80b4-00c04fd430c8');
assert.strictEqual(v3.URL, '6ba7b811-9dad-11d1-80b4-00c04fd430c8');
Expand Down

0 comments on commit 977aa8e

Please sign in to comment.