'use strict'; var test = require('tape'); var inspect = require('object-inspect'); var SaferBuffer = require('safer-buffer').Buffer; var forEach = require('for-each'); var v = require('es-value-fixtures'); var utils = require('../lib/utils'); test('merge()', function (t) { t.deepEqual(utils.merge(null, true), [null, true], 'merges true into null'); t.deepEqual(utils.merge(null, [42]), [null, 42], 'merges null into an array'); t.deepEqual(utils.merge({ a: 'b' }, { a: 'c' }), { a: ['b', 'c'] }, 'merges two objects with the same key'); var oneMerged = utils.merge({ foo: 'bar' }, { foo: { first: '123' } }); t.deepEqual(oneMerged, { foo: ['bar', { first: '123' }] }, 'merges a standalone and an object into an array'); var twoMerged = utils.merge({ foo: ['bar', { first: '123' }] }, { foo: { second: '456' } }); t.deepEqual(twoMerged, { foo: { 0: 'bar', 1: { first: '123' }, second: '456' } }, 'merges a standalone and two objects into an array'); var sandwiched = utils.merge({ foo: ['bar', { first: '123', second: '456' }] }, { foo: 'baz' }); t.deepEqual(sandwiched, { foo: ['bar', { first: '123', second: '456' }, 'baz'] }, 'merges an object sandwiched by two standalones into an array'); var nestedArrays = utils.merge({ foo: ['baz'] }, { foo: ['bar', 'xyzzy'] }); t.deepEqual(nestedArrays, { foo: ['baz', 'bar', 'xyzzy'] }); var noOptionsNonObjectSource = utils.merge({ foo: 'baz' }, 'bar'); t.deepEqual(noOptionsNonObjectSource, { foo: 'baz', bar: true }); var func = function f() {}; func(); t.deepEqual( utils.merge(func, { foo: 'bar' }), [func, { foo: 'bar' }], 'functions can not be merged into' ); func.bar = 'baz'; t.deepEqual( utils.merge({ foo: 'bar' }, func), { foo: 'bar', bar: 'baz' }, 'functions can be merge sources' ); t.test( 'avoids invoking array setters unnecessarily', { skip: typeof Object.defineProperty !== 'function' }, function (st) { var setCount = 0; var getCount = 0; var observed = []; Object.defineProperty(observed, 0, { get: function () { getCount += 1; return { bar: 'baz' }; }, set: function () { setCount += 1; } }); utils.merge(observed, [null]); st.equal(setCount, 0); st.equal(getCount, 1); observed[0] = observed[0]; // eslint-disable-line no-self-assign st.equal(setCount, 1); st.equal(getCount, 2); st.end(); } ); t.test('with overflow objects (from arrayLimit)', function (st) { // arrayLimit is max index, so with limit 0, max index 0 is allowed (1 element) // To create overflow, need 2+ elements with limit 0, or 3+ with limit 1, etc. st.test('merges primitive into overflow object at next index', function (s2t) { // Create an overflow object via combine: 3 elements (indices 0-2) with limit 0 var overflow = utils.combine(['a', 'b'], 'c', 0, false); s2t.ok(utils.isOverflow(overflow), 'overflow object is marked'); var merged = utils.merge(overflow, 'd'); s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'adds primitive at next numeric index'); s2t.end(); }); st.test('merges primitive into regular object with numeric keys normally', function (s2t) { var obj = { 0: 'a', 1: 'b' }; s2t.notOk(utils.isOverflow(obj), 'plain object is not marked as overflow'); var merged = utils.merge(obj, 'c'); s2t.deepEqual(merged, { 0: 'a', 1: 'b', c: true }, 'adds primitive as key (not at next index)'); s2t.end(); }); st.test('merges primitive into object with non-numeric keys normally', function (s2t) { var obj = { foo: 'bar' }; var merged = utils.merge(obj, 'baz'); s2t.deepEqual(merged, { foo: 'bar', baz: true }, 'adds primitive as key with value true'); s2t.end(); }); st.test('with strictMerge, wraps object and primitive in array', function (s2t) { var obj = { foo: 'bar' }; var merged = utils.merge(obj, 'baz', { strictMerge: true }); s2t.deepEqual(merged, [{ foo: 'bar' }, 'baz'], 'wraps in array with strictMerge'); s2t.end(); }); st.test('merges overflow object into primitive', function (s2t) { // Create an overflow object via combine: 2 elements (indices 0-1) with limit 0 var overflow = utils.combine(['a'], 'b', 0, false); s2t.ok(utils.isOverflow(overflow), 'overflow object is marked'); var merged = utils.merge('c', overflow); s2t.ok(utils.isOverflow(merged), 'result is also marked as overflow'); s2t.deepEqual(merged, { 0: 'c', 1: 'a', 2: 'b' }, 'creates object with primitive at 0, source values shifted'); s2t.end(); }); st.test('merges overflow object into primitive with plainObjects', function (s2t) { var overflow = utils.combine(['a'], 'b', 0, false); s2t.ok(utils.isOverflow(overflow), 'overflow object is marked'); var merged = utils.merge('c', overflow, { plainObjects: true }); s2t.ok(utils.isOverflow(merged), 'result is also marked as overflow'); s2t.deepEqual(merged, { __proto__: null, 0: 'c', 1: 'a', 2: 'b' }, 'creates null-proto object with primitive at 0'); s2t.end(); }); st.test('merges overflow object with multiple values into primitive', function (s2t) { // Create an overflow object via combine: 3 elements (indices 0-2) with limit 0 var overflow = utils.combine(['b', 'c'], 'd', 0, false); s2t.ok(utils.isOverflow(overflow), 'overflow object is marked'); var merged = utils.merge('a', overflow); s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'shifts all source indices by 1'); s2t.end(); }); st.test('merges regular object into primitive as array', function (s2t) { var obj = { foo: 'bar' }; var merged = utils.merge('a', obj); s2t.deepEqual(merged, ['a', { foo: 'bar' }], 'creates array with primitive and object'); s2t.end(); }); st.test('merges primitive into array that exceeds arrayLimit', function (s2t) { var arr = ['a', 'b', 'c']; var merged = utils.merge(arr, 'd', { arrayLimit: 1 }); s2t.ok(utils.isOverflow(merged), 'result is marked as overflow'); s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'converts to overflow object with primitive appended'); s2t.end(); }); st.test('merges array into primitive that exceeds arrayLimit', function (s2t) { var merged = utils.merge('a', ['b', 'c'], { arrayLimit: 1 }); s2t.ok(utils.isOverflow(merged), 'result is marked as overflow'); s2t.deepEqual(merged, { 0: 'a', 1: 'b', 2: 'c' }, 'converts to overflow object'); s2t.end(); }); st.test('merges primitive into array at the arrayLimit boundary, consistently with combine', function (s2t) { var merged = utils.merge(['a'], 'b', { arrayLimit: 1 }); s2t.ok(utils.isOverflow(merged), 'result is marked as overflow at the boundary'); s2t.deepEqual(merged, { 0: 'a', 1: 'b' }, 'converts to overflow object instead of a length-2 array'); s2t.end(); }); st.test('merges two arrays that exceed arrayLimit into an overflow object', function (s2t) { var merged = utils.merge(['a'], ['b'], { arrayLimit: 1 }); s2t.ok(utils.isOverflow(merged), 'result is marked as overflow'); s2t.deepEqual(merged, { 0: 'a', 1: 'b' }, 'array-into-array merge enforces arrayLimit like combine'); s2t.end(); }); st.test('throws at the arrayLimit boundary when merging a primitive into an array with throwOnLimitExceeded', function (s2t) { s2t['throws']( function () { utils.merge(['a'], 'b', { arrayLimit: 1, throwOnLimitExceeded: true }); }, new RangeError('Array limit exceeded. Only 1 element allowed in an array.'), 'throws when the resulting length would exceed arrayLimit' ); s2t.end(); }); st.test('throws when merging two arrays past arrayLimit with throwOnLimitExceeded', function (s2t) { s2t['throws']( function () { utils.merge(['a'], ['b'], { arrayLimit: 1, throwOnLimitExceeded: true }); }, new RangeError('Array limit exceeded. Only 1 element allowed in an array.'), 'array-into-array merge throws rather than silently exceeding arrayLimit' ); s2t['throws']( function () { utils.merge(['a', 'b', 'c'], ['d', 'e', 'f'], { arrayLimit: 2, throwOnLimitExceeded: true }); }, new RangeError('Array limit exceeded. Only 2 elements allowed in an array.'), 'uses the plural message when arrayLimit is not 1' ); s2t.end(); }); st.test('throws instead of merging primitive into over-limit array when throwOnLimitExceeded is set', function (s2t) { s2t['throws']( function () { utils.merge(['a', 'b', 'c'], 'd', { arrayLimit: 1, throwOnLimitExceeded: true }); }, new RangeError('Array limit exceeded. Only 1 element allowed in an array.'), 'throws rather than converting to an overflow object' ); s2t['throws']( function () { utils.merge(['a', 'b', 'c'], 'd', { arrayLimit: 2, throwOnLimitExceeded: true }); }, new RangeError('Array limit exceeded. Only 2 elements allowed in an array.'), 'uses the plural message when arrayLimit is not 1' ); s2t.end(); }); st.test('throws instead of merging array into primitive when throwOnLimitExceeded is set', function (s2t) { s2t['throws']( function () { utils.merge('a', ['b', 'c'], { arrayLimit: 1, throwOnLimitExceeded: true }); }, new RangeError('Array limit exceeded. Only 1 element allowed in an array.'), 'throws rather than converting to an overflow object' ); s2t['throws']( function () { utils.merge('a', ['b', 'c', 'd'], { arrayLimit: 2, throwOnLimitExceeded: true }); }, new RangeError('Array limit exceeded. Only 2 elements allowed in an array.'), 'uses the plural message when arrayLimit is not 1' ); s2t.end(); }); st.end(); }); t.end(); }); test('assign()', function (t) { var target = { a: 1, b: 2 }; var source = { b: 3, c: 4 }; var result = utils.assign(target, source); t.equal(result, target, 'returns the target'); t.deepEqual(target, { a: 1, b: 3, c: 4 }, 'target and source are merged'); t.deepEqual(source, { b: 3, c: 4 }, 'source is untouched'); t.end(); }); test('combine()', function (t) { t.test('both arrays', function (st) { var a = [1]; var b = [2]; var combined = utils.combine(a, b); st.deepEqual(a, [1], 'a is not mutated'); st.deepEqual(b, [2], 'b is not mutated'); st.notEqual(a, combined, 'a !== combined'); st.notEqual(b, combined, 'b !== combined'); st.deepEqual(combined, [1, 2], 'combined is a + b'); st.end(); }); t.test('one array, one non-array', function (st) { var aN = 1; var a = [aN]; var bN = 2; var b = [bN]; var combinedAnB = utils.combine(aN, b); st.deepEqual(b, [bN], 'b is not mutated'); st.notEqual(aN, combinedAnB, 'aN + b !== aN'); st.notEqual(a, combinedAnB, 'aN + b !== a'); st.notEqual(bN, combinedAnB, 'aN + b !== bN'); st.notEqual(b, combinedAnB, 'aN + b !== b'); st.deepEqual([1, 2], combinedAnB, 'first argument is array-wrapped when not an array'); var combinedABn = utils.combine(a, bN); st.deepEqual(a, [aN], 'a is not mutated'); st.notEqual(aN, combinedABn, 'a + bN !== aN'); st.notEqual(a, combinedABn, 'a + bN !== a'); st.notEqual(bN, combinedABn, 'a + bN !== bN'); st.notEqual(b, combinedABn, 'a + bN !== b'); st.deepEqual([1, 2], combinedABn, 'second argument is array-wrapped when not an array'); st.end(); }); t.test('neither is an array', function (st) { var combined = utils.combine(1, 2); st.notEqual(1, combined, '1 + 2 !== 1'); st.notEqual(2, combined, '1 + 2 !== 2'); st.deepEqual([1, 2], combined, 'both arguments are array-wrapped when not an array'); st.end(); }); t.test('with arrayLimit', function (st) { st.test('under the limit', function (s2t) { var combined = utils.combine(['a', 'b'], 'c', 10, false); s2t.deepEqual(combined, ['a', 'b', 'c'], 'returns array when under limit'); s2t.ok(Array.isArray(combined), 'result is an array'); s2t.end(); }); st.test('exactly at the limit stays as array', function (s2t) { var combined = utils.combine(['a', 'b'], 'c', 3, false); s2t.deepEqual(combined, ['a', 'b', 'c'], 'stays as array when count equals limit'); s2t.ok(Array.isArray(combined), 'result is an array'); s2t.end(); }); st.test('over the limit', function (s2t) { var combined = utils.combine(['a', 'b', 'c'], 'd', 3, false); s2t.deepEqual(combined, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'converts to object when over limit'); s2t.notOk(Array.isArray(combined), 'result is not an array'); s2t.end(); }); st.test('with arrayLimit 1', function (s2t) { var combined = utils.combine([], 'a', 1, false); s2t.deepEqual(combined, ['a'], 'stays as array when count equals limit'); s2t.ok(Array.isArray(combined), 'result is an array'); s2t.end(); }); st.test('with arrayLimit 0 converts single element to object', function (s2t) { var combined = utils.combine([], 'a', 0, false); s2t.deepEqual(combined, { 0: 'a' }, 'converts to object when count exceeds limit'); s2t.notOk(Array.isArray(combined), 'result is not an array'); s2t.end(); }); st.test('with arrayLimit 0 and two elements converts to object', function (s2t) { var combined = utils.combine(['a'], 'b', 0, false); s2t.deepEqual(combined, { 0: 'a', 1: 'b' }, 'converts to object when count exceeds limit'); s2t.notOk(Array.isArray(combined), 'result is not an array'); s2t.end(); }); st.test('with plainObjects option', function (s2t) { var combined = utils.combine(['a', 'b'], 'c', 1, true); var expected = { __proto__: null, 0: 'a', 1: 'b', 2: 'c' }; s2t.deepEqual(combined, expected, 'converts to object with null prototype'); s2t.equal(Object.getPrototypeOf(combined), null, 'result has null prototype when plainObjects is true'); s2t.end(); }); st.end(); }); t.test('with throwOnLimitExceeded', function (st) { st.test('throws when concatenation exceeds the limit', function (s2t) { s2t['throws']( function () { utils.combine(['a', 'b', 'c'], 'd', 3, false, true); }, new RangeError('Array limit exceeded. Only 3 elements allowed in an array.'), 'throws instead of converting to an overflow object' ); s2t['throws']( function () { utils.combine([], 'a', 0, false, true); }, new RangeError('Array limit exceeded. Only 0 elements allowed in an array.'), 'throws with the correct count at arrayLimit 0' ); s2t.end(); }); st.test('throws when adding to an existing overflow object', function (s2t) { var overflow = utils.combine(['a', 'b'], 'c', 0, false); s2t.ok(utils.isOverflow(overflow), 'initial object is marked as overflow'); s2t['throws']( function () { utils.combine(overflow, 'd', 0, false, true); }, new RangeError('Array limit exceeded. Only 0 elements allowed in an array.'), 'throws rather than appending to the overflow object' ); s2t['throws']( function () { utils.combine(overflow, 'd', 1, false, true); }, new RangeError('Array limit exceeded. Only 1 element allowed in an array.'), 'uses the singular message at arrayLimit 1' ); s2t.end(); }); st.test('does not throw when within the limit', function (s2t) { var combined = utils.combine(['a'], 'b', 5, false, true); s2t.deepEqual(combined, ['a', 'b'], 'returns the array unchanged when under the limit'); s2t.end(); }); st.end(); }); t.test('with existing overflow object', function (st) { st.test('adds to existing overflow object at next index', function (s2t) { // Create overflow object first via combine: 3 elements (indices 0-2) with limit 0 var overflow = utils.combine(['a', 'b'], 'c', 0, false); s2t.ok(utils.isOverflow(overflow), 'initial object is marked as overflow'); var combined = utils.combine(overflow, 'd', 10, false); s2t.equal(combined, overflow, 'returns the same object (mutated)'); s2t.deepEqual(combined, { 0: 'a', 1: 'b', 2: 'c', 3: 'd' }, 'adds value at next numeric index'); s2t.end(); }); st.test('does not treat plain object with numeric keys as overflow', function (s2t) { var plainObj = { 0: 'a', 1: 'b' }; s2t.notOk(utils.isOverflow(plainObj), 'plain object is not marked as overflow'); // combine treats this as a regular value, not an overflow object to append to var combined = utils.combine(plainObj, 'c', 10, false); s2t.deepEqual(combined, [{ 0: 'a', 1: 'b' }, 'c'], 'concatenates as regular values'); s2t.end(); }); st.end(); }); t.end(); }); test('decode', function (t) { t.equal( utils.decode('a+b'), 'a b', 'decodes + to space' ); t.equal( utils.decode('name%2Eobj'), 'name.obj', 'decodes a string' ); t.equal( utils.decode('name%2Eobj%2Efoo', null, 'iso-8859-1'), 'name.obj.foo', 'decodes a string in iso-8859-1' ); t.end(); }); test('encode', function (t) { forEach(v.nullPrimitives, function (nullish) { t['throws']( function () { utils.encode(nullish); }, TypeError, inspect(nullish) + ' is not a string' ); }); t.equal(utils.encode(''), '', 'empty string returns itself'); t.deepEqual(utils.encode([]), [], 'empty array returns itself'); t.deepEqual(utils.encode({ length: 0 }), { length: 0 }, 'empty arraylike returns itself'); t.test('symbols', { skip: !v.hasSymbols }, function (st) { st.equal(utils.encode(Symbol('x')), 'Symbol%28x%29', 'symbol is encoded'); st.end(); }); t.equal( utils.encode('(abc)'), '%28abc%29', 'encodes parentheses' ); t.equal( utils.encode({ toString: function () { return '(abc)'; } }), '%28abc%29', 'toStrings and encodes parentheses' ); t.equal( utils.encode('abc 123 💩', null, 'iso-8859-1'), 'abc%20123%20%26%2355357%3B%26%2356489%3B', 'encodes in iso-8859-1' ); var longString = ''; var expectedString = ''; for (var i = 0; i < 1500; i++) { longString += ' '; expectedString += '%20'; } t.equal( utils.encode(longString), expectedString, 'encodes a long string' ); var boundary = ''; var expected = ''; for (var j = 0; j < 1023; j++) { boundary += 'a'; expected += 'a'; } boundary += '😀'; expected += '%F0%9F%98%80'; t.equal( utils.encode(boundary), expected, 'encodes a surrogate pair split across long-string chunks' ); var laterBoundary = ''; var laterExpected = ''; for (var k = 0; k < 2047; k++) { laterBoundary += 'a'; laterExpected += 'a'; } laterBoundary += '😀'; laterExpected += '%F0%9F%98%80'; t.equal( utils.encode(laterBoundary), laterExpected, 'encodes a surrogate pair split across a later chunk boundary' ); var twoPairs = ''; for (k = 0; k < 1023; k++) { twoPairs += 'a'; } twoPairs += '😀'; for (k = 0; k < 1022; k++) { twoPairs += 'b'; } twoPairs += '😀'; t.equal( (utils.encode(twoPairs).match(/%F0%9F%98%80/g) || []).length, 2, 'encodes two surrogate pairs each split across a chunk boundary' ); var roundTrip = ''; for (k = 0; k < 1023; k++) { roundTrip += 'a'; } roundTrip += '😀'; t.equal( decodeURIComponent(utils.encode(roundTrip)), roundTrip, 'a boundary-split surrogate pair round-trips through decodeURIComponent' ); var loneBoundary = ''; var loneExpected = ''; for (k = 0; k < 1023; k++) { loneBoundary += 'a'; loneExpected += 'a'; } loneBoundary += '\uD83DX'; loneExpected += '%F0%9F%91%98'; t.equal( utils.encode(loneBoundary), loneExpected, 'a lone high surrogate at a chunk boundary encodes the same as mid-chunk' ); t.equal( utils.encode('\x28\x29'), '%28%29', 'encodes parens normally' ); t.equal( utils.encode('\x28\x29', null, null, null, 'RFC1738'), '()', 'does not encode parens in RFC1738' ); // todo RFC1738 format t.equal( utils.encode('Āက豈'), '%C4%80%E1%80%80%EF%A4%80', 'encodes multibyte chars' ); t.equal( utils.encode('\uD83D \uDCA9'), '%F0%9F%90%A0%F0%BA%90%80', 'encodes lone surrogates' ); t.end(); }); test('isBuffer()', function (t) { var fn = function () {}; fn(); forEach([null, undefined, true, false, '', 'abc', 42, 0, NaN, {}, [], fn, /a/g], function (x) { t.equal(utils.isBuffer(x), false, inspect(x) + ' is not a buffer'); }); var fakeBuffer = { constructor: Buffer }; t.equal(utils.isBuffer(fakeBuffer), false, 'fake buffer is not a buffer'); var saferBuffer = SaferBuffer.from('abc'); t.equal(utils.isBuffer(saferBuffer), true, 'SaferBuffer instance is a buffer'); var buffer = SaferBuffer.from('abc'); t.notEqual(saferBuffer, buffer, 'different buffer instances'); t.equal(utils.isBuffer(buffer), true, 'another Buffer instance is a buffer'); t.end(); }); test('isRegExp()', function (t) { t.equal(utils.isRegExp(/a/g), true, 'RegExp is a RegExp'); t.equal(utils.isRegExp(new RegExp('a', 'g')), true, 'new RegExp is a RegExp'); t.equal(utils.isRegExp(new Date()), false, 'Date is not a RegExp'); forEach(v.primitives, function (primitive) { t.equal(utils.isRegExp(primitive), false, inspect(primitive) + ' is not a RegExp'); }); t.end(); });